ilStartUpGUI Class Reference

ilStartUpGUI: ilAccountRegistrationGUI, ilPasswordAssistanceGUI, ilLoginPageGUI, ilDashboardGUI ilStartUpGUI: ilMembershipOverviewGUI, ilDerivedTasksGUI, ilAccessibilityControlConceptGUI ilStartUpGUI: ilLogoutPageGUI More...

Inheritance diagram for ilStartUpGUI:

Collaboration diagram for ilStartUpGUI:

Public Member Functions
	__construct (ilObjUser $user=null, ilGlobalTemplateInterface $mainTemplate=null, ServerRequestInterface $httpRequest=null)
	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...
	getSafePostCommands ()
	This method must return a list of safe POST commands. More...
	executeCommand ()

Static Public Member Functions
static	setForcedCommand (string $cmd)
static	printToGlobalTemplate ($tpl)
static	initStartUpTemplate ( $a_tmpl, bool $a_show_back=false, bool $a_show_logout=false)
	This method enriches the global template with some user interface elements (language selection, headlines, back buttons, ...) for public service views. More...
static	logoutUrl (array $parameters=[])
	Return the logout URL with a valid CSRF token. More...

Protected Member Functions
	showLegalDocuments ()

Private Member Functions
	checkForcedCommand (string $cmd)
	mergeValuesTrafo ()
	saniziteArrayElementsTrafo ()
	initTargetFromQuery ()
	getLogger ()
	jumpToRegistration ()
	jumpToPasswordAssistance ()
	showLoginPageOrStartupPage ()
	showLoginPage (ILIAS\UI\Component\Input\Container\Form\Form $form=null)
	retrieveMessagesFromSession ()
	showCodeForm (string $username=null, ILIAS\UI\Component\Input\Container\Form\Form $form=null)
	buildCodeForm (string $username=null)
	processCode ()
	buildStandardLoginForm ()
	doCasAuthentication ()
	doLTIAuthentication ()
	doApacheAuthentication ()
	doStandardAuthentication ()
	showLoginForm (string $page_editor_html, ILIAS\UI\Component\Input\Container\Form\Form $form=null)
	showLoginInformation (string $page_editor_html, ilGlobalTemplateInterface $tpl)
	showCASLoginForm (string $page_editor_html)
	showShibbolethLoginForm (string $page_editor_html)
	substituteLoginPageElements ( $tpl, string $page_editor_html, string $element_html, string $placeholder, string $fallback_tplvar)
	getAuthPageEditorHtml (AuthPageEditorContext $ipe_context)
	showRegistrationLinks (string $page_editor_html)
	showLegalDocumentsLinks (string $page_editor_html)
	purgePlaceholders (string $page_editor_html)
	buildAccountMigrationForm ()
	showAccountMigration (ILIAS\UI\Component\Input\Container\Form\Form $form=null, string $message='')
	migrateAccount ()
	doMigrationNewAccount ()
	doMigration (array $migration_request_data)
	showLogout ()
	processIndexPHP ()
	showSamlLoginForm (string $page_editor_html)
	showOpenIdConnectLoginForm (string $page_editor_html)
	doOpenIdConnectAuthentication ()
	doSamlAuthentication ()
	showSamlIdpSelection (ilSamlAuth $auth, array $idps)

Private Attributes
const	PROP_USERNAME = 'username'
const	PROP_PASSWORD = 'password'
const	PROP_AUTH_MODE = 'auth_mode'
const	PROP_CODE = 'code'
const	PROP_ACCOUNT_MIGRATION = 'account_migration'
const	PROP_ACCOUNT_MIGRATION_NEW = 'account_migration_new'
const	PROP_ACCOUNT_MIGRATION_MIGRATE = 'account_migration_migrate'
ilCtrlInterface	$ctrl
ilLanguage	$lng
ilLogger	$logger
ilGlobalTemplateInterface	$mainTemplate
ilObjUser	$user
ServerRequestInterface	$httpRequest
ILIAS DI Container	$dic
ilAuthSession	$authSession
ilAppEventHandler	$eventHandler
ilSetting	$setting
ilAccessHandler	$access
RefineryFactory	$refinery
HTTPServices	$http
ilHelpGUI	$help
ILIAS UI Factory	$ui_factory
ILIAS UI Renderer	$ui_renderer

Static Private Attributes
static string	$forced_cmd = ''

Detailed Description

ilStartUpGUI: ilAccountRegistrationGUI, ilPasswordAssistanceGUI, ilLoginPageGUI, ilDashboardGUI ilStartUpGUI: ilMembershipOverviewGUI, ilDerivedTasksGUI, ilAccessibilityControlConceptGUI ilStartUpGUI: ilLogoutPageGUI

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

Constructor & Destructor Documentation

__construct()

ilStartUpGUI::__construct	(	ilObjUser	$user = null,
		ilGlobalTemplateInterface	$mainTemplate = null,
		ServerRequestInterface	$httpRequest = null
	)

Definition at line 66 of file class.ilStartUpGUI.php.

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilLoggerFactory\getLogger(), ILIAS\Repository\help(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), ILIAS\Repository\mainTemplate(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

      {
        global $DIC;

        $this->dic = $DIC;

        $this->user = $user ?? $DIC->user();
        $this->mainTemplate = $mainTemplate ?? $DIC->ui()->mainTemplate();
        $this->httpRequest = $httpRequest ?? $DIC->http()->request();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('auth');
        $this->logger = ilLoggerFactory::getLogger('init');
        $this->authSession = $DIC['ilAuthSession'];
        $this->eventHandler = $DIC->event();
        $this->setting = $DIC->settings();
        $this->access = $DIC->access();
        $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->ctrl->saveParameter($this, ['rep_ref_id', 'lang', 'target', 'client_id']);
        $this->user->setLanguage($this->lng->getLangKey());
        $this->help->setScreenIdComponent('init');
    }

Here is the call graph for this function:

Member Function Documentation

buildAccountMigrationForm()

ilStartUpGUI::buildAccountMigrationForm ( )

private

Definition at line 1096 of file class.ilStartUpGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), mergeValuesTrafo(), ILIAS\Repository\refinery(), saniziteArrayElementsTrafo(), and ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation().

Referenced by migrateAccount().

                                                : ILIAS\UI\Component\Input\Container\Form\Form
    {
        $field_factory = $this->ui_factory->input()->field();

        $keep = $field_factory->group(
            [
                self::PROP_USERNAME => $field_factory->text($this->lng->txt('login'))->withRequired(true),
                self::PROP_PASSWORD => $field_factory
                    ->password($this->lng->txt('password'))
                    ->withRequired(true)
                    ->withRevelation(true)
                    ->withAdditionalTransformation(
                        $this->refinery->custom()->transformation(
                            static function (ILIAS\Data\Password $value): string {
                                return $value->toString();
                            }
                        )
                    ),
            ],
            $this->lng->txt('auth_account_migration_keep'),
            $this->lng->txt('auth_info_migrate')
        );

        $new = $field_factory->group(
            [],
            $this->lng->txt('auth_account_migration_new'),
            $this->lng->txt('auth_info_add')
        );

        $fields = [
            self::PROP_ACCOUNT_MIGRATION => $field_factory->switchableGroup(
                [
                    self::PROP_ACCOUNT_MIGRATION_MIGRATE => $keep,
                    self::PROP_ACCOUNT_MIGRATION_NEW => $new,
                ],
                $this->lng->txt('auth_account_migration_name')
            )->withRequired(true)->withValue(self::PROP_ACCOUNT_MIGRATION_MIGRATE)
        ];

        $sections = [$field_factory->section($fields, $this->lng->txt('auth_account_migration'))];

        return $this->ui_factory->input()
                                ->container()
                                ->form()
                                ->standard($this->ctrl->getFormAction($this, 'migrateAccount'), $sections)
                                ->withDedicatedName('login_form')
                                ->withSubmitLabel($this->lng->txt('save'))
                                ->withAdditionalTransformation($this->mergeValuesTrafo())
                                ->withAdditionalTransformation($this->saniziteArrayElementsTrafo());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildCodeForm()

ilStartUpGUI::buildCodeForm ( string  $username = null )

private

Definition at line 400 of file class.ilStartUpGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), mergeValuesTrafo(), saniziteArrayElementsTrafo(), and ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation().

