class.ilObjLinkResourceGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\HTTP\Services as HTTPService;
use ILIAS\UI\Component\Modal\RoundTrip as RoundTripModal;
use ILIAS\UI\Component\Input\Container\Form\Standard as StandardForm;

class ilObjLinkResourceGUI extends ilObject2GUI
{
    protected const int VIEW_MODE_VIEW = 1;
    protected const int VIEW_MODE_MANAGE = 2;
    protected const int VIEW_MODE_SORT = 3;

    protected const int LINK_MOD_CREATE = 1;
    protected const int LINK_MOD_EDIT = 2;
    protected const int LINK_MOD_ADD = 3;
    protected const int LINK_MOD_SET_LIST = 4;
    protected const int LINK_MOD_ASYNC = 6;

    private int $view_mode = self::VIEW_MODE_VIEW;

    private ?ilPropertyFormGUI $form = null;
    private ?ilWebLinkDraftItem $draft_item = null;
    private ?ilWebLinkDraftParameter $draft_parameter = null;
    private ?ilWebLinkDraftList $draft_list = null;

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

        parent::__construct($id, $id_type, $parent_node_id);

        $this->lng->loadLanguageModule("webr");
        $this->settings = $DIC->settings();
        $DIC->resourceStorage();
    }

    protected function getWebLinkRepo(): ilWebLinkRepository
    {
        return new ilWebLinkDatabaseRepository($this->object->getId());
    }

    public function getType(): string
    {
        return "webr";
    }

    protected function initViewMode(?int $new_view_mode = null): void
    {
        if ($new_view_mode !== null) {
            ilSession::set('webr_view_mode', $new_view_mode);
        }
        if (ilSession::has('webr_view_mode')) {
            $this->view_mode = (int) ilSession::get('webr_view_mode');
        }
    }

    public function executeCommand(): void
    {
        $this->initViewMode();

        $base_class = $this->http->wrapper()->query()->retrieve(
            'baseClass',
            $this->refinery->kindlyTo()->string()
        );
        if ($base_class === ilLinkResourceHandlerGUI::class) {
            $this->__prepareOutput();
        }
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();
        switch ($next_class) {
            case "ilinfoscreengui":
                $this->prepareOutput();
                $this->infoScreenForward();    // forwards command
                break;

            case 'ilobjectmetadatagui':
                $this->checkPermission('write'); // #18563
                $this->prepareOutput();
                $this->tabs_gui->activateTab('id_meta_data');
                $md_gui = new ilObjectMetaDataGUI($this->object);
                $this->ctrl->forwardCommand($md_gui);
                break;

            case 'ilpermissiongui':
                $this->prepareOutput();
                $this->tabs_gui->activateTab('id_permissions');
                $perm_gui = new ilPermissionGUI($this);
                $this->ctrl->forwardCommand($perm_gui);
                break;

            case 'ilobjectcopygui':
                $this->prepareOutput();
                $cp = new ilObjectCopyGUI($this);
                $cp->setType('webr');
                $this->ctrl->forwardCommand($cp);
                break;

            case 'ilexportgui':
                $this->prepareOutput();
                $this->tabs_gui->setTabActive('export');
                $exp = new ilExportGUI($this);
                $this->ctrl->forwardCommand($exp);
                break;

            case "ilcommonactiondispatchergui":
                $this->prepareOutput();
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;

            case "ilpropertyformgui":
                $mode = $this->ctrl->isAsynch() ?
                    self::LINK_MOD_ASYNC : self::LINK_MOD_EDIT;
                $this->initFormLink($mode);
                $this->ctrl->forwardCommand($this->form);
                break;

            case "ilinternallinkgui":
                $this->lng->loadLanguageModule("content");
                $link_gui = new ilInternalLinkGUI("RepositoryItem", 0);
                $link_gui->filterLinkType("PageObject");
                $link_gui->filterLinkType("GlossaryItem");
                $link_gui->filterLinkType("RepositoryItem");
                $link_gui->setFilterWhiteList(true);
                $this->ctrl->forwardCommand($link_gui);
                break;

            default:
                if ($this->getIdType() === ilObject2GUI::WORKSPACE_OBJECT_ID) {
                    parent::executeCommand();
                    break;
                }
                if (!$cmd) {
                    $cmd = 'view';
                }
                $this->prepareOutput();
                $this->$cmd();
        }

        if (!$this->getCreationMode()) {
            $this->addHeaderAction();
        }
    }

    protected function initCreateForm(string $new_type): ilPropertyFormGUI
    {
        $this->initFormLink(self::LINK_MOD_CREATE);
        return $this->form;
    }

    public function save(): void
    {
        $this->initFormLink(self::LINK_MOD_CREATE);
        $valid = $this->form->checkInput();
        if (
            $this->checkLinkInput(self::LINK_MOD_CREATE, $valid, 0) &&
            $this->form->getInput('tar_mode_type') === 'single'
        ) {
            $this->saveObject();
        } elseif ($valid && $this->form->getInput('tar_mode_type') == 'list') {
            $this->initList(self::LINK_MOD_CREATE);
            $this->saveObject();
        } else {
            // Data incomplete or invalid
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('err_check_input')
            );
            $this->form->setValuesByPost();
            $this->tpl->setContent($this->form->getHTML());
        }
    }

    public function saveObject(): void
    {
        // create permission is already checked in createObject. This check here is done to prevent hacking attempts
        if (!$this->checkPermissionBool("create", "", $this->requested_new_type)) {
            $this->error->raiseError($this->lng->txt("no_create_permission"), $this->error->MESSAGE);
        }

        $this->lng->loadLanguageModule($this->requested_new_type);
        $this->ctrl->setParameter($this, "new_type", $this->requested_new_type);

        $this->form = $this->initCreateForm($this->requested_new_type);
        if ($this->form->checkInput()) {
            $this->ctrl->setParameter($this, "new_type", "");

            $class_name = "ilObj" . $this->obj_definition->getClassName($this->requested_new_type);
            $newObj = new $class_name();
            $newObj->setType($this->requested_new_type);
            $newObj->setTitle($this->form->getInput("title"));
            $newObj->setDescription($this->form->getInput("desc"));
            $newObj->processAutoRating();
            $newObj->create();

            $this->putObjectInTree($newObj);

            if ($this->form->getInput('didactic_template')) {
                $dtpl = $this->getDidacticTemplateVar("dtpl");
                // Object calls initCreateForm again in getDidacticTemplateVar
                $this->form->checkInput();
                $newObj->applyDidacticTemplate($dtpl);
            }

            $this->afterSave($newObj);
        }

        $this->form->setValuesByPost();
        $this->tpl->setContent($this->form->getHTML());
    }

    protected function afterSave(ilObject $new_object): void
    {
        $new_web_link_repo = new ilWebLinkDatabaseRepository($new_object->getId());

        if ($this->form->getInput('tar_mode_type') === 'single') {
            // Save link
            $new_web_link_repo->createItem($this->draft_item);
            $this->tpl->setOnScreenMessage(
                'success',
                $this->lng->txt('webr_link_added')
            );
        }

        if ($this->form->getInput('tar_mode_type') === 'list') {
            // Save list
            $new_web_link_repo->createList($this->draft_list);
            $this->tpl->setOnScreenMessage(
                'success',
                $this->lng->txt('webr_list_added')
            );
        }

        // personal workspace
        if ($this->id_type == self::WORKSPACE_NODE_ID) {
            $this->ctrl->redirect($this, "editLinks");
        } // repository
        else {
            ilUtil::redirect(
                "ilias.php?baseClass=ilLinkResourceHandlerGUI&ref_id=" .
                $new_object->getRefId() . "&cmd=switchViewMode&switch_mode=2"
            );
        }
    }

    protected function settings(): void
    {
        $this->checkPermission('write');
        $this->tabs_gui->activateTab('id_settings');

        $form = $this->initFormSettings();
        $this->tpl->setContent($this->ui_renderer->render($form));
    }

    protected function saveSettings(): void
    {
        $this->checkPermission('write');
        $this->tabs_gui->activateTab('id_settings');

        $form = $this->initFormSettings()->withRequest($this->http->request());
        if (!($data = $form->getData())) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('err_check_input')
            );
            $this->tpl->setContent($this->ui_renderer->render($form));
        }

        $obj_props = $this->object->getObjectProperties();

        $title_and_description = $data['general']['title_and_description'] ?? null;
        if ($title_and_description !== null && $this->getWebLinkRepo()->doesListExist()) {
            $obj_props->storePropertyTitleAndDescription($title_and_description);

            // update list
            $draft_list = new ilWebLinkDraftList(
                $title_and_description->getTitle(),
                $title_and_description->getLongDescription()
            );
            $this->getWebLinkRepo()->updateList(
                $this->getWebLinkRepo()->getList(),
                $draft_list
            );
        }
        $obj_props->storePropertyIsOnline($data['activation']['is_online']);
        $obj_props->storePropertyTileImage($data['presentation']['tile_image']);
        $ordering = $data['presentation']['sor'] ?? null;
        if ($ordering !== null && $this->getWebLinkRepo()->doesListExist()) {
            $sort = new ilContainerSortingSettings($this->object->getId());
            $sort->setSortMode((int) $ordering);
            $sort->update();
        }

        $this->ctrl->redirect($this, 'settings');
    }

    protected function initFormSettings(): StandardForm
    {
        $inputs = [];
        $obj_props = $this->object->getObjectProperties();
        $field_factory = $this->ui_factory->input()->field();

        if ($this->getWebLinkRepo()->doesListExist()) {
            $title_and_description = $obj_props->getPropertyTitleAndDescription()->toForm(
                $this->lng,
                $field_factory,
                $this->refinery
            );
            $inputs['general'] = $field_factory->section(
                ['title_and_description' => $title_and_description],
                $this->lng->txt('webr_edit_settings')
            );
        }

        // activation
        $this->lng->loadLanguageModule('rep');
        $is_online = $obj_props->getPropertyIsOnline()->toForm(
            $this->lng,
            $field_factory,
            $this->refinery
        );
        $inputs['activation'] = $field_factory->section(
            ['is_online' => $is_online],
            $this->lng->txt('rep_activation_availability')
        );

        $presentation_inputs = [];

        // tile image
        $tile_input = $obj_props->getPropertyTileImage()->toForm(
            $this->lng,
            $field_factory,
            $this->refinery
        );
        $presentation_inputs['tile_image'] = $tile_input;

        // Sorting
        if ($this->getWebLinkRepo()->doesListExist()) {
            $current_mode = (string) ilContainerSortingSettings::_lookupSortMode($this->object->getId());
            $order_input = $field_factory->radio($this->lng->txt('webr_sorting'))
                                         ->withOption(
                                             (string) ilContainer::SORT_TITLE,
                                             $this->lng->txt('webr_sorting')
                                         )
                                         ->withOption(
                                             (string) ilContainer::SORT_MANUAL,
                                             $this->lng->txt('webr_sort_manual')
                                         )
                                         ->withValue($current_mode)
                                         ->withRequired(true);
            $presentation_inputs['sor'] = $order_input;
        }

        $inputs['presentation'] = $field_factory->section(
            $presentation_inputs,
            $this->lng->txt('obj_presentation')
        );

        $form = $this->ui_factory->input()->container()->form()->standard(
            $this->ctrl->getFormAction($this, 'saveSettings'),
            $inputs
        );
        return $form;
    }

    public function editLink(): void
    {
        $this->checkPermission('write');
        $this->activateTabs('content', 'id_content_view');

        $link_id = 0;
        if ($this->http->wrapper()->query()->has('link_id')) {
            $link_id = $this->http->wrapper()->query()->retrieve(
                'link_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        if (!$link_id) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('select_one'),
                true
            );
            $this->ctrl->redirect($this, 'view');
        }
        $form = $this->initFormLink(self::LINK_MOD_EDIT);
        $this->setValuesFromLink($link_id);
        $this->tpl->setContent($form->getHTML());
    }

    public function updateLink(): void
    {
        $form = $this->initFormLink(self::LINK_MOD_EDIT);
        $valid = $form->checkInput();
        $link_id = 0;
        if ($this->http->wrapper()->query()->has('link_id')) {
            $link_id = $this->http->wrapper()->query()->retrieve(
                'link_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        if ($this->checkLinkInput(
            self::LINK_MOD_EDIT,
            $valid,
            $link_id
        )) {
            $item = $this->getWebLinkRepo()->getItemByLinkId($link_id);
            foreach ($item->getParameters() as $parameter) {
                $this->draft_item->addParameter($parameter);
            }

            if (
                $this->settings->get('links_dynamic') &&
                $this->draft_parameter !== null
            ) {
                $this->draft_item->addParameter($this->draft_parameter);
            }
            $this->getWebLinkRepo()->updateItem($item, $this->draft_item);

            if (!$this->getWebLinkRepo()->doesListExist()) {
                $this->object->setTitle($form->getInput('title'));
                $this->object->setDescription($form->getInput('desc'));
                $this->object->update();
            }
            $this->tpl->setOnScreenMessage(
                'success',
                $this->lng->txt('settings_saved'),
                true
            );
            $this->ctrl->redirect($this, 'view');
        }
        $this->tpl->setOnScreenMessage(
            'failure',
            $this->lng->txt('err_check_input')
        );
        $form->setValuesByPost();
        $this->tpl->setContent($form->getHTML());
    }

    public function getLinkToListModal(): RoundTripModal
    {
        global $DIC;

        $f = $DIC->ui()->factory();
        $r = $DIC->ui()->renderer();

        // check if form was already set
        if ($this->form == null) {
            $this->initFormLink(self::LINK_MOD_SET_LIST);
        }

        $form_id = 'form_' . $this->form->getId();

        $submit = $f->button()->primary($this->lng->txt('save'), '#')
                    ->withOnLoadCode(
                        function ($id) use ($form_id) {
                            return "$('#{$id}').click(function() { $('#{$form_id}').submit(); return false; });";
                        }
                    );
        $info = $f->messageBox()->info($this->lng->txt('webr_new_list_info'));

        $modal = $f->modal()->roundtrip(
            $this->lng->txt('webr_new_list'),
            $f->legacy()->content($r->render($info) . $this->form->getHTML())
        )
                   ->withActionButtons([$submit]);

        $submit = '';
        if ($this->http->wrapper()->post()->has('sbmt')) {
            $submit = $this->http->wrapper()->post()->retrieve(
                'sbmt',
                $this->refinery->kindlyTo()->string()
            );
        }
        // modal triggers its show signal on load if form validation failed
        if ($submit === 'submit') {
            $modal = $modal->withOnLoad($modal->getShowSignal());
        }
        return $modal;
    }

    public function saveLinkList(): void
    {
        $this->checkPermission('write');
        $form = $this->initFormLink(self::LINK_MOD_SET_LIST);
        $valid = $form->checkInput();
        if ($valid) {
            $this->object->setTitle($form->getInput('lti'));
            $this->object->setDescription($form->getInput('tde'));
            $this->object->update();

            $this->initList(self::LINK_MOD_SET_LIST);
            $this->getWebLinkRepo()->createList($this->draft_list);
            $this->tpl->setOnScreenMessage(
                'success',
                $this->lng->txt('webr_list_set'),
                true
            );
            $this->ctrl->redirect($this, 'view');
        }
        $this->tpl->setOnScreenMessage(
            'failure',
            $this->lng->txt('err_check_input'),
            true
        );
        $form->setValuesByPost();
        $this->view();
    }

    public function addLink(): void
    {
        $this->checkPermission('write');
        $this->activateTabs('content', 'id_content_view');

        $form = $this->initFormLink(self::LINK_MOD_ADD);
        $this->tpl->setContent($form->getHTML());
    }

    public function saveAddLink(): void
    {
        $this->checkPermission('write');

        $form = $this->initFormLink(self::LINK_MOD_ADD);
        $valid = $form->checkInput();
        if ($this->checkLinkInput(
            self::LINK_MOD_ADD,
            $valid,
            0
        )
        ) {
            if (
                $this->settings->get('links_dynamic') &&
                $this->draft_parameter !== null
            ) {
                $this->draft_item->addParameter($this->draft_parameter);
            }
            $this->getWebLinkRepo()->createItem($this->draft_item);

            $this->tpl->setOnScreenMessage(
                'success',
                $this->lng->txt('webr_link_added'),
                true
            );
            $this->ctrl->redirect($this, 'view');
        }
        $this->tpl->setOnScreenMessage(
            'failure',
            $this->lng->txt('err_check_input')
        );
        $this->form->setValuesByPost();
        $this->activateTabs('content', 'id_content_view');
        $this->tpl->setContent($form->getHTML());
    }

    protected function deleteParameter(): void
    {
        $this->checkPermission('write');

        $link_id = $this->http->wrapper()->query()->retrieve(
            'link_id',
            $this->refinery->kindlyTo()->int()
        );
        $this->ctrl->setParameter($this, 'link_id', $link_id);

        $param_id = $this->http->wrapper()->query()->retrieve(
            'param_id',
            $this->refinery->kindlyTo()->int()
        );

        if (!$param_id) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('select_one'),
                true
            );
            $this->ctrl->redirect($this, 'view');
        }

        $this->getWebLinkRepo()->deleteParameterByLinkIdAndParamId($link_id, $param_id);

        $this->tpl->setOnScreenMessage(
            'success',
            $this->lng->txt(
                'links_parameter_deleted'
            ),
            true
        );
        $this->ctrl->redirect($this, 'editLinks');
    }

    protected function deleteParameterForm(): void
    {
        $this->checkPermission('write');

        $link_id = $this->http->wrapper()->query()->retrieve(
            'link_id',
            $this->refinery->kindlyTo()->int()
        );

        $param_id = $this->http->wrapper()->query()->retrieve(
            'param_id',
            $this->refinery->kindlyTo()->int()
        );
        if (!$param_id) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('select_one'),
                true
            );
            $this->ctrl->redirect($this, 'view');
        }

        $this->getWebLinkRepo()->deleteParameterByLinkIdAndParamId($link_id, $param_id);

        $this->tpl->setOnScreenMessage(
            'success',
            $this->lng->txt(
                'links_parameter_deleted'
            ),
            true
        );
        $this->ctrl->redirect($this, 'view');
    }

    protected function updateLinks(): void
    {
        $this->checkPermission('write');
        $this->activateTabs('content', '');

        $ids = [];
        if ($this->http->wrapper()->post()->has('ids')) {
            $ids = $this->http->wrapper()->post()->retrieve(
                'ids',
                $this->refinery->kindlyTo()->dictOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }

        if ($ids === []) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('select_one'),
                true
            );
            $this->ctrl->redirect($this, 'view');
        }

        $link_post = (array) ($this->http->request()->getParsedBody(
        )['links'] ?? []);

        // Validate
        $invalid = [];
        foreach ($ids as $link_id) {
            $data = $link_post[$link_id];

            if (
                $this->http->wrapper()->post()->has(
                    'tar_' . $link_id . '_ajax_type'
                ) &&
                $this->http->wrapper()->post()->has(
                    'tar_' . $link_id . '_ajax_id'
                )
            ) {
                $data['tar'] =
                    $this->http->wrapper()->post()->retrieve(
                        'tar_' . $link_id . '_ajax_type',
                        $this->refinery->kindlyTo()->string()
                    ) . '|' .
                    $this->http->wrapper()->post()->retrieve(
                        'tar_' . $link_id . '_ajax_id',
                        $this->refinery->kindlyTo()->string()
                    );
            }
            if (!strlen($data['title'] ?? '')) {
                $invalid[] = $link_id;
                continue;
            }
            if (!strlen($data['tar'] ?? '')) {
                $invalid[] = $link_id;
                continue;
            }
            if (($data['nam'] ?? false) && !($data['val'] ?? false)) {
                $invalid[] = $link_id;
                continue;
            }
            if (!($data['nam'] ?? false) && ($data['val'] ?? false)) {
                $invalid[] = $link_id;
            }
        }

        if ($invalid !== []) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('err_check_input')
            );
            $this->tpl->addBlockFile(
                'ADM_CONTENT',
                'adm_content',
                'tpl.webr_manage.html',
                'components/ILIAS/WebResource'
            );
            $table = new ilWebResourceEditableLinkTableGUI($this, 'view');
            $table->setInvalidLinks($invalid);
            $table->parseSelectedLinks($ids);
            $table->updateFromPost();
            $this->tpl->setVariable('TABLE_LINKS', $table->getHTML());
            return;
        }

        // Save Settings
        foreach ($ids as $link_id) {
            $data = $link_post[$link_id];

            if (
                $this->http->wrapper()->post()->has(
                    'tar_' . $link_id . '_ajax_type'
                ) &&
                $this->http->wrapper()->post()->has(
                    'tar_' . $link_id . '_ajax_id'
                )
            ) {
                $data['tar'] =
                    $this->http->wrapper()->post()->retrieve(
                        'tar_' . $link_id . '_ajax_type',
                        $this->refinery->kindlyTo()->string()
                    ) . '|' .
                    $this->http->wrapper()->post()->retrieve(
                        'tar_' . $link_id . '_ajax_id',
                        $this->refinery->kindlyTo()->string()
                    );
            }

            $item = $this->getWebLinkRepo()->getItemByLinkId($link_id);
            $draft = new ilWebLinkDraftItem(
                ilLinkInputGUI::isInternalLink($data['tar'] ?? ''),
                ilUtil::stripSlashes($data['title'] ?? ''),
                ilUtil::stripSlashes($data['desc'] ?? ''),
                str_replace('"', '', ilUtil::stripSlashes($data['tar'] ?? '')),
                (bool) ($data['act'] ?? false),
                $item->getParameters()
            );

            if (strlen($data['nam'] ?? '') && $data['val'] ?? '') {
                $param = new ilWebLinkDraftParameter(
                    (int) ($data['val'] ?? 0),
                    ilUtil::stripSlashes($data['nam'] ?? '')
                );
                $draft->addParameter($param);
            }

            $this->getWebLinkRepo()->updateItem($item, $draft);

            if (!$this->getWebLinkRepo()->doesListExist()) {
                $this->object->setTitle(ilUtil::stripSlashes($data['title'] ?? ''));
                $this->object->setDescription(
                    ilUtil::stripSlashes($data['desc'] ?? '')
                );
                $this->object->update();
            }
        }
        $this->tpl->setOnScreenMessage(
            'success',
            $this->lng->txt('settings_saved'),
            true
        );
        $this->ctrl->redirect($this, 'view');
    }

    protected function setValuesFromLink(int $a_link_id): void
    {
        $item = $this->getWebLinkRepo()->getItemByLinkId($a_link_id);
        $this->form->setValuesByArray(
            array(
                'title' => $item->getTitle(),
                'tar' => $item->getTarget(),
                'desc' => $item->getDescription(),
                'act' => (int) $item->isActive()
            )
        );
    }

    protected function initList(int $a_mode): void
    {
        if ($a_mode == self::LINK_MOD_CREATE) {
            $this->draft_list = new ilWebLinkDraftList(
                $this->form->getInput('title'),
                $this->form->getInput('desc')
            );
        }

        if ($a_mode == self::LINK_MOD_SET_LIST) {
            $this->draft_list = new ilWebLinkDraftList(
                $this->form->getInput('lti'),
                $this->form->getInput('tde')
            );
        }
    }

    protected function checkLinkInput(
        int $a_mode,
        bool $a_valid,
        ?int $a_link_id = null
    ): bool {
        $valid = $a_valid;

        $link_input = $this->form->getInput('tar');
        $active = false;

        if ($a_mode == self::LINK_MOD_CREATE) {
            $active = true;
        } else {
            $active = (bool) $this->form->getInput('act');
        }

        $this->draft_item = new ilWebLinkDraftItem(
            ilLinkInputGUI::isInternalLink($link_input),
            $this->form->getInput('title'),
            $this->form->getInput('desc'),
            str_replace('"', '', $link_input),
            $active,
            []
        );

        if (!$this->settings->get('links_dynamic')) {
            return $valid;
        }

        $this->draft_parameter = new ilWebLinkDraftParameter(
            (int) $this->form->getInput('val'),
            $this->form->getInput('nam')
        );

        $error = $this->draft_parameter->validate();
        if (!$error) {
            return $valid;
        }

        $this->draft_parameter = null;

        switch ($error) {
            case ilWebLinkDraftParameter::LINKS_ERR_NO_NAME:
                $this->form->getItemByPostVar('nam')->setAlert(
                    $this->lng->txt('links_no_name_given')
                );
                return false;

            case ilWebLinkDraftParameter::LINKS_ERR_NO_VALUE:
                $this->form->getItemByPostVar('val')->setAlert(
                    $this->lng->txt('links_no_value_given')
                );
                return false;

            default:
                // Nothing entered => no error
                return $valid;
        }
    }

    protected function initFormLink(int $a_mode): ilPropertyFormGUI
    {
        $this->tabs_gui->activateTab("id_content");

        $this->form = new ilPropertyFormGUI();
        switch ($a_mode) {
            case self::LINK_MOD_CREATE:
                // Header
                $this->ctrl->setParameter($this, 'new_type', 'webr');
                $this->form->setTitle($this->lng->txt('webr_new_link'));
                $this->form->setTableWidth('600px');

                // Buttons
                $this->form->addCommandButton(
                    'save',
                    $this->lng->txt('webr_add')
                );
                $this->form->addCommandButton(
                    'cancel',
                    $this->lng->txt('cancel')
                );
                break;

            case self::LINK_MOD_ADD:
                // Header
                $this->form->setTitle($this->lng->txt('webr_new_link'));

                // Buttons
                $this->form->addCommandButton(
                    'saveAddLink',
                    $this->lng->txt('webr_add')
                );
                $this->form->addCommandButton(
                    'view',
                    $this->lng->txt('cancel')
                );
                break;

            case self::LINK_MOD_EDIT:
                // Header
                $this->ctrl->setParameter(
                    $this,
                    'link_id',
                    // TODO PHP8 Review: Remove/Replace SuperGlobals
                    (int) $_REQUEST['link_id']
                );
                $this->form->setTitle($this->lng->txt('webr_edit'));

                // Buttons
                $this->form->addCommandButton(
                    'updateLink',
                    $this->lng->txt('save')
                );
                $this->form->addCommandButton(
                    'view',
                    $this->lng->txt('cancel')
                );
                break;

                /*
                 * The async call for displaying the object explorer for
                 * internal links goes through ilPropertyFormGUI to get
                 * to the right ilLinkInputGUI, so we only add that field
                 * to the form here.
                 */
            case self::LINK_MOD_ASYNC:
                $this->addLinkInputToForm($a_mode);
                return $this->form;
        }

        if ($a_mode == self::LINK_MOD_SET_LIST) {
            $this->form->setValuesByPost();
            $this->form->setFormAction(
                $this->ctrl->getFormAction($this, 'saveLinkList')
            );
            $this->form->setId(uniqid('form'));

            // List Title
            $title = new ilTextInputGUI(
                $this->lng->txt('webr_list_title'),
                'lti'
            );
            $title->setRequired(true);
            $title->setSize(40);
            $title->setMaxLength(127);
            $this->form->addItem($title);

            // List Description
            $desc = new ilTextAreaInputGUI(
                $this->lng->txt('webr_list_desc'),
                'tde'
            );
            $desc->setRows(3);
            $desc->setCols(40);
            $this->form->addItem($desc);

            $item = new ilHiddenInputGUI('sbmt');
            $item->setValue('submit');
            $this->form->addItem($item);
        } else {
            $this->form->setFormAction($this->ctrl->getFormAction($this));

            $this->addLinkInputToForm($a_mode);

            // Title
            $tit = new ilTextInputGUI(
                $this->lng->txt('webr_link_title'),
                'title'
            );
            $tit->setRequired(true);
            $tit->setSize(40);
            $tit->setMaxLength(127);
            $this->form->addItem($tit);

            // Description
            $des = new ilTextAreaInputGUI(
                $this->lng->txt('description'),
                'desc'
            );
            $des->setRows(3);
            $des->setCols(40);
            $this->form->addItem($des);

            if ($a_mode != self::LINK_MOD_CREATE) {
                // Active
                $act = new ilCheckboxInputGUI($this->lng->txt('active'), 'act');
                $act->setChecked(true);
                $act->setValue('1');
                $this->form->addItem($act);
            }

            if ($this->settings->get('links_dynamic') &&
                $a_mode != self::LINK_MOD_CREATE
            ) {
                $dyn = new ilNonEditableValueGUI(
                    $this->lng->txt('links_dyn_parameter')
                );
                $dyn->setInfo($this->lng->txt('links_dynamic_info'));

                if ($this->http->wrapper()->query()->has('link_id')) {
                    $link_id = $this->http->wrapper()->query()->retrieve(
                        'link_id',
                        $this->refinery->kindlyTo()->int()
                    );
                }
                if (
                    isset($link_id) &&
                    $link_id > 0 &&
                    ($params = $this->getWebLinkRepo()->getItemByLinkId($link_id)->getParameters()) !== []
                ) {
                    $ex = new ilCustomInputGUI(
                        $this->lng->txt('links_existing_params'),
                        'ex'
                    );
                    $dyn->addSubItem($ex);

                    foreach ($params as $param) {
                        $p = new ilCustomInputGUI();

                        $ptpl = new ilTemplate(
                            'tpl.link_dyn_param_edit.html',
                            true,
                            true,
                            'components/ILIAS/WebResource'
                        );
                        $ptpl->setVariable(
                            'INFO_TXT',
                            $param->getInfo()
                        );
                        $this->ctrl->setParameter($this, 'param_id', $param->getParamId());
                        $this->ctrl->setParameter($this, 'link_id', $link_id);
                        $ptpl->setVariable(
                            'LINK_DEL',
                            $this->ctrl->getLinkTarget(
                                $this,
                                'deleteParameterForm'
                            )
                        );
                        $ptpl->setVariable(
                            'LINK_TXT',
                            $this->lng->txt('delete')
                        );
                        $p->setHtml($ptpl->get());
                        $dyn->addSubItem($p);
                    }
                }

                // Dynyamic name
                $nam = new ilTextInputGUI($this->lng->txt('links_name'), 'nam');
                $nam->setSize(12);
                $nam->setMaxLength(128);
                $dyn->addSubItem($nam);

                // Dynamic value
                $val = new ilSelectInputGUI(
                    $this->lng->txt('links_value'),
                    'val'
                );
                $options = [];
                foreach (ilWebLinkBaseParameter::VALUES as $name => $identifier) {
                    $options[$identifier] = $this->lng->txt(ilWebLinkBaseParameter::VALUES_TEXT[$identifier]);
                }
                $val->setOptions($options);
                $val->setValue(0);
                $dyn->addSubItem($val);

                $this->form->addItem($dyn);
            }
        }
        return $this->form;
    }

    protected function addLinkInputToForm(int $mode): void
    {
        $tar = new ilLinkInputGUI(
            $this->lng->txt('type'),
            'tar'
        ); // lng var
        if ($mode == self::LINK_MOD_CREATE) {
            $tar->setAllowedLinkTypes(ilLinkInputGUI::LIST);
        }
        $tar->setInternalLinkFilterTypes(
            [
                "PageObject",
                "GlossaryItem",
                "RepositoryItem",
                'WikiPage'
            ]
        );
        $tar->setExternalLinkMaxLength(1000);
        $tar->setInternalLinkFilterTypes(
            ["PageObject", "GlossaryItem", "RepositoryItem"]
        );
        $tar->setRequired(true);
        $this->form->addItem($tar);
    }

    protected function switchViewMode(?int $force_view_mode = null): void
    {
        $new_view_mode = $this->view_mode;
        if ($force_view_mode !== null) {
            $new_view_mode = $force_view_mode;
        } elseif ($this->http->wrapper()->query()->has('switch_mode')) {
            $new_view_mode = $this->http->wrapper()->query()->retrieve(
                'switch_mode',
                $this->refinery->kindlyTo()->int()
            );
        }
        $this->initViewMode($new_view_mode);
        $this->view();
    }

    protected function editLinks(): void
    {
        $this->switchViewMode(self::VIEW_MODE_MANAGE);
    }

    public function view(): void
    {
        $this->tabs_gui->activateTab("id_content");
        $this->checkPermission('read');

        $base_class = $this->http->wrapper()->query()->retrieve(
            'baseClass',
            $this->refinery->kindlyTo()->string()
        );
        if (strcasecmp($base_class, ilAdministrationGUI::class) === 0) {
            parent::view();
            return;
        } else {
            switch ($this->view_mode) {
                case self::VIEW_MODE_MANAGE:
                    $this->manage();
                    break;

                case self::VIEW_MODE_SORT:
                    // #14638
                    if (ilContainerSortingSettings::_lookupSortMode(
                        $this->object->getId()
                    ) == ilContainer::SORT_MANUAL) {
                        $this->sort();
                        break;
                    }
                    $this->showLinks();
                    break;

                default:
                    $this->showLinks();
                    break;
            }
        }
        $this->tpl->setPermanentLink(
            $this->object->getType(),
            $this->object->getRefId()
        );
    }

    protected function manage(): void
    {
        $this->checkPermission('write');
        $this->activateTabs('content', 'id_content_manage');

        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.webr_manage.html',
            'components/ILIAS/WebResource'
        );
        $this->showToolbar('ACTION_BUTTONS');

        $table = new ilWebResourceEditableLinkTableGUI($this, 'view');
        $table->parse();

        $js = ilInternalLinkGUI::getInitHTML("");

        $this->tpl->addJavaScript("assets/js/intLink.js");
        $this->tpl->addJavascript("assets/js/Form.js");

        $this->tpl->setVariable('TABLE_LINKS', $table->getHTML() . $js);
    }

    protected function showLinks(): void
    {
        $this->checkPermission('read');
        $this->activateTabs('content', 'id_content_view');

        $table = new ilWebResourceLinkTableGUI($this, 'showLinks');
        $table->parse();

        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.webr_view.html',
            'components/ILIAS/WebResource'
        );
        $this->showToolbar('ACTION_BUTTONS');
        $this->tpl->setVariable('LINK_TABLE', $table->getHTML());
    }

    protected function sort(): void
    {
        $this->checkPermission('write');
        $this->activateTabs('content', 'id_content_ordering');

        $table = new ilWebResourceLinkTableGUI($this, 'sort', true);
        $table->parse();

        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.webr_view.html',
            'components/ILIAS/WebResource'
        );
        $this->showToolbar('ACTION_BUTTONS');
        $this->tpl->setVariable('LINK_TABLE', $table->getHTML());
    }

    protected function saveSorting(): void
    {
        $this->checkPermission('write');
        $sort = ilContainerSorting::_getInstance($this->object->getId());

        $position = [];
        if ($this->http->wrapper()->post()->has('position')) {
            $position = $this->http->wrapper()->post()->retrieve(
                'position',
                $this->refinery->kindlyTo()->dictOf(
                    $this->refinery->kindlyTo()->string()
                )
            );
        }
        $sort->savePost($position);
        $this->tpl->setOnScreenMessage(
            'success',
            $this->lng->txt('settings_saved'),
            true
        );
        $this->view();
    }

    protected function showToolbar(string $a_tpl_var): void
    {
        global $DIC;

        $tool = new ilToolbarGUI();
        $tool->setFormAction($this->ctrl->getFormAction($this));

        $f = $DIC->ui()->factory();
        $r = $DIC->ui()->renderer();

        if (
            $this->getWebLinkRepo()->doesListExist() &&
            $this->checkPermissionBool('write')
        ) {
            $tool->addButton(
                $this->lng->txt('webr_add'),
                $this->ctrl->getLinkTarget($this, 'addLink')
            );
        } elseif ($this->checkPermissionBool('write')) {
            $modal = $this->getLinkToListModal();
            $button = $f->button()->standard(
                $this->lng->txt('webr_set_to_list'),
                '#'
            )
                        ->withOnClick($modal->getShowSignal());

            $this->tpl->setVariable("MODAL", $r->render([$modal]));

            $tool->addComponent($button);
        }

        $download_button = $f->button()->standard(
            $this->lng->txt('export_html'),
            $this->ctrl->getLinkTarget($this, 'exportHTML')
        );
        $tool->addComponent($download_button);
        $this->tpl->setVariable($a_tpl_var, $tool->getHTML());
    }

    protected function confirmDeleteLink(): void
    {
        $this->checkPermission('write');
        $this->activateTabs('content', 'id_content_view');

        $link_ids = [];
        if ($this->http->wrapper()->query()->has('link_id')) {
            $link_ids = (array) $this->http->wrapper()->query()->retrieve(
                'link_id',
                $this->refinery->kindlyTo()->int()
            );
        } elseif ($this->http->wrapper()->post()->has('link_ids')) {
            $link_ids = $this->http->wrapper()->post()->retrieve(
                'link_ids',
                $this->refinery->kindlyTo()->dictOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }
        if ($link_ids === []) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('select_one')
            );
            $this->view();
            return;
        }

        $confirm = new ilConfirmationGUI();
        $confirm->setFormAction($this->ctrl->getFormAction($this, 'view'));
        $confirm->setHeaderText($this->lng->txt('webr_sure_delete_items'));
        $confirm->setConfirm($this->lng->txt('delete'), 'deleteLinks');
        $confirm->setCancel($this->lng->txt('cancel'), 'view');

        $items = $this->getWebLinkRepo()->getAllItemsAsContainer()->getItems();

        foreach ($items as $item) {
            if (!in_array($item->getLinkId(), $link_ids)) {
                continue;
            }
            $confirm->addItem(
                'link_ids[]',
                (string) $item->getLinkId(),
                $item->getTitle()
            );
        }
        $this->tpl->setContent($confirm->getHTML());
    }

    protected function deleteLinks(): void
    {
        $this->checkPermission('write');

        $link_ids = [];
        if ($this->http->wrapper()->post()->has('link_ids')) {
            $link_ids = $this->http->wrapper()->post()->retrieve(
                'link_ids',
                $this->refinery->kindlyTo()->dictOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }

        foreach ($link_ids as $link_id) {
            $this->getWebLinkRepo()->deleteItemByLinkID($link_id);
        }

        $this->tpl->setOnScreenMessage(
            'success',
            $this->lng->txt('webr_deleted_items'),
            true
        );
        $this->ctrl->redirect($this, 'view');
    }

    protected function deactivateLink(): void
    {
        $this->checkPermission('write');

        $link_id = 0;
        if ($this->http->wrapper()->query()->has('link_id')) {
            $link_id = $this->http->wrapper()->query()->retrieve(
                'link_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        if (!$link_id) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('select_one'),
                true
            );
            $this->ctrl->redirect($this, 'view');
        }

        $item = $this->getWebLinkRepo()->getItemByLinkId($link_id);
        $draft = new ilWebLinkDraftItem(
            $item->isInternal(),
            $item->getTitle(),
            $item->getDescription(),
            $item->getTarget(),
            false,
            $item->getParameters()
        );

        $this->tpl->setOnScreenMessage(
            'success',
            $this->lng->txt('webr_inactive_success'),
            true
        );
        $this->ctrl->redirect($this, 'view');
    }

    public function infoScreen(): void
    {
        $this->ctrl->redirectByClass(
            [self::class, ilInfoScreenGUI::class],
            'showSummary'
        );
    }

    public function infoScreenForward(): void
    {
        if (!$this->checkPermissionBool('visible')) {
            $this->checkPermission('read');
        }
        $this->tabs_gui->activateTab('id_info');

        $info = new ilInfoScreenGUI($this);

        $info->enablePrivateNotes();

        // standard meta data
        $info->addMetaDataSections(
            $this->object->getId(),
            0,
            $this->object->getType()
        );

        // forward the command
        $this->ctrl->forwardCommand($info);
    }

    protected function activateTabs(
        string $a_active_tab,
        string $a_active_subtab = ''
    ): void {
        switch ($a_active_tab) {
            case 'content':
                if ($this->checkPermissionBool('write')) {
                    $this->lng->loadLanguageModule('cntr');

                    $this->ctrl->setParameter(
                        $this,
                        'switch_mode',
                        self::VIEW_MODE_VIEW
                    );
                    $this->tabs_gui->addSubTab(
                        'id_content_view',
                        $this->lng->txt('view'),
                        $this->ctrl->getLinkTarget($this, 'switchViewMode')
                    );
                    $this->ctrl->setParameter(
                        $this,
                        'switch_mode',
                        self::VIEW_MODE_MANAGE
                    );
                    $this->tabs_gui->addSubTab(
                        'id_content_manage',
                        $this->lng->txt('cntr_manage'),
                        $this->ctrl->getLinkTarget($this, 'switchViewMode')
                    );
                    if (!$this->getWebLinkRepo()->doesOnlyOneItemExist() and
                        ilContainerSortingSettings::_lookupSortMode(
                            $this->object->getId()
                        ) == ilContainer::SORT_MANUAL) {
                        $this->ctrl->setParameter(
                            $this,
                            'switch_mode',
                            self::VIEW_MODE_SORT
                        );
                        $this->tabs_gui->addSubTab(
                            'id_content_ordering',
                            $this->lng->txt('cntr_ordering'),
                            $this->ctrl->getLinkTarget($this, 'switchViewMode')
                        );
                    }

                    $this->ctrl->clearParameters($this);
                    $this->tabs_gui->activateSubTab($a_active_subtab);
                }
        }

        $this->tabs_gui->activateTab('id_content');
    }

    protected function setTabs(): void
    {
        global $DIC;

        $ilHelp = $DIC['ilHelp'];
        $ilHelp->setScreenIdComponent("webr");

        if ($this->checkPermissionBool('read')) {
            $this->tabs_gui->addTab(
                "id_content",
                $this->lng->txt("content"),
                $this->ctrl->getLinkTarget($this, "view")
            );
        }

        if (
            $this->checkPermissionBool('visible') ||
            $this->checkPermissionBool('read')
        ) {
            $this->tabs_gui->addTab(
                "id_info",
                $this->lng->txt("info_short"),
                $this->ctrl->getLinkTarget($this, "infoScreen")
            );
        }

        if ($this->checkPermissionBool('write') and !$this->getCreationMode()) {
            $this->tabs_gui->addTab(
                "id_settings",
                $this->lng->txt("settings"),
                $this->ctrl->getLinkTarget($this, "settings")
            );
        }

        if ($this->checkPermissionBool('write')) {
            $mdgui = new ilObjectMetaDataGUI($this->object);
            $mdtab = $mdgui->getTab();
            if ($mdtab) {
                $this->tabs_gui->addTab(
                    "id_meta_data",
                    $this->lng->txt("meta_data"),
                    $mdtab
                );
            }
        }

        if ($this->checkPermissionBool('write')) {
            $this->tabs_gui->addTab(
                'export',
                $this->lng->txt('export'),
                $this->ctrl->getLinkTargetByClass('ilexportgui', '')
            );
        }

        // will add permission tab if needed
        parent::setTabs();
    }

    private function __prepareOutput(): void
    {
        $this->tpl->setLocator();
    }

    protected function addLocatorItems(): void
    {
        global $DIC;

        $ilLocator = $DIC['ilLocator'];
        if (is_object($this->object)) {
            $ilLocator->addItem(
                $this->object->getTitle(),
                $this->ctrl->getLinkTarget($this),
                "",
                $this->object->getRefId(),
                "webr"
            );
        }
    }

    public function callDirectLink(): void
    {
        $obj_id = $this->object->getId();

        if ($this->getWebLinkRepo()->doesOnlyOneItemExist(true)) {
            $item = ilObjLinkResourceAccess::_getFirstLink($obj_id);

            $this->redirectToLink(
                $this->ref_id,
                $obj_id,
                $item->getResolvedLink((bool) $this->settings->get('links_dynamic'))
            );
        }
    }

    public function callLink(): void
    {
        if ($this->http->wrapper()->query()->has('link_id')) {
            $link_id = $this->http->wrapper()->query()->retrieve(
                'link_id',
                $this->refinery->kindlyTo()->int()
            );

            $item = $this->getWebLinkRepo()->getItemByLinkId($link_id);

            $this->redirectToLink(
                $this->ref_id,
                $this->object->getId(),
                $item->getResolvedLink((bool) $this->settings->get('links_dynamic'))
            );
        }
    }

    protected function redirectToLink(
        int $a_ref_id,
        int $a_obj_id,
        string $a_url
    ): void {
        if ($a_url) {
            ilChangeEvent::_recordReadEvent(
                "webr",
                $a_ref_id,
                $a_obj_id,
                $this->user->getId()
            );
            ilUtil::redirect($a_url);
        }
    }

    public function exportHTML(): void
    {
        $tpl = new ilTemplate(
            "tpl.export_html.html",
            true,
            true,
            "components/ILIAS/WebResource"
        );

        $items = $this->getWebLinkRepo()->getAllItemsAsContainer(true)
                                        ->getItems();
        foreach ($items as $item) {
            $tpl->setCurrentBlock("link_bl");
            $tpl->setVariable("LINK_URL", $item->getResolvedLink(false));
            $tpl->setVariable("LINK_TITLE", $item->getTitle());
            $tpl->setVariable("LINK_DESC", $item->getDescription() ?? '');
            $tpl->setVariable("LINK_CREATE", $item->getCreateDate()
                                                          ->format('Y-m-d H-i-s'));
            $tpl->setVariable("LINK_UPDATE", $item->getLastUpdate()
                                                          ->format('Y-m-d H-i-s'));
            $tpl->parseCurrentBlock();
        }

        $tpl->setVariable("CREATE_DATE", $this->object->getCreateDate());
        $tpl->setVariable("LAST_UPDATE", $this->object->getLastUpdateDate());
        $tpl->setVariable("TXT_TITLE", $this->object->getTitle());
        $tpl->setVariable("TXT_DESC", $this->object->getLongDescription());

        $tpl->setVariable(
            "INST_ID",
            ($this->settings->get('short_inst_name') != "")
            ? $this->settings->get('short_inst_name')
            : "ILIAS"
        );

        ilUtil::deliverData($tpl->get(), "bookmarks.html");
    }

    public static function _goto(string $a_target, $a_additional = null): void
    {
        global $DIC;

        $main_tpl = $DIC->ui()->mainTemplate();
        $ilAccess = $DIC->access();
        $lng = $DIC->language();
        $ctrl = $DIC->ctrl();
        $ilErr = $DIC['ilErr'];

        if ($a_additional && substr($a_additional, -3) == "wsp") {
            $ctrl->setTargetScript('ilias.php');
            $ctrl->setParameterByClass(
                ilSharedResourceGUI::class,
                'wsp_id',
                $a_target
            );
            $ctrl->redirectByClass(
                [
                    ilSharedResourceGUI::class
                ],
                'edit'
            );
            return;
        }

        // Will be replaced in future releases by ilAccess::checkAccess()
        if ($ilAccess->checkAccess("read", "", (int) $a_target)) {
            ilUtil::redirect(
                "ilias.php?baseClass=ilLinkResourceHandlerGUI&ref_id=" . $a_target
            );
        } elseif ($ilAccess->checkAccess("visible", "", (int) $a_target)) {
            ilUtil::redirect(
                "ilias.php?baseClass=ilLinkResourceHandlerGUI&ref_id=" . $a_target . "&cmd=infoScreen"
            );
        } elseif ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
            $main_tpl->setOnScreenMessage(
                'failure',
                sprintf(
                    $lng->txt("msg_no_perm_read_item"),
                    ilObject::_lookupTitle(
                        ilObject::_lookupObjId(
                            (int) $a_target
                        )
                    )
                ),
                true
            );
            ilObjectGUI::_gotoRepositoryRoot();
        }

        $ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
    }
}