class.ilChatroomGUIHandler.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Filesystem\Filesystem;
use ILIAS\Filesystem\Stream\Streams;
use ILIAS\FileUpload\FileUpload;
use ILIAS\HTTP\GlobalHttpState;
use ILIAS\HTTP\Response\ResponseHeader;
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\Refinery\Transformation;
use ILIAS\UI\Factory as UIFactory;
use ILIAS\UI\Renderer as UIRenderer;

abstract class ilChatroomGUIHandler
{
    protected ilChatroomObjectGUI $gui;
    protected ilObjUser $ilUser;
    protected ilCtrlInterface $ilCtrl;
    protected ilLanguage $ilLng;
    protected Filesystem $webDirectory;
    protected ilObjectService $obj_service;
    protected FileUpload $upload;
    protected ilRbacSystem $rbacsystem;
    protected ilGlobalTemplateInterface $mainTpl;
    protected ILIAS $ilias;
    protected ilNavigationHistory $navigationHistory;
    protected ilTree $tree;
    protected ilTabsGUI $tabs;
    protected UIFactory $uiFactory;
    protected UIRenderer $uiRenderer;
    protected GlobalHttpState $http;
    protected Refinery $refinery;

    public function __construct(ilChatroomObjectGUI $gui)
    {
        global $DIC;

        $this->gui = $gui;
        $this->ilUser = $DIC->user();
        $this->ilCtrl = $DIC->ctrl();
        $this->ilLng = $DIC->language();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->mainTpl = $DIC->ui()->mainTemplate();
        $this->upload = $DIC->upload();
        $this->webDirectory = $DIC->filesystem()->web();
        $this->obj_service = $DIC->object();
        $this->ilias = $DIC['ilias'];
        $this->tabs = $DIC->tabs();
        $this->navigationHistory = $DIC['ilNavigationHistory'];
        $this->tree = $DIC['tree'];
        $this->uiFactory = $DIC->ui()->factory();
        $this->uiRenderer = $DIC->ui()->renderer();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
    }

    protected function getRequestValue(string $key, Transformation $trafo, $default = null)
    {
        if ($this->http->wrapper()->query()->has($key)) {
            return $this->http->wrapper()->query()->retrieve($key, $trafo);
        }

        if ($this->http->wrapper()->post()->has($key)) {
            return $this->http->wrapper()->post()->retrieve($key, $trafo);
        }

        return $default;
    }

    protected function hasRequestValue(string $key): bool
    {
        if ($this->http->wrapper()->query()->has($key)) {
            return true;
        }

        return $this->http->wrapper()->post()->has($key);
    }

    public function execute(string $method): void
    {
        $this->ilLng->loadLanguageModule('chatroom');

        if (method_exists($this, $method)) {
            $this->$method();
            return;
        }

        $this->executeDefault($method);
    }

    abstract public function executeDefault(string $requestedMethod): void;

    public function redirectIfNoPermission($permission): void
    {
        if (!ilChatroom::checkUserPermissions($permission, $this->gui->getRefId())) {
            $this->ilCtrl->setParameterByClass(ilRepositoryGUI::class, 'ref_id', ROOT_FOLDER_ID);
            $this->ilCtrl->redirectByClass(ilRepositoryGUI::class);
        }
    }

    public function isSuccessful($response): bool
    {
        if (!is_string($response)) {
            return false;
        }

        $response = json_decode($response, true, 512, JSON_THROW_ON_ERROR);

        return $response !== null && array_key_exists('success', $response) && $response['success'];
    }

    protected function getRoomByObjectId(int $objectId): ?ilChatroom
    {
        return ilChatroom::byObjectId($objectId);
    }

    protected function exitIfNoRoomExists(?ilChatroom $room): void
    {
        if (null === $room) {
            $this->sendResponse([
                'success' => false,
                'reason' => 'unknown room',
            ]);
        }
    }

    public function sendResponse($response, bool $isJson = false): void
    {
        $this->http->saveResponse(
            $this->http->response()
                ->withHeader(ResponseHeader::CONTENT_TYPE, 'application/json')
                ->withBody(Streams::ofString($isJson ? $response : json_encode($response, JSON_THROW_ON_ERROR)))
        );
        $this->http->sendResponse();
        $this->http->close();
    }

    protected function exitIfNoRoomModeratePermission(ilChatroom $room, int $subRoom, ilChatroomUser $chatUser): void
    {
        if (!$this->canModerate($room, $subRoom, $chatUser->getUserId())) {
            $this->sendResponse([
                'success' => false,
                'reason' => 'not owner of private room',
            ]);
        }
    }

    protected function canModerate(ilChatroom $room, int $subRoom, int $usrId): bool
    {
        return (
            $this->isMainRoom($subRoom) ||
            $room->isOwnerOfPrivateRoom($usrId, $subRoom) ||
            $this->hasPermission('moderate')
        );
    }

    protected function isMainRoom(int $subRoomId): bool
    {
        return $subRoomId === 0;
    }

    public function hasPermission(string $permission): bool
    {
        return ilChatroom::checkUserPermissions($permission, $this->gui->getRefId());
    }
}