ilOnScreenChatGUI Class Reference

Class ilOnScreenChatGUI. More...

Collaboration diagram for ilOnScreenChatGUI:

Public Member Functions
	__construct ()
	ilOnScreenChatGUI constructor. More...
	executeCommand ()

Static Public Member Functions
static	initializeFrontend (ilGlobalTemplateInterface $page)
	Initialize frontend and delivers required javascript files and configuration to the global template. More...

Static Protected Member Functions
static	isOnScreenChatAccessible (ilSetting $chatSettings)
static	getEmoticons (ilChatroomServerSettings $chatSettings)

Static Protected Attributes
static	$frontend_initialized = false

Private Member Functions
	getResponseWithText (string $body)
	verifyLogin ()
	Checks if a user is logged in. More...
	getUserList ()
	getUserProfileData ()

Private Attributes
	$dic
	$http
	$ctrl
	$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 16 of file class.ilOnScreenChatGUI.php.

Constructor & Destructor Documentation

__construct()

ilOnScreenChatGUI::__construct

(

)

ilOnScreenChatGUI constructor.

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

References $DIC, 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 105 of file class.ilOnScreenChatGUI.php.

References $response, exit, getResponseWithText(), getUserList(), getUserProfileData(), ILIAS\FileDelivery\http(), and verifyLogin().

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

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

            case 'getRenderedNotificationItems':
                $provider = new OnScreenChatNotificationProvider(
                    $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 'getUserlist':
            default:
                $response = $this->getUserList();
        }

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

Here is the call graph for this function:

getEmoticons()

static ilOnScreenChatGUI::getEmoticons ( ilChatroomServerSettings  $chatSettings )

staticprotected

Parameters

ilChatroomServerSettings

$chatSettings

Returns

array

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

References ilChatroomServerSettings\getSmiliesEnabled().

                                                                                   : array
    {
        $smileys = array();

        if ($chatSettings->getSmiliesEnabled()) {
            require_once 'Modules/Chatroom/classes/class.ilChatroomSmilies.php';
            ;

            $smileys_array = ilChatroomSmilies::_getSmilies();
            foreach ($smileys_array as $smiley_array) {
                $new_keys = array();
                $new_val = '';
                foreach ($smiley_array as $key => $value) {
                    if ($key == 'smiley_keywords') {
                        $new_keys = explode("\n", $value);
                    }

                    if ($key == 'smiley_fullpath') {
                        $new_val = $value;
                    }
                }

                if (!$new_keys || !$new_val) {
                    continue;
                }

                foreach ($new_keys as $new_key) {
                    $smileys[$new_key] = $new_val;
                }
            }
        }

        return $smileys;
    }

Here is the call graph for this function:

getResponseWithText()

ilOnScreenChatGUI::getResponseWithText ( string  $body )

private

Parameters

string

$body

Returns

ResponseInterface

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

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

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

Here is the caller graph for this function:

getUserList()

ilOnScreenChatGUI::getUserList ( )

private

Returns

ResponseInterface

Definition at line 164 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([]));
        }

        $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

Returns

ResponseInterface

Exceptions

ilWACException

Definition at line 188 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([]));
        }

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

        $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));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initializeFrontend()

static ilOnScreenChatGUI::initializeFrontend ( ilGlobalTemplateInterface  $page )

static

Initialize frontend and delivers required javascript files and configuration to the global template.

Parameters

ilGlobalTemplateInterface

$page

Exceptions

ilTemplateException
ilWACException

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

