ILIAS  Release_5_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
Static Public Member Functions | Data Fields | Static Protected Member Functions
ilSessionStatistics Class Reference
+ Collaboration diagram for ilSessionStatistics:

Static Public Member Functions

static isActive ()
 Is session statistics active at all?
static createRawEntry ($a_session_id, $a_session_type, $a_timestamp, $a_user_id)
 Create raw data entry.
static closeRawEntry ($a_session_id, $a_context=null, $a_expired_at=null)
 Close raw data entry.
static aggretateRaw ($a_now)
 Aggregate raw session data (older than given time)
static aggregateRawHelper ($a_begin, $a_end)
 Aggregate statistics data for one slot.
static getLastMaxedOut ()
 Get latest slot during which sessions were maxed out.
static getMaxedOutDuration ($a_from, $a_to)
 Get maxed out duration in given timeframe.
static getNumberOfSessionsByType ($a_from, $a_to)
 Get session counters by type (opened, closed)
static getActiveSessions ($a_from, $a_to)
 Get active sessions aggregated data.
static getLastAggregation ()
 Get timestamp of last aggregation.
static getLimitForSlot ($a_timestamp)
 Get max session setting for given timestamp.
static updateLimitLog ($a_new_value)
 Log max session setting.

Data Fields

const SLOT_SIZE = 15

Static Protected Member Functions

static getCurrentSlot ($a_now)
 Get next slot to aggregate.
static getNumberOfActiveRawSessions ($a_time)
 Count number of active sessions at given time.
static getRawData ($a_begin, $a_end)
 Read raw data for timespan.
static createNewAggregationSlot ($a_now)
 Create new slot (using table lock)
static deleteAggregatedRaw ($a_now)
 Remove already aggregated raw data.

Detailed Description

Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

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

Member Function Documentation

static ilSessionStatistics::aggregateRawHelper (   $a_begin,
  $a_end 
)
static

Aggregate statistics data for one slot.

Parameters
timestamp$a_begin
timestamp$a_end

Definition at line 286 of file class.ilSessionStatistics.php.

References $ilDB, $ilSetting, getLimitForSlot(), getNumberOfActiveRawSessions(), ilSession\SESSION_CLOSE_EXPIRE, ilSession\SESSION_CLOSE_FIRST, ilSession\SESSION_CLOSE_IDLE, ilSession\SESSION_CLOSE_LIMIT, ilSession\SESSION_CLOSE_LOGIN, and ilSession\SESSION_CLOSE_USER.

Referenced by aggretateRaw().

