includes/objectcache/MultiWriteBagOStuff.php

   1 <?php
   2 /**
   3  * Wrapper for object caching in different caches.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Cache
  22  */
  23
  24 /**
  25  * A cache class that replicates all writes to multiple child caches. Reads
  26  * are implemented by reading from the caches in the order they are given in
  27  * the configuration until a cache gives a positive result.
  28  *
  29  * @ingroup Cache
  30  */
  31 class MultiWriteBagOStuff extends BagOStuff {
  32         /** @var BagOStuff[] */
  33         protected $caches;
  34
  35         /**
  36          * Constructor. Parameters are:
  37          *
  38          *   - caches:   This should have a numbered array of cache parameter
  39          *               structures, in the style required by $wgObjectCaches. See
  40          *               the documentation of $wgObjectCaches for more detail.
  41          *
  42          * @param array $params
  43          * @throws InvalidArgumentException
  44          */
  45         public function __construct( $params ) {
  46                 parent::__construct( $params );
  47                 if ( !isset( $params['caches'] ) ) {
  48                         throw new InvalidArgumentException( __METHOD__ . ': the caches parameter is required' );
  49                 }
  50
  51                 $this->caches = array();
  52                 foreach ( $params['caches'] as $cacheInfo ) {
  53                         $this->caches[] = ObjectCache::newFromParams( $cacheInfo );
  54                 }
  55         }
  56
  57         /**
  58          * @param bool $debug
  59          */
  60         public function setDebug( $debug ) {
  61                 $this->doWrite( 'setDebug', $debug );
  62         }
  63
  64         public function get( $key, &$casToken = null, $flags = 0 ) {
  65                 foreach ( $this->caches as $cache ) {
  66                         $value = $cache->get( $key, $casToken, $flags );
  67                         if ( $value !== false ) {
  68                                 return $value;
  69                         }
  70                 }
  71                 return false;
  72         }
  73
  74         /**
  75          * @param string $key
  76          * @param mixed $value
  77          * @param int $exptime
  78          * @return bool
  79          */
  80         public function set( $key, $value, $exptime = 0 ) {
  81                 return $this->doWrite( 'set', $key, $value, $exptime );
  82         }
  83
  84         /**
  85          * @param string $key
  86          * @return bool
  87          */
  88         public function delete( $key ) {
  89                 return $this->doWrite( 'delete', $key );
  90         }
  91
  92         /**
  93          * @param string $key
  94          * @param mixed $value
  95          * @param int $exptime
  96          * @return bool
  97          */
  98         public function add( $key, $value, $exptime = 0 ) {
  99                 return $this->doWrite( 'add', $key, $value, $exptime );
 100         }
 101
 102         /**
 103          * @param string $key
 104          * @param int $value
 105          * @return bool|null
 106          */
 107         public function incr( $key, $value = 1 ) {
 108                 return $this->doWrite( 'incr', $key, $value );
 109         }
 110
 111         /**
 112          * @param string $key
 113          * @param int $value
 114          * @return bool
 115          */
 116         public function decr( $key, $value = 1 ) {
 117                 return $this->doWrite( 'decr', $key, $value );
 118         }
 119
 120         /**
 121          * @param string $key
 122          * @param int $timeout
 123          * @param int $expiry
 124          * @param string $rclass
 125          * @return bool
 126          */
 127         public function lock( $key, $timeout = 6, $expiry = 6, $rclass = '' ) {
 128                 // Lock only the first cache, to avoid deadlocks
 129                 if ( isset( $this->caches[0] ) ) {
 130                         return $this->caches[0]->lock( $key, $timeout, $expiry, $rclass );
 131                 } else {
 132                         return true;
 133                 }
 134         }
 135
 136         /**
 137          * @param string $key
 138          * @return bool
 139          */
 140         public function unlock( $key ) {
 141                 if ( isset( $this->caches[0] ) ) {
 142                         return $this->caches[0]->unlock( $key );
 143                 } else {
 144                         return true;
 145                 }
 146         }
 147
 148         /**
 149          * @param string $key
 150          * @param callable $callback Callback method to be executed
 151          * @param int $exptime Either an interval in seconds or a unix timestamp for expiry
 152          * @param int $attempts The amount of times to attempt a merge in case of failure
 153          * @return bool Success
 154          */
 155         public function merge( $key, $callback, $exptime = 0, $attempts = 10 ) {
 156                 return $this->doWrite( 'merge', $key, $callback, $exptime );
 157         }
 158
 159         public function getLastError() {
 160                 return isset( $this->caches[0] ) ? $this->caches[0]->getLastError() : self::ERR_NONE;
 161         }
 162
 163         public function clearLastError() {
 164                 if ( isset( $this->caches[0] ) ) {
 165                         $this->caches[0]->clearLastError();
 166                 }
 167         }
 168
 169         /**
 170          * @param string $method
 171          * @return bool
 172          */
 173         protected function doWrite( $method /*, ... */ ) {
 174                 $ret = true;
 175                 $args = func_get_args();
 176                 array_shift( $args );
 177
 178                 foreach ( $this->caches as $cache ) {
 179                         if ( !call_user_func_array( array( $cache, $method ), $args ) ) {
 180                                 $ret = false;
 181                         }
 182                 }
 183                 return $ret;
 184         }
 185
 186         /**
 187          * Delete objects expiring before a certain date.
 188          *
 189          * Succeed if any of the child caches succeed.
 190          * @param string $date
 191          * @param bool|callable $progressCallback
 192          * @return bool
 193          */
 194         public function deleteObjectsExpiringBefore( $date, $progressCallback = false ) {
 195                 $ret = false;
 196                 foreach ( $this->caches as $cache ) {
 197                         if ( $cache->deleteObjectsExpiringBefore( $date, $progressCallback ) ) {
 198                                 $ret = true;
 199                         }
 200                 }
 201                 return $ret;
 202         }
 203 }