interface/main/calendar/pnadodb/adodb-session.php

   1 <?php
   2 /*
   3 V3.60 16 June 2003  (c) 2000-2003 John Lim (jlim@natsoft.com.my). All rights reserved.
   4   Released under both BSD license and Lesser GPL library license.
   5   Whenever there is any discrepancy between the two licenses,
   6   the BSD license will take precedence.
   7           Set tabs to 4 for best viewing.
   8
   9   Latest version of ADODB is available at http://php.weblogs.com/adodb
  10   ======================================================================
  11
  12  This file provides PHP4 session management using the ADODB database
  13 wrapper library.
  14
  15  Example
  16  =======
  17
  18         GLOBAL $HTTP_SESSION_VARS;
  19         include('adodb.inc.php');
  20         include('adodb-session.php');
  21         session_start();
  22         session_register('AVAR');
  23         $HTTP_SESSION_VARS['AVAR'] += 1;
  24         print "<p>\$HTTP_SESSION_VARS['AVAR']={$HTTP_SESSION_VARS['AVAR']}</p>";
  25
  26 To force non-persistent connections, call adodb_session_open first before session_start():
  27
  28         GLOBAL $HTTP_SESSION_VARS;
  29         include('adodb.inc.php');
  30         include('adodb-session.php');
  31         adodb_sess_open(false,false,false);
  32         session_start();
  33         session_register('AVAR');
  34         $HTTP_SESSION_VARS['AVAR'] += 1;
  35         print "<p>\$HTTP_SESSION_VARS['AVAR']={$HTTP_SESSION_VARS['AVAR']}</p>";
  36
  37
  38  Installation
  39  ============
  40  1. Create this table in your database (syntax might vary depending on your db):
  41
  42   create table sessions (
  43            SESSKEY char(32) not null,
  44            EXPIRY int(11) unsigned not null,
  45            EXPIREREF varchar(64),
  46            DATA text not null,
  47           primary key (sesskey)
  48   );
  49
  50
  51   2. Then define the following parameters in this file:
  52         $ADODB_SESSION_DRIVER='database driver, eg. mysql or ibase';
  53         $ADODB_SESSION_CONNECT='server to connect to';
  54         $ADODB_SESSION_USER ='user';
  55         $ADODB_SESSION_PWD ='password';
  56         $ADODB_SESSION_DB ='database';
  57         $ADODB_SESSION_TBL = 'sessions'
  58
  59   3. Recommended is PHP 4.0.6 or later. There are documented
  60          session bugs in earlier versions of PHP.
  61
  62   4. If you want to receive notifications when a session expires, then
  63          you can tag a session with an EXPIREREF, and before the session
  64          record is deleted, we can call a function that will pass the EXPIREREF
  65          as the first parameter, and the session key as the second parameter.
  66
  67          To do this, define a notification function, say NotifyFn:
  68
  69                 function NotifyFn($expireref, $sesskey)
  70                 {
  71                 }
  72
  73          Then define a global variable, with the first parameter being the
  74          global variable you would like to store in the EXPIREREF field, and
  75          the second is the function name.
  76
  77          In this example, we want to be notified when a user's session
  78          has expired, so we store the user id in $USERID, and make this
  79          the value stored in the EXPIREREF field:
  80
  81                 $ADODB_SESSION_EXPIRE_NOTIFY = array('USERID','NotifyFn');
  82 */
  83
  84 if (!defined('_ADODB_LAYER')) {
  85         include (dirname(__FILE__).'/adodb.inc.php');
  86 }
  87
  88 if (!defined('ADODB_SESSION')) {
  89
  90  define('ADODB_SESSION',1);
  91
  92  /* if database time and system time is difference is greater than this, then give warning */
  93  define('ADODB_SESSION_SYNCH_SECS',60);
  94
  95 /****************************************************************************************\
  96         Global definitions
  97 \****************************************************************************************/
  98 GLOBAL  $ADODB_SESSION_CONNECT,
  99         $ADODB_SESSION_DRIVER,
 100         $ADODB_SESSION_USER,
 101         $ADODB_SESSION_PWD,
 102         $ADODB_SESSION_DB,
 103         $ADODB_SESS_CONN,
 104         $ADODB_SESS_LIFE,
 105         $ADODB_SESS_DEBUG,
 106         $ADODB_SESSION_EXPIRE_NOTIFY,
 107         $ADODB_SESSION_CRC;
 108
 109
 110         $ADODB_SESS_LIFE = ini_get('session.gc_maxlifetime');
 111         if ($ADODB_SESS_LIFE <= 1) {
 112          // bug in PHP 4.0.3 pl 1  -- how about other versions?
 113          //print "<h3>Session Error: PHP.INI setting <i>session.gc_maxlifetime</i>not set: $ADODB_SESS_LIFE</h3>";
 114                 $ADODB_SESS_LIFE=1440;
 115         }
 116         $ADODB_SESSION_CRC = false;
 117         //$ADODB_SESS_DEBUG = true;
 118
 119         //////////////////////////////////
 120         /* SET THE FOLLOWING PARAMETERS */
 121         //////////////////////////////////
 122
 123         if (empty($ADODB_SESSION_DRIVER)) {
 124                 $ADODB_SESSION_DRIVER='mysql';
 125                 $ADODB_SESSION_CONNECT='localhost';
 126                 $ADODB_SESSION_USER ='root';
 127                 $ADODB_SESSION_PWD ='';
 128                 $ADODB_SESSION_DB ='xphplens_2';
 129         }
 130
 131         if (empty($ADODB_SESSION_EXPIRE_NOTIFY)) {
 132                 $ADODB_SESSION_EXPIRE_NOTIFY = false;
 133         }
 134         //  Made table name configurable - by David Johnson djohnson@inpro.net
 135         if (empty($ADODB_SESSION_TBL)){
 136                 $ADODB_SESSION_TBL = 'sessions';
 137         }
 138
 139         /*
 140         $ADODB_SESS['driver'] = $ADODB_SESSION_DRIVER;
 141         $ADODB_SESS['connect'] = $ADODB_SESSION_CONNECT;
 142         $ADODB_SESS['user'] = $ADODB_SESSION_USER;
 143         $ADODB_SESS['pwd'] = $ADODB_SESSION_PWD;
 144         $ADODB_SESS['db'] = $ADODB_SESSION_DB;
 145         $ADODB_SESS['life'] = $ADODB_SESS_LIFE;
 146         $ADODB_SESS['debug'] = $ADODB_SESS_DEBUG;
 147
 148         $ADODB_SESS['debug'] = $ADODB_SESS_DEBUG;
 149         $ADODB_SESS['table'] = $ADODB_SESS_TBL;
 150         */
 151
 152 /****************************************************************************************\
 153         Create the connection to the database.
 154
 155         If $ADODB_SESS_CONN already exists, reuse that connection
 156 \****************************************************************************************/
 157 function adodb_sess_open($save_path, $session_name,$persist=true)
 158 {
 159 GLOBAL $ADODB_SESS_CONN;
 160         if (isset($ADODB_SESS_CONN)) return true;
 161
 162 GLOBAL  $ADODB_SESSION_CONNECT,
 163         $ADODB_SESSION_DRIVER,
 164         $ADODB_SESSION_USER,
 165         $ADODB_SESSION_PWD,
 166         $ADODB_SESSION_DB,
 167         $ADODB_SESS_DEBUG;
 168
 169         // cannot use & below - do not know why...
 170         $ADODB_SESS_CONN = ADONewConnection($ADODB_SESSION_DRIVER);
 171         if (!empty($ADODB_SESS_DEBUG)) {
 172                 $ADODB_SESS_CONN->debug = true;
 173                 ADOConnection::outp( " conn=$ADODB_SESSION_CONNECT user=$ADODB_SESSION_USER pwd=$ADODB_SESSION_PWD db=$ADODB_SESSION_DB ");
 174         }
 175         if ($persist) $ok = $ADODB_SESS_CONN->PConnect($ADODB_SESSION_CONNECT,
 176                         $ADODB_SESSION_USER,$ADODB_SESSION_PWD,$ADODB_SESSION_DB);
 177         else $ok = $ADODB_SESS_CONN->Connect($ADODB_SESSION_CONNECT,
 178                         $ADODB_SESSION_USER,$ADODB_SESSION_PWD,$ADODB_SESSION_DB);
 179
 180         if (!$ok) ADOConnection::outp( "<p>Session: connection failed</p>",false);
 181 }
 182
 183 /****************************************************************************************\
 184         Close the connection
 185 \****************************************************************************************/
 186 function adodb_sess_close()
 187 {
 188 global $ADODB_SESS_CONN;
 189
 190         if ($ADODB_SESS_CONN) $ADODB_SESS_CONN->Close();
 191         return true;
 192 }
 193
 194 /****************************************************************************************\
 195         Slurp in the session variables and return the serialized string
 196 \****************************************************************************************/
 197 function adodb_sess_read($key)
 198 {
 199 global $ADODB_SESS_CONN,$ADODB_SESSION_TBL,$ADODB_SESSION_CRC;
 200
 201         $rs = $ADODB_SESS_CONN->Execute("SELECT data FROM $ADODB_SESSION_TBL WHERE sesskey = '$key' AND expiry >= " . time());
 202         if ($rs) {
 203                 if ($rs->EOF) {
 204                         $v = '';
 205                 } else
 206                         $v = rawurldecode(reset($rs->fields));
 207
 208                 $rs->Close();
 209
 210                 // new optimization adodb 2.1
 211                 $ADODB_SESSION_CRC = strlen($v).crc32($v);
 212
 213                 return $v;
 214         }
 215
 216         return ''; // thx to Jorma Tuomainen, webmaster#wizactive.com
 217 }
 218
 219 /****************************************************************************************\
 220         Write the serialized data to a database.
 221
 222         If the data has not been modified since adodb_sess_read(), we do not write.
 223 \****************************************************************************************/
 224 function adodb_sess_write($key, $val)
 225 {
 226         global
 227                 $ADODB_SESS_CONN,
 228                 $ADODB_SESS_LIFE,
 229                 $ADODB_SESSION_TBL,
 230                 $ADODB_SESS_DEBUG,
 231                 $ADODB_SESSION_CRC,
 232                 $ADODB_SESSION_EXPIRE_NOTIFY;
 233
 234         $expiry = time() + $ADODB_SESS_LIFE;
 235
 236         // crc32 optimization since adodb 2.1
 237         // now we only update expiry date, thx to sebastian thom in adodb 2.32
 238         if ($ADODB_SESSION_CRC !== false && $ADODB_SESSION_CRC == strlen($val).crc32($val)) {
 239                 if ($ADODB_SESS_DEBUG) echo "<p>Session: Only updating date - crc32 not changed</p>";
 240                 $qry = "UPDATE $ADODB_SESSION_TBL SET expiry=$expiry WHERE sesskey='$key' AND expiry >= " . time();
 241                 $rs = $ADODB_SESS_CONN->Execute($qry);
 242                 return true;
 243         }
 244         $val = rawurlencode($val);
 245
 246         $arr = array('sesskey' => $key, 'expiry' => $expiry, 'data' => $val);
 247         if ($ADODB_SESSION_EXPIRE_NOTIFY) {
 248                 $var = reset($ADODB_SESSION_EXPIRE_NOTIFY);
 249                 global $$var;
 250                 $arr['expireref'] = $$var;
 251         }
 252         $rs = $ADODB_SESS_CONN->Replace($ADODB_SESSION_TBL,$arr,
 253         'sesskey',$autoQuote = true);
 254
 255         if (!$rs) {
 256                 ADOConnection::outp( '<p>Session Replace: '.$ADODB_SESS_CONN->ErrorMsg().'</p>',false);
 257         }  else {
 258                 // bug in access driver (could be odbc?) means that info is not commited
 259                 // properly unless select statement executed in Win2000
 260                 if ($ADODB_SESS_CONN->databaseType == 'access')
 261                         $rs = $ADODB_SESS_CONN->Execute("select sesskey from $ADODB_SESSION_TBL WHERE sesskey='$key'");
 262         }
 263         return !empty($rs);
 264 }
 265
 266 function adodb_sess_destroy($key)
 267 {
 268         global $ADODB_SESS_CONN, $ADODB_SESSION_TBL,$ADODB_SESSION_EXPIRE_NOTIFY;
 269
 270         if ($ADODB_SESSION_EXPIRE_NOTIFY) {
 271                 reset($ADODB_SESSION_EXPIRE_NOTIFY);
 272                 $fn = next($ADODB_SESSION_EXPIRE_NOTIFY);
 273                 $savem = $ADODB_SESS_CONN->SetFetchMode(ADODB_FETCH_NUM);
 274                 $rs = $ADODB_SESS_CONN->Execute("SELECT expireref,sesskey FROM $ADODB_SESSION_TBL WHERE sesskey='$key'");
 275                 $ADODB_SESS_CONN->SetFetchMode($savem);
 276                 if ($rs) {
 277                         $ADODB_SESS_CONN->BeginTrans();
 278                         while (!$rs->EOF) {
 279                                 $ref = $rs->fields[0];
 280                                 $key = $rs->fields[1];
 281                                 $fn($ref,$key);
 282                                 $del = $ADODB_SESS_CONN->Execute("DELETE FROM $ADODB_SESSION_TBL WHERE sesskey='$key'");
 283                                 $rs->MoveNext();
 284                         }
 285                         $ADODB_SESS_CONN->CommitTrans();
 286                 }
 287         } else {
 288                 $qry = "DELETE FROM $ADODB_SESSION_TBL WHERE sesskey = '$key'";
 289                 $rs = $ADODB_SESS_CONN->Execute($qry);
 290         }
 291         return $rs ? true : false;
 292 }
 293
 294 function adodb_sess_gc($maxlifetime)
 295 {
 296         global $ADODB_SESS_DEBUG, $ADODB_SESS_CONN, $ADODB_SESSION_TBL,$ADODB_SESSION_EXPIRE_NOTIFY;
 297
 298         if ($ADODB_SESSION_EXPIRE_NOTIFY) {
 299                 reset($ADODB_SESSION_EXPIRE_NOTIFY);
 300                 $fn = next($ADODB_SESSION_EXPIRE_NOTIFY);
 301                 $savem = $ADODB_SESS_CONN->SetFetchMode(ADODB_FETCH_NUM);
 302                 $rs = $ADODB_SESS_CONN->Execute("SELECT expireref,sesskey FROM $ADODB_SESSION_TBL WHERE expiry < " . time());
 303                 $ADODB_SESS_CONN->SetFetchMode($savem);
 304                 if ($rs) {
 305                         $ADODB_SESS_CONN->BeginTrans();
 306                         while (!$rs->EOF) {
 307                                 $ref = $rs->fields[0];
 308                                 $key = $rs->fields[1];
 309                                 $fn($ref,$key);
 310                                 $del = $ADODB_SESS_CONN->Execute("DELETE FROM $ADODB_SESSION_TBL WHERE sesskey='$key'");
 311                                 $rs->MoveNext();
 312                         }
 313                         $ADODB_SESS_CONN->CommitTrans();
 314                 }
 315         } else {
 316                 $qry = "DELETE FROM $ADODB_SESSION_TBL WHERE expiry < " . time();
 317                 $ADODB_SESS_CONN->Execute($qry);
 318
 319                 if ($ADODB_SESS_DEBUG) ADOConnection::outp("<p><b>Garbage Collection</b>: $qry</p>");
 320         }
 321         // suggested by Cameron, "GaM3R" <gamr@outworld.cx>
 322         if (defined('ADODB_SESSION_OPTIMIZE')) {
 323         global $ADODB_SESSION_DRIVER;
 324
 325                 switch( $ADODB_SESSION_DRIVER ) {
 326                         case 'mysql':
 327                         case 'mysqlt':
 328                                 $opt_qry = 'OPTIMIZE TABLE '.$ADODB_SESSION_TBL;
 329                                 break;
 330                         case 'postgresql':
 331                         case 'postgresql7':
 332                                 $opt_qry = 'VACUUM '.$ADODB_SESSION_TBL;
 333                                 break;
 334                 }
 335                 if (!empty($opt_qry)) {
 336                         $ADODB_SESS_CONN->Execute($opt_qry);
 337                 }
 338         }
 339
 340         $rs = $ADODB_SESS_CONN->SelectLimit('select '.$ADODB_SESS_CONN->sysTimeStamp.' from '. $ADODB_SESSION_TBL,1);
 341         if ($rs && !$rs->EOF) {
 342
 343                 $dbt = reset($rs->fields);
 344                 $rs->Close();
 345                 $dbt = $ADODB_SESS_CONN->UnixTimeStamp($dbt);
 346                 $t = time();
 347                 if (abs($dbt - $t) >= ADODB_SESSION_SYNCH_SECS) {
 348                 global $HTTP_SERVER_VARS;
 349                         $msg = "adodb-session.php: Server time for webserver {$HTTP_SERVER_VARS['HTTP_HOST']} not in synch: database=$dbt, webserver=".$t;
 350                         error_log($msg);
 351                         if ($ADODB_SESS_DEBUG) ADOConnection::outp("<p>$msg</p>");
 352                 }
 353         }
 354
 355         return true;
 356 }
 357
 358 session_module_name('user');
 359 session_set_save_handler(
 360         "adodb_sess_open",
 361         "adodb_sess_close",
 362         "adodb_sess_read",
 363         "adodb_sess_write",
 364         "adodb_sess_destroy",
 365         "adodb_sess_gc");
 366 }
 367
 368 /*  TEST SCRIPT -- UNCOMMENT */
 369
 370 if (0) {
 371 GLOBAL $HTTP_SESSION_VARS;
 372
 373         session_start();
 374         session_register('AVAR');
 375         $HTTP_SESSION_VARS['AVAR'] += 1;
 376         ADOConnection::outp( "<p>\$HTTP_SESSION_VARS['AVAR']={$HTTP_SESSION_VARS['AVAR']}</p>",false);
 377 }
 378
 379 ?>