ilInitialisation Class Reference

ILIAS Initialisation Utility Class perform basic setup: init database handler, load configuration file, init user authentification & error handler, load object type definitions. More...

Collaboration diagram for ilInitialisation:

Static Public Member Functions
static	initFileUploadService (\ILIAS\DI\Container $dic)
	Initializes the file upload service. More...
static	setSessionHandler ()
	set session handler to db More...
static	goToPublicSection ()
	go to public section More...
static	reinitILIAS ()
static	initILIAS ()
	ilias initialisation More...
static	handleErrorReporting ()
	Set error reporting level. More...
static	resumeUserSession ()
	Resume an existing user session. More...
static	authenticate ()
	Try authentication. More...

Static Protected Member Functions
static	removeUnsafeCharacters ()
	Remove unsafe characters from GET. More...
static	recursivelyRemoveUnsafeCharacters ($var)
static	requireCommonIncludes ()
	get common include code files More...
static	includePhp5Compliance ()
	This is a hack for authentication. More...
static	initIliasIniFile ()
	This method provides a global instance of class ilIniFile for the ilias.ini.php file in variable $ilIliasIniFile. More...
static	buildHTTPPath ()
	builds http path More...
static	determineClient ()
	This method determines the current client and sets the constant CLIENT_ID. More...
static	initClientIniFile ()
	This method provides a global instance of class ilIniFile for the client.ini.php file in variable $ilClientIniFile. More...
static	handleMaintenanceMode ()
	handle maintenance mode More...
static	initDatabase ()
	initialise database object $ilDB More...
static	setCookieConstants ()
static	setSessionCookieParams ()
	set session cookie params More...
static	initMail (\ILIAS\DI\Container $c)
static	initAvatar (\ILIAS\DI\Container $c)
static	initSettings ()
	initialise $ilSettings object and define constants More...
static	initStyle ()
	provide $styleDefinition object More...
static	initLocale ()
	Init Locale. More...
static	goToLogin ()
	go to login More...
static	initAccessHandling ()
	$ilAccess and $rbac... More...
static	initLog ()
	Init log instance. More...
static	initGlobal ($a_name, $a_class, $a_source_file=null)
	Initialize global instance. More...
static	abortAndDie ($a_message)
	Exit. More...
static	handleDevMode ()
	Prepare developer tools. More...
static	initSession ()
	Init auth session. More...
static	initCore ()
	Init core objects (level 0) More...
static	initClient ()
	Init client-based objects (level 1) More...
static	initUser ()
	Init user / authentification (level 2) More...
static	initHTTPServices (\ILIAS\DI\Container $container)
static	initUIFramework (\ILIAS\DI\Container $c)
	init the ILIAS UI framework. More...
static	initHTML ()
	init HTML output (level 3) More...
static	getCurrentCmd ()
	Extract current cmd from request. More...
static	blockedAuthentication ($a_current_script)
	Block authentication based on current request. More...
static	showingLoginForm ($a_current_script)
	Is current view the login form? More...
static	translateMessage ($a_message_id, array $a_message_static=null)
	Translate message if possible. More...
static	redirect ($a_target, $a_message_id='', array $a_message_static=null)
	Redirects to target url if context supports it. More...

Static Protected Attributes
static	$already_initialized

Static Private Member Functions
static	initBackgroundTasks (\ILIAS\DI\Container $c)
static	initInjector (\ILIAS\DI\Container $c)

Detailed Description

ILIAS Initialisation Utility Class perform basic setup: init database handler, load configuration file, init user authentification & error handler, load object type definitions.

Author

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

Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version

$Id$

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

Member Function Documentation

abortAndDie()

static ilInitialisation::abortAndDie (   $a_message )

staticprotected

Exit.

Parameters

string

$a_message

Definition at line 911 of file class.ilInitialisation.php.

References $GLOBALS.

    {
        if (is_object($GLOBALS['ilLog'])) {
            $GLOBALS['ilLog']->write("Fatal Error: ilInitialisation - " . $a_message);
        }
        die($a_message);
    }

authenticate()

static ilInitialisation::authenticate ( )

static

Try authentication.

This will basically validate the current session

Definition at line 1235 of file class.ilInitialisation.php.

References $_SERVER, $GLOBALS, $ilErr, $ilSetting, $ilUser, ilContext\CONTEXT_SOAP, ilContext\CONTEXT_WAC, ilPublicSectionSettings\getInstance(), ilLoggerFactory\getLogger(), and ilContext\getType().

    {
        global $ilAuth, $ilias, $ilErr;
        
        $current_script = substr(strrchr($_SERVER["PHP_SELF"], "/"), 1);
        
        if (self::blockedAuthentication($current_script)) {
            return;
        }
                        
        $oldSid = session_id();
        
        $ilAuth->start();
        $ilias->setAuthError($ilErr->getLastError());

        if ($ilAuth->getAuth() && $ilAuth->getStatus() == '') {
            self::initUserAccount();
            
            self::handleAuthenticationSuccess();
        } else {
            if (!self::showingLoginForm($current_script)) {
                // :TODO: should be moved to context?!
                $mandatory_auth = ($current_script != "shib_login.php"
                        && $current_script != "shib_logout.php"
                        && $current_script != "saml.php"
                        && $current_script != "error.php"
                        && $current_script != "chat.php"
                        && $current_script != "wac.php"
                        && $current_script != "index.php"); // #10316
                
                if ($mandatory_auth) {
                    self::handleAuthenticationFail();
                }
            }
        }
    }

Here is the call graph for this function:

blockedAuthentication()

static ilInitialisation::blockedAuthentication (   $a_current_script )

staticprotected

Block authentication based on current request.

Returns

boolean

Definition at line 1520 of file class.ilInitialisation.php.

References $_GET, array, ilContext\CONTEXT_APACHE_SSO, ilContext\CONTEXT_LTI_PROVIDER, ilContext\CONTEXT_SAML, ilContext\CONTEXT_SHIBBOLETH, ilContext\CONTEXT_WAC, ilContext\CONTEXT_WEBDAV, ilLoggerFactory\getLogger(), and ilContext\getType().

    {
        if (ilContext::getType() == ilContext::CONTEXT_WAC) {
            ilLoggerFactory::getLogger('init')->debug('Blocked authentication for WAC request.');
            return true;
        }
        if (ilContext::getType() == ilContext::CONTEXT_APACHE_SSO) {
            ilLoggerFactory::getLogger('init')->debug('Blocked authentication for sso request.');
            return true;
        }
        if (ilContext::getType() == ilContext::CONTEXT_WEBDAV) {
            ilLoggerFactory::getLogger('init')->debug('Blocked authentication for webdav request');
            return true;
        }
        if (ilContext::getType() == ilContext::CONTEXT_SHIBBOLETH) {
            ilLoggerFactory::getLogger('init')->debug('Blocked authentication for shibboleth request.');
            return true;
        }
        if (ilContext::getType() == ilContext::CONTEXT_LTI_PROVIDER) {
            ilLoggerFactory::getLogger('init')->debug('Blocked authentication for lti provider requests.');
            return true;
        }
        if (ilContext::getType() == ilContext::CONTEXT_SAML) {
            ilLoggerFactory::getLogger('init')->debug('Blocked authentication for SAML request.');
            return true;
        }
        if (
            $a_current_script == "register.php" ||
            $a_current_script == "pwassist.php" ||
            $a_current_script == "confirmReg.php" ||
            $a_current_script == "il_securimage_play.php" ||
            $a_current_script == "il_securimage_show.php" ||
            $a_current_script == 'login.php'
        ) {
            ilLoggerFactory::getLogger('auth')->debug('Blocked authentication for script: ' . $a_current_script);
            return true;
        }
        
        if ($_REQUEST["baseClass"] == "ilStartUpGUI") {
            $cmd_class = $_REQUEST["cmdClass"];
            
            if ($cmd_class == "ilaccountregistrationgui" ||
                $cmd_class == "ilpasswordassistancegui") {
                ilLoggerFactory::getLogger('auth')->debug('Blocked authentication for cmdClass: ' . $cmd_class);
                return true;
            }
            
            $cmd = self::getCurrentCmd();
            if (
                $cmd == "showTermsOfService" || $cmd == "showClientList" ||
                $cmd == 'showAccountMigration' || $cmd == 'migrateAccount' ||
                $cmd == 'processCode' || $cmd == 'showLoginPage' || $cmd == 'doStandardAuthentication' || $cmd == 'doCasAuthentication'
            ) {
                ilLoggerFactory::getLogger('auth')->debug('Blocked authentication for cmd: ' . $cmd);
                return true;
            }
        }
        
        // #12884
        if (($a_current_script == "goto.php" && $_GET["target"] == "impr_0") ||
            $_GET["baseClass"] == "ilImprintGUI") {
            ilLoggerFactory::getLogger('auth')->debug('Blocked authentication for baseClass: ' . $_GET['baseClass']);
            return true;
        }

        if ($a_current_script == 'goto.php' && in_array($_GET['target'], array(
            'usr_registration', 'usr_nameassist', 'usr_pwassist', 'usr_agreement'
        ))) {
            ilLoggerFactory::getLogger('auth')->debug('Blocked authentication for goto target: ' . $_GET['target']);
            return true;
        }

        ilLoggerFactory::getLogger('auth')->debug('Authentication required');
        return false;
    }

