ilStartUpGUI Class Reference

StartUp GUI class. More...

Inheritance diagram for ilStartUpGUI:

Collaboration diagram for ilStartUpGUI:

Public Member Functions
	__construct (ilObjUser $user=null, ilTermsOfServiceDocumentEvaluation $termsOfServiceEvaluation=null, ilGlobalTemplateInterface $mainTemplate=null, ServerRequestInterface $httpRequest=null)
	ilStartUpGUI constructor. More...
	getUnsafeGetCommands ()
	getSafePostCommands ()
	executeCommand ()
	execute command More...
	getLogger ()
	Get logger. More...
	jumpToRegistration ()
	jump to registration gui More...
	jumpToPasswordAssistance ()
	jump to password assistance More...
	showAccountMigration (string $message='')
	Show account migration screen. More...
	doLogout ()
	show logout screen More...
	showNoCookiesScreen ()
	show help screen, if cookies are disabled to do: link to online help here More...

Static Public Member Functions
static	printToGlobalTemplate ($tpl)
static	_checkGoto ($a_target)
	Return type depends on _checkGoto calls. More...
static	logoutUrl (array $parameters=[])
	Return the logout URL with a valid CSRF token. More...

Protected Member Functions
	initTargetFromQuery ()
	showLoginPage (ilPropertyFormGUI $form=null)
	retrieveMessagesFromSession ()
	showCodeForm ($a_username=null, $a_form=null)
	initCodeForm (string $a_username)
	processCode ()
	initStandardLoginForm ()
	Initialize the standard. More...
	doShibbolethAuthentication ()
	Trying shibboleth authentication. More...
	doCasAuthentication ()
	doLTIAuthentication ()
	Handle lti requests. More...
	doApacheAuthentication ()
	Try apache auth. More...
	doStandardAuthentication ()
	Check form input; authenticate user. More...
	showLoginForm (string $page_editor_html, ilPropertyFormGUI $form=null)
	Show login form. More...
	showLoginInformation (string $page_editor_html, ilGlobalTemplateInterface $tpl)
	Show login information. More...
	showCASLoginForm (string $page_editor_html)
	Show cas login. More...
	showShibbolethLoginForm (string $page_editor_html)
	Show shibboleth login form. More...
	substituteLoginPageElements ( $tpl, string $page_editor_html, string $element_html, string $placeholder, string $fallback_tplvar)
	Substitute login page elements. More...
	getLoginPageEditorHTML ()
	Get HTML of ILIAS login page editor. More...
	showRegistrationLinks (string $page_editor_html)
	Show registration, password forgotten, client slection links. More...
	showTermsOfServiceLink (string $page_editor_html)
	Show terms of service link. More...
	purgePlaceholders (string $page_editor_html)
	Purge page editor html from unused placeholders. More...
	migrateAccount ()
	doMigrationNewAccount ()
	doMigration ()
	showLogout ()
	Show logout screen. More...
	getAcceptance ()
	Get terms of service. More...
	confirmAcceptance ()
	confirmWithdrawal ()
	showTermsOfService (bool $accepted=false)
	Show terms of service. More...
	processIndexPHP ()
	process index.php More...
	showSamlLoginForm (string $page_editor_html)
	showOpenIdConnectLoginForm (string $page_editor_html)
	doOpenIdConnectAuthentication ()
	do open id connect authentication More...
	doSamlAuthentication ()
	showSamlIdpSelection (ilSamlAuth $auth, array $idps)

Protected Attributes
const	ACCOUNT_MIGRATION_MIGRATE = 1
const	ACCOUNT_MIGRATION_NEW = 2
ilCtrlInterface	$ctrl
ilLanguage	$lng
ilLogger	$logger
ilGlobalTemplateInterface	$mainTemplate
ilObjUser	$user
ilTermsOfServiceDocumentEvaluation	$termsOfServiceEvaluation
ServerRequestInterface	$httpRequest
ILIAS DI Container	$dic
ilAuthSession	$authSession
ilAppEventHandler	$eventHandler
ilSetting	$setting
ilAccessHandler	$access
RefineryFactory	$refinery
HTTPServices	$http
ilHelpGUI	$help

Detailed Description

StartUp GUI class.

Handles Login and Registration.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$ ilStartUpGUI: ilAccountRegistrationGUI, ilPasswordAssistanceGUI, ilLoginPageGUI, ilDashboardGUI ilStartUpGUI: ilMembershipOverviewGUI, ilDerivedTasksGUI, ilAccessibilityControlConceptGUI

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

Constructor & Destructor Documentation

__construct()

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

ilStartUpGUI constructor.

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

