Collaboration diagram for ilFileVersionsGUI:

Public Member Functions
	__construct (private ilObjFile $file)
	ilFileVersionsGUI constructor. More...

	executeCommand ()

	getFile ()

Data Fields
const	KEY_FILE_RID = 'file_rid'

const	KEY_FILE_EXTRACT = 'file_extract'

const	KEY_FILE_STRUCTURE = 'file_structure'

const	KEY_COPYRIGHT_OPTION = "copyright_option"

const	KEY_INHERIT_COPYRIGHT = "inherit_copyright"

const	KEY_SELECT_COPYRIGHT = "select_copyright"

const	KEY_COPYRIGHT_ID = "copyright_id"

const	CMD_DEFAULT = 'index'

const	CMD_DELETE_VERSIONS = "deleteVersions"

const	CMD_ROLLBACK_VERSION = "rollbackVersion"

const	CMD_DOWNLOAD_VERSION = "sendFile"

const	HIST_ID = 'hist_id'

const	CMD_CANCEL_DELETE = "cancelDeleteFile"

const	CMD_CONFIRMED_DELETE_FILE = "confirmDeleteFile"

const	CMD_CONFIRMED_DELETE_VERSIONS = 'confirmDeleteVersions'

const	CMD_ADD_NEW_VERSION = 'addNewVersion'

const	CMD_CREATE_NEW_VERSION = 'saveVersion'

const	CMD_ADD_REPLACING_VERSION = 'addReplacingVersion'

const	CMD_CREATE_REPLACING_VERSION = 'createReplacingVersion'

const	CMD_UNZIP_CURRENT_REVISION = Capabilities::UNZIP->value

const	CMD_PROCESS_UNZIP = 'processUnzip'

const	CMD_RENDER_DELETE_SELECTED_VERSIONS_MODAL = 'renderDeleteSelectedVersionsModal'

const	CMD_PUBLISH = 'publish'

const	CMD_UNPUBLISH = 'unpublish'

Protected Member Functions
	performCommand ()

	setBackTab ()

	renderDeleteSelectedVersionsModal ()

	getDeleteSelectedVersionsModal ()

	checkSanityOfDeletionRequest (array $requested_deletion_version, bool $redirect)

	getUIFactory ()

	getLanguage ()

Protected Attributes
UIServices	$ui

ilLanguage	$lng

ilCtrl	$ctrl

int	$version_id = null

ilTree	$tree

int	$parent_id

Refinery	$refinery

LOMServices	$lom_services

Private Member Functions
	unzipCurrentRevision ()

	publish ()

	unpublish ()

	processUnzip ()

	index ()

	addVersion (int $mode=ilFileVersionFormGUI::MODE_ADD)

	saveVersion (int $mode=ilFileVersionFormGUI::MODE_ADD)

	downloadVersion ()

	rollbackVersion ()

	confirmDeleteVersions ()

	confirmDeleteFile ()

	getVersionIdsFromRequest ()

	hasPermission (string $a_permission)
	bugfix mantis 26007: this function was created to ensure that the access check not only works for repository objects but for workspace objects too More...

	deleteVersions ()

	getFileZipOptionsForm ()

	getFileProcessor (bool $keep_structure)

	getIdentification ()

	getCurrentFileRevision ()

	getParentIdType ()

	isWorkspaceContext ()

Detailed Description

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

Definition at line 43 of file class.ilFileVersionsGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilFileVersionsGUI::__construct ( private ilObjFile $file )

ilFileVersionsGUI constructor.

Definition at line 97 of file class.ilFileVersionsGUI.php.

    {
        global $DIC;
        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->tabs = $DIC->tabs();
        $this->http = $DIC->http();
        $this->lng = $DIC->language();
        $this->ref_id = $this->http->wrapper()->query()->retrieve('ref_id', $DIC->refinery()->kindlyTo()->int());
        $this->toolbar = $DIC->toolbar();
        $this->access = $DIC->access();
        $this->storage = $DIC->resourceStorage();
        $this->file_service_settings = $DIC->fileServiceSettings();
        $this->ui = $DIC->ui();
        $this->tree = $this->isWorkspaceContext() ? new ilWorkspaceTree($DIC->user()->getId()) : $DIC->repositoryTree();
        $this->file_component_builder = new ilObjFileComponentBuilder($this->lng, $this->ui);
        $this->refinery = $DIC->refinery();
        $this->lom_services = $DIC->learningObjectMetadata();
 
        $this->parent_id = $this->tree->getParentId($this->file->getRefId()) ?? $this->getParentIdType();
        $this->wsp_access = new ilWorkspaceAccessHandler($this->tree);
        $this->version_id = $this->http->wrapper()->query()->has(self::HIST_ID)
            ? $this->http->wrapper()->query()->retrieve(self::HIST_ID, $DIC->refinery()->kindlyTo()->int())
            : null;
        $this->action_repo = new ActionDBRepository($DIC->database());
        $this->current_revision = $this->getCurrentFileRevision();
    }

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), getCurrentFileRevision(), getParentIdType(), ILIAS\FileDelivery\http(), isWorkspaceContext(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\ui().

Here is the call graph for this function:

Member Function Documentation

◆ addVersion()

ilFileVersionsGUI::addVersion ( int $mode = ilFileVersionFormGUI::MODE_ADD )

private

Definition at line 344 of file class.ilFileVersionsGUI.php.

                                                                         : void
    {
        $this->setBackTab();
 
        $form = new ilFileVersionFormGUI($this, $mode);
        $this->tpl->setContent($form->getHTML());
    }

References setBackTab().

Referenced by performCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkSanityOfDeletionRequest()

ilFileVersionsGUI::checkSanityOfDeletionRequest	(	array	$requested_deletion_version,
		bool	$redirect
	)

protected

Definition at line 533 of file class.ilFileVersionsGUI.php.

                                                                                                      : void
    {
        // Check Sanity of request
        // Cant delete version if current is a DRAFT
        if (
            $this->current_revision->getStatus() === RevisionStatus::DRAFT
        ) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('publish_before_delete'), $redirect);
            if ($redirect) {
                $this->ctrl->redirect($this, self::CMD_DEFAULT);
            }
        }
 
        // no checkbox has been selected
        if (count($requested_deletion_version) < 1) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("no_checkbox"), $redirect);
            if ($redirect) {
                $this->ctrl->redirect($this, self::CMD_DEFAULT);
            }
        }
    }

