class.ilChatroomFormFactory.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';

class ilChatroomFormFactory
{
        public function __construct()
        {
        }

        public static function applyValues(ilPropertyFormGUI $form, array $values)
        {
                foreach($values as $key => $value)
                {
                        $field = $form->getItemByPostVar($key);
                        if(!$field)
                        {
                                continue;
                        }

                        switch(strtolower(get_class($field)))
                        {
                                case 'ilcheckboxinputgui':
                                        if($value)
                                        {
                                                $field->setChecked(true);
                                        }
                                        break;

                                default:
                                        $field->setValue($value);
                        }
                }
        }

        public function getCreationForm()
        {
                global $lng;

                $form  = new ilPropertyFormGUI();
                $title = new ilTextInputGUI($lng->txt('title'), 'title');
                $title->setRequired(true);
                $form->addItem($title);

                $description = new ilTextAreaInputGUI($lng->txt('description'), 'desc');
                $form->addItem($description);

                return $this->addDefaultBehaviour($form);
        }

        private function addDefaultBehaviour(ilPropertyFormGUI $form)
        {
                global $lng;

                $form->addCommandButton('create-save', $lng->txt('create'));
                $form->addCommandButton('cancel', $lng->txt('cancel'));

                return $form;
        }

        public function getSettingsForm()
        {
                global $lng;

                $form  = new ilPropertyFormGUI();
                $title = new ilTextInputGUI($lng->txt('title'), 'title');
                $title->setRequired(true);
                $form->addItem($title);

                $description = new ilTextAreaInputGUI($lng->txt('description'), 'desc');
                $form->addItem($description);

                $cb = new ilCheckboxInputGUI($lng->txt('allow_anonymous'), 'allow_anonymous');
                $cb->setInfo($lng->txt('anonymous_hint'));

                $txt = new ilTextInputGUI($lng->txt('autogen_usernames'), 'autogen_usernames');
                $txt->setRequired(true);
                $txt->setInfo($lng->txt('autogen_usernames_info'));
                $cb->addSubItem($txt);
                $form->addItem($cb);

                $cb = new ilCheckboxInputGUI($lng->txt('allow_custom_usernames'), 'allow_custom_usernames');
                $form->addItem($cb);

                $cb_history = new ilCheckboxInputGUI($lng->txt('enable_history'), 'enable_history');
                $form->addItem($cb_history);

                $num_msg_history = new ilNumberInputGUI($lng->txt('display_past_msgs'), 'display_past_msgs');
                $num_msg_history->setInfo($lng->txt('hint_display_past_msgs'));
                $num_msg_history->setMinValue(0);
                $num_msg_history->setMaxValue(100);
                $form->addItem($num_msg_history);

                $cb = new ilCheckboxInputGUI($lng->txt('private_rooms_enabled'), 'private_rooms_enabled');
                $cb->setInfo($lng->txt('private_rooms_enabled_info'));
                $form->addItem($cb);

                return $form;
        }

        public function getFileUploadForm()
        {
                global $lng;

                $form       = new ilPropertyFormGUI();
                $file_input = new ilFileInputGUI();

                $file_input->setPostVar('file_to_upload');
                $file_input->setTitle($lng->txt('upload'));
                $form->addItem($file_input);
                $form->addCommandButton('UploadFile-uploadFile', $lng->txt('submit'));

                $form->setTarget('_blank');

                return $form;
        }

        public function getPeriodForm()
        {
                global $lng;

                $form = new ilPropertyFormGUI();
                $form->setPreventDoubleSubmission(false);

                require_once 'Services/Form/classes/class.ilDateDurationInputGUI.php';
                $duration = new ilDateDurationInputGUI($lng->txt('period'), 'timeperiod');

                $duration->setStartText($lng->txt('duration_from'));
                $duration->setEndText($lng->txt('duration_to'));
                $duration->setShowTime(true);
                $duration->setRequired(true);
                $form->addItem($duration);

                return $form;
        }

        public function getUserChatNameSelectionForm(array $name_options)
        {
                global $lng, $ilUser;

                $form = new ilPropertyFormGUI();

                $radio = new ilRadioGroupInputGUI($lng->txt('select_custom_username'), 'custom_username_radio');

                foreach($name_options as $key => $option)
                {
                        $opt = new ilRadioOption($option, $key);
                        $radio->addOption($opt);
                }

                $custom_opt = new ilRadioOption($lng->txt('custom_username'), 'custom_username');
                $radio->addOption($custom_opt);

                $txt = new ilTextInputGUI($lng->txt('custom_username'), 'custom_username_text');
                $custom_opt->addSubItem($txt);
                $form->addItem($radio);

                if($ilUser->isAnonymous())
                {
                        $radio->setValue('anonymousName');
                }
                else
                {
                        $radio->setValue('fullname');
                }

                return $form;
        }

