includes/BagOStuff.php

   1 <?php
   2 #
   3 # Copyright (C) 2003-2004 Brion Vibber <brion@pobox.com>
   4 # http://www.mediawiki.org/
   5 #
   6 # This program is free software; you can redistribute it and/or modify
   7 # it under the terms of the GNU General Public License as published by
   8 # the Free Software Foundation; either version 2 of the License, or
   9 # (at your option) any later version.
  10 #
  11 # This program is distributed in the hope that it will be useful,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14 # GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along
  17 # with this program; if not, write to the Free Software Foundation, Inc.,
  18 # 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19 # http://www.gnu.org/copyleft/gpl.html
  20 /**
  21  *
  22  * @package MediaWiki
  23  */
  24
  25 /**
  26  * Simple generic object store
  27  *
  28  * interface is intended to be more or less compatible with
  29  * the PHP memcached client.
  30  *
  31  * backends for local hash array and SQL table included:
  32  * $bag = new HashBagOStuff();
  33  * $bag = new MysqlBagOStuff($tablename); # connect to db first
  34  *
  35  * @package MediaWiki
  36  * @abstract
  37  */
  38 class BagOStuff {
  39         var $debugmode;
  40
  41         function BagOStuff() {
  42                 $this->set_debug( false );
  43         }
  44
  45         function set_debug($bool) {
  46                 $this->debugmode = $bool;
  47         }
  48
  49         /* *** THE GUTS OF THE OPERATION *** */
  50         /* Override these with functional things in subclasses */
  51
  52         function get($key) {
  53                 /* stub */
  54                 return false;
  55         }
  56
  57         function set($key, $value, $exptime=0) {
  58                 /* stub */
  59                 return false;
  60         }
  61
  62         function delete($key, $time=0) {
  63                 /* stub */
  64                 return false;
  65         }
  66
  67         function lock($key, $timeout = 0) {
  68                 /* stub */
  69                 return true;
  70         }
  71
  72         function unlock($key) {
  73                 /* stub */
  74                 return true;
  75         }
  76
  77         /* *** Emulated functions *** */
  78         /* Better performance can likely be got with custom written versions */
  79         function get_multi($keys) {
  80                 $out = array();
  81                 foreach($keys as $key)
  82                         $out[$key] = $this->get($key);
  83                 return $out;
  84         }
  85
  86         function set_multi($hash, $exptime=0) {
  87                 foreach($hash as $key => $value)
  88                         $this->set($key, $value, $exptime);
  89         }
  90
  91         function add($key, $value, $exptime=0) {
  92                 if( $this->get($key) == false ) {
  93                         $this->set($key, $value, $exptime);
  94                         return true;
  95                 }
  96         }
  97
  98         function add_multi($hash, $exptime=0) {
  99                 foreach($hash as $key => $value)
 100                         $this->add($key, $value, $exptime);
 101         }
 102
 103         function delete_multi($keys, $time=0) {
 104                 foreach($keys as $key)
 105                         $this->delete($key, $time);
 106         }
 107
 108         function replace($key, $value, $exptime=0) {
 109                 if( $this->get($key) !== false )
 110                         $this->set($key, $value, $exptime);
 111         }
 112
 113         function incr($key, $value=1) {
 114                 if ( !$this->lock($key) ) {
 115                         return false;
 116                 }
 117                 $value = intval($value);
 118                 if($value < 0) $value = 0;
 119
 120                 $n = false;
 121                 if( ($n = $this->get($key)) !== false ) {
 122                         $n += $value;
 123                         $this->set($key, $n); // exptime?
 124                 }
 125                 $this->unlock($key);
 126                 return $n;
 127         }
 128
 129         function decr($key, $value=1) {
 130                 if ( !$this->lock($key) ) {
 131                         return false;
 132                 }
 133                 $value = intval($value);
 134                 if($value < 0) $value = 0;
 135
 136                 $m = false;
 137                 if( ($n = $this->get($key)) !== false ) {
 138                         $m = $n - $value;
 139                         if($m < 0) $m = 0;
 140                         $this->set($key, $m); // exptime?
 141                 }
 142                 $this->unlock($key);
 143                 return $m;
 144         }
 145
 146         function _debug($text) {
 147                 if($this->debugmode)
 148                         wfDebug("BagOStuff debug: $text\n");
 149         }
 150 }
 151
 152
 153 /**
 154  * Functional versions!
 155  * @todo document
 156  * @package MediaWiki
 157  */
 158 class HashBagOStuff extends BagOStuff {
 159         /*
 160            This is a test of the interface, mainly. It stores
 161            things in an associative array, which is not going to
 162            persist between program runs.
 163         */
 164         var $bag;
 165
 166         function HashBagOStuff() {
 167                 $this->bag = array();
 168         }
 169
 170         function _expire($key) {
 171                 $et = $this->bag[$key][1];
 172                 if(($et == 0) || ($et > time()))
 173                         return false;
 174                 $this->delete($key);
 175                 return true;
 176         }
 177
 178         function get($key) {
 179                 if(!$this->bag[$key])
 180                         return false;
 181                 if($this->_expire($key))
 182                         return false;
 183                 return $this->bag[$key][0];
 184         }
 185
 186         function set($key,$value,$exptime=0) {
 187                 if(($exptime != 0) && ($exptime < 3600*24*30))
 188                         $exptime = time() + $exptime;
 189                 $this->bag[$key] = array( $value, $exptime );
 190         }
 191
 192         function delete($key,$time=0) {
 193                 if(!$this->bag[$key])
 194                         return false;
 195                 unset($this->bag[$key]);
 196                 return true;
 197         }
 198 }
 199
 200 /*
 201 CREATE TABLE objectcache (
 202   keyname char(255) binary not null default '',
 203   value mediumblob,
 204   exptime datetime,
 205   unique key (keyname),
 206   key (exptime)
 207 );
 208 */
 209
 210 /**
 211  * @todo document
 212  * @abstract
 213  * @package MediaWiki
 214  */
 215 class SqlBagOStuff extends BagOStuff {
 216         var $table;
 217         var $lastexpireall = 0;
 218
 219         function SqlBagOStuff($tablename = 'objectcache') {
 220                 $this->table = $tablename;
 221         }
 222
 223         function get($key) {
 224                 /* expire old entries if any */
 225                 $this->garbageCollect();
 226
 227                 $res = $this->_query(
 228                         "SELECT value,exptime FROM $0 WHERE keyname='$1'", $key);
 229                 if(!$res) {
 230                         $this->_debug("get: ** error: " . $this->_dberror($res) . " **");
 231                         return false;
 232                 }
 233                 if($row=$this->_fetchobject($res)) {
 234                         $this->_debug("get: retrieved data; exp time is " . $row->exptime);
 235                         return $this->_unserialize($row->value);
 236                 } else {
 237                         $this->_debug('get: no matching rows');
 238                 }
 239                 return false;
 240         }
 241
 242         function set($key,$value,$exptime=0) {
 243                 $exptime = intval($exptime);
 244                 if($exptime < 0) $exptime = 0;
 245                 if($exptime == 0) {
 246                         $exp = $this->_maxdatetime();
 247                 } else {
 248                         if($exptime < 3600*24*30)
 249                                 $exptime += time();
 250                         $exp = $this->_fromunixtime($exptime);
 251                 }
 252                 $this->delete( $key );
 253                 $this->_query(
 254                         "INSERT INTO $0 (keyname,value,exptime) VALUES('$1','$2','$exp')",
 255                         $key, $this->_serialize($value));
 256                 return true; /* ? */
 257         }
 258
 259         function delete($key,$time=0) {
 260                 $this->_query(
 261                         "DELETE FROM $0 WHERE keyname='$1'", $key );
 262                 return true; /* ? */
 263         }
 264
 265         function getTableName() {
 266                 return $this->table;
 267         }
 268
 269         function _query($sql) {
 270                 $reps = func_get_args();
 271                 $reps[0] = $this->getTableName();
 272                 // ewwww
 273                 for($i=0;$i<count($reps);$i++) {
 274                         $sql = str_replace(
 275                                 '$' . $i,
 276                                 $this->_strencode($reps[$i]),
 277                                 $sql);
 278                 }
 279                 $res = $this->_doquery($sql);
 280                 if($res == false) {
 281                         $this->_debug('query failed: ' . $this->_dberror($res));
 282                 }
 283                 return $res;
 284         }
 285
 286         function _strencode($str) {
 287                 /* Protect strings in SQL */
 288                 return str_replace( "'", "''", $str );
 289         }
 290
 291         function _doquery($sql) {
 292                 die( 'abstract function SqlBagOStuff::_doquery() must be defined' );
 293         }
 294
 295         function _fetchrow($res) {
 296                 die( 'abstract function SqlBagOStuff::_fetchrow() must be defined' );
 297         }
 298
 299         function _freeresult($result) {
 300                 /* stub */
 301                 return false;
 302         }
 303
 304         function _dberror($result) {
 305                 /* stub */
 306                 return 'unknown error';
 307         }
 308
 309         function _maxdatetime() {
 310                 die( 'abstract function SqlBagOStuff::_maxdatetime() must be defined' );
 311         }
 312
 313         function _fromunixtime() {
 314                 die( 'abstract function SqlBagOStuff::_fromunixtime() must be defined' );
 315         }
 316
 317         function garbageCollect() {
 318                 /* Ignore 99% of requests */
 319                 if ( !mt_rand( 0, 100 ) ) {
 320                         $nowtime = time();
 321                         /* Avoid repeating the delete within a few seconds */
 322                         if ( $nowtime > ($this->lastexpireall + 1) ) {
 323                                 $this->lastexpireall = $nowtime;
 324                                 $this->expireall();
 325                         }
 326                 }
 327         }
 328
 329         function expireall() {
 330                 /* Remove any items that have expired */
 331                 $now = $this->_fromunixtime( time() );
 332                 $this->_query( "DELETE FROM $0 WHERE exptime<'$now'" );
 333         }
 334
 335         function deleteall() {
 336                 /* Clear *all* items from cache table */
 337                 $this->_query( "DELETE FROM $0" );
 338         }
 339
 340         /**
 341          * Serialize an object and, if possible, compress the representation.
 342          * On typical message and page data, this can provide a 3X decrease
 343          * in storage requirements.
 344          *
 345          * @param mixed $data
 346          * @return string
 347          */
 348         function _serialize( &$data ) {
 349                 $serial = serialize( $data );
 350                 if( function_exists( 'gzdeflate' ) ) {
 351                         return gzdeflate( $serial );
 352                 } else {
 353                         return $serial;
 354                 }
 355         }
 356
 357         /**
 358          * Unserialize and, if necessary, decompress an object.
 359          * @param string $serial
 360          * @return mixed
 361          */
 362         function &_unserialize( $serial ) {
 363                 if( function_exists( 'gzinflate' ) ) {
 364                         $decomp = @gzinflate( $serial );
 365                         if( false !== $decomp ) {
 366                                 $serial = $decomp;
 367                         }
 368                 }
 369                 return unserialize( $serial );
 370         }
 371 }
 372
 373 /**
 374  * @todo document
 375  * @package MediaWiki
 376  */
 377 class MediaWikiBagOStuff extends SqlBagOStuff {
 378         var $tableInitialised = false;
 379
 380         function _doquery($sql) {
 381                 $dbw =& wfGetDB( DB_MASTER );
 382                 return $dbw->query($sql, 'MediaWikiBagOStuff:_doquery');
 383         }
 384         function _fetchobject($result) {
 385                 $dbw =& wfGetDB( DB_MASTER );
 386                 return $dbw->fetchObject($result);
 387         }
 388         function _freeresult($result) {
 389                 $dbw =& wfGetDB( DB_MASTER );
 390                 return $dbw->freeResult($result);
 391         }
 392         function _dberror($result) {
 393                 $dbw =& wfGetDB( DB_MASTER );
 394                 return $dbw->lastError();
 395         }
 396         function _maxdatetime() {
 397                 return '9999-12-31 12:59:59';
 398         }
 399         function _fromunixtime($ts) {
 400                 return gmdate( 'Y-m-d H:i:s', $ts );
 401         }
 402         function _strencode($s) {
 403                 $dbw =& wfGetDB( DB_MASTER );
 404                 return $dbw->strencode($s);
 405         }
 406         function getTableName() {
 407                 if ( !$this->tableInitialised ) {
 408                         $dbw =& wfGetDB( DB_MASTER );
 409                         $this->table = $dbw->tableName( $this->table );
 410                         $this->tableInitialised = true;
 411                 }
 412                 return $this->table;
 413         }
 414 }
 415
 416 /**
 417  * This is a wrapper for Turck MMCache's shared memory functions.
 418  *
 419  * You can store objects with mmcache_put() and mmcache_get(), but Turck seems
 420  * to use a weird custom serializer that randomly segfaults. So we wrap calls
 421  * with serialize()/unserialize().
 422  *
 423  * The thing I noticed about the Turck serialized data was that unlike ordinary
 424  * serialize(), it contained the names of methods, and judging by the amount of
 425  * binary data, perhaps even the bytecode of the methods themselves. It may be
 426  * that Turck's serializer is faster, so a possible future extension would be
 427  * to use it for arrays but not for objects.
 428  *
 429  * @package MediaWiki
 430  */
 431 class TurckBagOStuff extends BagOStuff {
 432         function get($key) {
 433                 $val = mmcache_get( $key );
 434                 if ( is_string( $val ) ) {
 435                         $val = unserialize( $val );
 436                 }
 437                 return $val;
 438         }
 439
 440         function set($key, $value, $exptime=0) {
 441                 mmcache_put( $key, serialize( $value ), $exptime );
 442                 return true;
 443         }
 444
 445         function delete($key, $time=0) {
 446                 mmcache_rm( $key );
 447                 return true;
 448         }
 449
 450         function lock($key, $waitTimeout = 0 ) {
 451                 mmcache_lock( $key );
 452                 return true;
 453         }
 454
 455         function unlock($key) {
 456                 mmcache_unlock( $key );
 457                 return true;
 458         }
 459 }
 460
 461 /**
 462  * This is a wrapper for eAccelerator's shared memory functions.
 463  *
 464  * This is basically identical to the Turck MMCache version,
 465  * mostly because eAccelerator is based on Turck MMCache.
 466  *
 467  * @package MediaWiki
 468  */
 469 class eAccelBagOStuff extends BagOStuff {
 470         function get($key) {
 471                 $val = eaccelerator_get( $key );
 472                 if ( is_string( $val ) ) {
 473                         $val = unserialize( $val );
 474                 }
 475                 return $val;
 476         }
 477
 478         function set($key, $value, $exptime=0) {
 479                 eaccelerator_put( $key, serialize( $value ), $exptime );
 480                 return true;
 481         }
 482
 483         function delete($key, $time=0) {
 484                 eaccelerator_rm( $key );
 485                 return true;
 486         }
 487
 488         function lock($key, $waitTimeout = 0 ) {
 489                 eaccelerator_lock( $key );
 490                 return true;
 491         }
 492
 493         function unlock($key) {
 494                 eaccelerator_unlock( $key );
 495                 return true;
 496         }
 497 }
 498 ?>