Class AbstractCtrlAwareIRSSUploadHandler. More...

Inheritance diagram for ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler:

Collaboration diagram for ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler:

Public Member Functions
	__construct ()
	ilUIDemoFileUploadHandlerGUI constructor. More...

	getUploadURL ()
	@inheritDoc More...

	getExistingFileInfoURL ()
	@inheritDoc More...

	getFileRemovalURL ()
	@inheritDoc More...

	getInfoResult (string $identifier)

	getInfoForExistingFiles (array $file_ids)

Public Member Functions inherited from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler
	__construct ()
	ilUIDemoFileUploadHandlerGUI constructor. More...

	getFileIdentifierParameterName ()
	@inheritDoc More...

	getUploadURL ()
	@inheritDoc More...

	getExistingFileInfoURL ()
	@inheritDoc More...

	getFileRemovalURL ()
	@inheritDoc More...

	executeCommand ()
	Since this is a ilCtrl aware UploadHandler executeCommand MUST be implemented. More...

	getInfoResult (string $identifier)

	getInfoForExistingFiles (array $file_ids)

	supportsChunkedUploads ()

	executeCommand ()
	Since this is a ilCtrl aware UploadHandler executeCommand MUST be implemented. More...

	getFileIdentifierParameterName ()

	getUploadURL ()

	getFileRemovalURL ()

	getExistingFileInfoURL ()

	getInfoForExistingFiles (array $file_ids)

	getInfoResult (string $identifier)

	supportsChunkedUploads ()

Protected Member Functions
	getStakeholder ()

	getClassPath ()

	getUploadResult ()

	processChunckedUpload (UploadResult $result)

	getRemoveResult (string $identifier)

Protected Member Functions inherited from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler
	readChunkedInformation ()

	getUploadResult ()

	getRemoveResult (string $identifier)

Protected Attributes
ilFileServicesFilenameSanitizer	$sanitizer

ilLanguage	$language

Services	$irss

ResourceStakeholder	$stakeholder

Filesystem	$temp_filesystem

array	$class_path

Protected Attributes inherited from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler
const	CMD_UPLOAD = 'upload'

const	CMD_REMOVE = 'remove'

const	CMD_INFO = 'info'

HttpServices	$http

ilCtrl	$ctrl

FileUpload	$upload

bool	$is_chunked = false

int	$chunk_index = 0

int	$amount_of_chunks = 0

string	$chunk_id = null

int	$chunk_total_size = 0

Additional Inherited Members
Data Fields inherited from ILIAS\UI\Component\Input\Field\UploadHandler
const	DEFAULT_FILE_ID_PARAMETER = 'file_id'

Detailed Description

Class AbstractCtrlAwareIRSSUploadHandler.

Author: Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 33 of file AbstractCtrlAwareIRSSUploadHandler.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler::__construct ( )

