class.ilObjFileServicesGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Refinery\Factory;
use ILIAS\HTTP\Wrapper\WrapperFactory;

class ilObjFileServicesGUI extends ilObject2GUI
{
    public const CMD_EDIT_SETTINGS = 'editSettings';
    protected const TAB_PERMISSIONS = 'perm_settings';
    protected const TAB_SETTINGS = 'settings';
    protected const TAB_OVERVIEW = 'resource_overview';
    protected const TAB_UPLOAD_LIMITS = 'upload_limits';

    protected ilTabsGUI $tabs;
    public ilLanguage $lng;
    public ilErrorHandling $error_handling;
    protected ilCtrl $ctrl;
    protected ilSetting $settings;
    public ilGlobalTemplateInterface $tpl;
    protected Factory $refinery;
    protected WrapperFactory $http;
    protected ilFileServicesSettings $file_service_settings;

    public function __construct(int $id = 0, int $id_type = self::REPOSITORY_NODE_ID, int $parent_node_id = 0)
    {
        global $DIC;

        $this->type = ilObjFileServices::TYPE_FILE_SERVICES;
        parent::__construct($id, $id_type, $parent_node_id);

        $this->tabs = $DIC['ilTabs'];
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('adn');
        $this->lng->loadLanguageModule('irss');
        $this->ctrl = $DIC['ilCtrl'];
        $this->tpl = $DIC['tpl'];
        $this->tree = $DIC['tree'];
        $this->settings = $DIC['ilSetting'];
        $this->error_handling = $DIC["ilErr"];
        $this->http = $DIC->http()->wrapper();
        $this->ref_id = $this->http->query()->retrieve('ref_id', $DIC->refinery()->kindlyTo()->int());
        $this->refinery = $DIC->refinery();
        $this->file_service_settings = $DIC->fileServiceSettings();
    }

    public function getType(): string
    {
        return ilObjFileServices::TYPE_FILE_SERVICES;
    }

    protected function checkPermissionOrFail(string $str): void
    {
        if (!$this->hasUserPermissionTo($str)) {
            $this->error_handling->raiseError(
                $this->lng->txt('no_permission'),
                $this->error->MESSAGE
            );
        }
    }

    protected function hasUserPermissionTo(string $str): bool
    {
        return $this->access->checkAccess($str, '', $this->ref_id);
    }

    #[\Override]
    public function executeCommand(): void
    {
        $this->lng->loadLanguageModule("fils");

        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        $this->prepareOutput();
        $this->checkPermissionOrFail('read');

        switch ($next_class) {
            case strtolower(ilPermissionGUI::class):
                $this->tabs_gui->activateTab(self::TAB_PERMISSIONS);
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;
            case strtolower(ilResourceOverviewGUI::class):
                $this->tabs_gui->activateTab(self::TAB_OVERVIEW);
                $overview = new ilResourceOverviewGUI();
                $this->ctrl->forwardCommand($overview);
                break;
            case strtolower(ilUploadLimitsOverviewGUI::class):
                $this->tabs_gui->activateTab(self::TAB_UPLOAD_LIMITS);
                $limits_gui = new ilUploadLimitsOverviewGUI();
                $this->ctrl->forwardCommand($limits_gui);
                break;
            default:
                if (!$cmd || $cmd === 'view') {
                    $cmd = self::CMD_EDIT_SETTINGS;
                }
                $this->$cmd();
                break;
        }
    }

    #[\Override]
    public function getAdminTabs(): void
    {
        // General Settings for File-Services
        if ($this->rbac_system->checkAccess(
            "visible,read",
            $this->object->getRefId()
        )
        ) {
            $this->tabs_gui->addTab(
                self::TAB_SETTINGS,
                $this->lng->txt(self::TAB_SETTINGS),
                $this->ctrl->getLinkTarget($this, self::CMD_EDIT_SETTINGS)
            );
        }
        // Resource-Overview
        if ($this->rbac_system->checkAccess(
            "visible,read",
            $this->object->getRefId()
        )
        ) {
            $this->tabs_gui->addTab(
                self::TAB_OVERVIEW,
                $this->lng->txt(self::TAB_OVERVIEW),
                $this->ctrl->getLinkTargetByClass(ilResourceOverviewGUI::class),
            );
        }
        // Upload-Limit
        if ($this->rbac_system->checkAccess(
            "visible,read",
            $this->object->getRefId()
        )
        ) {
            $this->tabs_gui->addTab(
                self::TAB_UPLOAD_LIMITS,
                $this->lng->txt(self::TAB_UPLOAD_LIMITS),
                $this->ctrl->getLinkTargetByClass(ilUploadLimitsOverviewGUI::class),
            );
        }
        // Permissions-tab
        if ($this->rbac_system->checkAccess(
            'edit_permission',
            $this->object->getRefId()
        )
        ) {
            $this->tabs_gui->addTab(
                self::TAB_PERMISSIONS,
                $this->lng->txt(self::TAB_PERMISSIONS),
                $this->ctrl->getLinkTargetByClass(ilPermissionGUI::class, "perm")
            );
        }
    }

