Inheritance diagram for ilPasswordAssistanceGUI:

Collaboration diagram for ilPasswordAssistanceGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...

	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...

	getSafePostCommands ()
	This method must return a list of safe POST commands. More...

Private Member Functions
	retrieveRequestedKey ()

	getClientId ()

	getBaseUrl ()

	buildUrl (string $script, array $query_parameters)

	emailTrafo ()

	mergeValuesTrafo ()

	saniziteArrayElementsTrafo ()

	trimIfStringTrafo ()

	getAssistanceForm ()

	showAssistanceForm (?ILIAS\UI\Component\Input\Container\Form\Form $form=null)

	submitAssistanceForm ()
	If the submitted username and email address matches an entry in the user data table, then ILIAS creates a password assistance session for the user, and sends a password assistance mail to the email address. More...

	getAssignPasswordForm (?string $pwassist_id=null)

	getUsernameAssistanceForm ()

	showUsernameAssistanceForm (?ILIAS\UI\Component\Input\Container\Form\Form $form=null)

	submitUsernameAssistanceForm ()

	sendUsernameAssistanceMail (string $email, array $logins)

	showMessageForm (string $text, string $permanent_link_context)

	fillPermanentLink (string $context)

	buildSystemMailBody (string $content)
	Appends the installation signature using line breaks that match the resolved mail body format. More...

Private Attributes
const string	PERMANENT_LINK_TARGET_PW = 'password'

const string	PERMANENT_LINK_TARGET_NAME = 'username'

const string	PROP_USERNAME = 'username'

const string	PROP_EMAIL = 'email'

const string	PROP_PASSWORD = 'password'

const string	PROP_KEY = 'key'

ilCtrlInterface	$ctrl

ilLanguage	$lng

ilRbacReview	$rbacreview

ilGlobalTemplateInterface	$tpl

ilSetting	$settings

ilErrorHandling	$ilErr

RefineryFactory	$refinery

HTTPServices	$http

ilHelpGUI	$help

ILIAS UI Factory	$ui_factory

ILIAS UI Renderer	$ui_renderer

ilObjUser	$actor

ILIAS Data Clock ClockInterface	$clock

ILIAS Init PasswordAssitance PasswordAssistanceRepository	$pwa_repository

readonly ILIAS Mail Service MailSignatureService	$signature_service

Detailed Description

Definition at line 24 of file class.ilPasswordAssistanceGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilPasswordAssistanceGUI::__construct ( )

Definition at line 50 of file class.ilPasswordAssistanceGUI.php.

    {
        global $DIC;
 
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->rbacreview = $DIC->rbac()->review();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->settings = $DIC->settings();
        $this->ilErr = $DIC['ilErr'];
        $this->help = $DIC->help();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->actor = $DIC->user();
        $this->clock = (new ILIAS\Data\Factory())->clock()->utc();
        $this->pwa_repository = new \ILIAS\Init\PasswordAssitance\Repository\PasswordAssistanceDbRepository(
            $DIC->database(),
            $this->clock
        );
        $this->help->setScreenIdComponent('init');
        $this->signature_service = $DIC->mail()->signature();
    }

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

◆ buildSystemMailBody()

ilPasswordAssistanceGUI::buildSystemMailBody ( string $content )

private

Appends the installation signature using line breaks that match the resolved mail body format.

This should be not needed once "Mail" does not accept primitive strings anymore but supports real "Text" handling {

See also: docs/development/text-representation.md}

Definition at line 861 of file class.ilPasswordAssistanceGUI.php.

                                                         : string
    {
        $body = str_replace(["\\n", "\\t"], ["\n", "\t"], $content);
        $signature = $this->signature_service->installation();
 
        if (strip_tags($body) !== $body) {
            $signature = nl2br($signature);
        }
 
        return $body . $signature;
    }

References $body.

◆ buildUrl()

ilPasswordAssistanceGUI::buildUrl	(	string	$script,
		array	$query_parameters
	)

private

Parameters

array<string,string> $query_parameters

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

                                                                      : string
    {
        $url = implode('/', [
            $this->getBaseUrl(),
            ltrim($script, '/')
        ]);
 
        $url = ilUtil::appendUrlParameterString(
            $url,
            http_build_query($query_parameters, '', '&')
        );
 
        return $url;
    }

