class.ilBuddySystemGUI.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use ILIAS\Filesystem\Stream\Streams;
use ILIAS\HTTP\Response\ResponseHeader;
use ILIAS\HTTP\Services;
use ILIAS\UI\Factory as UIFactory;
use ILIAS\UI\Renderer as UIRenderer;
 
class ilBuddySystemGUI
{
    private const int BS_REQUEST_HTTP_GET = 1;
    private const int BS_REQUEST_HTTP_POST = 2;
 
    protected static bool $isFrontendInitialized = false;
 
    protected ilCtrlInterface $ctrl;
    protected ilBuddyList $buddyList;
    protected ilBuddySystemRelationStateFactory $stateFactory;
    protected ilObjUser $user;
    protected ilLanguage $lng;
    protected Services $http;
    private readonly ilGlobalTemplateInterface $main_tpl;
    private UIFactory $ui_factory;
    private UIRenderer $ui_renderer;
 
    public function __construct()
    {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();
 
        $this->http = $DIC->http();
        $this->ctrl = $DIC['ilCtrl'];
        $this->user = $DIC['ilUser'];
        $this->lng = $DIC['lng'];
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
 
        $this->buddyList = ilBuddyList::getInstanceByGlobalUser();
        $this->stateFactory = ilBuddySystemRelationStateFactory::getInstance();
 
        $this->lng->loadLanguageModule('buddysystem');
    }
 
    public static function initializeFrontend(ilGlobalTemplateInterface $page): void
    {
        global $DIC;
 
        if (
            !self::$isFrontendInitialized &&
            ilBuddySystem::getInstance()->isEnabled() &&
            !$DIC->user()->isAnonymous()
        ) {
            $DIC->language()->loadLanguageModule('buddysystem');
 
            $page->addJavaScript('./assets/js/buddy_system.js');
            $page->addJavaScript('./assets/js/modal.min.js');
 
            $config = new stdClass();
            $config->async_get_unlink_modal_confirmation_html = $DIC->ctrl()->getLinkTargetByClass([
                ilUIPluginRouterGUI::class,
                self::class
            ], 'asyncGetUnlinkModalConfirmationHtml', '', true, false);
 
            $config->http_post_url = $DIC->ctrl()->getFormActionByClass([
                ilUIPluginRouterGUI::class,
                self::class
            ], '', '', true, false);
            $config->transition_state_cmd = 'transitionAsync';
            $page->addOnLoadCode('il.BuddySystem.setConfig(' . json_encode($config, JSON_THROW_ON_ERROR) . ');');
 
            $btn_config = new stdClass();
            $btn_config->bnt_class = ilBuddySystemLinkButtonType::ROOT_CSS_CLASS;
 
            $page->addOnLoadCode('il.BuddySystemButton.setConfig(' . json_encode($btn_config, JSON_THROW_ON_ERROR) . ');');
            $page->addOnLoadCode('il.BuddySystemButton.init();');
 
            self::$isFrontendInitialized = true;
        }
    }
 
    public function asyncGetUnlinkModalConfirmationHtmlCommand(): never
    {
        $modal_id = null;
        $confirmation_modal = $this
            ->ui_factory
            ->modal()
            ->interruptive(
                $this->lng->txt('confirmation'),
                $this->lng->txt('buddy_confirm_unlink'),
                ''
            )
            ->withActionButtonLabel($this->lng->txt('confirm'))
            ->withAdditionalOnLoadCode(function ($id) use (&$modal_id) {
                $modal_id = $id;
                return '';
            });
 
        $this->http->saveResponse(
            $this->http->response()->withBody(
                Streams::ofString(
                    json_encode([
                        'html' => $this->ui_renderer->renderAsync($confirmation_modal),
                        'signals' => [
                            'close' => $confirmation_modal->getCloseSignal()->getId()
                        ],
                        'modalId' => $modal_id
                    ], JSON_THROW_ON_ERROR)
                )
            )->withHeader(ResponseHeader::CONTENT_TYPE, 'application/json')
        );
        $this->http->sendResponse();
        $this->http->close();
    }
 
    public function executeCommand(): void
    {
        if ($this->user->isAnonymous()) {
            throw new RuntimeException('This controller only accepts requests of logged in users');
        }
 
        $this->{$this->ctrl->getCmd() . 'Command'}();
    }
 
    protected function isRequestParameterGiven(string $key, int $type): bool
    {
        switch ($type) {
            case self::BS_REQUEST_HTTP_POST:
                $body = $this->http->request()->getParsedBody();
                return (isset($body[$key]) && is_string($body[$key]) && $body[$key] !== '');
 
            case self::BS_REQUEST_HTTP_GET:
            default:
                $query = $this->http->request()->getQueryParams();
                return (isset($query[$key]) && is_string($query[$key]) && $query[$key] !== '');
        }
    }
 
    private function requestCommand(): void
    {
        $this->transitionCommand(
            'request',
            'buddy_relation_requested',
            static function (ilBuddySystemRelation $relation): void {
                if (
                    $relation->isUnlinked() &&
                    !ilUtil::yn2tf((string) ilObjUser::_lookupPref($relation->getBuddyUsrId(), 'bs_allow_to_contact_me'))
                ) {
                    throw new ilException('The requested user does not want to get contact requests');
                }
            }
        );
    }
 
