ilStartUpGUI Class Reference

StartUp GUI class. More...

Collaboration diagram for ilStartUpGUI:

Public Member Functions
	__construct ()
	constructor More...
	executeCommand ()
	execute command More...
	getLogger ()
	Get logger. More...
	jumpToRegistration ()
	jump to registration gui More...
	jumpToPasswordAssistance ()
	jump to password assistance More...
	showLogout ()
	show logout screen More...
	showUserMappingSelection ()
	Show user selection screen, if external account could not be mapped to an ILIAS account, but the provided e-mail address is known. More...
	showClientList ()
	show client list More...
	showNoCookiesScreen ()
	show help screen, if cookies are disabled More...

Static Public Member Functions
static	_checkGoto ($a_target)

Data Fields
const	ACCOUNT_MIGRATION_MIGRATE = 1
const	ACCOUNT_MIGRATION_NEW = 2

Protected Member Functions
	showLoginPage (ilPropertyFormGUI $form=null)
	showLogin ()
	Show login. More...
	showCodeForm ($a_username=null, $a_form=null)
	initCodeForm ($a_username)
	processCode ()
	initStandardLoginForm ()
	Initialize the standard. More...
	doShibbolethAuthentication ()
	Trying shibboleth authentication. More...
	doCasAuthentication ()
	Try CAS auth. More...
	doLTIAuthentication ()
	Handle lti requests. More...
	doApacheAuthentication ()
	Try apache auth. More...
	doStandardAuthentication ()
	Check form input; authenticate user. More...
	showLoginForm ($page_editor_html, ilPropertyFormGUI $form=null)
	Show login form ilSetting $ilSetting. More...
	showLoginInformation ($page_editor_html)
	Show login information. More...
	showCASLoginForm ($page_editor_html)
	Show cas login ilSetting $ilSetting. More...
	showShibbolethLoginForm ($page_editor_html)
	Show shibboleth login form. More...
	substituteLoginPageElements ($tpl, $page_editor_html, $element_html, $placeholder, $fallback_tplvar)
	Substitute login page elements. More...
	getLoginPageEditorHTML ()
	Get HTML of ILIAS login page editor. More...
	showRegistrationLinks ($page_editor_html)
	Show registration, password forgotten, client slection links ilLanguage $lng ilSetting $ilSetting <type> $ilIliasIniFile. More...
	purgePlaceholders ($page_editor_html)
	Purge page editor html from unused placeholders. More...
	migrateAccount ()
	Migrate Account. More...
	doMigrationNewAccount ()
	Create new account for migration. More...
	doMigration ()
	Do migration of existing ILIAS database user account. More...
	getAcceptance ()
	Get terms of service. More...
	processIndexPHP ()
	process index.php More...
	showSamlLoginForm ($page_editor_html)
	doSamlAuthentication ()
	showSamlIdpSelection (\ilSamlAuth $auth, array $idps)

Static Protected Member Functions
static	getLanguageSelection ()
	language selection list More...

Protected Attributes
	$ctrl
	$lng
	$logger

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

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

Constructor & Destructor Documentation

__construct()

ilStartUpGUI::__construct

(

)

constructor

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

References $ilCtrl, $lng, array, and ilLoggerFactory\getLogger().

    {
        global $ilCtrl, $lng;

        $this->ctrl = $ilCtrl;
        $this->lng = $lng;
        $this->lng->loadLanguageModule('auth');
        $this->logger = ilLoggerFactory::getLogger('init');

        $ilCtrl->saveParameter($this, array("rep_ref_id", "lang", "target", "client_id"));
    }

Here is the call graph for this function:

Member Function Documentation

_checkGoto()

static ilStartUpGUI::_checkGoto (   $a_target )

static

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