        public function getSessionForm(array $sessions)
        {
                global $lng;

                $form = new ilPropertyFormGUI();
                $form->setPreventDoubleSubmission(false);
                $list = new ilSelectInputGUI($lng->txt('session'), 'session');

                $options = array();

                foreach($sessions as $session)
                {
                        $start = new ilDateTime($session['connected'], IL_CAL_UNIX);
                        $end   = new ilDateTime($session['disconnected'], IL_CAL_UNIX);

                        $options[$session['connected'] . ',' .
                        $session['disconnected']] = ilDatePresentation::formatPeriod($start, $end);
                }

                $list->setOptions($options);
                $list->setRequired(true);

                $form->addItem($list);

                return $form;
        }

        public function getGeneralSettingsForm()
        {
                global $lng;

                $form = new ilPropertyFormGUI();

                $address = new ilTextInputGUI($lng->txt('chatserver_address'), 'address');
                $address->setRequired(true);
                $form->addItem($address);

                $port = new ilNumberInputGUI($lng->txt('chatserver_port'), 'port');
                $port->setMinValue(1);
                $port->setMaxValue(65535);
                $port->setRequired(true);
                $port->setInfo($lng->txt('port_info'));
                $port->setSize(6);
                $form->addItem($port);

                $subDirectory = new ilTextInputGUI($lng->txt('chat_osc_no_sub_directory'), 'sub_directory');
                $subDirectory->setRequired(false);
                $subDirectory->setInfo($lng->txt('chat_osc_no_sub_directory_info'));
                $form->addItem($subDirectory);

                $protocol = new ilRadioGroupInputGUI($lng->txt('protocol'), 'protocol');
                $form->addItem($protocol);

                $http = new ilRadioOption($lng->txt('http'), 'http');
                $protocol->addOption($http);

                $https = new ilRadioOption($lng->txt('https'), 'https');
                $protocol->addOption($https);

                $certificate = new ilTextInputGUI($lng->txt('certificate'), 'cert');
                $certificate->setInfo($lng->txt('chat_https_cert_info'));
                $certificate->setRequired(true);
                $https->addSubItem($certificate);

                $key = new ilTextInputGUI($lng->txt('key'), 'key');
                $key->setInfo($lng->txt('chat_https_key_info'));
                $key->setRequired(true);
                $https->addSubItem($key);

                $dhparam = new ilTextInputGUI($lng->txt('dhparam'), 'dhparam');
                $dhparam->setInfo($lng->txt('chat_https_dhparam_info'));
                $dhparam->setRequired(true);
                $https->addSubItem($dhparam);

                $chatLog = new ilTextInputGUI($lng->txt('log'), 'log');
                $chatLog->setInfo($lng->txt('chat_log_info'));
                $chatLog->setRequired(false);
                $form->addItem($chatLog);

                $chatErrorLog = new ilTextInputGUI($lng->txt('error_log'), 'error_log');
                $chatErrorLog->setInfo($lng->txt('chat_error_log_info'));
                $chatErrorLog->setRequired(false);
                $form->addItem($chatErrorLog);

                $iliasSection = new ilFormSectionHeaderGUI();
                $iliasSection->setTitle($lng->txt('ilias_chatserver_connection'));
                $form->addItem($iliasSection);

                $iliasProxy = new ilCheckboxInputGUI($lng->txt('proxy'), 'ilias_proxy');
                $iliasProxy->setRequired(false);
                $iliasProxy->setInfo($lng->txt('ilias_proxy_info'));
                $form->addItem($iliasProxy);

                $chatServerILIASUrl = new ilTextInputGUI($lng->txt('url'), 'ilias_url');
                $chatServerILIASUrl->setRequired(true);
                $chatServerILIASUrl->setInfo($lng->txt('connection_url_info'));
                $iliasProxy->addSubItem($chatServerILIASUrl);

                $clientSection = new ilFormSectionHeaderGUI();
                $clientSection->setTitle($lng->txt('client_chatserver_connection'));
                $form->addItem($clientSection);

                $clientProxy = new ilCheckboxInputGUI($lng->txt('proxy'), 'client_proxy');
                $clientProxy->setRequired(false);
                $clientProxy->setInfo($lng->txt('client_proxy_info'));
                $form->addItem($clientProxy);

                $chatServerClientUrl = new ilTextInputGUI($lng->txt('url'), 'client_url');
                $chatServerClientUrl->setRequired(true);
                $chatServerClientUrl->setInfo($lng->txt('connection_url_info'));
                $clientProxy->addSubItem($chatServerClientUrl);
                
                $deletion_section = new ilFormSectionHeaderGUI();
                $deletion_section->setTitle($lng->txt('chat_deletion_section_head'));
                $form->addItem($deletion_section);

                $deletion_options = new ilRadioGroupInputGUI($lng->txt('chat_deletion_section_head'), 'deletion_mode');

                $deletion_mode_deactivated = new ilRadioOption($lng->txt('chat_deletion_disabled'), 0);
                $deletion_options->addOption($deletion_mode_deactivated);

                $chat_deletion_interval = new ilRadioOption($lng->txt('chat_deletion_interval'), 1);
                $chat_deletion_interval->setInfo($lng->txt('chat_deletion_interval_info'));
                $interval_unit = new ilSelectInputGUI($lng->txt('chat_deletion_interval_unit'), 'deletion_unit');
                $interval_unit->setRequired(true);
                $interval_unit->setOptions(array(
                        'days'  => $lng->txt('days'),
                        'weeks' => $lng->txt('weeks'),
                        'month' => $lng->txt('months'),
                        'years' => $lng->txt('years'),
                ));
                $chat_deletion_interval->addSubItem($interval_unit);

                require_once 'Modules/Chatroom/classes/form/class.ilChatroomMessageDeletionThresholdInputGUI.php';
                $interval_value = new ilChatroomMessageDeletionThresholdInputGUI($lng->txt('chat_deletion_interval_value'), 'deletion_value', $interval_unit);
                $interval_value->allowDecimals(false);
                $interval_value->setMinValue(1);
                $interval_value->setRequired(true);
                $chat_deletion_interval->addSubItem($interval_value);

                $runAtTime = new ilTextInputGUI($lng->txt('chat_deletion_interval_run_at'), 'deletion_time');
                $runAtTime->setInfo($lng->txt('chat_deletion_interval_run_at_info'));
                $runAtTime->setRequired(true);
                $runAtTime->setValidationRegexp('/([01][0-9]|[2][0-3]):[0-5][0-9]/');
                $chat_deletion_interval->addSubItem($runAtTime);

                $deletion_options->addOption($chat_deletion_interval);

                $form->addItem($deletion_options);

                return $form;
        }

