phpldapadmin/lib/timeout_functions.php
2009-06-30 20:40:03 +10:00

83 lines
2.9 KiB
PHP

<?php
// $Header: /cvsroot/phpldapadmin/phpldapadmin/lib/timeout_functions.php,v 1.9 2006/01/03 20:39:59 wurley Exp $
/**
* A collection of functions used throughout phpLDAPadmin for the timeout and automatic logout feature
* @author Samuel Tran
* @package phpLDAPadmin
*
*/
/**
* Responsible for setting/updating two session-vars that are used for the timeout and auto logout feature:
* - "activity" var records the server last activity.
* - "rightframe_server_id" var records the ID of the server active on the right frame.
* where X is the * ID of the server which the user is working on
*
* @param object $ldapserver The LDAPServer object of the server which the user has logged in.
* @return bool
*/
function set_lastactivity($ldapserver) {
if (DEBUG_ENABLED)
debug_log('set_lastactivity(): Entered with (%s)',1,$ldapserver->server_id);
$_SESSION['activity']['server'][$ldapserver->server_id] = time();
$_SESSION['activity']['rightframe_server_id'] = $ldapserver->server_id;
return true;
}
/**
* Remove the session-var "lastactivity_X" set by update_lastactivity()
* where X is the * ID of the server
*
* @param object $ldapserver The LDAPServer object of the server which the user has logged in.
*/
function unset_lastactivity($ldapserver) {
if (DEBUG_ENABLED)
debug_log('unset_lastactivity(): Entered with (%s)',1,$ldapserver->server_id);
if (isset($_SESSION['activity']['server'][$ldapserver->server_id]))
unset($_SESSION['activity']['server'][$ldapserver->server_id]);
}
/**
* Check if custom session timeout has been reached for server $ldapserver.
* If it has:
* - automatically log out user by calling $ldapserver->unsetLoginDN()
* - if $server_id is equal to right frame $server_id, load timeout.php page in the right frame
* - return true
*
* @param object $ldapserver The LDAPServer object of the server which the user has logged in.
* @return bool true on success, false on failure.
*/
function session_timed_out($ldapserver) {
if (DEBUG_ENABLED)
debug_log('session_timed_out(): Entered with (%s)',1,$ldapserver->server_id);
# If session hasn't expired yet
if (isset($_SESSION['activity']['server'][$ldapserver->server_id])) {
# If $session_timeout not defined, use (session_cache_expire() - 1)
if (! isset($ldapserver->session_timeout))
$session_timeout = session_cache_expire()-1;
else
$session_timeout = $ldapserver->session_timeout;
# Get the $last_activity and $rightframe_server_id value
$last_activity = $_SESSION['activity']['server'][$ldapserver->server_id];
# If diff between current time and last activity greater than $session_timeout, log out user
if ((time()-$last_activity) > ($session_timeout*60)) {
if (in_array($ldapserver->auth_type, array('cookie','session'))) {
syslog_notice('Logout for '.$ldapserver->getLoggedInDN());
$ldapserver->unsetLoginDN() or pla_error(_('Could not logout.'));
}
return true;
} else
return false;
}
}