    #[\Override]
    public function setTitleAndDescription(): void
    {
        parent::setTitleAndDescription();
        $this->tpl->setDescription($this->object->getDescription());
    }

    private function initSettingsForm(): ilPropertyFormGUI
    {
        $permission_to_write = $this->hasUserPermissionTo('write');

        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt(self::TAB_SETTINGS));

        // default positive list
        $ne = new ilNonEditableValueGUI($this->lng->txt("file_suffix_default_positive"), "");
        $ne->setValue(implode(", ", $this->file_service_settings->getDefaultWhitelist()));
        $ne->setInfo($this->lng->txt("file_suffix_default_positive_info"));
        $form->addItem($ne);

        // file suffix custom negative list
        $ta = new ilTextAreaInputGUI(
            $this->lng->txt(
                "file_suffix_custom_negative"
            ),
            "suffix_repl_additional"
        );
        $ta->setInfo($this->lng->txt("file_suffix_custom_negative_info"));
        $ta->setRows(5);
        $ta->setDisabled(!$permission_to_write);
        $form->addItem($ta);

        // file suffix custom positive list
        $ta = new ilTextAreaInputGUI(
            $this->lng->txt(
                "file_suffix_custom_positive"
            ),
            "suffix_custom_white_list"
        );
        $ta->setInfo($this->lng->txt("file_suffix_custom_positive_info"));
        $ta->setRows(5);
        $ta->setDisabled(!$permission_to_write);
        $form->addItem($ta);

        // resulting overall positive list
        $ne = new ilNonEditableValueGUI($this->lng->txt("file_suffix_overall_positive"), "");
        $ne->setValue(implode(", ", $this->file_service_settings->getWhiteListedSuffixes()));
        $ne->setInfo($this->lng->txt("file_suffix_overall_positive_info"));
        $form->addItem($ne);

        // explicit negative list
        $ta = new ilTextAreaInputGUI(
            $this->lng->txt("file_suffix_custom_expl_negative"),
            "suffix_custom_expl_black"
        );
        $ta->setInfo($this->lng->txt("file_suffix_custom_expl_negative_info"));
        $ta->setRows(5);
        $ta->setDisabled(!$permission_to_write);
        $form->addItem($ta);

        // command buttons
        if ($permission_to_write) {
            $form->addCommandButton('saveSettings', $this->lng->txt('save'));
            $form->addCommandButton('view', $this->lng->txt('cancel'));
        }

        return $form;
    }

    protected function editSettings(): void
    {
        $this->tabs_gui->setTabActive(self::TAB_SETTINGS);

        $this->checkPermissionOrFail("visible,read");

        // get form
        $form = $this->initSettingsForm();

        // set current values
        $val = [];
        $val["suffix_repl_additional"] = implode(", ", $this->file_service_settings->getWhiteListNegative());
        $val["suffix_custom_white_list"] = implode(", ", $this->file_service_settings->getWhiteListPositive());
        $val["suffix_custom_expl_black"] = implode(", ", $this->file_service_settings->getProhibited());
        $form->setValuesByArray($val);

        // set content
        $this->tpl->setContent($form->getHTML());
    }

    protected function saveSettings(): void
    {
        $this->checkPermissionOrFail("write");

        // get form
        $form = $this->initSettingsForm();
        if ($form->checkInput()) {
            $trafo = (fn(string $id): ?string => $this->http->post()->has($id)
                ? $this->http->post()->retrieve($id, $this->refinery->to()->string())
                : null);


            $this->settings->set("suffix_repl_additional", $trafo("suffix_repl_additional"));
            $this->settings->set("suffix_custom_white_list", $trafo("suffix_custom_white_list"));
            $this->settings->set("suffix_custom_expl_black", $trafo("suffix_custom_expl_black"));

            $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this, self::CMD_EDIT_SETTINGS);
        } else {
            $form->setValuesByPost();
            $this->tpl->setContent($form->getHTML());
        }
    }
}