ilChatroomViewTask Class Reference

Class ilChatroomViewTask. More...

Inheritance diagram for ilChatroomViewTask:

Collaboration diagram for ilChatroomViewTask:

Public Member Functions
	__construct (ilChatroomObjectGUI $gui)
	Constructor Sets $this->gui using given $gui. More...
	forcePublicRoom ()
	__construct (ilChatroomObjectGUI $gui)
	renderFileUploadForm (ilTemplate $roomTpl)
	Prepares Fileupload form and displays it. More...
Public Member Functions inherited from ilChatroomTaskHandler
	__construct (ilChatroomObjectGUI $gui)
	executeDefault ($requestedMethod)

Protected Member Functions
	writeClientSettingsToFile (array $settings)
	Writes client settings to client.properties file. More...
	getClientFileContent (array $settings)
	Formats content for client settings file. More...
	writeDataToFile (array $settings)
	Writes server settings to server.properties file. More...
	getFileContent (array $settings)
	Builds and formats content tot write in server.properties file. More...
	checkDirectory ()
	Checks if external chatroom directory exists or can be created. More...
	checkPrivHosts ($ipnumbers)
	Checks if a valid IP number or a comma-separated string of valid IP numbers is given. More...

Private Member Functions
	defaultActions ()
	cancelJoin ($message)
	Calls ilUtil::sendFailure method using given $message as parameter. More...

Private Attributes
	$gui
	$commonSettings

Detailed Description

Class ilChatroomViewTask.

Author

Jan Posselt jposs.nosp@m.elt@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version

$Id$

Definition at line 12 of file class.ilChatroomViewTask.php.

Constructor & Destructor Documentation

__construct() [1/2]

ilChatroomViewTask::__construct

(

ilChatroomObjectGUI

$gui

)

Constructor Sets $this->gui using given $gui.

Parameters

ilChatroomObjectGUI

$gui

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

References $gui, $ilCtrl, $lng, checkPrivHosts(), ilUtil\sendFailure(), ilUtil\sendInfo(), ilUtil\sendSuccess(), writeClientSettingsToFile(), and writeDataToFile().

        {
                $this->gui            = $gui;
                $this->commonSettings = new ilSetting('common');
        }

Here is the call graph for this function:

__construct() [2/2]

ilChatroomViewTask::__construct

(

ilChatroomObjectGUI

$gui

)

Parameters

ilChatroomObjectGUI

$gui

Definition at line 23 of file class.ilChatroomViewTask.php.

References $gui.

        {
                $this->gui = $gui;
        }

Member Function Documentation

cancelJoin()

ilChatroomViewTask::cancelJoin (   $message )

private

Calls ilUtil::sendFailure method using given $message as parameter.

Parameters

string

$message

Definition at line 32 of file class.ilChatroomViewTask.php.

References $_GET, $_REQUEST, $_SESSION, $failure, $ilCtrl, $ilUser, $lng, $query, $tpl, ilChatroomSmilies\_getSmilies(), ilChatroom\addHistoryEntry(), ilChatroom\byObjectId(), ilChatroom\checkUserPermissions(), ilChatroomTaskHandler\executeDefault(), exit, ilChatroom\getActivePrivateRooms(), ilChatroomUser\getChatNameSuggestions(), ilChatroom\getConnectedUsers(), ilChatroom\getLastMessages(), ilChatroom\getRoomId(), ilChatroom\getSetting(), ilChatroomUser\getUserId(), ilChatroomUser\getUsername(), ilChatroom\isAllowedToEnterPrivateRoom(), ilChatroom\isSubscribed(), ilChatroom\isUserBanned(), ilTemplate\parseCurrentBlock(), renderFileUploadForm(), ilUtil\sendFailure(), ilTemplate\setCurrentBlock(), ilChatroomUser\setUsername(), HTML_Template_IT\setVariable(), and ilChatroom\subscribeUserToPrivateRoom().

        {
                ilUtil::sendFailure($message);
        }