References $DIC, $httpRequest, $mainTemplate, $termsOfServiceEvaluation, $user, 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;

        if ($user === null) {
            $user = $DIC->user();
        }
        $this->user = $user;

        if ($termsOfServiceEvaluation === null) {
            $termsOfServiceEvaluation = $DIC['tos.document.evaluator'];
        }
        $this->termsOfServiceEvaluation = $termsOfServiceEvaluation;

        if ($mainTemplate === null) {
            $mainTemplate = $DIC->ui()->mainTemplate();
        }
        $this->mainTemplate = $mainTemplate;

        if ($httpRequest === null) {
            $httpRequest = $DIC->http()->request();
        }
        $this->httpRequest = $httpRequest;

        $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->ctrl->saveParameter($this, array("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

_checkGoto()

static ilStartUpGUI::_checkGoto (   $a_target )

static

Return type depends on _checkGoto calls.

Returns

bool|mixed

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

References $_COOKIE, $_GET, $_SERVER, $DIC, $ilSetting, $ilUser, $lng, $location, $param, $path, $ref_id, XapiProxy\$resp, $tpl, $type, ilObject\_getAllReferences(), ilCourseParticipant\_getInstanceByObjId(), ilObjCourse\_isActivated(), ilGroupParticipants\_isParticipant(), ilLMObject\_lookupContObjID(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilObjCourse\_registrationEnabled(), ilObjUser\_verifyRegistrationHash(), 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(), 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(), ILIAS\Repository\refinery(), ROOT_FOLDER_ID, ilObjUser\setActive(), ilUtil\setCookie(), ilObjUser\setLastPasswordChangeTS(), ilObjUser\setPasswd(), and ilObjUser\update().

    {
        global $DIC;
        global $objDefinition, $ilUser;
        $component_factory = $DIC["component.factory"];

        $access = $DIC->access();

        foreach ($component_factory->getActivePluginsInSlot("uihk") as $ui_plugin) {
            $gui_class = $ui_plugin->getUIClassInstance();
            $resp = $gui_class->checkGotoHook($a_target);
            if ($resp["target"] !== false) {
                $a_target = $resp["target"];
                break;
            }
        }

        if ($a_target == "") {
            return false;
        }

        $t_arr = explode("_", $a_target);
        $type = $t_arr[0];

        if ($type == "git") {
            $type = "glo";
        }

        if ($type == "pg" | $type == "st") {
            $type = "lm";
        }

        $class = $objDefinition->getClassName($type);
        if ($class == "") {
            return false;
        }

        $location = $objDefinition->getLocation($type);
        $full_class = "ilObj" . $class . "Access";
        include_once($location . "/class." . $full_class . ".php");

        $ret = call_user_func(array($full_class, "_checkGoto"), $a_target);

        // if no access and repository object => check for parent course/group
        if (!$ret &&
            !stristr($a_target, "_wsp") &&
            $ilUser->getId() != ANONYMOUS_USER_ID && // #10637
            !$objDefinition->isAdministrationObject($type) &&
            $objDefinition->isRBACObject($type) &&
            $t_arr[1]) {
            global $tree, $rbacsystem, $ilAccess;

            // original type "pg" => pg_<page_id>[_<ref_id>]
            $ref_id = 0;
            if ($t_arr[0] == "pg") {
                if (isset($t_arr[2])) {
                    $ref_id = (int) $t_arr[2];
                } else {
                    $lm_id = ilLMObject::_lookupContObjID($t_arr[1]);
                    $ref_ids = ilObject::_getAllReferences($lm_id);
                    if ($ref_ids) {
                        $ref_id = array_shift($ref_ids);
                    }
                }
            } else {
                $ref_id = (int) $t_arr[1];
            }

            if ($ref_id < 1) {
                return false;
            }

            include_once "Services/Membership/classes/class.ilParticipants.php";
            $block_obj = array();

            // walk path to find parent container
            $path = $tree->getPathId($ref_id);
            array_pop($path);
            foreach ($path as $path_ref_id) {
                $redirect_infopage = false;
                $add_member_role = false;

                $ptype = ilObject::_lookupType($path_ref_id, true);
                $pobj_id = ilObject::_lookupObjId($path_ref_id);

                // core checks: timings/object-specific
                if (
                    !$access->doActivationCheck('read', '', $path_ref_id, $ilUser->getId(), $pobj_id, $ptype) ||
                    !$access->doStatusCheck('read', '', $path_ref_id, $ilUser->getId(), $pobj_id, $ptype)
                ) {
                    // object in path is inaccessible - aborting
                    return false;
                } elseif ($ptype == "crs") {
                    // check if already participant
                    $participants = ilCourseParticipant::_getInstanceByObjId($pobj_id, $ilUser->getId());
                    if (!$participants->isAssigned()) {
                        // subscription currently possible?
                        include_once "Modules/Course/classes/class.ilObjCourse.php";
                        if (ilObjCourse::_isActivated($pobj_id) &&
                            ilObjCourse::_registrationEnabled($pobj_id)) {
                            $block_obj[] = $path_ref_id;
                            $add_member_role = true;
                        } else {
                            $redirect_infopage = true;
                        }
                    }
                } elseif ($ptype == "grp") {
                    // check if already participant
                    include_once "Modules/Group/classes/class.ilGroupParticipants.php";
                    if (!ilGroupParticipants::_isParticipant($path_ref_id, $ilUser->getId())) {
                        // subscription currently possible?
                        include_once "Modules/Group/classes/class.ilObjGroup.php";
                        $group_obj = new ilObjGroup($path_ref_id);
                        if ($group_obj->isRegistrationEnabled()) {
                            $block_obj[] = $path_ref_id;
                            $add_member_role = true;
                        } else {
                            $redirect_infopage = true;
                        }
                    }
                }

                // add members roles for all "blocking" objects
                if ($add_member_role) {
                    // cannot join? goto will never work, so redirect to current object
                    $rbacsystem->resetPACache($ilUser->getId(), $path_ref_id);
                    if (!$rbacsystem->checkAccess("join", $path_ref_id)) {
                        $redirect_infopage = true;
                    } else {
                        $rbacsystem->addTemporaryRole(
                            $ilUser->getId(),
                            ilParticipants::getDefaultMemberRole($path_ref_id)
                        );
                    }
                }

                // redirect to infopage of 1st blocking object in path
                if ($redirect_infopage) {
                    if ($rbacsystem->checkAccess("visible", $path_ref_id)) {
                        ilUtil::redirect("ilias.php?baseClass=ilRepositoryGUI" .
                            "&ref_id=" . $path_ref_id . "&cmd=infoScreen");
                    } else {
                        return false;
                    }
                }
            }

            // check if access will be possible with all (possible) member roles added
            $rbacsystem->resetPACache($ilUser->getId(), $ref_id);
            if ($rbacsystem->checkAccess("read", $ref_id) && sizeof($block_obj)) { // #12128
                // this won't work with lm-pages (see above)
                // include_once "Services/Link/classes/class.ilLink.php";
                // $_SESSION["pending_goto"] = ilLink::_getStaticLink($ref_id, $type);

                // keep original target
                $_SESSION["pending_goto"] = "goto.php?target=" . $a_target;

                // redirect to 1st non-member object in path
                ilUtil::redirect("ilias.php?baseClass=ilRepositoryGUI" .
                    "&ref_id=" . array_shift($block_obj));
            }
        }

        return $ret;
    }

Here is the call graph for this function:

confirmAcceptance()

ilStartUpGUI::confirmAcceptance ( )

protected

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

References showTermsOfService().

                                          : void
    {
        $this->showTermsOfService(true);
    }

Here is the call graph for this function:

confirmWithdrawal()

ilStartUpGUI::confirmWithdrawal ( )

protected

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

References $tpl, ANONYMOUS_USER_ID, ILIAS\Repository\ctrl(), ilLegacyFormElementsUtil\formCheckbox(), ilSystemSupportContacts\getMailsToAddress(), ILIAS\Repository\lng(), ilLegacyFormElementsUtil\prepareFormOutput(), and ILIAS\Repository\user().

                                          : void
    {
        if (!$this->user->getId()) {
            $this->user->setId(ANONYMOUS_USER_ID);
        }
        $back_to_login = false;
        if ($this->user->getPref('consent_withdrawal_requested') != 1) {
            $back_to_login = true;
        }
        $tpl = self::initStartUpTemplate('tpl.view_terms_of_service.html', $back_to_login, !$back_to_login);

        $helper = new ilTermsOfServiceHelper();
        $handleDocument = $helper->isGloballyEnabled() && $this->termsOfServiceEvaluation->hasDocument();
        if ($handleDocument) {
            $document = $this->termsOfServiceEvaluation->document();
            if ('confirmWithdrawal' === $this->ctrl->getCmd()) {
                if (isset($this->httpRequest->getParsedBody()['status']) && 'withdrawn' === $this->httpRequest->getParsedBody()['status']) {
                    $helper->deleteAcceptanceHistoryByUser($this->user->getId());
                    $this->ctrl->redirectToUrl(self::logoutUrl());
                }
            }

            $tpl->setVariable('FORM_ACTION', $this->ctrl->getFormAction($this, $this->ctrl->getCmd()));
            $tpl->setVariable('ACCEPT_CHECKBOX', ilLegacyFormElementsUtil::formCheckbox(0, 'status', 'accepted'));
            $tpl->setVariable('ACCEPT_TERMS_OF_SERVICE', $this->lng->txt('accept_usr_agreement'));
            $tpl->setVariable('TXT_SUBMIT', $this->lng->txt('submit'));

            $tpl->setPermanentLink('usr', null, 'agreement');
            $tpl->setVariable('TERMS_OF_SERVICE_CONTENT', $document->content());
        } else {
            $tpl->setVariable(
                'TERMS_OF_SERVICE_CONTENT',
                sprintf(
                    $this->lng->txt('no_agreement_description'),
                    'mailto:' . ilLegacyFormElementsUtil::prepareFormOutput(
                        ilSystemSupportContacts::getMailsToAddress()
                    )
                )
            );
        }

        self::printToGlobalTemplate($tpl);
    }

Here is the call graph for this function:

doApacheAuthentication()

ilStartUpGUI::doApacheAuthentication ( )

protected

Try apache auth.

Definition at line 649 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(), and showLoginPage().

                                               : 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,
            array($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());
                } else {
                    $this->logger->debug(
                        'Authentication successful, but no valid target URL given. Redirecting to default starting page.'
                    );
                    \ilInitialisation::redirectToStartingPage();
                }
                break;

            case \ilAuthStatus::STATUS_ACCOUNT_MIGRATION_REQUIRED:
                $this->ctrl->redirect($this, 'showAccountMigration');
                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'
                ));
                break;
        }

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

