Collaboration diagram for ilSession:

Static Public Member Functions
static	_getData ($a_session_id)
	Get session data from table. More...

static	_writeData ($a_session_id, $a_data)
	Write session data. More...

static	_exists ($a_session_id)
	Check whether session exists. More...

static	_destroy ($a_session_id, $a_closing_context=null, $a_expired_at=null)
	Destroy session. More...

static	_destroyByUserId ($a_user_id)
	Destroy session. More...

static	_destroyExpiredSessions ()
	Destroy expired sessions. More...

static	_duplicate ($a_session_id)
	Duplicate session. More...

static	getExpireValue ($fixedMode=false)
	Returns the expiration timestamp in seconds. More...

static	getIdleValue ($fixedMode=false)
	Returns the idle time in seconds. More...

static	getSessionExpireValue ()
	Returns the session expiration value. More...

static	_getUsersWithIp ($a_ip)
	Get the active users with a specific remote ip address. More...

static	set ($a_var, $a_val)
	Set a value. More...

static	get ($a_var)
	Get a value. More...

static	clear ($a_var)
	Unset a value. More...

static	setClosingContext ($a_context)
	set closing context (for statistics) More...

static	getClosingContext ()
	get closing context (for statistics) More...

Data Fields
const	SESSION_HANDLING_FIXED = 0

const	SESSION_HANDLING_LOAD_DEPENDENT = 1

const	SESSION_CLOSE_USER = 1

const	SESSION_CLOSE_EXPIRE = 2

const	SESSION_CLOSE_FIRST = 3

const	SESSION_CLOSE_IDLE = 4

const	SESSION_CLOSE_LIMIT = 5

const	SESSION_CLOSE_LOGIN = 6

const	SESSION_CLOSE_PUBLIC = 7

const	SESSION_CLOSE_TIME = 8

const	SESSION_CLOSE_IP = 9

const	SESSION_CLOSE_SIMUL = 10

const	SESSION_CLOSE_INACTIVE = 11

const	SESSION_CLOSE_CAPTCHA = 12

Static Private Attributes
static	$closing_context = null

Detailed Description

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

Version: $Id:$

ilObjUser on usr_session

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

Member Function Documentation

◆ _destroy()

static ilSession::_destroy	(	$a_session_id,
		$a_closing_context = `null`,
		$a_expired_at = `null`
	)

static

Destroy session.

Parameters

string\|array	session id\|s
int	closing context
int\|bool	expired at timestamp

Definition at line 165 of file class.ilSession.php.

References ilSessionStatistics\closeRawEntry(), and ilSessionIStorage\destroySession().