Referenced by doStandardAuthentication(), and processCode().

                                                           : ILIAS\UI\Component\Input\Container\Form\Form
    {
        $this->lng->loadLanguageModule('auth');

        $field_factory = $this->ui_factory->input()->field();

        $username_field = $field_factory
            ->hidden()
            ->withRequired(true);
        if ($username !== null) {
            $username_field = $username_field->withValue($username);
        }

        return $this->ui_factory
            ->input()
            ->container()
            ->form()
            ->standard(
                $this->ctrl->getFormAction($this, 'processCode'),
                [
                    $field_factory->section(
                        [
                            self::PROP_CODE => $field_factory
                                ->text(
                                    $this->lng->txt('auth_account_code'),
                                    $this->lng->txt('auth_account_code_info')
                                )
                                ->withRequired(true),
                            // #11658
                            self::PROP_USERNAME => $username_field,
                        ],
                        $this->lng->txt('auth_account_code_title'),
                    ),
                ]
            )
            ->withSubmitLabel($this->lng->txt('send'))
            ->withAdditionalTransformation($this->mergeValuesTrafo())
            ->withAdditionalTransformation($this->saniziteArrayElementsTrafo());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildStandardLoginForm()

ilStartUpGUI::buildStandardLoginForm ( )

private

Definition at line 519 of file class.ilStartUpGUI.php.

References $lng, ilAuthModeDetermination\_getInstance(), ilAuthUtils\_getMultipleAuthModeOptions(), ilAuthUtils\_hasMultipleAuthenticationMethods(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), mergeValuesTrafo(), ILIAS\Repository\refinery(), saniziteArrayElementsTrafo(), and ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation().

Referenced by doStandardAuthentication().

                                             : ILIAS\UI\Component\Input\Container\Form\Form
    {
        $field_factory = $this->ui_factory->input()->field();

        $fields = [];
        $det = ilAuthModeDetermination::_getInstance();
        if (ilAuthUtils::_hasMultipleAuthenticationMethods() && $det->isManualSelection()) {
            $auth_mode = $field_factory->radio($this->lng->txt('auth_selection'))->withRequired(true);
            $visible_auth_methods = [];
            foreach (ilAuthUtils::_getMultipleAuthModeOptions($this->lng) as $key => $option) {
                if (isset($option['hide_in_ui']) && $option['hide_in_ui']) {
                    continue;
                }

                $auth_mode = $auth_mode->withOption((string) $key, $option['txt']);

                if (isset($option['checked'])) {
                    $auth_mode = $auth_mode->withValue($key);
                }
                $visible_auth_methods[] = $key;
            }

            if (count($visible_auth_methods) === 1) {
                $auth_mode = $field_factory->hidden()->withRequired(true)->withValue(current($visible_auth_methods));
            }

            $fields[self::PROP_AUTH_MODE] = $auth_mode;
        }

        $fields += [
                self::PROP_USERNAME => $field_factory
                    ->text($this->lng->txt('username'))
                    ->withRequired(
                        true,
                        $this->refinery->custom()->constraint(
                            static function (string $value): bool {
                                return $value !== '';
                            },
                            static function (Closure $lng, string $value): string {
                                return $lng('auth_required_username');
                            }
                        )
                    ),
                self::PROP_PASSWORD => $field_factory
                    ->password($this->lng->txt('password'))
                    ->withRevelation(true)
                    ->withRequired(
                        true,
                        $this->refinery->custom()->constraint(
                            static function (string $value): bool {
                                return $value !== '';
                            },
                            static function (Closure $lng, string $value): string {
                                return $lng('auth_required_password');
                            }
                        )
                    )
                    ->withAdditionalTransformation(
                        $this->refinery->custom()->transformation(
                            static function (ILIAS\Data\Password $value): string {
                                return $value->toString();
                            }
                        )
                    ),
        ];

        $sections = [$field_factory->section($fields, $this->lng->txt('login_to_ilias_via_login_form'))];

        return $this->ui_factory
            ->input()
            ->container()
            ->form()
            ->standard($this->ctrl->getFormAction($this, 'doStandardAuthentication'), $sections)
            ->withDedicatedName('login_form')
            ->withSubmitLabel($this->lng->txt('log_in'))
            ->withAdditionalTransformation($this->mergeValuesTrafo())
            ->withAdditionalTransformation($this->saniziteArrayElementsTrafo());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkForcedCommand()

ilStartUpGUI::checkForcedCommand ( string  $cmd )

private

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

Referenced by executeCommand().

                                                    : string
    {
        if (self::$forced_cmd) {
            $cmd = self::$forced_cmd;
            self::$forced_cmd = '';
        }

        return $cmd;
    }

Here is the caller graph for this function:

doApacheAuthentication()

ilStartUpGUI::doApacheAuthentication ( )

private

Definition at line 689 of file class.ilStartUpGUI.php.

References $provider, ilUtil\appendUrlParameterString(), ilAuthUtils\AUTH_APACHE, ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ILIAS\Repository\ctrl(), ilAuthStatus\getInstance(), getLogger(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), ILIAS\Repository\mainTemplate(), ilInitialisation\redirectToStartingPage(), showLoginPage(), ilAuthStatus\STATUS_ACCOUNT_MIGRATION_REQUIRED, ilAuthStatus\STATUS_AUTHENTICATED, and ilAuthStatus\STATUS_AUTHENTICATION_FAILED.

                                             : void
    {
        $this->getLogger()->debug('Trying apache authentication');

        $credentials = new ilAuthFrontendCredentialsApache($this->httpRequest, $this->ctrl);
        $credentials->initFromRequest();

        $provider_factory = new ilAuthProviderFactory();
        $provider = $provider_factory->getProviderByAuthMode($credentials, ilAuthUtils::AUTH_APACHE);

        $status = ilAuthStatus::getInstance();

        $frontend_factory = new \ilAuthFrontendFactory();
        $frontend_factory->setContext(\ilAuthFrontendFactory::CONTEXT_STANDARD_FORM);
        $frontend = $frontend_factory->getFrontend(
            $this->authSession,
            $status,
            $credentials,
            [$provider]
        );
        $frontend->authenticate();

        switch ($status->getStatus()) {
            case ilAuthStatus::STATUS_AUTHENTICATED:
                if ($credentials->hasValidTargetUrl()) {
                    $this->logger->debug(
                        sprintf(
                            'Authentication successful. Redirecting to starting page: %s',
                            $credentials->getTargetUrl()
                        )
                    );
                    $this->ctrl->redirectToURL($credentials->getTargetUrl());
                }
                $this->logger->debug(
                    'Authentication successful, but no valid target URL given. Redirecting to default starting page.'
                );
                ilInitialisation::redirectToStartingPage();

                // no break
            case ilAuthStatus::STATUS_ACCOUNT_MIGRATION_REQUIRED:
                $this->ctrl->redirect($this, 'showAccountMigration');

                // no break
            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                $this->mainTemplate->setOnScreenMessage('failure', $status->getTranslatedReason(), true);
                $this->ctrl->redirectToURL(
                    ilUtil::appendUrlParameterString(
                        $this->ctrl->getLinkTarget($this, 'showLoginPage', '', false, false),
                        'passed_sso=1'
                    )
                );
        }

        $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt('err_wrong_login'));
        $this->showLoginPage();
    }

Here is the call graph for this function:

doCasAuthentication()

ilStartUpGUI::doCasAuthentication ( )

private

Definition at line 598 of file class.ilStartUpGUI.php.

References $provider, ilAuthUtils\AUTH_CAS, ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ilAuthStatus\getInstance(), getLogger(), ILIAS\Repository\lng(), ILIAS\Repository\mainTemplate(), ilInitialisation\redirectToStartingPage(), showLoginPage(), ilAuthStatus\STATUS_AUTHENTICATED, and ilAuthStatus\STATUS_AUTHENTICATION_FAILED.

                                          : void
    {
        $this->getLogger()->debug('Trying cas authentication');
        $credentials = new ilAuthFrontendCredentialsCAS();

        $provider_factory = new ilAuthProviderFactory();
        $provider = $provider_factory->getProviderByAuthMode($credentials, ilAuthUtils::AUTH_CAS);

        $status = ilAuthStatus::getInstance();

        $frontend_factory = new ilAuthFrontendFactory();
        $frontend_factory->setContext(ilAuthFrontendFactory::CONTEXT_STANDARD_FORM);
        $frontend = $frontend_factory->getFrontend(
            $this->authSession,
            $status,
            $credentials,
            [$provider]
        );
        $frontend->authenticate();

        switch ($status->getStatus()) {
            case ilAuthStatus::STATUS_AUTHENTICATED:
                $this->getLogger()->debug('Authentication successful.');
                ilInitialisation::redirectToStartingPage();

                // no break
            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
            default:
                $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt($status->getReason()));
                $this->showLoginPage();
        }
    }

Here is the call graph for this function:

doLTIAuthentication()

ilStartUpGUI::doLTIAuthentication ( )

private

Definition at line 631 of file class.ilStartUpGUI.php.

References $provider, $ref_id, ilObject\_lookupType(), ilAuthUtils\AUTH_PROVIDER_LTI, ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ILIAS\Repository\ctrl(), ilSession\get(), ilAuthStatus\getInstance(), ilLoggerFactory\getLogger(), getLogger(), IL_COOKIE_PATH, ILIAS\Repository\lng(), ILIAS\Repository\mainTemplate(), ilInitialisation\redirectToStartingPage(), ilSession\set(), showLoginPage(), ilAuthStatus\STATUS_ACCOUNT_MIGRATION_REQUIRED, ilAuthStatus\STATUS_AUTHENTICATED, and ilAuthStatus\STATUS_AUTHENTICATION_FAILED.

                                          : void
    {
        $this->getLogger()->debug('Trying lti authentication');

        $credentials = new ilAuthFrontendCredentialsLTI();
        $credentials->initFromRequest();

        $provider_factory = new ilAuthProviderFactory();
        $provider = $provider_factory->getProviderByAuthMode($credentials, ilAuthUtils::AUTH_PROVIDER_LTI);

        $status = ilAuthStatus::getInstance();

        $frontend_factory = new ilAuthFrontendFactory();
        $frontend_factory->setContext(ilAuthFrontendFactory::CONTEXT_STANDARD_FORM);
        $frontend = $frontend_factory->getFrontend(
            $this->authSession,
            $status,
            $credentials,
            [$provider]
        );
        $frontend->authenticate();

        setcookie(session_name(), session_id(), [
            'expires' => 0,
            'path' => rtrim(IL_COOKIE_PATH, '/'),
            'domain' => IL_COOKIE_DOMAIN,
            'secure' => true,
            'httponly' => true,
            'samesite' => 'None'
        ]);

        $lti_context_ids = ilSession::get("lti_context_ids");

        if (is_array($lti_context_ids) && isset($lti_context_ids[0])) {
            $ref_id = $lti_context_ids[0];
            $obj_type = ilObject::_lookupType($ref_id, true);
            ilSession::set('orig_request_target', "goto.php?target=" . $obj_type . "_" . $ref_id . "&lti_context_id=" . $ref_id);
        }

        switch ($status->getStatus()) {
            case ilAuthStatus::STATUS_AUTHENTICATED:
                ilLoggerFactory::getLogger('auth')->debug('Authentication successful; Redirecting to starting page.');
                ilInitialisation::redirectToStartingPage();

                // no break
            case ilAuthStatus::STATUS_ACCOUNT_MIGRATION_REQUIRED:
                $this->ctrl->redirect($this, 'showAccountMigration');

                // no break
            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt($status->getReason()), true);
                $this->ctrl->redirect($this, 'showLoginPage');
        }

        $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt('err_wrong_login'));
        $this->showLoginPage();
    }

Here is the call graph for this function:

doMigration()

ilStartUpGUI::doMigration ( array  $migration_request_data )

private

Parameters

array<string,string>

$migration_request_data

Definition at line 1228 of file class.ilStartUpGUI.php.

References $GLOBALS, $provider, ilAuthUtils\AUTH_LOCAL, ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ILIAS\Repository\ctrl(), ilSession\get(), ilAuthStatus\getInstance(), getLogger(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), ILIAS\Repository\mainTemplate(), ilAuthFrontend\MIG_TRIGGER_AUTHMODE, ilInitialisation\redirectToStartingPage(), showAccountMigration(), and ilAuthStatus\STATUS_AUTHENTICATED.

