This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilSessionControl:

Static Public Member Functions
static	handleLoginEvent (string $a_login, ilAuthSession $auth_session)
	when current session is allowed to be created it marks it with type regarding to the sessions user context. More...

static	handleLogoutEvent ()
	reset sessions type to unknown More...

static	getExistingSessionCount (array $a_types)
	returns number of valid sessions relating to given session types More...

static	getSettingFields ()
	returns the array of setting fields More...

Data Fields
const	DEFAULT_MAX_COUNT = 0
	default value for settings that have not been defined in setup or administration yet More...

const	DEFAULT_MIN_IDLE = 15

const	DEFAULT_MAX_IDLE = 30

const	DEFAULT_MAX_IDLE_AFTER_FIRST_REQUEST = 1

const	DEFAULT_ALLOW_CLIENT_MAINTENANCE = 1

Static Public Attributes
static array	$session_types_controlled

Static Private Member Functions
static	checkCurrentSessionIsAllowed (ilAuthSession $auth, int $a_user_id)
	checks wether the current session exhaust the limit of sessions when limit is reached it deletes "firstRequestAbidencer" and checks again when limit is still reached it deletes "oneMinIdleSession" and checks again when limit is still reached the current session will be logged out More...

static	kickOneMinIdleSession (array $a_types)
	if sessions exist that relates to given session types and idled longer than min idle parameter, this method deletes one of these sessions More...

static	kickFirstRequestAbidencer (array $a_types)
	kicks sessions of users that abidence after login so people could not login and go for coffe break ;-) More...

static	isValidSession (string $a_sid)
	checks if session exists for given id and if it is still valid More...

static	removeSessionCookie ()
	removes a session cookie, so it is not sent by browser anymore More...

static	checkAdministrationPermission (int $a_user_id)
	checks wether a given user login relates to an user with administrative permissions More...

static	debug (string $a_debug_log_message)
	logs the given debug message in More...

Private Attributes
const	SESSION_TYPE_UNKNOWN = 0
	session types from which one is assigned to each session More...

const	SESSION_TYPE_SYSTEM = 1

const	SESSION_TYPE_ADMIN = 2

const	SESSION_TYPE_USER = 3

const	SESSION_TYPE_ANONYM = 4

const	SESSION_TYPE_KEY = "SessionType"

Static Private Attributes
static array	$setting_fields
	all fieldnames that are saved in settings table More...

static array	$session_types_not_controlled
	all session types that will be involved when count of sessions will be determined or when idleing sessions will be destroyed More...

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author: Bjoern Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

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

Member Function Documentation

◆ checkAdministrationPermission()

static ilSessionControl::checkAdministrationPermission ( int $a_user_id )

staticprivate

checks wether a given user login relates to an user with administrative permissions

ilRbacSystem $rbacsystem

Returns: boolean access

Definition at line 387 of file class.ilSessionControl.php.

References $DIC, and SYSTEM_FOLDER_ID.

                                                                          : bool
     {
         if (!$a_user_id) {
             return false;
         }
 
         global $DIC;
 
         $rbacsystem = $DIC['rbacsystem'];
 
         $access = $rbacsystem->checkAccessOfUser(
             $a_user_id,
             'read,visible',
             SYSTEM_FOLDER_ID
         );
 
         return $access;
     }

◆ checkCurrentSessionIsAllowed()

static ilSessionControl::checkCurrentSessionIsAllowed	(	ilAuthSession	$auth,
		int	$a_user_id
	)

staticprivate

checks wether the current session exhaust the limit of sessions when limit is reached it deletes "firstRequestAbidencer" and checks again when limit is still reached it deletes "oneMinIdleSession" and checks again when limit is still reached the current session will be logged out

Definition at line 161 of file class.ilSessionControl.php.

