ilPasswordAssistanceGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

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...
	showAssistanceForm (ilPropertyFormGUI $form=null)
	submitAssistanceForm ()
	Reads the submitted data from the password assistance form. More...
	showAssignPasswordForm (ilPropertyFormGUI $form=null, string $pwassist_id='')
	Assign password form. More...
	submitAssignPasswordForm ()
	Reads the submitted data from the password assistance form. More...
	showUsernameAssistanceForm (ilPropertyFormGUI $form=null)
	Shows the password assistance form. More...
	submitUsernameAssistanceForm ()
	Reads the submitted data from the password assistance form. More...
	showMessageForm (string $text, string $permanent_link_context)
	This form is used to show a message to the user. More...

Protected Member Functions
	getClientId ()
	as replacement for "this->ilias" More...
	getBaseUrl ()
	Returns the ILIAS http path without a trailing /. More...
	buildUrl (string $script, array $queryParameters)
	getAssistanceForm ()
	getAssignPasswordForm (string $pwassist_id)
	getUsernameAssistanceForm ()
	fillPermanentLink (string $context)

Protected Attributes
ilCtrlInterface	$ctrl
ilLanguage	$lng
ilRbacReview	$rbacreview
ilGlobalTemplateInterface	$tpl
ilSetting	$settings
ilErrorHandling	$ilErr
RefineryFactory	$refinery
HTTPServices	$http
ilHelpGUI	$help
ilObjUser	$actor

Private Member Functions
	retrieveRequestedKey ()

Private Attributes
const	PERMANENT_LINK_TARGET_PW = 'pwassist'
const	PERMANENT_LINK_TARGET_NAME = 'nameassist'
ILIAS UI Factory	$ui_factory
ILIAS UI Renderer	$ui_renderer

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Password assistance facility for users who have forgotten their password or for users for whom no password has been assigned yet.

Author

Werner Randelshofer wrand.nosp@m.els@.nosp@m.hsw.f.nosp@m.hz.c.nosp@m.h

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

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

Constructor & Destructor Documentation

__construct()

ilPasswordAssistanceGUI::__construct

(

)

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

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

    {
        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->actor = $DIC->user();
        $this->refinery = $DIC->refinery();
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();

        $this->help->setScreenIdComponent('init');
    }

Here is the call graph for this function:

Member Function Documentation

buildUrl()

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

protected

Parameters

string	$script
array	$queryParameters

Returns

string

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

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

Referenced by submitAssistanceForm(), and submitUsernameAssistanceForm().

                                                                       : string
    {
        $url = implode('/', [
            $this->getBaseUrl(),
            ltrim($script, '/')
        ]);

        $url = \ilUtil::appendUrlParameterString(
            $url,
            http_build_query($queryParameters, null, '&')
        );

        return $url;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPasswordAssistanceGUI::executeCommand

(

)

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

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

    {
        if (!$this->settings->get('setup_ok')) {
            $this->ilErr->raiseError('Setup is not completed. Please run setup routine again.', $this->ilErr->FATAL);
        }

        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;
        }
    }

Here is the call graph for this function:

fillPermanentLink()

ilPasswordAssistanceGUI::fillPermanentLink ( string  $context )

protected

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

Referenced by showAssignPasswordForm(), showAssistanceForm(), showMessageForm(), and showUsernameAssistanceForm().

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

Here is the caller graph for this function:

getAssignPasswordForm()

ilPasswordAssistanceGUI::getAssignPasswordForm ( string  $pwassist_id )

protected

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

References ILIAS\LTI\ToolProvider\$key, ILIAS\Repository\ctrl(), ilSecuritySettingsChecker\getPasswordRequirementsInfo(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setInfo().

Referenced by showAssignPasswordForm(), and submitAssignPasswordForm().

                                                                 : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, 'submitAssignPasswordForm'));
        $form->setTarget('_parent');

        $username = new ilTextInputGUI($this->lng->txt('username'), 'username');
        $username->setRequired(true);
        $form->addItem($username);

        $password = new ilPasswordInputGUI($this->lng->txt('password'), 'password');
        $password->setInfo(ilSecuritySettingsChecker::getPasswordRequirementsInfo());
        $password->setRequired(true);
        $password->setUseStripSlashes(false);
        $form->addItem($password);

        $key = new ilHiddenInputGUI('key');
        $key->setValue($pwassist_id);
        $form->addItem($key);
        $form->addCommandButton('submitAssignPasswordForm', $this->lng->txt('submit'));
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAssistanceForm()

