class.ilObjUserGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\User\UserGUIRequest;
use ILIAS\Language\Language;
use ILIAS\FileUpload\FileUpload;
use ILIAS\ResourceStorage\Services as ResourceStorageServices;
use ILIAS\ResourceStorage\Stakeholder\ResourceStakeholder;
use ILIAS\ResourceStorage\Identification\ResourceIdentification;
use ILIAS\Filesystem\Stream\Streams;
use ILIAS\LegalDocuments\Conductor;

class ilObjUserGUI extends ilObjectGUI
{
    private ilPropertyFormGUI $form_gui;
    private UserGUIRequest $user_request;
    private ilHelpGUI $help;
    private ilTabsGUI $tabs;
    private ilMailMimeSenderFactory $mail_sender_factory;

    private FileUpload $uploads;
    private ResourceStorageServices $irss;
    private ResourceStakeholder $stakeholder;

    private ilUserProfile $user_profile;

    private string $requested_letter = '';
    private string $requested_baseClass = '';
    private string $requested_search = '';
    private array $back_target;
    private bool $update;
    private array $selectable_roles;
    private int $default_role;
    private string $default_layout_and_style;
    private ilUserDefinedFields $user_defined_fields;

    private int $usrf_ref_id;
    private Conductor $legal_documents;

    public function __construct(
        $a_data,
        int $a_id,
        bool $a_call_by_reference = false,
        bool $a_prepare_output = true
    ) {
        global $DIC;
        $this->ctrl = $DIC['ilCtrl'];
        $this->tabs = $DIC['ilTabs'];
        $this->help = $DIC['ilHelp'];
        $this->mail_sender_factory = $DIC->mail()->mime()->senderFactory();

        $this->user_profile = new ilUserProfile();

        $this->default_layout_and_style = $DIC['ilClientIniFile']->readVariable('layout', 'skin') .
                ':' . $DIC['ilClientIniFile']->readVariable('layout', 'style');

        $this->type = 'usr';
        parent::__construct($a_data, $a_id, $a_call_by_reference, false);
        $this->usrf_ref_id = $this->ref_id;

        $this->uploads = $DIC->upload();
        $this->irss = $DIC->resourceStorage();
        $this->stakeholder = new ilUserProfilePictureStakeholder();

        $this->ctrl->saveParameter($this, ['obj_id', 'letter']);
        $this->ctrl->setParameterByClass('ilobjuserfoldergui', 'letter', $this->requested_letter);
        $this->lng->loadLanguageModule('user');

        $this->user_request = new UserGUIRequest(
            $DIC->http(),
            $DIC->refinery()
        );

        $this->requested_letter = $this->user_request->getLetter();
        $this->requested_baseClass = $this->user_request->getBaseClass();
        $this->requested_search = $this->user_request->getSearch();
        $this->legal_documents = $DIC['legalDocuments'];
    }

    public function executeCommand(): void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        $this->prepareOutput();

