diff options
| -rw-r--r-- | includes/bootstrap.inc | 2 | ||||
| -rw-r--r-- | includes/cache.inc | 21 | ||||
| -rw-r--r-- | includes/session.inc | 110 |
3 files changed, 108 insertions, 25 deletions
diff --git a/includes/bootstrap.inc b/includes/bootstrap.inc index 8b15ab737..9c2e4bad2 100644 --- a/includes/bootstrap.inc +++ b/includes/bootstrap.inc @@ -1028,7 +1028,7 @@ function _drupal_bootstrap($phase) { case DRUPAL_BOOTSTRAP_SESSION: require_once variable_get('session_inc', './includes/session.inc'); - session_set_save_handler('sess_open', 'sess_close', 'sess_read', 'sess_write', 'sess_destroy_sid', 'sess_gc'); + session_set_save_handler('_sess_open', '_sess_close', '_sess_read', '_sess_write', 'sess_destroy_sid', 'sess_gc'); session_start(); break; diff --git a/includes/cache.inc b/includes/cache.inc index 7c17e5484..245726ff6 100644 --- a/includes/cache.inc +++ b/includes/cache.inc @@ -2,14 +2,16 @@ // $Id$ /** - * Return data from the persistent cache. Data may be stored as either plain text or as serialized data. - * cache_get will automatically return unserialized objects and arrays. + * Return data from the persistent cache. Data may be stored as either plain + * text or as serialized data. cache_get will automatically return + * unserialized objects and arrays. * * @param $cid * The cache ID of the data to retrieve. * @param $table - * The table $table to store the data in. Valid core values are 'cache_filter', - * 'cache_menu', 'cache_page', or 'cache' for the default cache. + * The table $table to store the data in. Valid core values are + * 'cache_filter', 'cache_menu', 'cache_page', or 'cache' for + * the default cache. * @return The cache or FALSE on failure. */ function cache_get($cid, $table = 'cache') { @@ -37,7 +39,7 @@ function cache_get($cid, $table = 'cache') { // currently valid for this user before we return it by making sure the // cache entry was created before the timestamp in the current session's // cache timer. The cache variable is loaded into the $user object by - // sess_read() in session.inc. + // _sess_read() in session.inc. else { if ($user->cache > $cache->created) { // This cache data is too old and thus not valid for us, ignore it. @@ -82,11 +84,12 @@ function cache_get($cid, $table = 'cache') { * @param $cid * The cache ID of the data to store. * @param $data - * The data to store in the cache. Complex data types will be automatically serialized before insertion. + * The data to store in the cache. Complex data types will be automatically + * serialized before insertion. * Strings will be stored as plain text and not serialized. * @param $table - * The table $table to store the data in. Valid core values are 'cache_filter', - * 'cache_menu', 'cache_page', or 'cache'. + * The table $table to store the data in. Valid core values are + * 'cache_filter', 'cache_menu', 'cache_page', or 'cache'. * @param $expire * One of the following values: * - CACHE_PERMANENT: Indicates that the item should never be removed unless @@ -149,7 +152,7 @@ function cache_clear_all($cid = NULL, $table = NULL, $wildcard = FALSE) { if (empty($cid)) { if (variable_get('cache_lifetime', 0)) { // We store the time in the current user's $user->cache variable which - // will be saved into the sessions table by sess_write(). We then + // will be saved into the sessions table by _sess_write(). We then // simulate that the cache was flushed for this user by not returning // cached data that was cached before the timestamp. $user->cache = $_SERVER['REQUEST_TIME']; diff --git a/includes/session.inc b/includes/session.inc index ba579d5ee..02ab07880 100644 --- a/includes/session.inc +++ b/includes/session.inc @@ -4,31 +4,89 @@ /** * @file * User session handling functions. + * + * The user-level session storage handlers: + * - _sess_open() + * - _sess_close() + * - _sess_read() + * - _sess_write() + * are assigned by session_set_save_handler() in bootstrap.inc and are called + * automatically by PHP. These functions should not be called directly. Session + * data should instead be accessed via the $_SESSION superglobal. + * + * The user-level session storage handlers: + * - sess_destroy_sid() + * - sess_gc() + * are assigned by session_set_save_handler() in bootstrap.inc and are called + * automatically by PHP, but they may safely be called directly. */ -function sess_open($save_path, $session_name) { +/** + * Session handler assigned by session_set_save_handler(). + * + * This function is used to handle any initialization, such as file paths or + * database connections, that is needed before accessing session data. Drupal + * does not need to initialize anything in this function. + * + * This function should not be called directly. + * + * @return + * This function will always return TRUE. +*/ +function _sess_open() { return TRUE; } -function sess_close() { +/** + * Session handler assigned by session_set_save_handler(). + * + * This function is used to close the current session. Because Drupal stores + * session data in the database immediately on write, this function does + * not need to do anything. + * + * This function should not be called directly. + * + * @return + * This function will always return TRUE. +*/ +function _sess_close() { return TRUE; } -function sess_read($key) { +/** + * Session handler assigned by session_set_save_handler(). + * + * This function will be called by PHP to retrieve the current user's + * session data, which is stored in the database. It also loads the + * current user's appropriate roles into the user object. + * + * This function should not be called directly. Session data should + * instead be accessed via the $_SESSION superglobal. + * + * @param $key + * Session ID + * @return + * Either an array of the session data, or an empty string, if no data + * was found or the user is anonymous. +*/ +function _sess_read($key) { global $user; - // Write and Close handlers are called after destructing objects since PHP 5.0.5 + // Write and Close handlers are called after destructing objects + // since PHP 5.0.5. // Thus destructors can use sessions but session handler can't use objects. // So we are moving session closure before destructing objects. register_shutdown_function('session_write_close'); - // Handle the case of first time visitors and clients that don't store cookies (eg. web crawlers). + // Handle the case of first time visitors and clients that don't store + // cookies (eg. web crawlers). if (!isset($_COOKIE[session_name()])) { $user = drupal_anonymous_user(); return ''; } - // Otherwise, if the session is still active, we have a record of the client's session in the database. + // Otherwise, if the session is still active, we have a record of the + // client's session in the database. $user = db_fetch_object(db_query("SELECT u.*, s.* FROM {users} u INNER JOIN {sessions} s ON u.uid = s.uid WHERE s.sid = '%s'", $key)); // We found the client's session record and they are an authenticated user @@ -44,7 +102,8 @@ function sess_read($key) { $user->roles[$role->rid] = $role->name; } } - // We didn't find the client's record (session has expired), or they are an anonymous user. + // We didn't find the client's record (session has expired), or they + // are an anonymous user. else { $session = isset($user->session) ? $user->session : ''; $user = drupal_anonymous_user($session); @@ -53,7 +112,23 @@ function sess_read($key) { return $user->session; } -function sess_write($key, $value) { +/** + * Session handler assigned by session_set_save_handler(). + * + * This function will be called by PHP to store the current user's + * session, which Drupal saves to the database. + * + * This function should not be called directly. Session data should + * instead be accessed via the $_SESSION superglobal. + * + * @param $key + * Session ID + * @param $value + * Serialized array of the session data. + * @return + * This function will always return TRUE. +*/ +function _sess_write($key, $value) { global $user; // If saving of session data is disabled or if the client doesn't have a session, @@ -80,7 +155,8 @@ function sess_write($key, $value) { db_query("UPDATE {sessions} SET uid = %d, cache = %d, hostname = '%s', session = '%s', timestamp = %d WHERE sid = '%s'", $user->uid, isset($user->cache) ? $user->cache : 0, ip_address(), $value, $_SERVER['REQUEST_TIME'], $key); if (db_affected_rows()) { - // Last access time is updated no more frequently than once every 180 seconds. + // Last access time is updated no more frequently + // than once every 180 seconds. // This reduces contention in the users table. if ($user->uid && $_SERVER['REQUEST_TIME'] - $user->access > variable_get('session_write_interval', 180)) { db_query("UPDATE {users} SET access = %d WHERE uid = %d", $_SERVER['REQUEST_TIME'], $user->uid); @@ -101,7 +177,8 @@ function sess_regenerate() { } /** - * Counts how many users have sessions. Can count either anonymous sessions or authenticated sessions. + * Counts how many users have sessions. Can count either anonymous sessions, + * authenticated sessions, or both. * * @param int $timestamp * A Unix timestamp representing a point of time in the past. @@ -118,7 +195,8 @@ function sess_count($timestamp = 0, $anonymous = true) { } /** - * Called by PHP session handling with the PHP session ID to end a user's session. + * Called by PHP session handling with the PHP session ID + * to end a user's session. * * @param string $sid * the session id @@ -151,12 +229,14 @@ function sess_gc($lifetime) { /** * Determine whether to save session data of the current request. * - * This function allows the caller to temporarily disable writing of session data, - * should the request end while performing potentially dangerous operations, such as - * manipulating the global $user object. See http://drupal.org/node/218104 for usage + * This function allows the caller to temporarily disable writing of + * session data, should the request end while performing potentially + * dangerous operations, such as manipulating the global $user object. + * See http://drupal.org/node/218104 for usage * * @param $status - * Disables writing of session data when FALSE, (re-)enables writing when TRUE. + * Disables writing of session data when FALSE, (re-)enables + * writing when TRUE. * @return * FALSE if writing session data has been disabled. Otherwise, TRUE. */ |