ilPasswordAssistanceGUI::getAssistanceForm ( )

protected

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

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

Referenced by showAssistanceForm(), and submitAssistanceForm().

                                          : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();

        $form->setFormAction($this->ctrl->getFormAction($this, 'submitAssistanceForm'));
        $form->setTarget('_parent');

        $username = new ilTextInputGUI($this->lng->txt('username'), 'username');
        $username->setRequired(true);
        $form->addItem($username);

        $email = new ilEMailInputGUI($this->lng->txt('email'), 'email');
        $email->setRequired(true);
        $form->addItem($email);

        $form->addCommandButton('submitAssistanceForm', $this->lng->txt('submit'));
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getBaseUrl()

ilPasswordAssistanceGUI::getBaseUrl ( )

protected

Returns the ILIAS http path without a trailing /.

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

Referenced by buildUrl(), submitAssistanceForm(), and submitUsernameAssistanceForm().

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

Here is the caller graph for this function:

getClientId()

ilPasswordAssistanceGUI::getClientId ( )

protected

as replacement for "this->ilias"

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

References CLIENT_ID.

Referenced by submitAssistanceForm(), and submitUsernameAssistanceForm().

                                    : string
    {
        return CLIENT_ID;
    }

Here is the caller graph for this function:

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 132 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 127 of file class.ilPasswordAssistanceGUI.php.

                                          : array
    {
        return [];
    }

getUsernameAssistanceForm()

ilPasswordAssistanceGUI::getUsernameAssistanceForm ( )

protected

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

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

Referenced by showUsernameAssistanceForm(), and submitUsernameAssistanceForm().

                                                  : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();

        $form->setFormAction($this->ctrl->getFormAction($this, 'submitUsernameAssistanceForm'));
        $form->setTarget('_parent');

        $email = new ilTextInputGUI($this->lng->txt('email'), 'email');
        $email->setRequired(true);
        $form->addItem($email);

        $form->addCommandButton('submitUsernameAssistanceForm', $this->lng->txt('submit'));
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

retrieveRequestedKey()

ilPasswordAssistanceGUI::retrieveRequestedKey ( )

private

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

References ILIAS\LTI\ToolProvider\$key, ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by executeCommand().

                                           : 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showAssignPasswordForm()

ilPasswordAssistanceGUI::showAssignPasswordForm	(	ilPropertyFormGUI	$form = null,
		string	$pwassist_id = ''
	)

Assign password form.

This form is used to assign a password to a username. To use this form, the following data must be provided as HTTP GET parameter, or in argument pwassist_id: key The key is used to retrieve the password assistance session. If the key is missing, or if the password assistance session has expired, the password assistance form will be shown instead of this form.

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

