ObjectCache::newFromId() - Code Metrics - Inspection of "Daily Inspection: objectcache: add WANObjectCache:..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (24200e)

unknown

created 2016-10-05 17:04 UTC

ObjectCache::newFromId() A

↳ Parent: ObjectCache

Complexity

Conditions	4
Paths	4

Size

Total Lines	17
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	10
nc	4
nop	1
dl	0
loc	17
rs	9.2
c	0
b	0
f	0

<?php
/**
 * Functions to get cache objects.
 *
 * 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
 */

use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MediaWikiServices;

/**
 * Functions to get cache objects
 *
 * The word "cache" has two main dictionary meanings, and both
 * are used in this factory class. They are:
 *
 *   - a) Cache (the computer science definition).
 *        A place to store copies or computations on existing data for
 *        higher access speeds.
 *   - b) Storage.
 *        A place to store lightweight data that is not canonically
 *        stored anywhere else (e.g. a "hoard" of objects).
 *
 * The former should always use strongly consistent stores, so callers don't
 * have to deal with stale reads. The latter may be eventually consistent, but
 * callers can use BagOStuff:READ_LATEST to see the latest available data.
 *
 * Primary entry points:
 *
 * - ObjectCache::getMainWANInstance()
 *   Purpose: Memory cache.
 *   Stored in the local data-center's main cache (keyspace different from local-cluster cache).
 *   Delete events are broadcasted to other DCs main cache. See WANObjectCache for details.
 *
 * - ObjectCache::getLocalServerInstance( $fallbackType )
 *   Purpose: Memory cache for very hot keys.
 *   Stored only on the individual web server (typically APC or APCu for web requests,
 *   and EmptyBagOStuff in CLI mode).
 *   Not replicated to the other servers.
 *
 * - ObjectCache::getLocalClusterInstance()
 *   Purpose: Memory storage for per-cluster coordination and tracking.
 *   A typical use case would be a rate limit counter or cache regeneration mutex.
 *   Stored centrally within the local data-center. Not replicated to other DCs.
 *   Configured by $wgMainCacheType.
 *
 * - ObjectCache::getMainStashInstance()
 *   Purpose: Ephemeral global storage.
 *   Stored centrally within the primary data-center.
 *   Changes are applied there first and replicated to other DCs (best-effort).
 *   To retrieve the latest value (e.g. not from a replica DB), use BagOStuff::READ_LATEST.
 *   This store may be subject to LRU style evictions.
 *
 * - ObjectCache::getInstance( $cacheType )
 *   Purpose: Special cases (like tiered memory/disk caches).
 *   Get a specific cache type by key in $wgObjectCaches.
 *
 * All the above cache instances (BagOStuff and WANObjectCache) have their makeKey()
 * method scoped to the *current* wiki ID. Use makeGlobalKey() to avoid this scoping
 * when using keys that need to be shared amongst wikis.
 *
 * @ingroup Cache
 */
class ObjectCache {
	/** @var BagOStuff[] Map of (id => BagOStuff) */
	public static $instances = [];
	/** @var WANObjectCache[] Map of (id => WANObjectCache) */
	public static $wanInstances = [];

	/**
	 * Get a cached instance of the specified type of cache object.
	 *
	 * @param string $id A key in $wgObjectCaches.
	 * @return BagOStuff
	 */
	public static function getInstance( $id ) {
		if ( !isset( self::$instances[$id] ) ) {
			self::$instances[$id] = self::newFromId( $id );
		}

		return self::$instances[$id];
	}

	/**
	 * Get a cached instance of the specified type of WAN cache object.
	 *
	 * @since 1.26
	 * @param string $id A key in $wgWANObjectCaches.
	 * @return WANObjectCache
	 */
	public static function getWANInstance( $id ) {
		if ( !isset( self::$wanInstances[$id] ) ) {
			self::$wanInstances[$id] = self::newWANCacheFromId( $id );
		}

		return self::$wanInstances[$id];
	}

	/**
	 * Create a new cache object of the specified type.
	 *
	 * @param string $id A key in $wgObjectCaches.
	 * @return BagOStuff
	 * @throws InvalidArgumentException
	 */
	public static function newFromId( $id ) {
		global $wgObjectCaches;

		if ( !isset( $wgObjectCaches[$id] ) ) {
			// Always recognize these ones
			if ( $id === CACHE_NONE ) {

				return new EmptyBagOStuff();
			} elseif ( $id === 'hash' ) {
				return new HashBagOStuff();
			}

			throw new InvalidArgumentException( "Invalid object cache type \"$id\" requested. " .
				"It is not present in \$wgObjectCaches." );
		}

		return self::newFromParams( $wgObjectCaches[$id] );
	}

