use MediaWiki\Logger\LoggerFactory;
use MediaWiki\MediaWikiServices;
-use MediaWiki\Services\ServiceDisabledException;
/**
* Functions to get cache objects
* 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 later may be eventually consistent, but
+ * 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::getLocalServerInstance( $fallbackType )
* Purpose: Memory cache for very hot keys.
- * Stored only on the individual web server (typically APC for web requests,
+ * 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.
*
* 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 slave), use BagOStuff::READ_LATEST.
+ * 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 )
*
* @param string $id A key in $wgObjectCaches.
* @return BagOStuff
- * @throws MWException
+ * @throws InvalidArgumentException
*/
public static function newFromId( $id ) {
global $wgObjectCaches;
if ( !isset( $wgObjectCaches[$id] ) ) {
- throw new MWException( "Invalid object cache type \"$id\" requested. " .
+ // 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." );
}
* - loggroup: Alias to set 'logger' key with LoggerFactory group.
* - .. Other parameters passed to factory or class.
* @return BagOStuff
- * @throws MWException
+ * @throws InvalidArgumentException
*/
public static function newFromParams( $params ) {
if ( isset( $params['loggroup'] ) ) {
$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' ) ) {
+ if ( is_subclass_of( $class, MemcachedBagOStuff::class ) ) {
if ( !isset( $params['servers'] ) ) {
$params['servers'] = $GLOBALS['wgMemCachedServers'];
}
}
return new $class( $params );
} else {
- throw new MWException( "The definition of cache type \""
+ throw new InvalidArgumentException( "The definition of cache type \""
. print_r( $params, true ) . "\" lacks both "
. "factory and class parameters." );
}
/**
* Factory function for CACHE_ACCEL (referenced from DefaultSettings.php)
*
- * This will look for any APC style server-local cache.
+ * This will look for any APC or APCu style server-local cache.
* A fallback cache can be specified if none is found.
*
* // Direct calls
*
* @param int|string|array $fallback Fallback cache or parameter map with 'fallback'
* @return BagOStuff
- * @throws MWException
+ * @throws InvalidArgumentException
* @since 1.27
*/
public static function getLocalServerInstance( $fallback = CACHE_NONE ) {
if ( function_exists( 'apc_fetch' ) ) {
$id = 'apc';
+ } elseif ( function_exists( 'apcu_fetch' ) ) {
+ $id = 'apcu';
} elseif ( function_exists( 'xcache_get' ) && wfIniGetBool( 'xcache.var_size' ) ) {
$id = 'xcache';
} elseif ( function_exists( 'wincache_ucache_get' ) ) {
* @since 1.26
* @param string $id A key in $wgWANObjectCaches.
* @return WANObjectCache
- * @throws MWException
+ * @throws UnexpectedValueException
*/
public static function newWANCacheFromId( $id ) {
- global $wgWANObjectCaches;
+ global $wgWANObjectCaches, $wgObjectCaches;
if ( !isset( $wgWANObjectCaches[$id] ) ) {
- throw new MWException( "Invalid object cache type \"$id\" requested. " .
- "It is not present in \$wgWANObjectCaches." );
+ 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::newFromId( $params['cacheId'] );
+ $params['cache'] = self::newFromParams( $params['store'] );
if ( isset( $params['loggroup'] ) ) {
$params['logger'] = LoggerFactory::getInstance( $params['loggroup'] );
} else {
dépôts / lhc / web / wiklou.git / blobdiff