References ilUtil\appendUrlParameterString(), and getBaseUrl().

Here is the call graph for this function:

◆ emailTrafo()

ilPasswordAssistanceGUI::emailTrafo ( )

private

Definition at line 167 of file class.ilPasswordAssistanceGUI.php.

                                 : \ILIAS\Refinery\Transformation
    {
        return $this->refinery->custom()->constraint(
            static function ($value): bool {
                return is_string($value) && ilUtil::is_email($value);
            },
            $this->lng->txt('email_not_valid')
        );
    }

References ilUtil\is_email(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

◆ executeCommand()

ilPasswordAssistanceGUI::executeCommand ( )

Definition at line 98 of file class.ilPasswordAssistanceGUI.php.

                                    : void
    {
        // check correct setup
        if (!$this->settings->get('setup_ok')) {
            $this->ilErr->raiseError('Setup is not completed. Please run setup routine again.', $this->ilErr->FATAL);
        }
 
        // check hack attempts
        if (!$this->settings->get('password_assistance')) {
            $this->ilErr->raiseError($this->lng->txt('permission_denied'), $this->ilErr->MESSAGE);
        }
 
        if ($this->actor->getId() > 0 && !$this->actor->isAnonymous()) {
            $this->ilErr->raiseError($this->lng->txt('permission_denied'), $this->ilErr->MESSAGE);
        }
 
        $this->lng->loadLanguageModule('pwassist');
        $cmd = $this->ctrl->getCmd() ?? '';
        $next_class = $this->ctrl->getNextClass($this);
 
        switch ($next_class) {
            default:
                if ($cmd !== '' && method_exists($this, $cmd)) {
                    $this->$cmd();
                    return;
                }
 
                if ($this->retrieveRequestedKey() !== '') {
                    $this->showAssignPasswordForm(null, $this->retrieveRequestedKey());
                } else {
                    $this->showAssistanceForm();
                }
                break;
        }
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), retrieveRequestedKey(), ILIAS\Repository\settings(), and showAssistanceForm().

Here is the call graph for this function:

◆ fillPermanentLink()

ilPasswordAssistanceGUI::fillPermanentLink ( string $context )

private

Definition at line 851 of file class.ilPasswordAssistanceGUI.php.

                                                       : void
    {
        $this->tpl->setPermanentLink('assistant', null, $context);
    }

Referenced by showAssistanceForm().

Here is the caller graph for this function:

◆ getAssignPasswordForm()

ilPasswordAssistanceGUI::getAssignPasswordForm ( ?string $pwassist_id = null )

private

Definition at line 439 of file class.ilPasswordAssistanceGUI.php.

                                                                       : ILIAS\UI\Component\Input\Container\Form\Form
    {
        $field_factory = $this->ui_factory->input()->field();
 
        $key = $field_factory
            ->hidden()
            ->withRequired(true)
            ->withDedicatedName(self::PROP_KEY);
        if ($pwassist_id !== null) {
            $key = $key->withValue($pwassist_id);
        }
 
        return $this->ui_factory
            ->input()
            ->container()
            ->form()
            ->standard(
                $this->ctrl->getFormAction($this, 'submitAssignPasswordForm'),
                [
                    $field_factory->section(
                        [
                            self::PROP_KEY => $key,
                            self::PROP_USERNAME => $field_factory
                                ->text($this->lng->txt('username'))
                                ->withAdditionalTransformation($this->trimIfStringTrafo())
                                ->withRequired(true),
                            self::PROP_PASSWORD => $field_factory
                                ->password(
                                    $this->lng->txt('password'),
                                    ilSecuritySettingsChecker::getPasswordRequirementsInfo()
                                )
                                ->withRequired(true)
                                ->withRevelation(true)
                                ->withAdditionalTransformation(
                                    $this->refinery->custom()->constraint(
                                        static function (ILIAS\Data\Password $value): bool {
                                            return ilSecuritySettingsChecker::isPassword(
                                                trim($value->toString())
                                            );
                                        },
                                        static function (Closure $lng, ILIAS\Data\Password $value): string {
                                            $problem = $lng('passwd_invalid');
                                            $custom_problem = null;
                                            if (!ilSecuritySettingsChecker::isPassword(
                                                trim($value->toString()),
                                                $custom_problem
                                            )) {
                                                $problem = $custom_problem;
                                            }
 
                                            return $problem;
                                        }
                                    )
                                )
                                ->withAdditionalTransformation(
                                    $this->refinery->custom()->transformation(
                                        static function (ILIAS\Data\Password $value): string {
                                            return trim($value->toString());
                                        }
                                    )
                                ),
                        ],
                        $this->lng->txt('password_assistance'),
                        ''
                    ),
                ]
            )
            ->withSubmitLabel($this->lng->txt('submit'))
            ->withAdditionalTransformation($this->mergeValuesTrafo())
            ->withAdditionalTransformation($this->saniziteArrayElementsTrafo());
    }

References $lng, ILIAS\Repository\ctrl(), ilSecuritySettingsChecker\getPasswordRequirementsInfo(), ilSecuritySettingsChecker\isPassword(), ILIAS\Repository\lng(), mergeValuesTrafo(), ILIAS\User\Settings\Password, ILIAS\Repository\refinery(), saniziteArrayElementsTrafo(), and ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation().

Here is the call graph for this function:

◆ getAssistanceForm()

ilPasswordAssistanceGUI::getAssistanceForm ( )

private

Definition at line 202 of file class.ilPasswordAssistanceGUI.php.

                                        : ILIAS\UI\Component\Input\Container\Form\Form
    {
        $field_factory = $this->ui_factory->input()->field();
 
        return $this->ui_factory
            ->input()
            ->container()
            ->form()
            ->standard(
                $this->ctrl->getFormAction($this, 'submitAssistanceForm'),
                [
                    $field_factory->section(
                        [
                            self::PROP_USERNAME => $field_factory
                                ->text($this->lng->txt('username'))
                                ->withAdditionalTransformation($this->trimIfStringTrafo())
                                ->withRequired(true),
                            self::PROP_EMAIL => $field_factory
                                ->text($this->lng->txt('email'))
                                ->withRequired(true)
                                ->withAdditionalTransformation($this->trimIfStringTrafo())
                                ->withAdditionalTransformation($this->emailTrafo()),
                        ],
                        $this->lng->txt('password_assistance'),
                        ''
                    ),
                ]
            )
            ->withSubmitLabel($this->lng->txt('submit'))
            ->withAdditionalTransformation($this->mergeValuesTrafo())
            ->withAdditionalTransformation($this->saniziteArrayElementsTrafo());
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), mergeValuesTrafo(), and saniziteArrayElementsTrafo().

Referenced by submitAssistanceForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBaseUrl()

ilPasswordAssistanceGUI::getBaseUrl ( )

private

Definition at line 144 of file class.ilPasswordAssistanceGUI.php.

                                 : string
    {
        return rtrim(ilUtil::_getHttpPath(), '/');
    }

References ilUtil\_getHttpPath().

Referenced by buildUrl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getClientId()

ilPasswordAssistanceGUI::getClientId ( )

private

Definition at line 93 of file class.ilPasswordAssistanceGUI.php.

                                  : string
    {
        return CLIENT_ID;
    }

References CLIENT_ID.

◆ getSafePostCommands()

ilPasswordAssistanceGUI::getSafePostCommands ( )

This method must return a list of safe POST commands.

Safe post commands returned by this method will no longer be CSRF protected and will NOT be appended by an ilCtrlToken.

Returns: string[]

Implements ilCtrlSecurityInterface.

Definition at line 139 of file class.ilPasswordAssistanceGUI.php.

                                         : array
    {
        return ['submitAssignPasswordForm'];
    }

◆ getUnsafeGetCommands()

ilPasswordAssistanceGUI::getUnsafeGetCommands ( )

This method must return a list of unsafe GET commands.

Unsafe get commands returned by this method will now be CSRF protected, which means an ilCtrlToken is appended each time a link-target is generated to the class implementing this interface with a command from that list.

Tokens will be validated in

See also: ilCtrlInterface::getCmd(), whereas the fallback command will be used if the CSRF validation fails.

Returns: string[]

Implements ilCtrlSecurityInterface.

Definition at line 134 of file class.ilPasswordAssistanceGUI.php.

                                          : array
    {
        return [];
    }

◆ getUsernameAssistanceForm()

ilPasswordAssistanceGUI::getUsernameAssistanceForm ( )

private

Definition at line 686 of file class.ilPasswordAssistanceGUI.php.

                                                : ILIAS\UI\Component\Input\Container\Form\Form
    {
        $field_factory = $this->ui_factory->input()->field();
 
        return $this->ui_factory
            ->input()
            ->container()
            ->form()
            ->standard(
                $this->ctrl->getFormAction($this, 'submitUsernameAssistanceForm'),
                [
                    $field_factory->section(
                        [
                            self::PROP_EMAIL => $field_factory
                                ->text($this->lng->txt('email'))
                                ->withRequired(true)
                                ->withAdditionalTransformation($this->trimIfStringTrafo())
                                ->withAdditionalTransformation($this->emailTrafo()),
                        ],
                        $this->lng->txt('username_assistance'),
                        ''
                    ),
                ]
            )
            ->withSubmitLabel($this->lng->txt('submit'))
            ->withAdditionalTransformation($this->mergeValuesTrafo())
            ->withAdditionalTransformation($this->saniziteArrayElementsTrafo());
    }

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

Here is the call graph for this function:

◆ mergeValuesTrafo()

ilPasswordAssistanceGUI::mergeValuesTrafo ( )

private

Definition at line 177 of file class.ilPasswordAssistanceGUI.php.

                                       : \ILIAS\Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(static function (array $values): array {
            return array_merge(...$values);
        });
    }