References ILIAS\Repository\ctrl(), ILIAS\ResourceStorage\Revision\DRAFT, and ILIAS\Repository\lng().

Referenced by deleteVersions(), and getDeleteSelectedVersionsModal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmDeleteFile()

ilFileVersionsGUI::confirmDeleteFile ( )

private

Definition at line 415 of file class.ilFileVersionsGUI.php.

                                        : void
    {
        $parent_id = $this->tree->getParentId($this->ref_id);
 
        ilRepUtil::deleteObjects($parent_id, [$this->ref_id]);
 
        // redirect to parent object
        $this->ctrl->setParameterByClass(ilRepositoryGUI::class, "ref_id", $parent_id);
        $this->ctrl->redirectByClass(ilRepositoryGUI::class);
    }

References $parent_id, ILIAS\Repository\ctrl(), and ilRepUtil\deleteObjects().

Referenced by performCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmDeleteVersions()

ilFileVersionsGUI::confirmDeleteVersions ( )

private

Definition at line 402 of file class.ilFileVersionsGUI.php.

                                            : void
    {
        // delete versions after confirmation
        $versions_to_delete = $this->getVersionIdsFromRequest();
        if ($versions_to_delete !== []) {
            $this->file->deleteVersions($versions_to_delete);
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("file_versions_deleted"), true);
        }
 
        $this->ctrl->setParameter($this, self::HIST_ID, "");
        $this->ctrl->redirect($this, self::CMD_DEFAULT);
    }

References ILIAS\Repository\ctrl(), getVersionIdsFromRequest(), and ILIAS\Repository\lng().

Referenced by performCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteVersions()

ilFileVersionsGUI::deleteVersions ( )

private

Definition at line 557 of file class.ilFileVersionsGUI.php.

                                     : void
    {
        $version_ids = $this->getVersionIdsFromRequest();
        $existing_versions = $this->file->getVersions();
        $remaining_versions = array_udiff(
            $existing_versions,
            $version_ids,
            static function ($a, $b): int|float {
                if ($a instanceof ilObjFileVersion) {
                    $a = $a->getHistEntryId();
                }
                if ($b instanceof ilObjFileVersion) {
                    $b = $b->getHistEntryId();
                }
                return $a - $b;
            }
        );
 
        $this->checkSanityOfDeletionRequest($version_ids, true);
 
        $conf_gui = new ilConfirmationGUI();
        $conf_gui->setFormAction($this->ctrl->getFormAction($this, self::CMD_DEFAULT));
        $conf_gui->setCancel($this->lng->txt("cancel"), self::CMD_DEFAULT);
 
        $icon = ilObject::_getIcon($this->file->getId(), "small", $this->file->getType());
        $alt = $this->lng->txt("icon") . " " . $this->lng->txt("obj_" . $this->file->getType());
 
        // only one version left, delete the whole file
        if (count($remaining_versions) < 1) {
            // Ask
            $conf_gui->setHeaderText($this->lng->txt('file_confirm_delete_all_versions'));
            $conf_gui->setConfirm($this->lng->txt("confirm"), self::CMD_CONFIRMED_DELETE_FILE);
            $conf_gui->addItem(
                "id[]",
                $this->ref_id,
                $this->file->getTitle(),
                $icon,
                $alt
            );
        } else {
            // Ask to delete version
            $conf_gui->setHeaderText($this->lng->txt('file_confirm_delete_versions'));
            $conf_gui->setConfirm($this->lng->txt("confirm"), self::CMD_CONFIRMED_DELETE_VERSIONS);
 
            foreach ($this->file->getVersions($version_ids) as $version) {
                $a_text = $version['filename'] ?? $version->getFilename() ?? $this->file->getTitle();
                $version_string = $version['hist_id'] ?? $version->getVersion();
                $a_text .= " (v" . $version_string . ")";
                $conf_gui->addItem(
                    "hist_id[]",
                    $version['hist_entry_id'],
                    $a_text,
                    $icon,
                    $alt
                );
            }
        }
 
        $this->tpl->setContent($conf_gui->getHTML());
    }

References Vendor\Package\$a, Vendor\Package\$b, $version, ilObject\_getIcon(), checkSanityOfDeletionRequest(), ILIAS\Repository\ctrl(), getVersionIdsFromRequest(), and ILIAS\Repository\lng().

Referenced by performCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ downloadVersion()

ilFileVersionsGUI::downloadVersion ( )

private

Definition at line 366 of file class.ilFileVersionsGUI.php.

                                      : void
    {
        try {
            $this->file->sendFile($this->version_id);
        } catch (FileNotFoundException) {
        }
    }

Referenced by performCommand().

Here is the caller graph for this function:

◆ executeCommand()