ilUIDemoFileUploadHandlerGUI constructor.

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 42 of file AbstractCtrlAwareIRSSUploadHandler.php.

    {
        global $DIC;
 
        $this->irss = $DIC->resourceStorage();
        $this->stakeholder = $this->getStakeholder();
        $this->temp_filesystem = $DIC->filesystem()->temp();
        $this->class_path = $this->getClassPath();
        $this->language = $DIC->language();
        $this->sanitizer = new \ilFileServicesFilenameSanitizer(
            $DIC->fileServiceSettings()
        );
 
        parent::__construct();
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler\getClassPath(), ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler\getStakeholder(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Here is the call graph for this function:

Member Function Documentation

◆ getClassPath()

ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler::getClassPath ( )

abstractprotected

Reimplemented in ilObjFileUploadHandlerGUI, and ilFileVersionsUploadHandlerGUI.

Referenced by ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler\__construct().

Here is the caller graph for this function:

◆ getExistingFileInfoURL()

ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler::getExistingFileInfoURL ( )

@inheritDoc

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 135 of file AbstractCtrlAwareIRSSUploadHandler.php.

                                            : string
    {
        return $this->ctrl->getLinkTargetByClass($this->class_path, self::CMD_INFO, null, true);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getFileRemovalURL()

ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler::getFileRemovalURL ( )

@inheritDoc

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 141 of file AbstractCtrlAwareIRSSUploadHandler.php.

                                       : string
    {
        return $this->ctrl->getLinkTargetByClass($this->class_path, self::CMD_REMOVE, null, true);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getInfoForExistingFiles()

ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler::getInfoForExistingFiles ( array $file_ids )

Parameters

array $file_ids

Returns: BasicFileInfoResult[]

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 175 of file AbstractCtrlAwareIRSSUploadHandler.php.

                                                            : array
    {
        return array_map(fn($file_id): FileInfoResult => $this->getInfoResult($file_id), $file_ids);
    }

References ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler\getInfoResult().

Here is the call graph for this function:

◆ getInfoResult()

ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler::getInfoResult ( string $identifier )

Returns: null|FileInfoResult for the file with the given identifier or null if the file does not exist.

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 160 of file AbstractCtrlAwareIRSSUploadHandler.php.

                                                     : ?FileInfoResult
    {
        if (null !== ($id = $this->irss->manage()->find($identifier))) {
            $revision = $this->irss->manage()->getCurrentRevision($id)->getInformation();
            $title = $revision->getTitle();
            $size = $revision->getSize();
            $mime = $revision->getMimeType();
        } else {
            $title = $mime = 'unknown';
            $size = 0;
        }
 
        return new BasicFileInfoResult($this->getFileIdentifierParameterName(), $identifier, $title, $size, $mime);
    }

References $id, ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), and ILIAS\FileUpload\Handler\FileInfoResult\getSize().

Referenced by ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler\getInfoForExistingFiles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRemoveResult()

ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler::getRemoveResult ( string $identifier )

protected

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 146 of file AbstractCtrlAwareIRSSUploadHandler.php.

                                                          : HandlerResult
    {
        if (null !== ($id = $this->irss->manage()->find($identifier))) {
            $this->irss->manage()->remove($id, $this->stakeholder);
            $status = HandlerResult::STATUS_OK;
            $message = "file removal OK";
        } else {
            $status = HandlerResult::STATUS_OK;
            $message = "file with identifier '$identifier' doesn't exist, nothing to do.";
        }
 
        return new BasicHandlerResult($this->getFileIdentifierParameterName(), $status, $identifier, $message);
    }

References $id, $message, ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), and ILIAS\FileUpload\Handler\HandlerResult\STATUS_OK.

Here is the call graph for this function:

◆ getStakeholder()

ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler::getStakeholder ( )

abstractprotected

Reimplemented in ilObjFileUploadHandlerGUI, and ilFileVersionsUploadHandlerGUI.

Referenced by ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler\__construct().

Here is the caller graph for this function:

◆ getUploadResult()

ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler::getUploadResult ( )

protected

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Reimplemented in ilFileVersionsUploadHandlerGUI.

Definition at line 62 of file AbstractCtrlAwareIRSSUploadHandler.php.

                                        : HandlerResult
    {
        $this->upload->process(); // Process the uploads to rund things like PreProcessors
 
        $result_array = $this->upload->getResults();
        $result = end($result_array); // get the last result aka the Upload of the user
 
        if ($result instanceof UploadResult && $result->isOK()) {
            if ($this->is_chunked) {
                return $this->processChunckedUpload($result);
            }
 
            $identifier = $this->irss->manage()->upload($result, $this->stakeholder)->serialize();
            $status = HandlerResult::STATUS_OK;
            $message = "file upload OK";
        } else {
            $identifier = '';
            $status = HandlerResult::STATUS_FAILED;
            $message = $this->language->txt(
                'msg_info_blacklisted'
            ); // this is the most common reason for a failed upload
        }
 
        return new BasicHandlerResult($this->getFileIdentifierParameterName(), $status, $identifier, $message);
    }

References $message, ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), ILIAS\FileUpload\DTO\UploadResult\isOK(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler\processChunckedUpload(), ILIAS\FileUpload\Handler\HandlerResult\STATUS_FAILED, ILIAS\FileUpload\Handler\HandlerResult\STATUS_OK, and ILIAS\Repository\upload().

Here is the call graph for this function:

◆ getUploadURL()

ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler::getUploadURL ( )

@inheritDoc

Reimplemented from ILIAS\FileUpload\Handler\AbstractCtrlAwareUploadHandler.

Definition at line 129 of file AbstractCtrlAwareIRSSUploadHandler.php.

                                  : string
    {
        return $this->ctrl->getLinkTargetByClass($this->class_path, self::CMD_UPLOAD, null, true);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ processChunckedUpload()

ILIAS\FileUpload\Handler\AbstractCtrlAwareIRSSUploadHandler::processChunckedUpload ( UploadResult $result )

protected

Reimplemented in ilFileVersionsUploadHandlerGUI.

Definition at line 88 of file AbstractCtrlAwareIRSSUploadHandler.php.

                                                                  : HandlerResult
    {
        $temp_path = $this->sanitizer->sanitize("$this->chunk_id/{$result->getName()}");
 
        try {
            if ($this->temp_filesystem->has($temp_path)) {
                $stream = fopen($this->temp_filesystem->readStream($temp_path)->getMetadata()['uri'], 'ab');
                fwrite($stream, file_get_contents($result->getPath()));
            } else {
                $this->temp_filesystem->write($temp_path, file_get_contents($result->getPath()));
            }
        } catch (\Throwable $t) {
            return new BasicHandlerResult(
                $this->getFileIdentifierParameterName(),
                HandlerResult::STATUS_FAILED,
                '',
                $t->getMessage()
            );
        }
 
        if (($this->chunk_index + 1) === $this->amount_of_chunks) {
            $whole_file = $this->temp_filesystem->readStream($temp_path);
            $id = $this->irss->manage()->stream($whole_file, $this->stakeholder, $result->getName());
 
            return new BasicHandlerResult(
                $this->getFileIdentifierParameterName(),
                HandlerResult::STATUS_OK,
                $id->serialize(),
                "file upload OK"
            );
        }
 
        return new BasicHandlerResult(
            $this->getFileIdentifierParameterName(),
            HandlerResult::STATUS_PARTIAL,
            '',
            "chunk upload OK"
        );
    }