References ILIAS\Repository\refinery().

Referenced by getAssignPasswordForm(), and getAssistanceForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ retrieveRequestedKey()

ilPasswordAssistanceGUI::retrieveRequestedKey ( )

private

Definition at line 75 of file class.ilPasswordAssistanceGUI.php.

                                           : string
    {
        $key = $this->http->wrapper()->query()->retrieve(
            'key',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->always(
                    $this->http->wrapper()->post()->retrieve(
                        'key',
                        $this->refinery->byTrying([$this->refinery->kindlyTo()->string(), $this->refinery->always('')])
                    )
                )
            ])
        );
 
        return $key;
    }

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saniziteArrayElementsTrafo()

ilPasswordAssistanceGUI::saniziteArrayElementsTrafo ( )

private

Definition at line 184 of file class.ilPasswordAssistanceGUI.php.

                                                 : \ILIAS\Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(static function (array $values): array {
            return ilArrayUtil::stripSlashesRecursive($values);
        });
    }

References ILIAS\Repository\refinery(), and ilArrayUtil\stripSlashesRecursive().

Referenced by getAssignPasswordForm(), and getAssistanceForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendUsernameAssistanceMail()

ilPasswordAssistanceGUI::sendUsernameAssistanceMail	(	string	$email,
		array	$logins
	)