Referenced by ilSessionDBHandler\destroy(), ilInitialisation\initUser(), ilSessionControl\kickFirstRequestAbidencer(), ilSessionControl\kickOneMinIdleSession(), ilStartUpGUI\migrateAccount(), and ilSessionTest\testBasicSessionBehaviour().

         {               
                 global $ilDB;
                 
                 if(!$a_closing_context)
                 {
                         $a_closing_context = self::$closing_context;
                 }
                         
                 ilSessionStatistics::closeRawEntry($a_session_id, $a_closing_context, $a_expired_at);   
                 
                 
                 if(!is_array($a_session_id))
                 {
                         $q = "DELETE FROM usr_session WHERE session_id = ".
                                 $ilDB->quote($a_session_id, "text");                    
                 }
                 else
                 {
                         // array: id => timestamp - so we get rid of timestamps
                         if($a_expired_at)
                         {
                                 $a_session_id = array_keys($a_session_id);
                         }               
                         $q = "DELETE FROM usr_session WHERE ".
                                 $ilDB->in("session_id", $a_session_id, "", "text");
                 }
 
                 ilSessionIStorage::destroySession($a_session_id);
 
                 $ilDB->manipulate($q);
                 
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _destroyByUserId()

static ilSession::_destroyByUserId ( $a_user_id )

static

Destroy session.

Parameters

string session id

Definition at line 205 of file class.ilSession.php.

Referenced by ilObjUser\delete(), and ilSessionTest\testBasicSessionBehaviour().

         {
                 global $ilDB;
 
                 $q = "DELETE FROM usr_session WHERE user_id = ".
                         $ilDB->quote($a_user_id, "integer");
                 $ilDB->manipulate($q);
                 
                 return true;
         }

Here is the caller graph for this function:

◆ _destroyExpiredSessions()

static ilSession::_destroyExpiredSessions ( )

static

Destroy expired sessions.

Definition at line 219 of file class.ilSession.php.

References $res, and $row.

Referenced by ilSessionStatisticsGUI\adminSync(), ilSessionDBHandler\gc(), and ilSessionTest\testBasicSessionBehaviour().

         {
                 global $ilDB;
                                 
                 $q = "SELECT session_id,expires FROM usr_session WHERE expires < ".
                         $ilDB->quote(time(), "integer");
                 $res = $ilDB->query($q);
                 $ids = array();
                 while($row = $ilDB->fetchAssoc($res))
                 {
                         $ids[$row["session_id"]] = $row["expires"];
                 }               
                 if(sizeof($ids))
                 {
                         self::_destroy($ids, self::SESSION_CLOSE_EXPIRE, true);
                 }       
                 
                 return true;
         }

Here is the caller graph for this function:

◆ _duplicate()

static ilSession::_duplicate ( $a_session_id )

static

Duplicate session.

Parameters

string session id

Returns: string new session id

Definition at line 245 of file class.ilSession.php.

References $query, $res, $row, and _writeData().

Referenced by ilContainer\cloneAllObject(), ilECSTaskScheduler\initNextExecution(), and ilSessionTest\testBasicSessionBehaviour().

         {
                 global $ilDB;
         
                 // Create new session id
                 $new_session = $a_session_id;
                 do
                 {
                         $new_session = md5($new_session);
                         $q ="SELECT * FROM usr_session WHERE ".
                                 "session_id = ".$ilDB->quote($new_session, "text");
                         $res = $ilDB->query($q);
                 } while($ilDB->fetchAssoc($res));
                 
                 $query = "SELECT * FROM usr_session ".
                         "WHERE session_id = ".$ilDB->quote($a_session_id, "text");
                 $res = $ilDB->query($query);
 
                 while ($row = $ilDB->fetchObject($res))
                 {
                         ilSession::_writeData($new_session,$row->data);
                         return $new_session;
                 }
                 return false;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _exists()

static ilSession::_exists ( $a_session_id )

static

Check whether session exists.

Parameters

string session id

Returns: boolean true, if session id exists

Definition at line 144 of file class.ilSession.php.

Referenced by _writeData(), ilInitialisation\setSessionHandler(), and ilSessionTest\testBasicSessionBehaviour().

         {
                 global $ilDB;
 
                 $q = "SELECT session_id FROM usr_session WHERE session_id = ".
                         $ilDB->quote($a_session_id, "text");
                 $set = $ilDB->query($q);
                 if ($ilDB->fetchAssoc($set))
                 {
                         return true;
                 }
                 return false;
         }

Here is the caller graph for this function:

◆ _getData()

static ilSession::_getData ( $a_session_id )

static

Get session data from table.

Parameters

string session id

Returns: string session data

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

Referenced by ilSessionDBHandler\read(), and ilSessionTest\testBasicSessionBehaviour().

         {
                 global $ilDB;
                 
                 $q = "SELECT data FROM usr_session WHERE session_id = ".
                         $ilDB->quote($a_session_id, "text");
                 $set = $ilDB->query($q);
                 $rec = $ilDB->fetchAssoc($set);
         
                 return $rec["data"];
         }

Here is the caller graph for this function:

◆ _getUsersWithIp()

static ilSession::_getUsersWithIp ( $a_ip )

static

Get the active users with a specific remote ip address.

Parameters

string ip address

Returns: array list of active user id

Definition at line 343 of file class.ilSession.php.

References $query, $result, and $row.

Referenced by ilWebAccessChecker\determineUser().

         {
                 global $ilDB;
                 
                 $query = "SELECT DISTINCT user_id FROM usr_session"
                                 . " WHERE remote_addr = " . $ilDB->quote($a_ip, "text")
                                 . " AND user_id > 0";           
                 $result = $ilDB->query($query);
                 
                 $users = array();
                 while ($row = $ilDB->fetchObject($result))
                 {
                         $users[] = $row->user_id;
                 }
                 return $users;
         }

Here is the caller graph for this function:

◆ _writeData()

static ilSession::_writeData	(	$a_session_id,
		$a_data
	)

static

Write session data.

Parameters

string	session id
string	session data

Definition at line 79 of file class.ilSession.php.

References $_SESSION, $GLOBALS, ilSessionControl\$session_types_controlled, _exists(), ilSessionStatistics\aggretateRaw(), and ilSessionStatistics\createRawEntry().

Referenced by _duplicate(), ilSessionTest\testBasicSessionBehaviour(), and ilSessionDBHandler\write().

         {
                 global $ilDB, $ilClientIniFile;
                 
                 if ($GLOBALS['WEB_ACCESS_WITHOUT_SESSION'])
                 {
                         // Prevent session data written for web access checker
                         // when no cookie was sent (e.g. for pdf files linking others).
                         // This would result in new session records for each request.
                         return false;
                 }
 
                 $now = time();
 
                 // prepare session data
                 $fields = array(
                         "user_id" => array("integer", (int) $_SESSION["AccountId"]),
                         "expires" => array("integer", self::getExpireValue()),
                         "data" => array("clob", $a_data),
                         "ctime" => array("integer", $now),
                         "type" => array("integer", (int) $_SESSION["SessionType"])
                         );
                 if ($ilClientIniFile->readVariable("session","save_ip"))
                 {
                         $fields["remote_addr"] = array("text", $_SERVER["REMOTE_ADDR"]);
                 }                                                               
 
                 if (ilSession::_exists($a_session_id))
                 {
                         $ilDB->update("usr_session", $fields, 
                                 array("session_id" => array("text", $a_session_id)));                   
                 }
                 else
                 {
                         $fields["session_id"] = array("text", $a_session_id);
                         $fields["createtime"] = array("integer", $now);
                         
                         $ilDB->insert("usr_session", $fields);
                 
                         // check type against session control
                         $type = $fields["type"][1];
                         if(in_array($type, ilSessionControl::$session_types_controlled))
                         {               
                                 ilSessionStatistics::createRawEntry($fields["session_id"][1], 
                                         $type, $fields["createtime"][1], $fields["user_id"][1]);                        
                         }                                                       
                 }
                 
                 // finally delete deprecated sessions
                 if(rand(0, 50) == 2)
                 {
                         // get time _before_ destroying expired sessions                
                         self::_destroyExpiredSessions();        
                     ilSessionStatistics::aggretateRaw($now);
                 }
                 
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clear()

static ilSession::clear ( $a_var )

static

Unset a value.

Parameters

Definition at line 388 of file class.ilSession.php.

References $_SESSION.

Referenced by ilObjiLincUserGUI\cancel(), ilLMObjectGUI\cancelDelete(), ilObjiLincClassroomGUI\cancelDeleteClassroom(), ilSCORM2004ScoGUI\cancelDeleteExportFile(), ilObjSCORM2004LearningModuleGUI\cancelDeleteExportFile(), ilObjSurveyQuestionPoolGUI\cancelDeleteExportFileObject(), ilObjectGUI\cancelDeleteObject(), ilObjUserGUI\cancelObject(), ilObjectGUI\cancelObject(), ilObjectGUI\checkPermission(), ilObjectGUI\confirmedDeleteObject(), ilRepUtil\deleteObjects(), ilTemplate\fillMessage(), ilUtil\infoPanel(), ilHelpGUI\resetCurrentPage(), ilTemplate\show(), and ilPageObjectGUI\showPage().

         {
                 unset($_SESSION[$a_var]);
         }

Here is the caller graph for this function:

◆ get()

static ilSession::get ( $a_var )

static

Get a value.

Parameters

Definition at line 377 of file class.ilSession.php.

References $_SESSION.

Referenced by ilAccountRegistrationGUI\__distributeMails(), ilMailFolderGUI\addSubfolderCommands(), ilMailFolderGUI\cancelDeleteMails(), ilObjectGUI\confirmedDeleteObject(), ilMailGUI\executeCommand(), ilTemplate\fillMessage(), ilStartUpGUI\getAcceptance(), ilHelpMappingTableGUI\getChapters(), ilMailFormCall\getRecipients(), ilObjUser\hasToAcceptTermsOfServiceInSession(), ilUserRequestTargetAdjustment\initCases(), ilInitialisation\initCore(), ilHelpGUI\initHelp(), ilInitialisation\initLanguage(), ilObjForumGUI\initSessionStorage(), ilInitialisation\initStyle(), ilTestPlayerAbstractGUI\isTestSignRedirectRequired(), ilStartUpGUI\migrateAccount(), ilMailFolderGUI\performAddSubFolder(), ilMailFolderGUI\performRenameSubFolder(), ilPersonalSettingsGUI\savePassword(), ilPersonalProfileGUI\savePersonalData(), ilMailFormCall\setRecipients(), ilTemplate\show(), ilObjContentObjectGUI\showExportIDsOverview(), ilMailGUI\showHeader(), ilHelpGUI\showHelp(), and ilObjContentObjectGUI\showTooltipList().

         {
                 return $_SESSION[$a_var];
         }

Here is the caller graph for this function:

◆ getClosingContext()

static ilSession::getClosingContext ( )

static

get closing context (for statistics)

Returns: int

Definition at line 408 of file class.ilSession.php.

         {
                 return self::$closing_context;
         }

◆ getExpireValue()

static ilSession::getExpireValue ( $fixedMode = false )

static

Returns the expiration timestamp in seconds.

Parameters

boolean If passed, the value for fixed session is returned

Returns: integer The expiration timestamp in seconds public

Definition at line 281 of file class.ilSession.php.

References $ilSetting, and ilSessionControl\DEFAULT_MAX_IDLE.

         {
                 global $ilSetting;
                 
                 if( $fixedMode || $ilSetting->get('session_handling_type', self::SESSION_HANDLING_FIXED) == self::SESSION_HANDLING_FIXED )
                 {
                         // fixed session
                         return time() + ini_get('session.gc_maxlifetime');
                 }
                 else if( $ilSetting->get('session_handling_type', self::SESSION_HANDLING_FIXED) == self::SESSION_HANDLING_LOAD_DEPENDENT )
                 {
                         // load dependent session settings
                         return time() + (int) ($ilSetting->get('session_max_idle', ilSessionControl::DEFAULT_MAX_IDLE) * 60);
                 }
         }

◆ getIdleValue()

static ilSession::getIdleValue ( $fixedMode = false )

static

Returns the idle time in seconds.

Parameters

boolean If passed, the value for fixed session is returned

Returns: integer The idle time in seconds public

Definition at line 307 of file class.ilSession.php.

References $ilSetting, and ilSessionControl\DEFAULT_MAX_IDLE.

Referenced by ilAuthUtils\_initAuth(), ilTestPlayerAbstractGUI\finishTestCmd(), and ilSCORM13Player\getPlayer().

         {
                 global $ilSetting, $ilClientIniFile;
                 
                 if( $fixedMode || $ilSetting->get('session_handling_type', self::SESSION_HANDLING_FIXED) ==  self::SESSION_HANDLING_FIXED )
                 {
                         // fixed session
                         return $ilClientIniFile->readVariable('session','expire');
                 }
                 else if( $ilSetting->get('session_handling_type', self::SESSION_HANDLING_FIXED) ==  self::SESSION_HANDLING_LOAD_DEPENDENT )
                 {
                         // load dependent session settings
                         return (int) ($ilSetting->get('session_max_idle', ilSessionControl::DEFAULT_MAX_IDLE) * 60);
                 }
         }

Here is the caller graph for this function:

◆ getSessionExpireValue()

static ilSession::getSessionExpireValue ( )

static

Returns the session expiration value.

Returns: integer The expiration value in seconds public

Definition at line 332 of file class.ilSession.php.

Referenced by ilObjUserFolderGUI\initFormGeneralSettings(), and ilPersonalSettingsGUI\initGeneralSettingsForm().

         {
                 return self::getIdleValue(true);
         }

Here is the caller graph for this function:

◆ set()

static ilSession::set	(	$a_var,
		$a_val
	)

static

Set a value.

Parameters

Definition at line 366 of file class.ilSession.php.

References $_SESSION.

Referenced by ilObjContentObjectGUI\addTooltip(), ilInitialisation\authenticate(), ilObjectGUI\deleteObject(), ilTestSignatureGUI\executeCommand(), ilMailGUI\executeCommand(), ilObjContentObjectGUI\filterHelpChapters(), ilObjContentObjectGUI\filterTooltips(), ilStartUpGUI\getAcceptance(), ilTestSignatureGUI\getTestOutputGUI(), ilObjUser\hasToAcceptTermsOfServiceInSession(), ilObjectGUI\hitsperpageObject(), ilUserRequestTargetAdjustment\initCases(), ilInitialisation\initLanguage(), ilObjForumGUI\initSessionStorage(), ilInitialisation\initStyle(), ilInitialisation\initUser(), ilStartUpGUI\migrateAccount(), ilPersonalSettingsGUI\savePassword(), ilPersonalProfileGUI\savePersonalData(), ilTemplate\setMessage(), ilMailFormCall\setRecipients(), ilTemplate\show(), ilHelpGUI\showHelp(), ilStartUpGUI\showLogin(), and ilHelpGUI\showPage().

         {
                 $_SESSION[$a_var] = $a_val;
         }

Here is the caller graph for this function:

◆ setClosingContext()

static ilSession::setClosingContext ( $a_context )

static

set closing context (for statistics)

Parameters

int $a_context

Definition at line 398 of file class.ilSession.php.

Referenced by ilSessionControl\checkCurrentSessionIsAllowed(), ilPersonalSettingsGUI\deleteOwnAccountLogout(), ilInitialisation\goToLogin(), ilInitialisation\goToPublicSection(), ilStartUpGUI\showLogin(), and ilStartUpGUI\showLogout().

         {
                 self::$closing_context = (int)$a_context;
         }

Here is the caller graph for this function:

Field Documentation

◆ $closing_context

ilSession::$closing_context = null

staticprivate

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

◆ SESSION_CLOSE_CAPTCHA

const ilSession::SESSION_CLOSE_CAPTCHA = 12

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

Referenced by ilStartUpGUI\showLogin().

◆ SESSION_CLOSE_EXPIRE

const ilSession::SESSION_CLOSE_EXPIRE = 2

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

Referenced by ilSessionStatistics\aggregateRawHelper(), ilInitialisation\goToLogin(), and ilInitialisation\goToPublicSection().

◆ SESSION_CLOSE_FIRST

const ilSession::SESSION_CLOSE_FIRST = 3

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

Referenced by ilSessionStatistics\aggregateRawHelper(), and ilSessionControl\kickFirstRequestAbidencer().

◆ SESSION_CLOSE_IDLE

const ilSession::SESSION_CLOSE_IDLE = 4

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

Referenced by ilSessionStatistics\aggregateRawHelper(), and ilSessionControl\kickOneMinIdleSession().

◆ SESSION_CLOSE_INACTIVE

const ilSession::SESSION_CLOSE_INACTIVE = 11

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

Referenced by ilStartUpGUI\showLogin().

◆ SESSION_CLOSE_IP

const ilSession::SESSION_CLOSE_IP = 9

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

Referenced by ilStartUpGUI\showLogin().

◆ SESSION_CLOSE_LIMIT

const ilSession::SESSION_CLOSE_LIMIT = 5

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

Referenced by ilSessionStatistics\aggregateRawHelper(), and ilSessionControl\checkCurrentSessionIsAllowed().

◆ SESSION_CLOSE_LOGIN

const ilSession::SESSION_CLOSE_LOGIN = 6

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

Referenced by ilSessionStatistics\aggregateRawHelper(), ilInitialisation\goToLogin(), and ilInitialisation\initUser().

◆ SESSION_CLOSE_PUBLIC

const ilSession::SESSION_CLOSE_PUBLIC = 7

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

Referenced by ilInitialisation\goToPublicSection().

◆ SESSION_CLOSE_SIMUL

const ilSession::SESSION_CLOSE_SIMUL = 10

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

Referenced by ilStartUpGUI\showLogin().

◆ SESSION_CLOSE_TIME

const ilSession::SESSION_CLOSE_TIME = 8

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

Referenced by ilStartUpGUI\showLogin().

◆ SESSION_CLOSE_USER

const ilSession::SESSION_CLOSE_USER = 1

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

Referenced by ilSessionStatistics\aggregateRawHelper(), ilPersonalSettingsGUI\deleteOwnAccountLogout(), and ilStartUpGUI\showLogout().

◆ SESSION_HANDLING_FIXED

const ilSession::SESSION_HANDLING_FIXED = 0

Definition at line 24 of file class.ilSession.php.

Referenced by ilSetupGUI\displaySessions(), ilObjUserFolderGUI\generalSettingsObject(), ilObjUserFolderGUI\initFormGeneralSettings(), ilSessionReminder\isActive(), and ilObjUserFolderGUI\saveGeneralSettingsObject().

◆ SESSION_HANDLING_LOAD_DEPENDENT

const ilSession::SESSION_HANDLING_LOAD_DEPENDENT = 1

Definition at line 33 of file class.ilSession.php.

Referenced by ilSetupGUI\displaySessions(), ilObjUserFolderGUI\initFormGeneralSettings(), and ilObjUserFolderGUI\saveGeneralSettingsObject().

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

Services/Authentication/classes/class.ilSession.php

Static Public Member Functions

Data Fields

Static Private Attributes

Detailed Description

Member Function Documentation

◆ _destroy()

◆ _destroyByUserId()

◆ _destroyExpiredSessions()

◆ _duplicate()

◆ _exists()

◆ _getData()

◆ _getUsersWithIp()

◆ _writeData()

◆ clear()

◆ get()

◆ getClosingContext()

◆ getExpireValue()

◆ getIdleValue()

◆ getSessionExpireValue()

◆ set()

◆ setClosingContext()

Field Documentation

◆ $closing_context

◆ SESSION_CLOSE_CAPTCHA

◆ SESSION_CLOSE_EXPIRE

◆ SESSION_CLOSE_FIRST

◆ SESSION_CLOSE_IDLE

◆ SESSION_CLOSE_INACTIVE

◆ SESSION_CLOSE_IP

◆ SESSION_CLOSE_LIMIT

◆ SESSION_CLOSE_LOGIN

◆ SESSION_CLOSE_PUBLIC

◆ SESSION_CLOSE_SIMUL

◆ SESSION_CLOSE_TIME

◆ SESSION_CLOSE_USER

◆ SESSION_HANDLING_FIXED

◆ SESSION_HANDLING_LOAD_DEPENDENT