class.ilWOPIAdministrationGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\UI\Component\Item\Item;
use ILIAS\HTTP\Services;
use ILIAS\UI\Factory;
use ILIAS\UI\Renderer;
use ILIAS\components\WOPI\Discovery\Crawler;
use ILIAS\Data\URI;
use ILIAS\components\WOPI\Discovery\AppDBRepository;
use ILIAS\components\WOPI\Discovery\ActionDBRepository;
use ILIAS\components\WOPI\Discovery\ActionRepository;
use ILIAS\components\WOPI\Discovery\AppRepository;
use ILIAS\components\WOPI\Discovery\ActionTarget;
use ILIAS\components\WOPI\Discovery\Action;

class ilWOPIAdministrationGUI
{
    public const CMD_DEFAULT = "index";
    public const CMD_STORE = "store";
    public const CMD_SHOW = 'show';
    private ilCtrlInterface $ctrl;
    private ilAccessHandler $access;
    private Services $http;
    private ilLanguage $lng;
    private ilGlobalTemplateInterface $maint_tpl;
    private ilSetting $settings;
    private Crawler $crawler;
    private ?int $ref_id = null;
    private ActionRepository $action_repo;
    private AppRepository $app_repo;
    private Factory $ui_factory;
    private Renderer $ui_renderer;

    public function __construct()
    {
        global $DIC;
        $this->ctrl = $DIC->ctrl();
        $this->access = $DIC->access();
        $this->http = $DIC->http();
        $this->settings = $DIC->settings();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule("wopi");
        $this->maint_tpl = $DIC->ui()->mainTemplate();
        $this->ref_id = $this->http->wrapper()->query()->has("ref_id")
            ? (int) $this->http->wrapper()->query()->retrieve(
                "ref_id",
                $DIC->refinery()->to()->string()
            )
            : null;
        $this->crawler = new Crawler();
        $this->action_repo = new ActionDBRepository($DIC->database());
        $this->app_repo = new AppDBRepository($DIC->database());

        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
    }

    public function executeCommand(): void
    {
        if (!$this->access->checkAccess("read", "", $this->ref_id)) {
            $this->maint_tpl->setOnScreenMessage('failure', $this->lng->txt("permission_denied"), true);
            $this->ctrl->redirectByClass(ilObjExternalToolsSettingsGUI::class);
        }

        $cmd = $this->ctrl->getCmd(self::CMD_DEFAULT);
        match ($cmd) {
            self::CMD_DEFAULT => $this->index(),
            self::CMD_SHOW => $this->show(),
            self::CMD_STORE => $this->store(),
            default => throw new ilException("command not found: " . $cmd),
        };
    }

    private function index(): void
    {
        $supported_suffixes = $this->getSupportedSuffixes();
        $info = '';
        if (!empty($supported_suffixes)) {
            $listing = $this->ui_factory->panel()->secondary()->legacy(
                $this->lng->txt("currently_supported"),
                $this->ui_factory->legacy(
                    $this->ui_renderer->render(
                        $this->ui_factory->listing()->descriptive([
                            $this->lng->txt('action_edit') => implode(", ", $supported_suffixes[ActionTarget::EDIT->value]),
                            $this->lng->txt('action_view') => implode(", ", $supported_suffixes[ActionTarget::VIEW->value]),
                        ])
                    )
                )
            );
            $info = $this->ui_renderer->render($listing);
        }

        $form = new ilWOPISettingsForm(
            $this->settings,
            $this->access->checkAccess("write", "", $this->ref_id)
        );

        $this->maint_tpl->setContent(
            $form->getHTML()
        );

        $this->maint_tpl->setRightContent($info);
    }

    private function getSupportedSuffixes(): array
    {
        $wopi_activated = (bool) $this->settings->get("wopi_activated", '0');
        if (!$wopi_activated) {
            return [];
        }
        return [
            ActionTarget::EDIT->value => $this->action_repo->getSupportedSuffixes(ActionTarget::EDIT),
            ActionTarget::VIEW->value => $this->action_repo->getSupportedSuffixes(ActionTarget::VIEW),
        ];
    }

    private function show(): void
    {
        $actions = array_map(
            fn(Action $action): Item => $this->ui_factory->item()->standard($action->getExtension())->withProperties([
                $this->lng->txt('launcher_url') => (string) $action->getLauncherUrl(),
                $this->lng->txt('action') => $action->getName()
            ]),
            $this->action_repo->getActionsForTargets(ActionTarget::EDIT, ActionTarget::EMBED_EDIT)
        );

        $this->maint_tpl->setContent(
            $this->ui_renderer->render(
                $this->ui_factory->item()->group(
                    $this->lng->txt('actions'),
                    $actions
                )
            )
        );
    }

    private function store(): void
    {
        if (!$this->access->checkAccess("write", "", $this->ref_id)) {
            $this->maint_tpl->setOnScreenMessage('failure', $this->lng->txt("permission_denied"), true);
            $this->ctrl->redirect($this, self::CMD_DEFAULT);
        }

        $form = new ilWOPISettingsForm(
            $this->settings,
            $this->access->checkAccess("write", "", $this->ref_id)
        );

        if ($form->proceed($this->http->request())) {
            global $DIC;

            $this->maint_tpl->setOnScreenMessage('success', $this->lng->txt("msg_wopi_settings_modified"), true);

            // Crawl
            $discovery_url = $this->settings->get("wopi_discovery_url");
            if ($discovery_url === null) {
                $this->app_repo->clear($this->action_repo);
            } else {
                $apps = $this->crawler->crawl(new URI($discovery_url));
                if ($apps !== null) {
                    $this->app_repo->storeCollection($apps, $this->action_repo);
                }
            }

            $this->ctrl->redirect($this, self::CMD_DEFAULT);
        }

        $this->maint_tpl->setContent($form->getHTML());
    }
}