Here is the call graph for this function:

buildHTTPPath()

static ilInitialisation::buildHTTPPath ( )

staticprotected

builds http path

Definition at line 289 of file class.ilInitialisation.php.

References $_SERVER, $https, $module, $path, GuzzleHttp\Psr7\$protocol, ilContext\CONTEXT_APACHE_SSO, defined, ilContext\getType(), ILIAS_MODULE, and ilUtil\removeTrailingPathSeparators().

    {
        include_once './Services/Http/classes/class.ilHTTPS.php';
        $https = new ilHTTPS();

        if ($https->isDetected()) {
            $protocol = 'https://';
        } else {
            $protocol = 'http://';
        }
        $host = $_SERVER['HTTP_HOST'];

        $rq_uri = strip_tags($_SERVER['REQUEST_URI']);

        // security fix: this failed, if the URI contained "?" and following "/"
        // -> we remove everything after "?"
        if (is_int($pos = strpos($rq_uri, "?"))) {
            $rq_uri = substr($rq_uri, 0, $pos);
        }

        if (!defined('ILIAS_MODULE')) {
            $path = pathinfo($rq_uri);
            if (!$path['extension']) {
                $uri = $rq_uri;
            } else {
                $uri = dirname($rq_uri);
            }
        } else {
            // if in module remove module name from HTTP_PATH
            $path = dirname($rq_uri);

            // dirname cuts the last directory from a directory path e.g content/classes return content

            $module = ilUtil::removeTrailingPathSeparators(ILIAS_MODULE);

            $dirs = explode('/', $module);
            $uri = $path;
            foreach ($dirs as $dir) {
                $uri = dirname($uri);
            }
        }
        if (ilContext::getType() == ilContext::CONTEXT_APACHE_SSO) {
            return define('ILIAS_HTTP_PATH', ilUtil::removeTrailingPathSeparators(dirname($protocol . $host . $uri)));
        }
        return define('ILIAS_HTTP_PATH', ilUtil::removeTrailingPathSeparators($protocol . $host . $uri));
    }

Here is the call graph for this function:

determineClient()

static ilInitialisation::determineClient ( )

staticprotected

This method determines the current client and sets the constant CLIENT_ID.

Definition at line 340 of file class.ilInitialisation.php.

References $_COOKIE, $_GET, League\OAuth2\Client\Provider\$clientId, $ilIliasIniFile, defined, ilUtil\getClientIdByString(), ilUtil\setCookie(), and ilContext\supportsPersistentSessions().

    {
        global $ilIliasIniFile;

        // check whether ini file object exists
        if (!is_object($ilIliasIniFile)) {
            self::abortAndDie('Fatal Error: ilInitialisation::determineClient called without initialisation of ILIAS ini file object.');
        }

        if (isset($_GET['client_id']) && strlen($_GET['client_id']) > 0) {
            $_GET['client_id'] = \ilUtil::getClientIdByString((string) $_GET['client_id'])->toString();
            if (!defined('IL_PHPUNIT_TEST')) {
                if (ilContext::supportsPersistentSessions()) {
                    ilUtil::setCookie('ilClientId', $_GET['client_id']);
                }
            }
        } elseif (!isset($_COOKIE['ilClientId'])) {
            ilUtil::setCookie('ilClientId', $ilIliasIniFile->readVariable('clients', 'default'));
        }

        if (!defined('IL_PHPUNIT_TEST') && ilContext::supportsPersistentSessions()) {
            $clientId = $_COOKIE['ilClientId'];
        } else {
            $clientId = $_GET['client_id'];
        }

        define('CLIENT_ID', \ilUtil::getClientIdByString((string) $clientId)->toString());
    }

Here is the call graph for this function:

getCurrentCmd()

static ilInitialisation::getCurrentCmd ( )

staticprotected

Extract current cmd from request.

Returns

string

Definition at line 1505 of file class.ilInitialisation.php.

    {
        $cmd = $_REQUEST["cmd"];
        if (is_array($cmd)) {
            return array_shift(array_keys($cmd));
        } else {
            return $cmd;
        }
    }

goToLogin()

static ilInitialisation::goToLogin ( )

staticprotected

go to login

Parameters

int

$a_auth_stat

Definition at line 790 of file class.ilInitialisation.php.

References $_COOKIE, $_GET, $DIC, $GLOBALS, array, ilLanguage\getFallbackInstance(), ilLoggerFactory\getLogger(), ilSession\SESSION_CLOSE_EXPIRE, ilSession\SESSION_CLOSE_LOGIN, and ilSession\setClosingContext().

    {
        ilLoggerFactory::getLogger('init')->debug('Redirecting to login page.');
        
        if ($GLOBALS['DIC']['ilAuthSession']->isExpired()) {
            ilSession::setClosingContext(ilSession::SESSION_CLOSE_EXPIRE);
        }
        if (!$GLOBALS['DIC']['ilAuthSession']->isAuthenticated()) {
            ilSession::setClosingContext(ilSession::SESSION_CLOSE_LOGIN);
        }
        
        $script = "login.php?target=" . $_GET["target"] . "&client_id=" . $_COOKIE["ilClientId"] .
            "&auth_stat=" . $a_auth_stat;
                    
        self::redirect(
            $script,
            "init_error_authentication_fail",
            array(
                "en" => "Authentication failed.",
                "de" => "Authentifizierung fehlgeschlagen.")
        );
    }

Here is the call graph for this function:

goToPublicSection()

static ilInitialisation::goToPublicSection ( )

static

go to public section

Parameters

int

$a_auth_stat

Definition at line 735 of file class.ilInitialisation.php.

References $_GET, $_SERVER, $GLOBALS, ilSession\SESSION_CLOSE_EXPIRE, ilSession\SESSION_CLOSE_PUBLIC, and ilSession\setClosingContext().