	/**
	 * Get the default keyspace for this wiki.
	 *
	 * This is either the value of the `CachePrefix` configuration variable,
	 * or (if the former is unset) the `DBname` configuration variable, with
	 * `DBprefix` (if defined).
	 *
	 * @return string
	 */
	public static function getDefaultKeyspace() {
		global $wgCachePrefix;

		$keyspace = $wgCachePrefix;
		if ( is_string( $keyspace ) && $keyspace !== '' ) {
			return $keyspace;
		}

		return wfWikiID();
	}

	/**
	 * Create a new cache object from parameters.
	 *
	 * @param array $params Must have 'factory' or 'class' property.
	 *  - factory: Callback passed $params that returns BagOStuff.
	 *  - class: BagOStuff subclass constructed with $params.
	 *  - loggroup: Alias to set 'logger' key with LoggerFactory group.
	 *  - .. Other parameters passed to factory or class.
	 * @return BagOStuff
	 * @throws InvalidArgumentException
	 */
	public static function newFromParams( $params ) {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
		if ( isset( $params['loggroup'] ) ) {
			$params['logger'] = LoggerFactory::getInstance( $params['loggroup'] );
		} else {
			$params['logger'] = LoggerFactory::getInstance( 'objectcache' );
		}
		if ( !isset( $params['keyspace'] ) ) {
			$params['keyspace'] = self::getDefaultKeyspace();
		}
		if ( isset( $params['factory'] ) ) {
			return call_user_func( $params['factory'], $params );
		} elseif ( isset( $params['class'] ) ) {
			$class = $params['class'];
			// Automatically set the 'async' update handler
			$params['asyncHandler'] = isset( $params['asyncHandler'] )
				? $params['asyncHandler']
				: 'DeferredUpdates::addCallableUpdate';
			// Enable reportDupes by default
			$params['reportDupes'] = isset( $params['reportDupes'] )
				? $params['reportDupes']
				: true;
			// Do b/c logic for SqlBagOStuff
			if ( is_subclass_of( $class, SqlBagOStuff::class ) ) {
				if ( isset( $params['server'] ) && !isset( $params['servers'] ) ) {
					$params['servers'] = [ $params['server'] ];
					unset( $params['server'] );
				}
				// In the past it was not required to set 'dbDirectory' in $wgObjectCaches
				if ( isset( $params['servers'] ) ) {
					foreach ( $params['servers'] as &$server ) {
						if ( $server['type'] === 'sqlite' && !isset( $server['dbDirectory'] ) ) {
							$server['dbDirectory'] = MediaWikiServices::getInstance()
								->getMainConfig()->get( 'SQLiteDataDir' );
						}
					}
				}
			}

			// Do b/c logic for MemcachedBagOStuff
			if ( is_subclass_of( $class, MemcachedBagOStuff::class ) ) {
				if ( !isset( $params['servers'] ) ) {
					$params['servers'] = $GLOBALS['wgMemCachedServers'];
				}
				if ( !isset( $params['debug'] ) ) {
					$params['debug'] = $GLOBALS['wgMemCachedDebug'];
				}
				if ( !isset( $params['persistent'] ) ) {
					$params['persistent'] = $GLOBALS['wgMemCachedPersistent'];
				}
				if ( !isset( $params['timeout'] ) ) {
					$params['timeout'] = $GLOBALS['wgMemCachedTimeout'];
				}
			}
			return new $class( $params );
		} else {
			throw new InvalidArgumentException( "The definition of cache type \""
				. print_r( $params, true ) . "\" lacks both "
				. "factory and class parameters." );
		}
	}

