User privacy settings (currently located under "Profile and Privacy") More...

Collaboration diagram for ilUserPrivacySettingsGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	workWithUserSetting (string $setting)

	userSettingVisible (string $setting)

	showPrivacySettings (\ILIAS\UI\Component\Input\Container\Form\Standard $form=null)

	initPrivacySettingsForm ()
	Init form. More...

	shouldDisplayChatSection ()

	shouldDisplayNotificationSection ()

	savePrivacySettings ()

Protected Member Functions
	isAwarnessSettingVisible ()
	Is awareness tool setting visible. More...

	isContactSettingVisible ()
	Is contact setting visible. More...

	populateWithAwarenessSettingsSection (array &$formSections)

	populateWithContactsSettingsSection (array &$formSections)

	populateWithNotificationSettingsSection (array &$formSections)

	populateWithChatSettingsSection (array &$formSections)

	appendChatJsToTemplate (ilGlobalTemplateInterface $pageTemplate)

Protected Attributes
ilLanguage	$lng

ilCtrl	$ctrl

ilGlobalTemplateInterface	$main_tpl

ilUserSettingsConfig	$user_settings_config

ilObjUser	$user

ilSetting	$settings

Psr Http Message RequestInterface	$request

ilProfileChecklistStatus	$checklist_status

ilPersonalProfileMode	$profile_mode

ilSetting	$chatSettings

ilSetting	$notificationSettings

ilAppEventHandler	$event

Private Member Functions
	shouldShowOnScreenChatOptions ()

	shouldShowChatTypingBroadcastOption ()

	shouldShowNotificationOptions ()

Private Attributes
const	PROP_ENABLE_OSC = 'chat_osc_accept_msg'

const	PROP_ENABLE_BROWSER_NOTIFICATIONS = 'chat_osc_browser_notifications'

const	PROP_ENABLE_SOUND = 'osd_play_sound'

const	PROP_ENABLE_BROADCAST_TYPING = 'chat_broadcast_typing'

ILIAS UI Factory	$uiFactory

ILIAS UI Renderer	$uiRenderer

ILIAS Refinery Factory	$refinery

Detailed Description

User privacy settings (currently located under "Profile and Privacy")

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 25 of file class.ilUserPrivacySettingsGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilUserPrivacySettingsGUI::__construct ( )

