Inheritance diagram for ilContainerResourceGUI:

Collaboration diagram for ilContainerResourceGUI:

Public Member Functions
	__construct (private Configuration $view_configuration)

	executeCommand ()

	upload ()

	getFileIdentifierParameterName ()

	getUploadURL ()

	getFileRemovalURL ()

	getExistingFileInfoURL ()

	getInfoForExistingFiles (array $file_ids)

	getInfoResult (string $identifier)

	supportsChunkedUploads ()

	getFileIdentifierParameterName ()

	getUploadURL ()

	getFileRemovalURL ()

	getExistingFileInfoURL ()

	getInfoForExistingFiles (array $file_ids)

	getInfoResult (string $identifier)

	supportsChunkedUploads ()

Data Fields
const	P_PATH = 'path'

const	P_PATHS = 'paths'

const	CMD_INDEX = 'index'

const	CMD_INFO = 'info'

const	CMD_UPLOAD = 'upload'

const	CMD_POST_UPLOAD = 'postUpload'

const	CMD_REMOVE = 'remove'

const	CMD_DOWNLOAD = 'download'

const	CMD_DOWNLOAD_ZIP = 'downloadZIP'

const	CMD_UNZIP = 'unzip'

const	CMD_RENDER_CONFIRM_REMOVE = 'renderConfirmRemove'

const	ADD_DIRECTORY = 'addDirectory'

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

Private Member Functions
	abortWithPermissionDenied ()

	index ()

	downloadZIP ()

	addDirectory ()

	postUpload ()

	download ()

	getPathsFromRequest ()

	unzip ()

	renderConfirmRemove ()

	remove ()

Private Attributes
ilCtrlInterface	$ctrl

ilGlobalTemplateInterface	$main_tpl

Request	$view_request

ViewFactory	$view_factory

Renderer	$ui_renderer

Factory	$refinery

Services	$http

ilLanguage	$language

ILIAS ResourceStorage Services	$irss

ActionBuilder	$action_builder

ViewControlBuilder	$view_control_builder

ILIAS UI Factory	$ui_factory

FileUpload	$upload

Archives	$archive

PreviewDefinition	$preview_definition

ActionProvider	$action_provider

StandardActionProvider	$standard_action_provider

Detailed Description

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

Definition at line 45 of file class.ilContainerResourceGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilContainerResourceGUI::__construct ( private Configuration $view_configuration )

final

Definition at line 120 of file class.ilContainerResourceGUI.php.

      {
        global $DIC;
        $this->ctrl = $DIC->ctrl();
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->ui_factory = $DIC->ui()->factory();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->language = $DIC->language();
        $this->language->loadLanguageModule('irss');
        $this->irss = $DIC->resourceStorage();
        $this->upload = $DIC->upload();
 
        $this->view_request = new Request(
            $DIC->ctrl(),
            $DIC->http()->wrapper()->query(),
            $this->view_configuration
        );
 
        // to store paramaters needed in GUI
        $this->view_request->init($this);
 
        $this->action_provider = new CombinedActionProvider(
            $this->standard_action_provider = new StandardActionProvider($this->view_request),
            $this->view_configuration->getActionProvider()
        );
 
        $data_provider = new TableDataProvider($this->view_request);
 
        $this->action_builder = new ActionBuilder(
            $this->view_request,
            $this->ctrl,
            $DIC->ui()->factory(),
            $DIC->language(),
            $this->irss,
            $this->action_provider
        );
 
        $view_control_builder = new ViewControlBuilder(
            $this->view_request,
            $data_provider,
            $this->ctrl,
            $DIC->ui()->factory(),
            $DIC->language()
        );
 
        $upload_builder = new UploadBuilder(
            $this->view_request,
            $this->ctrl,
            $DIC->ui()->factory(),
            $DIC->language(),
            $this
        );
 
        $this->view_factory = new ViewFactory(
            $data_provider,
            $this->action_builder,
            $view_control_builder,
            $upload_builder
        );
    }

References $DIC, $view_control_builder, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\refinery(), and upload().

Here is the call graph for this function:

Member Function Documentation

◆ abortWithPermissionDenied()

ilContainerResourceGUI::abortWithPermissionDenied ( )

private