	/**
	 * Factory function for CACHE_ANYTHING (referenced from DefaultSettings.php)
	 *
	 * CACHE_ANYTHING means that stuff has to be cached, not caching is not an option.
	 * If a caching method is configured for any of the main caches ($wgMainCacheType,
	 * $wgMessageCacheType, $wgParserCacheType), then CACHE_ANYTHING will effectively
	 * be an alias to the configured cache choice for that.
	 * If no cache choice is configured (by default $wgMainCacheType is CACHE_NONE),
	 * then CACHE_ANYTHING will forward to CACHE_DB.
	 *
	 * @param array $params
	 * @return BagOStuff
	 */
	public static function newAnything( $params ) {
		global $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType;
		$candidates = [ $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType ];
		foreach ( $candidates as $candidate ) {
			if ( $candidate !== CACHE_NONE && $candidate !== CACHE_ANYTHING ) {
				return self::getInstance( $candidate );
			}
		}

		if ( MediaWikiServices::getInstance()->isServiceDisabled( 'DBLoadBalancer' ) ) {
			// The LoadBalancer is disabled, probably because
			// MediaWikiServices::disableStorageBackend was called.
			$candidate = CACHE_NONE;
		} else {
			$candidate = CACHE_DB;
		}

		return self::getInstance( $candidate );
	}

	/**
	 * Factory function for CACHE_ACCEL (referenced from DefaultSettings.php)
	 *
	 * This will look for any APC or APCu style server-local cache.
	 * A fallback cache can be specified if none is found.
	 *
	 *     // Direct calls
	 *     ObjectCache::getLocalServerInstance( $fallbackType );
	 *
	 *     // From $wgObjectCaches via newFromParams()
	 *     ObjectCache::getLocalServerInstance( [ 'fallback' => $fallbackType ] );
	 *
	 * @param int|string|array $fallback Fallback cache or parameter map with 'fallback'
	 * @return BagOStuff
	 * @throws InvalidArgumentException
	 * @since 1.27
	 */
	public static function getLocalServerInstance( $fallback = CACHE_NONE ) {
		$cache = MediaWikiServices::getInstance()->getLocalServerObjectCache();
		if ( $cache instanceof EmptyBagOStuff ) {
			if ( is_array( $fallback ) ) {
				$fallback = isset( $fallback['fallback'] ) ? $fallback['fallback'] : CACHE_NONE;
			}
			$cache = self::getInstance( $fallback );
		}

		return $cache;
	}

	/**
	 * @param array $params [optional] Array key 'fallback' for $fallback.
	 * @param int|string $fallback Fallback cache, e.g. (CACHE_NONE, "hash") (since 1.24)
	 * @return BagOStuff
	 * @deprecated since 1.27
	 */
	public static function newAccelerator( $params = [], $fallback = null ) {
		if ( $fallback === null ) {
			if ( is_array( $params ) && isset( $params['fallback'] ) ) {
				$fallback = $params['fallback'];
			} elseif ( !is_array( $params ) ) {
				$fallback = $params;
			}
		}

		return self::getLocalServerInstance( $fallback );
	}

	/**
	 * Create a new cache object of the specified type.
	 *
	 * @since 1.26
	 * @param string $id A key in $wgWANObjectCaches.
	 * @return WANObjectCache
	 * @throws UnexpectedValueException
	 */
	public static function newWANCacheFromId( $id ) {
		global $wgWANObjectCaches, $wgObjectCaches;

		if ( !isset( $wgWANObjectCaches[$id] ) ) {
			throw new UnexpectedValueException(
				"Cache type \"$id\" requested is not present in \$wgWANObjectCaches." );
		}

		$params = $wgWANObjectCaches[$id];
		if ( !isset( $wgObjectCaches[$params['cacheId']] ) ) {
			throw new UnexpectedValueException(
				"Cache type \"{$params['cacheId']}\" is not present in \$wgObjectCaches." );
		}
		$params['store'] = $wgObjectCaches[$params['cacheId']];

		return self::newWANCacheFromParams( $params );
	}

	/**
	 * Create a new cache object of the specified type.
	 *
	 * @since 1.28
	 * @param array $params
	 * @return WANObjectCache
	 * @throws UnexpectedValueException
	 */
	public static function newWANCacheFromParams( array $params ) {
		foreach ( $params['channels'] as $action => $channel ) {
			$params['relayers'][$action] = MediaWikiServices::getInstance()->getEventRelayerGroup()
				->getRelayer( $channel );
			$params['channels'][$action] = $channel;
		}
		$params['cache'] = self::newFromParams( $params['store'] );
		if ( isset( $params['loggroup'] ) ) {
			$params['logger'] = LoggerFactory::getInstance( $params['loggroup'] );
		} else {
			$params['logger'] = LoggerFactory::getInstance( 'objectcache' );
		}
		$class = $params['class'];

		return new $class( $params );
	}

