class.ilChatUserActionProvider.php

Go to the documentation of this file.

<?php

class ilChatUserActionProvider extends ilUserActionProvider
{
    protected static array $user_access = [];
    protected static array $accepts_messages_cache = [];
    protected int $pub_ref_id = 0;
    protected bool $chat_enabled = false;
    protected bool $osc_enabled = false;
    protected ilCtrlInterface $ctrl;

    public function __construct()
    {
        parent::__construct();

        global $DIC;

        $this->pub_ref_id = ilObjChatroom::_getPublicRefId();

        $chatSettings = new ilSetting('chatroom');
        $this->chat_enabled = (bool) $chatSettings->get('chat_enabled');
        $this->osc_enabled = (bool) $chatSettings->get('enable_osc');

        $this->lng->loadLanguageModule('chatroom');
        $this->ctrl = $DIC->ctrl();
    }

    public function getComponentId(): string
    {
        return "chtr";
    }

    public function getActionTypes(): array
    {
        return [
            "invite" => $this->lng->txt('chat_user_action_invite_public_room'),
            "invite_osd" => $this->lng->txt('chat_user_action_invite_osd')
        ];
    }

    protected function checkUserChatAccess(int $a_user_id): bool
    {
        if (!array_key_exists($a_user_id, self::$user_access)) {
            self::$user_access[$a_user_id] = $GLOBALS['DIC']->rbac()->system()->checkAccessOfUser($a_user_id, 'read', $this->pub_ref_id);
        }

        return self::$user_access[$a_user_id];
    }

    protected function acceptsMessages(int $a_user_id): bool
    {
        if (!array_key_exists($a_user_id, self::$accepts_messages_cache)) {
            self::$accepts_messages_cache[$a_user_id] = ilUtil::yn2tf(
                ilObjUser::_lookupPref($a_user_id, 'chat_osc_accept_msg') ?? 'n'
            );
        }

        return (bool) self::$accepts_messages_cache[$a_user_id];
    }

    public function collectActionsForTargetUser(int $a_target_user): ilUserActionCollection
    {
        $coll = new ilUserActionCollection();

        if (!$this->chat_enabled) {
            return $coll;
        }

        if ($this->checkUserChatAccess($this->getUserId()) && $a_target_user != $this->getUserId()) {
            if ($this->checkUserChatAccess($a_target_user)) {
                $f = new ilUserAction();
                $f->setType("invite");
                $f->setText($this->lng->txt('chat_user_action_invite_public_room'));
                $this->ctrl->setParameterByClass(ilObjChatroomGUI::class, 'ref_id', $this->pub_ref_id);
                $this->ctrl->setParameterByClass(ilObjChatroomGUI::class, 'user', $a_target_user);
                $f->setHref($this->ctrl->getLinkTargetByClass([ilRepositoryGUI::class, ilObjChatroomGUI::class], 'inviteUsersToPrivateRoom-byId'));
                $coll->addAction($f);
            }
        }

        if ($this->osc_enabled && $a_target_user != $this->getUserId()) {
            $f = new ilUserAction();
            $f->setHref('#');
            $f->setType("invite_osd");
            if ($this->acceptsMessages($a_target_user)) {
                $f->setText($this->lng->txt('chat_osc_start_conversation'));
                $f->setData([
                    'onscreenchat-userid' => $a_target_user,
                    'onscreenchat-username' => ilObjUser::_lookupLogin($a_target_user)
                ]);
            } else {
                $f->setText($this->lng->txt('chat_osc_doesnt_accept_msg'));
                $f->setData([
                    'onscreenchat-inact-userid' => $a_target_user
                ]);
            }
            $coll->addAction($f);
        }

        return $coll;
    }
}