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:

Public Member Functions
	removeUnsafeCharacters ()
	Remove unsafe characters from GET. More...

	requireCommonIncludes ()
	get common include code files More...

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

	determineClient ()
	This method determines the current client and sets the constant CLIENT_ID. More...

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

	initDatabase ()
	initialise database object $ilDB More...

	initEventHandling ()
	initialise event handler ilAppEventHandler More...

	initILIAS ($context="web")
	ilias initialisation More...

	initLog ()

	persistCMIData ()

Static Public Member Functions
static	setSessionHandler ()
	set session handler to db More...

static	goToPublicSection ($a_auth_stat="")
	go to public section More...

static	reinitILIAS ()

static	initILIAS ()
	ilias initialisation More...

static	handleErrorReporting ()
	Set error reporting level. 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	setCookieParams ()
	set session cookie params for path, domain, etc. More...

static	initSettings ()
	initialise $ilSettings object and define constants More...

static	initStyle ()
	provide $styleDefinition object More...

static	initLocale ()
	Init Locale. More...

static	goToLogin ($a_auth_stat="")
	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	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	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, $a_message_static)
	Redirects to target url if context supports it. More...

Static Protected Attributes
static	$already_initialized

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$

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; Uwe Kohnle kohnl.nosp@m.e@in.nosp@m.terne.nosp@m.tleh.nosp@m.rer-g.nosp@m.mbh..nosp@m.de

Version

Id: class.ilInitialisation.php 26932 2010-12-09 16:26:46Z mjansen

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

Member Function Documentation

◆ abortAndDie()

static ilInitialisation::abortAndDie ( $a_message )

staticprotected

Exit.

Parameters

string $a_message

Definition at line 820 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 1131 of file class.ilInitialisation.php.

References $_GET, $_SERVER, $ilCtrl, $ilErr, $ilSetting, $ilUser, $tpl, ilSession\_destroy(), AUTH_EXPIRED, AUTH_IDLED, ilContext\CONTEXT_SOAP, ilContext\CONTEXT_WAC, ilContext\doAuthentication(), ilLoggerFactory\getLogger(), ilUtil\getStyleSheetLocation(), ilContext\getType(), ilContext\hasUser(), ilSession\SESSION_CLOSE_LOGIN, and ilSession\set().

         {
                 global $ilAuth, $ilias, $ilErr;
                 
                 $current_script = substr(strrchr($_SERVER["PHP_SELF"], "/"), 1);                
                 
                 if(self::blockedAuthentication($current_script))
                 {
                         return;
                 }
                 
                 if(self::showingLoginForm($current_script))
                 {
                         // login form is shown or user tries to authenticate => destroy old user session
                         $ilAuth->logout();
                         ilSession::_destroy(session_id(), ilSession::SESSION_CLOSE_LOGIN);
                         ilSession::set('AccountId', null);
                         
                         ilLoggerFactory::getLogger('auth')->debug('Logout called for old session on login request');
                 }
                 
                 
                                                 
                 $oldSid = session_id();         
                 
                 $ilAuth->start();
                 $ilias->setAuthError($ilErr->getLastError());
                                 
                 if(IS_PAYMENT_ENABLED)
                 {
                         // cart is "attached" to session, has to be updated
                         $newSid = session_id();
                         if($oldSid != $newSid)
                         {
                                 include_once './Services/Payment/classes/class.ilPaymentShoppingCart.php';
                                 ilPaymentShoppingCart::_migrateShoppingCart($oldSid, $newSid);
                         }
                 }                                       
 
                 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 != "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 1352 of file class.ilInitialisation.php.

References $_GET, $_REQUEST, and $cmd.

         {
                 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") 
                 {
                         return true;
                 }
                 
                 if($_REQUEST["baseClass"] == "ilStartUpGUI")
                 {
                         $cmd_class = $_REQUEST["cmdClass"];
                         
                         if($cmd_class == "ilaccountregistrationgui" ||
                                 $cmd_class == "ilpasswordassistancegui")
                         {
                                 return true;
                         }
                         
                         $cmd = self::getCurrentCmd();
                         if($cmd == "showTermsOfService" || $cmd == "showClientList" || 
                                 $cmd == 'showAccountMigration' || $cmd == 'migrateAccount' ||
                                 $cmd == 'processCode')
                         {
                                 return true;
                         }
                 }
                 
                 // #12884
                 if(($a_current_script == "goto.php" && $_GET["target"] == "impr_0") ||
                         $_GET["baseClass"] == "ilImprintGUI")
                 {
                         return true;
                 }
                 
                 return false;
         }

◆ buildHTTPPath()

static ilInitialisation::buildHTTPPath ( )

staticprotected

builds http path

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

References $_SERVER, $dirs, $https, $path, 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);
                         }
                 }
                 
                 return define('ILIAS_HTTP_PATH',ilUtil::removeTrailingPathSeparators($protocol.$host.$uri));
         }