	/**
	 * Get the main cluster-local cache object.
	 *
	 * @since 1.27
	 * @return BagOStuff
	 */
	public static function getLocalClusterInstance() {
		global $wgMainCacheType;

		return self::getInstance( $wgMainCacheType );
	}

	/**
	 * Get the main WAN cache object.
	 *
	 * @since 1.26
	 * @return WANObjectCache
	 * @deprecated Since 1.28 Use MediaWikiServices::getMainWANCache()
	 */
	public static function getMainWANInstance() {
		return MediaWikiServices::getInstance()->getMainWANObjectCache();
	}

	/**
	 * Get the cache object for the main stash.
	 *
	 * Stash objects are BagOStuff instances suitable for storing light
	 * weight data that is not canonically stored elsewhere (such as RDBMS).
	 * Stashes should be configured to propagate changes to all data-centers.
	 *
	 * Callers should be prepared for:
	 *   - a) Writes to be slower in non-"primary" (e.g. HTTP GET/HEAD only) DCs
	 *   - b) Reads to be eventually consistent, e.g. for get()/getMulti()
	 * In general, this means avoiding updates on idempotent HTTP requests and
	 * avoiding an assumption of perfect serializability (or accepting anomalies).
	 * Reads may be eventually consistent or data might rollback as nodes flap.
	 * Callers can use BagOStuff:READ_LATEST to see the latest available data.
	 *
	 * @return BagOStuff
	 * @since 1.26
	 * @deprecated Since 1.28 Use MediaWikiServices::getMainObjectStash
	 */
	public static function getMainStashInstance() {
		return MediaWikiServices::getInstance()->getMainObjectStash();
	}

	/**
	 * Clear all the cached instances.
	 */
	public static function clear() {
		self::$instances = [];
		self::$wanInstances = [];
	}
}