ilFileVersionsGUI::executeCommand ( )

Definition at line 164 of file class.ilFileVersionsGUI.php.

                                    : void
    {
        // bugfix mantis 26007: use new function hasPermission to ensure that the check also works for workspace files
        if (!$this->hasPermission('write')) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            $this->ctrl->returnToParent($this);
        }
        switch ($this->ctrl->getNextClass()) {
            case strtolower(ilFileVersionsUploadHandlerGUI::class):
                $this->ctrl->forwardCommand(
                    new ilFileVersionsUploadHandlerGUI(
                        $this->file
                    )
                );
                return;
            case strtolower(ilWOPIEmbeddedApplicationGUI::class):
                $action = $this->action_repo->getEditActionForSuffix(
                    $this->current_revision->getInformation()->getSuffix()
                );
 
                $embeded_application = new EmbeddedApplication(
                    $this->current_revision->getIdentification(),
                    $action,
                    new ilObjFileStakeholder(),
                    new URI(rtrim(ILIAS_HTTP_PATH, "/") . "/" . $this->ctrl->getLinkTarget($this, self::CMD_DEFAULT)),
                    false,
                    $this->lng->getLangKey()
                );
 
                $this->ctrl->forwardCommand(
                    new ilWOPIEmbeddedApplicationGUI(
                        $embeded_application
                    )
                );
                break;
            default:
                $this->performCommand();
                break;
        }
    }

References ILIAS\Repository\ctrl(), hasPermission(), ILIAS\Repository\lng(), and performCommand().

Here is the call graph for this function:

◆ getCurrentFileRevision()

ilFileVersionsGUI::getCurrentFileRevision ( )

private

Definition at line 711 of file class.ilFileVersionsGUI.php.

                                             : ?Revision
    {
        $file_rid = $this->getIdentification();
        if (null !== $file_rid) {
            return $this->storage->manage()->getCurrentRevisionIncludingDraft($file_rid);
        }
 
        return null;
    }

References getIdentification().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDeleteSelectedVersionsModal()

ilFileVersionsGUI::getDeleteSelectedVersionsModal ( )

protected

Definition at line 498 of file class.ilFileVersionsGUI.php.

                                                       : ?Interruptive
    {
        $deletion_version_ids = $this->getVersionIdsFromRequest();
        $existing_versions = $this->file->getVersions();
 
        $non_deletion_versions = array_udiff(
            $existing_versions,
            $deletion_version_ids,
            static function ($a, $b): int|float {
                if ($a instanceof ilObjFileVersion) {
                    $a = $a->getHistEntryId();
                }
                if ($b instanceof ilObjFileVersion) {
                    $b = $b->getHistEntryId();
                }
                return $a - $b;
            }
        );
        $this->checkSanityOfDeletionRequest($deletion_version_ids, false);
 
        // no version will remain after deletion, so we can delete the whole file
        if (count($non_deletion_versions) < 1) {
            return $this->file_component_builder->buildConfirmDeleteAllVersionsModal(
                $this->ctrl->getFormActionByClass(self::class, self::CMD_CONFIRMED_DELETE_FILE),
                $this->file
            );
        }
        // confirm the deletion of the selected versions
        return $this->file_component_builder->buildConfirmDeleteSpecificVersionsModal(
            $this->ctrl->getFormActionByClass(self::class, self::CMD_CONFIRMED_DELETE_VERSIONS),
            $this->file,
            $deletion_version_ids
        );
    }

References Vendor\Package\$a, Vendor\Package\$b, checkSanityOfDeletionRequest(), ILIAS\Repository\ctrl(), and getVersionIdsFromRequest().

Referenced by renderDeleteSelectedVersionsModal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFile()

ilFileVersionsGUI::getFile ( )

Definition at line 426 of file class.ilFileVersionsGUI.php.

                             : ilObjFile
    {
        return $this->file;
    }

Referenced by ilFileVersionsTableGUI\__construct(), and ilFileVersionFormGUI\__construct().

Here is the caller graph for this function:

◆ getFileProcessor()

ilFileVersionsGUI::getFileProcessor ( bool $keep_structure )

private

Definition at line 675 of file class.ilFileVersionsGUI.php.

                                                           : ilObjFileProcessorInterface
    {
        $context = $this->getParentIdType();
 
        if ($keep_structure) {
            return new ilObjFileUnzipRecursiveProcessor(
                new ilObjFileStakeholder(),
                new ilObjFileGUI(
                    $this->file->getId(),
                    $context,
                    $this->parent_id
                ),
                $this->storage,
                $this->file_service_settings,
                $this->tree
            );
        }
 
        return new ilObjFileUnzipFlatProcessor(
            new ilObjFileStakeholder(),
            new ilObjFileGUI(
                $this->file->getId(),
                $context,
                $this->parent_id
            ),
            $this->storage,
            $this->file_service_settings,
            $this->tree
        );
    }

References $context, and getParentIdType().

Referenced by processUnzip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFileZipOptionsForm()

ilFileVersionsGUI::getFileZipOptionsForm ( )

private