Definition at line 186 of file class.ilContainerResourceGUI.php.

                                                : void
    {
        $this->main_tpl->setOnScreenMessage('failure', $this->language->txt('msg_no_perm_read'), true);
        $this->ctrl->redirect($this, self::CMD_INDEX);
    }

References ILIAS\Repository\ctrl(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by addDirectory(), postUpload(), remove(), renderConfirmRemove(), unzip(), and upload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addDirectory()

ilContainerResourceGUI::addDirectory ( )

private

Definition at line 266 of file class.ilContainerResourceGUI.php.

                                   : void
    {
        if (!$this->view_request->canUserAdministrate()) {
            $this->abortWithPermissionDenied();
            return;
        }
        $modal = $this->standard_action_provider->getAddDirectoryModal()->withRequest($this->http->request());
 
        $directory_name = $modal->getData()[0] ?? '';
        if (empty($directory_name)) {
            $this->main_tpl->setOnScreenMessage('failure', $this->language->txt('msg_error_adding_directory'), true);
            $this->ctrl->redirect($this, self::CMD_INDEX);
            return;
        }
        $directory_name = $this->view_request->getPath() . $directory_name;
 
        $success = $this->irss->manageContainer()->createDirectoryInsideContainer(
            $this->view_configuration->getContainer()->getIdentification(),
            $directory_name
        );
 
        if (!$success) {
            $this->main_tpl->setOnScreenMessage('failure', $this->language->txt('msg_error_adding_directory'), true);
            $this->ctrl->redirect($this, self::CMD_INDEX);
            return;
        }
 
        $this->main_tpl->setOnScreenMessage('success', $this->language->txt('msg_success_adding_directory'), true);
        $this->ctrl->redirect($this, self::CMD_INDEX);
    }

References abortWithPermissionDenied(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ download()

ilContainerResourceGUI::download ( )

private

Definition at line 349 of file class.ilContainerResourceGUI.php.

                               : never
    {
        $paths = $this->getPathsFromRequest();
 
        $this->view_request->getWrapper()->download(
            $paths[0]
        );
    }

References getPathsFromRequest().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ downloadZIP()

ilContainerResourceGUI::downloadZIP ( )

private

Definition at line 259 of file class.ilContainerResourceGUI.php.

                                  : never
    {
        $this->irss->consume()->download(
            $this->view_configuration->getContainer()->getIdentification()
        )->overrideFileName($this->view_request->getTitle())->run();
    }

Referenced by executeCommand().

Here is the caller graph for this function:

◆ executeCommand()

ilContainerResourceGUI::executeCommand ( )

Definition at line 192 of file class.ilContainerResourceGUI.php.

                                    : void
    {
        if ($this->view_request->handleViewTitle()) {
            $title = $this->view_request->getTitle();
            $this->main_tpl->setTitle($title);
            $description = $this->view_request->getDescription();
            if ($description !== null) {
                $this->main_tpl->setDescription($description);
            }
        }
 
        switch ($this->ctrl->getCmd(self::CMD_INDEX)) {
            case self::CMD_INDEX:
                $this->index();
                break;
            case self::CMD_UPLOAD:
                $this->upload();
                break;
            case self::CMD_POST_UPLOAD:
                $this->postUpload();
                break;
            case self::CMD_REMOVE:
                $this->remove();
                break;
            case self::CMD_DOWNLOAD:
                $this->download();
                break;
            case self::CMD_UNZIP:
                $this->unzip();
                break;
            case self::CMD_RENDER_CONFIRM_REMOVE:
                $this->renderConfirmRemove();
                break;
            case self::ADD_DIRECTORY:
                $this->addDirectory();
                break;
            case self::CMD_DOWNLOAD_ZIP:
                $this->downloadZIP();
                break;
        }
    }

References ADD_DIRECTORY, addDirectory(), CMD_DOWNLOAD, CMD_DOWNLOAD_ZIP, CMD_INDEX, CMD_POST_UPLOAD, CMD_REMOVE, CMD_RENDER_CONFIRM_REMOVE, CMD_UNZIP, CMD_UPLOAD, ILIAS\Repository\ctrl(), download(), downloadZIP(), index(), postUpload(), renderConfirmRemove(), unzip(), and upload().

Here is the call graph for this function:

◆ getExistingFileInfoURL()

ilContainerResourceGUI::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 477 of file class.ilContainerResourceGUI.php.

                                            : string
    {
        return $this->ctrl->getLinkTarget($this, self::CMD_INFO);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ getFileIdentifierParameterName()

ilContainerResourceGUI::getFileIdentifierParameterName ( )

Returns: string defaults to self::DEFAULT_FILE_ID_PARAMETER

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

Definition at line 462 of file class.ilContainerResourceGUI.php.

                                                    : string
    {
        return self::P_PATH;
    }

References P_PATH.

◆ getFileRemovalURL()

ilContainerResourceGUI::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 472 of file class.ilContainerResourceGUI.php.

                                       : string
    {
        return '';
    }

◆ getInfoForExistingFiles()

ilContainerResourceGUI::getInfoForExistingFiles ( array $file_ids )

Parameters

array $file_ids

Returns: BasicFileInfoResult[]

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

Definition at line 482 of file class.ilContainerResourceGUI.php.

◆ getInfoResult()

ilContainerResourceGUI::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 487 of file class.ilContainerResourceGUI.php.

                                                     : ?FileInfoResult
    {
        return null;
    }

◆ getPathsFromRequest()

ilContainerResourceGUI::getPathsFromRequest ( )

private

Definition at line 358 of file class.ilContainerResourceGUI.php.

                                          : array
    {
        $unhash = fn(string $path): string => $this->unhash($path);
        $unhash_array = static fn(array $paths): array => array_map(
            $unhash,
            $paths
        );
        $to_string = $this->refinery->kindlyTo()->string();
        $to_array_of_strings = $this->refinery->kindlyTo()->listOf(
            $to_string
        );
 
        // Get item from table
        $token_name = $this->action_builder->getUrlToken()->getName();
        if ($this->http->wrapper()->query()->has($token_name)) {
            return $unhash_array(
                $this->http->wrapper()->query()->retrieve(
                    $token_name,
                    $to_array_of_strings
                ) ?? []
            );
        }
 
        if ($this->http->wrapper()->post()->has('interruptive_items')) {
            return $unhash_array(
                $this->http->wrapper()->post()->retrieve(
                    'interruptive_items',
                    $to_array_of_strings
                )
            );
        }
 
        return [];
    }

References $path, ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by download(), remove(), renderConfirmRemove(), and unzip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUploadURL()

ilContainerResourceGUI::getUploadURL ( )

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

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

Definition at line 467 of file class.ilContainerResourceGUI.php.

                                  : string
    {
        return $this->ctrl->getLinkTarget($this, self::CMD_UPLOAD);
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ index()

ilContainerResourceGUI::index ( )

private

Definition at line 236 of file class.ilContainerResourceGUI.php.

                            : void
    {
        global $DIC;
        $components = [];
 
        // Add components from Actions
        $components = array_merge(
            $components,
            $this->action_provider->getComponents()
        );
 
        // Add components from the selected view (currently data-table)
        foreach ($this->view_factory->getComponentProvider($this->view_request)->getComponents() as $component) {
            $components[] = $component;
        }
 
        $this->main_tpl->setContent(
            $this->ui_renderer->render(
                $components
            )
        );
    }

References $components, and $DIC.

Referenced by executeCommand().

Here is the caller graph for this function:

◆ postUpload()

ilContainerResourceGUI::postUpload ( )

private

Definition at line 334 of file class.ilContainerResourceGUI.php.

                                 : void
    {
        if (!$this->view_request->canUserUplaod()) {
            $this->abortWithPermissionDenied();
            return;
        }
        if ($this->http->request()->getParsedBody() === []) { // nothing uploaded
            $this->main_tpl->setOnScreenMessage('failure', $this->language->txt('rids_appended_failed'), true);
        } else {
            $this->main_tpl->setOnScreenMessage('success', $this->language->txt('rids_appended'), true);
        }
 
        $this->ctrl->redirect($this, self::CMD_INDEX);
    }

References abortWithPermissionDenied(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ remove()

ilContainerResourceGUI::remove ( )

private

Definition at line 435 of file class.ilContainerResourceGUI.php.

                             : void
    {
        if (!$this->view_request->canUserAdministrate()) {
            $this->abortWithPermissionDenied();
            return;
        }
        $paths = $this->getPathsFromRequest();
 
        if (empty($paths)) {
            $this->main_tpl->setOnScreenMessage('failure', $this->language->txt('msg_no_perm_read'), true);
            $this->ctrl->redirect($this, self::CMD_INDEX);
            return;
        }
 
        foreach ($paths as $path_inside_zip) {
            $this->irss->manageContainer()->removePathInsideContainer(
                $this->view_configuration->getContainer()->getIdentification(),
                $path_inside_zip
            );
        }
 
        $this->main_tpl->setOnScreenMessage('success', $this->language->txt('msg_paths_deleted'), true);
        $this->ctrl->redirect($this, self::CMD_INDEX);
    }

References abortWithPermissionDenied(), ILIAS\Repository\ctrl(), getPathsFromRequest(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Here is the call graph for this function:

◆ renderConfirmRemove()

ilContainerResourceGUI::renderConfirmRemove ( )

private

Definition at line 408 of file class.ilContainerResourceGUI.php.

                                          : void
    {
        if (!$this->view_request->canUserAdministrate()) {
            $this->abortWithPermissionDenied();
            return;
        }
        $paths = $this->getPathsFromRequest();
 
        $stream = Streams::ofString(
            $this->ui_renderer->render(
                $this->ui_factory->modal()->interruptive(
                    $this->language->txt('action_remove_zip_path'),
                    $this->language->txt('action_remove_zip_path_msg'),
                    $this->ctrl->getLinkTarget($this, self::CMD_REMOVE)
                )->withAffectedItems(
                    array_map(fn(string $path_inside_zip): Standard => $this->ui_factory->modal()->interruptiveItem()->standard(
                        $this->hash($path_inside_zip),
                        $path_inside_zip
                    ), $paths)
                )
            )
        );
        $this->http->saveResponse($this->http->response()->withBody($stream));
        $this->http->sendResponse();
        $this->http->close();
    }

References abortWithPermissionDenied(), getPathsFromRequest(), and ILIAS\FileDelivery\http().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ supportsChunkedUploads()

ilContainerResourceGUI::supportsChunkedUploads ( )

Returns: bool if this uploadhandler chan handle Chunked Uploads. These come in multiple requests and must be combined to a single file. If your UploadHandler can handle Chunked Uploads, you can use a UI\Component\Input\Field\Upload\File with .

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

Definition at line 492 of file class.ilContainerResourceGUI.php.

                                            : bool
    {
        return false;
    }

◆ unzip()

ilContainerResourceGUI::unzip ( )

private

Definition at line 393 of file class.ilContainerResourceGUI.php.

                            : void
    {
        if (!$this->view_request->canUserAdministrate()) {
            $this->abortWithPermissionDenied();
            return;
        }
        $paths = $this->getPathsFromRequest()[0];
        $this->view_request->getWrapper()->unzip(
            $paths
        );
 
        $this->main_tpl->setOnScreenMessage('success', $this->language->txt('rids_appended'), true);
        $this->ctrl->redirect($this, self::CMD_INDEX);
    }

References abortWithPermissionDenied(), ILIAS\Repository\ctrl(), getPathsFromRequest(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ upload()

ilContainerResourceGUI::upload ( )

Definition at line 297 of file class.ilContainerResourceGUI.php.

                            : void
    {
        if (!$this->view_request->canUserUplaod()) {
            $this->abortWithPermissionDenied();
            return;
        }
        $this->upload->process();
        if (!$this->upload->hasUploads()) {
            return;
        }
        $container = $this->view_configuration->getContainer();
 
        foreach ($this->upload->getResults() as $result) {
            if (!$result->isOK()) {
                continue;
            }
            // store to zip
            $return = $this->irss->manageContainer()->addUploadToContainer(
                $container->getIdentification(),
                $result,
                $this->view_request->getPath()
            );
        }
 
        // OK
        $upload_result = new BasicHandlerResult(
            self::P_PATH,
            $return ? BasicHandlerResult::STATUS_OK : BasicHandlerResult::STATUS_FAILED,
            '-',
            'undefined error'
        );
        $response = $this->http->response()->withBody(Streams::ofString(json_encode($upload_result)));
        $this->http->saveResponse($response);
        $this->http->sendResponse();
        $this->http->close();
    }