private

Parameters

list<string> $logins

Definition at line 799 of file class.ilPasswordAssistanceGUI.php.

                                                                             : void
    {
        global $DIC;
 
        $login_url = $this->buildUrl(
            'pwassist.php',
            [
                'client_id' => $this->getClientId(),
                'lang' => $this->lng->getLangKey()
            ]
        );
 
        $senderFactory = $DIC->mail()->mime()->senderFactory();
        $sender = $senderFactory->system();
 
        $mm = new ilMimeMail();
        $mm->Subject($this->lng->txt('pwassist_mail_subject'), true);
        $mm->From($sender);
        $mm->To($email);
        $mm->Body(
            $this->buildSystemMailBody(
                sprintf(
                    $this->lng->txt('pwassist_username_mail_body'),
                    implode(",\n", $logins),
                    $this->getBaseUrl() . '/',
                    $_SERVER['REMOTE_ADDR'],
                    $email,
                    'mailto:' . $this->settings->get('admin_email'),
                    $login_url
                )
            )
        );
        $mm->Send();
    }

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

Here is the call graph for this function:

◆ showAssistanceForm()

ilPasswordAssistanceGUI::showAssistanceForm ( ?ILIAS\UI\Component\Input\Container\Form\Form $form = null )

private

Definition at line 235 of file class.ilPasswordAssistanceGUI.php.

                                                                                                   : void
    {
        $this->help->setSubScreenId('password_assistance');
 
        $tpl = ilStartUpGUI::initStartUpTemplate('tpl.pwassist_assistance.html', true);
        $tpl->setVariable('TXT_PAGEHEADLINE', $this->lng->txt('password_assistance'));
        $tpl->setVariable(
            'IMG_PAGEHEADLINE',
            $this->ui_renderer->render($this->ui_factory->symbol()->icon()->custom(
                ilUtil::getImagePath('standard/icon_auth.svg'),
                $this->lng->txt('password_assistance')
            ))
        );
 
        $tpl->setVariable(
            'TXT_ENTER_USERNAME_AND_EMAIL',
            $this->ui_renderer->render(
                $this->ui_factory->messageBox()->info(
                    str_replace(
                        "\\n",
                        '<br />',
                        sprintf(
                            $this->lng->txt('pwassist_enter_username_and_email'),
                            '<a href="mailto:' . ilLegacyFormElementsUtil::prepareFormOutput(
                                $this->settings->get('admin_email')
                            ) . '">' . ilLegacyFormElementsUtil::prepareFormOutput($this->settings->get('admin_email')) . '</a>'
                        )
                    )
                )
            )
        );
 
        $tpl->setVariable('FORM', $this->ui_renderer->render($form ?? $this->getAssistanceForm()));
        $this->fillPermanentLink(self::PERMANENT_LINK_TARGET_PW);
        ilStartUpGUI::printToGlobalTemplate($tpl);
    }