    private function ignoreCommand(): void
    {
        $this->transitionCommand('ignore', 'buddy_request_ignored');
    }
 
    private function linkCommand(): void
    {
        $this->transitionCommand('link', 'buddy_request_approved');
    }
 
    private function transitionCommand(
        string $cmd,
        string $positiveFeedbackLanguageId,
        ?callable $onBeforeExecute = null
    ): void {
        if (!$this->isRequestParameterGiven('user_id', self::BS_REQUEST_HTTP_GET)) {
            $this->main_tpl->setOnScreenMessage('info', $this->lng->txt('buddy_bs_action_not_possible'), true);
            $this->ctrl->returnToParent($this);
        }
 
        $usrId = (int) $this->http->request()->getQueryParams()['user_id'];
        try {
            $relation = ilBuddyList::getInstanceByGlobalUser()->getRelationByUserId($usrId);
 
            if (null !== $onBeforeExecute) {
                $onBeforeExecute($relation);
            }
 
            ilBuddyList::getInstanceByGlobalUser()->{$cmd}($relation);
            $this->main_tpl->setOnScreenMessage('success', $this->lng->txt($positiveFeedbackLanguageId), true);
        } catch (ilBuddySystemRelationStateAlreadyGivenException | ilBuddySystemRelationStateTransitionException $e) {
            $this->main_tpl->setOnScreenMessage('info', sprintf(
                $this->lng->txt($e->getMessage()),
                ilObjUser::_lookupLogin($usrId)
            ), true);
        } catch (Exception) {
            $this->main_tpl->setOnScreenMessage('info', $this->lng->txt('buddy_bs_action_not_possible'), true);
        }
 
        $this->redirectToReferer();
    }
 
    private function transitionAsyncCommand(): void
    {
        if (!$this->ctrl->isAsynch()) {
            throw new RuntimeException('This action only supports AJAX http requests');
        }
 
        if (!$this->isRequestParameterGiven('usr_id', self::BS_REQUEST_HTTP_POST)) {
            throw new RuntimeException('Missing "usr_id" parameter');
        }
 
        if (!$this->isRequestParameterGiven('action', self::BS_REQUEST_HTTP_POST)) {
            throw new RuntimeException('Missing "action" parameter');
        }
 
        $response = new stdClass();
        $response->success = false;
 
        try {
            $usr_id = (int) $this->http->request()->getParsedBody()['usr_id'];
            $action = ilUtil::stripSlashes($this->http->request()->getParsedBody()['action']);
 
            if (ilObjUser::_isAnonymous($usr_id)) {
                throw new ilBuddySystemException(sprintf(
                    'You cannot perform a state transition for the anonymous user (id: %s)',
                    $usr_id
                ));
            }
 
            $login = ilObjUser::_lookupLogin($usr_id);
            if ($login === '') {
                throw new ilBuddySystemException(sprintf(
                    'You cannot perform a state transition for a non existing user (id: %s)',
                    $usr_id
                ));
            }
 
            $relation = $this->buddyList->getRelationByUserId($usr_id);
 
            // The ILIAS JF decided to add a new personal setting
            if (
                $relation->isUnlinked() &&
                !ilUtil::yn2tf((string) ilObjUser::_lookupPref($relation->getBuddyUsrId(), 'bs_allow_to_contact_me'))
            ) {
                throw new ilException('The requested user does not want to get contact requests');
            }
 
            try {
                $this->buddyList->{$action}($relation);
                $response->success = true;
            } catch (ilBuddySystemRelationStateAlreadyGivenException|ilBuddySystemRelationStateTransitionException $e) {
                $response->message = sprintf($this->lng->txt($e->getMessage()), $login);
            } catch (Exception) {
                $response->message = $this->lng->txt('buddy_bs_action_not_possible');
            }
 
            $response->state = $relation->getState()::class;
            $response->state_html = $this->stateFactory->getStateButtonRendererByOwnerAndRelation(
                $this->buddyList->getOwnerId(),
                $relation
            )->getHtml();
        } catch (Exception) {
            $response->message = $this->lng->txt('buddy_bs_action_not_possible');
        }
 
        $this->http->saveResponse(
            $this->http->response()
                ->withAddedHeader('Content-Type', 'application/json')
                ->withBody(ILIAS\Filesystem\Stream\Streams::ofString(json_encode($response, JSON_THROW_ON_ERROR)))
        );
        $this->http->sendResponse();
        $this->http->close();
    }
 
    private function redirectToReferer(): void
    {
        if (isset($this->http->request()->getServerParams()['HTTP_REFERER'])) {
            $redirectUrl = $this->http->request()->getServerParams()['HTTP_REFERER'];
            $urlParts = parse_url($redirectUrl);
 
            if (isset($urlParts['path'])) {
                $script = basename($urlParts['path'], '.php');
                if ($script === 'login') {
                    $this->ctrl->returnToParent($this);
                } else {
                    $redirectUrl = ltrim(basename($urlParts['path']), '/');
                    if (isset($urlParts['query'])) {
                        $redirectUrl .= '?' . $urlParts['query'];
                    }
                }
            }
 
            if ($redirectUrl !== '') {
                $this->ctrl->redirectToURL($redirectUrl);
            }
        }
 
        $this->ctrl->returnToParent($this);
    }
}