Definition at line 618 of file class.ilFileVersionsGUI.php.

                                            : Form
    {
        $inputs = [];
        $copyright_options = [];
        $form_action = $this->ctrl->getFormActionByClass(self::class, self::CMD_PROCESS_UNZIP);
 
        $inputs[self::KEY_FILE_RID] = $this->ui->factory()->input()->field()->hidden()->withValue(
            $this->file->getResourceId()
        );
        $inputs[self::KEY_FILE_STRUCTURE] = $this->ui->factory()->input()->field()->checkbox(
            $this->lng->txt('take_over_structure'),
            $this->lng->txt('take_over_structure_info'),
        );
 
        if (!$this->lom_services->copyrightHelper()->isCopyrightSelectionActive()) {
            return $this->ui->factory()->input()->container()->form()->standard($form_action, $inputs);
        }
 
        $lom_reader = $this->lom_services->read($this->file->getId(), 0, $this->file->getType());
        $lom_cp_helper = $this->lom_services->copyrightHelper();
 
        if ($lom_cp_helper->hasPresetCopyright($lom_reader)) {
            $zip_copyright = $lom_cp_helper->readPresetCopyright($lom_reader);
            $zip_copyright_id = $zip_copyright->identifier();
            $zip_copyright_title = $zip_copyright->title();
        } else {
            $zip_copyright_id = $zip_copyright_title = $lom_cp_helper->readCustomCopyright($lom_reader);
        }
        if ($zip_copyright_id !== '') {
            $copyright_inheritance_input = $this->ui->factory()->input()->field()->hidden()->withValue(
                $zip_copyright_id
            );
            $copyright_options[self::KEY_INHERIT_COPYRIGHT] = $this->ui->factory()->input()->field()->group(
                [self::KEY_COPYRIGHT_ID => $copyright_inheritance_input],
                $this->lng->txt("copyright_inherited"),
                sprintf(
                    $this->lng->txt("copyright_inherited_info"),
                    $zip_copyright_title
                )
            );
        }
 
        $copyright_selection_input = $this->getCopyrightSelectionInput('set_license_for_all_files');
        $copyright_options[self::KEY_SELECT_COPYRIGHT] = $this->ui->factory()->input()->field()->group(
            [self::KEY_COPYRIGHT_ID => $copyright_selection_input],
            $this->lng->txt("copyright_custom"),
            $this->lng->txt("copyright_custom_info")
        );
 
        $inputs[self::KEY_COPYRIGHT_OPTION] = $this->ui->factory()->input()->field()->switchableGroup(
            $copyright_options,
            $this->lng->txt("md_copyright")
        )->withValue(self::KEY_SELECT_COPYRIGHT);
 
        return $this->ui->factory()->input()->container()->form()->standard($form_action, $inputs);
    }

References ILIAS\UI\Implementation\Component\Input\$inputs, ILIAS\Repository\ctrl(), KEY_COPYRIGHT_OPTION, KEY_FILE_RID, KEY_FILE_STRUCTURE, KEY_INHERIT_COPYRIGHT, KEY_SELECT_COPYRIGHT, ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Referenced by processUnzip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIdentification()

ilFileVersionsGUI::getIdentification ( )

private

Definition at line 706 of file class.ilFileVersionsGUI.php.

                                        : ?ResourceIdentification
    {
        return $this->storage->manage()->find($this->file->getResourceId());
    }

Referenced by getCurrentFileRevision(), publish(), and unpublish().

Here is the caller graph for this function:

◆ getLanguage()

ilFileVersionsGUI::getLanguage ( )

protected

Definition at line 738 of file class.ilFileVersionsGUI.php.

                                    : \ilLanguage
    {
        return $this->lng;
    }

References $lng.

◆ getParentIdType()

ilFileVersionsGUI::getParentIdType ( )

private

Definition at line 721 of file class.ilFileVersionsGUI.php.

                                      : int
    {
        return ($this->isWorkspaceContext()) ?
            ilObject2GUI::WORKSPACE_NODE_ID :
            ilObject2GUI::REPOSITORY_NODE_ID;
    }

References isWorkspaceContext(), ilObject2GUI\REPOSITORY_NODE_ID, and ilObject2GUI\WORKSPACE_NODE_ID.

Referenced by __construct(), and getFileProcessor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUIFactory()

ilFileVersionsGUI::getUIFactory ( )

protected

Definition at line 733 of file class.ilFileVersionsGUI.php.

                                     : ILIAS\UI\Factory
    {
        return $this->ui->factory();
    }

References ILIAS\Repository\ui().

Here is the call graph for this function:

◆ getVersionIdsFromRequest()

ilFileVersionsGUI::getVersionIdsFromRequest ( )

private

in case request is triggered by

See also: self::CMD_RENDER_DELETE_SELECTED_VERSIONS_MODAL

Definition at line 431 of file class.ilFileVersionsGUI.php.

                                               : array
    {
        if ('GET' === $this->http->request()->getMethod() &&
            $this->http->wrapper()->query()->has(self::HIST_ID)
        ) {
            return [
                $this->http->wrapper()->query()->retrieve(self::HIST_ID, $this->refinery->kindlyTo()->int()),
            ];
        }
 
        if ($this->http->wrapper()->post()->has('interruptive_items')) {
            return $this->http->wrapper()->post()->retrieve(
                'interruptive_items',
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
            );
        }
 
        if ($this->http->wrapper()->post()->has(self::HIST_ID)) {
            return $this->http->wrapper()->post()->retrieve(
                self::HIST_ID,
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
            );
        }
 
        return [];
    }

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

Referenced by confirmDeleteVersions(), deleteVersions(), getDeleteSelectedVersionsModal(), and rollbackVersion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasPermission()

ilFileVersionsGUI::hasPermission ( string $a_permission )

private

bugfix mantis 26007: this function was created to ensure that the access check not only works for repository objects but for workspace objects too