References $tpl, fillPermanentLink(), ilUtil\getImagePath(), ILIAS\Repository\help(), ilStartUpGUI\initStartUpTemplate(), ILIAS\Repository\lng(), ilLegacyFormElementsUtil\prepareFormOutput(), ilStartUpGUI\printToGlobalTemplate(), and ILIAS\UICore\GlobalTemplate\setVariable().

Referenced by executeCommand(), and submitAssistanceForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showMessageForm()

ilPasswordAssistanceGUI::showMessageForm	(	string	$text,
		string	$permanent_link_context
	)

private

Definition at line 834 of file class.ilPasswordAssistanceGUI.php.

                                                                                  : void
    {
        $tpl = ilStartUpGUI::initStartUpTemplate('tpl.pwassist_message.html', true);
        $tpl->setVariable('TXT_PAGEHEADLINE', $this->lng->txt('password_assistance'));
        $tpl->setVariable(
            'IMG_PAGEHEADLINE',
            $this->ui_renderer->render($this->ui_factory->symbol()->icon()->custom(
                ilUtil::getImagePath('standard/icon_auth.svg'),
                $this->lng->txt('password_assistance')
            ))
        );
 
        $tpl->setVariable('TXT_TEXT', str_replace("\\n", '<br />', $text));
        $this->fillPermanentLink($permanent_link_context);
        ilStartUpGUI::printToGlobalTemplate($tpl);
    }

References $text, ILIAS\News\Common\Table\$tpl, ilUtil\getImagePath(), ilStartUpGUI\initStartUpTemplate(), ILIAS\Repository\lng(), ilStartUpGUI\printToGlobalTemplate(), and ILIAS\UICore\GlobalTemplate\setVariable().

Referenced by submitAssistanceForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showUsernameAssistanceForm()

ilPasswordAssistanceGUI::showUsernameAssistanceForm ( ?ILIAS\UI\Component\Input\Container\Form\Form $form = null )

private

