ilOnScreenChatGUI Class Reference

Class ilOnScreenChatGUI. More...

Inheritance diagram for ilOnScreenChatGUI:

Collaboration diagram for ilOnScreenChatGUI:

Public Member Functions
	__construct ()
	executeCommand ()

Static Public Member Functions
static	initializeFrontend (ilGlobalTemplateInterface $page)

Static Protected Member Functions
static	isOnScreenChatAccessible (ilSetting $chatSettings)

Static Protected Attributes
static bool	$frontend_initialized = false

Private Member Functions
	getResponseWithText (string $body)
	verifyLogin ()
	getUserList ()
	getUserProfileData ()
	renderAsyncModal (string $bus_name, $modal)

Private Attributes
readonly ILIAS DI Container	$dic
readonly ILIAS HTTP Services	$http
readonly ilCtrlInterface	$ctrl
readonly ilObjUser	$actor

Detailed Description

Class ilOnScreenChatGUI.

Author

Thomas Joußen tjous.nosp@m.sen@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Since

26.07.16

Definition at line 33 of file class.ilOnScreenChatGUI.php.

Constructor & Destructor Documentation

__construct()

ilOnScreenChatGUI::__construct

(

)

Definition at line 42 of file class.ilOnScreenChatGUI.php.

References $DIC, ILIAS\Repository\ctrl(), and ILIAS\FileDelivery\http().

    {
        global $DIC;

        $this->dic = $DIC;
        $this->http = $DIC->http();
        $this->ctrl = $DIC->ctrl();
        $this->actor = $DIC->user();
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilOnScreenChatGUI::executeCommand

(

)

Definition at line 68 of file class.ilOnScreenChatGUI.php.

References $provider, $response, $txt, ILIAS\Repository\ctrl(), getResponseWithText(), getUserList(), getUserProfileData(), ILIAS\FileDelivery\http(), renderAsyncModal(), and verifyLogin().

                                    : void
    {
        $cmd = $this->ctrl->getCmd();
        switch ($cmd) {
            case 'getUserProfileData':
                $response = $this->getUserProfileData();
                break;

            case 'verifyLogin':
                $response = $this->verifyLogin();
                break;

            case 'getRenderedConversationItems':
                $provider = new OnScreenChatProvider(
                    $this->dic,
                    new Conversation($this->dic->database(), $this->dic->user()),
                    new Subscriber($this->dic->database(), $this->dic->user())
                );

                $conversationIds = (string) ($this->dic->http()->request()->getQueryParams()['ids'] ?? '');
                $noAggregates = ($this->dic->http()->request()->getQueryParams()['no_aggregates'] ?? '');

                $response = $this->getResponseWithText(
                    $this->dic->ui()->renderer()->renderAsync($provider->getAsyncItem(
                        $conversationIds,
                        $noAggregates !== 'true'
                    ))
                );
                break;

            case 'inviteModal':
                $this->dic->language()->loadLanguageModule('chatroom');
                $txt = $this->dic->language()->txt(...);
                $modal = $this->dic->ui()->factory()->modal()->roundtrip($txt('chat_osc_invite_to_conversation'), $this->dic->ui()->factory()->legacy()->content($txt('chat_osc_search_modal_info')), [
                    $this->dic->ui()->factory()->input()->field()->text($txt('chat_osc_user')),
                ])->withSubmitLabel($txt('confirm'));
                $response = $this->renderAsyncModal('inviteModal', $modal);
                break;

            case 'confirmRemove':
                $this->dic->language()->loadLanguageModule('chatroom');
                $txt = $this->dic->language()->txt(...);
                $modal = $this->dic->ui()->factory()->modal()->interruptive(
                    $txt('chat_osc_leave_grp_conv'),
                    $txt('chat_osc_sure_to_leave_grp_conv'),
                    ''
                )->withActionButtonLabel($txt('confirm'));
                $response = $this->renderAsyncModal('confirmRemove', $modal);
                break;

            case 'getUserlist':
            default:
                $response = $this->getUserList();
        }

        if ($this->ctrl->isAsynch()) {
            $this->http->saveResponse($response);
            $this->http->sendResponse();
            $this->http->close();
        }
    }

Here is the call graph for this function:

getResponseWithText()

ilOnScreenChatGUI::getResponseWithText ( string  $body )

private

Definition at line 52 of file class.ilOnScreenChatGUI.php.

Referenced by executeCommand(), getUserList(), getUserProfileData(), renderAsyncModal(), and verifyLogin().

                                                      : ResponseInterface
    {
        return $this->dic->http()->response()->withBody(Streams::ofString($body));
    }

Here is the caller graph for this function:

getUserList()

ilOnScreenChatGUI::getUserList ( )

private

Definition at line 139 of file class.ilOnScreenChatGUI.php.

References getResponseWithText(), ILIAS\FileDelivery\http(), ilUserAutoComplete\MAX_ENTRIES, and ilUserAutoComplete\PRIVACY_MODE_RESPECT_USER_SETTING.

Referenced by executeCommand().

                                  : ResponseInterface
    {
        if (!$this->actor->getId() || $this->actor->isAnonymous()) {
            return $this->getResponseWithText(json_encode([], JSON_THROW_ON_ERROR));
        }

        $auto = new ilOnScreenChatUserUserAutoComplete();
        $auto->setUser($this->actor);
        $auto->setPrivacyMode(ilUserAutoComplete::PRIVACY_MODE_RESPECT_USER_SETTING);
        if (isset($this->http->request()->getQueryParams()['fetchall'])) {
            $auto->setLimit(ilUserAutoComplete::MAX_ENTRIES);
        }
        $auto->setMoreLinkAvailable(true);
        $auto->setSearchFields(['firstname', 'lastname']);
        $auto->setResultField('login');
        $auto->enableFieldSearchableCheck(true);

        return $this->getResponseWithText($auto->getList($this->http->request()->getQueryParams()['term'] ?? ''));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUserProfileData()

ilOnScreenChatGUI::getUserProfileData ( )

private

Definition at line 159 of file class.ilOnScreenChatGUI.php.

References $data, ilSession\enableWebAccessWithoutSession(), getResponseWithText(), and ILIAS\FileDelivery\http().

Referenced by executeCommand().

                                         : ResponseInterface
    {
        if (!$this->actor->getId() || $this->actor->isAnonymous()) {
            return $this->getResponseWithText(json_encode([], JSON_THROW_ON_ERROR));
        }

        $usrIds = (string) ($this->http->request()->getQueryParams()['usr_ids'] ?? '');
        if ($usrIds === '') {
            return $this->getResponseWithText(json_encode([], JSON_THROW_ON_ERROR));
        }

        $this->dic->language()->loadLanguageModule('user');
        $subscriberRepo = new Subscriber($this->dic->database(), $this->dic->user());
        $data = $subscriberRepo->getDataByUserIds(explode(',', $usrIds));

        ilSession::enableWebAccessWithoutSession(true);

        return $this->getResponseWithText(json_encode($data, JSON_THROW_ON_ERROR));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initializeFrontend()

static ilOnScreenChatGUI::initializeFrontend ( ilGlobalTemplateInterface  $page )

static

Definition at line 179 of file class.ilOnScreenChatGUI.php.

References $DIC, $renderer, ILIAS\UICore\GlobalTemplate\addJavaScript(), ILIAS\UICore\GlobalTemplate\addOnLoadCode(), ilUtil\getImagePath(), ilUtil\img(), iljQueryUtil\initjQuery(), iljQueryUtil\initjQueryUI(), ilLinkifyUtil\initLinkify(), ilChatroomServerSettings\loadDefault(), null, and ilUtil\yn2tf().

Referenced by ilGlobalPageTemplate\prepareBasicJS().

                                                                              : void
    {
        global $DIC;

        if (!self::$frontend_initialized) {
            $clientSettings = new ilSetting('chatroom');

            if (!self::isOnScreenChatAccessible($clientSettings)) {
                self::$frontend_initialized = true;
                return;
            }

            $settings = ilChatroomServerSettings::loadDefault();

            $DIC->language()->loadLanguageModule('chatroom');
            $DIC->language()->loadLanguageModule('user');

            $renderer = $DIC->ui()->renderer();
            $factory = $DIC->ui()->factory();

            $chatWindowTemplate = new ilTemplate('tpl.chat-window.html', false, false, 'components/ILIAS/OnScreenChat');
            $chatWindowTemplate->setVariable('SUBMIT_ACTION', $renderer->render(
                $factory->button()->standard($DIC->language()->txt('chat_osc_send'), 'onscreenchat-submit')
            ));
            $chatWindowTemplate->setVariable('ADD_ACTION', $renderer->render(
                $factory->symbol()->glyph()->add('addUser')
            ));
            $chatWindowTemplate->setVariable('MINIMIZE_ACTION', $renderer->render(
                $factory->button()->minimize()
            ));
            $chatWindowTemplate->setVariable('CONVERSATION_ICON', ilUtil::img(ilUtil::getImagePath('standard/icon_pcht.svg')));

            $subscriberRepo = new Subscriber($DIC->database(), $DIC->user());

            $guiConfig = [
                'chatWindowTemplate' => $chatWindowTemplate->get(),
                'messageTemplate' => (new ilTemplate(
                    'tpl.chat-message.html',
                    false,
                    false,
                    'components/ILIAS/OnScreenChat'
                ))->get(),
                'nothingFoundTemplate' => $DIC->ui()->renderer()->render($DIC->ui()->factory()->messageBox()->info($DIC->language()->txt('chat_osc_no_usr_found'))),
                'userId' => $DIC->user()->getId(),
                'username' => $DIC->user()->getLogin(),
                'modalURLTemplate' => ILIAS_HTTP_PATH . '/' . $DIC->ctrl()->getLinkTargetByClass(
                    ilOnScreenChatGUI::class,
                    'postMessage',
                    null,
                    true
                ),
                'userListURL' => ILIAS_HTTP_PATH . '/' . $DIC->ctrl()->getLinkTargetByClass(
                    'ilonscreenchatgui',
                    'getUserList',
                    '',
                    true,
                    false
                ),
                'userProfileDataURL' => $DIC->ctrl()->getLinkTargetByClass(
                    'ilonscreenchatgui',
                    'getUserProfileData',
                    '',
                    true,
                    false
                ),
                'verifyLoginURL' => $DIC->ctrl()->getLinkTargetByClass(
                    'ilonscreenchatgui',
                    'verifyLogin',
                    '',
                    true,
                    false
                ),
                'renderConversationItemsURL' => $DIC->ctrl()->getLinkTargetByClass(
                    'ilonscreenchatgui',
                    'getRenderedConversationItems',
                    '',
                    true,
                    false
                ),
                'loaderImg' => ilUtil::getImagePath('media/loader.svg'),
                'locale' => $DIC->language()->getLangKey(),
                'initialUserData' => $subscriberRepo->getInitialUserProfileData(),
                'enabledBrowserNotifications' => (
                    $clientSettings->get('enable_browser_notifications', '0') &&
                    ilUtil::yn2tf((string) $DIC->user()->getPref('chat_osc_browser_notifications'))
                ),
                'broadcast_typing' => (
                    ilUtil::yn2tf((string) $DIC->user()->getPref('chat_broadcast_typing'))
                ),
                'notificationIconPath' => ilUtil::getImagePath('standard/icon_chta.png'),
            ];

            $chatConfig = [
                'url' => $settings->generateClientUrl() . '/' . $settings->getInstance() . '-im',
                'subDirectory' => $settings->getSubDirectory() . '/socket.io',
                'userId' => $DIC->user()->getId(),
                'username' => $DIC->user()->getLogin(),
            ];

            $DIC->language()->toJS([
                'chat_osc_no_usr_found',
                'chat_osc_write_a_msg',
                'autocomplete_more',
                'chat_osc_minimize',
                'chat_osc_invite_to_conversation',
                'chat_osc_user',
                'chat_osc_add_user',
                'chat_osc_subs_rej_msgs',
                'chat_osc_subs_rej_msgs_p',
                'chat_osc_self_rej_msgs',
                'chat_osc_search_modal_info',
                'chat_osc_head_grp_x_persons',
                'osc_noti_title',
                'chat_osc_conversations',
                'chat_osc_sure_to_leave_grp_conv',
                'chat_osc_user_left_grp_conv',
                'confirm',
                'cancel',
                'chat_osc_leave_grp_conv',
                'chat_osc_no_conv',
                'chat_osc_nc_conv_x_p',
                'chat_osc_nc_conv_x_s',
                'chat_osc_nc_no_conv',
                'chat_user_x_is_typing',
                'chat_users_are_typing',
                'today',
                'yesterday',
            ], $page);

            iljQueryUtil::initjQuery($page);
            iljQueryUtil::initjQueryUI($page);
            ilLinkifyUtil::initLinkify($page);

            $page->addJavaScript('assets/js/modal.min.js');
            $page->addJavaScript('assets/js/socket.io.min.js');
            $page->addJavaScript('assets/js/Chatroom.min.js');
            $page->addJavaScript('assets/js/moment-with-locales.min.js');
            $page->addJavaScript('assets/js/browser_notifications.js');
            $page->addJavaScript('assets/js/onscreenchat-notifications.js');
            $page->addJavaScript('assets/js/moment.js');
            $page->addJavaScript('assets/js/chat.js');
            $page->addJavaScript('assets/js/onscreenchat.js');
            $page->addOnLoadCode("il.Chat.setConfig(" . json_encode($chatConfig, JSON_THROW_ON_ERROR) . ");");
            $page->addOnLoadCode("il.OnScreenChat.setConfig(" . json_encode($guiConfig, JSON_THROW_ON_ERROR) . ");");
            $page->addOnLoadCode("il.OnScreenChat.init();");
            $page->addOnLoadCode('il.OnScreenChatNotifications.init(' . json_encode([
                'conversationIdleTimeThreshold' => max(
                    1,
                    (int) $clientSettings->get('conversation_idle_state_in_minutes', '1')
                ),
                'logLevel' => $DIC['ilLoggerFactory']->getSettings()->getLevelByComponent('osch'),
            ], JSON_THROW_ON_ERROR) . ');');

            self::$frontend_initialized = true;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isOnScreenChatAccessible()

static ilOnScreenChatGUI::isOnScreenChatAccessible ( ilSetting  $chatSettings )

staticprotected

Definition at line 57 of file class.ilOnScreenChatGUI.php.

References $DIC, and ilSetting\get().

                                                                               : bool
    {
        global $DIC;

        return (
            $chatSettings->get('chat_enabled', '0') &&
            $chatSettings->get('enable_osc', '0') &&
            $DIC->user() && !$DIC->user()->isAnonymous()
        );
    }

Here is the call graph for this function:

renderAsyncModal()

ilOnScreenChatGUI::renderAsyncModal ( string  $bus_name,   $modal  )

private

Definition at line 336 of file class.ilOnScreenChatGUI.php.

References $id, and getResponseWithText().

Referenced by executeCommand().

    {
        return $this->getResponseWithText($this->dic->ui()->renderer()->renderAsync($modal->withAdditionalOnLoadCode(fn($id) => (
            'il.OnScreenChat.bus.send(' . json_encode($bus_name, JSON_THROW_ON_ERROR) . ', ' . json_encode([(string) $modal->getShowSignal(), (string) $modal->getCloseSignal()], JSON_THROW_ON_ERROR) . ');'
        ))));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

verifyLogin()

ilOnScreenChatGUI::verifyLogin ( )

private

Definition at line 130 of file class.ilOnScreenChatGUI.php.

References ilSession\enableWebAccessWithoutSession(), and getResponseWithText().

Referenced by executeCommand().

                                  : ResponseInterface
    {
        ilSession::enableWebAccessWithoutSession(true);

        return $this->getResponseWithText(json_encode([
            'loggedIn' => $this->actor->getId() && !$this->actor->isAnonymous()
        ], JSON_THROW_ON_ERROR));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$actor

readonly ilObjUser ilOnScreenChatGUI::$actor

private

Definition at line 40 of file class.ilOnScreenChatGUI.php.

$ctrl

readonly ilCtrlInterface ilOnScreenChatGUI::$ctrl

private

Definition at line 39 of file class.ilOnScreenChatGUI.php.

$dic

readonly ILIAS DI Container ilOnScreenChatGUI::$dic

private

Definition at line 37 of file class.ilOnScreenChatGUI.php.

$frontend_initialized

bool ilOnScreenChatGUI::$frontend_initialized = false

staticprotected

Definition at line 35 of file class.ilOnScreenChatGUI.php.

$http

readonly ILIAS HTTP Services ilOnScreenChatGUI::$http

private

Definition at line 38 of file class.ilOnScreenChatGUI.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/OnScreenChat/classes/class.ilOnScreenChatGUI.php