Definition at line 464 of file class.ilFileVersionsGUI.php.

                                                        : bool
    {
        // determine if the permission check concerns a workspace- or repository-object
        if ($this->isWorkspaceContext()) {
            // permission-check concerning a workspace object
            if ($this->wsp_access->checkAccess($a_permission, "", $this->ref_id)) {
                return true;
            }
        } elseif ($this->access->checkAccess($a_permission, '', $this->ref_id)) {
            // permission-check concerning a repository object
            return true;
        }
 
        return false;
    }

References ILIAS\Repository\access(), and isWorkspaceContext().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ index()

ilFileVersionsGUI::index ( )

private

Definition at line 276 of file class.ilFileVersionsGUI.php.

                            : void
    {
        // Buttons
        $status = $this->current_revision?->getStatus();
 
        $btn_add_version = $this->ui->factory()->button()->standard(
            $this->lng->txt('file_new_version'),
            $this->ctrl->getLinkTarget($this, self::CMD_ADD_NEW_VERSION)
        );
        if ($status === RevisionStatus::DRAFT) {
            $btn_add_version = $btn_add_version->withUnavailableAction();
        }
        $this->toolbar->addComponent($btn_add_version);
 
        $btn_replace_version = $this->ui->factory()->button()->standard(
            $this->lng->txt('replace_file'),
            $this->ctrl->getLinkTarget($this, self::CMD_ADD_REPLACING_VERSION)
        );
        if ($status === RevisionStatus::DRAFT) {
            $btn_replace_version = $btn_replace_version->withUnavailableAction();
        }
        $this->toolbar->addComponent($btn_replace_version);
 
        // only add unzip button if the current revision is a zip.
        if (null !== $this->current_revision &&
            in_array($this->current_revision->getInformation()->getMimeType(), [MimeType::APPLICATION__ZIP, MimeType::APPLICATION__X_ZIP_COMPRESSED], true)
        ) {
            $btn_unzip = $this->ui->factory()->button()->standard(
                $this->lng->txt('unzip'),
                $this->ctrl->getLinkTarget($this, self::CMD_UNZIP_CURRENT_REVISION)
            );
            $this->toolbar->addComponent($btn_unzip);
        }
 
        // Editor
        $this->current_revision?->getInformation()?->getSuffix();
 
        if ($this->action_repo->hasEditActionForSuffix(
            $this->current_revision->getInformation()->getSuffix()
        )) {
            $external_editor = $this->ui->factory()
                                        ->button()
                                        ->standard(
                                            $this->lng->txt('open_external_editor'),
                                            $this->ctrl->getLinkTargetByClass(
                                                [self::class, ilWOPIEmbeddedApplicationGUI::class],
                                                \ilWOPIEmbeddedApplicationGUI::CMD_EDIT
                                            )
                                        );
            $this->toolbar->addComponent($external_editor);
        }
 
 
        // Publish
        if ($status === RevisionStatus::DRAFT) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('file_version_draft_info'));
 
            $btn_publish = $this->ui->factory()->button()->standard(
                $this->lng->txt('file_publish'),
                $this->ctrl->getLinkTarget($this, self::CMD_PUBLISH)
            );
            $this->toolbar->addComponent($btn_publish);
        }
 
        $table = new ilFileVersionsTableGUI($this, self::CMD_DEFAULT);
        $this->tpl->setContent($table->getHTML());
    }

References ilWOPIEmbeddedApplicationGUI\CMD_EDIT, ILIAS\ResourceStorage\Revision\DRAFT, ILIAS\Repository\lng(), ILIAS\Repository\toolbar(), and ILIAS\Repository\ui().

Referenced by performCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isWorkspaceContext()

ilFileVersionsGUI::isWorkspaceContext ( )

private

Definition at line 728 of file class.ilFileVersionsGUI.php.

                                         : bool
    {
        return $this->http->wrapper()->query()->has('wsp_id');
    }

References ILIAS\FileDelivery\http().

Referenced by __construct(), getParentIdType(), and hasPermission().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ performCommand()

ilFileVersionsGUI::performCommand ( )

protected

Exceptions

NoSuchElementException
IllegalStateException

Definition at line 131 of file class.ilFileVersionsGUI.php.

                                       : void
    {
        match ($this->ctrl->getCmd(self::CMD_DEFAULT)) {
            self::CMD_DEFAULT => $this->index(),
            self::CMD_DOWNLOAD_VERSION => $this->downloadVersion(),
            self::CMD_DELETE_VERSIONS => $this->deleteVersions(),
            self::CMD_ROLLBACK_VERSION => $this->rollbackVersion(),
            self::CMD_ADD_NEW_VERSION => $this->addVersion(ilFileVersionFormGUI::MODE_ADD),
            self::CMD_ADD_REPLACING_VERSION => $this->addVersion(ilFileVersionFormGUI::MODE_REPLACE),
            self::CMD_CREATE_NEW_VERSION => $this->saveVersion(ilFileVersionFormGUI::MODE_ADD),
            self::CMD_CREATE_REPLACING_VERSION => $this->saveVersion(ilFileVersionFormGUI::MODE_REPLACE),
            self::CMD_CONFIRMED_DELETE_VERSIONS => $this->confirmDeleteVersions(),
            self::CMD_CONFIRMED_DELETE_FILE => $this->confirmDeleteFile(),
            self::CMD_UNZIP_CURRENT_REVISION => $this->unzipCurrentRevision(),
            self::CMD_PROCESS_UNZIP => $this->processUnzip(),
            self::CMD_RENDER_DELETE_SELECTED_VERSIONS_MODAL => $this->renderDeleteSelectedVersionsModal(),
            self::CMD_PUBLISH => $this->publish(),
            self::CMD_UNPUBLISH => $this->unpublish()
        };
    }