Definition at line 715 of file class.ilPasswordAssistanceGUI.php.

                                                                                                           : void
    {
        $this->help->setSubScreenId('username_assistance');
 
        $tpl = ilStartUpGUI::initStartUpTemplate('tpl.pwassist_username_assistance.html', true);
        $tpl->setVariable('TXT_PAGEHEADLINE', $this->lng->txt('password_assistance'));
        $tpl->setVariable(
            'IMG_PAGEHEADLINE',
            $this->ui_renderer->render($this->ui_factory->symbol()->icon()->custom(
                ilUtil::getImagePath('standard/icon_auth.svg'),
                $this->lng->txt('password_assistance')
            ))
        );
 
        $tpl->setVariable(
            'TXT_ENTER_USERNAME_AND_EMAIL',
            $this->ui_renderer->render(
                $this->ui_factory->messageBox()->info(
                    str_replace(
                        "\\n",
                        '<br />',
                        sprintf(
                            $this->lng->txt('pwassist_enter_email'),
                            '<a href="mailto:' . ilLegacyFormElementsUtil::prepareFormOutput(
                                $this->settings->get('admin_email')
                            ) . '">' . ilLegacyFormElementsUtil::prepareFormOutput($this->settings->get('admin_email')) . '</a>'
                        )
                    )
                )
            )
        );
 
        $tpl->setVariable('FORM', $this->ui_renderer->render($form ?? $this->getUsernameAssistanceForm()));
        $this->fillPermanentLink(self::PERMANENT_LINK_TARGET_NAME);
        ilStartUpGUI::printToGlobalTemplate($tpl);
    }

References ILIAS\News\Common\Table\$tpl, ilUtil\getImagePath(), ILIAS\Repository\help(), ilStartUpGUI\initStartUpTemplate(), ILIAS\Repository\lng(), ilLegacyFormElementsUtil\prepareFormOutput(), ilStartUpGUI\printToGlobalTemplate(), and ILIAS\UICore\GlobalTemplate\setVariable().

Here is the call graph for this function:

◆ submitAssistanceForm()

ilPasswordAssistanceGUI::submitAssistanceForm ( )

private

If the submitted username and email address matches an entry in the user data table, then ILIAS creates a password assistance session for the user, and sends a password assistance mail to the email address.

For details about the creation of the session and the e-mail see function sendPasswordAssistanceMail().

Definition at line 279 of file class.ilPasswordAssistanceGUI.php.

                                           : void
    {
        $form = $this->getAssistanceForm();
        $form_valid = false;
        $form_data = null;
        if ($this->http->request()->getMethod() === 'POST') {
            $form = $form->withRequest($this->http->request());
            $form_data = $form->getData();
            $form_valid = $form_data !== null;
        }
 
        if (!$form_valid) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('form_input_not_valid'));
            $this->showAssistanceForm($form);
            return;
        }
 
        $defaultAuth = ilAuthUtils::AUTH_LOCAL;
        if ($GLOBALS['DIC']['ilSetting']->get('auth_mode')) {
            $defaultAuth = $GLOBALS['DIC']['ilSetting']->get('auth_mode');
        }
 
        $username = $form_data[self::PROP_USERNAME];
        $email = $form_data[self::PROP_EMAIL];
 
        $assistance_callback = function () use ($defaultAuth, $username, $email): void {
            $usr_id = ilObjUser::getUserIdByLogin($username);
            if (!is_numeric($usr_id) || !($usr_id > 0)) {
                ilLoggerFactory::getLogger('usr')->info(
                    sprintf(
                        'Could not process password assistance form (reason: no user found) %s / %s',
                        $username,
                        $email
                    )
                );
                return;
            }
 
            $user = new ilObjUser($usr_id);
            $email_addresses = array_map('strtolower', array_filter([$user->getEmail(), $user->getSecondEmail()]));
 
            if (!in_array(strtolower($email), $email_addresses, true)) {
                if (implode('', $email_addresses) === '') {
                    ilLoggerFactory::getLogger('usr')->info(
                        sprintf(
                            'Could not process password assistance form (reason: account without email addresses): %s / %s',
                            $username,
                            $email
                        )
                    );
                } else {
                    ilLoggerFactory::getLogger('usr')->info(
                        sprintf(
                            'Could not process password assistance form (reason: account email addresses differ from input): %s / %s',
                            $username,
                            $email
                        )
                    );
                }
            } elseif (
                (
                    $user->getAuthMode(true) != ilAuthUtils::AUTH_LOCAL ||
                    ($user->getAuthMode(true) == $defaultAuth && $defaultAuth != ilAuthUtils::AUTH_LOCAL)
                ) && !(
                    (int) $user->getAuthMode(true) === ilAuthUtils::AUTH_SAML &&
                    \ilAuthUtils::isLocalPasswordEnabledForAuthMode($user->getAuthMode(true))
                )
            ) {
                ilLoggerFactory::getLogger('usr')->info(
                    sprintf(
                        'Could not process password assistance form (reason: not permitted for accounts using external authentication sources): %s / %s',
                        $username,
                        $email
                    )
                );
            } elseif ($this->rbacreview->isAssigned($user->getId(), ANONYMOUS_ROLE_ID) ||
                $this->rbacreview->isAssigned($user->getId(), SYSTEM_ROLE_ID)) {
                ilLoggerFactory::getLogger('usr')->info(
                    sprintf(
                        'Could not process password assistance form (reason: not permitted for system user or anonymous): %s / %s',
                        $username,
                        $email
                    )
                );
            } else {
                $this->sendPasswordAssistanceMail($user);
            }
        };
 
        if (($assistance_duration = $this->settings->get('account_assistance_duration')) !== null) {
            $duration = $this->http->durations()->callbackDuration((int) $assistance_duration);
            $status = $duration->stretch($assistance_callback);
        } else {
            $status = $assistance_callback();
        }
 
        $this->showMessageForm(sprintf($this->lng->txt('pwassist_mail_sent'), $email), self::PERMANENT_LINK_TARGET_PW);
    }