Here is the call graph for this function:

doCasAuthentication()

ilStartUpGUI::doCasAuthentication ( )

protected

Definition at line 567 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,
            array($provider)
        );

        $frontend->authenticate();
        switch ($status->getStatus()) {
            case ilAuthStatus::STATUS_AUTHENTICATED:
                $this->getLogger()->debug('Authentication successful.');
                ilInitialisation::redirectToStartingPage();
                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:

doLogout()

ilStartUpGUI::doLogout

(

)

show logout screen

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

References $DIC, $ilIliasIniFile, ilAuthUtils\AUTH_SAML, CLIENT_ID, ILIAS\Repository\ctrl(), ilSession\get(), ILIAS\Repository\logger(), ilSession\SESSION_CLOSE_USER, ilSession\setClosingContext(), ilUtil\setCookie(), and ILIAS\Repository\user().

                              : void
    {
        global $DIC;

        $ilIliasIniFile = $DIC['ilIliasIniFile'];

        $this->eventHandler->raise(
            'Services/Authentication',
            'beforeLogout',
            [
                'user_id' => $this->user->getId()
            ]
        );

        $user_language = $this->user->getLanguage();

        $tosWithdrawalGui = new ilTermsOfServiceWithdrawalGUIHelper($this->user);
        $tosWithdrawalGui->handleWithdrawalLogoutRequest($this->httpRequest, $this);

        $had_external_authentication = ilSession::get('used_external_auth');

        ilSession::setClosingContext(ilSession::SESSION_CLOSE_USER);
        $this->authSession->logout();
        $this->eventHandler->raise(
            'Services/Authentication',
            'afterLogout',
            array(
                'username' => $this->user->getLogin()
            )
        );
        if ((int) $this->user->getAuthMode(true) == ilAuthUtils::AUTH_SAML && $had_external_authentication) {
            $this->logger->info('Redirecting user to SAML logout script');
            $this->ctrl->redirectToURL('saml.php?action=logout&logout_url=' . urlencode(ILIAS_HTTP_PATH . '/login.php'));
        }

        // reset cookie
        ilUtil::setCookie("ilClientId", "");

        // redirect and show logout information
        $this->ctrl->setParameter($this, 'client_id', CLIENT_ID);
        $this->ctrl->setParameter($this, 'lang', $user_language);
        $this->ctrl->redirect($this, 'showLogout');
    }

Here is the call graph for this function:

doLTIAuthentication()

ilStartUpGUI::doLTIAuthentication ( )

protected

Handle lti requests.

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

References $provider, ilAuthUtils\AUTH_PROVIDER_LTI, ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ILIAS\Repository\ctrl(), ilAuthStatus\getInstance(), ilLoggerFactory\getLogger(), getLogger(), ILIAS\Repository\lng(), ILIAS\Repository\mainTemplate(), ilInitialisation\redirectToStartingPage(), 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,
            array($provider)
        );

        $frontend->authenticate();

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

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

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

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

Here is the call graph for this function:

doMigration()

ilStartUpGUI::doMigration ( )

protected

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

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

Referenced by migrateAccount().

                                    : bool
    {
        $username = '';
        if ($this->http->wrapper()->post()->has('mig_username')) {
            $username = $this->http->wrapper()->post()->retrieve(
                'mig_username',
                $this->refinery->kindlyTo()->string()
            );
        }
        $password = '';
        if ($this->http->wrapper()->post()->has('mig_password')) {
            $password = $this->http->wrapper()->post()->retrieve(
                'mig_password',
                $this->refinery->kindlyTo()->string()
            );
        }

        $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,
            array($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();
                } else {
                    $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt('err_wrong_login'), true);
                    $this->ctrl->redirect($this, 'showAccountMigration');
                }
                break;

            default:
                $this->getLogger()->info('Account migration failed for user ' . $username);
                $this->showAccountMigration($GLOBALS['lng']->txt('err_wrong_login'));
                return false;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doMigrationNewAccount()

ilStartUpGUI::doMigrationNewAccount ( )

protected

Definition at line 1211 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().

                                              : bool
    {
        $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');

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doOpenIdConnectAuthentication()

ilStartUpGUI::doOpenIdConnectAuthentication ( )

protected

do open id connect authentication

Definition at line 1999 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,
            array($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());
                } else {
                    ilInitialisation::redirectToStartingPage();
                }
                return;

            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                $this->mainTemplate->setOnScreenMessage('failure', $status->getTranslatedReason(), true);
                $this->ctrl->redirect($this, 'showLoginPage');
                return;
        }
        $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt('err_wrong_login'));
        $this->showLoginPage();
    }

Here is the call graph for this function:

doSamlAuthentication()

ilStartUpGUI::doSamlAuthentication ( )

protected

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

References $auth, $factory, $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 (1 === count($activeIdps)) {
                    $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',
                (string) $auth->getParam('idpId')
            ));
        }

        // re-init
        $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',
            (string) $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'],
                    (string) $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);
        }

        $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 ?? '');
                return;

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

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

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

Here is the call graph for this function:

doShibbolethAuthentication()

ilStartUpGUI::doShibbolethAuthentication ( )

protected

Trying shibboleth authentication.

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

References $provider, ilAuthUtils\AUTH_SHIBBOLETH, 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 shibboleth authentication');

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

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

        $status = ilAuthStatus::getInstance();

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

        $frontend->authenticate();

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

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

            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                $this->mainTemplate->setOnScreenMessage('failure', $status->getTranslatedReason(), true);
                $this->ctrl->redirect($this, 'showLoginPage');
                return;
        }
        $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt('err_wrong_login'));
        $this->showLoginPage();
    }

