AllowOnScreenChatConversations.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Chatroom\UserSettings;
 
use ILIAS\User\Settings\SettingDefinition;
use ILIAS\User\Settings\AvailablePages;
use ILIAS\User\Settings\AvailableSections;
use ILIAS\Language\Language;
use ILIAS\UI\Component\Input\Field\Factory as FieldFactory;
use ILIAS\UI\Component\Input\Input;
use ILIAS\Refinery\Factory as Refinery;
 
class AllowOnScreenChatConversations implements SettingDefinition
{
    private const string KEY_ENABLE_BROWSER_NOTIFICATIONS = 'chat_osc_browser_notifications';
 
    public function getIdentifier(): string
    {
        return 'chat_osc_accept_msg';
    }
 
    public function isAvailable(): bool
    {
        return (new \ilSetting('chatroom'))->get('enable_osc', '0') === '1';
    }
 
    public function getLabel(Language $lng): string
    {
        return $lng->txt('chat_osc_accept_msg');
    }
 
    public function getSettingsPage(): AvailablePages
    {
        return AvailablePages::PrivacySettings;
    }
 
    public function getSection(): AvailableSections
    {
        return AvailableSections::Main;
    }
 
    public function getInput(
        FieldFactory $field_factory,
        Language $lng,
        Refinery $refinery,
        \ilSetting $settings,
        ?\ilObjUser $user = null
    ): Input {
        $chat_settings = new \ilSetting('chatroom');
        $lng->loadLanguageModule('chatroom_adm');
 
        if ($chat_settings->get('enable_browser_notifications', '0') !== '1') {
            return $field_factory->checkbox(
                $lng->txt('chat_osc_accept_msg'),
                $lng->txt('chat_osc_accept_msg_info')
            )->withValue(
                $user !== null
                    ? $user->getPref('chat_osc_accept_msg') === 'y'
                    : $settings->get('chat_osc_accept_msg') === 'y'
            );
        }
 
        return $field_factory->optionalGroup(
            [
                self::KEY_ENABLE_BROWSER_NOTIFICATIONS => $field_factory->checkbox(
                    $lng->txt('osc_enable_browser_notifications_label'),
                    \sprintf(
                        $lng->txt('osc_enable_browser_notifications_info'),
                        (int) $chat_settings->get('conversation_idle_state_in_minutes')
                    )
                )->withDisabled(
                    $settings->get('usr_settings_disable_chat_osc_accept_msg', '0') === '1'
                )
            ],
            $lng->txt('chat_osc_accept_msg'),
            $lng->txt('chat_osc_accept_msg_info')
        )->withValue(
            $this->buildValueForNotificationGroup($settings, $user)
        );
    }
 
    public function getLegacyInput(
        Language $lng,
        \ilSetting $settings,
        ?\ilObjUser $user = null
    ): \ilFormPropertyGUI {
        $lng->loadLanguageModule('chatroom');
 
        $input = new \ilCheckboxInputGUI($lng->txt('chat_osc_accept_msg'));
        $input->setChecked(
            $user !== null
                ? $user->getPref('chat_osc_accept_msg') === 'y'
                : $settings->get('chat_osc_accept_msg') === 'y'
        );
 
        return $input;
    }
 
    public function getDefaultValueForDisplay(
        Language $lng,
        \ilSetting $settings
    ): string {
        return $lng->txt('chat_osc_accepts_messages_no');
    }
 
    public function hasUserPersonalizedSetting(
        \ilSetting $settings,
        \ilObjUser $user
    ): bool {
        $user_value = $this->retrieveValueFromUser($user);
        return $user_value[$this->getIdentifier()] !== false;
    }
 
    public function persistUserInput(
        \ilObjUser $user,
        mixed $input
    ): \ilObjUser {
        if ($input === null) {
            $user->deletePref($this->getIdentifier());
            $user->deletePref(self::KEY_ENABLE_BROWSER_NOTIFICATIONS);
            $this->updateChatServer($user->getId(), false);
 
            return $user;
        }
 
        if ($input === '1' || $input === '0') {
            $input = $input === '1';
        }
 
        if (\is_bool($input)) {
            $user->setPref($this->getIdentifier(), $input ? 'y' : 'n');
            $this->updateChatServer($user->getId(), $input);
 
            return $user;
        }
 
        if (\is_array($input)) {
            $user->setPref($this->getIdentifier(), 'y');
            $user->setPref(
                self::KEY_ENABLE_BROWSER_NOTIFICATIONS,
                $input[self::KEY_ENABLE_BROWSER_NOTIFICATIONS] ? 'y' : 'n'
            );
            $this->updateChatServer($user->getId(), true);
        }
 
        return $user;
    }
 
    public function retrieveValueFromUser(\ilObjUser $user): array
    {
        if ($user->getPref($this->getIdentifier()) !== 'y') {
            return [
                $this->getIdentifier() => false,
                self::KEY_ENABLE_BROWSER_NOTIFICATIONS => false
            ];
        }
 
        return [
            $this->getIdentifier() => true,
            self::KEY_ENABLE_BROWSER_NOTIFICATIONS => $user->getPref(self::KEY_ENABLE_BROWSER_NOTIFICATIONS) === 'y'
        ];
    }
 
    private function buildValueForNotificationGroup(
        \ilSetting $settings,
        ?\ilObjUser $user
    ): ?array {
        $active = $settings->get($this->getIdentifier()) === 'y';
        $notification = false;
        if ($user !== null) {
            $active = $user->getPref($this->getIdentifier()) === 'y';
            $notification = $user->getPref(self::KEY_ENABLE_BROWSER_NOTIFICATIONS) === 'y';
        }
 
        if ($active === false) {
            return null;
        }
 
        return [
            self::KEY_ENABLE_BROWSER_NOTIFICATIONS => $notification
        ];
    }
 
    private function updateChatServer(int $user_id, bool $osc_state): void
    {
        $message = [
            $user_id => [
                'acceptsMessages' => $osc_state,
            ]
        ];
 
        $settings = \ilChatroomAdmin::getDefaultConfiguration()->getServerSettings();
        $connector = new \ilChatroomServerConnector($settings);
        $connector->sendUserConfigChange(json_encode($message, JSON_THROW_ON_ERROR));
    }
}