ilSessionControl Class Reference

Collaboration diagram for ilSessionControl:

Static Public Member Functions
static	checkExpiredSession ()
	checks for possibly expired session should be called from ilAuthUtils::__initAuth() so it's called before session_start() is called More...
static	initSession ()
	mark session with type regarding to the context. More...
static	handleLoginEvent ($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	INTERNAL_DEBUG = false
	this controls the debuggin into a separate logfile (. More...
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
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

Static Public Attributes
static	$session_types_controlled

Static Private Member Functions
static	checkCurrentSessionIsAllowed (ilAuthSession $auth, $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 ($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 ($a_user_id)
	checks wether a given user login relates to an user with administrative permissions More...
static	debug ($a_debug_log_message)
	logs the given debug message in ilLog More...

Static Private Attributes
static	$setting_fields
	all fieldnames that are saved in settings table More...
static	$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

Author

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

Version

$Id$

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

Member Function Documentation

checkAdministrationPermission()

static ilSessionControl::checkAdministrationPermission (   $a_user_id )

staticprivate

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

ilRbacSystem $rbacsystem

Parameters

integer

$a_user_id

Returns

boolean access

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

    {
        if (!(int) $a_user_id) {
            return false;
        }

        global $rbacsystem;

        $access = $rbacsystem->checkAccessOfUser(
            $a_user_id,
            'read,visible',
            SYSTEM_FOLDER_ID
        );

        return $access;
    }

checkCurrentSessionIsAllowed()

static ilSessionControl::checkCurrentSessionIsAllowed ( ilAuthSession  $auth,   $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

ilSetting $ilSetting ilAppEventHandler $ilAppEventHandler

Parameters

ilAuthSession

$a_auth

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

References $_SESSION, $ilSetting, array, ilSessionStatistics\createRawEntry(), ilAuthSession\logout(), ilUtil\redirect(), ilSession\SESSION_CLOSE_LIMIT, ilSession\setClosingContext(), and time.

    {
        global $ilSetting;
        
        $max_sessions = (int) $ilSetting->get('session_max_count', 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(),
                            $_SESSION['SessionType'],
                            time(),
                            $a_user_id
                        );

                        $auth->logout();

                        // Trigger reachedSessionPoolLimit Event
                        global $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:

checkExpiredSession()

static ilSessionControl::checkExpiredSession ( )

static

checks for possibly expired session should be called from ilAuthUtils::__initAuth() so it's called before session_start() is called

ilSetting $ilSetting ilLanguage $lng ilAppEventHandler $ilAppEventHandler

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

References $_COOKIE, $_GET, $ilSetting, $lng, array, isValidSession(), and ilUtil\redirect().

    {
        global $ilSetting;
        
        // do not check session in fixed duration mode
        if ($ilSetting->get('session_handling_type', 0) != 1) {
            return;
        }

        // check for expired sessions makes sense
        // only when public section is not enabled
        // because it is not possible to determine
        // wether the sid cookie relates to a session of an
        // authenticated user or a anonymous user
        // when the session dataset has allready been deleted

        if (!$ilSetting->get("pub_section")) {
            global $lng;

            $sid = null;

            if (!isset($_COOKIE[session_name()]) || !strlen($_COOKIE[session_name()])) {
                self::debug('Browser did not send a sid cookie');
            } else {
                $sid = $_COOKIE[session_name()];

                self::debug('Browser sent sid cookie with value (' . $sid . ')');

                if (!self::isValidSession($sid)) {
                    self::debug('remove session cookie for (' . $sid . ') and trigger event');

                    // raw data will be updated (later) with garbage collection [destroyExpired()]
                    
                    self::removeSessionCookie();

                    // Trigger expiredSessionDetected  Event
                    global $ilAppEventHandler;
                    $ilAppEventHandler->raise(
                        'Services/Authentication',
                        'expiredSessionDetected',
                        array()
                    );

                    ilUtil::redirect('login.php?expired=true' . '&target=' . $_GET['target']);
                }
            }
        }
    }

Here is the call graph for this function:

debug()

static ilSessionControl::debug (   $a_debug_log_message )

staticprivate

logs the given debug message in ilLog

ilLog $ilLog

Parameters

string

$a_debug_log_message

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

References $ilLog, and Monolog\Handler\error_log().

    {
        global $ilLog;

        if (DEVMODE) {
            $ilLog->write($a_debug_log_message, 'message');
        }

        if (self::INTERNAL_DEBUG) {
            error_log($a_debug_log_message . "\n", 3, 'session.log');
        }
    }

Here is the call graph for this function:

getExistingSessionCount()

static ilSessionControl::getExistingSessionCount ( array  $a_types )

static

returns number of valid sessions relating to given session types

ilDB $ilDB

Parameters

array

$a_types

Returns

integer num_sessions

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

References $ilDB, $query, $res, $row, array, ilDBConstants\FETCHMODE_OBJECT, and time.

Referenced by ilSessionStatisticsGUI\renderCurrentBasics().

    {
        global $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));
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);

        return $row->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 507 of file class.ilSessionControl.php.

Referenced by ilSetup\checkClientSessionSettings(), ilSetupGUI\displaySessions(), ilSetup\getSessionSettings(), and ilSetup\setSessionSettings().

    {
        return self::$setting_fields;
    }

Here is the caller graph for this function:

handleLoginEvent()

static ilSessionControl::handleLoginEvent (   $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 160 of file class.ilSessionControl.php.

References $_SESSION, $ilSetting, $type, and ilObjUser\_lookupId().

Referenced by ilAuthFrontend\handleAuthenticationSuccess(), and ilAuthBase\loginObserver().

    {
        global $ilSetting;
        
        require_once 'Services/User/classes/class.ilObjUser.php';
        $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;
        }
        
        $_SESSION['SessionType'] = $type;
        self::debug(__METHOD__ . " --> update sessions type to (" . $type . ")");
                
        // do not handle login event in fixed duration mode
        if ($ilSetting->get('session_handling_type', 0) != 1) {
            return true;
        }
                
        if (in_array($type, self::$session_types_controlled)) {
            return self::checkCurrentSessionIsAllowed($auth_session, $user_id);
        }
    }

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 203 of file class.ilSessionControl.php.

References $_SESSION, and $ilSetting.

Referenced by ilAuthBase\logoutObserver().

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

        self::removeSessionCookie();
    }

Here is the caller graph for this function:

initSession()

static ilSessionControl::initSession ( )

static

mark session with type regarding to the context.

should be called from ilAuthBase::initAuth()

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

References $_SESSION, and $ilSetting.

Referenced by ilAuthBase\initAuth().

    {
        global $ilSetting;
        
        // do not init session type in fixed duration mode
        if ($ilSetting->get('session_handling_type', 0) != 1) {
            return;
        }
        
        if (!isset($_SESSION['SessionType'])) {
            $_SESSION['SessionType'] = self::SESSION_TYPE_UNKNOWN;
            self::debug(__METHOD__ . " --> init session with type (" . $_SESSION['SessionType'] . ")");
        } else {
            self::debug(__METHOD__ . " --> keep sessions type on (" . $_SESSION['SessionType'] . ")");
        }
    }

Here is the caller graph for this function:

isValidSession()

static ilSessionControl::isValidSession (   $a_sid )

staticprivate

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

ilDB $ilDB ilSetting $ilSetting

Parameters

string

$a_sid

Returns

boolean session_valid

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

References $ilDB, $ilSetting, $query, $res, $row, array, and time.

    {
        global $ilDB, $ilSetting;

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

ilDB $ilDB ilSetting $ilSetting

Returns

<type>

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

References $ilDB, $ilSetting, $query, $res, $row, ilSession\_destroy(), array, ilDBConstants\FETCHMODE_OBJECT, ilSession\SESSION_CLOSE_FIRST, and time.

    {
        global $ilDB, $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

ilDB $ilDB ilSetting $ilSetting

Parameters

array

$a_types

Returns

boolean $deletionSuccess

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

References $ilDB, $ilSetting, $query, $res, $row, ilSession\_destroy(), array, ilDBConstants\FETCHMODE_OBJECT, ilSession\SESSION_CLOSE_IDLE, and time.

    {
        global $ilDB, $ilSetting;

        $ts = time();
        $min_idle = (int) $ilSetting->get('session_min_idle', self::DEFAULT_MIN_IDLE) * 60;
        $max_idle = (int) $ilSetting->get('session_max_idle', 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)
        );
        
        while ($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 true;
        }

        self::debug(__METHOD__ . ' --> no min idle session available for deletion');
        
        return false;
    }

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 452 of file class.ilSessionControl.php.

References ilUtil\setCookie().

    {
        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

ilSessionControl::$session_types_controlled

static

Initial value:

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

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

Referenced by ilSession\_writeData(), ilSessionStatistics\getNumberOfActiveRawSessions(), ilSessionStatistics\getRawData(), 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 70 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 34 of file class.ilSessionControl.php.

DEFAULT_ALLOW_CLIENT_MAINTENANCE

const ilSessionControl::DEFAULT_ALLOW_CLIENT_MAINTENANCE = 1

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

Referenced by ilSetup\getSessionSettings(), 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 23 of file class.ilSessionControl.php.

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

DEFAULT_MAX_IDLE

const ilSessionControl::DEFAULT_MAX_IDLE = 30

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

Referenced by ilObjUserFolderGUI\generalSettingsObject(), ilSession\getExpireValue(), ilSession\getIdleValue(), ilSetup\getSessionSettings(), and ilSessionStatisticsGUI\renderCurrentBasics().

DEFAULT_MAX_IDLE_AFTER_FIRST_REQUEST

const ilSessionControl::DEFAULT_MAX_IDLE_AFTER_FIRST_REQUEST = 1

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

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

DEFAULT_MIN_IDLE

const ilSessionControl::DEFAULT_MIN_IDLE = 15

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

Referenced by ilObjUserFolderGUI\generalSettingsObject(), ilObjSCORMInitData\getIliasScormVars(), ilSCORM13Player\getPlayer(), ilSetup\getSessionSettings(), and ilSessionStatisticsGUI\renderCurrentBasics().

INTERNAL_DEBUG

const ilSessionControl::INTERNAL_DEBUG = false

this controls the debuggin into a separate logfile (.

/session.log)

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

SESSION_TYPE_ADMIN

const ilSessionControl::SESSION_TYPE_ADMIN = 2

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

SESSION_TYPE_ANONYM

const ilSessionControl::SESSION_TYPE_ANONYM = 4

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

SESSION_TYPE_SYSTEM

const ilSessionControl::SESSION_TYPE_SYSTEM = 1

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

SESSION_TYPE_UNKNOWN

const ilSessionControl::SESSION_TYPE_UNKNOWN = 0

session types from which one is assigned to each session

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

SESSION_TYPE_USER

const ilSessionControl::SESSION_TYPE_USER = 3

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

---

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

• Services/Authentication/classes/class.ilSessionControl.php