MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / includes / libs / objectcache / HashBagOStuff.php

diff --git a/includes/libs/objectcache/HashBagOStuff.php b/includes/libs/objectcache/HashBagOStuff.php
new file mode 100644 (file)
index 0000000..6d583da
--- /dev/null
+++ b/includes/libs/objectcache/HashBagOStuff.php
@@ -0,0 +1,118 @@
+<?php
+/**
+ * Per-process memory cache for storing items.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ * @ingroup Cache
+ */
+
+/**
+ * Simple store for keeping values in an associative array for the current process.
+ *
+ * Data will not persist and is not shared with other processes.
+ *
+ * @ingroup Cache
+ */
+class HashBagOStuff extends BagOStuff {
+       /** @var mixed[] */
+       protected $bag = [];
+       /** @var int Max entries allowed */
+       protected $maxCacheKeys;
+
+       const KEY_VAL = 0;
+       const KEY_EXP = 1;
+
+       /**
+        * @param array $params Additional parameters include:
+        *   - maxKeys : only allow this many keys (using oldest-first eviction)
+        */
+       function __construct( $params = [] ) {
+               parent::__construct( $params );
+
+               $this->maxCacheKeys = isset( $params['maxKeys'] ) ? $params['maxKeys'] : INF;
+               if ( $this->maxCacheKeys <= 0 ) {
+                       throw new InvalidArgumentException( '$maxKeys parameter must be above zero' );
+               }
+       }
+
+       protected function expire( $key ) {
+               $et = $this->bag[$key][self::KEY_EXP];
+               if ( $et == self::TTL_INDEFINITE || $et > time() ) {
+                       return false;
+               }
+
+               $this->delete( $key );
+
+               return true;
+       }
+
+       /**
+        * Does this bag have a non-null value for the given key?
+        *
+        * @param string $key
+        * @return bool
+        * @since 1.27
+        */
+       protected function hasKey( $key ) {
+               return isset( $this->bag[$key] );
+       }
+
+       protected function doGet( $key, $flags = 0 ) {
+               if ( !$this->hasKey( $key ) ) {
+                       return false;
+               }
+
+               if ( $this->expire( $key ) ) {
+                       return false;
+               }
+
+               // Refresh key position for maxCacheKeys eviction
+               $temp = $this->bag[$key];
+               unset( $this->bag[$key] );
+               $this->bag[$key] = $temp;
+
+               return $this->bag[$key][self::KEY_VAL];
+       }
+
+       public function set( $key, $value, $exptime = 0, $flags = 0 ) {
+               // Refresh key position for maxCacheKeys eviction
+               unset( $this->bag[$key] );
+               $this->bag[$key] = [
+                       self::KEY_VAL => $value,
+                       self::KEY_EXP => $this->convertExpiry( $exptime )
+               ];
+
+               if ( count( $this->bag ) > $this->maxCacheKeys ) {
+                       reset( $this->bag );
+                       $evictKey = key( $this->bag );
+                       unset( $this->bag[$evictKey] );
+               }
+
+               return true;
+       }
+
+       public function delete( $key ) {
+               unset( $this->bag[$key] );
+
+               return true;
+       }
+
+       public function clear() {
+               $this->bag = [];
+       }
+}