includes/session.inc

   1 <?php
   2 // $Id: session.inc 144 2007-03-28 07:52:20Z thierry $
   3
   4 /**
   5  * @file
   6  * User session handling functions.
   7  */
   8
   9 function sess_open($save_path, $session_name) {
  10   return TRUE;
  11 }
  12
  13 function sess_close() {
  14   return TRUE;
  15 }
  16
  17 function sess_read($key) {
  18   global $user;
  19
  20   // retrieve data for a $user object
  21   $result = db_query("SELECT sid FROM {sessions} WHERE sid = '%s'", $key);
  22   if (!db_num_rows($result)) {
  23     $result = db_query("SELECT u.* FROM {users} u WHERE u.uid = 0");
  24   }
  25   else {
  26     $result = db_query("SELECT u.*, s.* FROM {users} u INNER JOIN {sessions} s ON u.uid = s.uid WHERE s.sid = '%s'", $key);
  27   }
  28
  29   // Build $user object:
  30   $user = db_fetch_object($result);
  31   $user = drupal_unpack($user);
  32
  33   // Add roles element to $user:
  34   $user->roles = array();
  35   if ($user->uid) {
  36     $user->roles[DRUPAL_AUTHENTICATED_RID] = 'authenticated user';
  37
  38     $result = db_query("SELECT r.rid, r.name FROM {role} r INNER JOIN {users_roles} ur ON ur.rid = r.rid WHERE ur.uid = %d", $user->uid);
  39     while ($role = db_fetch_object($result)) {
  40       $user->roles[$role->rid] = $role->name;
  41     }
  42   }
  43   else {
  44     $user->roles[DRUPAL_ANONYMOUS_RID] = 'anonymous user';
  45   }
  46
  47   return !empty($user->session) ? $user->session : '';
  48 }
  49
  50 function sess_write($key, $value) {
  51   global $user;
  52
  53   $result = db_query("SELECT sid FROM {sessions} WHERE sid = '%s'", $key);
  54
  55   if (!db_num_rows($result)) {
  56     // Only save session data when when the browser sends a cookie.  This keeps
  57     // crawlers out of session table. This improves speed up queries, reduces
  58     // memory, and gives more useful statistics. We can't eliminate anonymous
  59     // session table rows without breaking throttle module and "Who's Online"
  60     // block.
  61     if ($user->uid || $value || count($_COOKIE)) {
  62       db_query("INSERT INTO {sessions} (sid, uid, cache, hostname, session, timestamp) VALUES ('%s', %d, %d, '%s', '%s', %d)", $key, $user->uid, $user->cache, $_SERVER["REMOTE_ADDR"], $value, time());
  63     }
  64   }
  65   else {
  66     db_query("UPDATE {sessions} SET uid = %d, cache = %d, hostname = '%s', session = '%s', timestamp = %d WHERE sid = '%s'", $user->uid, $user->cache, $_SERVER["REMOTE_ADDR"], $value, time(), $key);
  67
  68     // TODO: this can be an expensive query. Perhaps only execute it every x minutes. Requires investigation into cache expiration.
  69     if ($user->uid) {
  70       db_query("UPDATE {users} SET access = %d WHERE uid = %d", time(), $user->uid);
  71     }
  72   }
  73
  74   return TRUE;
  75 }
  76
  77 function sess_destroy($key) {
  78   db_query("DELETE FROM {sessions} WHERE sid = '%s'", $key);
  79 }
  80
  81 function sess_gc($lifetime) {
  82   // Be sure to adjust 'php_value session.gc_maxlifetime' to a large enough
  83   // value.  For example, if you want user sessions to stay in your database
  84   // for three weeks before deleting them, you need to set gc_maxlifetime
  85   // to '1814400'.  At that value, only after a user doesn't log in after
  86   // three weeks (1814400 seconds) will his/her session be removed.
  87   db_query("DELETE FROM {sessions} WHERE timestamp < %d", time() - $lifetime);
  88
  89   return TRUE;
  90 }
  91