References $DIC, $ilSetting, ilSessionStatistics\createRawEntry(), ilSession\get(), ILIAS\Repository\int(), ilAuthSession\logout(), ilUtil\redirect(), ilSession\SESSION_CLOSE_LIMIT, and ilSession\setClosingContext().

                                                                                              : void
     {
         global $DIC;
 
         $ilSetting = $DIC['ilSetting'];
 
         $max_sessions = (int) $ilSetting->get('session_max_count', (string) self::DEFAULT_MAX_COUNT);
 
         if ($max_sessions > 0) {
             // get total number of sessions
             $num_sessions = self::getExistingSessionCount(self::$session_types_controlled);
 
             self::debug(__METHOD__ . "--> total existing sessions (" . $num_sessions . ")");
 
             if (($num_sessions + 1) > $max_sessions) {
                 self::debug(__METHOD__ . ' --> limit for session pool reached, but try kicking some first request abidencer');
 
                 self::kickFirstRequestAbidencer(self::$session_types_controlled);
 
                 // get total number of sessions again
                 $num_sessions = self::getExistingSessionCount(self::$session_types_controlled);
 
                 if (($num_sessions + 1) > $max_sessions) {
                     self::debug(__METHOD__ . ' --> limit for session pool still reached so try kick one min idle session');
 
                     self::kickOneMinIdleSession(self::$session_types_controlled);
 
                     // get total number of sessions again
                     $num_sessions = self::getExistingSessionCount(self::$session_types_controlled);
 
                     if (($num_sessions + 1) > $max_sessions) {
                         self::debug(__METHOD__ . ' --> limit for session pool still reached so logout session (' . session_id() . ') and trigger event');
 
                         ilSession::setClosingContext(ilSession::SESSION_CLOSE_LIMIT);
 
                         // as the session is opened and closed in one request, there
                         // is no proper session yet and we have to do this ourselves
                         ilSessionStatistics::createRawEntry(
                             session_id(),
                             ilSession::get(self::SESSION_TYPE_KEY),
                             time(),
                             $a_user_id
                         );
 
                         $auth->logout();
 
                         // Trigger reachedSessionPoolLimit Event
                         $ilAppEventHandler = $DIC['ilAppEventHandler'];
                         $ilAppEventHandler->raise(
                             'Services/Authentication',
                             'reachedSessionPoolLimit',
                             array()
                         );
 
                         // auth won't do this, we need to close session properly
                         // already done in new implementation
                         // session_destroy();
 
                         ilUtil::redirect('login.php?reached_session_limit=true');
                     } else {
                         self::debug(__METHOD__ . ' --> limit of session pool not reached anymore after kicking one min idle session');
                     }
                 } else {
                     self::debug(__METHOD__ . ' --> limit of session pool not reached anymore after kicking some first request abidencer');
                 }
             } else {
                 self::debug(__METHOD__ . ' --> limit for session pool not reached yet');
             }
         } else {
             self::debug(__METHOD__ . ' --> limit for session pool not set so check is bypassed');
         }
     }

Here is the call graph for this function:

◆ debug()

static ilSessionControl::debug ( string $a_debug_log_message )

staticprivate

logs the given debug message in

Parameters

string $a_debug_log_message

Definition at line 411 of file class.ilSessionControl.php.

References $DIC.

                                                               : void
     {
         global $DIC;
 
         $logger = $DIC->logger()->auth();
 
         $logger->debug($a_debug_log_message);
     }

◆ getExistingSessionCount()

static ilSessionControl::getExistingSessionCount ( array $a_types )

static

returns number of valid sessions relating to given session types

Definition at line 237 of file class.ilSessionControl.php.

References $DIC, $ilDB, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilSessionStatisticsGUI\renderCurrentBasics().

                                                                   : int
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $ts = time();
 
         $query = "SELECT count(session_id) AS num_sessions FROM usr_session " .
                     "WHERE expires > %s " .
                     "AND " . $ilDB->in('type', $a_types, false, 'integer');
 
         $res = $ilDB->queryF($query, array('integer'), array($ts));
         return (int) $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)->num_sessions;
     }

Here is the caller graph for this function:

◆ getSettingFields()

static ilSessionControl::getSettingFields ( )

static

returns the array of setting fields

Returns: array setting_fields

Definition at line 425 of file class.ilSessionControl.php.

                                              : array
     {
         return self::$setting_fields;
     }

◆ handleLoginEvent()

static ilSessionControl::handleLoginEvent	(	string	$a_login,
		ilAuthSession	$auth_session
	)

static

when current session is allowed to be created it marks it with type regarding to the sessions user context.

when session is not allowed to be created it will be destroyed.

Definition at line 89 of file class.ilSessionControl.php.