        public function getClientSettingsForm()
        {
                global $lng;

                $form = new ilPropertyFormGUI();

                $enable_chat = new ilCheckboxInputGUI($lng->txt('chat_enabled'), 'chat_enabled');
                $form->addItem($enable_chat);

                $enable_osc = new ilCheckboxInputGUI($lng->txt('chatroom_enable_osc'), 'enable_osc');
                $enable_osc->setInfo($lng->txt('chatroom_enable_osc_info'));
                $enable_chat->addSubItem($enable_osc);

                $osd = new ilCheckboxInputGUI($lng->txt('enable_osd'), 'enable_osd');
                $osd->setInfo($lng->txt('hint_osd'));
                $enable_chat->addSubItem($osd);

                $interval = new ilNumberInputGUI($lng->txt('osd_intervall'), 'osd_intervall');
                $interval->setMinValue(1);
                $interval->setRequired(true);
                $interval->setInfo($lng->txt('hint_osd_interval'));
                $osd->addSubItem($interval);

                $play_sound = new ilCheckboxInputGUI($lng->txt('play_invitation_sound'), 'play_invitation_sound');
                $play_sound->setInfo($lng->txt('play_invitation_sound'));
                $osd->addSubItem($play_sound);

                $enable_smilies = new ilCheckboxInputGUI($lng->txt('enable_smilies'), 'enable_smilies');
                $enable_smilies->setInfo($lng->txt('hint_enable_smilies'));
                $enable_chat->addSubItem($enable_smilies);

                $name = new \ilTextInputGUI($lng->txt('chatroom_client_name'), 'client_name');
                $name->setInfo($lng->txt('chatroom_client_name_info'));
                $name->setRequired(true);
                $name->setMaxLength(100);
                $enable_chat->addSubItem($name);

                require_once 'Modules/Chatroom/classes/class.ilChatroomAuthInputGUI.php';
                $auth = new ilChatroomAuthInputGUI($lng->txt('chatroom_auth'), 'auth');
                $auth->setInfo($lng->txt('chat_auth_token_info'));
                $auth->setCtrlPath(array('iladministrationgui', 'ilobjchatroomgui', 'ilpropertyformgui', 'ilformpropertydispatchgui', 'ilchatroomauthinputgui'));
                $auth->setRequired(true);
                $enable_chat->addSubItem($auth);

                return $form;
        }
}