class.xvmpGUI.php

<?php

declare(strict_types=1);

/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

use ILIAS\DI\Container;
use srag\Plugins\ViMP\UIComponents\PlayerModal\PlayerContainerDTO;
use srag\Plugins\ViMP\Content\MediumMetadataDTOBuilder;
use srag\Plugins\ViMP\UIComponents\Renderer\Factory;
use srag\Plugins\ViMP\UIComponents\Player\VideoPlayer;
use ILIAS\StaticURL\Services;
use ILIAS\Data\ReferenceId;

/**
 * Class xvmpGUI
 * @author  Theodor Truffer <tt@studer-raimann.ch>
 */
abstract class xvmpGUI
{
    public const CMD_STANDARD = 'index';
    public const CMD_CANCEL = 'cancel';
    public const CMD_FLUSH_CACHE = 'flushCache';
    public const CMD_FILL_MODAL = 'fillModalPlayer';
    public const TAB_ACTIVE = ''; // overwrite in subclass
    public const CMD_DOWNLOAD_MEDIUM = 'downloadMedium';
    protected ilObjViMPGUI $parent_gui;
    protected ilViMPPlugin $pl;
    protected Container $dic;
    protected Factory $renderer_factory;
    protected MediumMetadataDTOBuilder $metadata_builder;

    /**
     * xvmpGUI constructor.
     * @param ilObjViMPGUI $parent_gui
     */
    public function __construct(ilObjViMPGUI $parent_gui)
    {
        global $DIC;
        $this->dic = $DIC;
        $this->pl = ilViMPPlugin::getInstance();
        $this->parent_gui = $parent_gui;
        $this->metadata_builder = new MediumMetadataDTOBuilder($DIC, $this->pl);
        $this->renderer_factory = new Factory($DIC, $this->pl);
        $this->addJavaScript();
    }

    protected function addJavaScript() : void
    {
        $this->dic->ui()->mainTemplate()->addJavaScript('./node_modules/webui-popover/dist/jquery.webui-popover.js');
        $this->dic->ui()->mainTemplate()->addJavaScript('./src/UI/templates/js/Popover/popover.js');
    }

    /**
     * @return ilModalGUI
     */
    public static function getModalPlayer() : ilModalGUI
    {
        global $tpl;
        $tpl->addCss(ilViMPPlugin::getInstance()->getAssetURL('default/modal.css'));
        $modal = ilModalGUI::getInstance();
        $modal->setId('xvmp_modal_player');
        $modal->setType(ilModalGUI::TYPE_LARGE);
        $modal->setBody('<section><div id="xvmp_video_container"></div></section>');
        return $modal;
    }

    /**
     * @return mixed
     */
    abstract protected function index();

    /**
     * @throws ilCtrlException
     */
    protected function cancel() : void
    {
        $this->dic->ctrl()->redirect($this, self::CMD_STANDARD);
    }

    /**
     * @throws xvmpException
     */
    protected function downloadMedium() : void
    {
        $mid = filter_input(INPUT_GET, 'mid', FILTER_VALIDATE_INT);
        $video = xvmpMedium::find($mid);
        ilObjViMPAccess::checkAction(ilObjViMPAccess::ACTION_DOWNLOAD_VIDEO, $this, $video);
        xvmp::deliverMedium($video);
    }

    /**
     * @throws ilCtrlException
     */
    public function executeCommand() : void
    {
        if (!$this->dic->ctrl()->isAsynch()) {
            $this->dic->tabs()->activateTab(static::TAB_ACTIVE);
        }

        $nextClass = $this->dic->ctrl()->getNextClass();
        switch ($nextClass) {
            default:
                $cmd = $this->dic->ctrl()->getCmd(self::CMD_STANDARD);
                $this->performCommand($cmd);
                break;
        }
    }

    /**
     * @param $cmd
     */
    protected function performCommand($cmd) : void
    {
        switch ($cmd) {
            case self::CMD_FILL_MODAL:
                if(isset($_GET['mid'])) {
                    $mid = $_GET['mid'];
                    $medium = xvmpMedium::find($mid);
                    ilObjViMPAccess::checkAction(ilObjViMPAccess::ACTION_PLAY_VIDEO, $this, $medium);
                }
                break;
        }

        $this->{$cmd}();
    }