References $DIC, $ilSetting, ilObjUser\_lookupId(), ANONYMOUS_USER_ID, ilSession\SESSION_HANDLING_FIXED, ilSession\SESSION_HANDLING_LOAD_DEPENDENT, and ilSession\set().

Referenced by ilAuthFrontend\handleAuthenticationSuccess().

                                                                                          : bool
     {
         global $DIC;
 
         $ilSetting = $DIC['ilSetting'];
 
         $user_id = ilObjUser::_lookupId($a_login);
 
         // we need the session type for the session statistics
         // regardless of the current session handling type
         switch (true) {
             case isset($_ENV['SHELL']):
                 $type = self::SESSION_TYPE_SYSTEM;
                 break;
 
             case $user_id === ANONYMOUS_USER_ID:
                 $type = self::SESSION_TYPE_ANONYM;
                 break;
 
             case self::checkAdministrationPermission($user_id):
                 $type = self::SESSION_TYPE_ADMIN;
                 break;
 
             default:
                 $type = self::SESSION_TYPE_USER;
                 break;
         }
 
         ilSession::set(self::SESSION_TYPE_KEY, $type);
         self::debug(__METHOD__ . " --> update sessions type to (" . $type . ")");
 
         // do not handle login event in fixed duration mode
         if ((int) $ilSetting->get('session_handling_type', (string) ilSession::SESSION_HANDLING_FIXED) !== ilSession::SESSION_HANDLING_LOAD_DEPENDENT) {
             return true;
         }
 
         if (in_array($type, self::$session_types_controlled, true)) {
             //TODO rework this, as it did return value of a void method call
             self::checkCurrentSessionIsAllowed($auth_session, $user_id);
             return true;
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleLogoutEvent()

static ilSessionControl::handleLogoutEvent ( )

static

reset sessions type to unknown

Definition at line 136 of file class.ilSessionControl.php.

References $DIC, $ilSetting, ilSession\get(), and ilSession\set().

                                               : void
     {
         global $DIC;
 
         $ilSetting = $DIC['ilSetting'];
 
         // do not handle logout event in fixed duration mode
         if ((int) $ilSetting->get('session_handling_type', '0') !== 1) {
             return;
         }
 
         ilSession::set('SessionType', self::SESSION_TYPE_UNKNOWN);
         self::debug(__METHOD__ . " --> reset sessions type to (" . ilSession::get('SessionType') . ")");
 
         // session_destroy() is called in auth, so raw data will be updated
 
         self::removeSessionCookie();
     }

Here is the call graph for this function:

◆ isValidSession()

static ilSessionControl::isValidSession ( string $a_sid )

staticprivate

checks if session exists for given id and if it is still valid

Returns: boolean session_valid

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

References $DIC, $ilDB, and $res.

                                                          : bool
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         $query = "SELECT session_id, expires FROM usr_session " .
                     "WHERE session_id = %s";
 
         $res = $ilDB->queryF($query, array('text'), array($a_sid));
 
         $ts = time();
 
         $sessions = array();
 
         while ($row = $ilDB->fetchAssoc($res)) {
             if ($row['expires'] > $ts) {
                 self::debug(__METHOD__ . ' --> Found a valid session with id (' . $a_sid . ')');
                 $sessions[] = $row;
             } else {
                 self::debug(__METHOD__ . ' --> Found an expired session with id (' . $a_sid . ')');
             }
         }
 
         if (count($sessions) === 1) {
             self::debug(__METHOD__ . ' --> Exact one valid session found for session id (' . $a_sid . ')');
 
             return true;
         }
 
         if (count($sessions) > 1) {
             self::debug(__METHOD__ . ' --> Strange!!! More than one sessions found for given session id! (' . $a_sid . ')');
         } else {
             self::debug(__METHOD__ . ' --> No valid session found for session id (' . $a_sid . ')');
         }
 
         return false;
     }

◆ kickFirstRequestAbidencer()

static ilSessionControl::kickFirstRequestAbidencer ( array $a_types )

staticprivate

kicks sessions of users that abidence after login so people could not login and go for coffe break ;-)

Definition at line 293 of file class.ilSessionControl.php.