Referenced by migrateAccount().

                                                               : void
    {
        $username = $migration_request_data[self::PROP_USERNAME];
        $password = $migration_request_data[self::PROP_PASSWORD];

        $this->logger->debug('Starting account migration for user: ' . ilSession::get('mig_ext_account'));

        $credentials = new ilAuthFrontendCredentials();
        $credentials->setUsername($username);
        $credentials->setPassword($password);

        $provider_factory = new ilAuthProviderFactory();
        $provider = $provider_factory->getProviderByAuthMode($credentials, ilAuthUtils::AUTH_LOCAL);

        $status = ilAuthStatus::getInstance();

        $frontend_factory = new ilAuthFrontendFactory();
        $frontend_factory->setContext(ilAuthFrontendFactory::CONTEXT_STANDARD_FORM);
        $frontend = $frontend_factory->getFrontend(
            $this->authSession,
            $status,
            $credentials,
            [$provider]
        );
        $frontend->authenticate();

        switch ($status->getStatus()) {
            case ilAuthStatus::STATUS_AUTHENTICATED:
                $this->getLogger()->debug('Account migration: authentication successful for ' . $username);

                $provider = $provider_factory->getProviderByAuthMode(
                    $credentials,
                    ilSession::get(ilAuthFrontend::MIG_TRIGGER_AUTHMODE)
                );
                $frontend_factory->setContext(ilAuthFrontendFactory::CONTEXT_STANDARD_FORM);
                $frontend = $frontend_factory->getFrontend(
                    $GLOBALS['DIC']['ilAuthSession'],
                    $status,
                    $credentials,
                    [$provider]
                );

                if ($frontend->migrateAccount($GLOBALS['DIC']['ilAuthSession'])) {
                    ilInitialisation::redirectToStartingPage();
                }

                $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt('err_wrong_login'), true);
                $this->ctrl->redirect($this, 'showAccountMigration');

                // no break
            default:
                $this->getLogger()->info('Account migration failed for user ' . $username);
                $this->showAccountMigration(null, $GLOBALS['lng']->txt('err_wrong_login'));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doMigrationNewAccount()

ilStartUpGUI::doMigrationNewAccount ( )

private

Definition at line 1193 of file class.ilStartUpGUI.php.

References $GLOBALS, $provider, ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ILIAS\Repository\ctrl(), ilSession\get(), ilAuthStatus\getInstance(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), ILIAS\Repository\mainTemplate(), ilAuthFrontend\MIG_EXTERNAL_ACCOUNT, ilAuthFrontend\MIG_TRIGGER_AUTHMODE, and ilInitialisation\redirectToStartingPage().

Referenced by migrateAccount().

                                            : void
    {
        $credentials = new ilAuthFrontendCredentials();
        $credentials->setUsername(ilSession::get(ilAuthFrontend::MIG_EXTERNAL_ACCOUNT));

        $provider_factory = new ilAuthProviderFactory();
        $provider = $provider_factory->getProviderByAuthMode(
            $credentials,
            ilSession::get(ilAuthFrontend::MIG_TRIGGER_AUTHMODE)
        );

        $this->logger->debug('Using provider: ' . get_class($provider) . ' for further processing.');

        $status = ilAuthStatus::getInstance();

        $frontend_factory = new ilAuthFrontendFactory();
        $frontend_factory->setContext(ilAuthFrontendFactory::CONTEXT_STANDARD_FORM);
        $frontend = $frontend_factory->getFrontend(
            $GLOBALS['DIC']['ilAuthSession'],
            $status,
            $credentials,
            [$provider]
        );

        if ($frontend->migrateAccountNew()) {
            ilInitialisation::redirectToStartingPage();
        }

        $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt('err_wrong_login'));
        $this->ctrl->redirect($this, 'showAccountMigration');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doOpenIdConnectAuthentication()

ilStartUpGUI::doOpenIdConnectAuthentication ( )

private

Definition at line 1775 of file class.ilStartUpGUI.php.

References $provider, ilAuthUtils\AUTH_OPENID_CONNECT, ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ILIAS\Repository\ctrl(), ilAuthStatus\getInstance(), getLogger(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), ILIAS\Repository\mainTemplate(), ilInitialisation\redirectToStartingPage(), showLoginPage(), ilAuthStatus\STATUS_AUTHENTICATED, and ilAuthStatus\STATUS_AUTHENTICATION_FAILED.

                                                    : void
    {
        $this->getLogger()->debug('Trying openid connect authentication');

        $credentials = new ilAuthFrontendCredentialsOpenIdConnect();
        $credentials->initFromRequest();

        $provider_factory = new ilAuthProviderFactory();
        $provider = $provider_factory->getProviderByAuthMode($credentials, ilAuthUtils::AUTH_OPENID_CONNECT);

        $status = ilAuthStatus::getInstance();

        $frontend_factory = new ilAuthFrontendFactory();
        $frontend_factory->setContext(ilAuthFrontendFactory::CONTEXT_STANDARD_FORM);
        $frontend = $frontend_factory->getFrontend(
            $this->authSession,
            $status,
            $credentials,
            [$provider]
        );
        $frontend->authenticate();

        switch ($status->getStatus()) {
            case ilAuthStatus::STATUS_AUTHENTICATED:
                $this->logger->debug('Authentication successful; Redirecting to starting page.');
                if ($credentials->getRedirectionTarget()) {
                    ilInitialisation::redirectToStartingPage($credentials->getRedirectionTarget());
                }
                ilInitialisation::redirectToStartingPage();

                // no break
            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                $this->mainTemplate->setOnScreenMessage('failure', $status->getTranslatedReason(), true);
                $this->ctrl->redirect($this, 'showLoginPage');
        }

        $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt('err_wrong_login'));
        $this->showLoginPage();
    }

Here is the call graph for this function:

doSamlAuthentication()

ilStartUpGUI::doSamlAuthentication ( )

private

Definition at line 1815 of file class.ilStartUpGUI.php.

References $httpRequest, $params, $provider, ilAuthUtils\AUTH_SAML, ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ILIAS\Repository\ctrl(), ilSamlIdp\geIdpIdByEntityId(), ilSamlIdp\getActiveIdpList(), ilAuthStatus\getInstance(), ilLoggerFactory\getLogger(), getLogger(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), ILIAS\Repository\mainTemplate(), ilInitialisation\redirectToStartingPage(), showLoginPage(), showSamlIdpSelection(), ilAuthStatus\STATUS_ACCOUNT_MIGRATION_REQUIRED, ilAuthStatus\STATUS_AUTHENTICATED, ilAuthStatus\STATUS_AUTHENTICATION_FAILED, and ilUtil\stripSlashes().

                                           : void
    {
        $this->getLogger()->debug('Trying saml authentication');
        $request = $this->httpRequest;
        $params = $request->getQueryParams();

        $factory = new ilSamlAuthFactory();
        $auth = $factory->auth();

        if (isset($params['action']) && $params['action'] === 'logout') {
            $logout_url = $params['logout_url'] ?? '';
            $this->logger->info(sprintf('Requested SAML logout: %s', $logout_url));
            $auth->logout($logout_url);
        }

        if (isset($params['target']) && !isset($params['returnTo'])) {
            $params['returnTo'] = $params['target'];
        }

        if (isset($params['returnTo'])) {
            $auth->storeParam('target', $params['returnTo']);
        }

        $this->logger->debug('Started SAML authentication request');
        if (!$auth->isAuthenticated()) {
            ilLoggerFactory::getLogger('auth')->debug('User is not authenticated, yet');
            if (!isset($request->getQueryParams()['idpentityid'], $request->getQueryParams()['saml_idp_id'])) {
                $activeIdps = ilSamlIdp::getActiveIdpList();
                if (count($activeIdps) === 1) {
                    $idp = current($activeIdps);

                    ilLoggerFactory::getLogger('auth')->debug(
                        sprintf(
                            'Found exactly one active IDP with id %s: %s',
                            $idp->getIdpId(),
                            $idp->getEntityId()
                        )
                    );

                    $this->ctrl->setParameter($this, 'idpentityid', $idp->getEntityId());
                    $this->ctrl->setParameter($this, 'saml_idp_id', $idp->getIdpId());
                    $this->ctrl->setTargetScript('saml.php');
                    $this->ctrl->redirect($this, 'doSamlAuthentication');
                } elseif ($activeIdps === []) {
                    $this->logger->debug('Did not find any active IDP, skipp authentication process');
                    $this->ctrl->redirect($this, 'showLoginPage');
                } else {
                    $this->logger->debug('Found multiple active IPDs, presenting IDP selection...');
                    $this->showSamlIdpSelection($auth, $activeIdps);
                    return;
                }
            }

            $auth->storeParam('idpId', (int) $request->getQueryParams()['saml_idp_id']);
            $this->logger->debug(sprintf('Stored relevant IDP id in session: %s', $auth->getParam('idpId')));
        }

        $auth = $factory->auth();

        $this->logger->debug('Checking SAML authentication status...');
        $auth->protectResource();
        $this->logger->debug(
            'SAML authentication successful, continuing with ILIAS internal authentication process...'
        );

        $idpId = (int) $auth->getParam('idpId');

        $this->logger->debug(
            sprintf(
                'Internal SAML IDP id fetched from session: %s',
                $idpId
            )
        );

        if ($idpId < 1) {
            $this->logger->debug(
                'No valid internal IDP id found (most probably due to IDP initiated SSO), trying fallback determination...'
            );
            $authData = $auth->getAuthDataArray();
            if (isset($authData['saml:sp:IdP'])) {
                $idpId = ilSamlIdp::geIdpIdByEntityId($authData['saml:sp:IdP']);
                $this->logger->debug(
                    sprintf(
                        'Searching active ILIAS IDP by entity id "%s" results in: %s',
                        $authData['saml:sp:IdP'],
                        $idpId
                    )
                );
            } else {
                $this->logger->debug(
                    'Could not execute fallback determination, no IDP entity ID found SAML authentication session data'
                );
            }
        }

        $target = $auth->popParam('target');

        $this->logger->debug(sprintf('Retrieved "target" parameter: %s', print_r($target, true)));

        $credentials = new ilAuthFrontendCredentialsSaml($auth, $request);
        $credentials->initFromRequest();

        $provider_factory = new ilAuthProviderFactory();
        $provider = $provider_factory->getProviderByAuthMode(
            $credentials,
            ilUtil::stripSlashes(
                ilAuthUtils::AUTH_SAML . '_' . $idpId
            )
        );

        if ($target) {
            $credentials->setReturnTo($target);
        } else {
            $target = $credentials->getReturnTo();
        }

        $status = ilAuthStatus::getInstance();

        $frontend_factory = new ilAuthFrontendFactory();
        $frontend_factory->setContext(ilAuthFrontendFactory::CONTEXT_STANDARD_FORM);
        $frontend = $frontend_factory->getFrontend(
            $this->authSession,
            $status,
            $credentials,
            [$provider]
        );
        $frontend->authenticate();

        switch ($status->getStatus()) {
            case ilAuthStatus::STATUS_AUTHENTICATED:
                $this->logger->debug('Authentication successful; Redirecting to starting page.');
                ilInitialisation::redirectToStartingPage($target ?? '');

                // no break
            case ilAuthStatus::STATUS_ACCOUNT_MIGRATION_REQUIRED:
                $this->ctrl->redirect($this, 'showAccountMigration');

                // no break
            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                $this->mainTemplate->setOnScreenMessage('failure', $status->getTranslatedReason(), true);
                $this->ctrl->redirect($this, 'showLoginPage');
        }

        $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt('err_wrong_login'));
        $this->showLoginPage();
    }

Here is the call graph for this function:

doStandardAuthentication()

ilStartUpGUI::doStandardAuthentication ( )

private

Definition at line 746 of file class.ilStartUpGUI.php.