Here is the call graph for this function:

◆ determineClient() [1/2]

ilInitialisation::determineClient ( )

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

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

References $_GET, and $ilIliasIniFile.

         {
                 global $ilIliasIniFile;
 
                 // check whether ini file object exists
                 if (!is_object($ilIliasIniFile))
                 {
                         die ("Fatal Error: ilInitialisation::determineClient called without initialisation of ILIAS ini file object.");
                 }
                 if ($_GET["client_id"] != "") define ("CLIENT_ID", $_GET["client_id"]);
                 else define ("CLIENT_ID", $ilIliasIniFile->readVariable("clients","default"));
         }

◆ determineClient() [2/2]

static ilInitialisation::determineClient ( )

staticprotected

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

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

References $_COOKIE, $_GET, $client_id, $ilIliasIniFile, ilUtil\setCookie(), and ilUtil\stripSlashes().

Referenced by initILIAS().

         {
                 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.");
                 }
                                 
                 // set to default client if empty
                 if ($_GET["client_id"] != "")
                 {
                         $_GET["client_id"] = ilUtil::stripSlashes($_GET["client_id"]);
                         if (!defined("IL_PHPUNIT_TEST"))
                         {
                                 ilUtil::setCookie("ilClientId", $_GET["client_id"]);
                         }
                 }
                 else if (!$_COOKIE["ilClientId"])
                 {
                         // to do: ilias ini raus nehmen
                         $client_id = $ilIliasIniFile->readVariable("clients","default");
                         ilUtil::setCookie("ilClientId", $client_id);
                 }
                 if (!defined("IL_PHPUNIT_TEST"))
                 {
                         define ("CLIENT_ID", $_COOKIE["ilClientId"]);
                 }
                 else
                 {
                         define ("CLIENT_ID", $_GET["client_id"]);
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentCmd()

static ilInitialisation::getCurrentCmd ( )

staticprotected

Extract current cmd from request.

Returns: string

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

References $_REQUEST, and $cmd.

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

◆ goToLogin()

static ilInitialisation::goToLogin ( $a_auth_stat = "" )

staticprotected

go to login

Parameters

int $a_auth_stat

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

References $_COOKIE, $_GET, AUTH_EXPIRED, AUTH_IDLED, ilSession\SESSION_CLOSE_EXPIRE, ilSession\SESSION_CLOSE_LOGIN, and ilSession\setClosingContext().

         {               
                 global $ilAuth;
                 
                 // close current session
                 if($a_auth_stat == AUTH_EXPIRED ||
                         $a_auth_stat == AUTH_IDLED)
                 {
                         ilSession::setClosingContext(ilSession::SESSION_CLOSE_EXPIRE);
                 }
                 else
                 {
                         ilSession::setClosingContext(ilSession::SESSION_CLOSE_LOGIN);
                 }
                 $ilAuth->logout();
                 session_unset();
                 session_destroy();
 
                 $add = "";
                 if ($_GET["soap_pw"] != "")
                 {
                         $add = "&soap_pw=".$_GET["soap_pw"]."&ext_uid=".$_GET["ext_uid"];
                 }
 
                 $script = "login.php?target=".$_GET["target"]."&client_id=".$_COOKIE["ilClientId"].
                         "&auth_stat=".$a_auth_stat.$add;
                                         
                 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 ( $a_auth_stat = "" )

static

go to public section

Parameters

int $a_auth_stat

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

References $_GET, $_POST, $_SERVER, ilAuthUtils\_initAuth(), AUTH_EXPIRED, AUTH_IDLED, ilSession\SESSION_CLOSE_EXPIRE, ilSession\SESSION_CLOSE_PUBLIC, and ilSession\setClosingContext().

Referenced by ilStartUpGUI\processIndexPHP().

         {
                 global $ilAuth;
                                 
                 if (ANONYMOUS_USER_ID == "")
                 {
                         self::abortAndDie("Public Section enabled, but no Anonymous user found.");
                 }
 
                 // logout and end previous session
                 if($a_auth_stat == AUTH_EXPIRED ||
                         $a_auth_stat == AUTH_IDLED)
                 {
                         ilSession::setClosingContext(ilSession::SESSION_CLOSE_EXPIRE);
                 }
                 else
                 {
                         ilSession::setClosingContext(ilSession::SESSION_CLOSE_PUBLIC);
                 }
                 $ilAuth->logout();
                 session_unset();
                 session_destroy();
                 
                 // new session and login as anonymous
                 self::setSessionHandler();
                 session_start();
                 $_POST["username"] = "anonymous";
                 $_POST["password"] = "anonymous";
                 ilAuthUtils::_initAuth();
                 
                 // authenticate (anonymous)
                 $oldSid = session_id();         
                 $ilAuth->start();               
                 if (IS_PAYMENT_ENABLED)
                 {
                         $newSid = session_id();
                         if($oldSid != $newSid)
                         {
                                 include_once './Services/Payment/classes/class.ilPaymentShoppingCart.php';
                                 ilPaymentShoppingCart::_migrateShoppingCart($oldSid, $newSid);
                         }
                 }
                 
                 if (!$ilAuth->getAuth())
                 {
                         self::abortAndDie("ANONYMOUS user with the object_id ".ANONYMOUS_USER_ID." not found!");
                 }
                 
                 self::initUserAccount();
                 
                 $mess_id = "init_error_authentication_fail";
                 $mess = array("en" => "Authentication failed.",
                         "de" => "Authentifizierung fehlgeschlagen.");
                 
                 // if target given, try to go there
                 if ($_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"], $mess_id, $mess);                    
                 }
                 
                 // 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"], $mess_id, $mess);
         }

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 832 of file class.ilInitialisation.php.

         {
                 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 925 of file class.ilInitialisation.php.

Referenced by ilWebAccessCheckerDelivery\handleRequest().

         {               
                 // remove notices from error reporting
                 if (version_compare(PHP_VERSION, '5.4.0', '>='))
                 {
                         // Prior to PHP 5.4.0 E_ALL does not include E_STRICT.
                         // With PHP 5.4.0 and above E_ALL >DOES< include E_STRICT.
                         
                         error_reporting(((ini_get("error_reporting") & ~E_NOTICE) & ~E_DEPRECATED) & ~E_STRICT);
                 }
                 else
                 {
                         error_reporting((ini_get("error_reporting") & ~E_NOTICE) & ~E_DEPRECATED);
                 }
                 
                 // 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 375 of file class.ilInitialisation.php.

References 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 92 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 764 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", "ilAccessHandler", 
                          "./Services/AccessControl/classes/class.ilAccessHandler.php");
                 
                 require_once "./Services/AccessControl/classes/class.ilConditionHandler.php";
         }

Here is the call graph for this function:

◆ initClient()

static ilInitialisation::initClient ( )

staticprotected

Init client-based objects (level 1)

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

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

         {
                 global $https, $ilias; 
                 
                 self::determineClient();
 
                 self::initClientIniFile();
                                 
                 
                 // --- needs client ini         
                 
                 $ilias->client_id = CLIENT_ID;
                 
                 if (DEVMODE)
                 {
                         self::handleDevMode();
                 }                                               
         
 
                 self::handleMaintenanceMode();
 
                 self::initDatabase();
                 
                 // 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 (!is_object($GLOBALS["ilPluginAdmin"]))
                 {
                         self::initGlobal("ilPluginAdmin", "ilPluginAdmin",
                                 "./Services/Component/classes/class.ilPluginAdmin.php");
                 }
 
                 self::setSessionHandler();
 
                 self::initSettings();
                 
                 
                 // --- 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::setCookieParams();
         }

Here is the call graph for this function:

◆ initClientIniFile() [1/2]

ilInitialisation::initClientIniFile ( )

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 150 of file class.ilInitialisation.php.

References $GLOBALS, ILIAS_ABSOLUTE_PATH, and ILIAS_WEB_DIR.

         {
                 global $ilClientIniFile;
 
                 // check whether ILIAS_WEB_DIR is set.
                 if (ILIAS_WEB_DIR == "")
                 {
                         die ("Fatal Error: ilInitialisation::initClientIniFile called without ILIAS_WEB_DIR.");
                 }
 
                 // check whether CLIENT_ID is set.
                 if (CLIENT_ID == "")
                 {
                         die ("Fatal Error: ilInitialisation::initClientIniFile called without CLIENT_ID.");
                 }
 
                 $ini_file = "./".ILIAS_WEB_DIR."/".CLIENT_ID."/client.ini.php";
 
                 // get settings from ini file
                 require_once("./Services/Init/classes/class.ilIniFile.php");
                 $ilClientIniFile = new ilIniFile($ini_file);
                 $GLOBALS['ilClientIniFile'] =& $ilClientIniFile;
                 $ilClientIniFile->read();
 
                 // if no ini-file found switch to setup routine
                 if ($ilClientIniFile->ERROR != "")
                 {
                         throw new ilException('No Client INI File!! (ClientID "'.CLIENT_ID.'" / '.$ilClientIniFile->ERROR.')');
                         return false;
                 }
 
                 // set constants
                 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
 
                 define ("ROOT_FOLDER_ID",$ilClientIniFile->readVariable('system','ROOT_FOLDER_ID'));
 
                 $val = $ilClientIniFile->readVariable("db","type");
                 if ($val == "")
                 {
                         define ("IL_DB_TYPE", "mysql");
                 }
                 else
                 {
                         define ("IL_DB_TYPE", $val);
                 }
                 return true;
         }

◆ initClientIniFile() [2/2]

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 281 of file class.ilInitialisation.php.

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

Referenced by initILIAS().

         {
                 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
                 require_once("./Services/Init/classes/class.ilIniFile.php");
                 $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");
                 $log_error_trace = $ilClientIniFile->readVariable('system', 'LOG_ERROR_TRACE');
                 define ("LOG_ERROR_TRACE", $log_error_trace ? $log_error_trace : false);
                 
                 // 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);
                 }
 
                 require_once('./Services/GlobalCache/classes/Settings/class.ilGlobalCacheSettings.php');
                 $ilGlobalCacheSettings = new ilGlobalCacheSettings();
                 $ilGlobalCacheSettings->readFromIniFile($ilClientIniFile);
                 ilGlobalCache::setup($ilGlobalCacheSettings);
                 
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initCore()

static ilInitialisation::initCore ( )

staticprotected

Init core objects (level 0)

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

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

         {
                 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() [1/2]

ilInitialisation::initDatabase ( )

initialise database object $ilDB

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

References $GLOBALS, $ilDB, and ilDBWrapperFactory\getWrapper().

         {
                 global $ilDB, $ilClientIniFile;
 
                 // 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();
                 $GLOBALS['ilDB'] = $ilDB;
                 
         }

Here is the call graph for this function:

◆ initDatabase() [2/2]

static ilInitialisation::initDatabase ( )

staticprotected

initialise database object $ilDB

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

References $ilDB, and ilDBWrapperFactory\getWrapper().

Referenced by initILIAS().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initEventHandling()

ilInitialisation::initEventHandling ( )

initialise event handler ilAppEventHandler

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

References $GLOBALS.

         {
                 global $ilAppEventHandler;
 
                 // build dsn of database connection and connect
                 require_once("./Services/EventHandling/classes/class.ilAppEventHandler.php");
                 $ilAppEventHandler = new ilAppEventHandler();
                 $GLOBALS['ilAppEventHandler'] =& $ilAppEventHandler;
         }

◆ 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 802 of file class.ilInitialisation.php.

References $GLOBALS.

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

◆ initILIAS() [1/2]

ilInitialisation::initILIAS ( $context = "web" )

ilias initialisation

Parameters

string $context this is used for circumvent redirects to the login page if called e.g. by soap

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

References $_GET, $GLOBALS, $https, $ilBench, $ilCtrl, $ilDB, $ilErr, $ilIliasIniFile, $ilLog, $ilSetting, $ilUser, $lng, determineClient(), initClientIniFile(), initDatabase(), initIliasIniFile(), initLog(), persistCMIData(), removeUnsafeCharacters(), requireCommonIncludes(), and ilSCORM2004StoreData\scormPlayerUnload().

         {
                 global $ilDB, $ilUser, $ilLog, $ilErr, $ilClientIniFile, $ilIliasIniFile,
                         $ilSetting, $ilias, $https, $ilObjDataCache,
                         $ilLog, $objDefinition, $lng, $ilCtrl, $ilBrowser, $ilHelp,
                         $ilTabs, $ilMainMenu, $rbacsystem, $ilNavigationHistory;
 
                 // remove unsafe characters
                 $this->removeUnsafeCharacters();
 
                 // error reporting
                 // remove notices from error reporting
                 if (version_compare(PHP_VERSION, '5.3.0', '>='))
                 {
                         error_reporting((ini_get("error_reporting") & ~E_NOTICE) & ~E_DEPRECATED);
                 }
                 else
                 {
                         error_reporting(ini_get('error_reporting') & ~E_NOTICE);
                 }
 
                 $ilUser = new ilObjUserMin();
                 $GLOBALS['ilUser'] =& $ilUser;
 
                 
                 // include common code files
                 $this->requireCommonIncludes();
                 global $ilBench;
                 // $ilIliasIniFile initialisation
                 $this->initIliasIniFile();
 
 
                 // CLIENT_ID determination
                 $this->determineClient();
 
                 // $ilAppEventHandler initialisation
                 //$this->initEventHandling();
 
 
                 // $ilClientIniFile initialisation
                 if (!$this->initClientIniFile())
                 {
                         die("no client");
                 }
 
                 // $ilDB initialisation
                 $this->initDatabase();
                 $this->initLog();
                 
                 // settings
                 $ilSetting = new ilSetting();
                 $GLOBALS['ilSetting'] = & $ilSetting;
 
                 // init tree
                 require_once "./Services/Tree/classes/class.ilTree.php";
                 $tree = new ilTree(ROOT_FOLDER_ID);
                 $GLOBALS['tree'] =& $tree;
 
                 
                 if ((string) $_GET['do'] == "unload") {
                         include_once './Modules/Scorm2004/classes/class.ilSCORM2004StoreData.php';
                         ilSCORM2004StoreData::scormPlayerUnload(null, (int)$_GET['package_id']);
                 }
                 else $this->persistCMIData();
         }

Here is the call graph for this function:

◆ initILIAS() [2/2]

static ilInitialisation::initILIAS ( )

static

ilias initialisation

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

References $tpl, ilContext\doAuthentication(), ilUtil\getStyleSheetLocation(), ilContext\hasHTML(), ilContext\hasUser(), ilContext\initClient(), and ilECSTaskScheduler\start().

Referenced by ilSoapAdministration\getClientInfoXML(), ilSoapAdministration\getInstallationInfoXML(), ilCalendarRemoteAccessHandler\initIlias(), ilWebAccessChecker\initILIAS(), and ilSoapAdministration\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;
                 }
 
                 self::$already_initialized = true;
 
                 global $tree;
                 
                 self::initCore();
                                 
                 if(ilContext::initClient())
                 {
                         self::initClient();
 
                         if (ilContext::hasUser())
                         {                                               
                                 self::initUser();
                                 
                                 if(ilContext::doAuthentication())
                                 {
                                         self::authenticate();
                                 }                               
                         }       
 
                         // init after Auth otherwise breaks CAS
                         self::includePhp5Compliance();
                         
                         // language may depend on user setting
                         self::initLanguage();
                         $tree->initLangCode();
 
                         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() [1/2]

ilInitialisation::initIliasIniFile ( )

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 88 of file class.ilInitialisation.php.

References $GLOBALS, $ilIliasIniFile, and $tz.

         {
                 global $ilIliasIniFile;
 
                 require_once("./Services/Init/classes/class.ilIniFile.php");
                 $ilIliasIniFile = new ilIniFile("./ilias.ini.php");
                 $GLOBALS['ilIliasIniFile'] =& $ilIliasIniFile;
                 $ilIliasIniFile->read();
 
                 // 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"));
 
                 
                 $tz = $ilIliasIniFile->readVariable("server","timezone");
                 if ($tz != "")
                 {
                         if (function_exists('date_default_timezone_set'))
                         {
                                 date_default_timezone_set($tz);
                         }
                 }
                 define ("IL_TIMEZONE", $ilIliasIniFile->readVariable("server","timezone"));
         }

◆ initIliasIniFile() [2/2]

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 109 of file class.ilInitialisation.php.

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

Referenced by initILIAS().

         {               
                 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 ("PATH_TO_HTMLDOC",$ilIliasIniFile->readVariable("tools","htmldoc"));
                 define ("URL_TO_LATEX",$ilIliasIniFile->readVariable("tools","latex"));
                 define ("PATH_TO_FOP",$ilIliasIniFile->readVariable("tools","fop"));
 
                 // 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:

Here is the caller graph for this function:

◆ initLocale()

static ilInitialisation::initLocale ( )

staticprotected

Init Locale.

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

References $GLOBALS, $ilSetting, and $l.

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

◆ initLog() [1/2]

ilInitialisation::initLog ( )

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

References $GLOBALS, $ilLog, and $log.

                            {
                 global $ilLog;
                 $log = new ilLog(ILIAS_LOG_DIR,ILIAS_LOG_FILE,CLIENT_ID,ILIAS_LOG_ENABLED,ILIAS_LOG_LEVEL);
                 $GLOBALS['log'] = $log;
                 $ilLog = $log;
                 $GLOBALS['ilLog'] = $ilLog;
         }

◆ initLog() [2/2]

static ilInitialisation::initLog ( )

staticprotected

Init log instance.

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

References $log, and ilLoggerFactory\getRootLogger().

Referenced by initILIAS().

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

Here is the caller graph for this function:

◆ initSettings()

static ilInitialisation::initSettings ( )

staticprotected

initialise $ilSettings object and define constants

Used in Soap

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

References $ilSetting, ilPaymentSettings\_isPaymentEnabled(), 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();
                 }
 
                 // payment setting
                 require_once('Services/Payment/classes/class.ilPaymentSettings.php');
                 define('IS_PAYMENT_ENABLED', ilPaymentSettings::_isPaymentEnabled());           
         }

Here is the call graph for this function:

◆ initStyle()

static ilInitialisation::initStyle ( )

staticprotected

provide $styleDefinition object

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

References $GLOBALS, $ilUser, ilSession\get(), ilLoggerFactory\getInstance(), ilPluginAdmin\getPluginObject(), ilLoggerFactory\getRootLogger(), IL_COMP_SERVICE, IL_TIMEZONE, and ilSession\set().

         {
                 global $styleDefinition, $ilPluginAdmin;
 
                 // load style definitions
                 self::initGlobal("styleDefinition", "ilStyleDefinition",
                          "./Services/Style/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));
                 }
 
                 $styleDefinition->startParsing();
         }

Here is the call graph for this function:

◆ initUser()

static ilInitialisation::initUser ( )

staticprotected

Init user / authentification (level 2)

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

References $_GET, $_POST, $_SESSION, $ilUser, ilSession\_destroy(), ilAuthUtils\_initAuth(), ilSession\SESSION_CLOSE_LOGIN, ilSession\set(), and ilContext\usesHTTP().

         {
                 global $ilias, $ilAuth, $ilUser;
                 
                 if(ilContext::usesHTTP())
                 {                                                               
                         // allow login by submitting user data
                         // in query string when DEVMODE is enabled
                         if( DEVMODE
                                 && isset($_GET['username']) && strlen($_GET['username'])
                                 && isset($_GET['password']) && strlen($_GET['password'])
                         ){
                                 $_POST['username'] = $_GET['username'];
                                 $_POST['password'] = $_GET['password'];
                         }                                                                               
                 }               
 
                 // $ilAuth 
                 require_once "Auth/Auth.php";
                 require_once "./Services/AuthShibboleth/classes/class.ilShibboleth.php";                
                 include_once("./Services/Authentication/classes/class.ilAuthUtils.php");
                 ilAuthUtils::_initAuth();
                 $ilias->auth = $ilAuth;
 
                 // $ilUser 
                 self::initGlobal("ilUser", "ilObjUser", 
                         "./Services/User/classes/class.ilObjUser.php");
                 $ilias->account =& $ilUser;
                                 
                 self::initAccessHandling();
 
                 
                 // force login
                 if ((isset($_GET["cmd"]) && $_GET["cmd"] == "force_login"))
                 {                       
                         $ilAuth->logout();
                         
                         // we need to do this for the session statistics
                         // could we use session_destroy() instead?
                         // [this is done after every $ilAuth->logout() call elsewhere] 
                         ilSession::_destroy(session_id(), ilSession::SESSION_CLOSE_LOGIN);
 
                         // :TODO: keep session because of cart content?
                         if(!isset($_GET['forceShoppingCartRedirect']))
                         {
                                 $_SESSION = array();
                         }
                         else
                         {
                                 ilSession::set("AccountId", "");        
                         }
                 }               
                 
         }

Here is the call graph for this function:

◆ persistCMIData()

ilInitialisation::persistCMIData ( )

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

References $_GET, $data, $ilDB, $ilLog, $ilUser, $lm_set, $packageId, ilSCORM2004StoreData\persistCMIData(), and ilUtil\yn2tf().

Referenced by initILIAS().

         {
                 global $ilLog, $ilDB, $ilUser;
                 $packageId=(int)$_GET['package_id'];
                 $lm_set = $ilDB->queryF('SELECT default_lesson_mode, interactions, objectives, comments FROM sahs_lm WHERE id = %s', 
                         array('integer'),array($packageId));
                 
                 while($lm_rec = $ilDB->fetchAssoc($lm_set))
                 {
                         $defaultLessonMode=($lm_rec["default_lesson_mode"]);
                         $interactions=(ilUtil::yn2tf($lm_rec["interactions"]));
                         $objectives=(ilUtil::yn2tf($lm_rec["objectives"]));
                         $comments=(ilUtil::yn2tf($lm_rec["comments"]));
                 }
                 $data = file_get_contents('php://input');
                 $ilUser->setId($data->p);
 
                 include_once './Modules/Scorm2004/classes/class.ilSCORM2004StoreData.php';
                 ilSCORM2004StoreData::persistCMIData(null, $packageId, 
                 $defaultLessonMode, $comments, 
                 $interactions, $objectives,$data);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ recursivelyRemoveUnsafeCharacters()

static ilInitialisation::recursivelyRemoveUnsafeCharacters ( $var )

staticprotected

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

                                                                           {
                 if (is_array($var)) {
                         $mod = array();
                         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,
		$a_message_static
	)

staticprotected

Redirects to target url if context supports it.

Parameters

string	$a_target
string	$a_message_id
array	$a_message_details

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

References 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 852 of file class.ilInitialisation.php.

Referenced by ilWebAccessChecker\initILIAS(), and ilSoapUserAdministration\loginStudipUser().

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

Here is the caller graph for this function:

◆ removeUnsafeCharacters() [1/2]

ilInitialisation::removeUnsafeCharacters ( )

Remove unsafe characters from GET.

Definition at line 25 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)
                 if (is_array($_GET))
                 {
                         foreach($_GET as $k => $v)
                         {
                                 // \r\n used for IMAP MX Injection
                                 // ' used for SQL Injection
                                 $_GET[$k] = str_replace(array("\x00", "\n", "\r", "\\", "'", '"', "\x1a"), "", $v);
 
                                 // this one is for XSS of any kind
                                 $_GET[$k] = strip_tags($_GET[$k]);
                         }
                 }
         }

◆ removeUnsafeCharacters() [2/2]

static ilInitialisation::removeUnsafeCharacters ( )

staticprotected

Remove unsafe characters from GET.

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

References $_GET.

Referenced by initILIAS().

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

Here is the caller graph for this function:

◆ requireCommonIncludes() [1/2]

ilInitialisation::requireCommonIncludes ( )

get common include code files

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

References $GLOBALS, and $ilBench.

         {
                 global $ilBench;
 
                 // get pear
                 require_once("include/inc.get_pear.php");
                 require_once("include/inc.check_pear.php");
 
                 //include class.util first to start StopWatch
                 require_once "./Services/Utilities/classes/class.ilUtil.php";
                 require_once "./Services/Utilities/classes/class.ilBenchmark.php";
                 $ilBench = new ilBenchmark();
                 $GLOBALS['ilBench'] = $ilBench;
 
                 // Major PEAR Includes
                 require_once "PEAR.php";
                 //require_once "DB.php";
                 // require_once "Auth/Auth.php";
 
                 
 
                 //include classes and function libraries
                 require_once "./Services/Database/classes/class.ilDB.php";
                 // require_once "classes/class.ilias.php";
                 // require_once './Services/User/classes/class.ilObjUser.php';
                 require_once "./Services/Logging/classes/class.ilLog.php";
 //              require_once "classes/class.ilObjectDataCache.php";
                 require_once "./Services/Init/classes/class.ilErrorHandling.php";
                 
                 require_once "./Services/Administration/classes/class.ilSetting.php";
         }

◆ requireCommonIncludes() [2/2]

static ilInitialisation::requireCommonIncludes ( )

staticprotected

get common include code files

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

References ilContext\usesTemplate().

Referenced by initILIAS().

         {                       
                 // pear
                 require_once("include/inc.get_pear.php");
                 require_once("include/inc.check_pear.php");
                 require_once "PEAR.php";
                 
                 // ilTemplate
                 if(ilContext::usesTemplate())
                 {
                         // HTML_Template_IT support
                         require_once "HTML/Template/ITX.php";
                         require_once "./Services/UICore/classes/class.ilTemplateHTMLITX.php";
                         require_once "./Services/UICore/classes/class.ilTemplate.php";
                 }               
                                 
                 // really always required?
                 require_once "./Services/Utilities/classes/class.ilUtil.php";   
                 require_once "./Services/Utilities/classes/class.ilFormat.php";
                 require_once "./Services/Calendar/classes/class.ilDatePresentation.php";                                                                                                                
                 require_once "include/inc.ilias_version.php";   
                 
                 self::initGlobal("ilBench", "ilBenchmark", "./Services/Utilities/classes/class.ilBenchmark.php");                               
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCookieParams()

static ilInitialisation::setCookieParams ( )

staticprotected

set session cookie params for path, domain, etc.

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

References $_SERVER, $GLOBALS, $ilSetting, ilAuthFactory\CONTEXT_HTTP, ilAuthFactory\getContext(), ilHTTPS\getInstance(), and IL_COOKIE_PATH.

         {
                 global $ilSetting;
                 
                 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 = '/';
                 
                 include_once './Services/Http/classes/class.ilHTTPS.php';
                 $cookie_secure = !$ilSetting->get('https', 0) && ilHTTPS::getInstance()->isDetected();
                 
                 define('IL_COOKIE_EXPIRE',0);
                 define('IL_COOKIE_PATH',$cookie_path);
                 define('IL_COOKIE_DOMAIN','');
                 define('IL_COOKIE_SECURE', $cookie_secure); // Default Value
 
                 define('IL_COOKIE_HTTPONLY',true); // 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 419 of file class.ilInitialisation.php.

References ilSession\_exists().

Referenced by CASClient\renameSession().

         {
                 if(ini_get('session.save_handler') != 'user')
                 {
                         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'))
                 {
                         session_regenerate_id();
                 }                               
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showingLoginForm()

static ilInitialisation::showingLoginForm ( $a_current_script )

staticprotected

Is current view the login form?

Returns: boolean

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

References $_REQUEST.

         {               
                 if($a_current_script == "login.php")
                 {
                         return true;
                 }
                 
                 if($_REQUEST["baseClass"] == "ilStartUpGUI" && 
                         self::getCurrentCmd() == "showLogin")
                 {       
                         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 1420 of file class.ilInitialisation.php.

References $_REQUEST, $ilDB, $ilSetting, $ilUser, $lang, and $lng.

         {
                 global $ilDB, $lng, $ilSetting, $ilClientIniFile, $ilUser;
                         
                 // current language
                 if(!$lng)
                 {
                         $lang = "en";
                         if($ilUser)
                         {
                                 $lang = $ilUser->getLanguage();
                         }
                         else if($_REQUEST["lang"])
                         {
                                 $lang = (string)$_REQUEST["lang"];
                         }
                         else if($ilSetting)
                         {
                                 $lang = $ilSetting->get("language");
                         }
                         else if($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);    
                 }
                 else if(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 849 of file class.ilInitialisation.php.

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

Services/Init/classes/class.ilInitialisation.php

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Static Protected Attributes

Detailed Description

Member Function Documentation

◆ abortAndDie()

◆ authenticate()

◆ blockedAuthentication()

◆ buildHTTPPath()

◆ determineClient() [1/2]

◆ determineClient() [2/2]

◆ getCurrentCmd()

◆ goToLogin()

◆ goToPublicSection()

◆ handleDevMode()

◆ handleErrorReporting()

◆ handleMaintenanceMode()

◆ includePhp5Compliance()

◆ initAccessHandling()

◆ initClient()

◆ initClientIniFile() [1/2]

◆ initClientIniFile() [2/2]

◆ initCore()

◆ initDatabase() [1/2]

◆ initDatabase() [2/2]

◆ initEventHandling()

◆ initGlobal()

◆ initILIAS() [1/2]

◆ initILIAS() [2/2]

◆ initIliasIniFile() [1/2]

◆ initIliasIniFile() [2/2]

◆ initLocale()

◆ initLog() [1/2]

◆ initLog() [2/2]

◆ initSettings()

◆ initStyle()

◆ initUser()

◆ persistCMIData()

◆ recursivelyRemoveUnsafeCharacters()

◆ redirect()

◆ reinitILIAS()

◆ removeUnsafeCharacters() [1/2]

◆ removeUnsafeCharacters() [2/2]

◆ requireCommonIncludes() [1/2]

◆ requireCommonIncludes() [2/2]

◆ setCookieParams()

◆ setSessionHandler()

◆ showingLoginForm()

◆ translateMessage()

Field Documentation

◆ $already_initialized