class.ilWOPIEmbeddedApplicationGUI.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
use ILIAS\GlobalScreen\Services;
use ILIAS\HTTP\Wrapper\ArrayBasedRequestWrapper;
use ILIAS\Refinery\Factory;
use ILIAS\WOPI\Embed\EmbeddedApplication;
use ILIAS\WOPI\Embed\Renderer;
use ILIAS\WOPI\Embed\EmbeddedApplicationGSProvider;
use ILIAS\FileDelivery\Token\DataSigner;
 
class ilWOPIEmbeddedApplicationGUI
{
    public const CMD_EDIT = 'edit';
    public const CMD_VIEW = 'view';
    public const CMD_RETURN = 'return';
    public const P_RETURN_TO = 'return_to';
    public const DATA_SIGNER_SALT = 'wopi_return';
    private ilGlobalTemplateInterface $main_tpl;
    private ilTabsGUI $tabs;
    private Services $global_screen;
    private Renderer $renderer;
    private \ILIAS\UI\Renderer $ui_renderer;
    private ArrayBasedRequestWrapper $http;
    private Factory $refinery;
    private ilCtrlInterface $ctrl;
    private ilLanguage $lng;
    private DataSigner $data_signer;
 
    public function __construct(
        private EmbeddedApplication $application,
    ) {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->tabs = $DIC->tabs();
        $this->global_screen = $DIC->globalScreen();
        $this->global_screen->layout()->meta()->addJs('./assets/js/wopi.min.js');
        $this->global_screen->layout()->meta()->addOnloadCode('il.WOPI.init();');
        $this->renderer = new Renderer($this->application);
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->http = $DIC->http()->wrapper()->query();
        $this->refinery = $DIC->refinery();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('wopi');
        $this->data_signer = $DIC['file_delivery.data_signer'];
    }
 
    public function executeCommand(): void
    {
        if (!$this->application->isInline()) {
            $this->tabs->clearTargets();
        }
        $this->global_screen->tool()->context()->current()->addAdditionalData(
            EmbeddedApplicationGSProvider::EMBEDDED_APPLICATION,
            $this->application
        );
        $a_value = $this->sign((string) $this->application->getBackTarget());
        $this->ctrl->setParameter($this, self::P_RETURN_TO, $a_value);
 
        match ($this->ctrl->getCmd()) {
            default => $this->edit(),
            self::CMD_EDIT => $this->edit(),
            self::CMD_VIEW => $this->view(),
            self::CMD_RETURN => $this->return(),
        };
    }
 
    private function view(): void
    {
        $this->main_tpl->setContent(
            $this->ui_renderer->render($this->renderer->getComponent())
        );
    }
 
    private function edit(): void
    {
        $this->main_tpl->setContent(
            $this->ui_renderer->render($this->renderer->getComponent())
        );
    }
 
    private function return(): void
    {
        $return_to = $this->http->has(self::P_RETURN_TO)
            ? $this->verify((string) $this->http->retrieve(self::P_RETURN_TO, $this->refinery->kindlyTo()->string()))
            : null;
 
        if ($return_to === null) {
            $return_to = (string) $this->application->getBackTarget();
        }
 
        $this->main_tpl->setOnScreenMessage(
            'info',
            $this->lng->txt('close_wopi_editor_info'),
            true
        );
 
        $this->ctrl->redirectToURL($return_to);
    }
 
    private function sign(string $back_target): string
    {
        return $this->data_signer->sign(['t' => $back_target], self::DATA_SIGNER_SALT);
    }
 
    private function verify(string $back_target_token): ?string
    {
        return $this->data_signer->verify($back_target_token, self::DATA_SIGNER_SALT)['t'] ?? null;
    }
}