use CLDRPluralRuleParser\Evaluator;
use CLDRPluralRuleParser\Error as CLDRPluralRuleError;
-use MediaWiki\Logger\LoggerFactory;
-use MediaWiki\MediaWikiServices;
+use MediaWiki\Config\ServiceOptions;
+use MediaWiki\Languages\LanguageNameUtils;
+use Psr\Log\LoggerInterface;
/**
* Class for caching the contents of localisation files, Messages*.php
* and *.i18n.php.
*
- * An instance of this class is available using Language::getLocalisationCache().
+ * An instance of this class is available using MediaWikiServices.
*
* The values retrieved from here are merged, containing items from extension
* files, core messages files and the language fallback sequence (e.g. zh-cn ->
class LocalisationCache {
const VERSION = 4;
- /** Configuration associative array */
- private $conf;
+ /** @var ServiceOptions */
+ private $options;
/**
* True if recaching should only be done on an explicit call to recache().
*/
private $manualRecache = false;
- /**
- * True to treat all files as expired until they are regenerated by this object.
- */
- private $forceRecache = false;
-
/**
* The cache data. 3-d array, where the first key is the language code,
* the second key is the item key e.g. 'messages', and the third key is
private $store;
/**
- * @var \Psr\Log\LoggerInterface
+ * @var LoggerInterface
*/
private $logger;
+ /** @var callable[] See comment for parameter in constructor */
+ private $clearStoreCallbacks;
+
+ /** @var LanguageNameUtils */
+ private $langNameUtils;
+
/**
* A 2-d associative array, code/key, where presence indicates that the item
* is loaded. Value arbitrary.
*
* For split items, if set, this indicates that all of the subitems have been
* loaded.
+ *
*/
private $loadedItems = [];
private $mergeableKeys = null;
/**
- * For constructor parameters, see the documentation in DefaultSettings.php
- * for $wgLocalisationCacheConf.
+ * Return a suitable LCStore as specified by the given configuration.
*
- * @param array $conf
- * @throws MWException
+ * @since 1.34
+ * @param array $conf In the format of $wgLocalisationCacheConf
+ * @param string|false|null $fallbackCacheDir In case 'storeDirectory' isn't specified
+ * @return LCStore
*/
- function __construct( $conf ) {
- global $wgCacheDirectory;
-
- $this->conf = $conf;
- $this->logger = LoggerFactory::getInstance( 'localisation' );
-
- $directory = !empty( $conf['storeDirectory'] ) ? $conf['storeDirectory'] : $wgCacheDirectory;
+ public static function getStoreFromConf( array $conf, $fallbackCacheDir ) : LCStore {
$storeArg = [];
- $storeArg['directory'] = $directory;
+ $storeArg['directory'] =
+ $conf['storeDirectory'] ?: $fallbackCacheDir;
if ( !empty( $conf['storeClass'] ) ) {
$storeClass = $conf['storeClass'];
+ } elseif ( $conf['store'] === 'files' || $conf['store'] === 'file' ||
+ ( $conf['store'] === 'detect' && $storeArg['directory'] )
+ ) {
+ $storeClass = LCStoreCDB::class;
+ } elseif ( $conf['store'] === 'db' || $conf['store'] === 'detect' ) {
+ $storeClass = LCStoreDB::class;
+ $storeArg['server'] = $conf['storeServer'] ?? [];
+ } elseif ( $conf['store'] === 'array' ) {
+ $storeClass = LCStoreStaticArray::class;
} else {
- switch ( $conf['store'] ) {
- case 'files':
- case 'file':
- $storeClass = LCStoreCDB::class;
- break;
- case 'db':
- $storeClass = LCStoreDB::class;
- $storeArg['server'] = $conf['storeServer'] ?? [];
- break;
- case 'array':
- $storeClass = LCStoreStaticArray::class;
- break;
- case 'detect':
- if ( $directory ) {
- $storeClass = LCStoreCDB::class;
- } else {
- $storeClass = LCStoreDB::class;
- $storeArg['server'] = $conf['storeServer'] ?? [];
- }
- break;
- default:
- throw new MWException(
- 'Please set $wgLocalisationCacheConf[\'store\'] to something sensible.'
- );
- }
+ throw new MWException(
+ 'Please set $wgLocalisationCacheConf[\'store\'] to something sensible.'
+ );
}
- $this->logger->debug( static::class . ": using store $storeClass" );
- $this->store = new $storeClass( $storeArg );
- foreach ( [ 'manualRecache', 'forceRecache' ] as $var ) {
- if ( isset( $conf[$var] ) ) {
- $this->$var = $conf[$var];
- }
- }
+ return new $storeClass( $storeArg );
+ }
+
+ /**
+ * @var array
+ * @since 1.34
+ */
+ public const CONSTRUCTOR_OPTIONS = [
+ // True to treat all files as expired until they are regenerated by this object.
+ 'forceRecache',
+ 'manualRecache',
+ 'ExtensionMessagesFiles',
+ 'MessagesDirs',
+ ];
+
+ /**
+ * For constructor parameters, see the documentation in DefaultSettings.php
+ * for $wgLocalisationCacheConf.
+ *
+ * Do not construct this directly. Use MediaWikiServices.
+ *
+ * @param ServiceOptions $options
+ * @param LCStore $store What backend to use for storage
+ * @param LoggerInterface $logger
+ * @param callable[] $clearStoreCallbacks To be called whenever the cache is cleared. Can be
+ * used to clear other caches that depend on this one, such as ResourceLoader's
+ * MessageBlobStore.
+ * @param LanguageNameUtils $langNameUtils
+ * @throws MWException
+ */
+ function __construct(
+ ServiceOptions $options,
+ LCStore $store,
+ LoggerInterface $logger,
+ array $clearStoreCallbacks,
+ LanguageNameUtils $langNameUtils
+ ) {
+ $options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
+
+ $this->options = $options;
+ $this->store = $store;
+ $this->logger = $logger;
+ $this->clearStoreCallbacks = $clearStoreCallbacks;
+ $this->langNameUtils = $langNameUtils;
+
+ // Keep this separate from $this->options so it can be mutable
+ $this->manualRecache = $options->get( 'manualRecache' );
}
/**
* @return bool
*/
public function isExpired( $code ) {
- if ( $this->forceRecache && !isset( $this->recachedLangs[$code] ) ) {
+ if ( $this->options->get( 'forceRecache' ) && !isset( $this->recachedLangs[$code] ) ) {
$this->logger->debug( __METHOD__ . "($code): forced reload" );
return true;
$this->initialisedLangs[$code] = true;
# If the code is of the wrong form for a Messages*.php file, do a shallow fallback
- if ( !Language::isValidBuiltInCode( $code ) ) {
+ if ( !$this->langNameUtils->isValidBuiltInCode( $code ) ) {
$this->initShallowFallback( $code, 'en' );
return;
# Recache the data if necessary
if ( !$this->manualRecache && $this->isExpired( $code ) ) {
- if ( Language::isSupportedLanguage( $code ) ) {
+ if ( $this->langNameUtils->isSupportedLanguage( $code ) ) {
$this->recache( $code );
} elseif ( $code === 'en' ) {
throw new MWException( 'MessagesEn.php is missing.' );
* @return array
*/
protected function readPHPFile( $_fileName, $_fileType ) {
- // Disable APC caching
- Wikimedia\suppressWarnings();
- $_apcEnabled = ini_set( 'apc.cache_by_default', '0' );
- Wikimedia\restoreWarnings();
-
include $_fileName;
- Wikimedia\suppressWarnings();
- ini_set( 'apc.cache_by_default', $_apcEnabled );
- Wikimedia\restoreWarnings();
-
$data = [];
if ( $_fileType == 'core' || $_fileType == 'extension' ) {
foreach ( self::$allKeys as $key ) {
global $IP;
// This reads in the PHP i18n file with non-messages l10n data
- $fileName = Language::getMessagesFileName( $code );
+ $fileName = $this->langNameUtils->getMessagesFileName( $code );
if ( !file_exists( $fileName ) ) {
$data = [];
} else {
if ( in_array( $key, self::$mergeableMapKeys ) ) {
$value = $value + $fallbackValue;
} elseif ( in_array( $key, self::$mergeableListKeys ) ) {
+ // @phan-suppress-next-line PhanTypeMismatchArgumentInternal
$value = array_unique( array_merge( $fallbackValue, $value ) );
} elseif ( in_array( $key, self::$mergeableAliasListKeys ) ) {
$value = array_merge_recursive( $value, $fallbackValue );
public function getMessagesDirs() {
global $IP;
- $config = MediaWikiServices::getInstance()->getMainConfig();
- $messagesDirs = $config->get( 'MessagesDirs' );
return [
'core' => "$IP/languages/i18n",
'exif' => "$IP/languages/i18n/exif",
'api' => "$IP/includes/api/i18n",
'oojs-ui' => "$IP/resources/lib/ooui/i18n",
- ] + $messagesDirs;
+ ] + $this->options->get( 'MessagesDirs' );
}
/**
* @throws MWException
*/
public function recache( $code ) {
- global $wgExtensionMessagesFiles;
-
if ( !$code ) {
throw new MWException( "Invalid language code requested" );
}
- $this->recachedLangs[$code] = true;
+ $this->recachedLangs[ $code ] = true;
# Initial values
$initialData = array_fill_keys( self::$allKeys, null );
# Load the primary localisation from the source file
$data = $this->readSourceFilesAndRegisterDeps( $code, $deps );
- if ( $data === false ) {
- $this->logger->debug( __METHOD__ . ": no localisation file for $code, using fallback to en" );
- $coreData['fallback'] = 'en';
- } else {
- $this->logger->debug( __METHOD__ . ": got localisation for $code from source" );
+ $this->logger->debug( __METHOD__ . ": got localisation for $code from source" );
- # Merge primary localisation
- foreach ( $data as $key => $value ) {
- $this->mergeItem( $key, $coreData[$key], $value );
- }
+ # Merge primary localisation
+ foreach ( $data as $key => $value ) {
+ $this->mergeItem( $key, $coreData[ $key ], $value );
}
# Fill in the fallback if it's not there already
# Load non-JSON localisation data for extensions
$extensionData = array_fill_keys( $codeSequence, $initialData );
- foreach ( $wgExtensionMessagesFiles as $extension => $fileName ) {
+ foreach ( $this->options->get( 'ExtensionMessagesFiles' ) as $extension => $fileName ) {
if ( isset( $messageDirs[$extension] ) ) {
# This extension has JSON message data; skip the PHP shim
continue;
# Load the secondary localisation from the source file to
# avoid infinite cycles on cyclic fallbacks
$fbData = $this->readSourceFilesAndRegisterDeps( $csCode, $deps );
- if ( $fbData !== false ) {
- # Only merge the keys that make sense to merge
- foreach ( self::$allKeys as $key ) {
- if ( !isset( $fbData[$key] ) ) {
- continue;
- }
-
- if ( is_null( $coreData[$key] ) || $this->isMergeableKey( $key ) ) {
- $this->mergeItem( $key, $csData[$key], $fbData[$key] );
- }
+ # Only merge the keys that make sense to merge
+ foreach ( self::$allKeys as $key ) {
+ if ( !isset( $fbData[ $key ] ) ) {
+ continue;
+ }
+
+ if ( is_null( $coreData[ $key ] ) || $this->isMergeableKey( $key ) ) {
+ $this->mergeItem( $key, $csData[ $key ], $fbData[ $key ] );
}
}
}
# HACK: If using a null (i.e. disabled) storage backend, we
# can't write to the MessageBlobStore either
if ( !$this->store instanceof LCStoreNull ) {
- $blobStore = MediaWikiServices::getInstance()->getResourceLoader()->getMessageBlobStore();
- $blobStore->clear();
+ foreach ( $this->clearStoreCallbacks as $callback ) {
+ $callback();
+ }
}
}
$this->store = new LCStoreNull;
$this->manualRecache = false;
}
-
}