class.ilOnScreenChatGUI.php

Go to the documentation of this file.

<?php

class ilOnScreenChatGUI
{
    protected static $frontend_initialized = false;

    protected static function isOnScreenChatAccessible(ilSetting $chatSettings)
    {
        global $DIC;

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

    protected static function getEmoticons(ilChatroomServerSettings $chatSettings)
    {
        $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;
    }

    public function executeCommand()
    {
        global $DIC;

        $cmd = $DIC->ctrl()->getCmd();

        switch ($cmd) {
            case 'getUserProfileData':
                $this->getUserProfileData();
                break;
            case 'verifyLogin':
                $this->verifyLogin();
                break;
            case 'getUserlist':
            default:
                $this->getUserList();
        }
    }

    public function verifyLogin()
    {
        global $DIC;

        require_once 'Services/Authentication/classes/class.ilSession.php';
        ilSession::enableWebAccessWithoutSession(true);

        echo json_encode(array(
            'loggedIn' => $DIC->user() && !$DIC->user()->isAnonymous()
        ));
        exit;
    }

    public function getUserList()
    {
        global $DIC;

        if (!$DIC->user() || $DIC->user()->isAnonymous()) {
            return;
        }

        require_once 'Services/OnScreenChat/classes/class.ilOnScreenChatUserUserAutoComplete.php';
        $auto = new ilOnScreenChatUserUserAutoComplete();
        $auto->setUser($DIC->user());
        $auto->setPrivacyMode(ilUserAutoComplete::PRIVACY_MODE_RESPECT_USER_SETTING);
        if (($_REQUEST['fetchall'])) {
            $auto->setLimit(ilUserAutoComplete::MAX_ENTRIES);
        }
        $auto->setMoreLinkAvailable(true);
        $auto->setSearchFields(array('firstname', 'lastname'));
        $auto->setResultField('login');
        $auto->enableFieldSearchableCheck(true);
        echo $auto->getList($_REQUEST['term']);
        exit;
    }

    public function getUserProfileData()
    {
        global $DIC;

        if (!$DIC->user() || $DIC->user()->isAnonymous()) {
            echo json_encode([]);
            exit();
        }

        if (!isset($_GET['usr_ids']) || strlen($_GET['usr_ids']) == 0) {
            echo json_encode([]);
            exit();
        }

        $DIC['lng']->loadLanguageModule('user');

        $userProvider = new \ilOnScreenChatUserDataProvider($DIC->database(), $DIC->user());
        $data         = $userProvider->getDataByUserIds(explode(',', $_GET['usr_ids']));

        require_once 'Services/Authentication/classes/class.ilSession.php';
        ilSession::enableWebAccessWithoutSession(true);

        echo json_encode($data);
        exit();
    }

    public static function initializeFrontend()
    {
        global $DIC;

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

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

            require_once 'Services/JSON/classes/class.ilJsonUtil.php';

            $settings = self::loadServerSettings();

            $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->glyph()->add('addUser')
            ));
            $chatWindowTemplate->setVariable('CLOSE_ACTION', $renderer ->render(
                $factory->button()->close()
            ));
            $chatWindowTemplate->setVariable('CONVERSATION_ICON', ilUtil::img(ilUtil::getImagePath('icon_chta.svg')));

            $userProvider = new \ilOnScreenChatUserDataProvider($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),
                'loaderImg'          => ilUtil::getImagePath('loader.svg'),
                'emoticons'          => self::getEmoticons($settings),
                'locale'             => $DIC->language()->getLangKey(),
                'initialUserData'    => $userProvider->getInitialUserProfileData(),
            );

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

            $DIC->language()->toJS(array(
                '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'
            ));

            require_once 'Services/jQuery/classes/class.iljQueryUtil.php';
            iljQueryUtil::initjQuery();
            iljQueryUtil::initjQueryUI();

            require_once 'Services/Link/classes/class.ilLinkifyUtil.php';
            ilLinkifyUtil::initLinkify();

            $DIC['tpl']->addJavaScript('./libs/bower/bower_components/jquery-outside-events/jquery.ba-outside-events.min.js');
            $DIC['tpl']->addJavaScript('./libs/bower/bower_components/jqueryui-touch-punch/jquery.ui.touch-punch.min.js');
            $DIC['tpl']->addJavascript('./Services/UIComponent/Modal/js/Modal.js');
            $DIC['tpl']->addJavascript('./libs/composer/components/moment/min/moment-with-locales.js');
            $DIC['tpl']->addJavascript('./Services/OnScreenChat/js/moment.js');
            $DIC['tpl']->addJavascript('./Modules/Chatroom/chat/node_modules/socket.io/node_modules/socket.io-client/socket.io.js');
            $DIC['tpl']->addJavascript('./Services/OnScreenChat/js/chat.js');
            $DIC['tpl']->addJavascript('./Services/OnScreenChat/js/onscreenchat.js');
            $DIC['tpl']->addOnLoadCode("il.Chat.setConfig(" . json_encode($chatConfig) . ");");
            $DIC['tpl']->addOnLoadCode("il.OnScreenChat.setConfig(" . json_encode($guiConfig) . ");");
            $DIC['tpl']->addOnLoadCode("il.OnScreenChat.init();");

            self::$frontend_initialized = true;
        }
    }

    protected static function loadServerSettings()
    {
        require_once './Modules/Chatroom/classes/class.ilChatroomServerSettings.php';
        return ilChatroomServerSettings::loadDefault();
    }
}