Class AbstractCtrlAwareIRSSUploadHandler. More...

Inheritance diagram for ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler:

Collaboration diagram for ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler:

Public Member Functions
	__construct ()

	getUploadURL ()

	getExistingFileInfoURL ()

	getFileRemovalURL ()

	getInfoResult (string $identifier)

	getInfoForExistingFiles (array $file_ids)

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

	getFileIdentifierParameterName ()

	getUploadURL ()

	getExistingFileInfoURL ()

	getFileRemovalURL ()

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

	getInfoResult (string $identifier)

	getInfoForExistingFiles (array $file_ids)

	supportsChunkedUploads ()

Protected Member Functions
	getStakeholder ()

	getClassPath ()

	getUploadResult ()

	processChunckedUpload (UploadResult $result)

	getRemoveResult (string $identifier)

Protected Member Functions inherited from ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareUploadHandler
	readChunkedInformation ()

	getUploadResult ()

	getRemoveResult (string $identifier)

Protected Attributes
ilFileServicesFilenameSanitizer	$sanitizer

ilLanguage	$language

ILIAS ResourceStorage Services	$irss

ResourceStakeholder	$stakeholder

ILIAS Filesystem Filesystem	$temp_filesystem

array	$class_path

Protected Attributes inherited from ILIAS\MetaData\OERExposer\OAIPMH\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 31 of file AbstractCtrlAwareIRSSUploadHandler.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler::__construct ( )

Definition at line 40 of file AbstractCtrlAwareIRSSUploadHandler.php.

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

     {
         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();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getClassPath()

ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler::getClassPath ( )

abstractprotected

Referenced by ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler\__construct().

Here is the caller graph for this function:

◆ getExistingFileInfoURL()

ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler::getExistingFileInfoURL ( )

Returns: string of the URL where in GUI existing files are handled. The URL is called by GET with a field with name from getFileIdentifierParameterName() and the FileID of the desired file. Return a FI

Implements ILIAS\UI\Component\Input\Field\UploadHandler.

Definition at line 131 of file AbstractCtrlAwareIRSSUploadHandler.php.

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

◆ getFileRemovalURL()

ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler::getFileRemovalURL ( )

Returns: string of the URL where in GUI deleted files are handled. The URL is called by POST with a field with name from getFileIdentifierParameterName() and the FileID of the deleted file.

Implements ILIAS\UI\Component\Input\Field\UploadHandler.

Definition at line 136 of file AbstractCtrlAwareIRSSUploadHandler.php.

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

◆ getInfoForExistingFiles()

ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler::getInfoForExistingFiles ( array $file_ids )

Parameters

array $file_ids

Returns: BasicFileInfoResult[]

Implements ILIAS\UI\Component\Input\Field\UploadHandler.

Definition at line 170 of file AbstractCtrlAwareIRSSUploadHandler.php.

References ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler\getInfoResult().

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

Here is the call graph for this function:

◆ getInfoResult()

ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler::getInfoResult ( string $identifier )

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

Implements ILIAS\UI\Component\Input\Field\UploadHandler.

Definition at line 155 of file AbstractCtrlAwareIRSSUploadHandler.php.

References $id, ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), and ILIAS\MetaData\OERExposer\OAIPMH\Handler\FileInfoResult\getSize().

Referenced by ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler\getInfoForExistingFiles().

                                                      : ?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);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRemoveResult()

ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler::getRemoveResult ( string $identifier )

protected

Definition at line 141 of file AbstractCtrlAwareIRSSUploadHandler.php.

References $id, ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), and ILIAS\MetaData\OERExposer\OAIPMH\Handler\HandlerResult\STATUS_OK.

                                                           : 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);
     }

Here is the call graph for this function:

◆ getStakeholder()

ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler::getStakeholder ( )

abstractprotected

Referenced by ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler\__construct().

Here is the caller graph for this function:

◆ getUploadResult()

ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler::getUploadResult ( )

protected

Definition at line 60 of file AbstractCtrlAwareIRSSUploadHandler.php.

References ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler\processChunckedUpload(), ILIAS\MetaData\OERExposer\OAIPMH\Handler\HandlerResult\STATUS_FAILED, ILIAS\MetaData\OERExposer\OAIPMH\Handler\HandlerResult\STATUS_OK, and ILIAS\Repository\upload().

                                         : 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);
     }

Here is the call graph for this function:

◆ getUploadURL()

ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler::getUploadURL ( )

Returns: string of the URL where dropped files are sent to. This URL must make sure the upload is handled and a is returned as JSON.

Implements ILIAS\UI\Component\Input\Field\UploadHandler.

Definition at line 126 of file AbstractCtrlAwareIRSSUploadHandler.php.

References ILIAS\Repository\ctrl().

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

Here is the call graph for this function:

◆ processChunckedUpload()

ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler::processChunckedUpload ( UploadResult $result )

protected

Definition at line 86 of file AbstractCtrlAwareIRSSUploadHandler.php.

References ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareUploadHandler\$amount_of_chunks, $id, ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareUploadHandler\getFileIdentifierParameterName(), ILIAS\MetaData\OERExposer\OAIPMH\Handler\HandlerResult\STATUS_FAILED, ILIAS\MetaData\OERExposer\OAIPMH\Handler\HandlerResult\STATUS_OK, and ILIAS\MetaData\OERExposer\OAIPMH\Handler\HandlerResult\STATUS_PARTIAL.

Referenced by ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler\getUploadResult().

                                                                   : 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"
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $class_path

array ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler::$class_path

protected

Definition at line 38 of file AbstractCtrlAwareIRSSUploadHandler.php.

◆ $irss

ILIAS ResourceStorage Services ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler::$irss

protected

Definition at line 35 of file AbstractCtrlAwareIRSSUploadHandler.php.

◆ $language

ilLanguage ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler::$language

protected

Definition at line 34 of file AbstractCtrlAwareIRSSUploadHandler.php.

◆ $sanitizer

ilFileServicesFilenameSanitizer ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler::$sanitizer

protected

Definition at line 33 of file AbstractCtrlAwareIRSSUploadHandler.php.

◆ $stakeholder

ResourceStakeholder ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler::$stakeholder

protected

Definition at line 36 of file AbstractCtrlAwareIRSSUploadHandler.php.

◆ $temp_filesystem

ILIAS Filesystem Filesystem ILIAS\MetaData\OERExposer\OAIPMH\Handler\AbstractCtrlAwareIRSSUploadHandler::$temp_filesystem

protected

Definition at line 37 of file AbstractCtrlAwareIRSSUploadHandler.php.

The documentation for this class was generated from the following file:

components/ILIAS/FileUpload/src/Handler/AbstractCtrlAwareIRSSUploadHandler.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getClassPath()

◆ getExistingFileInfoURL()

◆ getFileRemovalURL()

◆ getInfoForExistingFiles()

◆ getInfoResult()

◆ getRemoveResult()

◆ getStakeholder()

◆ getUploadResult()

◆ getUploadURL()

◆ processChunckedUpload()

Field Documentation

◆ $class_path

◆ $irss

◆ $language

◆ $sanitizer

◆ $stakeholder

◆ $temp_filesystem