References addVersion(), confirmDeleteFile(), confirmDeleteVersions(), ILIAS\Repository\ctrl(), deleteVersions(), downloadVersion(), index(), ilFileVersionFormGUI\MODE_ADD, ilFileVersionFormGUI\MODE_REPLACE, processUnzip(), publish(), renderDeleteSelectedVersionsModal(), rollbackVersion(), saveVersion(), unpublish(), and unzipCurrentRevision().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processUnzip()

ilFileVersionsGUI::processUnzip ( )

private

Definition at line 238 of file class.ilFileVersionsGUI.php.

                                   : void
    {
        $form = $this->getFileZipOptionsForm()->withRequest($this->http->request());
        $data = $form->getData();
 
        if (!empty($data)) {
            $file_rid = $this->storage->manage()->find($data[self::KEY_FILE_RID]);
            if (null !== $file_rid) {
                $copyright_id = $data[self::KEY_COPYRIGHT_OPTION][1][self::KEY_COPYRIGHT_ID] ?? null;
                $processor = $this->getFileProcessor($data[self::KEY_FILE_STRUCTURE]);
                $processor->process($file_rid, null, null, $copyright_id);
 
                if ($processor->getInvalidFileNames() !== []) {
                    $this->ui->mainTemplate()->setOnScreenMessage(
                        'info',
                        sprintf(
                            $this->lng->txt('file_upload_info_file_with_critical_extension'),
                            implode(', ', $processor->getInvalidFileNames())
                        ),
                        true
                    );
                }
 
                $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_unzip_success'), true);
                $this->ctrl->setParameterByClass(ilRepositoryGUI::class, "ref_id", $this->parent_id);
                $this->ctrl->redirectByClass(ilRepositoryGUI::class);
            }
 
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('file_not_found'));
        }
 
        $this->tpl->setContent(
            $this->ui->renderer()->render(
                $this->getFileZipOptionsForm()
            )
        );
    }

References $data, ILIAS\Repository\ctrl(), getFileProcessor(), getFileZipOptionsForm(), ILIAS\FileDelivery\http(), KEY_COPYRIGHT_ID, KEY_COPYRIGHT_OPTION, ILIAS\Repository\lng(), and ILIAS\Repository\ui().

Referenced by performCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ publish()

ilFileVersionsGUI::publish ( )

private

Definition at line 215 of file class.ilFileVersionsGUI.php.

                              : void
    {
        $this->file->enableNotification();
        $this->storage->manage()->publish($this->getIdentification());
        $this->file->updateObjectFromCurrentRevision();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
        $this->ctrl->redirect($this, self::CMD_DEFAULT);
    }

References ILIAS\Repository\ctrl(), getIdentification(), and ILIAS\Repository\lng().

Referenced by performCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderDeleteSelectedVersionsModal()

ilFileVersionsGUI::renderDeleteSelectedVersionsModal ( )

protected

Definition at line 480 of file class.ilFileVersionsGUI.php.

                                                          : void
    {
        $delete_selected_versions_modal = $this->getDeleteSelectedVersionsModal();
 
        $this->http->saveResponse(
            $this->http->response()->withBody(
                Streams::ofString(
                    (null !== $delete_selected_versions_modal) ?
                        $this->ui->renderer()->renderAsync([$delete_selected_versions_modal]) :
                        ''
                )
            )->withHeader('Content-Type', 'application/json; charset=utf-8')
        );
 
        $this->http->sendResponse();
        $this->http->close();
    }

References getDeleteSelectedVersionsModal(), and ILIAS\FileDelivery\http().

Referenced by performCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rollbackVersion()

ilFileVersionsGUI::rollbackVersion ( )

private

Definition at line 374 of file class.ilFileVersionsGUI.php.

                                      : void
    {
        $version_ids = $this->getVersionIdsFromRequest();
 
        // more than one entry selected?
        if (count($version_ids) !== 1) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("file_rollback_select_exact_one"), true);
            $this->ctrl->redirect($this, self::CMD_DEFAULT);
        }
 
        if ($this->current_revision->getStatus() === RevisionStatus::DRAFT) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("file_rollback_rollback_first"), true);
            $this->ctrl->redirect($this, self::CMD_DEFAULT);
        }
 
        // rollback the version
        $version_id = $version_ids[0];
        if ($version_id === $this->current_revision->getVersionNumber()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("file_rollback_same_version"), true);
            $this->ctrl->redirect($this, self::CMD_DEFAULT);
        }
 
        $this->file->rollback($version_id);
 
        $this->tpl->setOnScreenMessage('success', sprintf($this->lng->txt("file_rollback_done"), (string) $version_id), true);
        $this->ctrl->redirect($this, self::CMD_DEFAULT);
    }

References $version_id, ILIAS\Repository\ctrl(), ILIAS\ResourceStorage\Revision\DRAFT, getVersionIdsFromRequest(), and ILIAS\Repository\lng().

Referenced by performCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveVersion()

ilFileVersionsGUI::saveVersion ( int $mode = ilFileVersionFormGUI::MODE_ADD )

private

Exceptions

NoSuchElementException
IllegalStateException

Definition at line 356 of file class.ilFileVersionsGUI.php.

                                                                          : void
    {
        $form = new ilFileVersionFormGUI($this, $mode);
        if ($form->saveObject()) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
            $this->ctrl->redirect($this, self::CMD_DEFAULT);
        }
        $this->tpl->setContent($form->getHTML());
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by performCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBackTab()

ilFileVersionsGUI::setBackTab ( )

protected

