classes/Session.php

   1 <?php
   2 /**
   3  * Table Definition for session
   4  *
   5  * StatusNet - the distributed open-source microblogging tool
   6  * Copyright (C) 2009, StatusNet, Inc.
   7  *
   8  * This program is free software: you can redistribute it and/or modify
   9  * it under the terms of the GNU Affero General Public License as published by
  10  * the Free Software Foundation, either version 3 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU Affero General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Affero General Public License
  19  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  */
  21
  22 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
  23
  24 require_once INSTALLDIR.'/classes/Memcached_DataObject.php';
  25
  26 class Session extends Memcached_DataObject
  27 {
  28     ###START_AUTOCODE
  29     /* the code below is auto generated do not remove the above tag */
  30
  31     public $__table = 'session';                         // table name
  32     public $id;                              // varchar(32)  primary_key not_null
  33     public $session_data;                    // text()
  34     public $created;                         // datetime()   not_null
  35     public $modified;                        // timestamp()   not_null default_CURRENT_TIMESTAMP
  36
  37     /* Static get */
  38     function staticGet($k,$v=NULL) { return Memcached_DataObject::staticGet('Session',$k,$v); }
  39
  40     /* the code above is auto generated do not remove the tag below */
  41     ###END_AUTOCODE
  42
  43     static function logdeb($msg)
  44     {
  45         if (common_config('sessions', 'debug')) {
  46             common_debug("Session: " . $msg);
  47         }
  48     }
  49
  50     static function open($save_path, $session_name)
  51     {
  52         return true;
  53     }
  54
  55     static function close()
  56     {
  57         return true;
  58     }
  59
  60     static function read($id)
  61     {
  62         self::logdeb("Fetching session '$id'");
  63
  64         $session = Session::staticGet('id', $id);
  65
  66         if (empty($session)) {
  67             self::logdeb("Couldn't find '$id'");
  68             return '';
  69         } else {
  70             self::logdeb("Found '$id', returning " .
  71                          strlen($session->session_data) .
  72                          " chars of data");
  73             return (string)$session->session_data;
  74         }
  75     }
  76
  77     static function write($id, $session_data)
  78     {
  79         self::logdeb("Writing session '$id'");
  80
  81         $session = Session::staticGet('id', $id);
  82
  83         if (empty($session)) {
  84             self::logdeb("'$id' doesn't yet exist; inserting.");
  85             $session = new Session();
  86
  87             $session->id           = $id;
  88             $session->session_data = $session_data;
  89             $session->created      = common_sql_now();
  90
  91             $result = $session->insert();
  92
  93             if (!$result) {
  94                 common_log_db_error($session, 'INSERT', __FILE__);
  95                 self::logdeb("Failed to insert '$id'.");
  96             } else {
  97                 self::logdeb("Successfully inserted '$id' (result = $result).");
  98             }
  99             return $result;
 100         } else {
 101             self::logdeb("'$id' already exists; updating.");
 102             if (strcmp($session->session_data, $session_data) == 0) {
 103                 self::logdeb("Not writing session '$id'; unchanged");
 104                 return true;
 105             } else {
 106                 self::logdeb("Session '$id' data changed; updating");
 107
 108                 $orig = clone($session);
 109
 110                 $session->session_data = $session_data;
 111
 112                 $result = $session->update($orig);
 113
 114                 if (!$result) {
 115                     common_log_db_error($session, 'UPDATE', __FILE__);
 116                     self::logdeb("Failed to update '$id'.");
 117                 } else {
 118                     self::logdeb("Successfully updated '$id' (result = $result).");
 119                 }
 120
 121                 return $result;
 122             }
 123         }
 124     }
 125
 126     static function destroy($id)
 127     {
 128         self::logdeb("Deleting session $id");
 129
 130         $session = Session::staticGet('id', $id);
 131
 132         if (empty($session)) {
 133             self::logdeb("Can't find '$id' to delete.");
 134         } else {
 135             $result = $session->delete();
 136             if (!$result) {
 137                 common_log_db_error($session, 'DELETE', __FILE__);
 138                 self::logdeb("Failed to delete '$id'.");
 139             } else {
 140                 self::logdeb("Successfully deleted '$id' (result = $result).");
 141             }
 142             return $result;
 143         }
 144     }
 145
 146     static function gc($maxlifetime)
 147     {
 148         self::logdeb("garbage collection (maxlifetime = $maxlifetime)");
 149
 150         $epoch = common_sql_date(time() - $maxlifetime);
 151
 152         $ids = array();
 153
 154         $session = new Session();
 155         $session->whereAdd('modified < "'.$epoch.'"');
 156         $session->selectAdd();
 157         $session->selectAdd('id');
 158
 159         $limit = common_config('sessions', 'gc_limit');
 160         if ($limit > 0) {
 161             // On large sites, too many sessions to expire
 162             // at once will just result in failure.
 163             $session->limit($limit);
 164         }
 165
 166         $session->find();
 167
 168         while ($session->fetch()) {
 169             $ids[] = $session->id;
 170         }
 171
 172         $session->free();
 173
 174         self::logdeb("Found " . count($ids) . " ids to delete.");
 175
 176         foreach ($ids as $id) {
 177             self::logdeb("Destroying session '$id'.");
 178             self::destroy($id);
 179         }
 180     }
 181
 182     static function setSaveHandler()
 183     {
 184         self::logdeb("setting save handlers");
 185         $result = session_set_save_handler('Session::open', 'Session::close', 'Session::read',
 186                                            'Session::write', 'Session::destroy', 'Session::gc');
 187         self::logdeb("save handlers result = $result");
 188
 189         // PHP 5.3 with APC ends up destroying a bunch of object stuff before the session
 190         // save handlers get called on request teardown.
 191         // Registering an explicit shutdown function should take care of this before
 192         // everything breaks on us.
 193         register_shutdown_function('Session::cleanup');
 194
 195         return $result;
 196     }
 197
 198     static function cleanup()
 199     {
 200         session_write_close();
 201     }
 202 }