References $duration, ilAuthModeDetermination\_getInstance(), ilAuthUtils\_hasMultipleAuthenticationMethods(), ilObjUser\_lookupLogin(), buildCodeForm(), buildStandardLoginForm(), ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ILIAS\Repository\ctrl(), ilAuthStatus\getInstance(), ilLoggerFactory\getLogger(), getLogger(), ILIAS\FileDelivery\http(), ILIAS\Repository\mainTemplate(), ilInitialisation\redirectToStartingPage(), showLoginPage(), ilAuthStatus\STATUS_ACCOUNT_MIGRATION_REQUIRED, ilAuthStatus\STATUS_AUTHENTICATED, ilAuthStatus\STATUS_AUTHENTICATION_FAILED, and ilAuthStatus\STATUS_CODE_ACTIVATION_REQUIRED.

                                               : void
    {
        $form = $this->buildStandardLoginForm();
        $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->showLoginPage($form);
            return;
        }

        $this->getLogger()->debug('Trying to authenticate user.');

        $auth_callback = function () use ($form_data) {
            $credentials = new ilAuthFrontendCredentials();
            $credentials->setUsername($form_data[self::PROP_USERNAME]);
            $credentials->setPassword($form_data[self::PROP_PASSWORD]);

            $det = ilAuthModeDetermination::_getInstance();
            if (ilAuthUtils::_hasMultipleAuthenticationMethods() and $det->isManualSelection()) {
                $credentials->setAuthMode($form_data[self::PROP_AUTH_MODE]);
            }

            $provider_factory = new ilAuthProviderFactory();
            $providers = $provider_factory->getProviders($credentials);

            $status = ilAuthStatus::getInstance();

            $frontend_factory = new ilAuthFrontendFactory();
            $frontend_factory->setContext(ilAuthFrontendFactory::CONTEXT_STANDARD_FORM);
            $frontend = $frontend_factory->getFrontend(
                $this->authSession,
                $status,
                $credentials,
                $providers
            );
            $frontend->authenticate();

            return $status;
        };

        if (($auth_duration = $this->setting->get('auth_duration')) !== null) {
            $duration = $this->http->durations()->callbackDuration((int) $auth_duration);
            $status = $duration->stretch($auth_callback);
        } else {
            $status = $auth_callback();
        }

        switch ($status->getStatus()) {
            case ilAuthStatus::STATUS_AUTHENTICATED:
                ilLoggerFactory::getLogger('auth')->debug(
                    'Authentication successful; Redirecting to starting page.'
                );
                ilInitialisation::redirectToStartingPage();

                // no break
            case ilAuthStatus::STATUS_CODE_ACTIVATION_REQUIRED:
                $uname = ilObjUser::_lookupLogin($status->getAuthenticatedUserId());
                $this->showLoginPage($this->buildCodeForm($uname));
                return;

            case ilAuthStatus::STATUS_ACCOUNT_MIGRATION_REQUIRED:
                $this->ctrl->redirect($this, 'showAccountMigration');

                // no break
            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                $this->mainTemplate->setOnScreenMessage('failure', $status->getTranslatedReason());
                $this->showLoginPage($form);
        }
    }

Here is the call graph for this function:

executeCommand()

ilStartUpGUI::executeCommand

(

)

Definition at line 153 of file class.ilStartUpGUI.php.

References checkForcedCommand(), ILIAS\Repository\ctrl(), and showLoginPageOrStartupPage().

                                    : void
    {
        $cmd = $this->checkForcedCommand($this->ctrl->getCmd('processIndexPHP'));

        $next_class = $this->ctrl->getNextClass($this) ?? '';

        switch (strtolower($next_class)) {
            case strtolower(ilLoginPageGUI::class):
                break;

            case strtolower(ilAccountRegistrationGUI::class):
                $this->ctrl->forwardCommand(new ilAccountRegistrationGUI());
                return;

            case strtolower(ilPasswordAssistanceGUI::class):
                $this->ctrl->forwardCommand(new ilPasswordAssistanceGUI());
                return;

            case strtolower(ilAccessibilityControlConceptGUI::class):
                $this->ctrl->forwardCommand(new ilAccessibilityControlConceptGUI());
                return;

            default:
                if (method_exists($this, $cmd)) {
                    $this->$cmd();
                    return;
                }
        }

        // because this class now implements ilCtrlSecurityInterface,
        // it may occur that commands are null, therefore I added
        // this as a fallback method.
        $this->showLoginPageOrStartupPage();
    }

Here is the call graph for this function:

getAuthPageEditorHtml()

ilStartUpGUI::getAuthPageEditorHtml ( AuthPageEditorContext  $ipe_context )

private

Definition at line 970 of file class.ilStartUpGUI.php.

References ilPageUtil\_existsAndNotEmpty(), ilObjAuthSettings\getAuthSettingsRefId(), ilAuthPageEditorSettings\getInstance(), ILIAS\Repository\lng(), ilLanguage\lookupId(), and ILIAS\Repository\mainTemplate().