References $DIC, $factory, ilGlobalTemplateInterface\addJavaScript(), ilGlobalTemplateInterface\addOnLoadCode(), ilUtil\getImagePath(), ilUtil\img(), iljQueryUtil\initjQuery(), iljQueryUtil\initjQueryUI(), ilLinkifyUtil\initLinkify(), ilChatroomServerSettings\loadDefault(), 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, 'Services/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('CLOSE_ACTION', $renderer->render(
                $factory->button()->close()
            ));
            $chatWindowTemplate->setVariable('CONVERSATION_ICON', ilUtil::img(ilUtil::getImagePath('outlined/icon_pcht.svg')));

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

            $guiConfig = array(
                'chatWindowTemplate' => $chatWindowTemplate->get(),
                'messageTemplate' => (new ilTemplate(
                    'tpl.chat-message.html',
                    false,
                    false,
                    'Services/OnScreenChat'
                ))->get(),
                'modalTemplate' => (new ilTemplate(
                    'tpl.chat-add-user.html',
                    false,
                    false,
                    'Services/OnScreenChat'
                ))->get(),
                'userId' => $DIC->user()->getId(),
                'username' => $DIC->user()->getLogin(),
                'userListURL' => $DIC->ctrl()->getLinkTargetByClass(
                    'ilonscreenchatgui',
                    'getUserList',
                    '',
                    true,
                    false
                ),
                'userProfileDataURL' => $DIC->ctrl()->getLinkTargetByClass(
                    'ilonscreenchatgui',
                    'getUserProfileData',
                    '',
                    true,
                    false
                ),
                'verifyLoginURL' => $DIC->ctrl()->getLinkTargetByClass(
                    'ilonscreenchatgui',
                    'verifyLogin',
                    '',
                    true,
                    false
                ),
                'renderNotificationItemsURL' => $DIC->ctrl()->getLinkTargetByClass(
                    'ilonscreenchatgui',
                    'getRenderedNotificationItems',
                    '',
                    true,
                    false
                ),
                'loaderImg' => ilUtil::getImagePath('loader.svg'),
                'emoticons' => self::getEmoticons($settings),
                'locale' => $DIC->language()->getLangKey(),
                'initialUserData' => $subscriberRepo->getInitialUserProfileData(),
                'enabledBrowserNotifications' => (
                    $clientSettings->get('enable_browser_notifications', false) &&
                    (bool) ilUtil::yn2tf($DIC->user()->getPref('chat_osc_browser_notifications'))
                ),
                'notificationIconPath' => \ilUtil::getImagePath('icon_chta.png'),
            );

            $chatConfig = array(
                '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_emoticons',
                'chat_osc_write_a_msg',
                'autocomplete_more',
                'close',
                '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',
                'today',
                'yesterday',
            ], $page);

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

            $page->addJavaScript('./libs/bower/bower_components/jquery-outside-events/jquery.ba-outside-events.min.js');
            $page->addJavaScript('./libs/bower/bower_components/jqueryui-touch-punch/jquery.ui.touch-punch.min.js');
            $page->addJavascript('./Services/UIComponent/Modal/js/Modal.js');
            $page->addJavascript('./libs/bower/bower_components/moment/min/moment-with-locales.min.js');
            $page->addJavascript('./Services/Notifications/js/browser_notifications.js');
            $page->addJavascript('./Services/OnScreenChat/js/onscreenchat-notifications.js');
            $page->addJavascript('./Services/OnScreenChat/js/moment.js');
            $page->addJavascript('./Modules/Chatroom/chat/node_modules/socket.io-client/dist/socket.io.js');
            $page->addJavascript('./Services/OnScreenChat/js/chat.js');
            $page->addJavascript('./Services/OnScreenChat/js/onscreenchat.js');
            $page->addOnLoadCode("il.Chat.setConfig(" . json_encode($chatConfig) . ");");
            $page->addOnLoadCode("il.OnScreenChat.setConfig(" . json_encode($guiConfig) . ");");
            $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'),
            ]) . ');');

            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

Parameters

ilSetting

$chatSettings

Returns

bool

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

References $DIC, and ilSetting\get().

                                                                                : bool
    {
        global $DIC;

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

Here is the call graph for this function:

verifyLogin()

ilOnScreenChatGUI::verifyLogin ( )

private

Checks if a user is logged in.

If not, this function should cause an redirect, to disallow chatting while not logged into ILIAS.

Returns

ResponseInterface

Definition at line 152 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()
        ]));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$actor

ilOnScreenChatGUI::$actor

private

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

$ctrl

ilOnScreenChatGUI::$ctrl

private

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

$dic

ilOnScreenChatGUI::$dic

private

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

$frontend_initialized

ilOnScreenChatGUI::$frontend_initialized = false

staticprotected

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

$http

ilOnScreenChatGUI::$http

private

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

---

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

• Services/OnScreenChat/classes/class.ilOnScreenChatGUI.php