class.ilChatroomAdminViewGUI.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
class ilChatroomAdminViewGUI extends ilChatroomGUIHandler
{
    private const string CHATROOM_README_PATH = __DIR__ . '/../../README.md';
 
    protected ilSetting $commonSettings;
 
    public function __construct(ilChatroomObjectGUI $gui)
    {
        parent::__construct($gui);
        $this->commonSettings = new ilSetting('common');
    }
 
    public function executeDefault(string $requestedMethod): void
    {
        $this->ilCtrl->redirect($this->gui, 'view-clientsettings');
    }
 
    private function defaultActions(): void
    {
        $chatSettings = new ilSetting('chatroom');
        if ($chatSettings->get('chat_enabled', '0')) {
            $this->forcePublicRoom();
        }
    }
 
    public function forcePublicRoom(): void
    {
        $ref_id = ilObjChatroom::_getPublicRefId();
        if (!$ref_id) {
            $this->createPublicRoom();
            return;
        }
 
        $instance = ilObjectFactory::getInstanceByRefId($ref_id, false);
        if (!($instance instanceof ilObjChatroom)) {
            $this->createPublicRoom();
            return;
        }
 
        $obj_id = ilObject::_lookupObjId($ref_id);
        if (!$obj_id) {
            $this->createPublicRoom();
            return;
        }
 
        if (!ilObject::_hasUntrashedReference($obj_id)) {
            $this->createPublicRoom();
            return;
        }
 
        ilChatroomInstaller::ensureCorrectPublicChatroomTreeLocation($ref_id);
    }
 
    public function createPublicRoom(): void
    {
        ilChatroomInstaller::createDefaultPublicRoom(true);
        $this->mainTpl->setOnScreenMessage('success', $this->ilLng->txt('public_chat_created'), true);
    }
 
    protected function checkServerConnection(array $serverSettings): void
    {
        if (
            isset($serverSettings['port'], $serverSettings['address']) &&
            !ilChatroomServerConnector::checkServerConnection(false)
        ) {
            $this->mainTpl->setOnScreenMessage('info', $this->ilLng->txt('chat_cannot_connect_to_server'));
        }
    }
 
    public function saveClientSettings(): void
    {
        $this->redirectIfNoPermission('write');
 
        $factory = new ilChatroomFormFactory();
        $form = $factory->getClientSettingsForm();
 
        if (!$form->checkInput()) {
            $form->setValuesByPost();
            $this->clientsettings($form);
            return;
        }
 
        $convIdleStateTime = max(1, (int) $form->getInput('conversation_idle_state_in_minutes'));
 
        $settings = [
            'name' => (string) $form->getInput('client_name'),
            'enable_osc' => (bool) $form->getInput('enable_osc'),
            'enable_browser_notifications' => (bool) $form->getInput('enable_browser_notifications'),
            'conversation_idle_state_in_minutes' => $convIdleStateTime,
            'chat_enabled' => (bool) $form->getInput('chat_enabled'),
            'auth' => $form->getInput('auth')
        ];
 
        if (!$settings['chat_enabled']) {
            $settings['enable_osc'] = false;
        }
 
        $chatSettings = new ilSetting('chatroom');
        $chatSettings->set('chat_enabled', (string) $settings['chat_enabled']);
        $chatSettings->set('enable_browser_notifications', (string) $settings['enable_browser_notifications']);
        $chatSettings->set('conversation_idle_state_in_minutes', (string) $convIdleStateTime);
        $chatSettings->set('enable_osc', (string) $settings['enable_osc']);
 
        $adminSettings = new ilChatroomAdmin($this->gui->getObject()->getId());
        $adminSettings->saveClientSettings((object) $settings);
 
        $osc_accept_msg = $form->getInput('chat_osc_accept_msg');
        $broadcast_typing = $form->getInput('chat_broadcast_typing');
        if (in_array($osc_accept_msg, ['n', 'y'], true)) {
            $this->commonSettings->set('chat_osc_accept_msg', $osc_accept_msg);
        }
 
        if (in_array($broadcast_typing, ['n', 'y'], true)) {
            $this->commonSettings->set('chat_broadcast_typing', $broadcast_typing);
        }
 
        $fileHandler = new ilChatroomConfigFileHandler();
        $fileHandler->createClientConfigFile($settings);
 
        $this->mainTpl->setOnScreenMessage('success', $this->ilLng->txt('settings_has_been_saved'), true);
        $this->ilCtrl->redirect($this->gui, 'view-clientsettings');
    }
 
    public function deliverDocumentation(): never
    {
        $this->redirectIfNoPermission(['visible','read']);
 
        $this->file_delivery->delivery()->inline(
            ILIAS\Filesystem\Stream\Streams::ofResource(
                fopen(self::CHATROOM_README_PATH, 'rb')
            ),
            basename(self::CHATROOM_README_PATH),
            'text/markdown'
        );
    }
 
    public function clientsettings(?ilPropertyFormGUI $form = null): void
    {
        $this->redirectIfNoPermission(['visible','read']);
 
        $this->defaultActions();
        $this->gui->switchToVisibleMode();
 
        $adminSettings = new ilChatroomAdmin($this->gui->getObject()->getId());
        $serverSettings = $adminSettings->loadGeneralSettings();
 
        if ($form === null) {
            $clientSettings = array_map(
                static fn($value) => is_int($value) ? (string) $value : $value,
                $adminSettings->loadClientSettings()
            );
            $clientSettings['chat_osc_accept_msg'] = $this->commonSettings->get('chat_osc_accept_msg', 'n');
            $clientSettings['chat_broadcast_typing'] = $this->commonSettings->get('chat_broadcast_typing', 'n');
            $factory = new ilChatroomFormFactory();
            $form = $factory->getClientSettingsForm();
            $form->setValuesByArray($clientSettings);
        }
 
        $this->checkServerConnection($serverSettings);
 
        $form->setTitle($this->ilLng->txt('general_settings_title'));
        if (ilChatroom::checkUserPermissions('write', $this->gui->getRefId(), false)) {
            $form->addCommandButton('view-saveClientSettings', $this->ilLng->txt('save'));
        } else {
            $item = $form->getItemByPostVar('auth');
            $item->setIsReadOnly(true);
        }
        $form->setFormAction($this->ilCtrl->getFormAction($this->gui, 'view-saveClientSettings'));
 
        $this->mainTpl->setContent($this->uiRenderer->render([
            $this->uiFactory->messageBox()->info(
                $this->ilLng->txt('server_further_information')
            )->withLinks([
                $this->uiFactory->link()->standard(
                    $this->ilLng->txt('server_readme_file_btn_label'),
                    $this->ilCtrl->getLinkTarget($this->gui, 'view-deliverDocumentation')
                )->withOpenInNewViewport(true)
            ]),
            $this->uiFactory->legacy()->content($form->getHTML())
        ]));
    }
}