Exceptions

ilCtrlException

Definition at line 155 of file class.ilFileVersionsGUI.php.

                                   : void
    {
        $this->tabs->clearTargets();
        $this->tabs->setBackTarget(
            $this->lng->txt('back'),
            $this->ctrl->getLinkTarget($this, self::CMD_DEFAULT)
        );
    }

References ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Referenced by addVersion(), and unzipCurrentRevision().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unpublish()

ilFileVersionsGUI::unpublish ( )

private

Definition at line 224 of file class.ilFileVersionsGUI.php.

                                : void
    {
        $this->file->enableNotification();
        if ($this->current_revision->getVersionNumber() === 1) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_cant_unpublish'), true);
            $this->ctrl->redirect($this, self::CMD_DEFAULT);
        }
 
        $this->storage->manage()->unpublish($this->getIdentification());
        $this->file->updateObjectFromCurrentRevision();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_obj_modified'), true);
        $this->ctrl->redirect($this, self::CMD_DEFAULT);
    }

References ILIAS\Repository\ctrl(), getIdentification(), and ILIAS\Repository\lng().

Referenced by performCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ unzipCurrentRevision()

ilFileVersionsGUI::unzipCurrentRevision ( )

private

Definition at line 205 of file class.ilFileVersionsGUI.php.

                                           : void
    {
        $this->setBackTab();
        $this->tpl->setContent(
            $this->ui->renderer()->render(
                $this->getFileZipOptionsForm()
            )
        );
    }

References setBackTab(), and ILIAS\Repository\ui().

Referenced by performCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

Definition at line 81 of file class.ilFileVersionsGUI.php.

Referenced by getLanguage().

◆ $lom_services

LOMServices ilFileVersionsGUI::$lom_services

protected

Definition at line 92 of file class.ilFileVersionsGUI.php.

◆ $parent_id

int ilFileVersionsGUI::$parent_id

◆ $wsp_access

ilWorkspaceAccessHandler ilFileVersionsGUI::$wsp_access

private

Definition at line 79 of file class.ilFileVersionsGUI.php.

◆ CMD_ADD_NEW_VERSION

const ilFileVersionsGUI::CMD_ADD_NEW_VERSION = 'addNewVersion'

Definition at line 63 of file class.ilFileVersionsGUI.php.

◆ CMD_ADD_REPLACING_VERSION

const ilFileVersionsGUI::CMD_ADD_REPLACING_VERSION = 'addReplacingVersion'

Definition at line 65 of file class.ilFileVersionsGUI.php.

◆ CMD_CANCEL_DELETE

const ilFileVersionsGUI::CMD_CANCEL_DELETE = "cancelDeleteFile"

Definition at line 60 of file class.ilFileVersionsGUI.php.

◆ CMD_CONFIRMED_DELETE_FILE

const ilFileVersionsGUI::CMD_CONFIRMED_DELETE_FILE = "confirmDeleteFile"

Definition at line 61 of file class.ilFileVersionsGUI.php.

◆ CMD_CONFIRMED_DELETE_VERSIONS

const ilFileVersionsGUI::CMD_CONFIRMED_DELETE_VERSIONS = 'confirmDeleteVersions'

Definition at line 62 of file class.ilFileVersionsGUI.php.

◆ CMD_CREATE_NEW_VERSION

const ilFileVersionsGUI::CMD_CREATE_NEW_VERSION = 'saveVersion'

Definition at line 64 of file class.ilFileVersionsGUI.php.

Referenced by ilFileVersionFormGUI\resolveParentCommand().

◆ CMD_CREATE_REPLACING_VERSION

const ilFileVersionsGUI::CMD_CREATE_REPLACING_VERSION = 'createReplacingVersion'

Definition at line 66 of file class.ilFileVersionsGUI.php.

Referenced by ilFileVersionFormGUI\resolveParentCommand().

◆ CMD_DEFAULT

const ilFileVersionsGUI::CMD_DEFAULT = 'index'

Definition at line 55 of file class.ilFileVersionsGUI.php.

Referenced by ilObjFileGUI\setTabs().

◆ CMD_DELETE_VERSIONS

const ilFileVersionsGUI::CMD_DELETE_VERSIONS = "deleteVersions"

Definition at line 56 of file class.ilFileVersionsGUI.php.

Referenced by ilFileVersionsTableGUI\__construct().

◆ CMD_DOWNLOAD_VERSION

const ilFileVersionsGUI::CMD_DOWNLOAD_VERSION = "sendFile"

Definition at line 58 of file class.ilFileVersionsGUI.php.

Referenced by ilFileVersionsTableGUI\fillRow().

◆ CMD_PROCESS_UNZIP

const ilFileVersionsGUI::CMD_PROCESS_UNZIP = 'processUnzip'

Definition at line 68 of file class.ilFileVersionsGUI.php.

◆ CMD_PUBLISH

const ilFileVersionsGUI::CMD_PUBLISH = 'publish'

Definition at line 70 of file class.ilFileVersionsGUI.php.

Referenced by ilFileVersionsTableGUI\fillRow().

◆ CMD_RENDER_DELETE_SELECTED_VERSIONS_MODAL

const ilFileVersionsGUI::CMD_RENDER_DELETE_SELECTED_VERSIONS_MODAL = 'renderDeleteSelectedVersionsModal'

Definition at line 69 of file class.ilFileVersionsGUI.php.

Referenced by ilFileVersionsTableGUI\fillRow().

◆ CMD_ROLLBACK_VERSION

const ilFileVersionsGUI::CMD_ROLLBACK_VERSION = "rollbackVersion"