1		<?php
2		/**
3		* Functions to get cache objects.
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		use MediaWiki\Logger\LoggerFactory;
25		use MediaWiki\MediaWikiServices;
26
27		/**
28		* Functions to get cache objects
29		*
30		* The word "cache" has two main dictionary meanings, and both
31		* are used in this factory class. They are:
32		*
33		* - a) Cache (the computer science definition).
34		* A place to store copies or computations on existing data for
35		* higher access speeds.
36		* - b) Storage.
37		* A place to store lightweight data that is not canonically
38		* stored anywhere else (e.g. a "hoard" of objects).
39		*
40		* The former should always use strongly consistent stores, so callers don't
41		* have to deal with stale reads. The latter may be eventually consistent, but
42		* callers can use BagOStuff:READ_LATEST to see the latest available data.
43		*
44		* Primary entry points:
45		*
46		* - ObjectCache::getMainWANInstance()
47		* Purpose: Memory cache.
48		* Stored in the local data-center's main cache (keyspace different from local-cluster cache).
49		* Delete events are broadcasted to other DCs main cache. See WANObjectCache for details.
50		*
51		* - ObjectCache::getLocalServerInstance( $fallbackType )
52		* Purpose: Memory cache for very hot keys.
53		* Stored only on the individual web server (typically APC or APCu for web requests,
54		* and EmptyBagOStuff in CLI mode).
55		* Not replicated to the other servers.
56		*
57		* - ObjectCache::getLocalClusterInstance()
58		* Purpose: Memory storage for per-cluster coordination and tracking.
59		* A typical use case would be a rate limit counter or cache regeneration mutex.
60		* Stored centrally within the local data-center. Not replicated to other DCs.
61		* Configured by $wgMainCacheType.
62		*
63		* - ObjectCache::getMainStashInstance()
64		* Purpose: Ephemeral global storage.
65		* Stored centrally within the primary data-center.
66		* Changes are applied there first and replicated to other DCs (best-effort).
67		* To retrieve the latest value (e.g. not from a replica DB), use BagOStuff::READ_LATEST.
68		* This store may be subject to LRU style evictions.
69		*
70		* - ObjectCache::getInstance( $cacheType )
71		* Purpose: Special cases (like tiered memory/disk caches).
72		* Get a specific cache type by key in $wgObjectCaches.
73		*
74		* All the above cache instances (BagOStuff and WANObjectCache) have their makeKey()
75		* method scoped to the current wiki ID. Use makeGlobalKey() to avoid this scoping
76		* when using keys that need to be shared amongst wikis.
77		*
78		* @ingroup Cache
79		*/
80		class ObjectCache {
81		/** @var BagOStuff[] Map of (id => BagOStuff) */
82		public static $instances = [];
83		/** @var WANObjectCache[] Map of (id => WANObjectCache) */
84		public static $wanInstances = [];
85
86		/**
87		* Get a cached instance of the specified type of cache object.
88		*
89		* @param string $id A key in $wgObjectCaches.
90		* @return BagOStuff
91		*/
92		public static function getInstance( $id ) {
93		if ( !isset( self::$instances[$id] ) ) {
94		self::$instances[$id] = self::newFromId( $id );
95		}
96
97		return self::$instances[$id];
98		}
99
100		/**
101		* Get a cached instance of the specified type of WAN cache object.
102		*
103		* @since 1.26
104		* @param string $id A key in $wgWANObjectCaches.
105		* @return WANObjectCache
106		*/
107		public static function getWANInstance( $id ) {
108		if ( !isset( self::$wanInstances[$id] ) ) {
109		self::$wanInstances[$id] = self::newWANCacheFromId( $id );
110		}
111
112		return self::$wanInstances[$id];
113		}
114
115		/**
116		* Create a new cache object of the specified type.
117		*
118		* @param string $id A key in $wgObjectCaches.
119		* @return BagOStuff
120		* @throws InvalidArgumentException
121		*/
122		public static function newFromId( $id ) {
123		global $wgObjectCaches;
124
125		if ( !isset( $wgObjectCaches[$id] ) ) {
126		// Always recognize these ones
127		if ( $id === CACHE_NONE ) {
		0 ignored issues – show Unused Code Bug introduced 2016-09-22 18:35 UTC by Report Bug Copy Issue Report The strict comparison `===` seems to always evaluate to `false` as the types of `$id` (`string`) and `CACHE_NONE` (`integer`) can never be identical. Maybe you want to use a loose comparison `==` instead? Loading history...
128		return new EmptyBagOStuff();
129		} elseif ( $id === 'hash' ) {
130		return new HashBagOStuff();
131		}
132
133		throw new InvalidArgumentException( "Invalid object cache type \"$id\" requested. " .
134		"It is not present in \$wgObjectCaches." );
135		}
136
137		return self::newFromParams( $wgObjectCaches[$id] );
138		}
139
140		/**
141		* Get the default keyspace for this wiki.
142		*
143		* This is either the value of the `CachePrefix` configuration variable,
144		* or (if the former is unset) the `DBname` configuration variable, with
145		* `DBprefix` (if defined).
146		*
147		* @return string
148		*/
149		public static function getDefaultKeyspace() {
150		global $wgCachePrefix;
151
152		$keyspace = $wgCachePrefix;
153		if ( is_string( $keyspace ) && $keyspace !== '' ) {
154		return $keyspace;
155		}
156
157		return wfWikiID();
158		}
159
160		/**
161		* Create a new cache object from parameters.
162		*
163		* @param array $params Must have 'factory' or 'class' property.
164		* - factory: Callback passed $params that returns BagOStuff.
165		* - class: BagOStuff subclass constructed with $params.
166		* - loggroup: Alias to set 'logger' key with LoggerFactory group.
167		* - .. Other parameters passed to factory or class.
168		* @return BagOStuff
169		* @throws InvalidArgumentException
170		*/
171		public static function newFromParams( $params ) {
		0 ignored issues – show Coding Style introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report `newFromParams` uses the super-global variable `$GLOBALS` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
172	View Code Duplication	if ( isset( $params['loggroup'] ) ) {
173		$params['logger'] = LoggerFactory::getInstance( $params['loggroup'] );
174		} else {
175		$params['logger'] = LoggerFactory::getInstance( 'objectcache' );
176		}
177		if ( !isset( $params['keyspace'] ) ) {
178		$params['keyspace'] = self::getDefaultKeyspace();
179		}
180		if ( isset( $params['factory'] ) ) {
181		return call_user_func( $params['factory'], $params );
182		} elseif ( isset( $params['class'] ) ) {
183		$class = $params['class'];
184		// Automatically set the 'async' update handler
185		$params['asyncHandler'] = isset( $params['asyncHandler'] )
186		? $params['asyncHandler']
187		: 'DeferredUpdates::addCallableUpdate';
188		// Enable reportDupes by default
189		$params['reportDupes'] = isset( $params['reportDupes'] )
190		? $params['reportDupes']
191		: true;
192		// Do b/c logic for SqlBagOStuff
193		if ( is_subclass_of( $class, SqlBagOStuff::class ) ) {
194		if ( isset( $params['server'] ) && !isset( $params['servers'] ) ) {
195		$params['servers'] = [ $params['server'] ];
196		unset( $params['server'] );
197		}
198		// In the past it was not required to set 'dbDirectory' in $wgObjectCaches
199		if ( isset( $params['servers'] ) ) {
200		foreach ( $params['servers'] as &$server ) {
201		if ( $server['type'] === 'sqlite' && !isset( $server['dbDirectory'] ) ) {
202		$server['dbDirectory'] = MediaWikiServices::getInstance()
203		->getMainConfig()->get( 'SQLiteDataDir' );
204		}
205		}
206		}
207		}
208
209		// Do b/c logic for MemcachedBagOStuff
210		if ( is_subclass_of( $class, MemcachedBagOStuff::class ) ) {
211		if ( !isset( $params['servers'] ) ) {
212		$params['servers'] = $GLOBALS['wgMemCachedServers'];
213		}
214		if ( !isset( $params['debug'] ) ) {
215		$params['debug'] = $GLOBALS['wgMemCachedDebug'];
216		}
217		if ( !isset( $params['persistent'] ) ) {
218		$params['persistent'] = $GLOBALS['wgMemCachedPersistent'];
219		}
220		if ( !isset( $params['timeout'] ) ) {
221		$params['timeout'] = $GLOBALS['wgMemCachedTimeout'];
222		}
223		}
224		return new $class( $params );
225		} else {
226		throw new InvalidArgumentException( "The definition of cache type \""
227		. print_r( $params, true ) . "\" lacks both "
228		. "factory and class parameters." );
229		}
230		}
231
232		/**
233		* Factory function for CACHE_ANYTHING (referenced from DefaultSettings.php)
234		*
235		* CACHE_ANYTHING means that stuff has to be cached, not caching is not an option.
236		* If a caching method is configured for any of the main caches ($wgMainCacheType,
237		* $wgMessageCacheType, $wgParserCacheType), then CACHE_ANYTHING will effectively
238		* be an alias to the configured cache choice for that.
239		* If no cache choice is configured (by default $wgMainCacheType is CACHE_NONE),
240		* then CACHE_ANYTHING will forward to CACHE_DB.
241		*
242		* @param array $params
243		* @return BagOStuff
244		*/
245		public static function newAnything( $params ) {
246		global $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType;
247		$candidates = [ $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType ];
248		foreach ( $candidates as $candidate ) {
249		if ( $candidate !== CACHE_NONE && $candidate !== CACHE_ANYTHING ) {
250		return self::getInstance( $candidate );
251		}
252		}
253
254		if ( MediaWikiServices::getInstance()->isServiceDisabled( 'DBLoadBalancer' ) ) {
255		// The LoadBalancer is disabled, probably because
256		// MediaWikiServices::disableStorageBackend was called.
257		$candidate = CACHE_NONE;
258		} else {
259		$candidate = CACHE_DB;
260		}
261
262		return self::getInstance( $candidate );
263		}
264
265		/**
266		* Factory function for CACHE_ACCEL (referenced from DefaultSettings.php)
267		*
268		* This will look for any APC or APCu style server-local cache.
269		* A fallback cache can be specified if none is found.
270		*
271		* // Direct calls
272		* ObjectCache::getLocalServerInstance( $fallbackType );
273		*
274		* // From $wgObjectCaches via newFromParams()
275		* ObjectCache::getLocalServerInstance( [ 'fallback' => $fallbackType ] );
276		*
277		* @param int\|string\|array $fallback Fallback cache or parameter map with 'fallback'
278		* @return BagOStuff
279		* @throws InvalidArgumentException
280		* @since 1.27
281		*/
282		public static function getLocalServerInstance( $fallback = CACHE_NONE ) {
283		$cache = MediaWikiServices::getInstance()->getLocalServerObjectCache();
284		if ( $cache instanceof EmptyBagOStuff ) {
285		if ( is_array( $fallback ) ) {
286		$fallback = isset( $fallback['fallback'] ) ? $fallback['fallback'] : CACHE_NONE;
287		}
288		$cache = self::getInstance( $fallback );
289		}
290
291		return $cache;
292		}
293
294		/**
295		* @param array $params [optional] Array key 'fallback' for $fallback.
296		* @param int\|string $fallback Fallback cache, e.g. (CACHE_NONE, "hash") (since 1.24)
297		* @return BagOStuff
298		* @deprecated since 1.27
299		*/
300		public static function newAccelerator( $params = [], $fallback = null ) {
301		if ( $fallback === null ) {
302		if ( is_array( $params ) && isset( $params['fallback'] ) ) {
303		$fallback = $params['fallback'];
304		} elseif ( !is_array( $params ) ) {
305		$fallback = $params;
306		}
307		}
308
309		return self::getLocalServerInstance( $fallback );
310		}
311
312		/**
313		* Create a new cache object of the specified type.
314		*
315		* @since 1.26
316		* @param string $id A key in $wgWANObjectCaches.
317		* @return WANObjectCache
318		* @throws UnexpectedValueException
319		*/
320		public static function newWANCacheFromId( $id ) {
321		global $wgWANObjectCaches, $wgObjectCaches;
322
323		if ( !isset( $wgWANObjectCaches[$id] ) ) {
324		throw new UnexpectedValueException(
325		"Cache type \"$id\" requested is not present in \$wgWANObjectCaches." );
326		}
327
328		$params = $wgWANObjectCaches[$id];
329		if ( !isset( $wgObjectCaches[$params['cacheId']] ) ) {
330		throw new UnexpectedValueException(
331		"Cache type \"{$params['cacheId']}\" is not present in \$wgObjectCaches." );
332		}
333		$params['store'] = $wgObjectCaches[$params['cacheId']];
334
335		return self::newWANCacheFromParams( $params );
336		}
337
338		/**
339		* Create a new cache object of the specified type.
340		*
341		* @since 1.28
342		* @param array $params
343		* @return WANObjectCache
344		* @throws UnexpectedValueException
345		*/
346		public static function newWANCacheFromParams( array $params ) {
347		foreach ( $params['channels'] as $action => $channel ) {
348		$params['relayers'][$action] = MediaWikiServices::getInstance()->getEventRelayerGroup()
349		->getRelayer( $channel );
350		$params['channels'][$action] = $channel;
351		}
352		$params['cache'] = self::newFromParams( $params['store'] );
353	View Code Duplication	if ( isset( $params['loggroup'] ) ) {
354		$params['logger'] = LoggerFactory::getInstance( $params['loggroup'] );
355		} else {
356		$params['logger'] = LoggerFactory::getInstance( 'objectcache' );
357		}
358		$class = $params['class'];
359
360		return new $class( $params );
361		}
362
363		/**
364		* Get the main cluster-local cache object.
365		*
366		* @since 1.27
367		* @return BagOStuff
368		*/
369		public static function getLocalClusterInstance() {
370		global $wgMainCacheType;
371
372		return self::getInstance( $wgMainCacheType );
373		}
374
375		/**
376		* Get the main WAN cache object.
377		*
378		* @since 1.26
379		* @return WANObjectCache
380		* @deprecated Since 1.28 Use MediaWikiServices::getMainWANCache()
381		*/
382		public static function getMainWANInstance() {
383		return MediaWikiServices::getInstance()->getMainWANObjectCache();
384		}
385
386		/**
387		* Get the cache object for the main stash.
388		*
389		* Stash objects are BagOStuff instances suitable for storing light
390		* weight data that is not canonically stored elsewhere (such as RDBMS).
391		* Stashes should be configured to propagate changes to all data-centers.
392		*
393		* Callers should be prepared for:
394		* - a) Writes to be slower in non-"primary" (e.g. HTTP GET/HEAD only) DCs
395		* - b) Reads to be eventually consistent, e.g. for get()/getMulti()
396		* In general, this means avoiding updates on idempotent HTTP requests and
397		* avoiding an assumption of perfect serializability (or accepting anomalies).
398		* Reads may be eventually consistent or data might rollback as nodes flap.
399		* Callers can use BagOStuff:READ_LATEST to see the latest available data.
400		*
401		* @return BagOStuff
402		* @since 1.26
403		* @deprecated Since 1.28 Use MediaWikiServices::getMainObjectStash
404		*/
405		public static function getMainStashInstance() {
406		return MediaWikiServices::getInstance()->getMainObjectStash();
407		}
408
409		/**
410		* Clear all the cached instances.
411		*/
412		public static function clear() {
413		self::$instances = [];
414		self::$wanInstances = [];
415		}
416		}
417

wikimedia / mediawiki

Branch — master (24200e)

ObjectCache::newFromId() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like