Definition at line 48 of file class.ilUserPrivacySettingsGUI.php.

    {
        global $DIC;
 
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $this->lng->loadLanguageModule("user");
        $this->user = $DIC->user();
        $this->refinery = $DIC->refinery();
        $this->uiFactory = $DIC->ui()->factory();
        $this->uiRenderer = $DIC->ui()->renderer();
        $this->chatSettings = new ilSetting('chatroom');
        $this->notificationSettings = new ilSetting('notifications');
        $this->event = $DIC->event();
 
        $this->request = $DIC->http()->request();
 
        $this->user_settings_config = new ilUserSettingsConfig();
        $this->settings = $DIC->settings();
        $this->checklist_status = new ilProfileChecklistStatus();
        $this->profile_mode = new ilPersonalProfileMode($this->user, $this->settings);
    }

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\settings(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ appendChatJsToTemplate()

ilUserPrivacySettingsGUI::appendChatJsToTemplate ( ilGlobalTemplateInterface $pageTemplate )

protected

Definition at line 495 of file class.ilUserPrivacySettingsGUI.php.

     : ilTemplate {
        $tpl = new ilTemplate('tpl.personal_chat_settings_form.html', true, true, 'Modules/Chatroom');
        if ($this->shouldShowOnScreenChatOptions() && $this->chatSettings->get('enable_browser_notifications', '0')) {
            $pageTemplate->addJavaScript('./Services/Notifications/js/browser_notifications.js');
 
            $tpl->setVariable('ALERT_IMAGE_SRC', ilUtil::getImagePath('icon_alert.svg'));
            $tpl->setVariable('BROWSER_NOTIFICATION_TOGGLE_LABEL', $this->lng->txt('osc_enable_browser_notifications_label'));
 
            $this->lng->toJSMap([
                'osc_browser_noti_no_permission_error' => $this->lng->txt('osc_browser_noti_no_permission_error'),
                'osc_browser_noti_no_support_error' => $this->lng->txt('osc_browser_noti_no_support_error'),
                'osc_browser_noti_req_permission_error' => $this->lng->txt('osc_browser_noti_req_permission_error'),
            ], $pageTemplate);
        }
 
        return $tpl;
    }

References $tpl, ilGlobalTemplateInterface\addJavaScript(), ilUtil\getImagePath(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ executeCommand()

ilUserPrivacySettingsGUI::executeCommand ( )

Definition at line 72 of file class.ilUserPrivacySettingsGUI.php.

                                    : void
    {
        $next_class = $this->ctrl->getNextClass();
 
        switch ($next_class) {
            default:
                $cmd = $this->ctrl->getCmd("showPrivacySettings");
                $this->$cmd();
                break;
        }
        $this->main_tpl->printToStdout();
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

◆ initPrivacySettingsForm()

ilUserPrivacySettingsGUI::initPrivacySettingsForm ( )

Init form.

Definition at line 160 of file class.ilUserPrivacySettingsGUI.php.

                                             : \ILIAS\UI\Component\Input\Container\Form\Standard
    {
        $sections = [];
 
        $this->populateWithAwarenessSettingsSection($sections);
        $this->populateWithContactsSettingsSection($sections);
        $this->populateWithChatSettingsSection($sections);
        $this->populateWithNotificationSettingsSection($sections);
 
        $form_action = $this->ctrl->getLinkTarget($this, "savePrivacySettings");
 
        return $this->uiFactory->input()
            ->container()
            ->form()
            ->standard($form_action, $sections)
            ->withAdditionalTransformation($this->refinery->custom()->transformation(static function (array $values): array {
                return array_merge(...array_values($values));
            }));
    }

References ILIAS\Repository\ctrl(), function, and ILIAS\Repository\refinery().

Referenced by showPrivacySettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAwarnessSettingVisible()

ilUserPrivacySettingsGUI::isAwarnessSettingVisible ( )

protected

Is awareness tool setting visible.

Definition at line 142 of file class.ilUserPrivacySettingsGUI.php.

                                                 : bool
    {
        $awrn_set = new ilSetting("awrn");
 
        return $awrn_set->get("awrn_enabled", '0') && $this->userSettingVisible("hide_own_online_status");
    }

◆ isContactSettingVisible()

ilUserPrivacySettingsGUI::isContactSettingVisible ( )

protected

Is contact setting visible.

Definition at line 152 of file class.ilUserPrivacySettingsGUI.php.

                                                : bool
    {
        return ilBuddySystem::getInstance()->isEnabled() && $this->userSettingVisible('bs_allow_to_contact_me');
    }

References ilBuddySystem\getInstance().

Here is the call graph for this function:

◆ populateWithAwarenessSettingsSection()

ilUserPrivacySettingsGUI::populateWithAwarenessSettingsSection ( array & $formSections )

protected

Definition at line 210 of file class.ilUserPrivacySettingsGUI.php.

     : void {
        if (!$this->isAwarnessSettingVisible()) {
            return;
        }
 
        $this->lng->loadLanguageModule("awrn");
 
        $default = ($this->settings->get('hide_own_online_status') === "n")
            ? $this->lng->txt("user_awrn_show")
            : $this->lng->txt("user_awrn_hide");
 
        $options = [
            "x" => $this->lng->txt("user_awrn_default") . " (" . $default . ")",
            "n" => $this->lng->txt("user_awrn_show"),
            "y" => $this->lng->txt("user_awrn_hide")
        ];
        $val = $this->user->prefs["hide_own_online_status"] ?? "";
        if ($val == "") {
            $val = "x";
        }
 
        $fields["hide_own_online_status"] = $this->uiFactory->input()
            ->field()
            ->select(
                $this->lng->txt("awrn_user_show"),
                $options,
                $this->lng->txt("awrn_hide_from_awareness_info")
            )
            ->withValue($val)
            ->withRequired(true)
            ->withDisabled(
                $this->settings->get('usr_settings_disable_hide_own_online_status', '0') === '1' ? true : false
            );
 
        $formSections['awrn_sec'] = $this->uiFactory->input()->field()->section($fields, $this->lng->txt('obj_awra'));
    }

◆ populateWithChatSettingsSection()

ilUserPrivacySettingsGUI::populateWithChatSettingsSection ( array & $formSections )

protected

Definition at line 299 of file class.ilUserPrivacySettingsGUI.php.

     : void {
        if (!$this->shouldDisplayChatSection()) {
            return;
        }
 
        $fieldFactory = $this->uiFactory->input()->field();
        $fields = [];
 
        $this->lng->loadLanguageModule('chatroom_adm');
        $checkboxStateToBooleanTrafo = $this->refinery->custom()->transformation(static function ($v) {
            if (is_array($v)) {
                return $v;
            }
 
            if (is_bool($v)) {
                return $v;
            }
 
            return $v === 'checked';
        });
 
        if ($this->shouldShowOnScreenChatOptions()) {
            $oscAvailable = $this->settings->get('usr_settings_disable_chat_osc_accept_msg', '0') === '1' ? true : false;
            $oscSubFormGroup = [];
 
            if ($this->chatSettings->get('enable_browser_notifications', '0')) {
                $enabledBrowserNotifications = $fieldFactory
                    ->checkbox(
                        $this->lng->txt('osc_enable_browser_notifications_label'),
                        sprintf(
                            $this->lng->txt('osc_enable_browser_notifications_info'),
                            (int) $this->chatSettings->get('conversation_idle_state_in_minutes')
                        )
                    )
                    ->withAdditionalTransformation($checkboxStateToBooleanTrafo)
                    ->withDisabled($oscAvailable);
 
                $oscSubFormGroup[self::PROP_ENABLE_BROWSER_NOTIFICATIONS] = $enabledBrowserNotifications;
 
                $groupValue = null;
                if (ilUtil::yn2tf((string) $this->user->getPref('chat_osc_accept_msg'))) {
                    $groupValue = [
                        self::PROP_ENABLE_BROWSER_NOTIFICATIONS => ilUtil::yn2tf((string) $this->user->getPref('chat_osc_browser_notifications')),
                    ];
                }
                $enabledOsc = $fieldFactory
                    ->optionalGroup(
                        $oscSubFormGroup,
                        $this->lng->txt('chat_osc_accept_msg'),
                        $this->lng->txt('chat_osc_accept_msg_info')
                    )
                    ->withAdditionalTransformation($checkboxStateToBooleanTrafo)
                    ->withDisabled($oscAvailable)
                    ->withValue($groupValue);
            } else {
                $enabledOsc = $fieldFactory
                    ->checkbox(
                        $this->lng->txt('chat_osc_accept_msg'),
                        $this->lng->txt('chat_osc_accept_msg_info')
                    )
                    ->withAdditionalTransformation($checkboxStateToBooleanTrafo)
                    ->withDisabled($oscAvailable)
                    ->withValue(ilUtil::yn2tf((string) $this->user->getPref('chat_osc_accept_msg')));
            }
 
            $fields[self::PROP_ENABLE_OSC] = $enabledOsc;
        }
 
        if ($this->shouldShowChatTypingBroadcastOption()) {
            $fields[self::PROP_ENABLE_BROADCAST_TYPING] = $fieldFactory
                ->checkbox($this->lng->txt('chat_broadcast_typing'), $this->lng->txt('chat_broadcast_typing_info'))
                ->withAdditionalTransformation($checkboxStateToBooleanTrafo)
                ->withValue(ilUtil::yn2tf((string) $this->user->getPref('chat_broadcast_typing')));
        }
 
        if ($fields !== []) {
            $formSections['chat_sec'] = $this->uiFactory->input()->field()->section(
                $fields,
                $this->lng->txt('chat_settings')
            );
        }
    }

◆ populateWithContactsSettingsSection()

ilUserPrivacySettingsGUI::populateWithContactsSettingsSection ( array & $formSections )

protected

Definition at line 249 of file class.ilUserPrivacySettingsGUI.php.

     : void {
        if (!$this->isContactSettingVisible()) {
            return;
        }
 
        $this->lng->loadLanguageModule('buddysystem');
        $bs_allow_contact_me = isset($this->user->prefs['bs_allow_to_contact_me']) ?
            $this->user->prefs['bs_allow_to_contact_me'] === 'y' : false;
        $fields["bs_allow_to_contact_me"] = $this->uiFactory->input()
            ->field()
            ->checkbox(
                $this->lng->txt("buddy_allow_to_contact_me"),
                $this->lng->txt("buddy_allow_to_contact_me_info")
            )
            ->withValue($bs_allow_contact_me)
            ->withDisabled(
                $this->settings->get('usr_settings_disable_bs_allow_to_contact_me', '0') === '1' ? true : false
            );
 
        $formSections['contacts_sec'] = $this->uiFactory->input()->field()->section($fields, $this->lng->txt('mm_contacts'));
    }

◆ populateWithNotificationSettingsSection()

ilUserPrivacySettingsGUI::populateWithNotificationSettingsSection ( array & $formSections )

protected

Parameters

Section[] $formSections

Definition at line 276 of file class.ilUserPrivacySettingsGUI.php.

                                                                                    : void
    {
        if (!$this->shouldDisplayNotificationSection()) {
            return;
        }
 
        $fields = [];
 
        if ($this->shouldShowNotificationOptions()) {
            $this->lng->loadLanguageModule('notifications_adm');
            $fields[self::PROP_ENABLE_SOUND] = $this->uiFactory->input()->field()
                                                               ->checkbox($this->lng->txt('osd_play_sound'), $this->lng->txt('osd_play_sound_desc'))
                                                               ->withValue((bool) $this->user->getPref('osd_play_sound'));
        }
 
        if ($fields !== []) {
            $formSections['notification_sec'] = $this->uiFactory->input()->field()->section(
                $fields,
                $this->lng->txt('notification_settings')
            );
        }
    }

References ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ savePrivacySettings()

ilUserPrivacySettingsGUI::savePrivacySettings ( )

Definition at line 384 of file class.ilUserPrivacySettingsGUI.php.

                                         : void
    {
        $request = $this->request;
        $form = $this->initPrivacySettingsForm();
        $lng = $this->lng;
        $user = $this->user;
        $ctrl = $this->ctrl;
 
        if ($request->getMethod() === "POST") {
            $form = $form->withRequest($request);
            $formData = $form->getData();
 
            if ($this->isAwarnessSettingVisible() && $this->workWithUserSetting("hide_own_online_status")) {
                $val = $formData["hide_own_online_status"] ?? 'x';
                if ($val == "x") {
                    $val = "";
                }
                $user->setPref(
                    "hide_own_online_status",
                    $val
                );
            }
            if ($this->isContactSettingVisible() && $this->workWithUserSetting("bs_allow_to_contact_me")) {
                if ($formData["bs_allow_to_contact_me"]) {
                    $user->setPref("bs_allow_to_contact_me", "y");
                } else {
                    $user->setPref("bs_allow_to_contact_me", "n");
                }
            }
 
            $user->update();
 
            if ($this->shouldDisplayNotificationSection()) {
                if ($this->shouldShowNotificationOptions()) {
                    $oldPlaySoundValue = (int) $this->user->getPref('osd_play_sound');
                    $playASound = (int) ($formData[self::PROP_ENABLE_SOUND] ?? 0);
 
                    if ($oldPlaySoundValue !== $playASound) {
                        $this->user->setPref('osd_play_sound', (string) $playASound);
                    }
                }
            }
 
            if ($this->shouldDisplayChatSection()) {
                $preferencesUpdated = false;
 
                if ($this->shouldShowOnScreenChatOptions()) {
                    $oldEnableOscValue = ilUtil::yn2tf((string) $this->user->getPref('chat_osc_accept_msg'));
                    $enableOsc = $formData[self::PROP_ENABLE_OSC] ?? null;
                    if (!is_bool($enableOsc)) {
                        $enableOsc = is_array($enableOsc);
                    }
 
                    if ($this->settings->get('usr_settings_disable_chat_osc_accept_msg', '0') !== '1') {
                        $preferencesUpdated = true;
                        if ($oldEnableOscValue !== $enableOsc) {
                            $this->user->setPref('chat_osc_accept_msg', ilUtil::tf2yn($enableOsc));
                            $preferencesUpdated = true;
                        }
                    }
 
                    if ($enableOsc && $this->chatSettings->get('enable_browser_notifications', '0')) {
                        $oldBrowserNotificationValue = ilUtil::yn2tf((string) $this->user->getPref('chat_osc_browser_notifications'));
 
                        $sendBrowserNotifications = false;
                        if (is_array($formData[self::PROP_ENABLE_OSC]) &&
                            true === $formData[self::PROP_ENABLE_OSC][self::PROP_ENABLE_BROWSER_NOTIFICATIONS]) {
                            $sendBrowserNotifications = true;
                        }
 
                        if ($oldBrowserNotificationValue !== $sendBrowserNotifications) {
                            $this->user->setPref(
                                'chat_osc_browser_notifications',
                                ilUtil::tf2yn($sendBrowserNotifications)
                            );
                            $preferencesUpdated = true;
                        }
                    }
                }
 
                if ($this->shouldShowChatTypingBroadcastOption()) {
                    $oldBroadcastTypingValue = ilUtil::yn2tf((string) $this->user->getPref('chat_broadcast_typing'));
                    $broadcastTyping = (bool) ($formData[self::PROP_ENABLE_BROADCAST_TYPING] ?? false);
 
                    if ($oldBroadcastTypingValue !== $broadcastTyping) {
                        $this->user->setPref('chat_broadcast_typing', ilUtil::tf2yn($broadcastTyping));
                        $preferencesUpdated = true;
                    }
                }
 
                if ($preferencesUpdated) {
                    $this->user->writePrefs();
 
                    $this->event->raise(
                        'Modules/Chatroom',
                        'chatSettingsChanged',
                        [
                            'user' => $this->user
                        ]
                    );
                }
            }
 
            $this->checklist_status->saveStepSucess(ilProfileChecklistStatus::STEP_VISIBILITY_OPTIONS);
            $this->main_tpl->setOnScreenMessage('success', $lng->txt('msg_obj_modified'), true);
            $ctrl->redirect($this, '');
        }
 
        $this->showPrivacySettings($form);
    }

References $lng, ILIAS\Repository\int(), ilCtrl\redirect(), ilObjUser\setPref(), ILIAS\Repository\settings(), ilProfileChecklistStatus\STEP_VISIBILITY_OPTIONS, ilUtil\tf2yn(), ilObjUser\update(), ILIAS\Repository\user(), and ilUtil\yn2tf().

Here is the call graph for this function:

◆ shouldDisplayChatSection()

ilUserPrivacySettingsGUI::shouldDisplayChatSection ( )

Definition at line 195 of file class.ilUserPrivacySettingsGUI.php.

                                              : bool
    {
        return (bool) $this->chatSettings->get('chat_enabled', '0');
    }

◆ shouldDisplayNotificationSection()

ilUserPrivacySettingsGUI::shouldDisplayNotificationSection ( )

Definition at line 205 of file class.ilUserPrivacySettingsGUI.php.

                                                      : bool
    {
        return (bool) $this->notificationSettings->get('enable_osd', '0');
    }

◆ shouldShowChatTypingBroadcastOption()

ilUserPrivacySettingsGUI::shouldShowChatTypingBroadcastOption ( )

private

Definition at line 188 of file class.ilUserPrivacySettingsGUI.php.

                                                          : bool
    {
        return (
            !$this->settings->get('usr_settings_hide_chat_broadcast_typing', '0')
        );
    }

References ILIAS\Repository\settings().

Here is the call graph for this function:

◆ shouldShowNotificationOptions()

ilUserPrivacySettingsGUI::shouldShowNotificationOptions ( )

private

Definition at line 200 of file class.ilUserPrivacySettingsGUI.php.

                                                    : bool
    {
        return (bool) $this->notificationSettings->get('osd_play_sound', '0');
    }

◆ shouldShowOnScreenChatOptions()

ilUserPrivacySettingsGUI::shouldShowOnScreenChatOptions ( )

private

Definition at line 180 of file class.ilUserPrivacySettingsGUI.php.

                                                    : bool
    {
        return (
            $this->chatSettings->get('enable_osc', '0') &&
            !$this->settings->get('usr_settings_hide_chat_osc_accept_msg', '0')
        );
    }

◆ showPrivacySettings()

ilUserPrivacySettingsGUI::showPrivacySettings ( \ILIAS\UI\Component\Input\Container\Form\Standard $form = null )

Definition at line 102 of file class.ilUserPrivacySettingsGUI.php.

     : void {
        $main_tpl = $this->main_tpl;
        $user = $this->user;
        $lng = $this->lng;
 
        $html = "";
        if ($this->checklist_status->anyVisibilitySettings()
            && ($this->isAwarnessSettingVisible()
                || $this->isContactSettingVisible()
                || $this->shouldDisplayChatSection())) {
            if (is_null($form)) {
                $form = $this->initPrivacySettingsForm();
            }
            $html = $this->uiRenderer->render([$form]);
        }
 
        $pub_profile = new ilPublicUserProfileGUI($user->getId());
        if ($this->profile_mode->isEnabled()) {
            $pub_profile_legacy = $this->uiFactory->legacy($pub_profile->getEmbeddable());
            $html .= $this->uiRenderer->render($this->uiFactory->panel()->standard(
                $this->lng->txt('user_profile_preview'),
                $pub_profile_legacy
            ));
        } elseif (!$this->checklist_status->anyVisibilitySettings()) {
            $html .= $this->uiRenderer->render(
                [$this->uiFactory->messageBox()->info($lng->txt("usr_public_profile_disabled"))]
            );
        }
 
 
        $chat_tpl = $this->appendChatJsToTemplate($main_tpl);
 
        $main_tpl->setContent($html . $chat_tpl->get());
    }

References initPrivacySettingsForm().

Here is the call graph for this function:

◆ userSettingVisible()

ilUserPrivacySettingsGUI::userSettingVisible ( string $setting )

Definition at line 97 of file class.ilUserPrivacySettingsGUI.php.

                                                       : bool
    {
        return $this->user_settings_config->isVisible($setting);
    }

◆ workWithUserSetting()

ilUserPrivacySettingsGUI::workWithUserSetting ( string $setting )

Definition at line 92 of file class.ilUserPrivacySettingsGUI.php.

                                                        : bool
    {
        return $this->user_settings_config->isVisibleAndChangeable($setting);
    }