includes/objectcache/BagOStuff.php

   1 <?php
   2 /**
   3  * Classes to cache objects in PHP accelerators, SQL database or DBA files
   4  *
   5  * Copyright © 2003-2004 Brion Vibber <brion@pobox.com>
   6  * https://www.mediawiki.org/
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 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 General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  * http://www.gnu.org/copyleft/gpl.html
  22  *
  23  * @file
  24  * @ingroup Cache
  25  */
  26
  27 /**
  28  * @defgroup Cache Cache
  29  */
  30
  31 /**
  32  * interface is intended to be more or less compatible with
  33  * the PHP memcached client.
  34  *
  35  * backends for local hash array and SQL table included:
  36  * <code>
  37  *   $bag = new HashBagOStuff();
  38  *   $bag = new SqlBagOStuff(); # connect to db first
  39  * </code>
  40  *
  41  * @ingroup Cache
  42  */
  43 abstract class BagOStuff {
  44         private $debugMode = false;
  45
  46         protected $lastError = self::ERR_NONE;
  47
  48         /** Possible values for getLastError() */
  49         const ERR_NONE = 0; // no error
  50         const ERR_NO_RESPONSE = 1; // no response
  51         const ERR_UNREACHABLE = 2; // can't connect
  52         const ERR_UNEXPECTED = 3; // response gave some error
  53
  54         /**
  55          * @param bool $bool
  56          */
  57         public function setDebug( $bool ) {
  58                 $this->debugMode = $bool;
  59         }
  60
  61         /* *** THE GUTS OF THE OPERATION *** */
  62         /* Override these with functional things in subclasses */
  63
  64         /**
  65          * Get an item with the given key. Returns false if it does not exist.
  66          * @param string $key
  67          * @param mixed $casToken [optional]
  68          * @return mixed Returns false on failure
  69          */
  70         abstract public function get( $key, &$casToken = null );
  71
  72         /**
  73          * Set an item.
  74          * @param string $key
  75          * @param mixed $value
  76          * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
  77          * @return bool Success
  78          */
  79         abstract public function set( $key, $value, $exptime = 0 );
  80
  81         /**
  82          * Check and set an item.
  83          * @param mixed $casToken
  84          * @param string $key
  85          * @param mixed $value
  86          * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
  87          * @return bool Success
  88          */
  89         abstract public function cas( $casToken, $key, $value, $exptime = 0 );
  90
  91         /**
  92          * Delete an item.
  93          * @param string $key
  94          * @param int $time Amount of time to delay the operation (mostly memcached-specific)
  95          * @return bool True if the item was deleted or not found, false on failure
  96          */
  97         abstract public function delete( $key, $time = 0 );
  98
  99         /**
 100          * Merge changes into the existing cache value (possibly creating a new one).
 101          * The callback function returns the new value given the current value (possibly false),
 102          * and takes the arguments: (this BagOStuff object, cache key, current value).
 103          *
 104          * @param string $key
 105          * @param Closure $callback Callback method to be executed
 106          * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
 107          * @param int $attempts The amount of times to attempt a merge in case of failure
 108          * @return bool Success
 109          */
 110         public function merge( $key, Closure $callback, $exptime = 0, $attempts = 10 ) {
 111                 return $this->mergeViaCas( $key, $callback, $exptime, $attempts );
 112         }
 113
 114         /**
 115          * @see BagOStuff::merge()
 116          *
 117          * @param string $key
 118          * @param Closure $callback Callback method to be executed
 119          * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
 120          * @param int $attempts The amount of times to attempt a merge in case of failure
 121          * @return bool Success
 122          */
 123         protected function mergeViaCas( $key, Closure $callback, $exptime = 0, $attempts = 10 ) {
 124                 do {
 125                         $casToken = null; // passed by reference
 126                         $currentValue = $this->get( $key, $casToken ); // get the old value
 127                         $value = $callback( $this, $key, $currentValue ); // derive the new value
 128
 129                         if ( $value === false ) {
 130                                 $success = true; // do nothing
 131                         } elseif ( $currentValue === false ) {
 132                                 // Try to create the key, failing if it gets created in the meantime
 133                                 $success = $this->add( $key, $value, $exptime );
 134                         } else {
 135                                 // Try to update the key, failing if it gets changed in the meantime
 136                                 $success = $this->cas( $casToken, $key, $value, $exptime );
 137                         }
 138                 } while ( !$success && --$attempts );
 139
 140                 return $success;
 141         }
 142
 143         /**
 144          * @see BagOStuff::merge()
 145          *
 146          * @param string $key
 147          * @param Closure $callback Callback method to be executed
 148          * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
 149          * @param int $attempts The amount of times to attempt a merge in case of failure
 150          * @return bool Success
 151          */
 152         protected function mergeViaLock( $key, Closure $callback, $exptime = 0, $attempts = 10 ) {
 153                 if ( !$this->lock( $key, 6 ) ) {
 154                         return false;
 155                 }
 156
 157                 $currentValue = $this->get( $key ); // get the old value
 158                 $value = $callback( $this, $key, $currentValue ); // derive the new value
 159
 160                 if ( $value === false ) {
 161                         $success = true; // do nothing
 162                 } else {
 163                         $success = $this->set( $key, $value, $exptime ); // set the new value
 164                 }
 165
 166                 if ( !$this->unlock( $key ) ) {
 167                         // this should never happen
 168                         trigger_error( "Could not release lock for key '$key'." );
 169                 }
 170
 171                 return $success;
 172         }
 173
 174         /**
 175          * @param string $key
 176          * @param int $timeout [optional]
 177          * @return bool Success
 178          */
 179         public function lock( $key, $timeout = 6 ) {
 180                 $this->clearLastError();
 181                 $timestamp = microtime( true ); // starting UNIX timestamp
 182                 if ( $this->add( "{$key}:lock", 1, $timeout ) ) {
 183                         return true;
 184                 } elseif ( $this->getLastError() ) {
 185                         return false;
 186                 }
 187
 188                 $uRTT = ceil( 1e6 * ( microtime( true ) - $timestamp ) ); // estimate RTT (us)
 189                 $sleep = 2 * $uRTT; // rough time to do get()+set()
 190
 191                 $locked = false; // lock acquired
 192                 $attempts = 0; // failed attempts
 193                 do {
 194                         if ( ++$attempts >= 3 && $sleep <= 1e6 ) {
 195                                 // Exponentially back off after failed attempts to avoid network spam.
 196                                 // About 2*$uRTT*(2^n-1) us of "sleep" happen for the next n attempts.
 197                                 $sleep *= 2;
 198                         }
 199                         usleep( $sleep ); // back off
 200                         $this->clearLastError();
 201                         $locked = $this->add( "{$key}:lock", 1, $timeout );
 202                         if ( $this->getLastError() ) {
 203                                 return false;
 204                         }
 205                 } while ( !$locked );
 206
 207                 return $locked;
 208         }
 209
 210         /**
 211          * @param string $key
 212          * @return bool Success
 213          */
 214         public function unlock( $key ) {
 215                 return $this->delete( "{$key}:lock" );
 216         }
 217
 218         /**
 219          * Delete all objects expiring before a certain date.
 220          * @param string $date The reference date in MW format
 221          * @param callable|bool $progressCallback Optional, a function which will be called
 222          *     regularly during long-running operations with the percentage progress
 223          *     as the first parameter.
 224          *
 225          * @return bool Success, false if unimplemented
 226          */
 227         public function deleteObjectsExpiringBefore( $date, $progressCallback = false ) {
 228                 // stub
 229                 return false;
 230         }
 231
 232         /* *** Emulated functions *** */
 233
 234         /**
 235          * Get an associative array containing the item for each of the keys that have items.
 236          * @param array $keys List of strings
 237          * @return array
 238          */
 239         public function getMulti( array $keys ) {
 240                 $res = array();
 241                 foreach ( $keys as $key ) {
 242                         $val = $this->get( $key );
 243                         if ( $val !== false ) {
 244                                 $res[$key] = $val;
 245                         }
 246                 }
 247                 return $res;
 248         }
 249
 250         /**
 251          * Batch insertion
 252          * @param array $data $key => $value assoc array
 253          * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
 254          * @return bool Success
 255          * @since 1.24
 256          */
 257         public function setMulti( array $data, $exptime = 0 ) {
 258                 $res = true;
 259                 foreach ( $data as $key => $value ) {
 260                         if ( !$this->set( $key, $value, $exptime ) ) {
 261                                 $res = false;
 262                         }
 263                 }
 264                 return $res;
 265         }
 266
 267         /**
 268          * @param string $key
 269          * @param mixed $value
 270          * @param int $exptime
 271          * @return bool Success
 272          */
 273         public function add( $key, $value, $exptime = 0 ) {
 274                 if ( $this->get( $key ) === false ) {
 275                         return $this->set( $key, $value, $exptime );
 276                 }
 277                 return false; // key already set
 278         }
 279
 280         /**
 281          * @param string $key
 282          * @param mixed $value
 283          * @param int $exptime
 284          * @return bool Success
 285          * @deprecated since 1.23
 286          */
 287         public function replace( $key, $value, $exptime = 0 ) {
 288                 wfDeprecated( __METHOD__, '1.23' );
 289                 if ( $this->get( $key ) !== false ) {
 290                         return $this->set( $key, $value, $exptime );
 291                 }
 292                 return false; // key not already set
 293         }
 294
 295         /**
 296          * Increase stored value of $key by $value while preserving its TTL
 297          * @param string $key Key to increase
 298          * @param int $value Value to add to $key (Default 1)
 299          * @return int|bool New value or false on failure
 300          */
 301         public function incr( $key, $value = 1 ) {
 302                 if ( !$this->lock( $key ) ) {
 303                         return false;
 304                 }
 305                 $n = $this->get( $key );
 306                 if ( $this->isInteger( $n ) ) { // key exists?
 307                         $n += intval( $value );
 308                         $this->set( $key, max( 0, $n ) ); // exptime?
 309                 } else {
 310                         $n = false;
 311                 }
 312                 $this->unlock( $key );
 313
 314                 return $n;
 315         }
 316
 317         /**
 318          * Decrease stored value of $key by $value while preserving its TTL
 319          * @param string $key
 320          * @param int $value
 321          * @return int
 322          */
 323         public function decr( $key, $value = 1 ) {
 324                 return $this->incr( $key, - $value );
 325         }
 326
 327         /**
 328          * Increase stored value of $key by $value while preserving its TTL
 329          *
 330          * This will create the key with value $init and TTL $ttl if not present
 331          *
 332          * @param string $key
 333          * @param int $ttl
 334          * @param int $value
 335          * @param int $init
 336          * @return bool
 337          * @since 1.24
 338          */
 339         public function incrWithInit( $key, $ttl, $value = 1, $init = 1 ) {
 340                 return $this->incr( $key, $value ) ||
 341                         $this->add( $key, (int)$init, $ttl ) || $this->incr( $key, $value );
 342         }
 343
 344         /**
 345          * Get the "last error" registered; clearLastError() should be called manually
 346          * @return int ERR_* constant for the "last error" registry
 347          * @since 1.23
 348          */
 349         public function getLastError() {
 350                 return $this->lastError;
 351         }
 352
 353         /**
 354          * Clear the "last error" registry
 355          * @since 1.23
 356          */
 357         public function clearLastError() {
 358                 $this->lastError = self::ERR_NONE;
 359         }
 360
 361         /**
 362          * Set the "last error" registry
 363          * @param int $err ERR_* constant
 364          * @since 1.23
 365          */
 366         protected function setLastError( $err ) {
 367                 $this->lastError = $err;
 368         }
 369
 370         /**
 371          * @param string $text
 372          */
 373         public function debug( $text ) {
 374                 if ( $this->debugMode ) {
 375                         $class = get_class( $this );
 376                         wfDebug( "$class debug: $text\n" );
 377                 }
 378         }
 379
 380         /**
 381          * Convert an optionally relative time to an absolute time
 382          * @param int $exptime
 383          * @return int
 384          */
 385         protected function convertExpiry( $exptime ) {
 386                 if ( ( $exptime != 0 ) && ( $exptime < 86400 * 3650 /* 10 years */ ) ) {
 387                         return time() + $exptime;
 388                 } else {
 389                         return $exptime;
 390                 }
 391         }
 392
 393         /**
 394          * Convert an optionally absolute expiry time to a relative time. If an
 395          * absolute time is specified which is in the past, use a short expiry time.
 396          *
 397          * @param int $exptime
 398          * @return int
 399          */
 400         protected function convertToRelative( $exptime ) {
 401                 if ( $exptime >= 86400 * 3650 /* 10 years */ ) {
 402                         $exptime -= time();
 403                         if ( $exptime <= 0 ) {
 404                                 $exptime = 1;
 405                         }
 406                         return $exptime;
 407                 } else {
 408                         return $exptime;
 409                 }
 410         }
 411
 412         /**
 413          * Check if a value is an integer
 414          *
 415          * @param mixed $value
 416          * @return bool
 417          */
 418         protected function isInteger( $value ) {
 419                 return ( is_int( $value ) || ctype_digit( $value ) );
 420         }
 421 }