Referenced by showLoginPage(), and showLogout().

                                                                              : string
    {
        $ipe_settings = ilAuthPageEditorSettings::getInstance($ipe_context);

        $ipe_language = $ipe_settings->getIliasEditorLanguage($this->lng->getLangKey());
        if (!$ipe_language) {
            return '';
        }

        // if page does not exist, return nothing
        if (!ilPageUtil::_existsAndNotEmpty($ipe_context->pageType(), ilLanguage::lookupId($ipe_language))) {
            return '';
        }

        $this->dic->contentStyle()->gui()->addCss($this->mainTemplate, ilObjAuthSettings::getAuthSettingsRefId());

        $page_gui = new ($ipe_context->pageUiClass())(ilLanguage::lookupId($ipe_language));

        $page_gui->setStyleId(0);

        $page_gui->setPresentationTitle('');
        $page_gui->setTemplateOutput(false);
        $page_gui->setHeader('');

        return $page_gui->showPage();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLogger()

ilStartUpGUI::getLogger ( )

private

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

References $logger.

Referenced by doApacheAuthentication(), doCasAuthentication(), doLTIAuthentication(), doMigration(), doOpenIdConnectAuthentication(), doSamlAuthentication(), doStandardAuthentication(), and showLoginPage().

                                : ilLogger
    {
        return $this->logger;
    }

Here is the caller graph for this function:

getSafePostCommands()

ilStartUpGUI::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 146 of file class.ilStartUpGUI.php.

                                         : array
    {
        return [
            'doStandardAuthentication',
        ];
    }

getUnsafeGetCommands()

ilStartUpGUI::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 139 of file class.ilStartUpGUI.php.

                                          : array
    {
        return [
            'doLogout'
        ];
    }

initStartUpTemplate()

static ilStartUpGUI::initStartUpTemplate (   $a_tmpl, bool  $a_show_back = false, bool  $a_show_logout = false  )

static

This method enriches the global template with some user interface elements (language selection, headlines, back buttons, ...) for public service views.

Parameters

string|array{0

string, 1: string} $a_tmpl The template file as a string of as an array (index 0: template file, index 1: template directory)

Definition at line 1653 of file class.ilStartUpGUI.php.

References $_SERVER, $DIC, $param, ANONYMOUS_USER_ID, CLIENT_ID, ilPublicSectionSettings\getInstance(), and ROOT_FOLDER_ID.

Referenced by ilAccountRegistrationGUI\displayForm(), ilAccountRegistrationGUI\login(), ilPasswordAssistanceGUI\showAssignPasswordForm(), ilPasswordAssistanceGUI\showAssistanceForm(), ilPasswordAssistanceGUI\showMessageForm(), and ilPasswordAssistanceGUI\showUsernameAssistanceForm().

     : ilGlobalTemplateInterface {
        global $DIC;

        $tpl = new ilGlobalTemplate('tpl.main.html', true, true);

        $tpl->addBlockfile('CONTENT', 'content', 'tpl.startup_screen.html', 'components/ILIAS/Init');

        $view_title = $DIC->language()->txt('login_to_ilias');
        if ($a_show_back) {
            // #13400
            $param = 'client_id=' . CLIENT_ID . '&lang=' . $DIC->language()->getLangKey();

            $tpl->setCurrentBlock('link_item_bl');
            $tpl->setVariable('LINK_TXT', $view_title);
            $tpl->setVariable('LINK_URL', 'login.php?cmd=force_login&' . $param);
            $tpl->parseCurrentBlock();

            if (ilPublicSectionSettings::getInstance()->isEnabledForDomain($_SERVER['SERVER_NAME']) &&
                $DIC->access()->checkAccessOfUser(ANONYMOUS_USER_ID, 'read', '', ROOT_FOLDER_ID)) {
                $tpl->setVariable('LINK_URL', 'index.php?' . $param);
                $tpl->setVariable('LINK_TXT', $DIC->language()->txt('home'));
                $tpl->parseCurrentBlock();
            }
        } elseif ($a_show_logout) {
            $view_title = $DIC->language()->txt('logout');
            $tpl->setCurrentBlock('link_item_bl');
            $tpl->setVariable('LINK_TXT', $view_title);
            $tpl->setVariable('LINK_URL', self::logoutUrl());
            $tpl->parseCurrentBlock();
        }

        if (is_array($a_tmpl)) {
            $template_file = $a_tmpl[0];
            $template_dir = $a_tmpl[1];
        } else {
            $template_file = $a_tmpl;
            $template_dir = 'components/ILIAS/Init';
        }

        $tpl->addBlockFile('STARTUP_CONTENT', 'startup_content', $template_file, $template_dir);

        PageContentProvider::setViewTitle($view_title);
        $short_title = trim($DIC->settings()->get('short_inst_name') ?? '');
        if ($short_title === '') {
            $short_title = 'ILIAS';
        }
        PageContentProvider::setShortTitle($short_title);

        $header_title = ilObjSystemFolder::_getHeaderTitle();
        PageContentProvider::setTitle($header_title);

        return $tpl;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initTargetFromQuery()

ilStartUpGUI::initTargetFromQuery ( )

private

Definition at line 131 of file class.ilStartUpGUI.php.

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

Referenced by showOpenIdConnectLoginForm(), showSamlLoginForm(), and showShibbolethLoginForm().

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

Here is the call graph for this function:

Here is the caller graph for this function:

jumpToPasswordAssistance()

ilStartUpGUI::jumpToPasswordAssistance ( )

private

Definition at line 198 of file class.ilStartUpGUI.php.

References ILIAS\Repository\ctrl().

                                               : void
    {
        $this->ctrl->saveParameterByClass(ilPasswordAssistanceGUI::class, 'key');
        $this->ctrl->redirectByClass(ilPasswordAssistanceGUI::class);
    }

Here is the call graph for this function:

jumpToRegistration()

ilStartUpGUI::jumpToRegistration ( )

private

Definition at line 193 of file class.ilStartUpGUI.php.

References ILIAS\Repository\ctrl().

                                         : void
    {
        $this->ctrl->redirectByClass(ilAccountRegistrationGUI::class);
    }

Here is the call graph for this function:

logoutUrl()

static ilStartUpGUI::logoutUrl ( array  $parameters = [] )

static

Return the logout URL with a valid CSRF token.

Without the token the logout won't be successful.

Parameters

array<string,string>

$parameters

Definition at line 2007 of file class.ilStartUpGUI.php.

References $DIC, and $url.

Referenced by ILIAS\LegalDocuments\Provide\ProvideWithdrawal\__construct(), ILIAS\LegalDocuments\Conductor\__construct(), ILIAS\User\Provider\UserMetaBarProvider\getMetaBarItems(), ilAuthProviderOpenIdConnect\handleLogout(), and ILIAS\LegalDocuments\ConsumerToolbox\Blocks\routing().

                                                            : string
    {
        global $DIC;

        $defaults = ['lang' => $DIC->user()->getCurrentLanguage()];
        $parameters = '&' . http_build_query(array_merge($defaults, $parameters));

        $DIC->ctrl()->setTargetScript('logout.php');
        $url = $DIC->ctrl()->getLinkTargetByClass([self::class], 'doLogout') . $parameters;
        $DIC->ctrl()->setTargetScript('ilias.php');

        return $url;
    }

Here is the caller graph for this function:

mergeValuesTrafo()

ilStartUpGUI::mergeValuesTrafo ( )

private

Definition at line 112 of file class.ilStartUpGUI.php.

References ILIAS\Repository\refinery().

Referenced by buildAccountMigrationForm(), buildCodeForm(), and buildStandardLoginForm().

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

Here is the call graph for this function:

Here is the caller graph for this function:

migrateAccount()

ilStartUpGUI::migrateAccount ( )

private

Definition at line 1163 of file class.ilStartUpGUI.php.

References buildAccountMigrationForm(), doMigration(), doMigrationNewAccount(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and showAccountMigration().

                                     : void
    {
        $form = $this->buildAccountMigrationForm();
        $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->showAccountMigration($form, $this->lng->txt('form_input_not_valid'));
            return;
        }

        $account_migration = $form_data[self::PROP_ACCOUNT_MIGRATION];
        $account_migration_mode = $account_migration[0];
        if ($account_migration_mode === self::PROP_ACCOUNT_MIGRATION_MIGRATE) {
            $this->doMigration($account_migration[1]);
        } elseif ($account_migration_mode === self::PROP_ACCOUNT_MIGRATION_NEW) {
            $this->doMigrationNewAccount();
        } else {
            $this->showAccountMigration(
                $form,
                $this->lng->txt('form_input_not_valid')
            );
        }
    }

Here is the call graph for this function:

printToGlobalTemplate()

static ilStartUpGUI::printToGlobalTemplate (   $tpl )

static

Parameters

ilTemplate | ilGlobalTemplateInterface

$tpl

Definition at line 357 of file class.ilStartUpGUI.php.

References $DIC.

Referenced by ilAccountRegistrationGUI\executeCommand(), ilPasswordAssistanceGUI\showAssignPasswordForm(), ilPasswordAssistanceGUI\showAssistanceForm(), ilPasswordAssistanceGUI\showMessageForm(), and ilPasswordAssistanceGUI\showUsernameAssistanceForm().

                                                      : void
    {
        global $DIC;
        $gtpl = $DIC['tpl'];
        $gtpl->setContent($tpl->get());
        $gtpl->printToStdout('DEFAULT', false, true);
    }

Here is the caller graph for this function:

processCode()

ilStartUpGUI::processCode ( )

private

Definition at line 440 of file class.ilStartUpGUI.php.

References $GLOBALS, $user_id, ilObjUser\_lookupId(), ilRegistrationCode\applyAccessLimits(), ilRegistrationCode\applyRoleAssignments(), buildCodeForm(), ILIAS\Repository\ctrl(), ilRegistrationCode\getCodeValidUntil(), ILIAS\FileDelivery\http(), ilRegistrationCode\isUnusedCode(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\lng(), ILIAS\Repository\mainTemplate(), ilObjUser\setActive(), ilObjUser\setTimeLimitUnlimited(), ilObjUser\setTimeLimitUntil(), showCodeForm(), showLoginPage(), ilObjUser\update(), and ilRegistrationCode\useCode().

                                  : void
    {
        $form = $this->buildCodeForm();
        $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;
        }

        $uname = null;
        if ($form_valid) {
            $code = $form_data[self::PROP_CODE];
            $uname = $form_data[self::PROP_USERNAME];
            if (ilRegistrationCode::isUnusedCode($code)) {
                $valid_until = ilRegistrationCode::getCodeValidUntil($code);
                if (!$user_id = ilObjUser::_lookupId($uname)) {
                    $this->showLoginPage();
                    return;
                }
                $invalid_code = false;
                $user = new ilObjUser($user_id);
                if ($valid_until === '0') {
                    $user->setTimeLimitUnlimited(true);
                } else {
                    if (is_numeric($valid_until)) {
                        $valid_until = strtotime('+' . $valid_until . 'days');
                    } else {
                        $valid_until = explode('-', $valid_until);
                        $valid_until = mktime(
                            23,
                            59,
                            59,
                            (int) $valid_until[1],
                            (int) $valid_until[2],
                            (int) $valid_until[0]
                        );
                        if ($valid_until < time()) {
                            $invalid_code = true;
                        }
                    }

                    if (!$invalid_code) {
                        $user->setTimeLimitUnlimited(false);
                        $user->setTimeLimitUntil($valid_until);
                    }
                }

                if (!$invalid_code) {
                    $user->setActive(true);
                    ilRegistrationCode::useCode($code);
                    // apply registration code role assignments
                    ilRegistrationCode::applyRoleAssignments($user, $code);
                    // apply registration code tie limits
                    ilRegistrationCode::applyAccessLimits($user, $code);

                    $user->update();

                    $this->ctrl->setParameter($this, 'cu', 1);
                    $this->lng->loadLanguageModule('auth');
                    $this->mainTemplate->setOnScreenMessage(
                        'success',
                        $GLOBALS['DIC']->language()->txt('auth_activation_code_success'),
                        true
                    );
                    $this->ctrl->redirect($this, 'showLoginPage');
                }
            }

            $this->lng->loadLanguageModule('user');
            $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt('user_account_code_not_valid'));
        } else {
            $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt('form_input_not_valid'));
        }

        $this->showCodeForm($uname, $form);
    }

Here is the call graph for this function:

processIndexPHP()

ilStartUpGUI::processIndexPHP ( )

private

Definition at line 1381 of file class.ilStartUpGUI.php.

