X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/mediawiki.git/blobdiff_plain/19e297c21b10b1b8a3acad5e73fc71dcb35db44a..6932310fd58ebef145fa01eb76edf7150284d8ea:/includes/libs/objectcache/CachedBagOStuff.php

diff --git a/includes/libs/objectcache/CachedBagOStuff.php b/includes/libs/objectcache/CachedBagOStuff.php
new file mode 100644
index 00000000..c85a82ea
--- /dev/null
+++ b/includes/libs/objectcache/CachedBagOStuff.php
@@ -0,0 +1,121 @@
+<?php
+/**
+ * Wrapper around a BagOStuff that caches data in memory
+ *
+ * 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
+ */
+
+/**
+ * Wrapper around a BagOStuff that caches data in memory
+ *
+ * The differences between CachedBagOStuff and MultiWriteBagOStuff are:
+ * * CachedBagOStuff supports only one "backend".
+ * * There's a flag for writes to only go to the in-memory cache.
+ * * The in-memory cache is always updated.
+ * * Locks go to the backend cache (with MultiWriteBagOStuff, it would wind
+ *   up going to the HashBagOStuff used for the in-memory cache).
+ *
+ * @ingroup Cache
+ */
+class CachedBagOStuff extends HashBagOStuff {
+	/** @var BagOStuff */
+	protected $backend;
+
+	/**
+	 * @param BagOStuff $backend Permanent backend to use
+	 * @param array $params Parameters for HashBagOStuff
+	 */
+	function __construct( BagOStuff $backend, $params = [] ) {
+		unset( $params['reportDupes'] ); // useless here
+
+		parent::__construct( $params );
+
+		$this->backend = $backend;
+		$this->attrMap = $backend->attrMap;
+	}
+
+	protected function doGet( $key, $flags = 0 ) {
+		$ret = parent::doGet( $key, $flags );
+		if ( $ret === false && !$this->hasKey( $key ) ) {
+			$ret = $this->backend->doGet( $key, $flags );
+			$this->set( $key, $ret, 0, self::WRITE_CACHE_ONLY );
+		}
+		return $ret;
+	}
+
+	public function set( $key, $value, $exptime = 0, $flags = 0 ) {
+		parent::set( $key, $value, $exptime, $flags );
+		if ( !( $flags & self::WRITE_CACHE_ONLY ) ) {
+			$this->backend->set( $key, $value, $exptime, $flags & ~self::WRITE_CACHE_ONLY );
+		}
+		return true;
+	}
+
+	public function delete( $key, $flags = 0 ) {
+		unset( $this->bag[$key] );
+		if ( !( $flags & self::WRITE_CACHE_ONLY ) ) {
+			$this->backend->delete( $key );
+		}
+
+		return true;
+	}
+
+	public function setDebug( $bool ) {
+		parent::setDebug( $bool );
+		$this->backend->setDebug( $bool );
+	}
+
+	public function deleteObjectsExpiringBefore( $date, $progressCallback = false ) {
+		parent::deleteObjectsExpiringBefore( $date, $progressCallback );
+		return $this->backend->deleteObjectsExpiringBefore( $date, $progressCallback );
+	}
+
+	public function makeKey() {
+		return call_user_func_array( [ $this->backend, __FUNCTION__ ], func_get_args() );
+	}
+
+	public function makeGlobalKey() {
+		return call_user_func_array( [ $this->backend, __FUNCTION__ ], func_get_args() );
+	}
+
+	// These just call the backend (tested elsewhere)
+	// @codeCoverageIgnoreStart
+
+	public function lock( $key, $timeout = 6, $expiry = 6, $rclass = '' ) {
+		return $this->backend->lock( $key, $timeout, $expiry, $rclass );
+	}
+
+	public function unlock( $key ) {
+		return $this->backend->unlock( $key );
+	}
+
+	public function getLastError() {
+		return $this->backend->getLastError();
+	}
+
+	public function clearLastError() {
+		return $this->backend->clearLastError();
+	}
+
+	public function modifySimpleRelayEvent( array $event ) {
+		return $this->backend->modifySimpleRelayEvent( $event );
+	}
+
+	// @codeCoverageIgnoreEnd
+}