Here is the call graph for this function:

doStandardAuthentication()

ilStartUpGUI::doStandardAuthentication ( )

protected

Check form input; authenticate user.

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

References ilAuthModeDetermination\_getInstance(), ilAuthUtils\_hasMultipleAuthenticationMethods(), ilObjUser\_lookupLogin(), ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ILIAS\Repository\ctrl(), ilAuthStatus\getInstance(), ilLoggerFactory\getLogger(), getLogger(), ILIAS\FileDelivery\http(), initCodeForm(), initStandardLoginForm(), ILIAS\Repository\lng(), 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->initStandardLoginForm();
        if ($form->checkInput()) {
            $this->getLogger()->debug('Trying to authenticate user.');

            $auth_callback = function () use ($form) {
                include_once './Services/Authentication/classes/Frontend/class.ilAuthFrontendCredentials.php';
                $credentials = new ilAuthFrontendCredentials();
                $credentials->setUsername($form->getInput('username'));
                $credentials->setPassword($form->getInput('password'));

                // set chosen auth mode
                include_once './Services/Authentication/classes/class.ilAuthModeDetermination.php';
                $det = ilAuthModeDetermination::_getInstance();
                if (ilAuthUtils::_hasMultipleAuthenticationMethods() and $det->isManualSelection()) {
                    $credentials->setAuthMode($form->getInput('auth_mode'));
                }

                include_once './Services/Authentication/classes/Provider/class.ilAuthProviderFactory.php';
                $provider_factory = new ilAuthProviderFactory();
                $providers = $provider_factory->getProviders($credentials);

                include_once './Services/Authentication/classes/class.ilAuthStatus.php';
                $status = ilAuthStatus::getInstance();

                include_once './Services/Authentication/classes/Frontend/class.ilAuthFrontendFactory.php';
                $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 (null !== ($auth_duration = $this->setting->get("auth_duration"))) {
                $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();
                    return;

                case ilAuthStatus::STATUS_CODE_ACTIVATION_REQUIRED:
                    $uname = ilObjUser::_lookupLogin($status->getAuthenticatedUserId());
                    $this->showLoginPage($this->initCodeForm($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);
                    return;
            }
        }
        $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt('err_wrong_login'));
        $this->showLoginPage($form);
    }

Here is the call graph for this function:

executeCommand()

ilStartUpGUI::executeCommand

(

)

execute command

Returns

mixed

See also

register.php

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

References ILIAS\Repository\ctrl().