References $_COOKIE, $_SERVER, $DIC, $location, $path, $ref_id, XapiProxy\$resp, ilObject\_getAllReferences(), ilCourseParticipant\_getInstanceByObjId(), ilObjCourse\_isActivated(), ilGroupParticipants\_isParticipant(), ilLMObject\_lookupContObjID(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilObjCourse\_registrationEnabled(), ilObjUser\_verifyRegistrationHash(), ILIAS\Repository\access(), ANONYMOUS_USER_ID, CLIENT_ID, ILIAS\Repository\ctrl(), ilRBACAccessHandler\doActivationCheck(), ilRBACAccessHandler\doStatusCheck(), ilSecuritySettingsChecker\generatePasswords(), ilParticipants\getDefaultMemberRole(), ilPublicSectionSettings\getInstance(), ilObjectFactory\getInstanceByObjId(), ilObjUser\getLanguage(), ilLoggerFactory\getLogger(), ilObjUser\getPref(), ilInitialisation\goToPublicSection(), ILIAS\FileDelivery\http(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), ILIAS\Repository\mainTemplate(), ilGlobalTemplateInterface\MESSAGE_TYPE_FAILURE, ilGlobalTemplateInterface\MESSAGE_TYPE_SUCCESS, ilObjUser\PASSWD_PLAIN, ilUtil\redirect(), ilInitialisation\redirectToStartingPage(), ILIAS\Repository\refinery(), ROOT_FOLDER_ID, ilSession\set(), ilObjUser\setActive(), ilUtil\setCookie(), ilObjUser\setLastPasswordChangeTS(), ilObjUser\setPasswd(), showLoginPage(), ilObjUser\update(), and ILIAS\Repository\user().

                                      : void
    {
        if ($this->authSession->isValid()) {
            if (!$this->user->isAnonymous() || (
                ilPublicSectionSettings::getInstance()->isEnabledForDomain(
                    $this->httpRequest->getServerParams()['SERVER_NAME']
                ) && $this->access->checkAccessOfUser(ANONYMOUS_USER_ID, 'read', '', ROOT_FOLDER_ID)
            )) {
                ilInitialisation::redirectToStartingPage();
                return;
            }
        }

        if (ilPublicSectionSettings::getInstance()->isEnabledForDomain($_SERVER['SERVER_NAME']) &&
            $this->access->checkAccessOfUser(ANONYMOUS_USER_ID, 'read', '', ROOT_FOLDER_ID)) {
            ilInitialisation::goToPublicSection();
        }

        $this->showLoginPage();
    }

Here is the call graph for this function:

purgePlaceholders()

ilStartUpGUI::purgePlaceholders ( string  $page_editor_html )

private

Definition at line 1077 of file class.ilStartUpGUI.php.

Referenced by showLoginPage().

                                                                : string
    {
        return str_replace(
            [
                '[list-language-selection]',
                '[list-registration-link]',
                '[list-user-agreement]',
                '[list-dpro-agreement]',
                '[list-login-form]',
                '[list-cas-login-form]',
                '[list-saml-login]',
                '[list-shibboleth-login-form]',
                '[list-openid-connect-login]'
            ],
            '',
            $page_editor_html
        );
    }

Here is the caller graph for this function:

retrieveMessagesFromSession()

ilStartUpGUI::retrieveMessagesFromSession ( )

private

Returns

array<string, string>

Definition at line 368 of file class.ilStartUpGUI.php.

References ilSession\get(), ilGlobalTemplateInterface\MESSAGE_TYPE_FAILURE, ilGlobalTemplateInterface\MESSAGE_TYPE_INFO, ilGlobalTemplateInterface\MESSAGE_TYPE_QUESTION, and ilGlobalTemplateInterface\MESSAGE_TYPE_SUCCESS.

Referenced by showLoginPageOrStartupPage().

                                                  : array
    {
        $messages = [];
        $message_types = [
            ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE,
            ilGlobalTemplateInterface::MESSAGE_TYPE_SUCCESS,
            ilGlobalTemplateInterface::MESSAGE_TYPE_INFO,
            ilGlobalTemplateInterface::MESSAGE_TYPE_QUESTION
        ];

        foreach ($message_types as $message_type) {
            if (ilSession::get($message_type)) {
                $messages[$message_type] = ilSession::get($message_type);
            }
        }

        return $messages;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saniziteArrayElementsTrafo()

ilStartUpGUI::saniziteArrayElementsTrafo ( )

private

Definition at line 119 of file class.ilStartUpGUI.php.

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

Referenced by buildAccountMigrationForm(), buildCodeForm(), and buildStandardLoginForm().

                                                 : ILIAS\Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(static function (array $values): array {
            $processed_values = array_merge(
                ilArrayUtil::stripSlashesRecursive($values),
                isset($values[self::PROP_PASSWORD]) ? [self::PROP_PASSWORD => $values[self::PROP_PASSWORD]] : []
            );

            return $processed_values;
        });
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setForcedCommand()

static ilStartUpGUI::setForcedCommand ( string  $cmd )

static

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

                                                        : void
    {
        self::$forced_cmd = $cmd;
    }

showAccountMigration()

ilStartUpGUI::showAccountMigration ( ILIAS\UI\Component\Input\Container\Form\Form  $form = null, string  $message = ''  )

private

Definition at line 1147 of file class.ilStartUpGUI.php.

References ILIAS\Repository\help(), and ILIAS\Repository\mainTemplate().

Referenced by doMigration(), and migrateAccount().

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

        $tpl = self::initStartUpTemplate('tpl.login_account_migration.html');
        $tpl->setVariable('MIG_FORM', $this->ui_renderer->render($form ?? $this->buildAccountMigrationForm()));

        if ($message !== '') {
            $this->mainTemplate->setOnScreenMessage('failure', $message);
        }

        self::printToGlobalTemplate($tpl);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showCASLoginForm()

ilStartUpGUI::showCASLoginForm ( string  $page_editor_html )

private

Definition at line 846 of file class.ilStartUpGUI.php.

References $GLOBALS, ILIAS\Repository\ctrl(), ilUtil\getImagePath(), ILIAS\Repository\lng(), and substituteLoginPageElements().

Referenced by showLoginPage().

                                                               : string
    {
        if ($this->setting->get('cas_active')) {
            $tpl = new ilTemplate('tpl.login_form_cas.html', true, true, 'components/ILIAS/Init');
            $tpl->setVariable('TXT_CAS_LOGIN', $this->lng->txt('login_to_ilias_via_cas'));
            $tpl->setVariable('TXT_CAS_LOGIN_BUTTON', ilUtil::getImagePath('auth/cas_login_button.png'));
            $tpl->setVariable('TXT_CAS_LOGIN_INSTRUCTIONS', $this->setting->get('cas_login_instructions'));
            $this->ctrl->setParameter($this, 'forceCASLogin', '1');
            $tpl->setVariable('TARGET_CAS_LOGIN', $this->ctrl->getLinkTarget($this, 'doCasAuthentication'));
            $this->ctrl->setParameter($this, 'forceCASLogin', '');

            return $this->substituteLoginPageElements(
                $GLOBALS['tpl'],
                $page_editor_html,
                $tpl->get(),
                '[list-cas-login-form]',
                'CAS_LOGIN_FORM'
            );
        }

        return $page_editor_html;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showCodeForm()

ilStartUpGUI::showCodeForm ( string  $username = null, ILIAS\UI\Component\Input\Container\Form\Form  $form = null  )

private

Definition at line 387 of file class.ilStartUpGUI.php.

References ILIAS\Repository\help(), ILIAS\Repository\lng(), and ILIAS\Repository\mainTemplate().

Referenced by processCode().

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

        $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt('time_limit_reached'));

        $tpl = self::initStartUpTemplate('tpl.login_reactivate_code.html');
        $tpl->setVariable('FORM', $this->ui_renderer->render($form ?? $this->buildCodeForm($username)));
        self::printToGlobalTemplate($tpl);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showLegalDocuments()

ilStartUpGUI::showLegalDocuments ( )

protected

Definition at line 1373 of file class.ilStartUpGUI.php.

References $DIC.

                                           : void
    {
        global $DIC;
        $tpl = self::initStartUpTemplate(['agreement.html', 'components/ILIAS/LegalDocuments'], true, false);
        $tpl->setVariable('CONTENT', $DIC['legalDocuments']->agreeContent(self::class, __FUNCTION__));
        self::printToGlobalTemplate($tpl);
    }

showLegalDocumentsLinks()

ilStartUpGUI::showLegalDocumentsLinks ( string  $page_editor_html )

private

Definition at line 1050 of file class.ilStartUpGUI.php.

References $DIC, ANONYMOUS_USER_ID, substituteLoginPageElements(), and ILIAS\Repository\user().

Referenced by showLoginPage().

                                                                      : string
    {
        global $tpl;
        global $DIC;

        if (0 === $this->user->getId()) {
            $this->user->setId(ANONYMOUS_USER_ID);
        }

        $page_editor_html = $this->substituteLoginPageElements(
            $tpl,
            $page_editor_html,
            $DIC['legalDocuments']->loginPageHTML(TermsOfService::ID),
            '[list-user-agreement]',
            'USER_AGREEMENT'
        );
        $page_editor_html = $this->substituteLoginPageElements(
            $tpl,
            $page_editor_html,
            $DIC['legalDocuments']->loginPageHTML(DataProtection::ID),
            '[list-dpro-agreement]',
            'DPRO_AGREEMENT'
        );

        return $page_editor_html;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showLoginForm()

ilStartUpGUI::showLoginForm ( string  $page_editor_html, ILIAS\UI\Component\Input\Container\Form\Form  $form = null  )

private

Definition at line 822 of file class.ilStartUpGUI.php.

References substituteLoginPageElements().

Referenced by showLoginPage().

     : string {
        global $tpl;

        return $this->substituteLoginPageElements(
            $tpl,
            $page_editor_html,
            $this->ui_renderer->render($form ?? $this->buildStandardLoginForm()),
            '[list-login-form]',
            'LOGIN_FORM'
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showLoginInformation()

ilStartUpGUI::showLoginInformation ( string  $page_editor_html, ilGlobalTemplateInterface  $tpl  )

private

Definition at line 837 of file class.ilStartUpGUI.php.

Referenced by showLoginPage().

                                                                                                   : string
    {
        if ($page_editor_html !== '') {
            return $page_editor_html;
        }

        return $page_editor_html;
    }

Here is the caller graph for this function:

showLoginPage()

ilStartUpGUI::showLoginPage ( ILIAS\UI\Component\Input\Container\Form\Form  $form = null )

private

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

References $GLOBALS, ANONYMOUS_USER_ID, ILIAS\Repository\ctrl(), getAuthPageEditorHtml(), ilObjStyleSheet\getContentStylePath(), getLogger(), ilObjStyleSheet\getSyntaxStylePath(), ILIAS\Repository\help(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\mainTemplate(), ilGlobalTemplateInterface\MESSAGE_TYPE_FAILURE, ilGlobalTemplateInterface\MESSAGE_TYPE_SUCCESS, purgePlaceholders(), ILIAS\Repository\refinery(), showCASLoginForm(), showLegalDocumentsLinks(), showLoginForm(), showLoginInformation(), showOpenIdConnectLoginForm(), showRegistrationLinks(), showSamlLoginForm(), and showShibbolethLoginForm().

Referenced by doApacheAuthentication(), doCasAuthentication(), doLTIAuthentication(), doOpenIdConnectAuthentication(), doSamlAuthentication(), doStandardAuthentication(), processCode(), processIndexPHP(), and showLoginPageOrStartupPage().

                                                                                             : void
    {
        global $tpl; // Don't remove this, the global variables will be replaced with a ilGlobalTemplate instnace

        $this->help->setSubScreenId('login');

        $this->getLogger()->debug('Showing login page');

        $extUid = $this->http->wrapper()->query()->retrieve(
            'ext_uid',
            $this->refinery->byTrying([$this->refinery->kindlyTo()->string(), $this->refinery->always('')])
        );

        $soapPw = $this->http->wrapper()->query()->retrieve(
            'soap_pw',
            $this->refinery->byTrying([$this->refinery->kindlyTo()->string(), $this->refinery->always('')])
        );

        $credentials = new ilAuthFrontendCredentialsSoap(
            $GLOBALS['DIC']->http()->request(),
            $this->ctrl,
            $this->setting
        );

        $credentials->setUsername($extUid);
        $credentials->setPassword($soapPw);
        $credentials->tryAuthenticationOnLoginPage();

        $frontend = new ilAuthFrontendCredentialsApache($this->httpRequest, $this->ctrl);
        $frontend->tryAuthenticationOnLoginPage();

        $tpl = self::initStartUpTemplate('tpl.login.html');
        $this->mainTemplate->addCss(ilObjStyleSheet::getContentStylePath(0));
        $this->mainTemplate->addCss(ilObjStyleSheet::getSyntaxStylePath());

        $page_editor_html = $this->getAuthPageEditorHtml(AuthPageEditorContext::LOGIN);
        $page_editor_html = $this->showOpenIdConnectLoginForm($page_editor_html);
        $page_editor_html = $this->showLoginInformation($page_editor_html, $tpl);
        $page_editor_html = $this->showLoginForm($page_editor_html, $form);
        $page_editor_html = $this->showCASLoginForm($page_editor_html);
        $page_editor_html = $this->showShibbolethLoginForm($page_editor_html);
        $page_editor_html = $this->showSamlLoginForm($page_editor_html);
        $page_editor_html = $this->showRegistrationLinks($page_editor_html);
        $page_editor_html = $this->showLegalDocumentsLinks($page_editor_html);
        $page_editor_html = $this->purgePlaceholders($page_editor_html);

        // check expired session and send message
        if ($this->authSession->isExpired() || $this->http->wrapper()->query()->has('session_expired')) {
            $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt('auth_err_expired'));
        } elseif ($this->http->wrapper()->query()->has('reg_confirmation_msg')) {
            $this->lng->loadLanguageModule('registration');
            $message_key = $this->http->wrapper()->query()->retrieve(
                'reg_confirmation_msg',
                $this->refinery->kindlyTo()->string()
            );
            $message_type = $message_key === 'reg_account_confirmation_successful' ?
                ilGlobalTemplateInterface::MESSAGE_TYPE_SUCCESS : ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE;
            $this->mainTemplate->setOnScreenMessage(
                $message_type,
                $this->lng->txt($message_key)
            );
        }

        if ($page_editor_html !== '') {
            $tpl->setVariable('LPE', $page_editor_html);
        }

        if ($this->authSession->isExpired()) {
            // The usr_id is is still the one of the former logged-in user, so we have to unset it
            $this->authSession->setAuthenticated(false, ANONYMOUS_USER_ID);
            $this->dic->user()->setId($this->authSession->getUserId());
            $this->dic->user()->read();
        }

        $this->mainTemplate->setPermanentLink('auth', null, 'login');
        self::printToGlobalTemplate($tpl);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showLoginPageOrStartupPage()

ilStartUpGUI::showLoginPageOrStartupPage ( )

private

According to a (core) code base analysis (ILIAS 8.x until 10.x, 2024-11-05), there is curently no code that redirects to this command/action with "cmd=force_login" as query parameter in a case where the user is still considered as "logged-in". To address https://mantis.ilias.de/view.php?id=29991 we assume that we can ignore such requests to prevent "Logout without CSRF / Denial of Service for Users" and redirect the user to the start page instead.

Definition at line 204 of file class.ilStartUpGUI.php.

References ILIAS\FileDelivery\http(), ILIAS\Repository\logger(), ILIAS\Repository\mainTemplate(), ilInitialisation\redirectToStartingPage(), ILIAS\Repository\refinery(), retrieveMessagesFromSession(), ilSession\SESSION_CLOSE_USER, ilSession\setClosingContext(), showLoginPage(), and ILIAS\Repository\user().

Referenced by executeCommand().

                                                 : void
    {
        if ($this->authSession->isValid() && $this->authSession->getUserId() > 0 && !$this->user->isAnonymous()) {
            ilInitialisation::redirectToStartingPage();
        }

        $is_forced_login = $this->http->wrapper()->query()->retrieve(
            'cmd',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->always(
                    $this->http->wrapper()->post()->retrieve(
                        'cmd',
                        $this->refinery->byTrying([
                            $this->refinery->kindlyTo()->string(),
                            $this->refinery->always('')
                        ])
                    )
                )
            ])
        ) === 'force_login';

        if ($is_forced_login) {
            // Only allow this for anonymous user, see: showLoginPageOrStartupPage
            $this->logger->debug('Force login');
            $messages = [];
            if ($this->authSession->isValid()) {
                $messages = $this->retrieveMessagesFromSession();
                $this->logger->debug('Valid session -> logout current user');
                ilSession::setClosingContext(ilSession::SESSION_CLOSE_USER);
                $this->authSession->logout();

                $this->eventHandler->raise(
                    'components/ILIAS/Authentication',
                    'afterLogout',
                    [
                        'username' => $this->user->getLogin(),
                        'is_explicit_logout' => false,
                    ]
                );

                $this->dic->user()->setId($this->authSession->getUserId());
                $this->dic->user()->read();
            }

            $this->logger->debug('Show login page');
            foreach ($messages as $type => $content) {
                $this->mainTemplate->setOnScreenMessage($type, $content);
            }

            $this->showLoginPage();
            return;
        }

        if ($this->authSession->isValid()) {
            $this->logger->debug('Valid session -> redirect to starting page');
            ilInitialisation::redirectToStartingPage();
            return;
        }

        $this->logger->debug('No valid session -> show login');
        $this->showLoginPage();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showLogout()

ilStartUpGUI::showLogout ( )

private

Definition at line 1284 of file class.ilStartUpGUI.php.

References $_SERVER, $client_id, $url, ilUtil\_getHttpPath(), ilObjUser\_isAnonymous(), ILIAS\Repository\access(), ANONYMOUS_USER_ID, CLIENT_ID, ILIAS\Repository\ctrl(), ilSession\get(), getAuthPageEditorHtml(), ilPublicSectionSettings\getInstance(), ILIAS\Repository\help(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\mainTemplate(), ILIAS\Repository\refinery(), ROOT_FOLDER_ID, ilSession\SESSION_CLOSE_USER, ilSession\setClosingContext(), ilUtil\setCookie(), and ILIAS\Repository\user().

                                 : void
    {
        if (!$this->authSession->isExpired() &&
            $this->authSession->isAuthenticated() &&
            !ilObjUser::_isAnonymous($this->authSession->getUserId())) {
            $this->ctrl->redirectToURL(ilUserUtil::getStartingPointAsUrl());
        }

        $this->help->setSubScreenId('logout');

        $tpl = self::initStartUpTemplate('tpl.logout.html');
        $client_id = $this->http->wrapper()->query()->retrieve(
            'client_id',
            $this->refinery->byTrying([$this->refinery->kindlyTo()->string(), $this->refinery->always('')])
        );

        if (ilPublicSectionSettings::getInstance()->isEnabledForDomain($_SERVER['SERVER_NAME']) &&
            $this->access->checkAccessOfUser(ANONYMOUS_USER_ID, 'read', '', ROOT_FOLDER_ID)) {
            $tpl->setCurrentBlock('homelink');
            $tpl->setVariable('CLIENT_ID', '?client_id=' . $client_id . '&lang=' . $this->lng->getLangKey());
            $tpl->setVariable('TXT_HOME', $this->lng->txt('home'));
            $tpl->parseCurrentBlock();
        }

        $tpl->setVariable('LPE', $this->getAuthPageEditorHtml(AuthPageEditorContext::LOGOUT));
        $tpl->setVariable('TXT_PAGEHEADLINE', $this->lng->txt('logout'));
        $tpl->setVariable('TXT_LOGIN', $this->lng->txt('login_to_ilias'));
        $tpl->setVariable(
            'CLIENT_ID',
            '?client_id=' . $client_id . '&cmd=force_login&lang=' . $this->lng->getLangKey()
        );

        self::printToGlobalTemplate($tpl);
    }

Here is the call graph for this function:

showOpenIdConnectLoginForm()

ilStartUpGUI::showOpenIdConnectLoginForm ( string  $page_editor_html )

private

Definition at line 1740 of file class.ilStartUpGUI.php.

References $GLOBALS, ilOpenIdConnectSettings\getInstance(), initTargetFromQuery(), ILIAS\Repository\lng(), ilOpenIdConnectSettings\LOGIN_ELEMENT_TYPE_IMG, ilOpenIdConnectSettings\LOGIN_ELEMENT_TYPE_TXT, and substituteLoginPageElements().

Referenced by showLoginPage().

                                                                         : string
    {
        $oidc_settings = ilOpenIdConnectSettings::getInstance();
        if ($oidc_settings->getActive()) {
            $tpl = new ilTemplate('tpl.login_element.html', true, true, 'components/ILIAS/OpenIdConnect');

            $this->lng->loadLanguageModule('auth');
            $tpl->setVariable('TXT_OIDCONNECT_HEADER', $this->lng->txt('auth_oidc_login_element_info'));

            $target = $this->initTargetFromQuery();
            $target_str = empty($target) ? '' : ('?target=' . $target);
            switch ($oidc_settings->getLoginElementType()) {
                case ilOpenIdConnectSettings::LOGIN_ELEMENT_TYPE_TXT:
                    $tpl->setVariable('SCRIPT_OIDCONNECT_T', './openidconnect.php' . $target_str);
                    $tpl->setVariable('TXT_OIDC', $oidc_settings->getLoginElemenText());
                    break;

                case ilOpenIdConnectSettings::LOGIN_ELEMENT_TYPE_IMG:
                    $tpl->setVariable('SCRIPT_OIDCONNECT_I', './openidconnect.php' . $target_str);
                    $tpl->setVariable('IMG_SOURCE', $oidc_settings->getImageFilePath());
                    break;
            }

            return $this->substituteLoginPageElements(
                $GLOBALS['tpl'],
                $page_editor_html,
                $tpl->get(),
                '[list-openid-connect-login]',
                'OPEN_ID_CONNECT_LOGIN_FORM'
            );
        }

        return $page_editor_html;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showRegistrationLinks()

ilStartUpGUI::showRegistrationLinks ( string  $page_editor_html )

private

Definition at line 997 of file class.ilStartUpGUI.php.

References $_SERVER, ilRegistrationSettings\_lookupRegistrationType(), ILIAS\Repository\access(), ANONYMOUS_USER_ID, CLIENT_ID, ILIAS\Repository\ctrl(), ilPublicSectionSettings\getInstance(), ilRegistrationSettings\IL_REG_DISABLED, ILIAS\Repository\lng(), ROOT_FOLDER_ID, and substituteLoginPageElements().

Referenced by showLoginPage().

                                                                    : string
    {
        global $tpl;

        $rtpl = new ilTemplate('tpl.login_registration_links.html', true, true, 'components/ILIAS/Init');

        // allow new registrations?
        if (ilRegistrationSettings::_lookupRegistrationType() !== ilRegistrationSettings::IL_REG_DISABLED) {
            $rtpl->setCurrentBlock('new_registration');
            $rtpl->setVariable('REGISTER', $this->lng->txt('registration'));
            $rtpl->setVariable(
                'CMD_REGISTER',
                $this->ctrl->getLinkTargetByClass(ilAccountRegistrationGUI::class)
            );
            $rtpl->parseCurrentBlock();
        }
        // allow password assistance? Surpress option if Authmode is not local database
        if ($this->setting->get('password_assistance')) {
            $rtpl->setCurrentBlock('password_assistance');
            $rtpl->setVariable('FORGOT_PASSWORD', $this->lng->txt('forgot_password'));
            $rtpl->setVariable('FORGOT_USERNAME', $this->lng->txt('forgot_username'));
            $rtpl->setVariable(
                'CMD_FORGOT_PASSWORD',
                $this->ctrl->getLinkTargetByClass(ilPasswordAssistanceGUI::class)
            );
            $rtpl->setVariable(
                'CMD_FORGOT_USERNAME',
                $this->ctrl->getLinkTargetByClass(ilPasswordAssistanceGUI::class, 'showUsernameAssistanceForm')
            );
            $rtpl->setVariable('LANG_ID', $this->lng->getLangKey());
            $rtpl->parseCurrentBlock();
        }

        if (ilPublicSectionSettings::getInstance()->isEnabledForDomain($_SERVER['SERVER_NAME']) &&
            $this->access->checkAccessOfUser(ANONYMOUS_USER_ID, 'read', '', ROOT_FOLDER_ID)) {
            $rtpl->setCurrentBlock('homelink');
            $rtpl->setVariable(
                'CLIENT_ID',
                '?client_id=' . CLIENT_ID . '&lang=' . $this->lng->getLangKey()
            );
            $rtpl->setVariable('TXT_HOME', $this->lng->txt('home'));
            $rtpl->parseCurrentBlock();
        }

        return $this->substituteLoginPageElements(
            $tpl,
            $page_editor_html,
            $rtpl->get(),
            '[list-registration-link]',
            'REG_PWD_CLIENT_LINKS'
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showSamlIdpSelection()

ilStartUpGUI::showSamlIdpSelection ( ilSamlAuth  $auth, array  $idps  )

private

Parameters

list<ilSamlIdp>

$idps

Definition at line 1965 of file class.ilStartUpGUI.php.

References $components, ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), and ILIAS\Repository\mainTemplate().

Referenced by doSamlAuthentication().

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

        self::initStartUpTemplate(['tpl.saml_idp_selection.html', 'components/ILIAS/Saml']);

        $this->ctrl->setTargetScript('saml.php');
        $items = [];
        foreach ($idps as $idp) {
            $this->ctrl->setParameter($this, 'saml_idp_id', $idp->getIdpId());
            $this->ctrl->setParameter($this, 'idpentityid', urlencode($idp->getEntityId()));

            $items[] = $this->ui_factory->link()->standard(
                $idp->getEntityId(),
                $this->ctrl->getLinkTarget($this, 'doSamlAuthentication')
            );
        }

        $components = [
            $this->ui_factory->panel()->standard(
                $this->lng->txt('auth_saml_idp_selection_table_title'),
                [
                    $this->ui_factory->messageBox()->info($this->lng->txt('auth_saml_idp_selection_table_desc')),
                    $this->ui_factory->listing()->unordered(
                        array_map(
                            fn($item) => $this->ui_renderer->render($item),
                            $items
                        )
                    )
                ]
            )
        ];

        $this->mainTemplate->setVariable('CONTENT', $this->ui_renderer->render($components));
        $this->mainTemplate->printToStdout('DEFAULT', false);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showSamlLoginForm()

ilStartUpGUI::showSamlLoginForm ( string  $page_editor_html )

private

Definition at line 1711 of file class.ilStartUpGUI.php.

References $GLOBALS, ilSamlIdp\getActiveIdpList(), ilSamlSettings\getInstance(), initTargetFromQuery(), ILIAS\Repository\lng(), ilUtil\stripSlashes(), and substituteLoginPageElements().

Referenced by showLoginPage().

                                                                : string
    {
        if (count(ilSamlIdp::getActiveIdpList()) > 0 && ilSamlSettings::getInstance()->isDisplayedOnLoginPage()) {
            $tpl = new ilTemplate('tpl.login_form_saml.html', true, true, 'components/ILIAS/Saml');

            $return = '';
            $target = $this->initTargetFromQuery();
            if ($target !== '') {
                $return = '?returnTo=' . urlencode(ilUtil::stripSlashes($target));
            }

            $tpl->setVariable('SAML_SCRIPT_URL', './saml.php' . $return);
            $tpl->setVariable('TXT_LOGIN', $this->lng->txt('saml_log_in'));
            $tpl->setVariable('LOGIN_TO_ILIAS_VIA_SAML', $this->lng->txt('login_to_ilias_via_saml'));
            $tpl->setVariable('TXT_SAML_LOGIN_TXT', $this->lng->txt('saml_login_form_txt'));
            $tpl->setVariable('TXT_SAML_LOGIN_INFO_TXT', $this->lng->txt('saml_login_form_info_txt'));

            return $this->substituteLoginPageElements(
                $GLOBALS['tpl'],
                $page_editor_html,
                $tpl->get(),
                '[list-saml-login]',
                'SAML_LOGIN_FORM'
            );
        }

        return $page_editor_html;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showShibbolethLoginForm()

ilStartUpGUI::showShibbolethLoginForm ( string  $page_editor_html )

private

Definition at line 869 of file class.ilStartUpGUI.php.

References $GLOBALS, initTargetFromQuery(), ILIAS\Repository\lng(), and substituteLoginPageElements().

Referenced by showLoginPage().

                                                                      : string
    {
        $target = $this->initTargetFromQuery();

        if ($this->setting->get('shib_active')) {
            $tpl = new ilTemplate('tpl.login_form_shibboleth.html', true, true, 'components/ILIAS/Init');

            $tpl->setVariable(
                'SHIB_FORMACTION',
                './shib_login.php'
            ); // Bugfix http://ilias.de/mantis/view.php?id=10662 {$tpl->setVariable('SHIB_FORMACTION', $this->ctrl->getFormAction($this));}
            $federation_name = $this->setting->get('shib_federation_name');
            $admin_mail = ' <a href="mailto:' . $this->setting->get('admin_email') . '">ILIAS ' . $this->lng->txt(
                'administrator'
            ) . '</a>.';
            if ($this->setting->get('shib_hos_type') === 'external_wayf') {
                $tpl->setCurrentBlock('shibboleth_login');
                $tpl->setVariable('TXT_SHIB_LOGIN', $this->lng->txt('login_to_ilias_via_shibboleth'));
                $tpl->setVariable('IL_TARGET', $target);
                $tpl->setVariable('TXT_SHIB_FEDERATION_NAME', $this->setting->get('shib_federation_name'));
                $tpl->setVariable('TXT_SHIB_LOGIN_BUTTON', $this->setting->get('shib_login_button'));
                $tpl->setVariable(
                    'TXT_SHIB_LOGIN_INSTRUCTIONS',
                    sprintf(
                        $this->lng->txt('shib_general_login_instructions'),
                        $federation_name,
                        $admin_mail
                    )
                );
                $tpl->setVariable('TXT_SHIB_CUSTOM_LOGIN_INSTRUCTIONS', $this->setting->get('shib_login_instructions'));
                $tpl->parseCurrentBlock();
            } elseif ($this->setting->get('shib_hos_type') == 'embedded_wayf') {
                $tpl->setCurrentBlock('shibboleth_custom_login');
                $customInstructions = stripslashes($this->setting->get('shib_login_instructions'));
                $tpl->setVariable('TXT_SHIB_CUSTOM_LOGIN_INSTRUCTIONS', $customInstructions);
                $tpl->parseCurrentBlock();
            } else {
                $tpl->setCurrentBlock('shibboleth_wayf_login');
                $tpl->setVariable('TXT_SHIB_LOGIN', $this->lng->txt('login_to_ilias_via_shibboleth'));
                $tpl->setVariable('TXT_SHIB_FEDERATION_NAME', $this->setting->get('shib_federation_name'));
                $tpl->setVariable(
                    'TXT_SELECT_HOME_ORGANIZATION',
                    sprintf(
                        $this->lng->txt('shib_select_home_organization'),
                        $this->setting->get('shib_federation_name')
                    )
                );
                $tpl->setVariable('TXT_CONTINUE', $this->lng->txt('btn_next'));
                $tpl->setVariable('TXT_SHIB_HOME_ORGANIZATION', $this->lng->txt('shib_home_organization'));
                $tpl->setVariable(
                    'TXT_SHIB_LOGIN_INSTRUCTIONS',
                    sprintf(
                        $this->lng->txt('shib_general_wayf_login_instructions'),
                        $admin_mail
                    )
                );
                $tpl->setVariable('TXT_SHIB_CUSTOM_LOGIN_INSTRUCTIONS', $this->setting->get('shib_login_instructions'));

                $ilShibbolethWAYF = new ilShibbolethWAYF();

                $tpl->setVariable('TXT_SHIB_INVALID_SELECTION', $ilShibbolethWAYF->showNotice());
                $tpl->setVariable('SHIB_IDP_LIST', $ilShibbolethWAYF->generateSelection());
                $tpl->setVariable('ILW_TARGET', $target);
                $tpl->parseCurrentBlock();
            }

            return $this->substituteLoginPageElements(
                $GLOBALS['tpl'],
                $page_editor_html,
                $tpl->get(),
                '[list-shibboleth-login-form]',
                'SHIB_LOGIN_FORM'
            );
        }

        return $page_editor_html;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

substituteLoginPageElements()

ilStartUpGUI::substituteLoginPageElements (   $tpl, string  $page_editor_html, string  $element_html, string  $placeholder, string  $fallback_tplvar  )

private

Parameters

ilTemplate | ilGlobalTemplateInterface

$tpl

Definition at line 950 of file class.ilStartUpGUI.php.

Referenced by showCASLoginForm(), showLegalDocumentsLinks(), showLoginForm(), showOpenIdConnectLoginForm(), showRegistrationLinks(), showSamlLoginForm(), and showShibbolethLoginForm().

     : string {
        if ($page_editor_html === '') {
            $tpl->setVariable($fallback_tplvar, $element_html);
            return $page_editor_html;
        }

        if (stripos($page_editor_html, $placeholder) === false) {
            $tpl->setVariable($fallback_tplvar, $element_html);
            return $page_editor_html;
        }

        return str_replace($placeholder, $element_html, $page_editor_html);
    }

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilStartUpGUI::$access

private

Definition at line 58 of file class.ilStartUpGUI.php.

$authSession

ilAuthSession ilStartUpGUI::$authSession

private

Definition at line 55 of file class.ilStartUpGUI.php.

$ctrl

ilCtrlInterface ilStartUpGUI::$ctrl

private

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

$dic

ILIAS DI Container ilStartUpGUI::$dic

private

Definition at line 54 of file class.ilStartUpGUI.php.

$eventHandler

ilAppEventHandler ilStartUpGUI::$eventHandler

private

Definition at line 56 of file class.ilStartUpGUI.php.

$forced_cmd

string ilStartUpGUI::$forced_cmd = ''

staticprivate

Definition at line 46 of file class.ilStartUpGUI.php.

$help

ilHelpGUI ilStartUpGUI::$help

private

Definition at line 62 of file class.ilStartUpGUI.php.

$http

HTTPServices ilStartUpGUI::$http

private

Definition at line 61 of file class.ilStartUpGUI.php.

$httpRequest

ServerRequestInterface ilStartUpGUI::$httpRequest

private

Definition at line 53 of file class.ilStartUpGUI.php.

Referenced by doSamlAuthentication().

$lng

ilLanguage ilStartUpGUI::$lng

private

Definition at line 49 of file class.ilStartUpGUI.php.

Referenced by buildStandardLoginForm().

$logger

ilLogger ilStartUpGUI::$logger

private

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

Referenced by getLogger().

$mainTemplate

ilGlobalTemplateInterface ilStartUpGUI::$mainTemplate

private

Definition at line 51 of file class.ilStartUpGUI.php.

$refinery

RefineryFactory ilStartUpGUI::$refinery

private

Definition at line 60 of file class.ilStartUpGUI.php.

$setting

ilSetting ilStartUpGUI::$setting

private

Definition at line 57 of file class.ilStartUpGUI.php.

$ui_factory

ILIAS UI Factory ilStartUpGUI::$ui_factory

private

Definition at line 63 of file class.ilStartUpGUI.php.

$ui_renderer

ILIAS UI Renderer ilStartUpGUI::$ui_renderer

private

Definition at line 64 of file class.ilStartUpGUI.php.

$user

ilObjUser ilStartUpGUI::$user

private

Definition at line 52 of file class.ilStartUpGUI.php.

PROP_ACCOUNT_MIGRATION

const ilStartUpGUI::PROP_ACCOUNT_MIGRATION = 'account_migration'

private

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

PROP_ACCOUNT_MIGRATION_MIGRATE

const ilStartUpGUI::PROP_ACCOUNT_MIGRATION_MIGRATE = 'account_migration_migrate'

private

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

PROP_ACCOUNT_MIGRATION_NEW

const ilStartUpGUI::PROP_ACCOUNT_MIGRATION_NEW = 'account_migration_new'

private

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

PROP_AUTH_MODE

const ilStartUpGUI::PROP_AUTH_MODE = 'auth_mode'

private

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

PROP_CODE

const ilStartUpGUI::PROP_CODE = 'code'

private

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

PROP_PASSWORD

const ilStartUpGUI::PROP_PASSWORD = 'password'

private

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

PROP_USERNAME

const ilStartUpGUI::PROP_USERNAME = 'username'

private

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

---

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

• components/ILIAS/Init/classes/class.ilStartUpGUI.php