References $DIC, $ilDB, $ilSetting, $res, ilSession\_destroy(), ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), and ilSession\SESSION_CLOSE_FIRST.

                                                                      : void
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         $ilSetting = $DIC['ilSetting'];
 
         $max_idle_after_first_request = (int) $ilSetting->get('session_max_idle_after_first_request') * 60;
 
         if ((int) $max_idle_after_first_request === 0) {
             return;
         }
 
         $query = "SELECT session_id,expires FROM usr_session WHERE " .
                 "(ctime - createtime) < %s " .
                 "AND (%s - createtime) > %s " .
                 "AND " . $ilDB->in('type', $a_types, false, 'integer');
 
         $res = $ilDB->queryF(
             $query,
             array('integer', 'integer', 'integer'),
             array($max_idle_after_first_request, time(), $max_idle_after_first_request)
         );
 
         $session_ids = array();
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $session_ids[$row->session_id] = $row->expires;
         }
         ilSession::_destroy($session_ids, ilSession::SESSION_CLOSE_FIRST, true);
 
         self::debug(__METHOD__ . ' --> Finished kicking first request abidencer');
     }

Here is the call graph for this function:

◆ kickOneMinIdleSession()

static ilSessionControl::kickOneMinIdleSession ( array $a_types )

staticprivate

if sessions exist that relates to given session types and idled longer than min idle parameter, this method deletes one of these sessions

Definition at line 258 of file class.ilSessionControl.php.

References $DIC, $ilDB, $ilSetting, $res, ilSession\_destroy(), ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), and ilSession\SESSION_CLOSE_IDLE.

                                                                  : void
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
         $ilSetting = $DIC['ilSetting'];
 
         $ts = time();
         $min_idle = (int) $ilSetting->get('session_min_idle', (string) self::DEFAULT_MIN_IDLE) * 60;
         $max_idle = (int) $ilSetting->get('session_max_idle', (string) self::DEFAULT_MAX_IDLE) * 60;
 
         $query = "SELECT session_id,expires FROM usr_session WHERE expires >= %s " .
                 "AND (expires - %s) < (%s - %s) " .
                 "AND " . $ilDB->in('type', $a_types, false, 'integer') . " ORDER BY expires";
 
         $res = $ilDB->queryF(
             $query,
             array('integer', 'integer', 'integer', 'integer'),
             array($ts, $ts, $max_idle, $min_idle)
         );
 
         if ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             ilSession::_destroy($row->session_id, ilSession::SESSION_CLOSE_IDLE, $row->expires);
 
             self::debug(__METHOD__ . ' --> successfully deleted one min idle session');
 
             return;
         }
         self::debug(__METHOD__ . ' --> no min idle session available for deletion');
     }

Here is the call graph for this function:

◆ removeSessionCookie()

static ilSessionControl::removeSessionCookie ( )

staticprivate

removes a session cookie, so it is not sent by browser anymore

Definition at line 374 of file class.ilSessionControl.php.

References ilUtil\setCookie().

                                                  : void
     {
         ilUtil::setCookie(session_name(), 'deleted', true, true);
         self::debug('Session cookie has been removed');
     }

Here is the call graph for this function:

Field Documentation

◆ $session_types_controlled

array ilSessionControl::$session_types_controlled

static

Initial value:

= array(
        self::SESSION_TYPE_USER,
        self::SESSION_TYPE_ANONYM
    )

Definition at line 67 of file class.ilSessionControl.php.

Referenced by ilSessionStatistics\getNumberOfActiveRawSessions(), ilSessionStatistics\getRawData(), ilSession\lookupExpireTime(), and ilSessionStatisticsGUI\renderCurrentBasics().

◆ $session_types_not_controlled

array ilSessionControl::$session_types_not_controlled

staticprivate

Initial value:

= array(
        self::SESSION_TYPE_UNKNOWN,
        self::SESSION_TYPE_SYSTEM,
        self::SESSION_TYPE_ADMIN
    )

all session types that will be involved when count of sessions will be determined or when idleing sessions will be destroyed

all session types that will be ignored when count of sessions will be determined or when idleing sessions will be destroyed

Definition at line 78 of file class.ilSessionControl.php.

◆ $setting_fields

array ilSessionControl::$setting_fields

staticprivate

Initial value:

= array(
        'session_max_count',
        'session_min_idle',
        'session_max_idle',
        'session_max_idle_after_first_request',
        'session_allow_client_maintenance',
        'session_handling_type'
    )

all fieldnames that are saved in settings table

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

◆ DEFAULT_ALLOW_CLIENT_MAINTENANCE

const ilSessionControl::DEFAULT_ALLOW_CLIENT_MAINTENANCE = 1

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

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

◆ DEFAULT_MAX_COUNT

const ilSessionControl::DEFAULT_MAX_COUNT = 0

default value for settings that have not been defined in setup or administration yet

Definition at line 30 of file class.ilSessionControl.php.

Referenced by ilObjUserFolderGUI\generalSettingsObject(), ilSessionStatistics\getLimitForSlot(), ilSessionStatisticsGUI\renderCurrentBasics(), and ilSessionStatistics\updateLimitLog().

◆ DEFAULT_MAX_IDLE

const ilSessionControl::DEFAULT_MAX_IDLE = 30

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

Referenced by ilSession\_duplicate(), ilObjUserFolderGUI\generalSettingsObject(), ilSession\getIdleValue(), and ilSessionStatisticsGUI\renderCurrentBasics().

◆ DEFAULT_MAX_IDLE_AFTER_FIRST_REQUEST

const ilSessionControl::DEFAULT_MAX_IDLE_AFTER_FIRST_REQUEST = 1

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

Referenced by ilObjUserFolderGUI\generalSettingsObject(), and ilSessionStatisticsGUI\renderCurrentBasics().

◆ DEFAULT_MIN_IDLE

const ilSessionControl::DEFAULT_MIN_IDLE = 15

Definition at line 31 of file class.ilSessionControl.php.

Referenced by ilObjUserFolderGUI\generalSettingsObject(), ilObjSCORMInitData\getIliasScormVars(), ilSCORM13PlayerGUI\getPlayer(), and ilSessionStatisticsGUI\renderCurrentBasics().

◆ SESSION_TYPE_ADMIN

const ilSessionControl::SESSION_TYPE_ADMIN = 2

private

Definition at line 56 of file class.ilSessionControl.php.

◆ SESSION_TYPE_ANONYM

const ilSessionControl::SESSION_TYPE_ANONYM = 4

private

Definition at line 58 of file class.ilSessionControl.php.

◆ SESSION_TYPE_KEY

const ilSessionControl::SESSION_TYPE_KEY = "SessionType"

private

Definition at line 60 of file class.ilSessionControl.php.

◆ SESSION_TYPE_SYSTEM

const ilSessionControl::SESSION_TYPE_SYSTEM = 1

private

Definition at line 55 of file class.ilSessionControl.php.

◆ SESSION_TYPE_UNKNOWN

const ilSessionControl::SESSION_TYPE_UNKNOWN = 0

private

session types from which one is assigned to each session

Definition at line 54 of file class.ilSessionControl.php.

◆ SESSION_TYPE_USER

const ilSessionControl::SESSION_TYPE_USER = 3

private

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

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

Services/Authentication/classes/class.ilSessionControl.php

Static Public Member Functions

Data Fields

Static Public Attributes

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ checkAdministrationPermission()

◆ checkCurrentSessionIsAllowed()

◆ debug()

◆ getExistingSessionCount()

◆ getSettingFields()

◆ handleLoginEvent()

◆ handleLogoutEvent()

◆ isValidSession()

◆ kickFirstRequestAbidencer()

◆ kickOneMinIdleSession()

◆ removeSessionCookie()

Field Documentation

◆ $session_types_controlled

◆ $session_types_not_controlled

◆ $setting_fields

◆ DEFAULT_ALLOW_CLIENT_MAINTENANCE

◆ DEFAULT_MAX_COUNT

◆ DEFAULT_MAX_IDLE

◆ DEFAULT_MAX_IDLE_AFTER_FIRST_REQUEST

◆ DEFAULT_MIN_IDLE

◆ SESSION_TYPE_ADMIN

◆ SESSION_TYPE_ANONYM

◆ SESSION_TYPE_KEY

◆ SESSION_TYPE_SYSTEM

◆ SESSION_TYPE_UNKNOWN

◆ SESSION_TYPE_USER