        switch ($next_class) {
            case 'illearningprogressgui':
                $new_gui = new ilLearningProgressGUI(
                    ilLearningProgressBaseGUI::LP_CONTEXT_USER_FOLDER,
                    USER_FOLDER_ID,
                    $this->object->getId()
                );
                $this->ctrl->forwardCommand($new_gui);
                break;

            case 'ilobjectownershipmanagementgui':
                $gui = new ilObjectOwnershipManagementGUI($this->object->getId());
                $this->ctrl->forwardCommand($gui);
                break;

            default:
                if ($cmd == '' || $cmd == 'view') {
                    $cmd = 'edit';
                }
                $cmd .= 'Object';
                $this->$cmd();
                break;
        }
    }

    protected function setTitleAndDescription(): void
    {
        if (strtolower(get_class($this->object)) == 'ilobjuser') {
            $this->tpl->setTitle('[' . $this->object->getLogin() . '] ' . $this->object->getTitle());
            $this->tpl->setDescription($this->object->getLongDescription());
            $this->tpl->setTitleIcon(
                ilUtil::getImagePath('standard/icon_' . $this->object->getType() . '.svg'),
                $this->lng->txt('obj_' . $this->object->getType())
            );
        } else {
            parent::setTitleAndDescription();
        }
    }

    public function cancelObject(): void
    {
        ilSession::clear('saved_post');

        if (strtolower($this->requested_baseClass) == 'iladministrationgui') {
            $this->ctrl->redirectByClass('ilobjuserfoldergui', 'view');
        } else {
            $this->ctrl->redirectByClass('ilobjcategorygui', 'listUsers');
        }
    }

    public function getAdminTabs(): void
    {
        $this->getTabs();
    }

    protected function getTabs(): void
    {
        $this->tabs_gui->clearTargets();

        $this->help->setScreenIdComponent('usr');

        if ($this->requested_search) {
            $this->tabs_gui->setBackTarget(
                $this->lng->txt('search_results'),
                ilSession::get('usr_search_link')
            );

            $this->tabs_gui->addTarget(
                'properties',
                $this->ctrl->getLinkTarget($this, 'edit'),
                ['edit', '', 'view'],
                get_class($this),
                '',
                true
            );
        } else {
            $this->tabs_gui->addTarget(
                'properties',
                $this->ctrl->getLinkTarget($this, 'edit'),
                ['edit', '', 'view'],
                get_class($this)
            );
        }

        $this->tabs_gui->addTarget(
            'role_assignment',
            $this->ctrl->getLinkTarget($this, 'roleassignment'),
            ['roleassignment'],
            get_class($this)
        );

        // learning progress
        if ($this->rbac_system->checkAccess('read', $this->ref_id) and
            ilObjUserTracking::_enabledLearningProgress() and
            ilObjUserTracking::_enabledUserRelatedData()) {
            $this->tabs_gui->addTarget(
                'learning_progress',
                $this->ctrl->getLinkTargetByClass('illearningprogressgui', ''),
                '',
                ['illplistofobjectsgui', 'illplistofsettingsgui', 'illearningprogressgui', 'illplistofprogressgui']
            );
        }

        $this->tabs_gui->addTarget(
            'user_ownership',
            $this->ctrl->getLinkTargetByClass('ilobjectownershipmanagementgui', ''),
            '',
            'ilobjectownershipmanagementgui'
        );
    }

    public function setBackTarget(
        string $a_text,
        string $a_link
    ): void {
        $this->back_target = ['text' => $a_text, 'link' => $a_link];
    }

    public function __checkUserDefinedRequiredFields(): bool
    {
        $this->user_defined_fields = ilUserDefinedFields::_getInstance();

        $udfs = $this->user_request->getUDFs();
        foreach ($this->user_defined_fields->getDefinitions() as $field_id => $definition) {
            if ($definition['required'] and !strlen($udfs[$field_id])) {
                return false;
            }
        }
        return true;
    }

    public function __showUserDefinedFields(): void
    {
        $user_defined_data = null;
        $this->user_defined_fields = ilUserDefinedFields::_getInstance();

        if ($this->object->getType() == 'usr') {
            $user_defined_data = $this->object->getUserDefinedData();
        }
        foreach ($this->user_defined_fields->getDefinitions() as $field_id => $definition) {
            $error_post_vars = ilSession::get('error_post_vars');
            $old = $error_post_vars['udf'][$field_id] ?? $user_defined_data[$field_id];

            if ($definition['field_type'] == UDF_TYPE_TEXT) {
                $this->tpl->setCurrentBlock('field_text');
                $this->tpl->setVariable('FIELD_NAME', 'udf[' . $definition['field_id'] . ']');
                $this->tpl->setVariable('FIELD_VALUE', ilLegacyFormElementsUtil::prepareFormOutput($old));
            } else {
                $this->tpl->setCurrentBlock('field_select');
                $this->tpl->setVariable(
                    'SELECT_BOX',
                    ilLegacyFormElementsUtil::formSelect(
                        $old,
                        'udf[' . $definition['field_id'] . ']',
                        $this->user_defined_fields->fieldValuesToSelectArray(
                            $definition['field_values']
                        ),
                        false,
                        true
                    )
                );
            }
            $this->tpl->parseCurrentBlock();
            $this->tpl->setCurrentBlock('user_defined');

            if ($definition['required']) {
                $name = $definition['field_name'] . '<span class="asterisk">*</span>';
            } else {
                $name = $definition['field_name'];
            }
            $this->tpl->setVariable('TXT_FIELD_NAME', $name);
            $this->tpl->parseCurrentBlock();
        }
    }

    public function initCreate(): void
    {
        if ($this->usrf_ref_id != USER_FOLDER_ID) {
            $this->tabs_gui->clearTargets();
        }

        // role selection
        $obj_list = $this->rbac_review->getRoleListByObject(ROLE_FOLDER_ID);
        $rol = [];
        foreach ($obj_list as $obj_data) {
            // allow only 'assign_users' marked roles if called from category
            if ($this->object->getRefId() != USER_FOLDER_ID && !in_array(
                SYSTEM_ROLE_ID,
                $this->rbac_review->assignedRoles($this->user->getId())
            )) {
                if (!ilObjRole::_getAssignUsersStatus($obj_data['obj_id'])) {
                    continue;
                }
            }
            // exclude anonymous role from list
            if ($obj_data['obj_id'] != ANONYMOUS_ROLE_ID) {
                // do not allow to assign users to administrator role if current user does not has SYSTEM_ROLE_ID
                if ($obj_data['obj_id'] != SYSTEM_ROLE_ID || in_array(
                    SYSTEM_ROLE_ID,
                    $this->rbac_review->assignedRoles($this->user->getId())
                )) {
                    $rol[$obj_data['obj_id']] = $obj_data['title'];
                }
            }
        }

        if (!count($rol)) {
            $this->ilias->raiseError(
                $this->lng->txt('msg_no_roles_users_can_be_assigned_to'),
                $this->ilias->error_obj->MESSAGE
            );
        }

        $keys = array_keys($rol);

        // set pre defined user role to default
        if (in_array(4, $keys)) {
            $this->default_role = 4;
        } else {
            if (count($keys) > 1 && in_array(2, $keys)) {
                // remove admin role as preselectable role
                foreach ($keys as $key => $val) {
                    if ($val == 2) {
                        unset($keys[$key]);
                        break;
                    }
                }
            }

            $this->default_role = array_shift($keys);
        }
        $this->selectable_roles = $rol;
    }

    public function createObject(): void
    {
        if (!$this->rbac_system->checkAccess('create_usr', $this->usrf_ref_id)
            && !$this->rbac_system->checkAccess('cat_administrate_users', $this->usrf_ref_id)) {
            $this->ilias->raiseError($this->lng->txt('permission_denied'), $this->ilias->error_obj->MESSAGE);
        }

        $this->initCreate();
        $this->initForm('create');
        $this->renderForm();
    }

    public function saveObject(): void
    {
        if (!$this->rbac_system->checkAccess('create_usr', $this->usrf_ref_id)
            && !$this->access->checkAccess('cat_administrate_users', '', $this->usrf_ref_id)) {
            $this->ilias->raiseError($this->lng->txt('permission_denied'), $this->ilias->error_obj->MESSAGE);
        }

        $this->initCreate();
        $this->initForm('create');

        // Manipulate form so ignore required fields are no more required. This has to be done before ilPropertyFormGUI::checkInput() is called.
        $profile_maybe_incomplete = false;
        if ($this->form_gui->getInput('ignore_rf', false)) {
            $profile_maybe_incomplete = $this->handleIgnoredRequiredFields();
        }

        if (!$this->form_gui->checkInput()) {
            $this->form_gui->setValuesByPost();
            $this->renderForm();
            return;
        }

        // checks passed. save user
        $user_object = $this->loadValuesFromForm();
        if ($this->user->getId() === (int) SYSTEM_USER_ID
            || !in_array(SYSTEM_ROLE_ID, $this->rbac_review->assignedRoles($this->object->getId()))
            || in_array(SYSTEM_ROLE_ID, $this->rbac_review->assignedRoles($this->user->getId()))) {
            $user_object->setPasswd($this->form_gui->getInput('passwd'), ilObjUser::PASSWD_PLAIN);
        }
        $user_object->setTitle($user_object->getFullname());
        $user_object->setDescription($user_object->getEmail());

        $this->loadUserDefinedDataFromForm($user_object);

        $user_object->create();

        if (ilAuthUtils::_isExternalAccountEnabled()) {
            $user_object->setExternalAccount($this->form_gui->getInput('ext_account'));
        }

        // set a timestamp for last_password_change
        // this ts is needed by ilSecuritySettings
        $user_object->setLastPasswordChangeTS(time());

        //insert user data in table user_data
        $user_object->saveAsNew();

        // setup user preferences
        if ($this->isSettingChangeable('language')) {
            $user_object->setLanguage($this->form_gui->getInput('language'));
        }

        if ($this->isSettingChangeable('skin_style')) {
            //set user skin and style
            $sknst = explode(':', $this->form_gui->getInput('skin_style'));

            if ($user_object->getPref('style') != $sknst[1] ||
                $user_object->getPref('skin') != $sknst[0]) {
                $user_object->setPref('skin', $sknst[0]);
                $user_object->setPref('style', $sknst[1]);
            }
        }
        if ($this->isSettingChangeable('session_reminder')) {
            $user_object->setPref('session_reminder_lead_time', (string) $this->form_gui->getInput('session_reminder_lead_time'));
        }
        if ($this->isSettingChangeable('hide_own_online_status')) {
            $user_object->setPref(
                'hide_own_online_status',
                $this->form_gui->getInput('hide_own_online_status')
            );
        }
        if ($this->isSettingChangeable('bs_allow_to_contact_me')) {
            $user_object->setPref(
                'bs_allow_to_contact_me',
                $this->form_gui->getInput('bs_allow_to_contact_me') ? 'y' : 'n'
            );
        }
        if ($this->isSettingChangeable('chat_osc_accept_msg')) {
            $user_object->setPref(
                'chat_osc_accept_msg',
                $this->form_gui->getInput('chat_osc_accept_msg') ? 'y' : 'n'
            );
        }
        if ($this->isSettingChangeable('chat_broadcast_typing')) {
            $user_object->setPref(
                'chat_broadcast_typing',
                $this->form_gui->getInput('chat_broadcast_typing') ? 'y' : 'n'
            );
        }
        $user_object->writePrefs();

        //set role entries
        $this->rbac_admin->assignUser(
            (int) $this->form_gui->getInput('default_role'),
            $user_object->getId(),
            true
        );

        $msg = $this->lng->txt('user_added');

        $this->user->setPref(
            'send_info_mails',
            ($this->form_gui->getInput('send_mail') == 'y') ? 'y' : 'n'
        );
        $this->user->writePrefs();

        $this->object = $user_object;

        if ($this->isSettingChangeable('upload')) {
            $this->uploadUserPicture();
        }

        if ($profile_maybe_incomplete
            && $this->user_profile->isProfileIncomplete($this->object)) {
            $this->object->setProfileIncomplete(true);
            $this->object->update();
        }

        // send new account mail
        if ($this->form_gui->getInput('send_mail') == 'y') {
            $acc_mail = new ilAccountMail();
            $acc_mail->useLangVariablesAsFallback(true);
            $acc_mail->setAttachConfiguredFiles(true);
            $acc_mail->setUserPassword($this->form_gui->getInput('passwd'));
            $acc_mail->setUser($user_object);

            if ($acc_mail->send()) {
                $msg .= '<br />' . $this->lng->txt('mail_sent');
                $this->tpl->setOnScreenMessage('success', $msg, true);
            } else {
                $msg .= '<br />' . $this->lng->txt('mail_not_sent');
                $this->tpl->setOnScreenMessage('info', $msg, true);
            }
        } else {
            $this->tpl->setOnScreenMessage('success', $msg, true);
        }

        if (strtolower($this->requested_baseClass) == 'iladministrationgui') {
            $this->ctrl->redirectByClass('ilobjuserfoldergui', 'view');
            return;
        }

        $this->ctrl->redirectByClass('ilobjcategorygui', 'listUsers');
    }

    public function editObject(): void
    {
        $this->checkUserWriteRight();

        if ($this->usrf_ref_id != USER_FOLDER_ID) {
            $this->tabs_gui->clearTargets();
        }

        // get form
        $this->initForm('edit');
        $this->getValues();
        $this->renderForm();
    }

    protected function loadValuesFromForm(string $a_mode = 'create'): ilObjUser
    {
        $user = null;

        switch ($a_mode) {
            case 'create':
                $user = new ilObjUser();
                break;

            case 'update':
                $user = $this->object;
                break;
        }

        $from = $this->form_gui->getItemByPostVar('time_limit_from')->getDate();
        $user->setTimeLimitFrom($from
            ? $from->get(IL_CAL_UNIX)
            : null);

        $until = $this->form_gui->getItemByPostVar('time_limit_until')->getDate();
        $user->setTimeLimitUntil($until
            ? $until->get(IL_CAL_UNIX)
            : null);

        $user->setTimeLimitUnlimited((bool) $this->form_gui->getInput('time_limit_unlimited'));

        if ($a_mode == 'create') {
            $user->setTimeLimitOwner($this->usrf_ref_id);
        }
        if ($this->isSettingChangeable('birthday')) {
            $bd = $this->form_gui->getItemByPostVar('birthday');
            $bd = $bd->getDate();
            $user->setBirthday($bd
                ? $bd->get(IL_CAL_DATE)
                : null);
        }
        $user->setLogin($this->form_gui->getInput('login'));
        if ($this->isSettingChangeable('gender')) {
            $user->setGender($this->form_gui->getInput('gender'));
        }
        if ($this->isSettingChangeable('title')) {
            $user->setUTitle($this->form_gui->getInput('title'));
        }
        if ($this->isSettingChangeable('firstname')) {
            $user->setFirstname($this->form_gui->getInput('firstname'));
        }
        if ($this->isSettingChangeable('lastname')) {
            $user->setLastname($this->form_gui->getInput('lastname'));
        }
        $user->setFullname();
        if ($this->isSettingChangeable('institution')) {
            $user->setInstitution($this->form_gui->getInput('institution'));
        }
        if ($this->isSettingChangeable('department')) {
            $user->setDepartment($this->form_gui->getInput('department'));
        }
        if ($this->isSettingChangeable('street')) {
            $user->setStreet($this->form_gui->getInput('street'));
        }
        if ($this->isSettingChangeable('city')) {
            $user->setCity($this->form_gui->getInput('city'));
        }
        if ($this->isSettingChangeable('zipcode')) {
            $user->setZipcode($this->form_gui->getInput('zipcode'));
        }
        if ($this->isSettingChangeable('country')) {
            $user->setCountry($this->form_gui->getInput('country'));
        }
        if ($this->isSettingChangeable('sel_country')) {
            $user->setSelectedCountry($this->form_gui->getInput('sel_country'));
        }
        if ($this->isSettingChangeable('phone_office')) {
            $user->setPhoneOffice($this->form_gui->getInput('phone_office'));
        }
        if ($this->isSettingChangeable('phone_home')) {
            $user->setPhoneHome($this->form_gui->getInput('phone_home'));
        }
        if ($this->isSettingChangeable('phone_mobile')) {
            $user->setPhoneMobile($this->form_gui->getInput('phone_mobile'));
        }
        if ($this->isSettingChangeable('fax')) {
            $user->setFax($this->form_gui->getInput('fax'));
        }
        if ($this->isSettingChangeable('matriculation')) {
            $user->setMatriculation($this->form_gui->getInput('matriculation'));
        }
        if ($this->isSettingChangeable('email')) {
            $user->setEmail($this->form_gui->getInput('email'));
        }
        if ($this->isSettingChangeable('second_email')) {
            $user->setSecondEmail($this->form_gui->getInput('second_email'));
        }
        if ($this->isSettingChangeable('hobby')) {
            $user->setHobby($this->form_gui->getInput('hobby'));
        }
        if ($this->isSettingChangeable('referral_comment')) {
            $user->setComment($this->form_gui->getInput('referral_comment'));
        }

        $general_interests = is_array($this->form_gui->getInput('interests_general'))
            ? $this->form_gui->getInput('interests_general')
            : [];
        $user->setGeneralInterests($general_interests);

        $offering_help = is_array($this->form_gui->getInput('interests_help_offered'))
            ? $this->form_gui->getInput('interests_help_offered')
            : [];
        $user->setOfferingHelp($offering_help);

        $looking_for_help = is_array($this->form_gui->getInput('interests_help_looking'))
            ? $this->form_gui->getInput('interests_help_looking')
            : [];
        $user->setLookingForHelp($looking_for_help);

        $user->setClientIP($this->form_gui->getInput('client_ip'));
        $user->setLatitude($this->form_gui->getInput('latitude'));
        $user->setLongitude($this->form_gui->getInput('longitude'));
        $zoom = (int) $this->form_gui->getInput('loc_zoom');
        if ($zoom == 0) {
            $zoom = null;
        }
        $user->setLocationZoom($zoom);

        $user->setAuthMode($this->form_gui->getInput('auth_mode'));
        $user->setExternalAccount($this->form_gui->getInput('ext_account'));

        if ((int) $user->getActive() != (int) $this->form_gui->getInput('active')) {
            $user->setActive((bool) $this->form_gui->getInput('active'), $this->user->getId());
        }

        return $user;
    }

    protected function loadUserDefinedDataFromForm(?ilObjUser $user = null): void
    {
        if (!$user) {
            $user = $this->object;
        }

        $user_defined_fields = ilUserDefinedFields::_getInstance();
        if ($this->usrf_ref_id == USER_FOLDER_ID) {
            $all_defs = $user_defined_fields->getDefinitions();
        } else {
            $all_defs = $user_defined_fields->getChangeableLocalUserAdministrationDefinitions();
        }
        $udf = [];
        foreach ($all_defs as $definition) {
            $f = "udf_" . $definition['field_id'];
            $item = $this->form_gui->getItemByPostVar($f);
            if ($item && !$item->getDisabled()) {
                $udf[$definition['field_id']] = $this->form_gui->getInput($f);
            }
        }
        $user->setUserDefinedData($udf);
    }

    public function updateObject(): void
    {
        $this->checkUserWriteRight();
        $this->initForm('edit');

        // Manipulate form so ignore required fields are no more required. This has to be done before ilPropertyFormGUI::checkInput() is called.
        $profile_maybe_incomplete = false;
        if ($this->form_gui->getInput('ignore_rf', false)) {
            $profile_maybe_incomplete = $this->handleIgnoredRequiredFields();
        }

        if ($this->form_gui->checkInput()) {
            // @todo: external account; time limit
            // if not allowed or empty -> do no change password
            if (ilAuthUtils::_allowPasswordModificationByAuthMode(
                ilAuthUtils::_getAuthMode($this->form_gui->getInput('auth_mode'))
            ) && trim($this->form_gui->getInput('passwd')) !== ''
                && ($this->user->getId() === (int) SYSTEM_USER_ID
                    || !in_array(SYSTEM_ROLE_ID, $this->rbac_review->assignedRoles($this->object->getId()))
                    || in_array(SYSTEM_ROLE_ID, $this->rbac_review->assignedRoles($this->user->getId())))
            ) {
                $this->object->setPasswd($this->form_gui->getInput('passwd'), ilObjUser::PASSWD_PLAIN);
            }

            if ((int) $this->form_gui->getInput('active') == 1) {
                $this->object->setLoginAttempts(0);
            }

            $this->loadValuesFromForm('update');

            $this->loadUserDefinedDataFromForm();

            try {
                $this->object->updateLogin($this->form_gui->getInput('login'));
            } catch (ilUserException $e) {
                $this->tpl->setOnScreenMessage('failure', $e->getMessage());
                $this->form_gui->setValuesByPost();
                $this->renderForm();
                return;
            }

            $this->object->setTitle($this->object->getFullname());
            $this->object->setDescription($this->object->getEmail());

            if ($this->isSettingChangeable('language')) {
                $this->object->setLanguage($this->form_gui->getInput('language'));
            }

            if ($this->isSettingChangeable('skin_style')) {
                //set user skin and style
                $sknst = explode(':', $this->form_gui->getInput('skin_style'));

                if ($this->object->getPref('style') != $sknst[1] ||
                    $this->object->getPref('skin') != $sknst[0]) {
                    $this->object->setPref('skin', $sknst[0]);
                    $this->object->setPref('style', $sknst[1]);
                }
            }

            if ($this->isSettingChangeable('session_reminder')) {
                $this->object->setPref('session_reminder_lead_time', (string) $this->form_gui->getInput('session_reminder_lead_time'));
            }

            if ($this->isSettingChangeable('hide_own_online_status')) {
                $this->object->setPref(
                    'hide_own_online_status',
                    ($this->form_gui->getInput('hide_own_online_status') ?? '0')
                );
            }
            if ($this->isSettingChangeable('bs_allow_to_contact_me')) {
                $this->object->setPref(
                    'bs_allow_to_contact_me',
                    ($this->form_gui->getInput('bs_allow_to_contact_me') ?? false) ? 'y' : 'n'
                );
            }
            if ($this->isSettingChangeable('chat_osc_accept_msg')) {
                $this->object->setPref(
                    'chat_osc_accept_msg',
                    ($this->form_gui->getInput('chat_osc_accept_msg') ?? false) ? 'y' : 'n'
                );
            }
            if ($this->isSettingChangeable('chat_broadcast_typing')) {
                $this->object->setPref(
                    'chat_broadcast_typing',
                    ($this->form_gui->getInput('chat_broadcast_typing') ?? false) ? 'y' : 'n'
                );
            }

            // set a timestamp for last_password_change
            // this ts is needed by ilSecuritySettings
            $this->object->setLastPasswordChangeTS(time());

            // #10054 - profile may have been completed, check below is only for incomplete
            $this->object->setProfileIncomplete(false);

            $this->update = $this->object->update();

            // If the current user is editing its own user account,
            // we update his preferences.
            if ($this->user->getId() == $this->object->getId()) {
                $this->user->readPrefs();
            }
            $this->user->setPref(
                'send_info_mails',
                ($this->form_gui->getInput('send_mail') === 'y') ? 'y' : 'n'
            );
            $this->user->writePrefs();

            $mail_message = $this->__sendProfileMail();
            $msg = $this->lng->txt('saved_successfully') . $mail_message;

            // same personal image
            if ($this->isSettingChangeable('upload')) {
                $this->uploadUserPicture();
            }

            if ($profile_maybe_incomplete) {
                $user = $this->object;
                if ($this->user_profile->isProfileIncomplete($user)) {
                    $this->object->setProfileIncomplete(true);
                    $this->object->update();
                }
            }

            // feedback
            $this->tpl->setOnScreenMessage('success', $msg, true);

            if (strtolower($this->requested_baseClass) == 'iladministrationgui') {
                $this->ctrl->redirectByClass('ilobjuserfoldergui', 'view');
            } else {
                $this->ctrl->redirectByClass('ilobjcategorygui', 'listUsers');
            }
        } else {
            $this->form_gui->setValuesByPost();
            $this->tabs_gui->activateTab('properties');
            $this->tpl->setContent($this->form_gui->getHtml());
        }
    }

    public function getValues(): void
    {
        $data = [];

        // login data
        $data['auth_mode'] = $this->object->getAuthMode();
        $data['login'] = $this->object->getLogin();
        $data['ext_account'] = $this->object->getExternalAccount();
        $data['create_date'] = ilDatePresentation::formatDate(new ilDateTime(
            $this->object->getCreateDate(),
            IL_CAL_DATETIME
        ));
        $data['owner'] = ilObjUser::_lookupLogin($this->object->getOwner());
        $data['approve_date'] = ($this->object->getApproveDate() != '')
            ? ilDatePresentation::formatDate(new ilDateTime($this->object->getApproveDate(), IL_CAL_DATETIME))
            : null;

        $data['last_login'] = ($this->object->getLastLogin() != '')
            ? ilDatePresentation::formatDate(new ilDateTime($this->object->getLastLogin(), IL_CAL_DATETIME))
            : null;
        $data['active'] = $this->object->getActive();
        $data['time_limit_unlimited'] = $this->object->getTimeLimitUnlimited() ? '1' : '0';

        $data['time_limit_from'] = $this->object->getTimeLimitFrom()
            ? new ilDateTime($this->object->getTimeLimitFrom(), IL_CAL_UNIX)
            : null;
        $data['time_limit_until'] = $this->object->getTimeLimitUntil()
            ? new ilDateTime($this->object->getTimeLimitUntil(), IL_CAL_UNIX)
            : null;

        $data['gender'] = $this->object->getGender();
        $data['firstname'] = $this->object->getFirstname();
        $data['lastname'] = $this->object->getLastname();
        $data['title'] = $this->object->getUTitle();
        $data['birthday'] = $this->object->getBirthday()
            ? new ilDate($this->object->getBirthday(), IL_CAL_DATE)
            : null;
        $data['institution'] = $this->object->getInstitution();
        $data['department'] = $this->object->getDepartment();
        $data['street'] = $this->object->getStreet();
        $data['city'] = $this->object->getCity();
        $data['zipcode'] = $this->object->getZipcode();
        $data['country'] = $this->object->getCountry();
        $data['sel_country'] = $this->object->getSelectedCountry();
        $data['phone_office'] = $this->object->getPhoneOffice();
        $data['phone_home'] = $this->object->getPhoneHome();
        $data['phone_mobile'] = $this->object->getPhoneMobile();
        $data['fax'] = $this->object->getFax();
        $data['email'] = $this->object->getEmail();
        $data['second_email'] = $this->object->getSecondEmail();
        $data['hobby'] = $this->object->getHobby();
        $data['referral_comment'] = $this->object->getComment();

        $data['interests_general'] = $this->object->getGeneralInterests();
        $data['interests_help_offered'] = $this->object->getOfferingHelp();
        $data['interests_help_looking'] = $this->object->getLookingForHelp();

        $data['matriculation'] = $this->object->getMatriculation();
        $data['client_ip'] = $this->object->getClientIP();

        $this->user_defined_fields = ilUserDefinedFields::_getInstance();
        $user_defined_data = $this->object->getUserDefinedData();
        foreach ($this->user_defined_fields->getDefinitions() as $field_id => $definition) {
            $data['udf_' . $field_id] = $user_defined_data['f_' . $field_id] ?? '';
        }

        $data['language'] = $this->object->getLanguage();
        $data['skin_style'] = $this->object->skin . ':' . $this->object->prefs['style'];
        $data['session_reminder_lead_time'] =
            $this->object->prefs['session_reminder_lead_time'] ??
            ilSessionReminder::byLoggedInUser()->getGlobalSessionReminderLeadTime();
        $data['hide_own_online_status'] = $this->object->prefs['hide_own_online_status'] ?? '';
        $data['bs_allow_to_contact_me'] = ($this->object->prefs['bs_allow_to_contact_me'] ?? '') == 'y';
        $data['chat_osc_accept_msg'] = ($this->object->prefs['chat_osc_accept_msg'] ?? '') == 'y';
        $data['chat_broadcast_typing'] = ($this->object->prefs['chat_broadcast_typing'] ?? '') == 'y';

        $data['send_mail'] = (($this->object->prefs['send_info_mails'] ?? '') == 'y');

        $this->form_gui->setValuesByArray($data);
    }

    public function initForm(string $a_mode): void
    {
        $settings = $this->settings->getAll();

        $this->form_gui = new ilPropertyFormGUI();
        $this->form_gui->setFormAction($this->ctrl->getFormAction($this));
        if ($a_mode == 'create') {
            $this->form_gui->setTitle($this->lng->txt('usr_new'));
        } else {
            $this->form_gui->setTitle($this->lng->txt('usr_edit'));
        }

        // login data
        $sec_l = new ilFormSectionHeaderGUI();
        $sec_l->setTitle($this->lng->txt('login_data'));
        $this->form_gui->addItem($sec_l);

        // authentication mode
        $active_auth_modes = ilAuthUtils::_getActiveAuthModes();
        $am = new ilSelectInputGUI($this->lng->txt('auth_mode'), 'auth_mode');
        $option = [];
        foreach ($active_auth_modes as $auth_name => $auth_key) {
            if ($auth_name == 'default') {
                $name = $this->lng->txt('auth_' . $auth_name) . ' (' . $this->lng->txt('auth_' . ilAuthUtils::_getAuthModeName($auth_key)) . ')';
            } else {
                $name = ilAuthUtils::getAuthModeTranslation((string) $auth_key, $auth_name);
            }
            $option[$auth_name] = $name;
        }
        $am->setOptions($option);
        $this->form_gui->addItem($am);

        if ($a_mode == 'edit') {
            $id = new ilNonEditableValueGUI($this->lng->txt('usr_id'), 'id');
            $id->setValue($this->object->getId());
            $this->form_gui->addItem($id);
        }

        $lo = new ilUserLoginInputGUI($this->lng->txt('login'), 'login');
        $lo->setRequired(true);
        if ($a_mode == 'edit') {
            $lo->setCurrentUserId($this->object->getId());
            try {
                $last_history_entry = ilObjUser::_getLastHistoryDataByUserId($this->object->getId());
                $lo->setInfo(
                    sprintf(
                        $this->lng->txt('usr_loginname_history_info'),
                        ilDatePresentation::formatDate(new ilDateTime($last_history_entry[1], IL_CAL_UNIX)),
                        $last_history_entry[0]
                    )
                );
            } catch (ilUserException $e) {
            }
        }

        $this->form_gui->addItem($lo);

        if ($this->user->getId() === (int) SYSTEM_USER_ID
            || !in_array(SYSTEM_ROLE_ID, $this->rbac_review->assignedRoles($this->object->getId()))
            || in_array(SYSTEM_ROLE_ID, $this->rbac_review->assignedRoles($this->user->getId()))) {
            $pw = new ilPasswordInputGUI($this->lng->txt('passwd'), 'passwd');
            $pw->setUseStripSlashes(false);
            $pw->setSize(32);
            $pw->setMaxLength(80);
            $pw->setValidateAuthPost('auth_mode');
            if ($a_mode == 'create') {
                $pw->setRequiredOnAuth(true);
            }
            if ($this->user->getId() !== (int) SYSTEM_USER_ID
                && in_array(SYSTEM_ROLE_ID, $this->rbac_review->assignedRoles($this->object->getId()))
                && !in_array(SYSTEM_ROLE_ID, $this->rbac_review->assignedRoles($this->user->getId()))) {
                $pw->setDisabled(true);
            }
            $pw->setInfo(ilSecuritySettingsChecker::getPasswordRequirementsInfo());
            $this->form_gui->addItem($pw);
        }

        if (ilAuthUtils::_isExternalAccountEnabled()) {
            $ext = new ilTextInputGUI($this->lng->txt('user_ext_account'), 'ext_account');
            $ext->setSize(40);
            $ext->setMaxLength(250);
            $ext->setInfo($this->lng->txt('user_ext_account_desc'));
            $this->form_gui->addItem($ext);
        }

        $sec_si = new ilFormSectionHeaderGUI();
        $sec_si->setTitle($this->lng->txt('system_information'));
        $this->form_gui->addItem($sec_si);

        // create date, approve date, agreement date, last login
        if ($a_mode == 'edit') {
            $sia = [
                'create_date' => '',
                'approve_date' => '',
                ...$this->legal_documents->userManagementFields($this->object),
                'last_login' => '',
                'owner' => '',
            ];
            foreach ($sia as $a => $v) {
                if (is_string($v)) {
                    $siai = new ilNonEditableValueGUI($this->lng->txt($a), $a);
                    $siai->setValue($v);
                    $this->form_gui->addItem($siai);
                } else {
                    $this->form_gui->addItem($v);
                }
            }
        }

        $ac = new ilCheckboxInputGUI($this->lng->txt('active'), 'active');
        $ac->setChecked(true);
        $this->form_gui->addItem($ac);

        $this->lng->loadLanguageModule('crs');

        $radg = new ilRadioGroupInputGUI($this->lng->txt('time_limit'), 'time_limit_unlimited');
        $radg->setValue('1');
        $radg->setRequired(true);
        $op1 = new ilRadioOption($this->lng->txt('user_access_unlimited'), '1');
        $radg->addOption($op1);
        $op2 = new ilRadioOption($this->lng->txt('user_access_limited'), '0');
        $radg->addOption($op2);

        $acfrom = new ilDateTimeInputGUI($this->lng->txt('crs_from'), 'time_limit_from');
        $acfrom->setRequired(true);
        $acfrom->setShowTime(true);
        $acfrom->setMinuteStepSize(1);
        $op2->addSubItem($acfrom);

        $acto = new ilDateTimeInputGUI($this->lng->txt('crs_to'), 'time_limit_until');
        $acto->setRequired(true);
        $acto->setShowTime(true);
        $acto->setMinuteStepSize(1);
        $op2->addSubItem($acto);

        $this->form_gui->addItem($radg);

        if ($this->isSettingChangeable('gender')
            || $this->isSettingChangeable('firstname')
            || $this->isSettingChangeable('lastname')
            || $this->isSettingChangeable('title')
            || $this->isSettingChangeable('personal_image')
            || $this->isSettingChangeable('birhtday')
        ) {
            $sec_pd = new ilFormSectionHeaderGUI();
            $sec_pd->setTitle($this->lng->txt('personal_data'));
            $this->form_gui->addItem($sec_pd);
        }

        if ($this->isSettingChangeable('gender')) {
            $gndr = new ilRadioGroupInputGUI($this->lng->txt('salutation'), 'gender');
            $gndr->setRequired(isset($settings['require_gender']) && $settings['require_gender']);
            $neutral = new ilRadioOption($this->lng->txt('salutation_n'), 'n');
            $gndr->addOption($neutral);
            $female = new ilRadioOption($this->lng->txt('salutation_f'), 'f');
            $gndr->addOption($female);
            $male = new ilRadioOption($this->lng->txt('salutation_m'), 'm');
            $gndr->addOption($male);
            $this->form_gui->addItem($gndr);
        }

        $fields = [
            'firstname' => true,
            'lastname' => true,
            'title' => isset($settings['require_title']) && $settings['require_title']
        ];
        foreach ($fields as $field => $req) {
            $max_len = $field === 'title' ? 32 : 128;
            if ($this->isSettingChangeable($field)) {
                // #18795
                $caption = ($field == 'title')
                    ? 'person_title'
                    : $field;
                $inp = new ilTextInputGUI($this->lng->txt($caption), $field);
                $inp->setSize(32);
                $inp->setMaxLength($max_len);
                $inp->setRequired($req);
                $this->form_gui->addItem($inp);
            }
        }

        // personal image
        if ($this->isSettingChangeable('upload')) {
            $pi = new ilImageFileInputGUI($this->lng->txt('personal_picture'), 'userfile');
            if ($a_mode == 'edit' || $a_mode == 'upload') {
                $pi->setImage(ilObjUser::_getPersonalPicturePath(
                    $this->object->getId(),
                    'small',
                    true,
                    true
                ));
            }
            $this->form_gui->addItem($pi);
        }

        if ($this->isSettingChangeable('birthday')) {
            $birthday = new ilBirthdayInputGUI($this->lng->txt('birthday'), 'birthday');
            $birthday->setRequired(isset($settings['require_birthday']) && $settings['require_birthday']);
            $this->form_gui->addItem($birthday);
        }

        // institution, department, street, city, zip code, country, phone office
        // phone home, phone mobile, fax, e-mail
        $fields = [
            ['institution', 40, 80],
            ['department', 40, 80],
            ['street', 40, 40],
            ['city', 40, 40],
            ['zipcode', 10, 10],
            ['country', 40, 40],
            ['sel_country'],
            ['phone_office', 30, 30],
            ['phone_home', 30, 30],
            ['phone_mobile', 30, 30],
            ['fax', 30, 30]
        ];

        $counter = 0;
        foreach ($fields as $field) {
            if (!$counter++ and $this->isSettingChangeable($field[0])) {
                // contact data
                $sec_cd = new ilFormSectionHeaderGUI();
                $sec_cd->setTitle($this->lng->txt('contact_data'));
                $this->form_gui->addItem($sec_cd);

                // org units
                if ($a_mode == 'edit') {
                    $orgus = new ilNonEditableValueGUI($this->lng->txt('objs_orgu'), 'org_units');
                    $orgus->setValue($this->object->getOrgUnitsRepresentation());
                    $this->form_gui->addItem($orgus);
                }
            }
            if ($this->isSettingChangeable($field[0])) {
                if ($field[0] != 'sel_country') {
                    $inp = new ilTextInputGUI($this->lng->txt($field[0]), $field[0]);
                    $inp->setSize($field[1]);
                    $inp->setMaxLength($field[2]);
                    $inp->setRequired(isset($settings['require_' . $field[0]]) &&
                        $settings['require_' . $field[0]]);
                    $this->form_gui->addItem($inp);
                } else {
                    // country selection
                    $cs = new ilCountrySelectInputGUI($this->lng->txt($field[0]), $field[0]);
                    $cs->setRequired(isset($settings['require_' . $field[0]]) &&
                        $settings['require_' . $field[0]]);
                    $this->form_gui->addItem($cs);
                }
            }
        }

        if ($this->isSettingChangeable('email')) {
            $em = new ilEMailInputGUI($this->lng->txt('email'), 'email');
            $em->setRequired(isset($settings['require_email']) && $settings['require_email']);
            $em->setMaxLength(128);
            $this->form_gui->addItem($em);
        }

        if ($this->isSettingChangeable('second_email')) {
            $em = new ilEMailInputGUI($this->lng->txt('second_email'), 'second_email');

            $this->form_gui->addItem($em);
        }

        if ($this->isSettingChangeable('hobby')) {
            $hob = new ilTextAreaInputGUI($this->lng->txt('hobby'), 'hobby');
            $hob->setRows(3);
            $hob->setCols(40);
            $hob->setRequired(isset($settings['require_hobby']) &&
                $settings['require_hobby']);
            $this->form_gui->addItem($hob);
        }

        if ($this->isSettingChangeable('referral_comment')) {
            $rc = new ilTextAreaInputGUI($this->lng->txt('referral_comment'), 'referral_comment');
            $rc->setRows(3);
            $rc->setCols(40);
            $rc->setRequired(isset($settings['require_referral_comment']) &&
                $settings['require_referral_comment']);
            $this->form_gui->addItem($rc);
        }

        $sh = new ilFormSectionHeaderGUI();
        $sh->setTitle($this->lng->txt('interests'));
        $this->form_gui->addItem($sh);

        $multi_fields = ['interests_general', 'interests_help_offered', 'interests_help_looking'];
        foreach ($multi_fields as $multi_field) {
            if ($this->isSettingChangeable($multi_field)) {
                // see ilUserProfile
                $ti = new ilTextInputGUI($this->lng->txt($multi_field), $multi_field);
                $ti->setMulti(true);
                $ti->setMaxLength(40);
                $ti->setSize(40);
                $ti->setRequired(isset($settings['require_' . $multi_field]) &&
                    $settings['require_' . $multi_field]);
                $this->form_gui->addItem($ti);
            }
        }

        if ($this->isSettingChangeable('user_profile_other')) {
            $sec_oi = new ilFormSectionHeaderGUI();
            $sec_oi->setTitle($this->lng->txt('user_profile_other'));
            $this->form_gui->addItem($sec_oi);
        }

        if ($this->isSettingChangeable('matriculation')) {
            $mr = new ilTextInputGUI($this->lng->txt('matriculation'), 'matriculation');
            $mr->setSize(40);
            $mr->setMaxLength(40);
            $mr->setRequired(isset($settings['require_matriculation']) &&
                $settings['require_matriculation']);
            $this->form_gui->addItem($mr);
        }

        $ip = new ilTextInputGUI($this->lng->txt('client_ip'), 'client_ip');
        $ip->setSize(40);
        $ip->setMaxLength(255);
        $ip->setInfo($this->lng->txt('current_ip') . ' ' . $_SERVER['REMOTE_ADDR'] . ' <br />' .
            '<span class="warning">' . $this->lng->txt('current_ip_alert') . '</span>');
        $this->form_gui->addItem($ip);

        $user_defined_fields = ilUserDefinedFields::_getInstance();

        if ($this->usrf_ref_id == USER_FOLDER_ID) {
            $all_defs = $user_defined_fields->getDefinitions();
        } else {
            $all_defs = $user_defined_fields->getChangeableLocalUserAdministrationDefinitions();
        }

        foreach ($all_defs as $definition) {
            $f_property = ilCustomUserFieldsHelper::getInstance()->getFormPropertyForDefinition($definition, true);
            if ($f_property instanceof ilFormPropertyGUI) {
                $this->form_gui->addItem($f_property);
            }
        }

        if ($a_mode == 'create'
            || $this->isSettingChangeable('language')
            || $this->isSettingChangeable('skin_style')
            || $this->isSettingChangeable('hide_own_online_status')
            || $this->isSettingChangeable('bs_allow_to_contact_me')
            || $this->isSettingChangeable('chat_osc_accept_msg')
            || $this->isSettingChangeable('chat_broadcast_typing')
            || ($this->isSettingChangeable('session_reminder'))
        ) {
            $sec_st = new ilFormSectionHeaderGUI();
            $sec_st->setTitle($this->lng->txt('settings'));
            $this->form_gui->addItem($sec_st);
        }

        if ($a_mode == 'create') {
            $role = new ilSelectInputGUI(
                $this->lng->txt('default_role'),
                'default_role'
            );
            $role->setRequired(true);
            $role->setValue($this->default_role);
            $role->setOptions($this->selectable_roles);
            $this->form_gui->addItem($role);
        }

        if ($this->isSettingChangeable('language')) {
            $languages = $this->lng->getInstalledLanguages();
            $this->lng->loadLanguageModule('meta');
            $options = [];
            foreach ($languages as $l) {
                $options[$l] = $this->lng->txt('meta_l_' . $l);
            }
            $lang = new ilSelectInputGUI(
                $this->lng->txt('language'),
                'language'
            );
            $lang->setOptions($options);
            $lang->setValue($this->settings->get('language'));
            if (count($options) <= 1) {
                $lang->setDisabled(true);
            }
            $this->form_gui->addItem($lang);
        }

        if ($this->isSettingChangeable('skin_style')) {
            $sk = new ilSelectInputGUI(
                $this->lng->txt('skin_style'),
                'skin_style'
            );

            $skins = ilStyleDefinition::getAllSkins();

            $options = [];
            if (is_array($skins)) {
                $sk = new ilSelectInputGUI($this->lng->txt('skin_style'), 'skin_style');

                $options = [];
                foreach ($skins as $skin) {
                    foreach ($skin->getStyles() as $style) {
                        if (!ilSystemStyleSettings::_lookupActivatedStyle($skin->getId(), $style->getId())) {
                            continue;
                        }

                        $options[$skin->getId() . ':' . $style->getId()] = $skin->getName() . ' / ' . $style->getName();
                    }
                }
            }
            $sk->setOptions($options);
            $sk->setValue($this->default_layout_and_style);

            $this->form_gui->addItem($sk);
        }

        if ($this->isSettingChangeable('hide_own_online_status')) {
            $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 = [
                '' => $this->lng->txt('user_awrn_default') . ' (' . $default . ')',
                'n' => $this->lng->txt('user_awrn_show'),
                'y' => $this->lng->txt('user_awrn_hide')
            ];
            $os = new ilSelectInputGUI($this->lng->txt('awrn_user_show'), 'hide_own_online_status');
            $os->setOptions($options);
            $os->setDisabled((bool) $this->settings->get('usr_settings_disable_hide_own_online_status'));
            $os->setInfo($this->lng->txt('awrn_hide_from_awareness_info'));
            $this->form_gui->addItem($os);
        }

        if ($this->isSettingChangeable('bs_allow_to_contact_me')) {
            $this->lng->loadLanguageModule('buddysystem');
            $os = new ilCheckboxInputGUI($this->lng->txt('buddy_allow_to_contact_me'), 'bs_allow_to_contact_me');
            if ($a_mode == 'create') {
                $os->setChecked(ilUtil::yn2tf($this->settings->get('bs_allow_to_contact_me', 'n')));
            }
            $this->form_gui->addItem($os);
        }
        if ($this->isSettingChangeable('chat_osc_accept_msg')) {
            $this->lng->loadLanguageModule('chatroom');
            $chat_osc_acm = new ilCheckboxInputGUI($this->lng->txt('chat_osc_accept_msg'), 'chat_osc_accept_msg');
            if ($a_mode == 'create') {
                $chat_osc_acm->setChecked(ilUtil::yn2tf($this->settings->get('chat_osc_accept_msg', 'n')));
            }
            $this->form_gui->addItem($chat_osc_acm);
        }

        if ($this->isSettingChangeable('session_reminder')) {
            $session_reminder = new ilNumberInputGUI(
                $this->lng->txt('session_reminder_input'),
                'session_reminder_lead_time'
            );
            $expires = ilSession::getSessionExpireValue();
            $session_reminder_object = ilSessionReminder::byLoggedInUser();
            $session_reminder->setInfo(
                sprintf(
                    $this->lng->txt('session_reminder_lead_time_info'),
                    ilSessionReminder::LEAD_TIME_DISABLED,
                    ilSessionReminder::SUGGESTED_LEAD_TIME,
                    ilDatePresentation::secondsToString($expires, true)
                )
            );
            $session_reminder->setValue(
                (string) $session_reminder_object->getGlobalSessionReminderLeadTime()
            );
            $session_reminder->setSize(3);
            $session_reminder->setMinValue(ilSessionReminder::LEAD_TIME_DISABLED);
            $session_reminder->setMaxValue($session_reminder_object->getMaxPossibleLeadTime());
            $this->form_gui->addItem($session_reminder);
        }

        if ($this->isSettingChangeable('send_mail')) {
            $sec_op = new ilFormSectionHeaderGUI();
            $sec_op->setTitle($this->lng->txt('options'));
            $this->form_gui->addItem($sec_op);
        }

        $se = new ilCheckboxInputGUI($this->lng->txt('inform_user_mail'), 'send_mail');
        $se->setInfo($this->lng->txt('inform_user_mail_info'));
        $se->setValue('y');
        $se->setChecked(($this->user->getPref('send_info_mails') == 'y'));
        $this->form_gui->addItem($se);

        $irf = new ilCheckboxInputGUI($this->lng->txt('ignore_required_fields'), 'ignore_rf');
        $irf->setInfo($this->lng->txt('ignore_required_fields_info'));
        $irf->setValue('1');
        $this->form_gui->addItem($irf);

        if ($a_mode == 'create' || $a_mode == 'save') {
            $this->form_gui->addCommandButton('save', $this->lng->txt('save'));
        }
        if ($a_mode == 'edit' || $a_mode == 'update') {
            $this->form_gui->addCommandButton('update', $this->lng->txt('save'));
        }
        $this->form_gui->addCommandButton('cancel', $this->lng->txt('cancel'));
    }

    protected function isSettingChangeable(string $a_field): bool
    {
        static $settings = null;

        if ($this->usrf_ref_id == USER_FOLDER_ID) {
            return true;
        }

        if ($settings == null) {
            $settings = $this->settings->getAll();
        }
        return (bool) ($settings['usr_settings_changeable_lua_' . $a_field] ?? false);
    }

    protected function uploadUserPicture(): void
    {
        $userfile_input = $this->form_gui->getItemByPostVar('userfile');
        if ($_FILES['userfile']['tmp_name'] == '') {
            if ($userfile_input->getDeletionFlag()) {
                $this->object->removeUserPicture();
            }
            return;
        }
        if ($_FILES['userfile']['size'] == 0) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_file'));
        } else {
            $store_file = 'usr_' . $this->object->getId() . '.' . 'jpg';

            $rid = $this->moveFileToStorage();

            if ($rid === null) {
                return;
            }

            $this->object->setAvatarRid($rid->serialize());
            $this->irss->flavours()->ensure($rid, new ilUserProfilePictureDefinition());

            $this->object->setPref('profile_image', $store_file); // this may be dropped with the next release
            $this->object->update();
        }
    }

    private function moveFileToStorage(): ?ResourceIdentification
    {
        $uploads = $this->uploads->getResults();
        $upload_tmp_name = $_FILES['userfile']['tmp_name'];
        $avatar_upload_result = $uploads[$upload_tmp_name] ?? null;

        $existing_rid = null;
        if ($this->object->getAvatarRid() !== null) {
            $existing_rid = $this->irss->manage()->find($this->object->getAvatarRid());
        }

        $revision_title = 'Avatar for user ' . $this->object->getLogin();
        $this->stakeholder->setOwner($this->object->getId()); // The Resource is owned by the user we are editing

        if ($avatar_upload_result === null && file_exists($upload_tmp_name)) {
            $stream = Streams::ofResource(
                fopen($upload_tmp_name, 'r')
            );

            if ($existing_rid === null) {
                return $this->irss->manage()->stream($stream, $this->stakeholder, $revision_title);
            }

            $this->irss->manage()->appendNewRevisionFromStream(
                $existing_rid,
                $stream,
                $this->stakeholder,
                $revision_title
            );
            return $existing_rid;
        }

        if ($avatar_upload_result === null) {
            return null;
        }

        if ($existing_rid === null) {
            return $this->irss->manage()->upload(
                $avatar_upload_result,
                $this->stakeholder,
                $revision_title
            );
        }

        $this->irss->manage()->replaceWithUpload(
            $existing_rid,
            $avatar_upload_result,
            $this->stakeholder,
            $revision_title
        );
        return $existing_rid;
    }

    public function removeUserPictureObject(): void
    {
        $webspace_dir = ilFileUtils::getWebspaceDir();
        $image_dir = $webspace_dir . '/usr_images';
        $file = $image_dir . '/usr_' . $this->object->getId() . '.' . 'jpg';
        $thumb_file = $image_dir . '/usr_' . $this->object->getId() . '_small.jpg';
        $xthumb_file = $image_dir . '/usr_' . $this->object->getId() . '_xsmall.jpg';
        $xxthumb_file = $image_dir . '/usr_' . $this->object->getId() . '_xxsmall.jpg';
        $upload_file = $image_dir . '/upload_' . $this->object->getId();

        // remove user pref file name
        $this->object->setPref('profile_image', '');
        $this->object->update();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('user_image_removed'));

        if (is_file($file)) {
            unlink($file);
        }
        if (is_file($thumb_file)) {
            unlink($thumb_file);
        }
        if (is_file($xthumb_file)) {
            unlink($xthumb_file);
        }
        if (is_file($xxthumb_file)) {
            unlink($xxthumb_file);
        }
        if (is_file($upload_file)) {
            unlink($upload_file);
        }

        $this->editObject();
    }

    public function assignSaveObject(): void
    {
        if (!$this->rbac_system->checkAccess('edit_roleassignment', $this->usrf_ref_id)) {
            $this->ilias->raiseError(
                $this->lng->txt('msg_no_perm_assign_role_to_user'),
                $this->ilias->error_obj->MESSAGE
            );
        }

        $selected_roles = $this->user_request->getRoleIds();
        $posted_roles = $this->user_request->getPostedRoleIds();

        // prevent unassignment of system role from system user
        if ($this->object->getId() == SYSTEM_USER_ID && in_array(SYSTEM_ROLE_ID, $posted_roles)) {
            $selected_roles[] = SYSTEM_ROLE_ID;
        }

        $global_roles_all = $this->rbac_review->getGlobalRoles();
        $assigned_roles_all = $this->rbac_review->assignedRoles($this->object->getId());
        $assigned_roles = array_intersect($assigned_roles_all, $posted_roles);
        $assigned_global_roles_all = array_intersect($assigned_roles_all, $global_roles_all);
        $assigned_global_roles = array_intersect($assigned_global_roles_all, $posted_roles);

        $user_not_allowed_to_change_admin_role_assginements =
            !in_array(SYSTEM_ROLE_ID, $this->rbac_review->assignedRoles($this->user->getId()));

        if ($user_not_allowed_to_change_admin_role_assginements
            && in_array(SYSTEM_ROLE_ID, $assigned_roles_all)) {
            $selected_roles[] = SYSTEM_ROLE_ID;
        }

        $posted_global_roles = array_intersect($selected_roles, $global_roles_all);

        if (empty($selected_roles) && count($assigned_roles_all) === count($assigned_roles)
             || empty($posted_global_roles) && count($assigned_global_roles_all) === count($assigned_global_roles)) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('msg_min_one_role') . '<br/>' . $this->lng->txt('action_aborted'),
                true
            );
            $this->ctrl->redirect($this, 'roleassignment');
        }

        foreach (array_diff($assigned_roles, $selected_roles) as $role) {
            if ($this->object->getId() === (int) SYSTEM_USER_ID && $role === SYSTEM_ROLE_ID
                || $user_not_allowed_to_change_admin_role_assginements && $role === SYSTEM_ROLE_ID) {
                continue;
            }
            $this->rbac_admin->deassignUser($role, $this->object->getId());
        }

        foreach (array_diff($selected_roles, $assigned_roles) as $role) {
            if ($this->object->getId() === (int) SYSTEM_USER_ID && $role === SYSTEM_ROLE_ID
                || $user_not_allowed_to_change_admin_role_assginements && $role === SYSTEM_ROLE_ID) {
                continue;
            }
            $this->rbac_admin->assignUser($role, $this->object->getId(), false);
        }

        $this->object->update();

        $this->tpl->setOnScreenMessage('success', $this->lng->txt('msg_roleassignment_changed'), true);

        if (strtolower($this->requested_baseClass) == 'iladministrationgui') {
            $this->ctrl->redirect($this, 'roleassignment');
        } else {
            $this->ctrl->redirectByClass('ilobjcategorygui', 'listUsers');
        }
    }

    public function roleassignmentObject(): void
    {
        $this->tabs->activateTab('role_assignment');

        if ($this->object->getId() === (int) ANONYMOUS_USER_ID
            || !$this->rbac_system->checkAccess('edit_roleassignment', $this->usrf_ref_id)
                && !$this->access->isCurrentUserBasedOnPositionsAllowedTo('read_users', [$this->object->getId()])
        ) {
            $this->ilias->raiseError(
                $this->lng->txt('msg_no_perm_assign_role_to_user'),
                $this->ilias->error_obj->MESSAGE
            );
        }

        $filtered_roles = ilSession::get('filtered_roles');
        $req_filtered_roles = $this->user_request->getFilteredRoles();
        ilSession::set(
            'filtered_roles',
            ($req_filtered_roles > 0) ? $req_filtered_roles : $filtered_roles
        );

        $filtered_roles = ilSession::get('filtered_roles');
        if ($filtered_roles > 5) {
            ilSession::set('filtered_roles', 0);
        }

        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.usr_role_assignment.html', 'components/ILIAS/User');

        // init table
        $tab = new ilRoleAssignmentTableGUI($this, 'roleassignment');

        $tab->parse($this->object->getId());
        $this->tpl->setVariable('ROLES_TABLE', $tab->getHTML());
    }

    public function applyFilterObject(): void
    {
        $table_gui = new ilRoleAssignmentTableGUI($this, 'roleassignment');
        $table_gui->writeFilterToSession();
        $table_gui->resetOffset();
        $this->roleassignmentObject();
    }

    public function resetFilterObject(): void
    {
        $table_gui = new ilRoleAssignmentTableGUI($this, 'roleassignment');
        $table_gui->resetOffset();
        $table_gui->resetFilter();
        $this->roleassignmentObject();
    }

    public function __getDateSelect(
        string $a_type,
        string $a_varname,
        string $a_selected
    ): string {
        $year = null;
        switch ($a_type) {
            case 'minute':
                for ($i = 0; $i <= 60; $i++) {
                    $days[$i] = $i < 10 ? '0' . $i : $i;
                }
                return ilLegacyFormElementsUtil::formSelect($a_selected, $a_varname, $days, false, true);

            case 'hour':
                for ($i = 0; $i < 24; $i++) {
                    $days[$i] = $i < 10 ? '0' . $i : $i;
                }
                return ilLegacyFormElementsUtil::formSelect($a_selected, $a_varname, $days, false, true);

            case 'day':
                for ($i = 1; $i < 32; $i++) {
                    $days[$i] = $i < 10 ? '0' . $i : $i;
                }
                return ilLegacyFormElementsUtil::formSelect($a_selected, $a_varname, $days, false, true);

            case 'month':
                for ($i = 1; $i < 13; $i++) {
                    $month[$i] = $i < 10 ? '0' . $i : $i;
                }
                return ilLegacyFormElementsUtil::formSelect($a_selected, $a_varname, $month, false, true);

            case 'year':
                if ($a_selected < date('Y')) {
                    $start = $a_selected;
                } else {
                    $start = date('Y');
                }

                for ($i = $start; $i < ((int) date('Y') + 11); ++$i) {
                    $year[$i] = $i;
                }
                return ilLegacyFormElementsUtil::formSelect($a_selected, $a_varname, $year, false, true);
        }
        return '';
    }

    public function __toUnix(array $a_time_arr): int // Missing array type.
    {
        return mktime(
            $a_time_arr['hour'],
            $a_time_arr['minute'],
            $a_time_arr['second'],
            $a_time_arr['month'],
            $a_time_arr['day'],
            $a_time_arr['year']
        );
    }

    public function __unsetSessionVariables(): void
    {
        ilSession::clear('filtered_roles');
    }

    public function __buildFilterSelect(): string
    {
        $action[0] = $this->lng->txt('assigned_roles');
        $action[1] = $this->lng->txt('all_roles');
        $action[2] = $this->lng->txt('all_global_roles');
        $action[3] = $this->lng->txt('all_local_roles');
        $action[4] = $this->lng->txt('internal_local_roles_only');
        $action[5] = $this->lng->txt('non_internal_local_roles_only');

        return ilLegacyFormElementsUtil::formSelect(
            ilSession::get('filtered_roles'),
            'filter',
            $action,
            false,
            true
        );
    }

    protected function addAdminLocatorItems(bool $do_not_add_object = false): void
    {
        $this->locator->clearItems();

        if ($this->admin_mode == 'settings') {    // system settings
            $this->ctrl->setParameterByClass(
                'ilobjsystemfoldergui',
                'ref_id',
                SYSTEM_FOLDER_ID
            );
            $this->locator->addItem(
                $this->lng->txt('administration'),
                $this->ctrl->getLinkTargetByClass(['iladministrationgui', 'ilobjsystemfoldergui'], ''),
                ilFrameTargetInfo::_getFrame('MainContent')
            );

            if ($this->requested_ref_id == USER_FOLDER_ID) {
                $this->locator->addItem(
                    $this->lng->txt('obj_' . ilObject::_lookupType(
                        ilObject::_lookupObjId($this->requested_ref_id)
                    )),
                    $this->ctrl->getLinkTargetByClass('ilobjuserfoldergui', 'view')
                );
            } elseif ($this->requested_ref_id == ROLE_FOLDER_ID) {
                $this->locator->addItem(
                    $this->lng->txt('obj_' . ilObject::_lookupType(
                        ilObject::_lookupObjId($this->requested_ref_id)
                    )),
                    $this->ctrl->getLinkTargetByClass('ilobjrolefoldergui', 'view')
                );
            }

            if ($this->obj_id > 0) {
                $this->locator->addItem(
                    $this->object->getTitle(),
                    $this->ctrl->getLinkTarget($this, 'view')
                );
            }
        }
    }

    public function __sendProfileMail(): string
    {
        if ($this->user_request->getSendMail() != 'y') {
            return '';
        }
        if (!strlen($this->object->getEmail())) {
            return '';
        }

        $usr_lang = new ilLanguage($this->object->getLanguage());
        $usr_lang->loadLanguageModule('crs');
        $usr_lang->loadLanguageModule('registration');

        $mmail = new ilMimeMail();
        $mmail->From($this->mail_sender_factory->system());

        $mailOptions = new ilMailOptions($this->object->getId());
        $mmail->To($mailOptions->getExternalEmailAddresses());

        $subject = $usr_lang->txt('profile_changed');
        $body = $usr_lang->txt('reg_mail_body_salutation')
            . ' ' . $this->object->getFullname() . ",\n\n";

        $date = $this->object->getApproveDate();

        if ($date !== null && (time() - strtotime($date)) < 10) {
            $body .= $usr_lang->txt('reg_mail_body_approve') . "\n\n";
        } else {
            $body .= $usr_lang->txt('reg_mail_body_profile_changed') . "\n\n";
        }

        // Append login info only if password has been changed
        if ($this->user_request->getPassword() != '') {
            $body .= $usr_lang->txt('reg_mail_body_text2') . "\n" .
                ILIAS_HTTP_PATH . '/login.php?client_id=' . $this->ilias->client_id . "\n" .
                $usr_lang->txt('login') . ': ' . $this->object->getLogin() . "\n" .
                $usr_lang->txt('passwd') . ': ' . $this->user_request->getPassword() . "\n\n";
        }
        $body .= $usr_lang->txt('reg_mail_body_text3') . "\n";
        $body .= $this->object->getProfileAsString($usr_lang);
        $body .= ilMail::_getInstallationSignature();


        $mmail->Subject($subject, true);
        $mmail->Body($body);
        $mmail->Send();

        return '<br/>' . $this->lng->txt('mail_sent');
    }

    public static function _goto(string $a_target): void
    {
        global $DIC;

        $ilUser = $DIC['ilUser'];

        $ilCtrl = $DIC['ilCtrl'];

        // #10888
        if ($a_target == md5('usrdelown')) {
            if ($ilUser->getId() != ANONYMOUS_USER_ID &&
                $ilUser->hasDeletionFlag()) {
                $ilCtrl->setTargetScript('ilias.php');
                $ilCtrl->redirectByClass(['ildashboardgui', 'ilpersonalsettingsgui'], 'deleteOwnAccountStep2');
            }
            exit('This account is not flagged for deletion.'); // #12160
        }

        // badges
        if (substr($a_target, -4) == '_bdg') {
            $ilCtrl->redirectByClass('ilDashboardGUI', 'jumpToBadges');
        }

        if ('registration' == $a_target) {
            $ilCtrl->redirectByClass(['ilStartUpGUI', 'ilAccountRegistrationGUI'], '');
        } elseif ('nameassist' == $a_target) {
            $ilCtrl->redirectByClass(['ilStartUpGUI', 'ilPasswordAssistanceGUI'], 'showUsernameAssistanceForm');
        } elseif ('pwassist' == $a_target) {
            $ilCtrl->redirectByClass(['ilStartUpGUI', 'ilPasswordAssistanceGUI'], '');
        } else {
            $target = $DIC['legalDocuments']->findGotoLink($a_target);
            if ($target->isOK()) {
                $ilCtrl->setTargetScript('ilias.php');
                foreach ($target->value()->queryParams() as $key => $value) {
                    $ilCtrl->setParameterByClass($target->value()->guiName(), (string) $key, $value);
                }
                $ilCtrl->redirectByClass($target->value()->guiPath(), $target->value()->command());
            }
        }

        if (strpos($a_target, 'n') === 0) {
            $a_target = ilObjUser::_lookupId(ilUtil::stripSlashes(substr($a_target, 1)));
        }

        $cmd = 'view';
        if (strpos($a_target, 'contact_approved') !== false) {
            $cmd = 'approveContactRequest';
        } elseif (strpos($a_target, 'contact_ignored') !== false) {
            $cmd = 'ignoreContactRequest';
        }

        $ilCtrl->setParameterByClass('ilpublicuserprofilegui', 'user_id', (int) $a_target);
        $ilCtrl->redirectByClass(['ilPublicUserProfileGUI'], $cmd);
    }

    protected function handleIgnoredRequiredFields(): bool
    {
        $profile_maybe_incomplete = false;

        foreach ($this->user_profile->getIgnorableRequiredSettings() as $fieldName) {
            $elm = $this->form_gui->getItemByPostVar($fieldName);

            if (!$elm) {
                continue;
            }

            if ($elm->getRequired()) {
                $profile_maybe_incomplete = true;

                // Flag as optional
                $elm->setRequired(false);
            }
        }

        $user_defined_fields = ilUserDefinedFields::_getInstance();
        foreach ($user_defined_fields->getDefinitions() as $definition) {
            $elm = $this->form_gui->getItemByPostVar('udf_' . $definition['field_id']);

            if (!$elm) {
                continue;
            }

            if ($elm->getRequired() && $definition['required']) {
                $profile_maybe_incomplete = true;

                // Flag as optional
                $elm->setRequired(false);
            }
        }

        return $profile_maybe_incomplete;
    }

    private function checkUserWriteRight(): void
    {
        if ($this->usrf_ref_id === USER_FOLDER_ID
            && (
                !$this->rbac_system->checkAccess('visible,read', $this->usrf_ref_id)
                || !$this->rbac_system->checkAccess('write', $this->usrf_ref_id)
                    && (
                        !$this->access->checkPositionAccess(\ilObjUserFolder::ORG_OP_EDIT_USER_ACCOUNTS, $this->usrf_ref_id)
                        || $this->access->checkPositionAccess(\ilObjUserFolder::ORG_OP_EDIT_USER_ACCOUNTS, $this->usrf_ref_id)
                            && !in_array(
                                $this->object->getId(),
                                $this->access->filterUserIdsByPositionOfCurrentUser(
                                    \ilObjUserFolder::ORG_OP_EDIT_USER_ACCOUNTS,
                                    USER_FOLDER_ID,
                                    [$this->object->getId()]
                                )
                            )
                    )
            )
        ) {
            $this->ilias->raiseError($this->lng->txt('msg_no_perm_modify_user'), $this->ilias->error_obj->MESSAGE);
        }

        // if called from local administration $this->usrf_ref_id is category id
        // Todo: this has to be fixed. Do not mix user folder id and category id
        if ($this->usrf_ref_id != USER_FOLDER_ID
            && !$this->rbac_system->checkAccess('cat_administrate_users', $this->object->getTimeLimitOwner())) {
            $this->ilias->raiseError($this->lng->txt('msg_no_perm_modify_user'), $this->ilias->error_obj->MESSAGE);
        }
    }

    private function renderForm(): void
    {
        $this->tpl->setContent($this->legal_documents->userManagementModals() . $this->form_gui->getHTML());
    }
}