Referenced by ilAuthUtils\handleForcedAuthentication(), ilStartUpGUI\processIndexPHP(), and redirect().

    {
        global $ilAuth;
                
        if (ANONYMOUS_USER_ID == "") {
            self::abortAndDie("Public Section enabled, but no Anonymous user found.");
        }
        
        $session_destroyed = false;
        if ($GLOBALS['DIC']['ilAuthSession']->isExpired()) {
            $session_destroyed = true;
            ilSession::setClosingContext(ilSession::SESSION_CLOSE_EXPIRE);
        }
        if (!$GLOBALS['DIC']['ilAuthSession']->isAuthenticated()) {
            $session_destroyed = true;
            ilSession::setClosingContext(ilSession::SESSION_CLOSE_PUBLIC);
        }
        
        if ($session_destroyed) {
            $GLOBALS['DIC']['ilAuthSession']->setAuthenticated(true, ANONYMOUS_USER_ID);
        }
        
        self::initUserAccount();
        
        // if target given, try to go there
        if (strlen($_GET["target"])) {
            // when we are already "inside" goto.php no redirect is needed
            $current_script = substr(strrchr($_SERVER["PHP_SELF"], "/"), 1);
            if ($current_script == "goto.php") {
                return;
            }
            // goto will check if target is accessible or redirect to login
            self::redirect("goto.php?target=" . $_GET["target"]);
        }
        
        // check access of root folder otherwise redirect to login
        #if(!$GLOBALS['DIC']->rbac()->system()->checkAccess('read', ROOT_FOLDER_ID))
        #{
        #       return self::goToLogin();
        #}
        
        // we do not know if ref_id of request is accesible, so redirecting to root
        $_GET["ref_id"] = ROOT_FOLDER_ID;
        $_GET["cmd"] = "frameset";
        self::redirect(
            "ilias.php?baseClass=ilrepositorygui&reloadpublic=1&cmd=" .
            $_GET["cmd"] . "&ref_id=" . $_GET["ref_id"]
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handleDevMode()

static ilInitialisation::handleDevMode ( )

staticprotected

Prepare developer tools.

Definition at line 922 of file class.ilInitialisation.php.

References defined.

    {
        if (defined(SHOWNOTICES) && SHOWNOTICES) {
            // no further differentiating of php version regarding to 5.4 neccessary
            // when the error reporting is set to E_ALL anyway
            
            // add notices to error reporting
            error_reporting(E_ALL);
        }
        
        if (defined('DEBUGTOOLS') && DEBUGTOOLS) {
            include_once "include/inc.debug.php";
        }
    }

handleErrorReporting()

static ilInitialisation::handleErrorReporting ( )

static

Set error reporting level.

Definition at line 1030 of file class.ilInitialisation.php.

Referenced by ilWebAccessCheckerDelivery\handleRequest().

    {
        // push the error level as high as possible / sane
        error_reporting(E_ALL & ~E_NOTICE);
        
        // see handleDevMode() - error reporting might be overwritten again
        // but we need the client ini first
    }

Here is the caller graph for this function:

handleMaintenanceMode()

static ilInitialisation::handleMaintenanceMode ( )

staticprotected

handle maintenance mode

Definition at line 462 of file class.ilInitialisation.php.

References array, and ilContext\hasHTML().

    {
        global $ilClientIniFile;

        if (!$ilClientIniFile->readVariable("client", "access")) {
            $mess = array("en" => "The server is not available due to maintenance." .
                    " We apologise for any inconvenience.",
                "de" => "Der Server ist aufgrund von Wartungsarbeiten nicht verfügbar." .
                    " Wir bitten um Verständnis.");
            $mess_id = "init_error_maintenance";
            
            if (ilContext::hasHTML() && is_file("./maintenance.html")) {
                self::redirect("./maintenance.html", $mess_id, $mess);
            } else {
                $mess = self::translateMessage($mess_id, $mess);
                self::abortAndDie($mess);
            }
        }
    }

Here is the call graph for this function:

includePhp5Compliance()

static ilInitialisation::includePhp5Compliance ( )

staticprotected

This is a hack for authentication.

Since the phpCAS lib ships with its own compliance functions.

Definition at line 94 of file class.ilInitialisation.php.

References ilAuthFactory\CONTEXT_CAS, and ilAuthFactory\getContext().

    {
        include_once 'Services/Authentication/classes/class.ilAuthFactory.php';
        if (ilAuthFactory::getContext() != ilAuthFactory::CONTEXT_CAS) {
            require_once("include/inc.xml5compliance.php");
        }
        require_once("include/inc.xsl5compliance.php");
    }

Here is the call graph for this function:

initAccessHandling()

static ilInitialisation::initAccessHandling ( )

staticprotected

$ilAccess and $rbac...

initialisation

Definition at line 843 of file class.ilInitialisation.php.

References ilRbacSystem\getInstance().

    {
        self::initGlobal(
            "rbacreview",
            "ilRbacReview",
            "./Services/AccessControl/classes/class.ilRbacReview.php"
        );
        
        require_once "./Services/AccessControl/classes/class.ilRbacSystem.php";
        $rbacsystem = ilRbacSystem::getInstance();
        self::initGlobal("rbacsystem", $rbacsystem);
        
        self::initGlobal(
            "rbacadmin",
            "ilRbacAdmin",
            "./Services/AccessControl/classes/class.ilRbacAdmin.php"
        );
        
        self::initGlobal(
            "ilAccess",
            "ilAccess",
            "./Services/AccessControl/classes/class.ilAccess.php"
        );
        
        require_once "./Services/AccessControl/classes/class.ilConditionHandler.php";
    }

Here is the call graph for this function:

initAvatar()

static ilInitialisation::initAvatar ( \ILIAS\DI\Container  $c )

staticprotected

Parameters

\ILIAS\DI\Container

$c

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

    {
        $c["user.avatar.factory"] = function ($c) {
            require_once 'Services/User/Avatar/classes/class.ilUserAvatarFactory.php';
            return new ilUserAvatarFactory($c);
        };
    }

initBackgroundTasks()

static ilInitialisation::initBackgroundTasks ( \ILIAS\DI\Container  $c )

staticprivate

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

References $ilIliasIniFile, and $sync.

    {
        global $ilIliasIniFile;

        $n_of_tasks = $ilIliasIniFile->readVariable("background_tasks", "number_of_concurrent_tasks");
        $sync = $ilIliasIniFile->readVariable("background_tasks", "concurrency");

        $n_of_tasks = $n_of_tasks ? $n_of_tasks : 5;
        $sync = $sync ? $sync : 'sync'; // The default value is sync.

        $c["bt.task_factory"] = function ($c) {
            return new \ILIAS\BackgroundTasks\Implementation\Tasks\BasicTaskFactory($c["di.injector"]);
        };

        $c["bt.persistence"] = function ($c) {
            return new \ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence();
        };

        $c["bt.injector"] = function ($c) {
            return new \ILIAS\BackgroundTasks\Dependencies\Injector($c, new BaseDependencyMap());
        };

        $c["bt.task_manager"] = function ($c) use ($sync) {
            if ($sync == 'sync') {
                return new \ILIAS\BackgroundTasks\Implementation\TaskManager\BasicTaskManager($c["bt.persistence"]);
            } elseif ($sync == 'async') {
                return new \ILIAS\BackgroundTasks\Implementation\TaskManager\AsyncTaskManager($c["bt.persistence"]);
            } else {
                throw new ilException("The supported Background Task Managers are sync and async. $sync given.");
            }
        };
    }

initClient()

static ilInitialisation::initClient ( )

staticprotected

Init client-based objects (level 1)

Definition at line 1084 of file class.ilInitialisation.php.

References $DIC, $GLOBALS, $https, and ilContext\usesHTTP().

    {
        global $https, $ilias, $DIC;

        self::setCookieConstants();

        self::determineClient();

        self::bootstrapFilesystems();

        self::initClientIniFile();
                
        
        // --- needs client ini
        
        $ilias->client_id = CLIENT_ID;
        
        if (DEVMODE) {
            self::handleDevMode();
        }
    

        self::handleMaintenanceMode();

        self::initDatabase();

        // init dafault language
        self::initLanguage(false);
        
        // moved after databases
        self::initLog();
        
        self::initGlobal(
            "ilAppEventHandler",
            "ilAppEventHandler",
            "./Services/EventHandling/classes/class.ilAppEventHandler.php"
        );

        // there are rare cases where initILIAS is called twice for a request
        // example goto.php is called and includes ilias.php later
        // we must prevent that ilPluginAdmin is initialized twice in
        // this case, since this won't get the values out of plugin.php the
        // second time properly
        if (!isset($DIC["ilPluginAdmin"]) || !$DIC["ilPluginAdmin"] instanceof ilPluginAdmin) {
            self::initGlobal(
                "ilPluginAdmin",
                "ilPluginAdmin",
                "./Services/Component/classes/class.ilPluginAdmin.php"
            );
        }

        self::initSettings();
        self::setSessionHandler();
        self::initMail($GLOBALS['DIC']);
        self::initAvatar($GLOBALS['DIC']);
        
        
        // --- needs settings
        
        self::initLocale();
                        
        if (ilContext::usesHTTP()) {
            // $https
            self::initGlobal("https", "ilHTTPS", "./Services/Http/classes/class.ilHTTPS.php");
            $https->enableSecureCookies();
            $https->checkPort();
        }
        

        // --- object handling
        
        self::initGlobal(
            "ilObjDataCache",
            "ilObjectDataCache",
            "./Services/Object/classes/class.ilObjectDataCache.php"
        );
                                                
        // needed in ilObjectDefinition
        require_once "./Services/Xml/classes/class.ilSaxParser.php";
        
        self::initGlobal(
            "objDefinition",
            "ilObjectDefinition",
            "./Services/Object/classes/class.ilObjectDefinition.php"
        );
        
        // $tree
        require_once "./Services/Tree/classes/class.ilTree.php";
        $tree = new ilTree(ROOT_FOLDER_ID);
        self::initGlobal("tree", $tree);
        unset($tree);

        self::initGlobal(
            "ilCtrl",
            "ilCtrl",
            "./Services/UICore/classes/class.ilCtrl.php"
        );

        self::setSessionCookieParams();
    }

Here is the call graph for this function:

initClientIniFile()

static ilInitialisation::initClientIniFile ( )

staticprotected

This method provides a global instance of class ilIniFile for the client.ini.php file in variable $ilClientIniFile.

It initializes a lot of constants accordingly to the settings in the client.ini.php file.

Preconditions: ILIAS_WEB_DIR and CLIENT_ID must be set.

Returns

boolean true, if no error occured with client init file otherwise false

Definition at line 381 of file class.ilInitialisation.php.

References $_COOKIE, $ilIliasIniFile, array, ilUtil\setCookie(), and ilGlobalCache\setup().

    {
        global $ilIliasIniFile;
        
        // check whether ILIAS_WEB_DIR is set.
        if (ILIAS_WEB_DIR == "") {
            self::abortAndDie("Fatal Error: ilInitialisation::initClientIniFile called without ILIAS_WEB_DIR.");
        }

        // check whether CLIENT_ID is set.
        if (CLIENT_ID == "") {
            self::abortAndDie("Fatal Error: ilInitialisation::initClientIniFile called without CLIENT_ID.");
        }

        $ini_file = "./" . ILIAS_WEB_DIR . "/" . CLIENT_ID . "/client.ini.php";

        // get settings from ini file
        $ilClientIniFile = new ilIniFile($ini_file);
        $ilClientIniFile->read();
        
        // invalid client id / client ini
        if ($ilClientIniFile->ERROR != "") {
            $c = $_COOKIE["ilClientId"];
            $default_client = $ilIliasIniFile->readVariable("clients", "default");
            ilUtil::setCookie("ilClientId", $default_client);
            if (CLIENT_ID != "" && CLIENT_ID != $default_client) {
                $mess = array("en" => "Client does not exist.",
                        "de" => "Mandant ist ungültig.");
                self::redirect("index.php?client_id=" . $default_client, null, $mess);
            } else {
                self::abortAndDie("Fatal Error: ilInitialisation::initClientIniFile initializing client ini file abborted with: " . $ilClientIniFile->ERROR);
            }
        }
        
        self::initGlobal("ilClientIniFile", $ilClientIniFile);

        // set constants
        define("SESSION_REMINDER_LEADTIME", 30);
        define("DEBUG", $ilClientIniFile->readVariable("system", "DEBUG"));
        define("DEVMODE", $ilClientIniFile->readVariable("system", "DEVMODE"));
        define("SHOWNOTICES", $ilClientIniFile->readVariable("system", "SHOWNOTICES"));
        define("DEBUGTOOLS", $ilClientIniFile->readVariable("system", "DEBUGTOOLS"));
        define("ROOT_FOLDER_ID", $ilClientIniFile->readVariable('system', 'ROOT_FOLDER_ID'));
        define("SYSTEM_FOLDER_ID", $ilClientIniFile->readVariable('system', 'SYSTEM_FOLDER_ID'));
        define("ROLE_FOLDER_ID", $ilClientIniFile->readVariable('system', 'ROLE_FOLDER_ID'));
        define("MAIL_SETTINGS_ID", $ilClientIniFile->readVariable('system', 'MAIL_SETTINGS_ID'));
        $error_handler = $ilClientIniFile->readVariable('system', 'ERROR_HANDLER');
        define("ERROR_HANDLER", $error_handler ? $error_handler : "PRETTY_PAGE");
        
        // this is for the online help installation, which sets OH_REF_ID to the
        // ref id of the online module
        define("OH_REF_ID", $ilClientIniFile->readVariable("system", "OH_REF_ID"));

        define("SYSTEM_MAIL_ADDRESS", $ilClientIniFile->readVariable('system', 'MAIL_SENT_ADDRESS')); // Change SS
        define("MAIL_REPLY_WARNING", $ilClientIniFile->readVariable('system', 'MAIL_REPLY_WARNING')); // Change SS

        // see ilObject::TITLE_LENGTH, ilObject::DESC_LENGTH
        // define ("MAXLENGTH_OBJ_TITLE",125);#$ilClientIniFile->readVariable('system','MAXLENGTH_OBJ_TITLE'));
        // define ("MAXLENGTH_OBJ_DESC",$ilClientIniFile->readVariable('system','MAXLENGTH_OBJ_DESC'));

        define("CLIENT_DATA_DIR", ILIAS_DATA_DIR . "/" . CLIENT_ID);
        define("CLIENT_WEB_DIR", ILIAS_ABSOLUTE_PATH . "/" . ILIAS_WEB_DIR . "/" . CLIENT_ID);
        define("CLIENT_NAME", $ilClientIniFile->readVariable('client', 'name')); // Change SS

        $val = $ilClientIniFile->readVariable("db", "type");
        if ($val == "") {
            define("IL_DB_TYPE", "mysql");
        } else {
            define("IL_DB_TYPE", $val);
        }

        $ilGlobalCacheSettings = new ilGlobalCacheSettings();
        $ilGlobalCacheSettings->readFromIniFile($ilClientIniFile);
        ilGlobalCache::setup($ilGlobalCacheSettings);
        
        return true;
    }

Here is the call graph for this function:

initCore()

static ilInitialisation::initCore ( )

staticprotected

Init core objects (level 0)

Definition at line 1042 of file class.ilInitialisation.php.

References $_POST, $ilErr, array, ilSession\get(), and PEAR_ERROR_CALLBACK.

    {
        global $ilErr;
        
        self::handleErrorReporting();
        
        // breaks CAS: must be included after CAS context isset in AuthUtils
        //self::includePhp5Compliance();

        self::requireCommonIncludes();
        
        
        // error handler
        self::initGlobal(
            "ilErr",
            "ilErrorHandling",
            "./Services/Init/classes/class.ilErrorHandling.php"
        );
        $ilErr->setErrorHandling(PEAR_ERROR_CALLBACK, array($ilErr, 'errorHandler'));
        
        // :TODO: obsolete?
        // PEAR::setErrorHandling(PEAR_ERROR_CALLBACK, array($ilErr, "errorHandler"));
                    
        // workaround: load old post variables if error handler 'message' was called
        include_once "Services/Authentication/classes/class.ilSession.php";
        if (ilSession::get("message")) {
            $_POST = ilSession::get("post_vars");
        }
                    
        self::removeUnsafeCharacters();

        self::initIliasIniFile();

        define('IL_INITIAL_WD', getcwd());
        
        // deprecated
        self::initGlobal("ilias", "ILIAS", "./Services/Init/classes/class.ilias.php");
    }

Here is the call graph for this function:

initDatabase()

static ilInitialisation::initDatabase ( )

staticprotected

initialise database object $ilDB

Definition at line 486 of file class.ilInitialisation.php.

References $ilDB.

    {
        // build dsn of database connection and connect
        require_once("./Services/Database/classes/class.ilDBWrapperFactory.php");
        $ilDB = ilDBWrapperFactory::getWrapper(IL_DB_TYPE);
        $ilDB->initFromIniFile();
        $ilDB->connect();
        
        self::initGlobal("ilDB", $ilDB);
    }

initFileUploadService()

static ilInitialisation::initFileUploadService ( \ILIAS\DI\Container  $dic )

static

Initializes the file upload service.

This service requires the http and filesystem service.

Parameters

\ILIAS\DI\Container

$dic

The dependency container which should be used to load the file upload service.

Returns

void

Definition at line 270 of file class.ilInitialisation.php.

References ilVirusScannerFactory\_getInstance().

    {
        $dic['upload.processor-manager'] = function ($c) {
            return new \ILIAS\FileUpload\Processor\PreProcessorManagerImpl();
        };

        $dic['upload'] = function ($c) {
            $fileUploadImpl = new \ILIAS\FileUpload\FileUploadImpl($c['upload.processor-manager'], $c['filesystem'], $c['http']);
            if (IL_VIRUS_SCANNER != "None") {
                $fileUploadImpl->register(new \ILIAS\FileUpload\Processor\VirusScannerPreProcessor(ilVirusScannerFactory::_getInstance()));
            }

            return $fileUploadImpl;
        };
    }

Here is the call graph for this function:

initGlobal()

static ilInitialisation::initGlobal (   $a_name,   $a_class,   $a_source_file = null  )

staticprotected

Initialize global instance.

Parameters

string	$a_name
string	$a_class
string	$a_source_file

Definition at line 890 of file class.ilInitialisation.php.

References $DIC, and $GLOBALS.

    {
        global $DIC;

        if ($a_source_file) {
            include_once $a_source_file;
            $GLOBALS[$a_name] = new $a_class;
        } else {
            $GLOBALS[$a_name] = $a_class;
        }

        $DIC[$a_name] = function ($c) use ($a_name) {
            return $GLOBALS[$a_name];
        };
    }

initHTML()

static ilInitialisation::initHTML ( )

staticprotected

init HTML output (level 3)

Definition at line 1392 of file class.ilInitialisation.php.

References $_GET, $GLOBALS, $ilUser, $tpl, ilUtil\getStyleSheetLocation(), ilContext\hasUser(), and ilSession\set().

    {
        global $ilUser;
        require_once "./Services/LTI/classes/class.ilLTIViewGUI.php";
        $lti = new ilLTIViewGUI($ilUser);
        $GLOBALS["DIC"]["lti"] = $lti;
        
        if (ilContext::hasUser()) {
            // load style definitions
            // use the init function with plugin hook here, too
            self::initStyle();
        }

        self::initUIFramework($GLOBALS["DIC"]);

        // LTI
        if ($lti->isActive()) {
            include_once "./Services/LTI/classes/class.ilTemplate.php";
            $tpl = new LTI\ilTemplate("tpl.main.html", true, true, "Services/LTI");
        } else {
            $tpl = new ilTemplate("tpl.main.html", true, true);
        }
        
        self::initGlobal("tpl", $tpl);

        if (ilContext::hasUser()) {
            require_once 'Services/User/classes/class.ilUserRequestTargetAdjustment.php';
            $request_adjuster = new ilUserRequestTargetAdjustment($ilUser, $GLOBALS['DIC']['ilCtrl']);
            $request_adjuster->adjust();
        }


        // load style sheet depending on user's settings
        $location_stylesheet = ilUtil::getStyleSheetLocation();
        $tpl->setVariable("LOCATION_STYLESHEET", $location_stylesheet);
        
        require_once "./Services/UICore/classes/class.ilFrameTargetInfo.php";
                
        self::initGlobal(
            "ilNavigationHistory",
            "ilNavigationHistory",
            "Services/Navigation/classes/class.ilNavigationHistory.php"
        );

        self::initGlobal(
            "ilBrowser",
            "ilBrowser",
            "./Services/Utilities/classes/class.ilBrowser.php"
        );

        self::initGlobal(
            "ilHelp",
            "ilHelpGUI",
            "Services/Help/classes/class.ilHelpGUI.php"
        );

        self::initGlobal(
            "ilToolbar",
            "ilToolbarGUI",
            "./Services/UIComponent/Toolbar/classes/class.ilToolbarGUI.php"
        );

        self::initGlobal(
            "ilLocator",
            "ilLocatorGUI",
            "./Services/Locator/classes/class.ilLocatorGUI.php"
        );

        self::initGlobal(
            "ilTabs",
            "ilTabsGUI",
            "./Services/UIComponent/Tabs/classes/class.ilTabsGUI.php"
        );

        if (ilContext::hasUser()) {
            // LTI
            if ($lti->isActive()) {
                include_once './Services/LTI/classes/class.ilMainMenuGUI.php';
                $ilMainMenu = new LTI\ilMainMenuGUI("_top");
            } else {
                include_once './Services/MainMenu/classes/class.ilMainMenuGUI.php';
                $ilMainMenu = new ilMainMenuGUI("_top");
            }
            
            self::initGlobal("ilMainMenu", $ilMainMenu);
            unset($ilMainMenu);

            // :TODO: tableGUI related

            // set hits per page for all lists using table module
            $_GET['limit'] = (int) $ilUser->getPref('hits_per_page');
            ilSession::set('tbl_limit', $_GET['limit']);

            // the next line makes it impossible to save the offset somehow in a session for
            // a specific table (I tried it for the user administration).
            // its not posssible to distinguish whether it has been set to page 1 (=offset = 0)
            // or not set at all (then we want the last offset, e.g. being used from a session var).
            // So I added the wrapping if statement. Seems to work (hopefully).
            // Alex April 14th 2006
            if (isset($_GET['offset']) && $_GET['offset'] != "") {                                                      // added April 14th 2006
                $_GET['offset'] = (int) $_GET['offset'];                // old code
            }
        } else {
            // several code parts rely on ilObjUser being always included
            include_once "Services/User/classes/class.ilObjUser.php";
        }
    }

Here is the call graph for this function:

initHTTPServices()

static ilInitialisation::initHTTPServices ( \ILIAS\DI\Container  $container )

staticprotected

Parameters

\ILIAS\DI\Container

$container

Definition at line 1320 of file class.ilInitialisation.php.

    {
        $container['http.request_factory'] = function ($c) {
            return new \ILIAS\HTTP\Request\RequestFactoryImpl();
        };

        $container['http.response_factory'] = function ($c) {
            return new \ILIAS\HTTP\Response\ResponseFactoryImpl();
        };

        $container['http.cookie_jar_factory'] = function ($c) {
            return new \ILIAS\HTTP\Cookies\CookieJarFactoryImpl();
        };

        $container['http.response_sender_strategy'] = function ($c) {
            return new \ILIAS\HTTP\Response\Sender\DefaultResponseSenderStrategy();
        };

        $container['http'] = function ($c) {
            return new \ILIAS\DI\HTTPServices(
                $c['http.response_sender_strategy'],
                $c['http.cookie_jar_factory'],
                $c['http.request_factory'],
                $c['http.response_factory']
            );
        };
    }

initILIAS()

static ilInitialisation::initILIAS ( )

static

ilias initialisation

Definition at line 949 of file class.ilInitialisation.php.

References $GLOBALS, $tpl, ilLoggerFactory\getInstance(), ilUtil\getStyleSheetLocation(), ilContext\hasHTML(), ilContext\hasUser(), ilContext\initClient(), ilECSTaskScheduler\start(), and ilContext\supportsPersistentSessions().

Referenced by ilSoapFunctions\__call(), ilSoapAdministration\getClientInfoXML(), ilSoapAdministration\getInstallationInfoXML(), ilNusoapUserAdministrationAdapter\handleSoapPlugins(), ilCalendarRemoteAccessHandler\initIlias(), and ilWebAccessChecker\initILIAS().

    {
        if (self::$already_initialized) {
            // workaround for bug #17990
            // big mess. we prevent double initialisations with ILIAS 5.1, which is good, but...
            // the style service uses $_GET["ref_id"] to determine
            // the context styles. $_GET["ref_id"] is "corrected" by the "goto" procedure and which calls
            // initILIAS again.
            // we need a mechanism that detemines our repository context and stores that in an information object
            // usable by the style component afterwars. This needs new concepts and a refactoring.
            if (ilContext::initClient()) {
                global $tpl;
                if (is_object($tpl)) {
                    // load style sheet depending on user's settings
                    $location_stylesheet = ilUtil::getStyleSheetLocation();
                    $tpl->setVariable("LOCATION_STYLESHEET", $location_stylesheet);
                }
            }

            return;
        }

        $GLOBALS["DIC"] = new \ILIAS\DI\Container();
        $GLOBALS["DIC"]["ilLoggerFactory"] = function ($c) {
            return ilLoggerFactory::getInstance();
        };

        self::$already_initialized = true;

        self::initCore();
        self::initHTTPServices($GLOBALS["DIC"]);
        if (ilContext::initClient()) {
            self::initClient();
            self::initFileUploadService($GLOBALS["DIC"]);
            self::initSession();
            
            if (ilContext::hasUser()) {
                self::initUser();
                
                if (ilContext::supportsPersistentSessions()) {
                    self::resumeUserSession();
                }
            }

            // init after Auth otherwise breaks CAS
            self::includePhp5Compliance();
            
            // language may depend on user setting
            self::initLanguage(true);
            $GLOBALS['DIC']['tree']->initLangCode();

            self::initInjector($GLOBALS['DIC']);
            self::initBackgroundTasks($GLOBALS['DIC']);

            if (ilContext::hasHTML()) {
                include_once('./Services/WebServices/ECS/classes/class.ilECSTaskScheduler.php');
                ilECSTaskScheduler::start();
                
                self::initHTML();
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initIliasIniFile()

static ilInitialisation::initIliasIniFile ( )

staticprotected

This method provides a global instance of class ilIniFile for the ilias.ini.php file in variable $ilIliasIniFile.

It initializes a lot of constants accordingly to the settings in the ilias.ini.php file.

Definition at line 110 of file class.ilInitialisation.php.

References $DIC, $ilIliasIniFile, $tz, and ilTimeZone\initDefaultTimeZone().

    {
        require_once("./Services/Init/classes/class.ilIniFile.php");
        $ilIliasIniFile = new ilIniFile("./ilias.ini.php");
        $ilIliasIniFile->read();
        self::initGlobal('ilIliasIniFile', $ilIliasIniFile);

        // initialize constants
        define("ILIAS_DATA_DIR", $ilIliasIniFile->readVariable("clients", "datadir"));
        define("ILIAS_WEB_DIR", $ilIliasIniFile->readVariable("clients", "path"));
        define("ILIAS_ABSOLUTE_PATH", $ilIliasIniFile->readVariable('server', 'absolute_path'));

        // logging
        define("ILIAS_LOG_DIR", $ilIliasIniFile->readVariable("log", "path"));
        define("ILIAS_LOG_FILE", $ilIliasIniFile->readVariable("log", "file"));
        define("ILIAS_LOG_ENABLED", $ilIliasIniFile->readVariable("log", "enabled"));
        define("ILIAS_LOG_LEVEL", $ilIliasIniFile->readVariable("log", "level"));
        define("SLOW_REQUEST_TIME", $ilIliasIniFile->readVariable("log", "slow_request_time"));

        // read path + command for third party tools from ilias.ini
        define("PATH_TO_CONVERT", $ilIliasIniFile->readVariable("tools", "convert"));
        define("PATH_TO_FFMPEG", $ilIliasIniFile->readVariable("tools", "ffmpeg"));
        define("PATH_TO_ZIP", $ilIliasIniFile->readVariable("tools", "zip"));
        define("PATH_TO_MKISOFS", $ilIliasIniFile->readVariable("tools", "mkisofs"));
        define("PATH_TO_UNZIP", $ilIliasIniFile->readVariable("tools", "unzip"));
        define("PATH_TO_GHOSTSCRIPT", $ilIliasIniFile->readVariable("tools", "ghostscript"));
        define("PATH_TO_JAVA", $ilIliasIniFile->readVariable("tools", "java"));
        define("URL_TO_LATEX", $ilIliasIniFile->readVariable("tools", "latex"));
        define("PATH_TO_FOP", $ilIliasIniFile->readVariable("tools", "fop"));
        define("PATH_TO_LESSC", $ilIliasIniFile->readVariable("tools", "lessc"));
        define("PATH_TO_PHANTOMJS", $ilIliasIniFile->readVariable("tools", "phantomjs"));

        // read virus scanner settings
        switch ($ilIliasIniFile->readVariable("tools", "vscantype")) {
            case "sophos":
                define("IL_VIRUS_SCANNER", "Sophos");
                define("IL_VIRUS_SCAN_COMMAND", $ilIliasIniFile->readVariable("tools", "scancommand"));
                define("IL_VIRUS_CLEAN_COMMAND", $ilIliasIniFile->readVariable("tools", "cleancommand"));
                break;

            case "antivir":
                define("IL_VIRUS_SCANNER", "AntiVir");
                define("IL_VIRUS_SCAN_COMMAND", $ilIliasIniFile->readVariable("tools", "scancommand"));
                define("IL_VIRUS_CLEAN_COMMAND", $ilIliasIniFile->readVariable("tools", "cleancommand"));
                break;

            case "clamav":
                define("IL_VIRUS_SCANNER", "ClamAV");
                define("IL_VIRUS_SCAN_COMMAND", $ilIliasIniFile->readVariable("tools", "scancommand"));
                define("IL_VIRUS_CLEAN_COMMAND", $ilIliasIniFile->readVariable("tools", "cleancommand"));
                break;

            default:
                define("IL_VIRUS_SCANNER", "None");
                break;
        }
        
        include_once './Services/Calendar/classes/class.ilTimeZone.php';
        $tz = ilTimeZone::initDefaultTimeZone($ilIliasIniFile);
        define("IL_TIMEZONE", $tz);
    }

Here is the call graph for this function:

initInjector()

static ilInitialisation::initInjector ( \ILIAS\DI\Container  $c )

staticprivate

Definition at line 1774 of file class.ilInitialisation.php.

    {
        $c["di.dependency_map"] = function ($c) {
            return new \ILIAS\BackgroundTasks\Dependencies\DependencyMap\BaseDependencyMap();
        };

        $c["di.injector"] = function ($c) {
            return new \ILIAS\BackgroundTasks\Dependencies\Injector($c, $c["di.dependency_map"]);
        };
    }

initLocale()

static ilInitialisation::initLocale ( )

staticprotected

Init Locale.

Definition at line 701 of file class.ilInitialisation.php.

References $GLOBALS, $ilSetting, $l, and array.

    {
        global $ilSetting;
        
        if (trim($ilSetting->get("locale") != "")) {
            $larr = explode(",", trim($ilSetting->get("locale")));
            $ls = array();
            $first = $larr[0];
            foreach ($larr as $l) {
                if (trim($l) != "") {
                    $ls[] = $l;
                }
            }
            if (count($ls) > 0) {
                setlocale(LC_ALL, $ls);
                            
                // #15347 - making sure that floats are not changed
                setlocale(LC_NUMERIC, "C");
                
                if (class_exists("Collator")) {
                    $GLOBALS["ilCollator"] = new Collator($first);
                    $GLOBALS["DIC"]["ilCollator"] = function ($c) {
                        return $GLOBALS["ilCollator"];
                    };
                }
            }
        }
    }

initLog()

static ilInitialisation::initLog ( )

staticprotected

Init log instance.

Definition at line 873 of file class.ilInitialisation.php.

References $log, and ilLoggerFactory\getRootLogger().

    {
        include_once './Services/Logging/classes/public/class.ilLoggerFactory.php';
        $log = ilLoggerFactory::getRootLogger();
        
        self::initGlobal("ilLog", $log);
        // deprecated
        self::initGlobal("log", $log);
    }

Here is the call graph for this function:

initMail()

static ilInitialisation::initMail ( \ILIAS\DI\Container  $c )

staticprotected

Parameters

\ILIAS\DI\Container

$c

Definition at line 583 of file class.ilInitialisation.php.

    {
        $c["mail.mime.transport.factory"] = function ($c) {
            require_once 'Services/Mail/classes/Mime/Transport/class.ilMailMimeTransportFactory.php';
            return new ilMailMimeTransportFactory($c["ilSetting"]);
        };
        $c["mail.mime.sender.factory"] = function ($c) {
            require_once 'Services/Mail/classes/Mime/Sender/class.ilMailMimeSenderFactory.php';
            return new ilMailMimeSenderFactory($c["ilSetting"]);
        };
    }

initSession()

static ilInitialisation::initSession ( )

staticprotected

Init auth session.

Definition at line 1015 of file class.ilInitialisation.php.

References $GLOBALS, and ilAuthSession\getInstance().

    {
        $GLOBALS["DIC"]["ilAuthSession"] = function ($c) {
            $auth_session = ilAuthSession::getInstance(
                $c['ilLoggerFactory']->getLogger('auth')
            );
            $auth_session->init();
            return $auth_session;
        };
    }

Here is the call graph for this function:

initSettings()

static ilInitialisation::initSettings ( )

staticprotected

initialise $ilSettings object and define constants

Used in Soap

Definition at line 611 of file class.ilInitialisation.php.

References $ilSetting, and ilContext\usesHTTP().

    {
        global $ilSetting;

        self::initGlobal(
            "ilSetting",
            "ilSetting",
            "Services/Administration/classes/class.ilSetting.php"
        );
                
        // check correct setup
        if (!$ilSetting->get("setup_ok")) {
            self::abortAndDie("Setup is not completed. Please run setup routine again.");
        }

        // set anonymous user & role id and system role id
        define("ANONYMOUS_USER_ID", $ilSetting->get("anonymous_user_id"));
        define("ANONYMOUS_ROLE_ID", $ilSetting->get("anonymous_role_id"));
        define("SYSTEM_USER_ID", $ilSetting->get("system_user_id"));
        define("SYSTEM_ROLE_ID", $ilSetting->get("system_role_id"));
        define("USER_FOLDER_ID", 7);

        // recovery folder
        define("RECOVERY_FOLDER_ID", $ilSetting->get("recovery_folder_id"));

        // installation id
        define("IL_INST_ID", $ilSetting->get("inst_id", 0));

        // define default suffix replacements
        define("SUFFIX_REPL_DEFAULT", "php,php3,php4,inc,lang,phtml,htaccess");
        define("SUFFIX_REPL_ADDITIONAL", $ilSetting->get("suffix_repl_additional"));

        if (ilContext::usesHTTP()) {
            self::buildHTTPPath();
        }
    }

Here is the call graph for this function:

initStyle()

static ilInitialisation::initStyle ( )

staticprotected

provide $styleDefinition object

Definition at line 651 of file class.ilInitialisation.php.

References $GLOBALS, $ilUser, array, ilLoggerFactory\getInstance(), ilPluginAdmin\getPluginObject(), and IL_COMP_SERVICE.

    {
        global $styleDefinition, $ilPluginAdmin;

        // load style definitions
        self::initGlobal(
            "styleDefinition",
            "ilStyleDefinition",
            "./Services/Style/System/classes/class.ilStyleDefinition.php"
        );

        // add user interface hook for style initialisation
        $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_SERVICE, "UIComponent", "uihk");
        foreach ($pl_names as $pl) {
            $ui_plugin = ilPluginAdmin::getPluginObject(IL_COMP_SERVICE, "UIComponent", "uihk", $pl);
            $gui_class = $ui_plugin->getUIClassInstance();
            $gui_class->modifyGUI("Services/Init", "init_style", array("styleDefinition" => $styleDefinition));
        }
    }

Here is the call graph for this function:

initUIFramework()

static ilInitialisation::initUIFramework ( \ILIAS\DI\Container  $c )

staticprotected

init the ILIAS UI framework.

Definition at line 1351 of file class.ilInitialisation.php.

    {
        $c["ui.factory"] = function ($c) {
            return new ILIAS\UI\Implementation\Factory();
        };
        $c["ui.renderer"] = function ($c) {
            return new ILIAS\UI\Implementation\DefaultRenderer(
                $c["ui.component_renderer_loader"]
            );
        };
        $c["ui.component_renderer_loader"] = function ($c) {
            return new ILIAS\UI\Implementation\Render\LoaderCachingWrapper(
                new ILIAS\UI\Implementation\Render\LoaderResourceRegistryWrapper(
                $c["ui.resource_registry"],
                new ILIAS\UI\Implementation\Render\FSLoader(
                        new ILIAS\UI\Implementation\Render\DefaultRendererFactory(
                        $c["ui.factory"],
                        $c["ui.template_factory"],
                        $c["lng"],
                        $c["ui.javascript_binding"]
                    )
                    )
            )
            );
        };
        $c["ui.template_factory"] = function ($c) {
            return new ILIAS\UI\Implementation\Render\ilTemplateWrapperFactory(
                $c["tpl"]
            );
        };
        $c["ui.resource_registry"] = function ($c) {
            return new ILIAS\UI\Implementation\Render\ilResourceRegistry($c["tpl"]);
        };
        $c["ui.javascript_binding"] = function ($c) {
            return new ILIAS\UI\Implementation\Render\ilJavaScriptBinding($c["tpl"]);
        };
    }

initUser()

static ilInitialisation::initUser ( )

staticprotected

Init user / authentification (level 2)

Definition at line 1188 of file class.ilInitialisation.php.

References $ilUser.

    {
        global $ilias, $ilUser;
        
        // $ilUser
        self::initGlobal(
            "ilUser",
            "ilObjUser",
            "./Services/User/classes/class.ilObjUser.php"
        );
        $ilias->account = $ilUser;
                
        self::initAccessHandling();
    }

recursivelyRemoveUnsafeCharacters()

static ilInitialisation::recursivelyRemoveUnsafeCharacters (   $var )

staticprotected

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

References array.

    {
        if (is_array($var)) {
            $mod = [];
            foreach ($var as $k => $v) {
                $k = self::recursivelyRemoveUnsafeCharacters($k);
                $mod[$k] = self::recursivelyRemoveUnsafeCharacters($v);
            }
            return $mod;
        }
        return strip_tags(
            str_replace(
                array("\x00", "\n", "\r", "\\", "'", '"', "\x1a"),
                "",
                $var
            )
        );
    }

redirect()

static ilInitialisation::redirect (   $a_target,   $a_message_id = '', array  $a_message_static = null  )

staticprotected

Redirects to target url if context supports it.

Parameters

string	$a_target
string	$a_message_id
array	$a_message_details

Definition at line 1668 of file class.ilInitialisation.php.

References $_GET, $ilUser, $message, array, defined, ilLoggerFactory\getLogger(), ilUserUtil\getStartingPointAsUrl(), goToPublicSection(), ilContext\hasHTML(), ilUtil\redirect(), ilContext\supportsRedirects(), and ilContext\usesHTTP().

    {
        // #12739
        if (defined("ILIAS_HTTP_PATH") &&
            !stristr($a_target, ILIAS_HTTP_PATH)) {
            $a_target = ILIAS_HTTP_PATH . "/" . $a_target;
        }
        
        if (ilContext::supportsRedirects()) {
            ilUtil::redirect($a_target);
        } else {
            $message = self::translateMessage($a_message_id, $a_message_static);
            
            // user-directed linked message
            if (ilContext::usesHTTP() && ilContext::hasHTML()) {
                $link = self::translateMessage(
                    "init_error_redirect_click",
                    array("en" => 'Please click to continue.',
                        "de" => 'Bitte klicken um fortzufahren.')
                );
                $mess = $message .
                    '<br /><a href="' . $a_target . '">' . $link . '</a>';
            }
            // plain text
            else {
                // not much we can do here
                $mess = $message;
                
                if (!trim($mess)) {
                    $mess = self::translateMessage(
                        "init_error_redirect_info",
                        array("en" => 'Redirect not supported by context.',
                            "de" => 'Weiterleitungen werden durch Kontext nicht unterstützt.')
                    ) .
                    ' (' . $a_target . ')';
                }
            }
                                    
            self::abortAndDie($mess);
        }
    }

Here is the call graph for this function:

reinitILIAS()

static ilInitialisation::reinitILIAS ( )

static

Definition at line 940 of file class.ilInitialisation.php.

Referenced by ilWebAccessChecker\addAppliedCheckingMethod(), and ilSoapAdministration\initIlias().

    {
        self::$already_initialized = false;
        self::initILIAS();
    }

Here is the caller graph for this function:

removeUnsafeCharacters()

static ilInitialisation::removeUnsafeCharacters ( )

staticprotected

Remove unsafe characters from GET.

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

References $_GET.

    {
        // Remove unsafe characters from GET parameters.
        // We do not need this characters in any case, so it is
        // feasible to filter them everytime. POST parameters
        // need attention through ilUtil::stripSlashes() and similar functions)
        $_GET = self::recursivelyRemoveUnsafeCharacters($_GET);
    }

requireCommonIncludes()

static ilInitialisation::requireCommonIncludes ( )

staticprotected

get common include code files

Definition at line 72 of file class.ilInitialisation.php.

References ilContext\usesTemplate().

    {
        // ilTemplate
        if (ilContext::usesTemplate()) {
            require_once "./Services/UICore/classes/class.ilTemplate.php";
        }
                
        // really always required?
        require_once "./Services/Utilities/classes/class.ilUtil.php";
        require_once "./Services/Calendar/classes/class.ilDatePresentation.php";
        require_once "include/inc.ilias_version.php";
        
        include_once './Services/Authentication/classes/class.ilAuthUtils.php';
        
        self::initGlobal("ilBench", "ilBenchmark", "./Services/Utilities/classes/class.ilBenchmark.php");
    }

Here is the call graph for this function:

resumeUserSession()

static ilInitialisation::resumeUserSession ( )

static

Resume an existing user session.

Definition at line 1206 of file class.ilInitialisation.php.

References $_SERVER, $GLOBALS, ilLoggerFactory\getLogger(), ilAuthUtils\handleForcedAuthentication(), and ilAuthUtils\isAuthenticationForced().

    {
        include_once './Services/Authentication/classes/class.ilAuthUtils.php';
        if (ilAuthUtils::isAuthenticationForced()) {
            ilAuthUtils::handleForcedAuthentication();
        }
        
        if (
            !$GLOBALS['DIC']['ilAuthSession']->isAuthenticated() or
            $GLOBALS['DIC']['ilAuthSession']->isExpired()
        ) {
            ilLoggerFactory::getLogger('init')->debug('Current session is invalid: ' . $GLOBALS['DIC']['ilAuthSession']->getId());
            $current_script = substr(strrchr($_SERVER["PHP_SELF"], "/"), 1);
            if (self::blockedAuthentication($current_script)) {
                ilLoggerFactory::getLogger('init')->debug('Authentication is started in current script.');
                // nothing todo: authentication is done in current script
                return;
            }
            return self::handleAuthenticationFail();
        }
        // valid session
        return self::initUserAccount();
    }

Here is the call graph for this function:

setCookieConstants()

static ilInitialisation::setCookieConstants ( )

staticprotected

Definition at line 526 of file class.ilInitialisation.php.

References $_SERVER, $cookie_path, $GLOBALS, ilAuthFactory\CONTEXT_HTTP, and ilAuthFactory\getContext().

    {
        include_once 'Services/Authentication/classes/class.ilAuthFactory.php';
        if (ilAuthFactory::getContext() == ilAuthFactory::CONTEXT_HTTP) {
            $cookie_path = '/';
        } elseif ($GLOBALS['COOKIE_PATH']) {
            // use a predefined cookie path from WebAccessChecker
            $cookie_path = $GLOBALS['COOKIE_PATH'];
        } else {
            $cookie_path = dirname($_SERVER['PHP_SELF']);
        }

        /* if ilias is called directly within the docroot $cookie_path
        is set to '/' expecting on servers running under windows..
        here it is set to '\'.
        in both cases a further '/' won't be appended due to the following regex
        */
        $cookie_path .= (!preg_match("/[\/|\\\\]$/", $cookie_path)) ? "/" : "";

        if ($cookie_path == "\\") {
            $cookie_path = '/';
        }

        define('IL_COOKIE_HTTPONLY', true); // Default Value
        define('IL_COOKIE_EXPIRE', 0);
        define('IL_COOKIE_PATH', $cookie_path);
        define('IL_COOKIE_DOMAIN', '');
    }

Here is the call graph for this function:

setSessionCookieParams()

static ilInitialisation::setSessionCookieParams ( )

staticprotected

set session cookie params

Definition at line 558 of file class.ilInitialisation.php.

References $ilSetting, defined, ilHTTPS\getInstance(), and IL_COOKIE_PATH.

    {
        global $ilSetting;

        if (!defined('IL_COOKIE_SECURE')) {
            // If this code is executed, we can assume that \ilHTTPS::enableSecureCookies was NOT called before
            // \ilHTTPS::enableSecureCookies already executes session_set_cookie_params()

            include_once './Services/Http/classes/class.ilHTTPS.php';
            $cookie_secure = !$ilSetting->get('https', 0) && ilHTTPS::getInstance()->isDetected();
            define('IL_COOKIE_SECURE', $cookie_secure); // Default Value

            session_set_cookie_params(
                IL_COOKIE_EXPIRE,
                IL_COOKIE_PATH,
                IL_COOKIE_DOMAIN,
                IL_COOKIE_SECURE,
                IL_COOKIE_HTTPONLY
            );
        }
    }

Here is the call graph for this function:

setSessionHandler()

static ilInitialisation::setSessionHandler ( )

static

set session handler to db

Used in Soap/CAS

Definition at line 502 of file class.ilInitialisation.php.

References ilSession\_exists(), and defined.

    {
        if (ini_get('session.save_handler') != 'user' && version_compare(PHP_VERSION, '7.2.0', '<')) {
            ini_set("session.save_handler", "user");
        }

        require_once "Services/Authentication/classes/class.ilSessionDBHandler.php";
        $db_session_handler = new ilSessionDBHandler();
        if (!$db_session_handler->setSaveHandler()) {
            self::abortAndDie("Please turn off Safe mode OR set session.save_handler to \"user\" in your php.ini");
        }
                        
        // Do not accept external session ids
        if (!ilSession::_exists(session_id()) && !defined('IL_PHPUNIT_TEST')) {
            // php7-todo, correct-with-php5-removal : alex, 1.3.2016: added if, please check
            if (function_exists("session_status") && session_status() == PHP_SESSION_ACTIVE) {
                session_regenerate_id();
            }
        }
    }

Here is the call graph for this function:

showingLoginForm()

static ilInitialisation::showingLoginForm (   $a_current_script )

staticprotected

Is current view the login form?

Returns

boolean

Definition at line 1601 of file class.ilInitialisation.php.

    {
        if ($a_current_script == "login.php") {
            return true;
        }
        
        if ($_REQUEST["baseClass"] == "ilStartUpGUI" &&
            self::getCurrentCmd() == "showLoginPage") {
            return true;
        }
        
        return false;
    }

translateMessage()

static ilInitialisation::translateMessage (   $a_message_id, array  $a_message_static = null  )

staticprotected

Translate message if possible.

Parameters

string	$a_message_id
array	$a_message_static

Returns

string

Definition at line 1622 of file class.ilInitialisation.php.

References $ilDB, $ilSetting, $ilUser, $lang, $lng, $message, and string.

    {
        global $ilDB, $lng, $ilSetting, $ilClientIniFile, $ilUser;
            
        // current language
        if (!$lng) {
            $lang = "en";
            if ($ilUser) {
                $lang = $ilUser->getLanguage();
            } elseif ($_REQUEST["lang"]) {
                $lang = (string) $_REQUEST["lang"];
            } elseif ($ilSetting) {
                $lang = $ilSetting->get("language");
            } elseif ($ilClientIniFile) {
                $lang = $ilClientIniFile->readVariable("language", "default");
            }
        } else {
            $lang = $lng->getLangKey();
        }

        $message = "";
        if ($ilDB && $a_message_id) {
            if (!$lng) {
                require_once "./Services/Language/classes/class.ilLanguage.php";
                $lng = new ilLanguage($lang);
            }
                    
            $lng->loadLanguageModule("init");
            $message = $lng->txt($a_message_id);
        } elseif (is_array($a_message_static)) {
            if (!isset($a_message_static[$lang])) {
                $lang = "en";
            }
            $message = $a_message_static[$lang];
        }
    
        return utf8_decode($message);
    }

Field Documentation

$already_initialized

ilInitialisation::$already_initialized

staticprotected

Definition at line 937 of file class.ilInitialisation.php.

---

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

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