Here is the call graph for this function:

checkDirectory()

ilChatroomViewTask::checkDirectory ( )

protected

Checks if external chatroom directory exists or can be created.

Returns

string

Exceptions

Exception

Definition at line 244 of file class.ilChatroomViewTask.php.

References ilUtil\getDataDir(), and ilUtil\makeDir().

Referenced by writeClientSettingsToFile(), and writeDataToFile().

        {
                $srv_prp_path = ilUtil::getDataDir() . '/chatroom/';

                if(!file_exists($srv_prp_path))
                {
                        if(!ilUtil::makeDir($srv_prp_path))
                        {
                                throw new Exception('Directory cannot be created');
                        }
                }

                return $srv_prp_path;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

checkPrivHosts()

ilChatroomViewTask::checkPrivHosts (   $ipnumbers )

protected

Checks if a valid IP number or a comma-separated string of valid IP numbers is given.

Parameters

string

$ipnumbers

Returns

bool

Definition at line 266 of file class.ilChatroomViewTask.php.

References $data, $ilCtrl, $lng, $serverSettings, $tpl, ilUtil\_getHttpPath(), ilChatroomServerConnector\checkServerConnection(), ilChatroom\checkUserPermissions(), defaultActions(), ilChatroomTaskHandler\executeDefault(), and ilUtil\sendInfo().

Referenced by __construct().

        {
                $ipnumbers = preg_replace("/[^0-9.,]+/", "", $ipnumbers);
                $ips       = explode(',', $ipnumbers);

                foreach($ips as $ip)
                {
                        $ip_parts = explode('.', $ip);

                        if(!($ip_parts[0] <= 255 && $ip_parts[1] <= 255 && $ip_parts[2] <= 255 && $ip_parts[3] <= 255 &&
                                preg_match("!^([0-9]{1,3})\.([0-9]{1,3})\.([0-9]{1,3})\.([0-9]{1,3})$!", $ip))
                        )
                        {
                                return false;
                        }
                }

                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

defaultActions()

ilChatroomViewTask::defaultActions ( )

private

Definition at line 441 of file class.ilChatroomViewTask.php.

References forcePublicRoom().

Referenced by checkPrivHosts().

        {
                $chatSettings = new ilSetting('chatroom');
                if($chatSettings->get('chat_enabled', false))
                {
                        $this->forcePublicRoom();
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

forcePublicRoom()

ilChatroomViewTask::forcePublicRoom

(

)

Definition at line 453 of file class.ilChatroomViewTask.php.

References $lng, $ref_id, ilObjChatroom\_getPublicRefId(), ilObject\_hasUntrashedReference(), ilObject\_lookupObjId(), ilObjectFactory\getInstanceByRefId(), and ilUtil\sendSuccess().

Referenced by defaultActions().

        {
                $ref_id = ilObjChatroom::_getPublicRefId();
                if(!$ref_id)
                {
                        $this->createPublicRoom();
                        return;
                }

                $instance = ilObjectFactory::getInstanceByRefId($ref_id, false);
                if(!$instance)
                {
                        $this->createPublicRoom();
                        return;
                }

                $obj_id = ilObject::_lookupObjId($ref_id);
                if(!$obj_id)
                {
                        $this->createPublicRoom();
                        return;
                }

                if(!ilObject::_hasUntrashedReference($obj_id))
                {
                        $this->createPublicRoom();
                        return;
                }

                require_once 'Modules/Chatroom/classes/class.ilChatroomInstaller.php';
                ilChatroomInstaller::ensureCorrectPublicChatroomTreeLocation($ref_id);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getClientFileContent()

ilChatroomViewTask::getClientFileContent ( array  $settings )

protected

Formats content for client settings file.

Parameters

array

$settings

Returns

string

Definition at line 182 of file class.ilChatroomViewTask.php.

Referenced by writeClientSettingsToFile().

        {
                $linebreak = "\n";

                $content = 'hash = ' . $settings['hash'] . $linebreak;
                $content .= 'name = ' . $settings['name'] . $linebreak;
                $content .= 'url = ' . $settings['url'] . $linebreak;
                $content .= 'user = ' . $settings['user'] . $linebreak;
                $content .= 'password = ' . $settings['password'] . $linebreak;
                $content .= 'client = ' . $settings['client'];

                return $content;
        }

Here is the caller graph for this function:

getFileContent()

ilChatroomViewTask::getFileContent ( array  $settings )

protected

Builds and formats content tot write in server.properties file.

Parameters

array

$settings

Returns

string

Definition at line 221 of file class.ilChatroomViewTask.php.

References $https.

Referenced by writeDataToFile().

        {
                $linebreak = "\n";

                $content = 'host = ' . $settings['address'] . $linebreak;
                $content .= 'port = ' . $settings['port'] . $linebreak;
                $content .= 'privileged_hosts = ' . $settings['priv_hosts'] . $linebreak;

                $settings['protocol'] == 'https' ? $https = 1 : $https = 0;

                $content .= 'https = ' . $https . $linebreak;
                $content .= 'keystore = ' . $settings['keystore'] . $linebreak;
                $content .= 'keypass = ' . $settings['keypass'] . $linebreak;
                $content .= 'storepass = ' . $settings['storepass'];

                return $content;
        }

Here is the caller graph for this function:

renderFileUploadForm()

ilChatroomViewTask::renderFileUploadForm

(

ilTemplate

$roomTpl

)

Prepares Fileupload form and displays it.

Parameters

ilTemplate

$roomTpl

Definition at line 637 of file class.ilChatroomViewTask.php.

References $ilCtrl, $lng, ilUtil\sendFailure(), and HTML_Template_IT\setVariable().

Referenced by cancelJoin().

        {
                // @todo: Not implemented yet
                return;

                require_once 'Modules/Chatroom/classes/class.ilChatroomFormFactory.php';
                $formFactory = new ilChatroomFormFactory();
                $file_upload = $formFactory->getFileUploadForm();
                //$file_upload->setFormAction( $ilCtrl->getFormAction($this->gui, 'UploadFile-uploadFile') );
                $roomTpl->setVariable('FILE_UPLOAD', $file_upload->getHTML());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

writeClientSettingsToFile()

ilChatroomViewTask::writeClientSettingsToFile ( array  $settings )

protected

Writes client settings to client.properties file.

Parameters

array

$settings

Exceptions

Exception

Definition at line 162 of file class.ilChatroomViewTask.php.

References checkDirectory(), and getClientFileContent().

Referenced by __construct().

        {
                if($srv_prp_path = $this->checkDirectory())
                {
                        $handle = fopen($srv_prp_path . 'client.properties', 'w');

                        if(!fwrite($handle, $this->getClientFileContent($settings)))
                        {
                                throw new Exception('Cannot write to file');
                        }

                        fclose($handle);
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

writeDataToFile()

ilChatroomViewTask::writeDataToFile ( array  $settings )

protected

Writes server settings to server.properties file.

Parameters

array

$settings

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

References checkDirectory(), and getFileContent().

Referenced by __construct().

        {
                if($srv_prp_path = $this->checkDirectory())
                {
                        $handle = fopen($srv_prp_path . 'server.properties', 'w');

                        if(!fwrite($handle, $this->getFileContent($settings)))
                        {
                                throw new Exception('Cannot write to file');
                        }

                        fclose($handle);
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$commonSettings

ilChatroomViewTask::$commonSettings

private

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

$gui

ilChatroomViewTask::$gui

private

Definition at line 17 of file class.ilChatroomViewTask.php.

Referenced by __construct().

---

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

• Modules/Chatroom/classes/admintasks/class.ilChatroomViewTask.php