    /**
     *
     */
    public function addFlushCacheButton() : void
    {
        $button = ilLinkButton::getInstance();
        $button->setUrl($this->dic->ctrl()->getLinkTarget($this, self::CMD_FLUSH_CACHE));
        $button->setCaption($this->pl->txt('flush_video_cache'), false);
        $button->setId('xvmp_flush_video_cache');
        $this->dic->toolbar()->addButtonInstance($button);

        ilTooltipGUI::addTooltip('xvmp_flush_video_cache', $this->pl->txt('flush_video_cache_tooltip'));
    }

    /**
     * @throws ilCtrlException
     */
    public function flushCache() : void
    {
        //		xvmpCacheFactory::getInstance()->flush();
        foreach (xvmpSelectedMedia::getSelected($this->getObjId()) as $selected) {
            xvmpCacheFactory::getInstance()->delete(xvmpMedium::class . '-' . $selected->getMid());
        }
        $this->dic->ctrl()->redirect($this, self::CMD_STANDARD);
    }

    /**
     * called by ilObjViMPAccess
     * @throws ilCtrlException
     */
    public function accessDenied() : void
    {
        $this->dic->ui()->mainTemplate()->setOnScreenMessage('failure', $this->pl->txt('access_denied'), true);
        $this->dic->ctrl()->redirect($this->parent_gui, ilObjViMPGUI::CMD_SHOW_CONTENT);
    }

    /**
     * @param $video_mid
     * @return ilModalGUI
     * @throws ilTemplateException
     * @throws xvmpException
     */
    public function getFilledModalPlayer($video_mid) : ilModalGUI
    {
        $selected_medium = xvmpSelectedMedia::where(array('obj_id' => $this->getObjId(), 'mid' => $video_mid));
        if (!ilObjViMPAccess::hasWriteAccess()) {
            $selected_medium = $selected_medium->where(['visible' => 1]);
        }
        /** @var xvmpSelectedMedia $selected_medium */
        $selected_medium = $selected_medium->first();
        if (!$selected_medium) {
            return $this->getAccessDeniedModal();
        }
        $this->dic->ui()->mainTemplate()->addCss($this->pl->getAssetURL('default/modal.css'));
        $modal_content = $this->fillModalPlayer($video_mid, false);
        /** @var xvmpSettings $settings */
        $settings = xvmpSettings::find($this->getObjId());
        if ($settings->getLpActive()) {
            $this->dic->ui()->mainTemplate()->addOnLoadCode('VimpObserver.init(' . $video_mid . ', ' . json_encode($modal_content->time_ranges) . ');');
        }
        $modal = ilModalGUI::getInstance();
        $modal->setId('xvmp_modal_player');
        $modal->setHeading($modal_content->video_title);
        $modal->setType(ilModalGUI::TYPE_LARGE);
        $modal->setBody('<section><div id="xvmp_video_container">' .
            $modal_content->html .
            '</div></section>');
        return $modal;
    }

    /**
     * @return ilModalGUI
     */
    protected function getAccessDeniedModal() : ilModalGUI
    {
        $modal = ilModalGUI::getInstance();
        $modal->setId('xvmp_modal_player');
        $modal->setType(ilModalGUI::TYPE_LARGE);
        $modal->setBody($this->dic->ui()->renderer()->render($this->dic->ui()->factory()->messageBox()->failure($this->pl->txt('access_denied'))));
        return $modal;
    }

    /**
     * @param null $play_video_id
     * @param bool $async
     * @return stdClass
     * @throws ilTemplateException
     * @throws xvmpException
     */
    public function fillModalPlayer($play_video_id = null, bool $async = true) : stdClass
    {
        $mid = $play_video_id ?? $_GET['mid'];
        $video = xvmpMedium::find($mid);
        $playModalDto = $this->buildPlayerContainerDTO($video);

        $response = new stdClass();
        // TODO: Abstract classes MUST NOT know their children. this is a cognitive overload
        // Refactoring Issue: https://git.fluxlabs.ch/fluxlabs/ilias/plugins/RepositoryObjects/ViMP/-/issues/3
        $show_unavailable = ($this instanceof xvmpVideosGUI) || ($this instanceof xvmpContentGUI);
        $response->html = $this->renderer_factory->playerModal()->render($playModalDto, $async, $show_unavailable);

        $response->video_title = $video->getTitle();
        /** @var xvmpUserProgress $progress */
        $progress = xvmpUserProgress::where(array(xvmpUserProgress::F_USR_ID => $this->dic->user()->getId(),
                                                  xvmpMedium::F_MID => $mid
        ))->first();
        if ($progress) {
            $response->time_ranges = json_decode($progress->getRanges());
        } else {
            $response->time_ranges = array();
        }
        if ($async) {
            echo json_encode($response);
            exit;
        } else {
            return $response;
        }
    }