{
global $ilDB, $ilSetting;
// "relevant" closing types
$separate_closed = array(ilSession::SESSION_CLOSE_USER,
ilSession::SESSION_CLOSE_EXPIRE,
ilSession::SESSION_CLOSE_IDLE,
ilSession::SESSION_CLOSE_FIRST,
ilSession::SESSION_CLOSE_LIMIT,
ilSession::SESSION_CLOSE_LOGIN);
// gather/process data (build event timeline)
$closed_counter = $events = array();
$opened_counter = 0;
foreach(self::getRawData($a_begin, $a_end) as $item)
{
// open/close counters are _not_ time related
// we could filter for undefined/invalid closing contexts
// and ignore those items, but this would make any debugging
// close to impossible
// "closed_other" would have been a good idea...
// session opened
if($item["start_time"] >= $a_begin)
{
$opened_counter++;
$events[$item["start_time"]][] = 1;
}
// session closed
if($item["end_time"] && $item["end_time"] <= $a_end)
{
if(in_array($item["end_context"], $separate_closed))
{
$closed_counter[$item["end_context"]]++;
}
else
{
$closed_counter[0]++;
}
$events[$item["end_time"]][] = -1;
}
}
// initialising active statistical values
$active_begin = self::getNumberOfActiveRawSessions($a_begin-1);
$active_end = $active_min = $active_max = $active_avg = $active_begin;
// parsing events / building avergages
if(sizeof($events))
{
$last_update_avg = $a_begin-1;
$slot_seconds = self::SLOT_SIZE*60;
$active_avg = 0;
// parse all open/closing events
ksort($events);
foreach($events as $ts => $actions)
{
// actions which occur in the same second are "merged"
foreach($actions as $action)
{
// max
if($action > 0)
{
$active_end++;
}
// min
else
{
$active_end--;
}
}
// max
if($active_end > $active_max)
{
$active_max = $active_end;
}
// min
if($active_end < $active_min)
{
$active_min = $active_end;
}
// avg
$diff = $ts-$last_update_avg;
$active_avg += $diff/$slot_seconds*$active_end;
$last_update_avg = $ts;
}
unset($actions);
// add up to end of slot if needed
if($last_update_avg < $a_end)
{
$diff = $a_end-$last_update_avg;
$active_avg += $diff/$slot_seconds*$active_end;
}
$active_avg = round($active_avg);
}
unset($events);
// do we (really) need a log here?
// $max_sessions = (int)$ilSetting->get("session_max_count", ilSessionControl::DEFAULT_MAX_COUNT);
$max_sessions = self::getLimitForSlot($a_begin);
// save aggregated data
$fields = array(
"active_min" => array("integer", $active_min),
"active_max" => array("integer", $active_max),
"active_avg" => array("integer", $active_avg),
"active_end" => array("integer", $active_end),
"opened" => array("integer", $opened_counter),
"closed_manual" => array("integer", (int)$closed_counter[ilSession::SESSION_CLOSE_USER]),
"closed_expire" => array("integer", (int)$closed_counter[ilSession::SESSION_CLOSE_EXPIRE]),
"closed_idle" => array("integer", (int)$closed_counter[ilSession::SESSION_CLOSE_IDLE]),
"closed_idle_first" => array("integer", (int)$closed_counter[ilSession::SESSION_CLOSE_FIRST]),
"closed_limit" => array("integer", (int)$closed_counter[ilSession::SESSION_CLOSE_LIMIT]),
"closed_login" => array("integer", (int)$closed_counter[ilSession::SESSION_CLOSE_LOGIN]),
"closed_misc" => array("integer", (int)$closed_counter[0]),
"max_sessions" => array("integer", (int)$max_sessions)
);
$ilDB->update("usr_session_stats", $fields,
array("slot_begin" => array("integer", $a_begin),
"slot_end" => array("integer", $a_end)));
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static ilSessionStatistics::aggretateRaw (   $a_now)
static

Aggregate raw session data (older than given time)

Parameters
integer$a_now

Definition at line 262 of file class.ilSessionStatistics.php.

References aggregateRawHelper(), createNewAggregationSlot(), and deleteAggregatedRaw().

Referenced by ilSession\_writeData(), and ilSessionStatisticsGUI\adminSync().

{
if(!self::isActive())
{
return;
}
$slot = self::createNewAggregationSlot($a_now);
while(is_array($slot))
{
self::aggregateRawHelper($slot[0], $slot[1]);
$slot = self::createNewAggregationSlot($a_now);
}
// #12728
self::deleteAggregatedRaw($a_now);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static ilSessionStatistics::closeRawEntry (   $a_session_id,
  $a_context = null,
  $a_expired_at = null 
)
static

Close raw data entry.

Parameters
int | array$a_session_id
int$a_context
int | bool$a_expired_at

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

References $ilDB.

Referenced by ilSession\_destroy().

{
global $ilDB;
if(!self::isActive())
{
return;
}
// single entry
if(!is_array($a_session_id))
{
if($a_expired_at)
{
$end_time = $a_expired_at;
}
else
{
$end_time = time();
}
$sql = "UPDATE usr_session_stats_raw".
" SET end_time = ".$ilDB->quote($end_time, "integer");
if($a_context)
{
$sql .= ",end_context = ".$ilDB->quote($a_context, "integer");
}
$sql .= " WHERE session_id = ".$ilDB->quote($a_session_id, "text").
" AND end_time IS NULL";
$ilDB->manipulate($sql);
}
// batch closing
else if(!$a_expired_at)
{
$sql = "UPDATE usr_session_stats_raw".
" SET end_time = ".$ilDB->quote(time(), "integer");
if($a_context)
{
$sql .= ",end_context = ".$ilDB->quote($a_context, "integer");
}
$sql .= " WHERE ".$ilDB->in("session_id", $a_session_id, false, "text").
" AND end_time IS NULL";
$ilDB->manipulate($sql);
}
// batch with individual timestamps
else
{
foreach($a_session_id as $id => $ts)
{
$sql = "UPDATE usr_session_stats_raw".
" SET end_time = ".$ilDB->quote($ts, "integer");
if($a_context)
{
$sql .= ",end_context = ".$ilDB->quote($a_context, "integer");
}
$sql .= " WHERE session_id = ".$ilDB->quote($id, "text").
" AND end_time IS NULL";
$ilDB->manipulate($sql);
}
}
}

+ Here is the caller graph for this function:

static ilSessionStatistics::createNewAggregationSlot (   $a_now)
staticprotected

Create new slot (using table lock)

Parameters
integer$a_now
Returns
array begin, end

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

References $ilDB, getCurrentSlot(), and ilDB\LOCK_WRITE.

Referenced by aggretateRaw().

{
global $ilDB;
// get exclusive lock
$ilDB->lockTables(array(array("name"=>"usr_session_stats", "type"=>ilDB::LOCK_WRITE)));
// if we had to wait for the lock, no current slot should be returned here
$slot = self::getCurrentSlot($a_now);
if(!is_array($slot))
{
$ilDB->unlockTables();
return false;
}
// save slot to mark as taken
$fields = array(
"slot_begin" => array("integer", $slot[0]),
"slot_end" => array("integer", $slot[1]),
);
$ilDB->insert("usr_session_stats", $fields);
$ilDB->unlockTables();
return $slot;
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

static ilSessionStatistics::createRawEntry (   $a_session_id,
  $a_session_type,
  $a_timestamp,
  $a_user_id 
)
static

Create raw data entry.

Parameters
int$a_session_id
int$a_session_type
int$a_timestamp
int$a_user_id

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

References $ilDB.

Referenced by ilSession\_writeData(), and ilSessionControl\checkCurrentSessionIsAllowed().

{
global $ilDB;
if(!$a_user_id || !$a_session_id || !self::isActive())
{
return;
}
// #9669: if a session was destroyed and somehow the session id is still
// in use there will be a id-collision for the raw-entry
$ilDB->replace(
"usr_session_stats_raw",
array(
"session_id" => array("text", $a_session_id)
),
array(
"type" => array("integer", $a_session_type),
"start_time" => array("integer", $a_timestamp),
"user_id" => array("integer", $a_user_id)
)
);
}

+ Here is the caller graph for this function:

static ilSessionStatistics::deleteAggregatedRaw (   $a_now)
staticprotected

Remove already aggregated raw data.

Parameters
integer$a_now

Definition at line 422 of file class.ilSessionStatistics.php.

References $ilDB.

Referenced by aggretateRaw().

{
global $ilDB;
// we are rather defensive here - 7 days BEFORE current aggregation
$cut = $a_now-(60*60*24*7);
$ilDB->manipulate("DELETE FROM usr_session_stats_raw".
" WHERE start_time <= ".$ilDB->quote($cut, "integer"));
}

+ Here is the caller graph for this function:

static ilSessionStatistics::getActiveSessions (   $a_from,
  $a_to 
)
static

Get active sessions aggregated data.

Parameters
int$a_from
int$a_to
Returns
array

Definition at line 506 of file class.ilSessionStatistics.php.

References $ilDB, $res, and $row.

Referenced by ilSessionStatisticsGUI\buildData().

{
global $ilDB;
$sql = "SELECT slot_begin, slot_end, active_min, active_max, active_avg,".
" max_sessions".
" FROM usr_session_stats".
" WHERE slot_end > ".$ilDB->quote($a_from, "integer").
" AND slot_begin < ".$ilDB->quote($a_to, "integer").
" ORDER BY slot_begin";
$res = $ilDB->query($sql);
$all = array();
while($row = $ilDB->fetchAssoc($res))
{
$all[] = $row;
}
return $all;
}

+ Here is the caller graph for this function:

static ilSessionStatistics::getCurrentSlot (   $a_now)
staticprotected

Get next slot to aggregate.

Parameters
integer$a_now
Returns
array begin, end

Definition at line 139 of file class.ilSessionStatistics.php.

References $ilDB, $res, $row, and SLOT_SIZE.

Referenced by createNewAggregationSlot().

{
global $ilDB;
// get latest slot in db
$sql = "SELECT MAX(slot_end) previous_slot_end".
" FROM usr_session_stats";
$res = $ilDB->query($sql);
$row = $ilDB->fetchAssoc($res);
$previous_slot_end = $row["previous_slot_end"];
// no previous slot? calculate last complete slot
// should we use minimum session raw date instead? (problem: table lock)
if(!$previous_slot_end)
{
$slot = floor(date("i")/self::SLOT_SIZE);
// last slot of previous hour
if(!$slot)
{
$current_slot_begin = mktime(date("H", $a_now)-1, 60-self::SLOT_SIZE, 0);
}
// "normalize" to slot
else
{
$current_slot_begin = mktime(date("H", $a_now), ($slot-1)*self::SLOT_SIZE, 0);
}
}
else
{
$current_slot_begin = $previous_slot_end+1;
}
$current_slot_end = $current_slot_begin+(60*self::SLOT_SIZE)-1;
// no complete slot: nothing to do yet
if($current_slot_end < $a_now)
{
return array($current_slot_begin, $current_slot_end);
}
}

+ Here is the caller graph for this function:

static ilSessionStatistics::getLastAggregation ( )
static

Get timestamp of last aggregation.

Returns
timestamp

Definition at line 530 of file class.ilSessionStatistics.php.

References $ilDB, $res, and $row.

Referenced by ilSessionStatisticsGUI\renderCurrentBasics().

{
global $ilDB;
$sql = "SELECT max(slot_end) latest FROM usr_session_stats";
$res = $ilDB->query($sql);
$row = $ilDB->fetchAssoc($res);
if($row["latest"])
{
return $row["latest"];
}
}

+ Here is the caller graph for this function:

static ilSessionStatistics::getLastMaxedOut ( )
static

Get latest slot during which sessions were maxed out.

Returns
int timestamp

Definition at line 438 of file class.ilSessionStatistics.php.

References $ilDB, $res, and $row.

Referenced by ilSessionStatisticsGUI\renderCurrentBasics().

{
global $ilDB;
$sql = "SELECT max(slot_end) latest FROM usr_session_stats".
" WHERE active_max >= max_sessions".
" AND max_sessions > ".$ilDB->quote(0, "integer");
$res = $ilDB->query($sql);
$row = $ilDB->fetchAssoc($res);
if($row["latest"])
{
return $row["latest"];
}
}

+ Here is the caller graph for this function:

static ilSessionStatistics::getLimitForSlot (   $a_timestamp)
static

Get max session setting for given timestamp.

Parameters
timestamp$a_timestamp
Returns
int

Definition at line 549 of file class.ilSessionStatistics.php.

References $ilDB, $ilSetting, $res, and ilSessionControl\DEFAULT_MAX_COUNT.

Referenced by aggregateRawHelper().

{
global $ilDB, $ilSetting;
$ilDB->setLimit(1);
$sql = "SELECT maxval FROM usr_session_log".
" WHERE tstamp <= ".$ilDB->quote($a_timestamp, "integer").
" ORDER BY tstamp DESC";
$res = $ilDB->query($sql);
$val = $ilDB->fetchAssoc($res);
if($val["maxval"])
{
return (int)$val["maxval"];
}
else
{
return (int)$ilSetting->get("session_max_count", ilSessionControl::DEFAULT_MAX_COUNT);
}
}

+ Here is the caller graph for this function:

static ilSessionStatistics::getMaxedOutDuration (   $a_from,
  $a_to 
)
static

Get maxed out duration in given timeframe.

Parameters
int$a_from
int$a_to
Returns
int seconds

Definition at line 460 of file class.ilSessionStatistics.php.

References $ilDB, $res, and $row.

Referenced by ilSessionStatisticsGUI\buildData().

{
global $ilDB;
$sql = "SELECT SUM(slot_end-slot_begin) dur FROM usr_session_stats".
" WHERE active_max >= max_sessions".
" AND max_sessions > ".$ilDB->quote(0, "integer").
" AND slot_end > ".$ilDB->quote($a_from, "integer").
" AND slot_begin < ".$ilDB->quote($a_to, "integer");
$res = $ilDB->query($sql);
$row = $ilDB->fetchAssoc($res);
if($row["dur"])
{
return $row["dur"];
}
}

+ Here is the caller graph for this function:

static ilSessionStatistics::getNumberOfActiveRawSessions (   $a_time)
staticprotected

Count number of active sessions at given time.

Parameters
integer$a_time
Returns
integer

Definition at line 186 of file class.ilSessionStatistics.php.

References $ilDB, $res, $row, and ilSessionControl\$session_types_controlled.

Referenced by aggregateRawHelper().

{
global $ilDB;
$sql = "SELECT COUNT(*) counter FROM usr_session_stats_raw".
" WHERE (end_time IS NULL OR end_time >= ".$ilDB->quote($a_time, "integer").")".
" AND start_time <= ".$ilDB->quote($a_time, "integer").
" AND ".$ilDB->in("type", ilSessionControl::$session_types_controlled, false, "integer");
$res = $ilDB->query($sql);
$row = $ilDB->fetchAssoc($res);
return $row["counter"];
}

+ Here is the caller graph for this function:

static ilSessionStatistics::getNumberOfSessionsByType (   $a_from,
  $a_to 
)
static

Get session counters by type (opened, closed)

Parameters
int$a_from
int$a_to
Returns
array

Definition at line 484 of file class.ilSessionStatistics.php.

References $ilDB, and $res.

Referenced by ilSessionStatisticsGUI\buildData().

{
global $ilDB;
$sql = "SELECT SUM(opened) opened, SUM(closed_manual) closed_manual,".
" SUM(closed_expire) closed_expire, SUM(closed_idle) closed_idle,".
" SUM(closed_idle_first) closed_idle_first, SUM(closed_limit) closed_limit,".
" SUM(closed_login) closed_login, SUM(closed_misc) closed_misc".
" FROM usr_session_stats".
" WHERE slot_end > ".$ilDB->quote($a_from, "integer").
" AND slot_begin < ".$ilDB->quote($a_to, "integer");
$res = $ilDB->query($sql);
return $ilDB->fetchAssoc($res);
}

+ Here is the caller graph for this function:

static ilSessionStatistics::getRawData (   $a_begin,
  $a_end 
)
staticprotected

Read raw data for timespan.

Parameters
integer$a_begin
integer$a_end
Returns
array

Definition at line 206 of file class.ilSessionStatistics.php.

References $ilDB, $res, $row, and ilSessionControl\$session_types_controlled.

{
global $ilDB;
$sql = "SELECT start_time,end_time,end_context FROM usr_session_stats_raw".
" WHERE start_time <= ".$ilDB->quote($a_end, "integer").
" AND (end_time IS NULL OR end_time >= ".$ilDB->quote($a_begin, "integer").")".
" AND ".$ilDB->in("type", ilSessionControl::$session_types_controlled, false, "integer").
" ORDER BY start_time";
$res = $ilDB->query($sql);
$all = array();
while($row = $ilDB->fetchAssoc($res))
{
$all[] = $row;
}
return $all;
}
static ilSessionStatistics::isActive ( )
static

Is session statistics active at all?

Returns
bool

Definition at line 20 of file class.ilSessionStatistics.php.

References $ilSetting.

{
global $ilSetting;
return (bool)$ilSetting->get('session_statistics', 1);
/* #13566 - includes somehow won't work this late in the request - doing it directly
include_once "Services/Tracking/classes/class.ilObjUserTracking.php";
return ilObjUserTracking::_enabledSessionStatistics();
*/
}
static ilSessionStatistics::updateLimitLog (   $a_new_value)
static

Log max session setting.

Parameters
int$a_new_value

Definition at line 574 of file class.ilSessionStatistics.php.

References $ilDB, $ilSetting, $ilUser, and ilSessionControl\DEFAULT_MAX_COUNT.

Referenced by ilObjUserFolderGUI\saveGeneralSettingsObject().

{
global $ilDB, $ilSetting, $ilUser;
$new_value = (int)$a_new_value;
$old_value = (int)$ilSetting->get("session_max_count", ilSessionControl::DEFAULT_MAX_COUNT);
if($new_value != $old_value)
{
$fields = array(
"tstamp" => array("timestamp", time()),
"maxval" => array("integer", $new_value),
"user_id" => array("integer", $ilUser->getId())
);
$ilDB->insert("usr_session_log", $fields);
}
}

+ Here is the caller graph for this function:

Field Documentation

const ilSessionStatistics::SLOT_SIZE = 15

Definition at line 13 of file class.ilSessionStatistics.php.

Referenced by getCurrentSlot().

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