References db_pwassist_session_read(), fillPermanentLink(), getAssignPasswordForm(), ilUtil\getImagePath(), ILIAS\Repository\help(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ilStartUpGUI\printToGlobalTemplate(), ILIAS\Repository\refinery(), ilGlobalTemplateInterface\setVariable(), and showAssistanceForm().

Referenced by executeCommand(), and submitAssignPasswordForm().

                                                                                                    : void
    {
        $this->help->setSubScreenId('password_input');

        // Retrieve form data
        if (!$pwassist_id) {
            if ($this->http->wrapper()->query()->has('key')) {
                $pwassist_id = $this->http->wrapper()->query()->retrieve(
                    'key',
                    $this->refinery->kindlyTo()->string()
                );
            }
        }

        // Retrieve the session, and check if it is valid
        require_once 'include/inc.pwassist_session_handler.php';
        $pwassist_session = db_pwassist_session_read($pwassist_id);
        if (
            !is_array($pwassist_session) ||
            count($pwassist_session) == 0 ||
            $pwassist_session['expires'] < time()
        ) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('pwassist_session_expired'));
            $this->showAssistanceForm(null);
        } else {
            $tpl = ilStartUpGUI::initStartUpTemplate('tpl.pwassist_assignpassword.html', true);
            $tpl->setVariable(
                'IMG_PAGEHEADLINE',
                $this->ui_renderer->render($this->ui_factory->symbol()->icon()->custom(
                    ilUtil::getImagePath('icon_auth.svg'),
                    $this->lng->txt('password_assistance')
                ))
            );
            $tpl->setVariable('TXT_PAGEHEADLINE', $this->lng->txt('password_assistance'));

            $tpl->setVariable(
                'TXT_ENTER_USERNAME_AND_NEW_PASSWORD',
                $this->lng->txt('pwassist_enter_username_and_new_password')
            );

            if (!$form) {
                $form = $this->getAssignPasswordForm($pwassist_id);
            }
            $tpl->setVariable('FORM', $form->getHTML());
            $this->fillPermanentLink(self::PERMANENT_LINK_TARGET_PW);
            ilStartUpGUI::printToGlobalTemplate($tpl);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showAssistanceForm()

ilPasswordAssistanceGUI::showAssistanceForm

(

ilPropertyFormGUI

$form = null

)

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

References fillPermanentLink(), getAssistanceForm(), ilUtil\getImagePath(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ilLegacyFormElementsUtil\prepareFormOutput(), ilStartUpGUI\printToGlobalTemplate(), ILIAS\Repository\settings(), and ilGlobalTemplateInterface\setVariable().

Referenced by executeCommand(), showAssignPasswordForm(), submitAssignPasswordForm(), and submitAssistanceForm().

                                                                      : void
    {
        $this->help->setSubScreenId('password_assistance');

        $tpl = ilStartUpGUI::initStartUpTemplate('tpl.pwassist_assistance.html', true);
        $tpl->setVariable(
            'IMG_PAGEHEADLINE',
            $this->ui_renderer->render($this->ui_factory->symbol()->icon()->custom(
                ilUtil::getImagePath('icon_auth.svg'),
                $this->lng->txt('password_assistance')
            ))
        );
        $tpl->setVariable('TXT_PAGEHEADLINE', $this->lng->txt('password_assistance'));

        $tpl->setVariable(
            'TXT_ENTER_USERNAME_AND_EMAIL',
            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>'
                )
            )
        );

        if (!$form) {
            $form = $this->getAssistanceForm();
        }
        $tpl->setVariable('FORM', $form->getHTML());
        $this->fillPermanentLink(self::PERMANENT_LINK_TARGET_PW);
        ilStartUpGUI::printToGlobalTemplate($tpl);
    }

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
	)

This form is used to show a message to the user.

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

References fillPermanentLink(), ilUtil\getImagePath(), ILIAS\Repository\lng(), ilStartUpGUI\printToGlobalTemplate(), and ilGlobalTemplateInterface\setVariable().