References $_COOKIE, $_GET, $_SERVER, $_SESSION, $ilCtrl, $ilSetting, $ilUser, $lng, $location, $password, $path, $ret, $target, $tpl, $type, ilObject\_getAllReferences(), ilObjCourse\_isActivated(), ilGroupParticipants\_isParticipant(), ilLMObject\_lookupContObjID(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilObjCourse\_registrationEnabled(), ilObjUser\_verifyRegistrationHash(), array, ilUtil\generatePasswords(), ilParticipants\getDefaultMemberRole(), ilUtil\getImagePath(), ilPublicSectionSettings\getInstance(), ilObjectFactory\getInstanceByObjId(), ilLoggerFactory\getLogger(), ilPluginAdmin\getPluginObject(), IL_COMP_SERVICE, IL_PASSWD_PLAIN, ilUIFramework\init(), iljQueryUtil\initjQuery(), ilUtil\redirect(), ilUtil\setCookie(), and time.

    {
        global $objDefinition, $ilPluginAdmin, $ilUser;

        if (is_object($ilPluginAdmin)) {
            // get user interface plugins
            $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_SERVICE, "UIComponent", "uihk");

            // search
            foreach ($pl_names as $pl) {
                $ui_plugin = ilPluginAdmin::getPluginObject(IL_COMP_SERVICE, "UIComponent", "uihk", $pl);
                $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>]
            if ($t_arr[0] == "pg") {
                if (isset($t_arr[2])) {
                    $ref_id = $t_arr[2];
                } else {
                    $lm_id = ilLMObject::_lookupContObjID($t_arr[1]);
                    $ref_id = ilObject::_getAllReferences($lm_id);
                    if ($ref_id) {
                        $ref_id = array_shift($ref_id);
                    }
                }
            } else {
                $ref_id = $t_arr[1];
            }
            
            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 (!$ilAccess->doActivationCheck("read", "", $path_ref_id, $ilUser->getId(), $pobj_id, $ptype) ||
                    !$ilAccess->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
                    include_once "Modules/Course/classes/class.ilCourseParticipant.php";
                    $participants = new ilCourseParticipant($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:

doApacheAuthentication()

ilStartUpGUI::doApacheAuthentication ( )

protected

Try apache auth.

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

References $GLOBALS, League\OAuth2\Client\Provider\$provider, ilUtil\appendUrlParameterString(), array, AUTH_APACHE, ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ilAuthStatus\getInstance(), getLogger(), ilLoggerFactory\getLogger(), ilUtil\redirect(), ilUtil\sendFailure(), showLoginPage(), ilAuthStatus\STATUS_ACCOUNT_MIGRATION_REQUIRED, ilAuthStatus\STATUS_AUTHENTICATED, and ilAuthStatus\STATUS_AUTHENTICATION_FAILED.

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

        include_once './Services/Authentication/classes/Frontend/class.ilAuthFrontendCredentialsApache.php';
        $credentials = new ilAuthFrontendCredentialsApache();
        $credentials->initFromRequest();

        include_once './Services/Authentication/classes/Provider/class.ilAuthProviderFactory.php';
        $provider_factory = new ilAuthProviderFactory();
        $provider = $provider_factory->getProviderByAuthMode($credentials, AUTH_APACHE);

        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(
            $GLOBALS['DIC']['ilAuthSession'],
            $status,
            $credentials,
            array($provider)
        );

        $frontend->authenticate();

        switch ($status->getStatus()) {
            case ilAuthStatus::STATUS_AUTHENTICATED:
                ilLoggerFactory::getLogger('auth')->debug('Authentication successful; Redirecting to starting page.');
                if ($credentials->hasValidTargetUrl()) {
                    ilUtil::redirect($credentials->getTargetUrl());
                } else {
                    require_once './Services/Init/classes/class.ilInitialisation.php';
                    ilInitialisation::redirectToStartingPage();
                }
                return;

            case ilAuthStatus::STATUS_ACCOUNT_MIGRATION_REQUIRED:
                return $GLOBALS['ilCtrl']->redirect($this, 'showAccountMigration');

            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                ilUtil::sendFailure($status->getTranslatedReason(), true);
                ilUtil::redirect(
                    ilUtil::appendUrlParameterString(
                        $GLOBALS['ilCtrl']->getLinkTarget($this, 'showLoginPage', '', false, false),
                        'passed_sso=1'
                    )
                );
                return false;
        }

        ilUtil::sendFailure($this->lng->txt('err_wrong_login'));
        $this->showLoginPage();
        return false;
    }

Here is the call graph for this function:

doCasAuthentication()

ilStartUpGUI::doCasAuthentication ( )

protected

Try CAS auth.

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

References $DIC, $GLOBALS, League\OAuth2\Client\Provider\$provider, array, AUTH_CAS, ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ilAuthStatus\getInstance(), getLogger(), ilUtil\sendFailure(), showLoginPage(), ilAuthStatus\STATUS_AUTHENTICATED, and ilAuthStatus\STATUS_AUTHENTICATION_FAILED.

    {
        global $DIC;

        $this->getLogger()->debug('Trying cas authentication');

        include_once './Services/CAS/classes/class.ilAuthFrontendCredentialsCAS.php';
        $credentials = new ilAuthFrontendCredentialsCAS();

        include_once './Services/Authentication/classes/Provider/class.ilAuthProviderFactory.php';
        $provider_factory = new ilAuthProviderFactory();
        $provider = $provider_factory->getProviderByAuthMode($credentials, AUTH_CAS);

        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(
            $GLOBALS['DIC']['ilAuthSession'],
            $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:
                ilUtil::sendFailure($DIC->language()->txt($status->getReason()));
                $this->showLoginPage();
                return false;
        }
    }

Here is the call graph for this function:

doLTIAuthentication()

ilStartUpGUI::doLTIAuthentication ( )

protected

Handle lti requests.

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

References $GLOBALS, League\OAuth2\Client\Provider\$provider, array, ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ilAuthStatus\getInstance(), getLogger(), ilLoggerFactory\getLogger(), ilUtil\sendFailure(), showLoginPage(), ilAuthStatus\STATUS_ACCOUNT_MIGRATION_REQUIRED, ilAuthStatus\STATUS_AUTHENTICATED, and ilAuthStatus\STATUS_AUTHENTICATION_FAILED.

    {
        $this->getLogger()->debug('Trying lti authentication');
        
        $credentials = new ilAuthFrontendCredentialsLTI();
        $credentials->initFromRequest();
        
        $provider_factory = new ilAuthProviderFactory();
        $provider = $provider_factory->getProviderByAuthMode($credentials, AUTH_LTI_PROVIDER);
        
        $status = ilAuthStatus::getInstance();
        
        $frontend_factory = new ilAuthFrontendFactory();
        $frontend_factory->setContext(ilAuthFrontendFactory::CONTEXT_STANDARD_FORM);
        $frontend = $frontend_factory->getFrontend(
            $GLOBALS['DIC']['ilAuthSession'],
            $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:
                return $GLOBALS['ilCtrl']->redirect($this, 'showAccountMigration');

            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                ilUtil::sendFailure($GLOBALS['lng']->txt($status->getReason()), true);
                $GLOBALS['ilCtrl']->redirect($this, 'showLoginPage');
                return false;
        }
        
        ilUtil::sendFailure($this->lng->txt('err_wrong_login'));
        $this->showLoginPage();
        return false;
    }

Here is the call graph for this function:

doMigration()

ilStartUpGUI::doMigration ( )

protected

Do migration of existing ILIAS database user account.

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

References $_POST, $GLOBALS, League\OAuth2\Client\Provider\$provider, array, AUTH_LOCAL, ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ilSession\get(), ilAuthStatus\getInstance(), getLogger(), ilAuthFrontend\MIG_TRIGGER_AUTHMODE, ilUtil\sendFailure(), and ilAuthStatus\STATUS_AUTHENTICATED.

Referenced by migrateAccount().

    {
        include_once './Services/Authentication/classes/class.ilAuthFactory.php';
            
        $this->logger->debug('Starting account migration for user: ' . (string) ilSession::get('mig_ext_account'));

        // try database authentication
        include_once './Services/Authentication/classes/Frontend/class.ilAuthFrontendCredentials.php';
        $credentials = new ilAuthFrontendCredentials();
        $credentials->setUsername((string) $_POST['mig_username']);
        $credentials->setPassword((string) $_POST['mig_password']);
            
        include_once './Services/Authentication/classes/Provider/class.ilAuthProviderFactory.php';
        $provider_factory = new ilAuthProviderFactory();
        $provider = $provider_factory->getProviderByAuthMode($credentials, AUTH_LOCAL);
        
        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(
            $GLOBALS['DIC']['ilAuthSession'],
            $status,
            $credentials,
            array($provider)
        );
            
        $frontend->authenticate();
        
        switch ($status->getStatus()) {
            case ilAuthStatus::STATUS_AUTHENTICATED:
                $this->getLogger()->debug('Account migration: authentication successful for ' . (string) $_POST['mig_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,
                    array($provider)
                );
                if (
                    $frontend->migrateAccount($GLOBALS['DIC']['ilAuthSession'])
                ) {
                    include_once './Services/Init/classes/class.ilInitialisation.php';
                    ilInitialisation::redirectToStartingPage();
                } else {
                    ilUtil::sendFailure($this->lng->txt('err_wrong_login'), true);
                    $this->ctrl->redirect($this, 'showAccountMigration');
                }
                break;
                
            default:
                $this->getLogger()->info('Account migration failed for user ' . (string) $_POST['mig_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

Create new account for migration.

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

References $GLOBALS, League\OAuth2\Client\Provider\$provider, array, ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ilSession\get(), ilAuthStatus\getInstance(), ilAuthFrontend\MIG_EXTERNAL_ACCOUNT, ilAuthFrontend\MIG_TRIGGER_AUTHMODE, and ilUtil\sendFailure().

Referenced by migrateAccount().

    {
        include_once './Services/Authentication/classes/Frontend/class.ilAuthFrontend.php';
        
        include_once './Services/Authentication/classes/Frontend/class.ilAuthFrontendCredentials.php';
        $credentials = new ilAuthFrontendCredentials();
        $credentials->setUsername(ilSession::get(ilAuthFrontend::MIG_EXTERNAL_ACCOUNT));

        include_once './Services/Authentication/classes/Provider/class.ilAuthProviderFactory.php';
        $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.');
        
        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(
            $GLOBALS['DIC']['ilAuthSession'],
            $status,
            $credentials,
            array($provider)
        );
        
        if ($frontend->migrateAccountNew()) {
            include_once './Services/Init/classes/class.ilInitialisation.php';
            ilInitialisation::redirectToStartingPage();
        }
        
        ilUtil::sendFailure($this->lng->txt('err_wrong_login'));
        $this->ctrl->redirect($this, 'showAccountMigration');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doSamlAuthentication()

ilStartUpGUI::doSamlAuthentication ( )

protected

Returns

bool

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

References $_GET, $_POST, $auth, $DIC, $factory, $GLOBALS, $idp, $params, League\OAuth2\Client\Provider\$provider, array, AUTH_SAML, ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ilSamlIdp\getActiveIdpList(), ilAuthStatus\getInstance(), getLogger(), ilLoggerFactory\getLogger(), ilUtil\sendFailure(), showLoginPage(), showSamlIdpSelection(), ilAuthStatus\STATUS_ACCOUNT_MIGRATION_REQUIRED, ilAuthStatus\STATUS_AUTHENTICATED, ilAuthStatus\STATUS_AUTHENTICATION_FAILED, and ilUtil\stripSlashes().

    {
        global $DIC;

        $this->getLogger()->debug('Trying saml authentication');

        $request = $DIC->http()->request();
        $params  = $request->getQueryParams();

        require_once 'Services/Saml/classes/class.ilSamlAuthFactory.php';
        $factory = new ilSamlAuthFactory();
        $auth = $factory->auth();

        if (isset($params['action']) && $params['action'] == 'logout') {
            $auth->logout(isset($params['logout_url']) ? $params['logout_url'] : '');
        }

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

        if (!$auth->isAuthenticated()) {
            if (!isset($_GET['idpentityid']) || !isset($_GET['saml_idp_id'])) {
                $activeIdps = ilSamlIdp::getActiveIdpList();
                if (1 == count($activeIdps)) {
                    $idp = current($activeIdps);
                    $_GET['idpentityid'] = $idp->getEntityId();
                    $_GET['saml_idp_id'] = $idp->getIdpId();
                } elseif (0 == count($activeIdps)) {
                    $GLOBALS['DIC']->ctrl()->redirect($this, 'showLoginPage');
                } else {
                    $this->showSamlIdpSelection($auth, $activeIdps);
                    return;
                }
            }
            $auth->storeParam('idpId', (int) $_GET['saml_idp_id']);
        }

        // re-init
        $auth = $factory->auth();
        $auth->protectResource();

        $_GET['target'] = $auth->popParam('target');

        $_POST['auth_mode'] = AUTH_SAML . '_' . ((int) $auth->getParam('idpId'));

        require_once 'Services/Saml/classes/class.ilAuthFrontendCredentialsSaml.php';
        $credentials = new ilAuthFrontendCredentialsSaml($auth);
        $credentials->initFromRequest();

        require_once 'Services/Authentication/classes/Provider/class.ilAuthProviderFactory.php';
        $provider_factory = new ilAuthProviderFactory();
        $provider = $provider_factory->getProviderByAuthMode($credentials, ilUtil::stripSlashes($_POST['auth_mode']));

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

        require_once 'Services/Authentication/classes/Frontend/class.ilAuthFrontendFactory.php';
        $frontend_factory = new ilAuthFrontendFactory();
        $frontend_factory->setContext(ilAuthFrontendFactory::CONTEXT_STANDARD_FORM);
        $frontend = $frontend_factory->getFrontend(
            $GLOBALS['DIC']['ilAuthSession'],
            $status,
            $credentials,
            array($provider)
        );

        $frontend->authenticate();

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

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

            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                ilUtil::sendFailure($status->getTranslatedReason(), true);
                $GLOBALS['DIC']->ctrl()->redirect($this, 'showLoginPage');
                return false;
        }

        ilUtil::sendFailure($this->lng->txt('err_wrong_login'));
        $this->showLoginPage();

        return false;
    }

Here is the call graph for this function:

doShibbolethAuthentication()

ilStartUpGUI::doShibbolethAuthentication ( )

protected

Trying shibboleth authentication.

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

References $GLOBALS, League\OAuth2\Client\Provider\$provider, array, AUTH_SHIBBOLETH, ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ilAuthStatus\getInstance(), getLogger(), ilLoggerFactory\getLogger(), ilUtil\sendFailure(), showLoginPage(), ilAuthStatus\STATUS_ACCOUNT_MIGRATION_REQUIRED, ilAuthStatus\STATUS_AUTHENTICATED, and ilAuthStatus\STATUS_AUTHENTICATION_FAILED.

    {
        $this->getLogger()->debug('Trying shibboleth authentication');
        
        include_once './Services/AuthShibboleth/classes/class.ilAuthFrontendCredentialsShibboleth.php';
        $credentials = new ilAuthFrontendCredentialsShibboleth();
        $credentials->initFromRequest();
        
        include_once './Services/Authentication/classes/Provider/class.ilAuthProviderFactory.php';
        $provider_factory = new ilAuthProviderFactory();
        $provider = $provider_factory->getProviderByAuthMode($credentials, AUTH_SHIBBOLETH);
        
        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(
            $GLOBALS['DIC']['ilAuthSession'],
            $status,
            $credentials,
            array($provider)
        );
            
        $frontend->authenticate();
        
        switch ($status->getStatus()) {
            case ilAuthStatus::STATUS_AUTHENTICATED:
                ilLoggerFactory::getLogger('auth')->debug('Authentication successful; Redirecting to starting page.');
                include_once './Services/Init/classes/class.ilInitialisation.php';
                ilInitialisation::redirectToStartingPage();
                return;
                    
            case ilAuthStatus::STATUS_ACCOUNT_MIGRATION_REQUIRED:
                return $GLOBALS['ilCtrl']->redirect($this, 'showAccountMigration');

            case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                ilUtil::sendFailure($status->getTranslatedReason(), true);
                $GLOBALS['ilCtrl']->redirect($this, 'showLoginPage');
                return false;
        }
        
        ilUtil::sendFailure($this->lng->txt('err_wrong_login'));
        $this->showLoginPage();
        return false;
    }

Here is the call graph for this function:

doStandardAuthentication()

ilStartUpGUI::doStandardAuthentication ( )

protected

Check form input; authenticate user.

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

References $form, $GLOBALS, ilAuthModeDetermination\_getInstance(), ilAuthUtils\_hasMultipleAuthenticationMethods(), ilObjUser\_lookupLogin(), ilAuthFrontendFactory\CONTEXT_STANDARD_FORM, ilAuthStatus\getInstance(), getLogger(), ilLoggerFactory\getLogger(), initStandardLoginForm(), ilUtil\sendFailure(), showCodeForm(), showLoginPage(), ilAuthStatus\STATUS_ACCOUNT_MIGRATION_REQUIRED, ilAuthStatus\STATUS_AUTHENTICATED, ilAuthStatus\STATUS_AUTHENTICATION_FAILED, and ilAuthStatus\STATUS_CODE_ACTIVATION_REQUIRED.

    {
        $form = $this->initStandardLoginForm();
        if ($form->checkInput()) {
            $this->getLogger()->debug('Trying to authenticate user.');
            
            include_once './Services/Authentication/classes/Frontend/class.ilAuthFrontendCredentials.php';
            $credentials = new ilAuthFrontendCredentials();
            $credentials->setUsername($form->getInput('username'));
            $credentials->setPassword($form->getInput('password'));
            $credentials->setCaptchaCode($form->getInput('captcha_code'));
            
            // 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(
                $GLOBALS['DIC']['ilAuthSession'],
                $status,
                $credentials,
                $providers
            );
            
            $frontend->authenticate();
            
            switch ($status->getStatus()) {
                case ilAuthStatus::STATUS_AUTHENTICATED:
                    ilLoggerFactory::getLogger('auth')->debug('Authentication successful; Redirecting to starting page.');
                    include_once './Services/Init/classes/class.ilInitialisation.php';
                    ilInitialisation::redirectToStartingPage();
                    return;
                    
                case ilAuthStatus::STATUS_CODE_ACTIVATION_REQUIRED:
                    return $this->showCodeForm(ilObjUser::_lookupLogin($status->getAuthenticatedUserId()));

                case ilAuthStatus::STATUS_ACCOUNT_MIGRATION_REQUIRED:
                    return $GLOBALS['ilCtrl']->redirect($this, 'showAccountMigration');

                case ilAuthStatus::STATUS_AUTHENTICATION_FAILED:
                    ilUtil::sendFailure($status->getTranslatedReason());
                    return $this->showLoginPage($form);
            }
        }
        ilUtil::sendFailure($this->lng->txt('err_wrong_login'));
        $this->showLoginPage($form);
        return false;
    }

Here is the call graph for this function:

executeCommand()

ilStartUpGUI::executeCommand

(

)

execute command

See also

register.php

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

References array.

Referenced by jumpToPasswordAssistance(), and jumpToRegistration().

    {
        $cmd = $this->ctrl->getCmd("processIndexPHP", array('processIndexPHP','showLoginPage'));
        $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());

            default:
                return $this->$cmd();
        }
    }

Here is the caller graph for this function:

getAcceptance()

ilStartUpGUI::getAcceptance ( )

protected

Get terms of service.

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

References $_GET, $_POST, $ilSetting, $ilUser, $lng, $target, $tpl, ilUtil\formCheckbox(), ilSession\get(), ilTermsOfServiceSignableDocumentFactory\getByLanguageObject(), ilSystemSupportContacts\getMailToAddress(), ilUtil\prepareFormOutput(), ilUtil\redirect(), ilSession\set(), and ilTermsOfServiceHelper\trackAcceptance().

    {
        $this->showTermsOfService();
    }

Here is the call graph for this function:

getLanguageSelection()

static ilStartUpGUI::getLanguageSelection ( )

staticprotected

language selection list

Returns

string ilGroupedList

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

References ilMainMenuGUI\getLanguageSelection().

    {
        include_once("./Services/MainMenu/classes/class.ilMainMenuGUI.php");
        return ilMainMenuGUI::getLanguageSelection(true);
    }

Here is the call graph for this function:

getLogger()

ilStartUpGUI::getLogger

(

)

Get logger.

Returns

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

References $logger.

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

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

References $lng, $ret, $tpl, ilPageUtil\_existsAndNotEmpty(), ilObjStyleSheet\getContentStylePath(), ilAuthLoginPageEditorSettings\getInstance(), ilObjStyleSheet\getSyntaxStylePath(), and ilLanguage\lookupId().

Referenced by showLogin(), and showLoginPage().

    {
        global $lng, $tpl;

        include_once './Services/Authentication/classes/class.ilAuthLoginPageEditorSettings.php';
        $lpe = ilAuthLoginPageEditorSettings::getInstance();
        $active_lang = $lpe->getIliasEditorLanguage($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 '';
        }

        include_once './Services/Authentication/classes/class.ilLoginPage.php';
        include_once './Services/Authentication/classes/class.ilLoginPageGUI.php';

        include_once("./Services/Style/Content/classes/class.ilObjStyleSheet.php");
        $tpl->setVariable("LOCATION_CONTENT_STYLESHEET", ilObjStyleSheet::getContentStylePath(0));
        $tpl->setCurrentBlock("SyntaxStyle");
        $tpl->setVariable("LOCATION_SYNTAX_STYLESHEET", ilObjStyleSheet::getSyntaxStylePath());
        $tpl->parseCurrentBlock();

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

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

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

initCodeForm()

ilStartUpGUI::initCodeForm (   $a_username )

protected

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

References $form, $ilCtrl, $lng, and ilFormPropertyGUI\setRequired().

Referenced by processCode(), and showCodeForm().

    {
        global $lng, $ilCtrl;
        
        $lng->loadLanguageModule("auth");
        
        include_once 'Services/Form/classes/class.ilPropertyFormGUI.php';

        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this, 'showcodeform'));
        $form->setTitle($lng->txt('auth_account_code_title'));
        
        $count = new ilTextInputGUI($lng->txt('auth_account_code'), 'code');
        $count->setRequired(true);
        $count->setInfo($lng->txt('auth_account_code_info'));
        $form->addItem($count);
        
        // #11658
        $uname = new ilHiddenInputGUI("uname");
        $uname->setValue($a_username);
        $form->addItem($uname);
        
        $form->addCommandButton('processCode', $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 560 of file class.ilStartUpGUI.php.

References $form, $key, ilAuthModeDetermination\_getInstance(), ilAuthUtils\_getMultipleAuthModeOptions(), ilAuthUtils\_hasMultipleAuthenticationMethods(), array, ilFormPropertyGUI\setRequired(), ilTextInputGUI\setSize(), and ilPasswordInputGUI\setUseStripSlashes().

Referenced by doStandardAuthentication(), and showLoginForm().

    {
        include_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, ''));
        $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);

        require_once 'Services/Captcha/classes/class.ilCaptchaUtil.php';
        if (ilCaptchaUtil::isActiveForLogin()) {
            require_once 'Services/Captcha/classes/class.ilCaptchaInputGUI.php';
            $captcha = new ilCaptchaInputGUI($this->lng->txt('captcha_code'), 'captcha_code');
            $captcha->setRequired(true);
            $form->addItem($captcha);
        }

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

jumpToPasswordAssistance()

ilStartUpGUI::jumpToPasswordAssistance

(

)

jump to password assistance

See also

pwassist.php

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

References $GLOBALS, array, executeCommand(), ilSession\SESSION_CLOSE_USER, ilSession\setClosingContext(), showLoginPage(), and user().

    {
        $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 79 of file class.ilStartUpGUI.php.

References executeCommand().

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

Here is the call graph for this function:

migrateAccount()

ilStartUpGUI::migrateAccount ( )

protected

Migrate Account.

Returns

bool

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

References $_POST, $GLOBALS, doMigration(), and doMigrationNewAccount().

    {
        if (!isset($_POST['account_migration'])) {
            $this->showAccountMigration(
                $GLOBALS['DIC']->language()->txt('err_choose_migration_type')
            );
            return false;
        }
        
        if (
            ($_POST['account_migration'] == self::ACCOUNT_MIGRATION_MIGRATE) &&
            (!strlen($_POST['mig_username']) || !strlen($_POST['mig_password']))
        ) {
            $this->showAccountMigration(
                $GLOBALS['DIC']->language()->txt('err_wrong_login')
            );
            return false;
        }
        
        if ((int) $_POST['account_migration'] == self::ACCOUNT_MIGRATION_MIGRATE) {
            return $this->doMigration();
        }
        if ((int) $_POST['account_migration'] == static::ACCOUNT_MIGRATION_NEW) {
            return $this->doMigrationNewAccount();
        }
    }

Here is the call graph for this function:

processCode()

ilStartUpGUI::processCode ( )

protected

Todo:

has to be refactored.

ilLanguage $lng type $ilAuth type $ilCtrl

Returns

boolean

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

References $_POST, $code, $form, $GLOBALS, $ilCtrl, $lng, ilObjUser\_lookupId(), ilAccountCode\applyAccessLimits(), ilAccountCode\applyRoleAssignments(), ilAccountCode\getCodeValidUntil(), initCodeForm(), ilAccountCode\isUnusedCode(), ilUtil\sendSuccess(), showCodeForm(), showLogin(), time, and ilAccountCode\useCode().

    {
        global $lng, $ilAuth, $ilCtrl;
        
        $uname = $_POST["uname"];
        
        $form = $this->initCodeForm($uname);
        if ($uname && $form->checkInput()) {
            $code = $form->getInput("code");
                        
            include_once "Services/User/classes/class.ilAccountCode.php";
            if (ilAccountCode::isUnusedCode($code)) {
                $valid_until = ilAccountCode::getCodeValidUntil($code);
                
                if (!$user_id = ilObjUser::_lookupId($uname)) {
                    $this->showLogin();
                    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 time limits
                    ilAccountCode::applyAccessLimits($user, $code);

                    $user->update();
                    
                    $ilCtrl->setParameter($this, "cu", 1);
                    $GLOBALS['DIC']->language()->loadLanguageModule('auth');
                    ilUtil::sendSuccess($GLOBALS['DIC']->language()->txt('auth_activation_code_success'), true);
                    $ilCtrl->redirect($this, "showLoginPage");
                }
            }
            
            $lng->loadLanguageModule("user");
            $field = $form->getItemByPostVar("code");
            $field->setAlert($lng->txt("user_account_code_not_valid"));
        }
        
        $form->setValuesByPost();
        $this->showCodeForm($uname, $form);
    }

Here is the call graph for this function:

processIndexPHP()

ilStartUpGUI::processIndexPHP ( )

protected

process index.php

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

References $_GET, $_SERVER, $GLOBALS, $ilIliasIniFile, $ilSetting, ilPublicSectionSettings\getInstance(), ilInitialisation\goToPublicSection(), showClientList(), and showLoginPage().

Referenced by showClientList().

    {
        global $ilIliasIniFile, $ilAuth, $ilSetting;

        // In case of an valid session, redirect to starting page
        if ($GLOBALS['DIC']['ilAuthSession']->isValid()) {
            include_once './Services/Init/classes/class.ilInitialisation.php';
            ilInitialisation::redirectToStartingPage();
            return;
        }
        
        // no valid session => show client list, if no client info is given
        if (
            !isset($_GET["client_id"]) &&
            ($_GET["cmd"] == "") &&
            $ilIliasIniFile->readVariable("clients", "list")) {
            return $this->showClientList();
        }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

purgePlaceholders()

ilStartUpGUI::purgePlaceholders (   $page_editor_html )

protected

Purge page editor html from unused placeholders.

Parameters

string

$page_editor_html

Returns

string

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

References $_POST, $form, $lng, $new, $pass, $tpl, ilRadioOption\addSubItem(), array, ilUtil\prepareFormOutput(), ilUtil\sendFailure(), ilRadioGroupInputGUI\setValue(), and ilRadioOption\setValue().

Referenced by showLogin(), and showLoginPage().

    {
        return str_replace(
            array(
                '[list-language-selection] ',
                '[list-registration-link]',
                '[list-user-agreement]',
                '[list-login-form]',
                '[list-cas-login-form]',
                '[list-shibboleth-login-form]'
            ),
            array('','','','','','',''),
            $page_editor_html
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showCASLoginForm()

ilStartUpGUI::showCASLoginForm (   $page_editor_html )

protected

Show cas login ilSetting $ilSetting.

Parameters

string

$page_editor_html

Returns

string $page_editor_html

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

References $GLOBALS, $ilSetting, $lng, $tpl, ilUtil\getImagePath(), and substituteLoginPageElements().

Referenced by showLogin(), and showLoginPage().

    {
        global $ilSetting, $lng;


        // cas login link
        if ($ilSetting->get("cas_active")) {
            $tpl = new ilTemplate('tpl.login_form_cas.html', true, true, 'Services/Init');
            $tpl->setVariable("TXT_CAS_LOGIN", $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", $ilSetting->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:

showClientList()

ilStartUpGUI::showClientList

(

)

show client list

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

References $_GET, $client, $data, $ilIliasIniFile, $key, $list, $lng, $tbl, $tpl, array, exit, ilUtil\getStyleSheetLocation(), header, and processIndexPHP().

Referenced by processIndexPHP().

    {
        global $tpl, $ilIliasIniFile, $lng;

        if (!$ilIliasIniFile->readVariable("clients", "list")) {
            $this->processIndexPHP();
            return;
        }

        // fix #21612
    //  $tpl = new ilTemplate("tpl.main.html", true, true);
        $tpl->setAddFooter(false); // no client yet

        $tpl->setVariable("PAGETITLE", $lng->txt("clientlist_clientlist"));
        $tpl->setVariable("LOCATION_STYLESHEET", ilUtil::getStyleSheetLocation());

        // load client list template
        self::initStartUpTemplate("tpl.client_list.html");

        // load template for table
        $tpl->addBlockfile("CLIENT_LIST", "client_list", "tpl.table.html");

        // load template for table content data
        $tpl->addBlockfile("TBL_CONTENT", "tbl_content", "tpl.obj_tbl_rows.html");

        // load table content data
        require_once("setup/classes/class.ilClientList.php");
        require_once("setup/classes/class.ilClient.php");
        require_once("setup/classes/class.ilDBConnections.php");
        require_once("./Services/Table/classes/class.ilTableGUI.php");
        $this->db_connections = new ilDBConnections();
        $clientlist = new ilClientList($this->db_connections);
        $list = $clientlist->getClients();

        if (count($list) == 0) {
            header("Location: ./setup/setup.php");
            exit();
        }

        $hasPublicSection = false;
        foreach ($list as $key => $client) {
            $client->setDSN();
            if ($client->checkDatabaseExists(true)) {
                $client->connect();
                if ($client->ini->readVariable("client", "access") and $client->getSetting("setup_ok")) {
                    $this->ctrl->setParameter($this, "client_id", $key);
                    $tmp = array();
                    $tmp[] = $client->getName();
                    $tmp[] = "<a href=\"" . "login.php?cmd=force_login&client_id=" . urlencode($key) . "\">" . $lng->txt("clientlist_login_page") . "</a>";

                    if ($client->getSetting('pub_section')) {
                        $hasPublicSection = true;
                        $tmp[] = "<a href=\"" . "ilias.php?baseClass=ilRepositoryGUI&client_id=" . urlencode($key) . "\">" . $lng->txt("clientlist_start_page") . "</a>";
                    } else {
                        $tmp[] = '';
                    }

                    $data[] = $tmp;
                }
            }
        }

        // create table
        $tbl = new ilTableGUI();

        // title & header columns
        if ($hasPublicSection) {
            $tbl->setTitle($lng->txt("clientlist_available_clients"));
            $tbl->setHeaderNames(array($lng->txt("clientlist_installation_name"), $lng->txt("clientlist_login"), $lng->txt("clientlist_public_access")));
            $tbl->setHeaderVars(array("name","index","login"));
            $tbl->setColumnWidth(array("50%","25%","25%"));
        } else {
            $tbl->setTitle($lng->txt("clientlist_available_clients"));
            $tbl->setHeaderNames(array($lng->txt("clientlist_installation_name"), $lng->txt("clientlist_login"), ''));
            $tbl->setHeaderVars(array("name","login",''));
            $tbl->setColumnWidth(array("70%","25%",'1px'));
        }

        // control
        $tbl->setOrderColumn($_GET["sort_by"], "name");
        $tbl->setOrderDirection($_GET["sort_order"]);
        $tbl->setLimit($_GET["limit"]);
        $tbl->setOffset($_GET["offset"]);

        // content
        $tbl->setData($data);

        $tbl->disable("icon");
        $tbl->disable("numinfo");
        $tbl->disable("sort");
        $tbl->disable("footer");
        
        // render table
        $tbl->render();
        $tpl->show("DEFAULT", true, true);
    }

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

References $lng, $tpl, initCodeForm(), and ilUtil\sendFailure().

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

    {
        global $tpl, $lng;
        
        self::initStartUpTemplate("tpl.login_reactivate_code.html");

        ilUtil::sendFailure($lng->txt("time_limit_reached"));

        if (!$a_form) {
            $a_form = $this->initCodeForm($a_username);
        }
        
        $tpl->setVariable("FORM", $a_form->getHTML());
        $tpl->show("DEFAULT", false);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showLogin()

ilStartUpGUI::showLogin ( )

protected

Show login.

ilLanguage $lng

Deprecated:

since 5.2

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

References $_COOKIE, $_GET, $_SERVER, $failure, $ilSetting, $lng, $success, $tpl, AUTH_APACHE_FAILED, AUTH_CAPTCHA_INVALID, AUTH_CAS_NO_ILIAS_USER, AUTH_LDAP_NO_ILIAS_USER, AUTH_MODE_INACTIVE, AUTH_RADIUS_NO_ILIAS_USER, AUTH_SAML_FAILED, AUTH_SOAP_NO_ILIAS_USER, AUTH_USER_INACTIVE, AUTH_USER_SIMULTANEOUS_LOGIN, AUTH_USER_TIME_LIMIT_EXCEEDED, AUTH_USER_WRONG_IP, getLogger(), getLoginPageEditorHTML(), purgePlaceholders(), ilUtil\redirect(), ilUtil\sendFailure(), ilUtil\sendSuccess(), ilSession\SESSION_CLOSE_CAPTCHA, ilSession\SESSION_CLOSE_INACTIVE, ilSession\SESSION_CLOSE_IP, ilSession\SESSION_CLOSE_SIMUL, ilSession\SESSION_CLOSE_TIME, ilSession\setClosingContext(), ilUtil\setCookie(), showCASLoginForm(), showCodeForm(), showLoginForm(), showLoginInformation(), showRegistrationLinks(), showSamlLoginForm(), showShibbolethLoginForm(), and ilLogLevel\WARNING.

Referenced by processCode().

    {
        global $ilSetting, $ilAuth, $tpl, $ilias, $lng;
                
        $this->getLogger()->warning('Using deprecated startup method');
        $this->getLogger()->logStack(ilLogLevel::WARNING);

        $status = $ilAuth->getStatus();
        if ($status == "" && isset($_GET["auth_stat"])) {
            $status = $_GET["auth_stat"];
        }
        
        if ($ilAuth->getAuth() && !$status) {
            // deprecated?
            if ($_GET["rep_ref_id"] != "") {
                $_GET["ref_id"] = $_GET["rep_ref_id"];
            }
            include_once './Services/Init/classes/class.ilInitialisation.php';
            ilInitialisation::redirectToStartingPage();
            return;
        }
        
        // check for session cookies enabled
        if (!isset($_COOKIE['iltest'])) {
            if (empty($_GET['cookies'])) {
                $additional_params = '';
                ilUtil::setCookie("iltest", "cookie", false);
                ilUtil::redirect("login.php?target=" . $_GET["target"] . "&soap_pw=" . $_GET["soap_pw"] .
                    "&ext_uid=" . $_GET["ext_uid"] . "&cookies=nocookies&client_id=" .
                    rawurlencode(CLIENT_ID) . "&lang=" . $lng->getLangKey() . $additional_params);
            } else {
                $_COOKIE['iltest'] = "";
            }
        } else {
            unset($_GET['cookies']);
        }
    
        if ($ilSetting->get("shib_active") && $ilSetting->get("shib_hos_type")) {
            require_once "./Services/AuthShibboleth/classes/class.ilShibbolethWAYF.php";
            // Check if we user selects Home Organization
            $WAYF = new ShibWAYF();
        }

        if (isset($WAYF) && $WAYF->is_selection()) {
            if ($WAYF->is_valid_selection()) {
                // Set cookie
                $WAYF->setSAMLCookie();

                // Redirect
                $WAYF->redirect();
            }
        }
        
        $failure = $success = null;

        // :TODO: handle internally?
        if (isset($_GET['reg_confirmation_msg']) && strlen(trim($_GET['reg_confirmation_msg']))) {
            $lng->loadLanguageModule('registration');
            if ($_GET['reg_confirmation_msg'] == 'reg_account_confirmation_successful') {
                $success = $lng->txt(trim($_GET['reg_confirmation_msg']));
            } else {
                $failure = $lng->txt(trim($_GET['reg_confirmation_msg']));
            }
        } elseif (isset($_GET['reached_session_limit']) && $_GET['reached_session_limit']) {
            $failure = $lng->txt("reached_session_limit");
        } elseif (isset($_GET['accdel']) && $_GET['accdel']) {
            $lng->loadLanguageModule('user');
            $failure = $lng->txt("user_account_deleted_confirmation");
        }
            
        if (!empty($status)) {
            switch ($status) {
                case AUTH_IDLED:
                    // lang variable err_idled not existing
                    // $tpl->setVariable(TXT_MSG_LOGIN_FAILED, $lng->txt("err_idled"));
                    // fallthrough
                
                case AUTH_EXPIRED:
                    $failure = $lng->txt("err_session_expired");
                    break;

                case AUTH_CAS_NO_ILIAS_USER:
                    $failure = $lng->txt("err_auth_cas_no_ilias_user");
                    break;

                case AUTH_SOAP_NO_ILIAS_USER:
                    $failure = $lng->txt("err_auth_soap_no_ilias_user");
                    break;

                case AUTH_LDAP_NO_ILIAS_USER:
                    $failure = $lng->txt("err_auth_ldap_no_ilias_user");
                    break;
                
                case AUTH_RADIUS_NO_ILIAS_USER:
                    $failure = $lng->txt("err_auth_radius_no_ilias_user");
                    break;
                    
                case AUTH_MODE_INACTIVE:
                    $failure = $lng->txt("err_auth_mode_inactive");
                    break;

                case AUTH_APACHE_FAILED:
                    $failure = $lng->txt("err_auth_apache_failed");
                    break;
                case AUTH_SAML_FAILED:
                    $lng->loadLanguageModule('auth');
                    $failure = $lng->txt("err_auth_saml_failed");
                    break;
                case AUTH_CAPTCHA_INVALID:
                    $lng->loadLanguageModule('cptch');
                    ilSession::setClosingContext(ilSession::SESSION_CLOSE_CAPTCHA);
                    $ilAuth->logout();
                    session_destroy();
                    $failure = $lng->txt("cptch_wrong_input");
                    break;
                
                // special cases: extended user validation failed
                // ilAuth was successful, so we have to logout here
                
                case AUTH_USER_WRONG_IP:
                    ilSession::setClosingContext(ilSession::SESSION_CLOSE_IP);
                    $ilAuth->logout();
                    session_destroy();

                    $failure = sprintf($lng->txt('wrong_ip_detected'), $_SERVER['REMOTE_ADDR']);
                    break;

                case AUTH_USER_SIMULTANEOUS_LOGIN:
                    ilSession::setClosingContext(ilSession::SESSION_CLOSE_SIMUL);
                    $ilAuth->logout();
                    session_destroy();

                    $failure = $lng->txt("simultaneous_login_detected");
                    break;

                case AUTH_USER_TIME_LIMIT_EXCEEDED:
                    ilSession::setClosingContext(ilSession::SESSION_CLOSE_TIME);
                    $username = $ilAuth->getExceededUserName(); // #16327
                    $ilAuth->logout();

                    // user could reactivate by code?
                    if ($ilSetting->get('user_reactivate_code')) {
                        return $this->showCodeForm($username);
                    }

                    session_destroy();

                    $failure = $lng->txt("time_limit_reached");
                    break;
                    
                case AUTH_USER_INACTIVE:
                    ilSession::setClosingContext(ilSession::SESSION_CLOSE_INACTIVE);
                    $ilAuth->logout();
                    session_destroy();
                    
                    $failure = $lng->txt("err_inactive");
                    break;
                    
                // special cases end
                    
                
                case AUTH_WRONG_LOGIN:
                default:
                    $add = "";
                    $auth_error = $ilias->getAuthError();
                    if (is_object($auth_error)) {
                        $add = "<br>" . $auth_error->getMessage();
                    }
                    $failure = $lng->txt("err_wrong_login") . $add;
                    break;
            }
        }
        
        if (isset($_GET['cu']) && $_GET['cu']) {
            $lng->loadLanguageModule("auth");
            $success = $lng->txt("auth_account_code_used");
        }
        
        
        // --- render
        
        // Instantiate login template
        self::initStartUpTemplate("tpl.login.html");

        // we need the template for this
        if ($failure) {
            ilUtil::sendFailure($failure);
        } elseif ($success) {
            ilUtil::sendSuccess($success);
        }

        // Draw single page editor elements
        $page_editor_html = $this->getLoginPageEditorHTML();
        $page_editor_html = $this->showLoginInformation($page_editor_html);
        $page_editor_html = $this->showLoginForm($page_editor_html);
        $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);
        
        // not controlled by login page editor
        $tpl->setVariable("PAGETITLE", "- " . $lng->txt("startpage"));
        $tpl->setVariable("ILIAS_RELEASE", $ilSetting->get("ilias_version"));
        
        $this->ctrl->setTargetScript("ilias.php");
        $tpl->setVariable("PHP_SELF", $_SERVER['PHP_SELF']);

        // browser does not accept cookies
        if (isset($_GET['cookies']) && $_GET['cookies'] == 'nocookies') {
            ilUtil::sendFailure($lng->txt("err_no_cookies"));
        }

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

        $tpl->fillWindowTitle();
        $tpl->fillCssFiles();
        $tpl->fillJavaScriptFiles();

        $tpl->show("DEFAULT", false);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showLoginForm()

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

protected

Show login form ilSetting $ilSetting.

Parameters

string

$page_editor_html

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

References $form, $ilSetting, $lng, $tpl, AUTH_CAS, AUTH_SHIBBOLETH, initStandardLoginForm(), and substituteLoginPageElements().

Referenced by showLogin(), and showLoginPage().

    {
        global $ilSetting,$lng,$tpl;

        // @todo move this to auth utils.
        // login via ILIAS (this also includes radius and ldap)
        // If local authentication is enabled for shibboleth users, we
        // display the login form for ILIAS here.
        if (($ilSetting->get("auth_mode") != AUTH_SHIBBOLETH ||
            $ilSetting->get("shib_auth_allow_local")) &&
            $ilSetting->get("auth_mode") != 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 (   $page_editor_html )

protected

Show login information.

Parameters

string

$page_editor_html

Returns

string $page_editor_html

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

References $lng, and $tpl.

Referenced by showLogin(), and showLoginPage().

    {
        global $lng,$tpl;

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

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

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

Here is the caller graph for this function:

showLoginPage()

ilStartUpGUI::showLoginPage ( ilPropertyFormGUI  $form = null )

protected

Todo:

check for forced authentication like ecs, ...

Show login page

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

References $form, $GLOBALS, $ilSetting, $tpl, getLogger(), getLoginPageEditorHTML(), purgePlaceholders(), ilUtil\sendFailure(), showCASLoginForm(), showLoginForm(), showLoginInformation(), showRegistrationLinks(), showSamlLoginForm(), and showShibbolethLoginForm().

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

    {
        global $tpl, $ilSetting;
        
        $this->getLogger()->debug('Showing login page');
    
        // try apache auth
        include_once './Services/Authentication/classes/Frontend/class.ilAuthFrontendCredentialsApache.php';
        $frontend = new ilAuthFrontendCredentialsApache();
        $frontend->tryAuthenticationOnLoginPage();
        
        // Instantiate login template
        self::initStartUpTemplate("tpl.login.html");
        
        $page_editor_html = $this->getLoginPageEditorHTML();
        $page_editor_html = $this->showLoginInformation($page_editor_html);
        $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);

        // not controlled by login page editor
        $tpl->setVariable("PAGETITLE", "- " . $this->lng->txt("startpage"));
        $tpl->setVariable("ILIAS_RELEASE", $ilSetting->get("ilias_version"));
        
        $this->ctrl->setTargetScript("ilias.php");
        
        // check expired session and send message
        if ($GLOBALS['DIC']['ilAuthSession']->isExpired()) {
            ilUtil::sendFailure($GLOBALS['lng']->txt('auth_err_expired'));
        }
        

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

        $tpl->fillWindowTitle();
        $tpl->fillCssFiles();
        $tpl->fillJavaScriptFiles();
        $tpl->show("DEFAULT", false);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showLogout()

ilStartUpGUI::showLogout

(

)

show logout screen

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

References $_COOKIE, $_SERVER, $client_id, $GLOBALS, $ilIliasIniFile, $ilSetting, $lng, $tpl, array, AUTH_SAML, ilSession\get(), ilPublicSectionSettings\getInstance(), ilUtil\redirect(), ilSession\SESSION_CLOSE_USER, ilSession\setClosingContext(), ilUtil\setCookie(), and user().

    {
        global $tpl, $ilSetting, $lng, $ilIliasIniFile;
        
        ilSession::setClosingContext(ilSession::SESSION_CLOSE_USER);
        $GLOBALS['DIC']['ilAuthSession']->logout();
        
        $GLOBALS['ilAppEventHandler']->raise(
            'Services/Authentication',
            'afterLogout',
            array(
                'username' => $GLOBALS['DIC']->user()->getLogin()
            )
        );

        // reset cookie
        $client_id = $_COOKIE["ilClientId"];
        ilUtil::setCookie("ilClientId", "");

        if ((int) $GLOBALS['DIC']->user()->getAuthMode(true) == AUTH_SAML && ilSession::get('used_external_auth')) {
            ilUtil::redirect('saml.php?action=logout&logout_url=' . urlencode(ILIAS_HTTP_PATH . '/login.php'));
        }

        //instantiate logout template
        self::initStartUpTemplate("tpl.logout.html");
        
        if (ilPublicSectionSettings::getInstance()->isEnabledForDomain($_SERVER['SERVER_NAME'])) {
            $tpl->setCurrentBlock("homelink");
            $tpl->setVariable("CLIENT_ID", "?client_id=" . $client_id . "&lang=" . $lng->getLangKey());
            $tpl->setVariable("TXT_HOME", $lng->txt("home"));
            $tpl->parseCurrentBlock();
        }

        if ($ilIliasIniFile->readVariable("clients", "list")) {
            $tpl->setCurrentBlock("client_list");
            $tpl->setVariable("TXT_CLIENT_LIST", $lng->txt("to_client_list"));
            $this->ctrl->setParameter($this, "client_id", $client_id);
            $tpl->setVariable(
                "CMD_CLIENT_LIST",
                $this->ctrl->getLinkTarget($this, "showClientList")
            );
            $tpl->parseCurrentBlock();
            $this->ctrl->setParameter($this, "client_id", "");
        }

        $tpl->setVariable("TXT_PAGEHEADLINE", $lng->txt("logout"));
        $tpl->setVariable("TXT_LOGOUT_TEXT", $lng->txt("logout_text"));
        $tpl->setVariable("TXT_LOGIN", $lng->txt("login_to_ilias"));
        $tpl->setVariable("CLIENT_ID", "?client_id=" . $client_id . "&lang=" . $lng->getLangKey());

        $tpl->show();
    }

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

References $tpl.

    {
        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->show();
    }

showRegistrationLinks()

ilStartUpGUI::showRegistrationLinks (   $page_editor_html )

protected

Show registration, password forgotten, client slection links ilLanguage $lng ilSetting $ilSetting <type> $ilIliasIniFile.

Parameters

string

$page_editor_html

Returns

string

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

References $_COOKIE, $_SERVER, $GLOBALS, $ilIliasIniFile, $ilSetting, $lng, ilRegistrationSettings\_lookupRegistrationType(), ilTermsOfServiceSignableDocumentFactory\getByLanguageObject(), ilPublicSectionSettings\getInstance(), IL_REG_DISABLED, ilTermsOfServiceHelper\isEnabled(), and substituteLoginPageElements().

Referenced by showLogin(), and showLoginPage().

    {
        global $lng, $ilSetting, $ilIliasIniFile, $ilAccess;

        $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() != IL_REG_DISABLED) {
            $rtpl->setCurrentBlock("new_registration");
            $rtpl->setVariable("REGISTER", $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 ($ilSetting->get("password_assistance")) {
            $rtpl->setCurrentBlock("password_assistance");
            $rtpl->setVariable("FORGOT_PASSWORD", $lng->txt("forgot_password"));
            $rtpl->setVariable("FORGOT_USERNAME", $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", $lng->getLangKey());
            $rtpl->parseCurrentBlock();
        }

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

        if ($ilIliasIniFile->readVariable("clients", "list")) {
            $rtpl->setCurrentBlock("client_list");
            $rtpl->setVariable("TXT_CLIENT_LIST", $lng->txt("to_client_list"));
            $rtpl->setVariable("CMD_CLIENT_LIST", $this->ctrl->getLinkTarget($this, "showClientList"));
            $rtpl->parseCurrentBlock();
        }

        return $this->substituteLoginPageElements(
            $GLOBALS['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

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

References $DIC, $factory, $idp, $table, and array.

Referenced by doSamlAuthentication().

    {
        global $DIC;

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

        $mainTpl  = $DIC->ui()->mainTemplate();
        $factory  = $DIC->ui()->factory();
        $renderer = $DIC->ui()->renderer();

        $DIC->ctrl()->setTargetScript('saml.php');

        $items = [];

        require_once 'Services/Saml/classes/class.ilSamlIdpSelectionTableGUI.php';
        $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(), $DIC->ctrl()->getLinkTarget($this, 'doSamlAuthentication')))
            ];
        }

        $table->setData($items);
        $mainTpl->setVariable('CONTENT', $table->getHtml());

        $mainTpl->fillWindowTitle();
        $mainTpl->fillCssFiles();
        $mainTpl->fillJavaScriptFiles();
        $mainTpl->show('DEFAULT', false);
    }

Here is the caller graph for this function:

showSamlLoginForm()

ilStartUpGUI::showSamlLoginForm (   $page_editor_html )

protected

Parameters

string

$page_editor_html

Returns

string

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

References $_GET, $GLOBALS, $tpl, ilSamlIdp\getActiveIdpList(), ilSamlSettings\getInstance(), ilUtil\stripSlashes(), and substituteLoginPageElements().

Referenced by showLogin(), and showLoginPage().

    {
        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 = '';
            if (isset($_GET['target'])) {
                $return = '?returnTo=' . urlencode(ilUtil::stripSlashes($_GET['target']));
            }

            $tpl->setVariable('SAML_SCRIPT_URL', './saml.php' . $return);
            $tpl->setVariable('TXT_LOGIN', $GLOBALS['DIC']->language()->txt('saml_log_in'));
            $tpl->setVariable('LOGIN_TO_ILIAS_VIA_SAML', $GLOBALS['DIC']->language()->txt('login_to_ilias_via_saml'));
            $tpl->setVariable('TXT_SAML_LOGIN_TXT', $GLOBALS['DIC']->language()->txt('saml_login_form_txt'));
            $tpl->setVariable('TXT_SAML_LOGIN_INFO_TXT', $GLOBALS['DIC']->language()->txt('saml_login_form_info_txt'));

            return $this->substituteLoginPageElements(
                $GLOBALS['tpl'],
                $page_editor_html,
                $tpl->get(),
                '[list-saml-login-form]',
                '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 (   $page_editor_html )

protected

Show shibboleth login form.

Parameters

string

$page_editor_html

Returns

string $page_editor_html

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

References $_GET, $GLOBALS, $ilSetting, $lng, $tpl, and substituteLoginPageElements().

Referenced by showLogin(), and showLoginPage().

    {
        global $ilSetting, $lng;

        // Refactoring with ilFormPropertyGUI
        // [...]

        // shibboleth login link
        if ($ilSetting->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));}

            if ($ilSetting->get("shib_hos_type") == 'external_wayf') {
                $tpl->setCurrentBlock("shibboleth_login");
                $tpl->setVariable("TXT_SHIB_LOGIN", $lng->txt("login_to_ilias_via_shibboleth"));
                $tpl->setVariable("IL_TARGET", $_GET["target"]);
                $tpl->setVariable("TXT_SHIB_FEDERATION_NAME", $ilSetting->get("shib_federation_name"));
                $tpl->setVariable("TXT_SHIB_LOGIN_BUTTON", $ilSetting->get("shib_login_button"));
                $tpl->setVariable("TXT_SHIB_LOGIN_INSTRUCTIONS", sprintf($lng->txt("shib_general_login_instructions"), $ilSetting->get("shib_federation_name")) . ' <a href="mailto:' . $ilSetting->get("admin_email") . '">ILIAS ' . $lng->txt("administrator") . '</a>.');
                $tpl->setVariable("TXT_SHIB_CUSTOM_LOGIN_INSTRUCTIONS", $ilSetting->get("shib_login_instructions"));
                $tpl->parseCurrentBlock();
            } elseif ($ilSetting->get("shib_hos_type") == 'embedded_wayf') {
                $tpl->setCurrentBlock("shibboleth_custom_login");
                $customInstructions = stripslashes($ilSetting->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", $lng->txt("login_to_ilias_via_shibboleth"));
                $tpl->setVariable("TXT_SHIB_FEDERATION_NAME", $ilSetting->get("shib_federation_name"));
                $tpl->setVariable("TXT_SELECT_HOME_ORGANIZATION", sprintf($lng->txt("shib_select_home_organization"), $ilSetting->get("shib_federation_name")));
                $tpl->setVariable("TXT_CONTINUE", $lng->txt("btn_next"));
                $tpl->setVariable("TXT_SHIB_HOME_ORGANIZATION", $lng->txt("shib_home_organization"));
                $tpl->setVariable("TXT_SHIB_LOGIN_INSTRUCTIONS", $lng->txt("shib_general_wayf_login_instructions") . ' <a href="mailto:' . $ilSetting->get("admin_email") . '">ILIAS ' . $lng->txt("administrator") . '</a>.');
                $tpl->setVariable("TXT_SHIB_CUSTOM_LOGIN_INSTRUCTIONS", $ilSetting->get("shib_login_instructions"));

                require_once "./Services/AuthShibboleth/classes/class.ilShibbolethWAYF.php";
                $WAYF = new ShibWAYF();

                $tpl->setVariable("TXT_SHIB_INVALID_SELECTION", $WAYF->showNotice());
                $tpl->setVariable("SHIB_IDP_LIST", $WAYF->generateSelection());
                $tpl->setVariable("ILW_TARGET", $_GET["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:

showUserMappingSelection()

ilStartUpGUI::showUserMappingSelection

(

)

Show user selection screen, if external account could not be mapped to an ILIAS account, but the provided e-mail address is known.

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

References $_GET, $_POST, $key, $lng, $tpl, $valid, ilObjUser\_getLocalAccountsForEmail(), ilUtil\prepareFormOutput(), and ilUtil\sendFailure().

    {
        global $ilAuth, $tpl, $lng;

        $valid = $ilAuth->getValidationData();

        self::initStartUpTemplate("tpl.user_mapping_selection.html");
        $email_user = ilObjUser::_getLocalAccountsForEmail($valid["email"]);


        if ($ilAuth->getSubStatus() == AUTH_WRONG_LOGIN) {
            ilUtil::sendFailure($lng->txt("err_wrong_login"));
        }

        include_once('./Services/User/classes/class.ilObjUser.php');
        if (count($email_user) == 1) {
            //$user = new ilObjUser(key($email_user));
            $tpl->setCurrentBlock("one_user");
            $tpl->setVariable("TXT_USERNAME", $lng->txt("username"));
            $tpl->setVariable("VAL_USERNAME", current($email_user));
            $tpl->setVariable("USER_ID", key($email_user));
            $tpl->parseCurrentBlock();
        } else {
            foreach ($email_user as $key => $login) {
                $tpl->setCurrentBlock("user");
                $tpl->setVariable("USR_ID", $key);
                $tpl->setVariable("VAL_USER", $login);
                $tpl->parseCurrentBlock();
            }
            $tpl->setCurrentBlock("multpiple_user");
            $tpl->parseCurrentBlock();
        }

        $tpl->setCurrentBlock("content");
        $this->ctrl->setParameter($this, "ext_uid", urlencode($_GET["ext_uid"]));
        $this->ctrl->setParameter($this, "soap_pw", urlencode($_GET["soap_pw"]));
        $this->ctrl->setParameter($this, "auth_stat", $_GET["auth_stat"]);
        $tpl->setVariable(
            "FORMACTION",
            $this->ctrl->getFormAction($this)
        );
        $tpl->setVariable("TXT_ILIAS_LOGIN", $lng->txt("login_to_ilias"));
        if (count($email_user) == 1) {
            $tpl->setVariable("TXT_EXPLANATION", $lng->txt("ums_explanation"));
            $tpl->setVariable("TXT_EXPLANATION_2", $lng->txt("ums_explanation_2"));
        } else {
            $tpl->setVariable("TXT_EXPLANATION", $lng->txt("ums_explanation_3"));
            $tpl->setVariable("TXT_EXPLANATION_2", $lng->txt("ums_explanation_4"));
        }
        $tpl->setVariable("TXT_CREATE_USER", $lng->txt("ums_create_new_account"));
        $tpl->setVariable("TXT_PASSWORD", $lng->txt("password"));
        $tpl->setVariable("PASSWORD", ilUtil::prepareFormOutput($_POST["password"]));
        $tpl->setVariable("TXT_SUBMIT", $lng->txt("login"));

        $tpl->show();
    }

Here is the call graph for this function:

substituteLoginPageElements()

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

protected

Substitute login page elements.

Parameters

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

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

References $tpl.

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

    {
        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

$ctrl

ilStartUpGUI::$ctrl

protected

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

$lng

ilStartUpGUI::$lng

protected

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

Referenced by __construct(), _checkGoto(), getAcceptance(), getLoginPageEditorHTML(), initCodeForm(), processCode(), purgePlaceholders(), showCASLoginForm(), showClientList(), showCodeForm(), showLogin(), showLoginForm(), showLoginInformation(), showLogout(), showRegistrationLinks(), showShibbolethLoginForm(), and showUserMappingSelection().

$logger

ilStartUpGUI::$logger

protected

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

Referenced by getLogger().

ACCOUNT_MIGRATION_MIGRATE

const ilStartUpGUI::ACCOUNT_MIGRATION_MIGRATE = 1

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

ACCOUNT_MIGRATION_NEW

const ilStartUpGUI::ACCOUNT_MIGRATION_NEW = 2

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

---

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

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