Definition at line 57 of file class.ilFileVersionsGUI.php.

Referenced by ilFileVersionsTableGUI\__construct(), and ilFileVersionsTableGUI\fillRow().

◆ CMD_UNPUBLISH

const ilFileVersionsGUI::CMD_UNPUBLISH = 'unpublish'

Definition at line 71 of file class.ilFileVersionsGUI.php.

Referenced by ilFileVersionsTableGUI\fillRow().

◆ CMD_UNZIP_CURRENT_REVISION

const ilFileVersionsGUI::CMD_UNZIP_CURRENT_REVISION = Capabilities::UNZIP->value

Definition at line 67 of file class.ilFileVersionsGUI.php.

◆ HIST_ID

const ilFileVersionsGUI::HIST_ID = 'hist_id'

Definition at line 59 of file class.ilFileVersionsGUI.php.

Referenced by ilFileVersionsTableGUI\fillRow().

◆ KEY_COPYRIGHT_ID

const ilFileVersionsGUI::KEY_COPYRIGHT_ID = "copyright_id"

Definition at line 53 of file class.ilFileVersionsGUI.php.

Referenced by processUnzip().

◆ KEY_COPYRIGHT_OPTION

const ilFileVersionsGUI::KEY_COPYRIGHT_OPTION = "copyright_option"

Definition at line 50 of file class.ilFileVersionsGUI.php.

Referenced by getFileZipOptionsForm(), and processUnzip().

◆ KEY_FILE_EXTRACT

const ilFileVersionsGUI::KEY_FILE_EXTRACT = 'file_extract'

Definition at line 48 of file class.ilFileVersionsGUI.php.

◆ KEY_FILE_RID

const ilFileVersionsGUI::KEY_FILE_RID = 'file_rid'

Definition at line 47 of file class.ilFileVersionsGUI.php.

Referenced by getFileZipOptionsForm().

◆ KEY_FILE_STRUCTURE

const ilFileVersionsGUI::KEY_FILE_STRUCTURE = 'file_structure'

Definition at line 49 of file class.ilFileVersionsGUI.php.

Referenced by getFileZipOptionsForm().

◆ KEY_INHERIT_COPYRIGHT

const ilFileVersionsGUI::KEY_INHERIT_COPYRIGHT = "inherit_copyright"

Definition at line 51 of file class.ilFileVersionsGUI.php.

Referenced by getFileZipOptionsForm().

◆ KEY_SELECT_COPYRIGHT

const ilFileVersionsGUI::KEY_SELECT_COPYRIGHT = "select_copyright"

Definition at line 52 of file class.ilFileVersionsGUI.php.

Referenced by getFileZipOptionsForm().

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

components/ILIAS/File/classes/Versions/class.ilFileVersionsGUI.php

Private Attributes
ilToolbarGUI	$toolbar

ILIAS ResourceStorage Services	$storage

ActionRepository	$action_repo

Revision	$current_revision

ilAccessHandler	$access

ilWorkspaceAccessHandler	$wsp_access

int	$ref_id

Services	$http

ilTabsGUI	$tabs

ilGlobalTemplateInterface	$tpl

ilFileServicesSettings	$file_service_settings

ilObjFileComponentBuilder	$file_component_builder

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addVersion()

◆ checkSanityOfDeletionRequest()

◆ confirmDeleteFile()

◆ confirmDeleteVersions()

◆ deleteVersions()

◆ downloadVersion()

◆ executeCommand()

◆ getCurrentFileRevision()

◆ getDeleteSelectedVersionsModal()

◆ getFile()

◆ getFileProcessor()

◆ getFileZipOptionsForm()

◆ getIdentification()

◆ getLanguage()

◆ getParentIdType()

◆ getUIFactory()

◆ getVersionIdsFromRequest()

◆ hasPermission()

◆ index()

◆ isWorkspaceContext()

◆ performCommand()

◆ processUnzip()

◆ publish()

◆ renderDeleteSelectedVersionsModal()

◆ rollbackVersion()

◆ saveVersion()

◆ setBackTab()

◆ unpublish()

◆ unzipCurrentRevision()

Field Documentation

◆ $access

◆ $action_repo

◆ $ctrl

◆ $current_revision

◆ $file_component_builder

◆ $file_service_settings

◆ $http

◆ $lng

◆ $lom_services

◆ $parent_id

◆ $ref_id

◆ $refinery

◆ $storage

◆ $tabs

◆ $toolbar

◆ $tpl

◆ $tree

◆ $ui

◆ $version_id

◆ $wsp_access

◆ CMD_ADD_NEW_VERSION

◆ CMD_ADD_REPLACING_VERSION

◆ CMD_CANCEL_DELETE

◆ CMD_CONFIRMED_DELETE_FILE

◆ CMD_CONFIRMED_DELETE_VERSIONS

◆ CMD_CREATE_NEW_VERSION

◆ CMD_CREATE_REPLACING_VERSION

◆ CMD_DEFAULT

◆ CMD_DELETE_VERSIONS

◆ CMD_DOWNLOAD_VERSION

◆ CMD_PROCESS_UNZIP

◆ CMD_PUBLISH

◆ CMD_RENDER_DELETE_SELECTED_VERSIONS_MODAL

◆ CMD_ROLLBACK_VERSION

◆ CMD_UNPUBLISH

◆ CMD_UNZIP_CURRENT_REVISION

◆ HIST_ID

◆ KEY_COPYRIGHT_ID

◆ KEY_COPYRIGHT_OPTION

◆ KEY_FILE_EXTRACT