    /**
     * @param xvmpMedium $medium
     * @return PlayerContainerDTO
     * @throws xvmpException|ilCtrlException
     */
    public function buildPlayerContainerDTO(xvmpMedium $medium) : PlayerContainerDTO
    {
        $playerContainerDTO = new PlayerContainerDTO(
            $this->getVideoPlayer($medium, $this->getObjId()),
            $this->metadata_builder->buildFromVimpMedium($medium, false, false)
        );

        $buttons = [];
        if (!is_null($this->getObject())) {
            $buttons[] = $this->buildPermLinkUI($medium);
        }

        if ($medium->isDownloadAllowed()) {
            $this->dic->ctrl()->setParameter($this, 'mid', $medium->getMid());
            $buttons[] = $this->dic->ui()->factory()->button()->standard(
                $this->pl->txt('btn_download'),
                $this->dic->ctrl()->getLinkTarget($this, self::CMD_DOWNLOAD_MEDIUM)
            );
        }

        if (!empty($buttons)) {
            $playerContainerDTO = $playerContainerDTO->withButtons($buttons);
        }

        return $playerContainerDTO;
    }

    /**
     * @throws xvmpException
     */
    protected function getVideoPlayer($video, int $obj_id) : VideoPlayer
    {
        return (new VideoPlayer($video, xvmp::isUseEmbeddedPlayer($obj_id, $video), false));
    }

    /**
     * @return int
     */
    public function getObjId() : int
    {
        $obj = $this->parent_gui->getObject();
        return $obj ? $obj->getId() : 0;
    }

    /**
     * @return ?ilObject
     */
    public function getObject() : ?ilObject
    {
        return $this->parent_gui->getObject();
    }

    /**
     * @param xvmpMedium $video
     * @return ILIAS\UI\Component\Component[]
     */
    public function buildPermLinkUI(xvmpMedium $video) : array
    {
        $items = [];

        $link_tpl = $this->dic['static_url']->builder()->build(
            $this->parent_gui->getType(),
            new ReferenceId($this->parent_gui->getRefId()),
            [$video->getMid() , '0']
        );

        $popover = $this->dic->ui()->factory()->popover()->standard(
            $this->dic->ui()->factory()->legacy($this->pl->txt('popover_link_copied'))
        );

        if (!xvmpConf::getConfig(xvmpConf::F_EMBED_PLAYER)) {
            $items[] = $this->dic->ui()->factory()->button()->shy(
                $this->pl->txt('btn_copy_link_w_time'),
                ''
            )->withOnClick($popover->getShowSignal())->withOnLoadCode(function ($id) use ($link_tpl) {
                return "document.getElementById('$id').addEventListener('click', () => VimpContent.copyDirectLinkWithTime('$link_tpl'));";
            });
        }
        return [
            $popover,
            $this->dic->ui()->factory()->legacy('
                <div class="ilPermalinkContainer input-group">
                    <input class="form-control" id="current_perma_link" type="text" value="' . $link_tpl . '" readonly="readonly" onclick="this.focus();this.select();return false;" />
                    <span class="input-group-btn">'),
            $this->dic->ui()->factory()->dropdown()->standard($items)->withLabel(''),
            $this->dic->ui()->factory()->legacy('</span></div>'),
        ];
    }

    /**
     * ajax
     * @throws xvmpException
     */
    public function updateProgress()
    {
        $mid = (int) $_POST[xvmpMedium::F_MID];
        $ranges = $_POST[xvmpUserProgress::F_RANGES];
        xvmpUserProgress::storeProgress($this->dic->user()->getid(), $mid, $ranges);
        echo "ok";
        exit;
    }

}