Referenced by submitAssignPasswordForm(), submitAssistanceForm(), and submitUsernameAssistanceForm().

                                                                                 : 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('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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showUsernameAssistanceForm()

ilPasswordAssistanceGUI::showUsernameAssistanceForm

(

ilPropertyFormGUI

$form = null

)

Shows the password assistance form.

This form is used to request a password assistance mail from ILIAS. This form contains the following fields: username email When the user submits the form, then this script is invoked with the cmd 'submitAssistanceForm'.

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

References fillPermanentLink(), ilUtil\getImagePath(), getUsernameAssistanceForm(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ilLegacyFormElementsUtil\prepareFormOutput(), ilStartUpGUI\printToGlobalTemplate(), ILIAS\Repository\settings(), and ilGlobalTemplateInterface\setVariable().

Referenced by submitUsernameAssistanceForm().

                                                                              : void
    {
        $this->help->setSubScreenId('username_assistance');

        $tpl = ilStartUpGUI::initStartUpTemplate('tpl.pwassist_username_assistance.html', true);
        $tpl->setVariable(
            'IMG_PAGEHEADLINE',
            $this->ui_renderer->render($this->ui_factory->symbol()->icon()->custom(
                ilUtil::getImagePath('icon_auth.svg'),
                $this->lng->txt('password_assistance')
            ))
        );
        $tpl->setVariable('TXT_PAGEHEADLINE', $this->lng->txt('password_assistance'));

        $tpl->setVariable(
            'TXT_ENTER_USERNAME_AND_EMAIL',
            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>'
                )
            )
        );

        if (!$form) {
            $form = $this->getUsernameAssistanceForm();
        }
        $tpl->setVariable('FORM', $form->getHTML());
        $this->fillPermanentLink(self::PERMANENT_LINK_TARGET_NAME);
        ilStartUpGUI::printToGlobalTemplate($tpl);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

submitAssignPasswordForm()

ilPasswordAssistanceGUI::submitAssignPasswordForm

(

)

Reads the submitted data from the password assistance form.

The following form fields are read as HTTP POST parameters: key username password1 password2 The key is used to retrieve the password assistance session. If the key is missing, or if the password assistance session has expired, the password assistance form will be shown instead of this form. If the password assistance session is valid, and if the username matches the username, for which the password assistance has been requested, and if the new password is valid, ILIAS assigns the password to the user. Note: To prevent replay attacks, the session is deleted when the password has been assigned successfully.

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

References $message, db_pwassist_session_destroy(), db_pwassist_session_read(), getAssignPasswordForm(), ilObjectFactory\getInstanceByObjId(), ilObjUser\getLogin(), ilSecuritySettingsChecker\isPasswordValidForUserContext(), ILIAS\Repository\lng(), ilObjUser\resetPassword(), ilObjUser\setLastPasswordChangeToNow(), showAssignPasswordForm(), showAssistanceForm(), showMessageForm(), ilUtil\stripSlashes(), and ilObjUser\update().

                                              : void
    {
        require_once 'include/inc.pwassist_session_handler.php';

        // We need to fetch this before form instantiation
        $pwassist_id = ilUtil::stripSlashes($_POST['key']);

        $form = $this->getAssignPasswordForm($pwassist_id);
        if (!$form->checkInput()) {
            $form->setValuesByPost();
            $this->showAssignPasswordForm($form, $pwassist_id);
            return;
        }

        $username = trim($form->getInput('username'));
        $password = trim($form->getInput('password'));
        $pwassist_id = $form->getInput('key');

        // Retrieve the session
        $pwassist_session = db_pwassist_session_read($pwassist_id);

        if (
            !is_array($pwassist_session) ||
            count($pwassist_session) == 0 ||
            $pwassist_session['expires'] < time()
        ) {
            $this->tpl->setOnScreenMessage('failure', str_replace("\\n", '', $this->lng->txt('pwassist_session_expired')));
            $form->setValuesByPost();
            $this->showAssistanceForm($form);
            return;
        } else {
            $is_successful = true;
            $message = '';

            $userObj = \ilObjectFactory::getInstanceByObjId($pwassist_session['user_id'], false);
            if (!$userObj || !($userObj instanceof \ilObjUser)) {
                $message = $this->lng->txt('user_does_not_exist');
                $is_successful = false;
            }

            // check if the username entered by the user matches the
            // one of the user object.
            if ($is_successful && strcasecmp($userObj->getLogin(), $username) != 0) {
                $message = $this->lng->txt('pwassist_login_not_match');
                $is_successful = false;
            }

            $error_lng_var = '';
            if (!ilSecuritySettingsChecker::isPasswordValidForUserContext($password, $userObj, $error_lng_var)) {
                $message = $this->lng->txt($error_lng_var);
                $is_successful = false;
            }

            // End of validation
            // If the validation was successful, we change the password of the
            // user.
            // ------------------
            if ($is_successful) {
                $is_successful = $userObj->resetPassword($password, $password);
                if (!$is_successful) {
                    $message = $this->lng->txt('passwd_invalid');
                }
            }

            // If we are successful so far, we update the user object.
            // ------------------
            if ($is_successful) {
                $userObj->setLastPasswordChangeToNow();
                $userObj->update();
            }

            // If we are successful, we destroy the password assistance
            // session and redirect to the login page.
            // Else we display the form again along with an error message.
            // ------------------
            if ($is_successful) {
                db_pwassist_session_destroy($pwassist_id);
                $this->showMessageForm(
                    sprintf($this->lng->txt('pwassist_password_assigned'), $username),
                    self::PERMANENT_LINK_TARGET_PW
                );
            } else {
                $this->tpl->setOnScreenMessage('failure', str_replace("\\n", '', $message));
                $form->setValuesByPost();
                $this->showAssignPasswordForm($form, $pwassist_id);
            }
        }
    }

Here is the call graph for this function:

submitAssistanceForm()

ilPasswordAssistanceGUI::submitAssistanceForm

(

)

Reads the submitted data from the password assistance form.

The following form fields are read as HTTP POST parameters: username email 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 231 of file class.ilPasswordAssistanceGUI.php.

References $_SERVER, $DIC, $email, $GLOBALS, ANONYMOUS_ROLE_ID, ilAuthUtils\AUTH_LOCAL, ilAuthUtils\AUTH_SAML, buildUrl(), db_pwassist_create_id(), db_pwassist_session_write(), getAssistanceForm(), getBaseUrl(), getClientId(), ilObjUser\getEmail(), ilObject\getId(), ilLoggerFactory\getLogger(), ilObjUser\getLogin(), ilObjUser\getUserIdByLogin(), ILIAS\FileDelivery\http(), ILIAS\Repository\int(), ilAuthUtils\isLocalPasswordEnabledForAuthMode(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), showAssistanceForm(), showMessageForm(), and SYSTEM_ROLE_ID.

                                          : void
    {
        $form = $this->getAssistanceForm();
        if (!$form->checkInput()) {
            $form->setValuesByPost();
            $this->showAssistanceForm($form);
            return;
        }

        $defaultAuth = ilAuthUtils::AUTH_LOCAL;
        if ($GLOBALS['DIC']['ilSetting']->get('auth_mode')) {
            $defaultAuth = $GLOBALS['DIC']['ilSetting']->get('auth_mode');
        }

        $assistance_callback = function () use ($form, $defaultAuth): void {
            $username = trim($form->getInput('username'));
            $email = trim($form->getInput('email'));

            $usrId = \ilObjUser::getUserIdByLogin($username);
            if (!is_numeric($usrId) || !($usrId > 0)) {
                \ilLoggerFactory::getLogger('usr')->info(
                    sprintf(
                        'Could not process password assistance form (reason: no user found) %s / %s',
                        $username,
                        $email
                    )
                );

                return;
            }

            $user = new \ilObjUser($usrId);
            $emailAddresses = array_map('strtolower', [$user->getEmail(), $user->getSecondEmail()]);

            if (!in_array(strtolower($email), $emailAddresses)) {
                if (0 === strlen(implode('', $emailAddresses))) {
                    \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 (null !== ($assistance_duration = $this->settings->get("account_assistance_duration"))) {
            $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'), $form->getInput('email')),
            self::PERMANENT_LINK_TARGET_PW
        );
    }

Here is the call graph for this function:

submitUsernameAssistanceForm()

ilPasswordAssistanceGUI::submitUsernameAssistanceForm

(

)

Reads the submitted data from the password assistance form.

The following form fields are read as HTTP POST parameters: username email 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 652 of file class.ilPasswordAssistanceGUI.php.

References $_SERVER, $DIC, $email, buildUrl(), getBaseUrl(), getClientId(), ilLoggerFactory\getLogger(), ilObjUser\getUserLoginsByEmail(), getUsernameAssistanceForm(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), showMessageForm(), and showUsernameAssistanceForm().

                                                  : void
    {
        $form = $this->getUsernameAssistanceForm();
        if (!$form->checkInput()) {
            $form->setValuesByPost();
            $this->showUsernameAssistanceForm($form);

            return;
        }

        $assistance_callback = function () use ($form): void {
            $email = trim($form->getInput('email'));
            $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 (null !== ($assistance_duration = $this->settings->get("account_assistance_duration"))) {
            $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);
    }

Here is the call graph for this function:

Field Documentation

$actor

ilObjUser ilPasswordAssistanceGUI::$actor

protected

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

$ctrl

ilCtrlInterface ilPasswordAssistanceGUI::$ctrl

protected

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

$help

ilHelpGUI ilPasswordAssistanceGUI::$help

protected

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

$http

HTTPServices ilPasswordAssistanceGUI::$http

protected

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

$ilErr

ilErrorHandling ilPasswordAssistanceGUI::$ilErr

protected

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

$lng

ilLanguage ilPasswordAssistanceGUI::$lng

protected

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

$rbacreview

ilRbacReview ilPasswordAssistanceGUI::$rbacreview

protected

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

$refinery

RefineryFactory ilPasswordAssistanceGUI::$refinery

protected

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

$settings

ilSetting ilPasswordAssistanceGUI::$settings

protected

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

$tpl

ilGlobalTemplateInterface ilPasswordAssistanceGUI::$tpl

protected

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

$ui_factory

ILIAS UI Factory ilPasswordAssistanceGUI::$ui_factory

private

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

$ui_renderer

ILIAS UI Renderer ilPasswordAssistanceGUI::$ui_renderer

private

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

PERMANENT_LINK_TARGET_NAME

const ilPasswordAssistanceGUI::PERMANENT_LINK_TARGET_NAME = 'nameassist'

private

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

PERMANENT_LINK_TARGET_PW

const ilPasswordAssistanceGUI::PERMANENT_LINK_TARGET_PW = 'pwassist'

private

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

---

The documentation for this class was generated from the following file:

• Services/Init/classes/class.ilPasswordAssistanceGUI.php