References $duration, $GLOBALS, ANONYMOUS_ROLE_ID, ilAuthUtils\AUTH_LOCAL, ilAuthUtils\AUTH_SAML, getAssistanceForm(), ilLoggerFactory\getLogger(), ilObjUser\getUserIdByLogin(), ILIAS\FileDelivery\http(), ilAuthUtils\isLocalPasswordEnabledForAuthMode(), ILIAS\Repository\lng(), PROP_EMAIL, PROP_USERNAME, ILIAS\Repository\settings(), showAssistanceForm(), showMessageForm(), and SYSTEM_ROLE_ID.

Here is the call graph for this function:

◆ submitUsernameAssistanceForm()

ilPasswordAssistanceGUI::submitUsernameAssistanceForm ( )

private

Definition at line 752 of file class.ilPasswordAssistanceGUI.php.

                                                   : void
    {
        $form = $this->getUsernameAssistanceForm();
        $form_valid = false;
        $form_data = null;
        if ($this->http->request()->getMethod() === 'POST') {
            $form = $form->withRequest($this->http->request());
            $form_data = $form->getData();
            $form_valid = $form_data !== null;
        }
 
        if (!$form_valid) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('form_input_not_valid'));
            $this->showUsernameAssistanceForm($form);
            return;
        }
 
        $email = trim($form_data[self::PROP_EMAIL]);
 
        $assistance_callback = function () use ($email): void {
            $logins = ilObjUser::getUserLoginsByEmail($email);
 
            if (is_array($logins) && count($logins) > 0) {
                $this->sendUsernameAssistanceMail($email, $logins);
            } else {
                ilLoggerFactory::getLogger('usr')->info(
                    sprintf(
                        'Could not sent username assistance emails to (reason: no user found): %s',
                        $email
                    )
                );
            }
        };
 
        if (($assistance_duration = $this->settings->get('account_assistance_duration')) !== null) {
            $duration = $this->http->durations()->callbackDuration((int) $assistance_duration);
            $status = $duration->stretch($assistance_callback);
        } else {
            $status = $assistance_callback();
        }
 
        $this->showMessageForm($this->lng->txt('pwassist_mail_sent_generic'), self::PERMANENT_LINK_TARGET_NAME);
    }

References $duration, ilLoggerFactory\getLogger(), ilObjUser\getUserLoginsByEmail(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ trimIfStringTrafo()

ilPasswordAssistanceGUI::trimIfStringTrafo ( )

private

Definition at line 191 of file class.ilPasswordAssistanceGUI.php.

                                        : \ILIAS\Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(static function ($value) {
            if (is_string($value)) {
                $value = trim($value);
            }
 
            return $value;
        });
    }