includes/libs/objectcache/HashBagOStuff.php

   1 <?php
   2 /**
   3  * Per-process memory cache for storing items.
   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 use Wikimedia\Assert\Assert;
  24
  25 /**
  26  * Simple store for keeping values in an associative array for the current process.
  27  *
  28  * Data will not persist and is not shared with other processes.
  29  *
  30  * @ingroup Cache
  31  */
  32 class HashBagOStuff extends BagOStuff {
  33         /** @var mixed[] */
  34         protected $bag = [];
  35         /** @var integer Max entries allowed */
  36         protected $maxCacheKeys;
  37
  38         const KEY_VAL = 0;
  39         const KEY_EXP = 1;
  40
  41         /**
  42          * @param array $params Additional parameters include:
  43          *   - maxKeys : only allow this many keys (using oldest-first eviction)
  44          */
  45         function __construct( $params = [] ) {
  46                 parent::__construct( $params );
  47
  48                 $this->maxCacheKeys = isset( $params['maxKeys'] ) ? $params['maxKeys'] : INF;
  49                 Assert::parameter( $this->maxCacheKeys > 0, 'maxKeys', 'must be above zero' );
  50         }
  51
  52         protected function expire( $key ) {
  53                 $et = $this->bag[$key][self::KEY_EXP];
  54                 if ( $et == self::TTL_INDEFINITE || $et > time() ) {
  55                         return false;
  56                 }
  57
  58                 $this->delete( $key );
  59
  60                 return true;
  61         }
  62
  63         /**
  64          * Does this bag have a non-null value for the given key?
  65          *
  66          * @param string $key
  67          * @return bool
  68          * @since 1.27
  69          */
  70         protected function hasKey( $key ) {
  71                 return isset( $this->bag[$key] );
  72         }
  73
  74         protected function doGet( $key, $flags = 0 ) {
  75                 if ( !$this->hasKey( $key ) ) {
  76                         return false;
  77                 }
  78
  79                 if ( $this->expire( $key ) ) {
  80                         return false;
  81                 }
  82
  83                 // Refresh key position for maxCacheKeys eviction
  84                 $temp = $this->bag[$key];
  85                 unset( $this->bag[$key] );
  86                 $this->bag[$key] = $temp;
  87
  88                 return $this->bag[$key][self::KEY_VAL];
  89         }
  90
  91         public function set( $key, $value, $exptime = 0, $flags = 0 ) {
  92                 // Refresh key position for maxCacheKeys eviction
  93                 unset( $this->bag[$key] );
  94                 $this->bag[$key] = [
  95                         self::KEY_VAL => $value,
  96                         self::KEY_EXP => $this->convertExpiry( $exptime )
  97                 ];
  98
  99                 if ( count( $this->bag ) > $this->maxCacheKeys ) {
 100                         reset( $this->bag );
 101                         $evictKey = key( $this->bag );
 102                         unset( $this->bag[$evictKey] );
 103                 }
 104
 105                 return true;
 106         }
 107
 108         public function delete( $key ) {
 109                 unset( $this->bag[$key] );
 110
 111                 return true;
 112         }
 113
 114         public function clear() {
 115                 $this->bag = [];
 116         }
 117 }