Collaboration diagram for ilOnScreenChatGUI:

Public Member Functions
	executeCommand ()

	verifyLogin ()
	Checks if a user is logged in. More...

	getUserList ()

	getUserProfileImages ()

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

Data Fields
const	WAC_TTL_TIME = 60

Static Protected Member Functions
static	isOnScreenChatAccessible (ilSetting $chatSettings)

static	getEmoticons (ilChatroomServerSettings $chatSettings)

static	loadServerSettings ()

Static Protected Attributes
static	$frontend_initialized = false

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 9 of file class.ilOnScreenChatGUI.php.

Member Function Documentation

◆ executeCommand()

ilOnScreenChatGUI::executeCommand ( )

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

        {
                global $DIC;
 
                $cmd = $DIC->ctrl()->getCmd();
 
                switch($cmd)
                {
                        case 'getUserProfileImages':
                                $this->getUserProfileImages();
                                break;
                        case 'verifyLogin':
                                $this->verifyLogin();
                                break;
                        case 'getUserlist':
                        default:
                                $this->getUserList();
                }
        }

References $cmd, $DIC, getUserList(), getUserProfileImages(), and verifyLogin().

Here is the call graph for this function:

◆ getEmoticons()

static ilOnScreenChatGUI::getEmoticons ( ilChatroomServerSettings $chatSettings )

staticprotected

Parameters

ilChatroomServerSettings $chatSettings

Returns: array

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

        {
                $smileys = array();
 
                if($chatSettings->getSmiliesEnabled())
                {
                        require_once 'Services/WebAccessChecker/classes/class.ilWACSignedPath.php';
                        require_once 'Modules/Chatroom/classes/class.ilChatroomSmilies.php';
 
                        ilWACSignedPath::setTokenMaxLifetimeInSeconds(self::WAC_TTL_TIME);
 
                        $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 = ilWACSignedPath::signFile($value);
                                        }
                                }
 
                                if(!$new_keys || !$new_val)
                                {
                                        continue;
                                }
 
                                foreach($new_keys as $new_key)
                                {
                                        $smileys[$new_key] = $new_val;
                                }
                        }
                }
 
                return $smileys;
        }

References ilChatroomServerSettings\getSmiliesEnabled(), ilWACSignedPath\setTokenMaxLifetimeInSeconds(), and ilWACSignedPath\signFile().

Here is the call graph for this function:

◆ getUserList()

ilOnScreenChatGUI::getUserList ( )

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

        {
                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;
        }

References $DIC, exit, ilUserAutoComplete\MAX_ENTRIES, and ilUserAutoComplete\PRIVACY_MODE_RESPECT_USER_SETTING.

Referenced by executeCommand().

Here is the caller graph for this function:

◆ getUserProfileImages()

ilOnScreenChatGUI::getUserProfileImages ( )

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

        {
                global $DIC;
 
                $response = array();
 
                if(!$DIC->user() || $DIC->user()->isAnonymous())
                {
                        echo json_encode($response);
                        exit();
                }
 
                if(!isset($_GET['usr_ids']) || strlen($_GET['usr_ids']) == 0)
                {
                        echo json_encode($response);
                        exit();
                }
 
                $DIC['lng']->loadLanguageModule('user');
                
                require_once 'Services/WebAccessChecker/classes/class.ilWACSignedPath.php';
                ilWACSignedPath::setTokenMaxLifetimeInSeconds(self::WAC_TTL_TIME);
 
                $user_ids = array_filter(array_map('intval', array_map('trim', explode(',', $_GET['usr_ids']))));
                require_once 'Services/User/classes/class.ilUserUtil.php';
                $public_data  = ilUserUtil::getNamePresentation($user_ids, true, false, '', false, true, false, true);
                $public_names = ilUserUtil::getNamePresentation($user_ids, false, false, '', false, true, false, false);
                
                foreach($user_ids as $usr_id)
                {
                        $public_image = isset($public_data[$usr_id]) && isset($public_data[$usr_id]['img']) ? $public_data[$usr_id]['img'] : '';
 
                        $public_name = '';
                        if(isset($public_names[$usr_id]))
                        {
                                $public_name = $public_names[$usr_id];
                                if('unknown' == $public_name && isset($public_data[$usr_id]) && isset($public_data[$usr_id]['login']))
                                {
                                        $public_name = $public_data[$usr_id]['login'];
                                }
                        }
 
                        $response[$usr_id] = array(
                                'public_name'   => $public_name,
                                'profile_image' => $public_image
                        );
                }
 
                require_once 'Services/Authentication/classes/class.ilSession.php';
                ilSession::enableWebAccessWithoutSession(true);
 
                echo json_encode($response);
                exit();
        }

References $_GET, $DIC, ilSession\enableWebAccessWithoutSession(), exit, ilUserUtil\getNamePresentation(), and ilWACSignedPath\setTokenMaxLifetimeInSeconds().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initializeFrontend()

static ilOnScreenChatGUI::initializeFrontend ( )

static

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

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

        {
                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');
                        
                        $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')));
 
                        $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', 'getUserProfileImages', '', true, false),
                                'verifyLoginURL'     => $DIC->ctrl()->getLinkTargetByClass('ilonscreenchatgui', 'verifyLogin', '', true, false),
                                'loaderImg'          => ilUtil::getImagePath('loader.svg'),
                                'emoticons'          => self::getEmoticons($settings),
                                'locale'             => $DIC->language()->getLangKey()
                        );
 
                        $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'
                        ));
 
                        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('./Services/jQuery/js/jquery.outside.events.min.js');
                        $DIC['tpl']->addJavaScript('./Services/jQuery/js/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(".ilJsonUtil::encode($chatConfig).");");
                        $DIC['tpl']->addOnLoadCode("il.OnScreenChat.setConfig(".ilJsonUtil::encode($guiConfig).");");
                        $DIC['tpl']->addOnLoadCode("il.OnScreenChat.init();");
 
                        self::$frontend_initialized = true;
                }
        }

References $DIC, ilJsonUtil\encode(), ilUtil\getImagePath(), ilUtil\img(), iljQueryUtil\initjQuery(), iljQueryUtil\initjQueryUI(), ilLinkifyUtil\initLinkify(), and loadServerSettings().

Referenced by ilMainMenuGUI\populateWithOnScreenChat().

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 24 of file class.ilOnScreenChatGUI.php.

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

References $DIC, and ilSetting\get().

Here is the call graph for this function:

◆ loadServerSettings()

static ilOnScreenChatGUI::loadServerSettings ( )

staticprotected

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

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

Referenced by initializeFrontend().

Here is the caller graph for this function:

◆ verifyLogin()

ilOnScreenChatGUI::verifyLogin ( )

Checks if a user is logged in.

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

Returns: bool

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

        {
                global $DIC;
 
                require_once 'Services/Authentication/classes/class.ilSession.php';
                ilSession::enableWebAccessWithoutSession(true);
 
                echo json_encode(array(
                        'loggedIn' => $DIC->user() && !$DIC->user()->isAnonymous()
                ));
                exit;
        }