Referenced by jumpToPasswordAssistance(), and jumpToRegistration().

    {
        $cmd = $this->ctrl->getCmd("processIndexPHP");
        $next_class = $this->ctrl->getNextClass($this);
        switch ($next_class) {
            case 'ilLoginPageGUI':
                break;

            case "ilaccountregistrationgui":
                require_once("Services/Registration/classes/class.ilAccountRegistrationGUI.php");
                return $this->ctrl->forwardCommand(new ilAccountRegistrationGUI());

            case "ilpasswordassistancegui":
                require_once("Services/Init/classes/class.ilPasswordAssistanceGUI.php");
                return $this->ctrl->forwardCommand(new ilPasswordAssistanceGUI());

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getAcceptance()

ilStartUpGUI::getAcceptance ( )

protected

Get terms of service.

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

References showTermsOfService().

                                      : void
    {
        $this->showTermsOfService();
    }

Here is the call graph for this function:

getLogger()

ilStartUpGUI::getLogger

(

)

Get logger.

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

References $logger.

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

                               : ilLogger
    {
        return $this->logger;
    }

Here is the caller graph for this function:

getLoginPageEditorHTML()

ilStartUpGUI::getLoginPageEditorHTML ( )

protected

Get HTML of ILIAS login page editor.

Returns

string html

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

References ilPageUtil\_existsAndNotEmpty(), ilAuthLoginPageEditorSettings\getInstance(), ILIAS\Repository\lng(), and ilLanguage\lookupId().

Referenced by showLoginPage().

                                               : string
    {
        include_once './Services/Authentication/classes/class.ilAuthLoginPageEditorSettings.php';
        $lpe = ilAuthLoginPageEditorSettings::getInstance();
        $active_lang = $lpe->getIliasEditorLanguage($this->lng->getLangKey());

        if (!$active_lang) {
            return '';
        }

        // if page does not exist, return nothing
        include_once './Services/COPage/classes/class.ilPageUtil.php';
        if (!ilPageUtil::_existsAndNotEmpty('auth', ilLanguage::lookupId($active_lang))) {
            return '';
        }

        // get page object
        $page_gui = new ilLoginPageGUI(ilLanguage::lookupId($active_lang));

        include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
        $page_gui->setStyleId(0);

        $page_gui->setPresentationTitle("");
        $page_gui->setTemplateOutput(false);
        $page_gui->setHeader("");
        $ret = $page_gui->showPage();

        return $ret;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSafePostCommands()

ilStartUpGUI::getSafePostCommands

(

)

Implements ilCtrlSecurityInterface.

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

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

getUnsafeGetCommands()

ilStartUpGUI::getUnsafeGetCommands

(

)

Implements ilCtrlSecurityInterface.

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

                                          : array
    {
        return [
            'doLogout'
        ];
    }

initCodeForm()

ilStartUpGUI::initCodeForm ( string  $a_username )

protected

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

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

Referenced by doStandardAuthentication(), processCode(), and showCodeForm().

                                                       : ilPropertyFormGUI
    {
        $this->lng->loadLanguageModule("auth");
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, 'showcodeform'));
        $form->setTitle($this->lng->txt('auth_account_code_title'));

        $count = new ilTextInputGUI($this->lng->txt('auth_account_code'), 'code');
        $count->setRequired(true);
        $count->setInfo($this->lng->txt('auth_account_code_info'));
        $form->addItem($count);

        // #11658
        $uname = new ilHiddenInputGUI("uname");
        $uname->setValue($a_username);
        $form->addItem($uname);
        $form->addCommandButton('processCode', $this->lng->txt('send'));
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initStandardLoginForm()

ilStartUpGUI::initStandardLoginForm ( )

protected

Initialize the standard.

Returns

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

References ILIAS\LTI\ToolProvider\$key, ilAuthModeDetermination\_getInstance(), ilAuthUtils\_getMultipleAuthModeOptions(), ilAuthUtils\_hasMultipleAuthenticationMethods(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilPasswordInputGUI\setUseStripSlashes().

Referenced by doStandardAuthentication(), and showLoginForm().

                                              : ilPropertyFormGUI
    {
        include_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, 'doStandardAuthentication'));
        $form->setName("formlogin");
        $form->setShowTopButtons(false);
        $form->setTitle($this->lng->txt("login_to_ilias"));

        include_once './Services/Authentication/classes/class.ilAuthModeDetermination.php';
        $det = ilAuthModeDetermination::_getInstance();
        if (ilAuthUtils::_hasMultipleAuthenticationMethods() and $det->isManualSelection()) {
            $visible_auth_methods = array();
            $radg = new ilRadioGroupInputGUI($this->lng->txt("auth_selection"), "auth_mode");
            foreach (ilAuthUtils::_getMultipleAuthModeOptions($this->lng) as $key => $option) {
                if (isset($option['hide_in_ui']) && $option['hide_in_ui']) {
                    continue;
                }

                $op1 = new ilRadioOption($option['txt'], $key);
                $radg->addOption($op1);
                if (isset($option['checked'])) {
                    $radg->setValue($key);
                }
                $visible_auth_methods[] = $op1;
            }

            if (count($visible_auth_methods) === 1) {
                $first_auth_method = current($visible_auth_methods);
                $hidden_auth_method = new ilHiddenInputGUI("auth_mode");
                $hidden_auth_method->setValue($first_auth_method->getValue());
                $form->addItem($hidden_auth_method);
            } else {
                $form->addItem($radg);
            }
        }

        $ti = new ilTextInputGUI($this->lng->txt("username"), "username");
        $ti->setSize(20);
        $ti->setRequired(true);
        $form->addItem($ti);

        $pi = new ilPasswordInputGUI($this->lng->txt("password"), "password");
        $pi->setUseStripSlashes(false);
        $pi->setRetype(false);
        $pi->setSkipSyntaxCheck(true);
        $pi->setSize(20);
        $pi->setDisableHtmlAutoComplete(false);
        $pi->setRequired(true);
        $form->addItem($pi);

        $form->addCommandButton("doStandardAuthentication", $this->lng->txt("log_in"));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initTargetFromQuery()

ilStartUpGUI::initTargetFromQuery ( )

protected

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

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

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

                                            : string
    {
        if ($this->http->wrapper()->query()->has('target')) {
            return $this->http->wrapper()->query()->retrieve(
                'target',
                $this->refinery->kindlyTo()->string()
            );
        }
        return '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

jumpToPasswordAssistance()

ilStartUpGUI::jumpToPasswordAssistance

(

)

jump to password assistance

See also

pwassist.php

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

References $authSession, $eventHandler, $messages, $type, ILIAS\Repository\ctrl(), executeCommand(), ILIAS\Repository\logger(), ILIAS\Repository\mainTemplate(), ilInitialisation\redirectToStartingPage(), retrieveMessagesFromSession(), ilSession\SESSION_CLOSE_USER, ilSession\setClosingContext(), showLoginPage(), and ILIAS\Repository\user().

                                              : void
    {
        $this->ctrl->setCmdClass("ilpasswordassistancegui");
        $this->ctrl->setCmd("");
        $this->executeCommand();
    }

Here is the call graph for this function:

jumpToRegistration()

ilStartUpGUI::jumpToRegistration

(

)

jump to registration gui

See also

register.php

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

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

                                        : void
    {
        $this->ctrl->setCmdClass("ilaccountregistrationgui");
        $this->ctrl->setCmd("");
        $this->executeCommand();
    }

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

References $DIC, and $url.

Referenced by ILIAS\User\Provider\UserMetaBarProvider\getMetaBarItems(), ilTermsOfServiceWithdrawalGUIHelper\getWithdrawalSectionForModal(), and ilAuthProviderOpenIdConnect\handleLogout().

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

migrateAccount()

ilStartUpGUI::migrateAccount ( )

protected

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

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

                                       : void
    {
        if (!isset($this->httpRequest->getParsedBody()['account_migration'])) {
            $this->showAccountMigration(
                $this->lng->txt('select_one')
            );
            return;
        }

        if (
            ((int) $this->httpRequest->getParsedBody()['account_migration'] === self::ACCOUNT_MIGRATION_MIGRATE) &&
            (
                !isset($this->httpRequest->getParsedBody()['mig_username']) ||
                !is_string($this->httpRequest->getParsedBody()['mig_username']) ||
                0 === strlen($this->httpRequest->getParsedBody()['mig_username']) ||
                !isset($this->httpRequest->getParsedBody()['mig_password']) ||
                !is_string($this->httpRequest->getParsedBody()['mig_password'])
            )
        ) {
            $this->showAccountMigration(
                $this->lng->txt('err_wrong_login')
            );
            return;
        }

        if ((int) $this->httpRequest->getParsedBody()['account_migration'] == self::ACCOUNT_MIGRATION_MIGRATE) {
            $this->doMigration();
            return;
        } elseif ((int) $this->httpRequest->getParsedBody()['account_migration'] == static::ACCOUNT_MIGRATION_NEW) {
            $this->doMigrationNewAccount();
            return;
        }
        return;
    }

Here is the call graph for this function:

printToGlobalTemplate()

static ilStartUpGUI::printToGlobalTemplate (   $tpl )

static

Parameters

ilTemplate | ilGlobalTemplateInterface

$tpl

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

References $DIC, and $tpl.

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 ( )

protected

Todo:

needs rafactoring

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

References $GLOBALS, ilObjUser\_lookupId(), ilAccountCode\applyAccessLimits(), ilAccountCode\applyRoleAssignments(), ILIAS\Repository\ctrl(), ilAccountCode\getCodeValidUntil(), initCodeForm(), ilAccountCode\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 ilAccountCode\useCode().

                                    : ?bool
    {
        $uname = $_POST["uname"];
        $form = $this->initCodeForm($uname);
        if ($uname && $form->checkInput()) {
            $code = $form->getInput("code");
            if (ilAccountCode::isUnusedCode($code)) {
                $valid_until = ilAccountCode::getCodeValidUntil($code);
                if (!$user_id = ilObjUser::_lookupId($uname)) {
                    $this->showLoginPage();
                    return false;
                }
                $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,
                            $valid_until[1],
                            $valid_until[2],
                            $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);
                    ilAccountCode::useCode($code);
                    // apply registration code role assignments
                    ilAccountCode::applyRoleAssignments($user, $code);
                    // apply registration code tie limits
                    ilAccountCode::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");
            $field = $form->getItemByPostVar("code");
            $field->setAlert($this->lng->txt("user_account_code_not_valid"));
        }

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

Here is the call graph for this function:

processIndexPHP()

ilStartUpGUI::processIndexPHP ( )

protected

process index.php

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

References $_SERVER, $ilIliasIniFile, $ilSetting, ilPublicSectionSettings\getInstance(), ilInitialisation\goToPublicSection(), ilInitialisation\redirectToStartingPage(), showLoginPage(), and ILIAS\Repository\user().

                                        : void
    {
        global $ilIliasIniFile, $ilAuth, $ilSetting;

        // In case of an valid session, redirect to starting page
        if ($this->authSession->isValid()) {
            if (!$this->user->isAnonymous() || ilPublicSectionSettings::getInstance()->isEnabledForDomain(
                $this->httpRequest->getServerParams()['SERVER_NAME']
            )) {
                ilInitialisation::redirectToStartingPage();
                return;
            }
        }

        if (ilPublicSectionSettings::getInstance()->isEnabledForDomain($_SERVER['SERVER_NAME'])) {
            ilInitialisation::goToPublicSection();
        }

        // otherwise show login page
        $this->showLoginPage();
    }

Here is the call graph for this function:

purgePlaceholders()

ilStartUpGUI::purgePlaceholders ( string  $page_editor_html )

protected

Purge page editor html from unused placeholders.

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

Referenced by showLoginPage().

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

Here is the caller graph for this function:

retrieveMessagesFromSession()

ilStartUpGUI::retrieveMessagesFromSession ( )

protected

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

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

Referenced by jumpToPasswordAssistance().

                                                    : array
    {
        $messages = [];
        if (ilSession::get(ilGlobalTemplate::MESSAGE_TYPE_FAILURE)) {
            $messages[ilGlobalTemplate::MESSAGE_TYPE_FAILURE] = ilSession::get(ilGlobalTemplate::MESSAGE_TYPE_FAILURE);
        }
        if (ilSession::get(ilGlobalTemplate::MESSAGE_TYPE_SUCCESS)) {
            $messages[ilGlobalTemplate::MESSAGE_TYPE_SUCCESS] = ilSession::get(ilGlobalTemplate::MESSAGE_TYPE_SUCCESS);
        }
        if (ilSession::get(ilGlobalTemplate::MESSAGE_TYPE_INFO)) {
            $messages[ilGlobalTemplate::MESSAGE_TYPE_INFO] = ilSession::get(ilGlobalTemplate::MESSAGE_TYPE_INFO);
        }
        if (ilSession::get(ilGlobalTemplate::MESSAGE_TYPE_QUESTION)) {
            $messages[ilGlobalTemplate::MESSAGE_TYPE_QUESTION] = ilSession::get(ilGlobalTemplate::MESSAGE_TYPE_QUESTION);
        }
        return $messages;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showAccountMigration()

ilStartUpGUI::showAccountMigration

(

string

$message = ''

)

Show account migration screen.

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

References $message, $tpl, ilRadioOption\addSubItem(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ILIAS\Repository\mainTemplate(), ilLegacyFormElementsUtil\prepareFormOutput(), ilPasswordInputGUI\setRetype(), ilRadioGroupInputGUI\setValue(), and ilRadioOption\setValue().

Referenced by doMigration(), and migrateAccount().

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

        $tpl = self::initStartUpTemplate('tpl.login_account_migration.html');

        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, 'migrateAccount'));

        $form->setTitle($this->lng->txt('auth_account_migration'));
        $form->addCommandButton('migrateAccount', $this->lng->txt('save'));
        $form->addCommandButton('showLogin', $this->lng->txt('cancel'));

        $rad = new ilRadioGroupInputGUI($this->lng->txt('auth_account_migration_name'), 'account_migration');
        $rad->setValue(1);

        $keep = new ilRadioOption(
            $this->lng->txt('auth_account_migration_keep'),
            static::ACCOUNT_MIGRATION_MIGRATE,
            $this->lng->txt('auth_info_migrate')
        );
        $user = new ilTextInputGUI($this->lng->txt('login'), 'mig_username');
        $user->setRequired(true);
        $user->setValue(
            ilLegacyFormElementsUtil::prepareFormOutput(
                (string) ($this->httpRequest->getParsedBody()['mig_username'] ?? '')
            )
        );
        $user->setSize(32);
        $user->setMaxLength(128);
        $keep->addSubItem($user);

        $pass = new ilPasswordInputGUI($this->lng->txt('password'), 'mig_password');
        $pass->setRetype(false);
        $pass->setRequired(true);
        $pass->setValue(
            ilLegacyFormElementsUtil::prepareFormOutput(
                (string) ($this->httpRequest->getParsedBody()['mig_password'] ?? '')
            )
        );
        $pass->setSize(12);
        $pass->setMaxLength(128);
        $keep->addSubItem($pass);
        $rad->addOption($keep);

        $new = new ilRadioOption(
            $this->lng->txt('auth_account_migration_new'),
            static::ACCOUNT_MIGRATION_NEW,
            $this->lng->txt('auth_info_add')
        );
        $rad->addOption($new);

        $form->addItem($rad);

        $tpl->setVariable('MIG_FORM', $form->getHTML());

        if (strlen($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 )

protected

Show cas login.

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

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

Referenced by showLoginPage().

                                                                 : string
    {
        // cas login link
        if ($this->setting->get("cas_active")) {
            $tpl = new ilTemplate('tpl.login_form_cas.html', true, true, 'Services/Init');
            $tpl->setVariable("TXT_CAS_LOGIN", $this->lng->txt("login_to_ilias_via_cas"));
            $tpl->setVariable("TXT_CAS_LOGIN_BUTTON", ilUtil::getImagePath("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 (   $a_username = null,   $a_form = null  )

protected

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

References $tpl, ILIAS\Repository\help(), initCodeForm(), 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", ($a_form ?? $this->initCodeForm($a_username))->getHTML());

        self::printToGlobalTemplate($tpl);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showLoginForm()

ilStartUpGUI::showLoginForm ( string  $page_editor_html, ilPropertyFormGUI  $form = null  )

protected

Show login form.

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

References $tpl, ilAuthUtils\AUTH_CAS, ilAuthUtils\AUTH_SHIBBOLETH, initStandardLoginForm(), and substituteLoginPageElements().

Referenced by showLoginPage().

                                                                                              : string
    {
        global $tpl;

        // @todo move this to auth utils.
        // login via ILIAS (this also includes ldap)
        // If local authentication is enabled for shibboleth users, we
        // display the login form for ILIAS here.
        if (($this->setting->get("auth_mode") != ilAuthUtils::AUTH_SHIBBOLETH ||
                $this->setting->get("shib_auth_allow_local")) &&
            $this->setting->get("auth_mode") != ilAuthUtils::AUTH_CAS) {
            if (!$form instanceof ilPropertyFormGUI) {
                $form = $this->initStandardLoginForm();
            }

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

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  )

protected

Show login information.

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

References ILIAS\Repository\lng(), and ilGlobalTemplateInterface\setVariable().

Referenced by showLoginPage().

                                                                                                     : string
    {
        if (strlen($page_editor_html)) {
            // page editor active return
            return $page_editor_html;
        }

        $loginSettings = new ilSetting("login_settings");
        $information = $loginSettings->get("login_message_" . $this->lng->getLangKey());

        if (strlen(trim($information))) {
            $tpl->setVariable("TXT_LOGIN_INFORMATION", $information);
        }
        return $page_editor_html;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showLoginPage()

ilStartUpGUI::showLoginPage ( ilPropertyFormGUI  $form = null )

protected

Parameters

\ilPropertyFormGUI | null

$form

Todo:

check for forced authentication like ecs, ... Show login page

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

References $GLOBALS, $tpl, ILIAS\Repository\ctrl(), ilObjStyleSheet\getContentStylePath(), getLogger(), getLoginPageEditorHTML(), 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(), showLoginForm(), showLoginInformation(), showOpenIdConnectLoginForm(), showRegistrationLinks(), showSamlLoginForm(), showShibbolethLoginForm(), showTermsOfServiceLink(), and ILIAS\Repository\user().

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

                                                                    : void
    {
        global $tpl;

        $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->getLoginPageEditorHTML();
        $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->showTermsOfServiceLink($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 = "reg_account_confirmation_successful" === $message_key ?
                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);
        }
        $tosWithdrawalGui = new ilTermsOfServiceWithdrawalGUIHelper($this->user);
        $tosWithdrawalGui->setWithdrawalInfoForLoginScreen($this->httpRequest);
        self::printToGlobalTemplate($tpl);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showLogout()

ilStartUpGUI::showLogout ( )

protected

Show logout screen.

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

References $_SERVER, $client_id, $DIC, $ilIliasIniFile, $tpl, ilPublicSectionSettings\getInstance(), ILIAS\Repository\help(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

                                   : void
    {
        global $DIC;

        $ilIliasIniFile = $DIC['ilIliasIniFile'];

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

        $tpl = self::initStartUpTemplate("tpl.logout.html");
        $client_id = '';
        if ($this->http->wrapper()->query()->has('client_id')) {
            $client_id = $this->http->wrapper()->query()->retrieve(
                'client_id',
                $this->refinery->kindlyTo()->string()
            );
        }
        if (ilPublicSectionSettings::getInstance()->isEnabledForDomain($_SERVER['SERVER_NAME'])) {
            $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();
        }

        $tosWithdrawalGui = new ilTermsOfServiceWithdrawalGUIHelper($this->user);

        $tpl->setVariable("TXT_PAGEHEADLINE", $this->lng->txt("logout"));
        $tpl->setVariable(
            "TXT_LOGOUT_TEXT",
            $this->lng->txt("logout_text") . $tosWithdrawalGui->getWithdrawalTextForLogoutScreen($this->httpRequest)
        );
        $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:

showNoCookiesScreen()

ilStartUpGUI::showNoCookiesScreen

(

)

show help screen, if cookies are disabled to do: link to online help here

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

References $tpl.

                                         : void
    {
        global $tpl;

        $str = "<p style=\"margin:15px;\">
                        You need to enable Session Cookies in your Browser to use ILIAS.
                        <br/>
                        <br/><b>Firefox</b>
                        <br/>Tools -> Options -> Privacy -> Cookies
                        <br/>Enable 'Allow sites to set cookies' and activate option 'Keep
                        <br/>cookies' auf 'until I close Firefox'
                        <br/>
                        <br/><b>Mozilla/Netscape</b>
                        <br/>Edit -> Preferences -> Privacy&Security -> Cookies
                        <br/>Go to 'Cookie Lifetime Policy' and check option 'Accept for current
                        <br/>session only'.
                        <br/>
                        <br/><b>Internet Explorer</b>
                        <br/>Tools -> Internet Options -> Privacy -> Advanced
                        <br/>- Check 'Override automatic cookie handling'
                        <br/>- Check 'Always allow session cookies'
                        </p>";
        $tpl->setVariable("CONTENT", $str);
        $tpl->printToStdout();
    }

showOpenIdConnectLoginForm()

ilStartUpGUI::showOpenIdConnectLoginForm ( string  $page_editor_html )

protected

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

References $GLOBALS, $tpl, 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, 'Services/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', ILIAS_HTTP_PATH . '/openidconnect.php' . $target_str);
                    $tpl->setVariable('TXT_OIDC', $oidc_settings->getLoginElemenText());
                    break;

                case ilOpenIdConnectSettings::LOGIN_ELEMENT_TYPE_IMG:
                    $tpl->setVariable('SCRIPT_OIDCONNECT_I', ILIAS_HTTP_PATH . '/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 )

protected

Show registration, password forgotten, client slection links.

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

References $_SERVER, $ilIliasIniFile, $tpl, 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, $ilIliasIniFile;

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

        // allow new registrations?
        include_once 'Services/Registration/classes/class.ilRegistrationSettings.php';
        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", "")
            );
            $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", "")
            );
            $rtpl->setVariable(
                "CMD_FORGOT_USERNAME",
                $this->ctrl->getLinkTargetByClass("ilpasswordassistancegui", "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  )

protected

Parameters

ilSamlAuth	$auth
	ilSamlIdp[]	$idps

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

References $DIC, $factory, ILIAS\Repository\ctrl(), ILIAS\Repository\help(), and ILIAS\Repository\mainTemplate().

Referenced by doSamlAuthentication().

                                                                          : void
    {
        global $DIC;

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

        self::initStartUpTemplate(array('tpl.saml_idp_selection.html', 'Services/Saml'));

        $factory = $DIC->ui()->factory();
        $renderer = $DIC->ui()->renderer();
        $DIC->ctrl()->setTargetScript('saml.php');
        $items = [];
        $table = new ilSamlIdpSelectionTableGUI($this, 'doSamlAuthentication');
        foreach ($idps as $idp) {
            $DIC->ctrl()->setParameter($this, 'saml_idp_id', $idp->getIdpId());
            $DIC->ctrl()->setParameter($this, 'idpentityid', urlencode($idp->getEntityId()));

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

        $table->setData($items);
        $this->mainTemplate->setVariable('CONTENT', $table->getHtml());
        $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 )

protected

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

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

Referenced by showLoginPage().

                                                                  : string
    {
        require_once 'Services/Saml/classes/class.ilSamlIdp.php';
        require_once 'Services/Saml/classes/class.ilSamlSettings.php';

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

            $return = '';
            $target = $this->initTargetFromQuery();
            if (strlen($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 )

protected

Show shibboleth login form.

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

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

Referenced by showLoginPage().

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

        // shibboleth login link
        if ($this->setting->get("shib_active")) {
            $tpl = new ilTemplate('tpl.login_form_shibboleth.html', true, true, 'Services/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:

showTermsOfService()

ilStartUpGUI::showTermsOfService ( bool  $accepted = false )

protected

Show terms of service.

Parameters

bool

$accepted

Exceptions

ilTermsOfServiceMissingDatabaseAdapterException
ilTermsOfServiceNoSignableDocumentFoundException
ilTermsOfServiceUnexpectedCriteriaBagContentException

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

References $tpl, ANONYMOUS_USER_ID, CLIENT_ID, ILIAS\Repository\ctrl(), ilSession\get(), ilSystemSupportContacts\getMailsToAddress(), ILIAS\Repository\help(), initTargetFromQuery(), ILIAS\Repository\lng(), ILIAS\Repository\mainTemplate(), ilLegacyFormElementsUtil\prepareFormOutput(), ilSession\set(), and ILIAS\Repository\user().

Referenced by confirmAcceptance(), and getAcceptance().

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

        $back_to_login = ('getAcceptance' !== $this->ctrl->getCmd());
        $target = $this->initTargetFromQuery();

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

        $tpl = self::initStartUpTemplate('tpl.view_terms_of_service.html', $back_to_login, !$back_to_login);

        $is_read_only_view = true;

        $helper = new ilTermsOfServiceHelper();
        $handleDocument = $helper->isGloballyEnabled() && $this->termsOfServiceEvaluation->hasDocument();
        if ($handleDocument) {
            $document = $this->termsOfServiceEvaluation->document();
            if (
                'confirmAcceptance' === $this->ctrl->getCmd() ||
                'getAcceptance' === $this->ctrl->getCmd()
            ) {
                if ($accepted) {
                    $helper->trackAcceptance($this->user, $document);

                    if (ilSession::get('orig_request_target')) {
                        $target = ilSession::get('orig_request_target');
                        ilSession::set('orig_request_target', '');
                        $this->ctrl->redirectToURL($target);
                    } else {
                        $this->ctrl->redirectToURL('index.php?target=' . $target . '&client_id=' . CLIENT_ID);
                    }
                }

                $this->mainTemplate->setTitle($this->lng->txt('accept_usr_agreement'));
                $this->mainTemplate->setOnScreenMessage('info', $this->lng->txt('accept_usr_agreement_intro'));
                $is_read_only_view = false;

                $tpl->setVariable('FORM_ACTION', $this->ctrl->getFormAction($this, $this->ctrl->getCmd()));
                $tpl->setVariable('ACCEPT_TERMS_OF_SERVICE', $this->lng->txt('accept_usr_agreement'));
                $tpl->setVariable('TXT_ACCEPT', $this->lng->txt('accept_usr_agreement_btn'));
                $tpl->setVariable('DENY_TERMS_OF_SERVICE', $this->lng->txt('deny_usr_agreement'));
                $tpl->setVariable(
                    'DENIAL_BUTTON',
                    $this->dic->ui()->renderer()->render(
                        $this->dic->ui()->factory()->button()->standard(
                            $this->dic->language()->txt('deny_usr_agreement_btn'),
                            self::logoutUrl(['withdraw_consent' => ''])
                        )
                    )
                );
            }

            $tpl->setPermanentLink('usr', 0, 'agreement');
            $tpl->setVariable('TERMS_OF_SERVICE_CONTENT', $document->content());
        } else {
            $tpl->setVariable(
                'TERMS_OF_SERVICE_CONTENT',
                sprintf(
                    $this->lng->txt('no_agreement_description'),
                    'mailto:' . ilLegacyFormElementsUtil::prepareFormOutput(
                        ilSystemSupportContacts::getMailsToAddress()
                    )
                )
            );
        }

        if ($is_read_only_view) {
            if ($this->user->isAnonymous()) {
                $this->lng->loadLanguageModule('tos');
                $this->mainTemplate->setTitle($this->lng->txt('tos_accept_usr_agreement_anonymous'));
                $this->mainTemplate->setOnScreenMessage('info', $this->lng->txt('tos_accept_usr_agreement_anonymous_intro'));
            } else {
                $this->mainTemplate->setTitle($this->lng->txt('usr_agreement'));
                $this->mainTemplate->setOnScreenMessage('info', $this->lng->txt('usr_agreement_footer_intro'));
            }
        }

        self::printToGlobalTemplate($tpl);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showTermsOfServiceLink()

ilStartUpGUI::showTermsOfServiceLink ( string  $page_editor_html )

protected

Show terms of service link.

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

References $GLOBALS, $tpl, ANONYMOUS_USER_ID, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), substituteLoginPageElements(), and ILIAS\Repository\user().

Referenced by showLoginPage().

                                                                       : string
    {
        global $tpl;

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

        $helper = new ilTermsOfServiceHelper();
        if ($helper->isGloballyEnabled() && $this->termsOfServiceEvaluation->hasDocument()) {
            $utpl = new ilTemplate('tpl.login_terms_of_service_link.html', true, true, 'Services/Init');
            $utpl->setVariable('TXT_TERMS_OF_SERVICE', $this->lng->txt('usr_agreement'));
            $utpl->setVariable('LINK_TERMS_OF_SERVICE', $this->ctrl->getLinkTarget($this, 'showTermsOfService'));

            return $this->substituteLoginPageElements(
                $tpl,
                $page_editor_html,
                $utpl->get(),
                '[list-user-agreement]',
                'USER_AGREEMENT'
            );
        }

        return $this->substituteLoginPageElements(
            $GLOBALS['tpl'],
            $page_editor_html,
            '',
            '[list-user-agreement]',
            'USER_AGREEMENT'
        );
    }

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  )

protected

Substitute login page elements.

Parameters

ilTemplate | ilGlobalTemplateInterface	$tpl
string	$page_editor_html
string	$element_html
string	$placeholder
string	$fallback_tplvar	return string $page_editor_html

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

References $tpl.

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

     : string {
        if (!strlen($page_editor_html)) {
            $tpl->setVariable($fallback_tplvar, $element_html);
            return $page_editor_html;
        }
        // Try to replace placeholders
        if (!stristr($page_editor_html, $placeholder)) {
            $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

protected

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

$authSession

ilAuthSession ilStartUpGUI::$authSession

protected

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

Referenced by jumpToPasswordAssistance().

$ctrl

ilCtrlInterface ilStartUpGUI::$ctrl

protected

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

$dic

ILIAS DI Container ilStartUpGUI::$dic

protected

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

$eventHandler

ilAppEventHandler ilStartUpGUI::$eventHandler

protected

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

Referenced by jumpToPasswordAssistance().

$help

ilHelpGUI ilStartUpGUI::$help

protected

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

$http

HTTPServices ilStartUpGUI::$http

protected

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

$httpRequest

ServerRequestInterface ilStartUpGUI::$httpRequest

protected

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

Referenced by __construct(), and doSamlAuthentication().

$lng

ilLanguage ilStartUpGUI::$lng

protected

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

Referenced by _checkGoto().

$logger

ilLogger ilStartUpGUI::$logger

protected

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

Referenced by getLogger().

$mainTemplate

ilGlobalTemplateInterface ilStartUpGUI::$mainTemplate

protected

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

Referenced by __construct().

$refinery

RefineryFactory ilStartUpGUI::$refinery

protected

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

$setting

ilSetting ilStartUpGUI::$setting

protected

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

$termsOfServiceEvaluation

ilTermsOfServiceDocumentEvaluation ilStartUpGUI::$termsOfServiceEvaluation

protected

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

Referenced by __construct().

$user

ilObjUser ilStartUpGUI::$user

protected

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

Referenced by __construct().

ACCOUNT_MIGRATION_MIGRATE

const ilStartUpGUI::ACCOUNT_MIGRATION_MIGRATE = 1

protected

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

ACCOUNT_MIGRATION_NEW

const ilStartUpGUI::ACCOUNT_MIGRATION_NEW = 2

protected

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

---

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

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