3 * Cache of the contents of localisation files.
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.
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.
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
23 use CLDRPluralRuleParser\Evaluator
;
24 use CLDRPluralRuleParser\Error
as CLDRPluralRuleError
;
25 use MediaWiki\MediaWikiServices
;
28 * Class for caching the contents of localisation files, Messages*.php
31 * An instance of this class is available using Language::getLocalisationCache().
33 * The values retrieved from here are merged, containing items from extension
34 * files, core messages files and the language fallback sequence (e.g. zh-cn ->
35 * zh-hans -> en ). Some common errors are corrected, for example namespace
36 * names with spaces instead of underscores, but heavyweight processing, such
37 * as grammatical transformation, is done by the caller.
39 class LocalisationCache
{
42 /** Configuration associative array */
46 * True if recaching should only be done on an explicit call to recache().
47 * Setting this reduces the overhead of cache freshness checking, which
48 * requires doing a stat() for every extension i18n file.
50 private $manualRecache = false;
53 * True to treat all files as expired until they are regenerated by this object.
55 private $forceRecache = false;
58 * The cache data. 3-d array, where the first key is the language code,
59 * the second key is the item key e.g. 'messages', and the third key is
60 * an item specific subkey index. Some items are not arrays and so for those
61 * items, there are no subkeys.
66 * The persistent store object. An instance of LCStore.
73 * A 2-d associative array, code/key, where presence indicates that the item
74 * is loaded. Value arbitrary.
76 * For split items, if set, this indicates that all of the subitems have been
79 private $loadedItems = [];
82 * A 3-d associative array, code/key/subkey, where presence indicates that
83 * the subitem is loaded. Only used for the split items, i.e. messages.
85 private $loadedSubitems = [];
88 * An array where presence of a key indicates that that language has been
89 * initialised. Initialisation includes checking for cache expiry and doing
90 * any necessary updates.
92 private $initialisedLangs = [];
95 * An array mapping non-existent pseudo-languages to fallback languages. This
96 * is filled by initShallowFallback() when data is requested from a language
97 * that lacks a Messages*.php file.
99 private $shallowFallbacks = [];
102 * An array where the keys are codes that have been recached by this instance.
104 private $recachedLangs = [];
109 static public $allKeys = [
110 'fallback', 'namespaceNames', 'bookstoreList',
111 'magicWords', 'messages', 'rtl', 'capitalizeAllNouns', 'digitTransformTable',
112 'separatorTransformTable', 'minimumGroupingDigits',
113 'fallback8bitEncoding', 'linkPrefixExtension',
114 'linkTrail', 'linkPrefixCharset', 'namespaceAliases',
115 'dateFormats', 'datePreferences', 'datePreferenceMigrationMap',
116 'defaultDateFormat', 'extraUserToggles', 'specialPageAliases',
117 'imageFiles', 'preloadedMessages', 'namespaceGenderAliases',
118 'digitGroupingPattern', 'pluralRules', 'pluralRuleTypes', 'compiledPluralRules',
122 * Keys for items which consist of associative arrays, which may be merged
123 * by a fallback sequence.
125 static public $mergeableMapKeys = [ 'messages', 'namespaceNames',
126 'namespaceAliases', 'dateFormats', 'imageFiles', 'preloadedMessages'
130 * Keys for items which are a numbered array.
132 static public $mergeableListKeys = [ 'extraUserToggles' ];
135 * Keys for items which contain an array of arrays of equivalent aliases
136 * for each subitem. The aliases may be merged by a fallback sequence.
138 static public $mergeableAliasListKeys = [ 'specialPageAliases' ];
141 * Keys for items which contain an associative array, and may be merged if
142 * the primary value contains the special array key "inherit". That array
143 * key is removed after the first merge.
145 static public $optionalMergeKeys = [ 'bookstoreList' ];
148 * Keys for items that are formatted like $magicWords
150 static public $magicWordKeys = [ 'magicWords' ];
153 * Keys for items where the subitems are stored in the backend separately.
155 static public $splitKeys = [ 'messages' ];
158 * Keys which are loaded automatically by initLanguage()
160 static public $preloadedKeys = [ 'dateFormats', 'namespaceNames' ];
163 * Associative array of cached plural rules. The key is the language code,
164 * the value is an array of plural rules for that language.
166 private $pluralRules = null;
169 * Associative array of cached plural rule types. The key is the language
170 * code, the value is an array of plural rule types for that language. For
171 * example, $pluralRuleTypes['ar'] = ['zero', 'one', 'two', 'few', 'many'].
172 * The index for each rule type matches the index for the rule in
173 * $pluralRules, thus allowing correlation between the two. The reason we
174 * don't just use the type names as the keys in $pluralRules is because
175 * Language::convertPlural applies the rules based on numeric order (or
176 * explicit numeric parameter), not based on the name of the rule type. For
177 * example, {{plural:count|wordform1|wordform2|wordform3}}, rather than
178 * {{plural:count|one=wordform1|two=wordform2|many=wordform3}}.
180 private $pluralRuleTypes = null;
182 private $mergeableKeys = null;
185 * For constructor parameters, see the documentation in DefaultSettings.php
186 * for $wgLocalisationCacheConf.
189 * @throws MWException
191 function __construct( $conf ) {
192 global $wgCacheDirectory;
196 if ( !empty( $conf['storeClass'] ) ) {
197 $storeClass = $conf['storeClass'];
199 switch ( $conf['store'] ) {
202 $storeClass = LCStoreCDB
::class;
205 $storeClass = LCStoreDB
::class;
208 $storeClass = LCStoreStaticArray
::class;
211 if ( !empty( $conf['storeDirectory'] ) ) {
212 $storeClass = LCStoreCDB
::class;
213 } elseif ( $wgCacheDirectory ) {
214 $storeConf['directory'] = $wgCacheDirectory;
215 $storeClass = LCStoreCDB
::class;
217 $storeClass = LCStoreDB
::class;
221 throw new MWException(
222 'Please set $wgLocalisationCacheConf[\'store\'] to something sensible.'
227 wfDebugLog( 'caches', static::class . ": using store $storeClass" );
228 if ( !empty( $conf['storeDirectory'] ) ) {
229 $storeConf['directory'] = $conf['storeDirectory'];
232 $this->store
= new $storeClass( $storeConf );
233 foreach ( [ 'manualRecache', 'forceRecache' ] as $var ) {
234 if ( isset( $conf[$var] ) ) {
235 $this->$var = $conf[$var];
241 * Returns true if the given key is mergeable, that is, if it is an associative
242 * array which can be merged through a fallback sequence.
246 public function isMergeableKey( $key ) {
247 if ( $this->mergeableKeys
=== null ) {
248 $this->mergeableKeys
= array_flip( array_merge(
249 self
::$mergeableMapKeys,
250 self
::$mergeableListKeys,
251 self
::$mergeableAliasListKeys,
252 self
::$optionalMergeKeys,
257 return isset( $this->mergeableKeys
[$key] );
263 * Warning: this may be slow for split items (messages), since it will
264 * need to fetch all of the subitems from the cache individually.
265 * @param string $code
269 public function getItem( $code, $key ) {
270 if ( !isset( $this->loadedItems
[$code][$key] ) ) {
271 $this->loadItem( $code, $key );
274 if ( $key === 'fallback' && isset( $this->shallowFallbacks
[$code] ) ) {
275 return $this->shallowFallbacks
[$code];
278 return $this->data
[$code][$key];
282 * Get a subitem, for instance a single message for a given language.
283 * @param string $code
285 * @param string $subkey
288 public function getSubitem( $code, $key, $subkey ) {
289 if ( !isset( $this->loadedSubitems
[$code][$key][$subkey] ) &&
290 !isset( $this->loadedItems
[$code][$key] )
292 $this->loadSubitem( $code, $key, $subkey );
295 if ( isset( $this->data
[$code][$key][$subkey] ) ) {
296 return $this->data
[$code][$key][$subkey];
303 * Get the list of subitem keys for a given item.
305 * This is faster than array_keys($lc->getItem(...)) for the items listed in
308 * Will return null if the item is not found, or false if the item is not an
310 * @param string $code
312 * @return bool|null|string|string[]
314 public function getSubitemList( $code, $key ) {
315 if ( in_array( $key, self
::$splitKeys ) ) {
316 return $this->getSubitem( $code, 'list', $key );
318 $item = $this->getItem( $code, $key );
319 if ( is_array( $item ) ) {
320 return array_keys( $item );
328 * Load an item into the cache.
329 * @param string $code
332 protected function loadItem( $code, $key ) {
333 if ( !isset( $this->initialisedLangs
[$code] ) ) {
334 $this->initLanguage( $code );
337 // Check to see if initLanguage() loaded it for us
338 if ( isset( $this->loadedItems
[$code][$key] ) ) {
342 if ( isset( $this->shallowFallbacks
[$code] ) ) {
343 $this->loadItem( $this->shallowFallbacks
[$code], $key );
348 if ( in_array( $key, self
::$splitKeys ) ) {
349 $subkeyList = $this->getSubitem( $code, 'list', $key );
350 foreach ( $subkeyList as $subkey ) {
351 if ( isset( $this->data
[$code][$key][$subkey] ) ) {
354 $this->data
[$code][$key][$subkey] = $this->getSubitem( $code, $key, $subkey );
357 $this->data
[$code][$key] = $this->store
->get( $code, $key );
360 $this->loadedItems
[$code][$key] = true;
364 * Load a subitem into the cache
365 * @param string $code
367 * @param string $subkey
369 protected function loadSubitem( $code, $key, $subkey ) {
370 if ( !in_array( $key, self
::$splitKeys ) ) {
371 $this->loadItem( $code, $key );
376 if ( !isset( $this->initialisedLangs
[$code] ) ) {
377 $this->initLanguage( $code );
380 // Check to see if initLanguage() loaded it for us
381 if ( isset( $this->loadedItems
[$code][$key] ) ||
382 isset( $this->loadedSubitems
[$code][$key][$subkey] )
387 if ( isset( $this->shallowFallbacks
[$code] ) ) {
388 $this->loadSubitem( $this->shallowFallbacks
[$code], $key, $subkey );
393 $value = $this->store
->get( $code, "$key:$subkey" );
394 $this->data
[$code][$key][$subkey] = $value;
395 $this->loadedSubitems
[$code][$key][$subkey] = true;
399 * Returns true if the cache identified by $code is missing or expired.
401 * @param string $code
405 public function isExpired( $code ) {
406 if ( $this->forceRecache
&& !isset( $this->recachedLangs
[$code] ) ) {
407 wfDebug( __METHOD__
. "($code): forced reload\n" );
412 $deps = $this->store
->get( $code, 'deps' );
413 $keys = $this->store
->get( $code, 'list' );
414 $preload = $this->store
->get( $code, 'preload' );
415 // Different keys may expire separately for some stores
416 if ( $deps === null ||
$keys === null ||
$preload === null ) {
417 wfDebug( __METHOD__
. "($code): cache missing, need to make one\n" );
422 foreach ( $deps as $dep ) {
423 // Because we're unserializing stuff from cache, we
424 // could receive objects of classes that don't exist
425 // anymore (e.g. uninstalled extensions)
426 // When this happens, always expire the cache
427 if ( !$dep instanceof CacheDependency ||
$dep->isExpired() ) {
428 wfDebug( __METHOD__
. "($code): cache for $code expired due to " .
429 get_class( $dep ) . "\n" );
439 * Initialise a language in this object. Rebuild the cache if necessary.
440 * @param string $code
441 * @throws MWException
443 protected function initLanguage( $code ) {
444 if ( isset( $this->initialisedLangs
[$code] ) ) {
448 $this->initialisedLangs
[$code] = true;
450 # If the code is of the wrong form for a Messages*.php file, do a shallow fallback
451 if ( !Language
::isValidBuiltInCode( $code ) ) {
452 $this->initShallowFallback( $code, 'en' );
457 # Recache the data if necessary
458 if ( !$this->manualRecache
&& $this->isExpired( $code ) ) {
459 if ( Language
::isSupportedLanguage( $code ) ) {
460 $this->recache( $code );
461 } elseif ( $code === 'en' ) {
462 throw new MWException( 'MessagesEn.php is missing.' );
464 $this->initShallowFallback( $code, 'en' );
471 $preload = $this->getItem( $code, 'preload' );
472 if ( $preload === null ) {
473 if ( $this->manualRecache
) {
474 // No Messages*.php file. Do shallow fallback to en.
475 if ( $code === 'en' ) {
476 throw new MWException( 'No localisation cache found for English. ' .
477 'Please run maintenance/rebuildLocalisationCache.php.' );
479 $this->initShallowFallback( $code, 'en' );
483 throw new MWException( 'Invalid or missing localisation cache.' );
486 $this->data
[$code] = $preload;
487 foreach ( $preload as $key => $item ) {
488 if ( in_array( $key, self
::$splitKeys ) ) {
489 foreach ( $item as $subkey => $subitem ) {
490 $this->loadedSubitems
[$code][$key][$subkey] = true;
493 $this->loadedItems
[$code][$key] = true;
499 * Create a fallback from one language to another, without creating a
500 * complete persistent cache.
501 * @param string $primaryCode
502 * @param string $fallbackCode
504 public function initShallowFallback( $primaryCode, $fallbackCode ) {
505 $this->data
[$primaryCode] =& $this->data
[$fallbackCode];
506 $this->loadedItems
[$primaryCode] =& $this->loadedItems
[$fallbackCode];
507 $this->loadedSubitems
[$primaryCode] =& $this->loadedSubitems
[$fallbackCode];
508 $this->shallowFallbacks
[$primaryCode] = $fallbackCode;
512 * Read a PHP file containing localisation data.
513 * @param string $_fileName
514 * @param string $_fileType
515 * @throws MWException
518 protected function readPHPFile( $_fileName, $_fileType ) {
519 // Disable APC caching
520 MediaWiki\
suppressWarnings();
521 $_apcEnabled = ini_set( 'apc.cache_by_default', '0' );
522 MediaWiki\restoreWarnings
();
526 MediaWiki\
suppressWarnings();
527 ini_set( 'apc.cache_by_default', $_apcEnabled );
528 MediaWiki\restoreWarnings
();
530 if ( $_fileType == 'core' ||
$_fileType == 'extension' ) {
531 $data = compact( self
::$allKeys );
532 } elseif ( $_fileType == 'aliases' ) {
533 $data = compact( 'aliases' );
535 throw new MWException( __METHOD__
. ": Invalid file type: $_fileType" );
542 * Read a JSON file containing localisation messages.
543 * @param string $fileName Name of file to read
544 * @throws MWException If there is a syntax error in the JSON file
545 * @return array Array with a 'messages' key, or empty array if the file doesn't exist
547 public function readJSONFile( $fileName ) {
548 if ( !is_readable( $fileName ) ) {
552 $json = file_get_contents( $fileName );
553 if ( $json === false ) {
557 $data = FormatJson
::decode( $json, true );
558 if ( $data === null ) {
559 throw new MWException( __METHOD__
. ": Invalid JSON file: $fileName" );
562 // Remove keys starting with '@', they're reserved for metadata and non-message data
563 foreach ( $data as $key => $unused ) {
564 if ( $key === '' ||
$key[0] === '@' ) {
565 unset( $data[$key] );
569 // The JSON format only supports messages, none of the other variables, so wrap the data
570 return [ 'messages' => $data ];
574 * Get the compiled plural rules for a given language from the XML files.
576 * @param string $code
579 public function getCompiledPluralRules( $code ) {
580 $rules = $this->getPluralRules( $code );
581 if ( $rules === null ) {
585 $compiledRules = Evaluator
::compile( $rules );
586 } catch ( CLDRPluralRuleError
$e ) {
587 wfDebugLog( 'l10n', $e->getMessage() );
592 return $compiledRules;
596 * Get the plural rules for a given language from the XML files.
599 * @param string $code
602 public function getPluralRules( $code ) {
603 if ( $this->pluralRules
=== null ) {
604 $this->loadPluralFiles();
606 if ( !isset( $this->pluralRules
[$code] ) ) {
609 return $this->pluralRules
[$code];
614 * Get the plural rule types for a given language from the XML files.
617 * @param string $code
620 public function getPluralRuleTypes( $code ) {
621 if ( $this->pluralRuleTypes
=== null ) {
622 $this->loadPluralFiles();
624 if ( !isset( $this->pluralRuleTypes
[$code] ) ) {
627 return $this->pluralRuleTypes
[$code];
632 * Load the plural XML files.
634 protected function loadPluralFiles() {
636 $cldrPlural = "$IP/languages/data/plurals.xml";
637 $mwPlural = "$IP/languages/data/plurals-mediawiki.xml";
638 // Load CLDR plural rules
639 $this->loadPluralFile( $cldrPlural );
640 if ( file_exists( $mwPlural ) ) {
641 // Override or extend
642 $this->loadPluralFile( $mwPlural );
647 * Load a plural XML file with the given filename, compile the relevant
648 * rules, and save the compiled rules in a process-local cache.
650 * @param string $fileName
651 * @throws MWException
653 protected function loadPluralFile( $fileName ) {
654 // Use file_get_contents instead of DOMDocument::load (T58439)
655 $xml = file_get_contents( $fileName );
657 throw new MWException( "Unable to read plurals file $fileName" );
659 $doc = new DOMDocument
;
660 $doc->loadXML( $xml );
661 $rulesets = $doc->getElementsByTagName( "pluralRules" );
662 foreach ( $rulesets as $ruleset ) {
663 $codes = $ruleset->getAttribute( 'locales' );
666 $ruleElements = $ruleset->getElementsByTagName( "pluralRule" );
667 foreach ( $ruleElements as $elt ) {
668 $ruleType = $elt->getAttribute( 'count' );
669 if ( $ruleType === 'other' ) {
670 // Don't record "other" rules, which have an empty condition
673 $rules[] = $elt->nodeValue
;
674 $ruleTypes[] = $ruleType;
676 foreach ( explode( ' ', $codes ) as $code ) {
677 $this->pluralRules
[$code] = $rules;
678 $this->pluralRuleTypes
[$code] = $ruleTypes;
684 * Read the data from the source files for a given language, and register
685 * the relevant dependencies in the $deps array. If the localisation
686 * exists, the data array is returned, otherwise false is returned.
688 * @param string $code
689 * @param array &$deps
692 protected function readSourceFilesAndRegisterDeps( $code, &$deps ) {
695 // This reads in the PHP i18n file with non-messages l10n data
696 $fileName = Language
::getMessagesFileName( $code );
697 if ( !file_exists( $fileName ) ) {
700 $deps[] = new FileDependency( $fileName );
701 $data = $this->readPHPFile( $fileName, 'core' );
704 # Load CLDR plural rules for JavaScript
705 $data['pluralRules'] = $this->getPluralRules( $code );
707 $data['compiledPluralRules'] = $this->getCompiledPluralRules( $code );
708 # Load plural rule types
709 $data['pluralRuleTypes'] = $this->getPluralRuleTypes( $code );
711 $deps['plurals'] = new FileDependency( "$IP/languages/data/plurals.xml" );
712 $deps['plurals-mw'] = new FileDependency( "$IP/languages/data/plurals-mediawiki.xml" );
718 * Merge two localisation values, a primary and a fallback, overwriting the
719 * primary value in place.
721 * @param mixed &$value
722 * @param mixed $fallbackValue
724 protected function mergeItem( $key, &$value, $fallbackValue ) {
725 if ( !is_null( $value ) ) {
726 if ( !is_null( $fallbackValue ) ) {
727 if ( in_array( $key, self
::$mergeableMapKeys ) ) {
728 $value = $value +
$fallbackValue;
729 } elseif ( in_array( $key, self
::$mergeableListKeys ) ) {
730 $value = array_unique( array_merge( $fallbackValue, $value ) );
731 } elseif ( in_array( $key, self
::$mergeableAliasListKeys ) ) {
732 $value = array_merge_recursive( $value, $fallbackValue );
733 } elseif ( in_array( $key, self
::$optionalMergeKeys ) ) {
734 if ( !empty( $value['inherit'] ) ) {
735 $value = array_merge( $fallbackValue, $value );
738 if ( isset( $value['inherit'] ) ) {
739 unset( $value['inherit'] );
741 } elseif ( in_array( $key, self
::$magicWordKeys ) ) {
742 $this->mergeMagicWords( $value, $fallbackValue );
746 $value = $fallbackValue;
751 * @param mixed &$value
752 * @param mixed $fallbackValue
754 protected function mergeMagicWords( &$value, $fallbackValue ) {
755 foreach ( $fallbackValue as $magicName => $fallbackInfo ) {
756 if ( !isset( $value[$magicName] ) ) {
757 $value[$magicName] = $fallbackInfo;
759 $oldSynonyms = array_slice( $fallbackInfo, 1 );
760 $newSynonyms = array_slice( $value[$magicName], 1 );
761 $synonyms = array_values( array_unique( array_merge(
762 $newSynonyms, $oldSynonyms ) ) );
763 $value[$magicName] = array_merge( [ $fallbackInfo[0] ], $synonyms );
769 * Given an array mapping language code to localisation value, such as is
770 * found in extension *.i18n.php files, iterate through a fallback sequence
771 * to merge the given data with an existing primary value.
773 * Returns true if any data from the extension array was used, false
775 * @param array $codeSequence
777 * @param mixed &$value
778 * @param mixed $fallbackValue
781 protected function mergeExtensionItem( $codeSequence, $key, &$value, $fallbackValue ) {
783 foreach ( $codeSequence as $code ) {
784 if ( isset( $fallbackValue[$code] ) ) {
785 $this->mergeItem( $key, $value, $fallbackValue[$code] );
794 * Gets the combined list of messages dirs from
795 * core and extensions
800 public function getMessagesDirs() {
803 $config = MediaWikiServices
::getInstance()->getMainConfig();
804 $messagesDirs = $config->get( 'MessagesDirs' );
806 'core' => "$IP/languages/i18n",
807 'api' => "$IP/includes/api/i18n",
808 'oojs-ui' => "$IP/resources/lib/oojs-ui/i18n",
813 * Load localisation data for a given language for both core and extensions
814 * and save it to the persistent cache store and the process cache
815 * @param string $code
816 * @throws MWException
818 public function recache( $code ) {
819 global $wgExtensionMessagesFiles;
822 throw new MWException( "Invalid language code requested" );
824 $this->recachedLangs
[$code] = true;
827 $initialData = array_fill_keys( self
::$allKeys, null );
828 $coreData = $initialData;
831 # Load the primary localisation from the source file
832 $data = $this->readSourceFilesAndRegisterDeps( $code, $deps );
833 if ( $data === false ) {
834 wfDebug( __METHOD__
. ": no localisation file for $code, using fallback to en\n" );
835 $coreData['fallback'] = 'en';
837 wfDebug( __METHOD__
. ": got localisation for $code from source\n" );
839 # Merge primary localisation
840 foreach ( $data as $key => $value ) {
841 $this->mergeItem( $key, $coreData[$key], $value );
845 # Fill in the fallback if it's not there already
846 if ( is_null( $coreData['fallback'] ) ) {
847 $coreData['fallback'] = $code === 'en' ?
false : 'en';
849 if ( $coreData['fallback'] === false ) {
850 $coreData['fallbackSequence'] = [];
852 $coreData['fallbackSequence'] = array_map( 'trim', explode( ',', $coreData['fallback'] ) );
853 $len = count( $coreData['fallbackSequence'] );
855 # Ensure that the sequence ends at en
856 if ( $coreData['fallbackSequence'][$len - 1] !== 'en' ) {
857 $coreData['fallbackSequence'][] = 'en';
861 $codeSequence = array_merge( [ $code ], $coreData['fallbackSequence'] );
862 $messageDirs = $this->getMessagesDirs();
864 # Load non-JSON localisation data for extensions
865 $extensionData = array_fill_keys( $codeSequence, $initialData );
866 foreach ( $wgExtensionMessagesFiles as $extension => $fileName ) {
867 if ( isset( $messageDirs[$extension] ) ) {
868 # This extension has JSON message data; skip the PHP shim
872 $data = $this->readPHPFile( $fileName, 'extension' );
875 foreach ( $data as $key => $item ) {
876 foreach ( $codeSequence as $csCode ) {
877 if ( isset( $item[$csCode] ) ) {
878 $this->mergeItem( $key, $extensionData[$csCode][$key], $item[$csCode] );
885 $deps[] = new FileDependency( $fileName );
889 # Load the localisation data for each fallback, then merge it into the full array
890 $allData = $initialData;
891 foreach ( $codeSequence as $csCode ) {
892 $csData = $initialData;
894 # Load core messages and the extension localisations.
895 foreach ( $messageDirs as $dirs ) {
896 foreach ( (array)$dirs as $dir ) {
897 $fileName = "$dir/$csCode.json";
898 $data = $this->readJSONFile( $fileName );
900 foreach ( $data as $key => $item ) {
901 $this->mergeItem( $key, $csData[$key], $item );
904 $deps[] = new FileDependency( $fileName );
908 # Merge non-JSON extension data
909 if ( isset( $extensionData[$csCode] ) ) {
910 foreach ( $extensionData[$csCode] as $key => $item ) {
911 $this->mergeItem( $key, $csData[$key], $item );
915 if ( $csCode === $code ) {
916 # Merge core data into extension data
917 foreach ( $coreData as $key => $item ) {
918 $this->mergeItem( $key, $csData[$key], $item );
921 # Load the secondary localisation from the source file to
922 # avoid infinite cycles on cyclic fallbacks
923 $fbData = $this->readSourceFilesAndRegisterDeps( $csCode, $deps );
924 if ( $fbData !== false ) {
925 # Only merge the keys that make sense to merge
926 foreach ( self
::$allKeys as $key ) {
927 if ( !isset( $fbData[$key] ) ) {
931 if ( is_null( $coreData[$key] ) ||
$this->isMergeableKey( $key ) ) {
932 $this->mergeItem( $key, $csData[$key], $fbData[$key] );
938 # Allow extensions an opportunity to adjust the data for this
940 Hooks
::run( 'LocalisationCacheRecacheFallback', [ $this, $csCode, &$csData ] );
942 # Merge the data for this fallback into the final array
943 if ( $csCode === $code ) {
946 foreach ( self
::$allKeys as $key ) {
947 if ( !isset( $csData[$key] ) ) {
951 if ( is_null( $allData[$key] ) ||
$this->isMergeableKey( $key ) ) {
952 $this->mergeItem( $key, $allData[$key], $csData[$key] );
958 # Add cache dependencies for any referenced globals
959 $deps['wgExtensionMessagesFiles'] = new GlobalDependency( 'wgExtensionMessagesFiles' );
960 // The 'MessagesDirs' config setting is used in LocalisationCache::getMessagesDirs().
961 // We use the key 'wgMessagesDirs' for historical reasons.
962 $deps['wgMessagesDirs'] = new MainConfigDependency( 'MessagesDirs' );
963 $deps['version'] = new ConstantDependency( 'LocalisationCache::VERSION' );
965 # Add dependencies to the cache entry
966 $allData['deps'] = $deps;
968 # Replace spaces with underscores in namespace names
969 $allData['namespaceNames'] = str_replace( ' ', '_', $allData['namespaceNames'] );
971 # And do the same for special page aliases. $page is an array.
972 foreach ( $allData['specialPageAliases'] as &$page ) {
973 $page = str_replace( ' ', '_', $page );
975 # Decouple the reference to prevent accidental damage
978 # If there were no plural rules, return an empty array
979 if ( $allData['pluralRules'] === null ) {
980 $allData['pluralRules'] = [];
982 if ( $allData['compiledPluralRules'] === null ) {
983 $allData['compiledPluralRules'] = [];
985 # If there were no plural rule types, return an empty array
986 if ( $allData['pluralRuleTypes'] === null ) {
987 $allData['pluralRuleTypes'] = [];
991 $allData['list'] = [];
992 foreach ( self
::$splitKeys as $key ) {
993 $allData['list'][$key] = array_keys( $allData[$key] );
997 Hooks
::run( 'LocalisationCacheRecache', [ $this, $code, &$allData, &$purgeBlobs ] );
999 if ( is_null( $allData['namespaceNames'] ) ) {
1000 throw new MWException( __METHOD__
. ': Localisation data failed sanity check! ' .
1001 'Check that your languages/messages/MessagesEn.php file is intact.' );
1004 # Set the preload key
1005 $allData['preload'] = $this->buildPreload( $allData );
1007 # Save to the process cache and register the items loaded
1008 $this->data
[$code] = $allData;
1009 foreach ( $allData as $key => $item ) {
1010 $this->loadedItems
[$code][$key] = true;
1013 # Save to the persistent cache
1014 $this->store
->startWrite( $code );
1015 foreach ( $allData as $key => $value ) {
1016 if ( in_array( $key, self
::$splitKeys ) ) {
1017 foreach ( $value as $subkey => $subvalue ) {
1018 $this->store
->set( "$key:$subkey", $subvalue );
1021 $this->store
->set( $key, $value );
1024 $this->store
->finishWrite();
1026 # Clear out the MessageBlobStore
1027 # HACK: If using a null (i.e. disabled) storage backend, we
1028 # can't write to the MessageBlobStore either
1029 if ( $purgeBlobs && !$this->store
instanceof LCStoreNull
) {
1030 $blobStore = new MessageBlobStore();
1031 $blobStore->clear();
1036 * Build the preload item from the given pre-cache data.
1038 * The preload item will be loaded automatically, improving performance
1039 * for the commonly-requested items it contains.
1040 * @param array $data
1043 protected function buildPreload( $data ) {
1044 $preload = [ 'messages' => [] ];
1045 foreach ( self
::$preloadedKeys as $key ) {
1046 $preload[$key] = $data[$key];
1049 foreach ( $data['preloadedMessages'] as $subkey ) {
1050 if ( isset( $data['messages'][$subkey] ) ) {
1051 $subitem = $data['messages'][$subkey];
1055 $preload['messages'][$subkey] = $subitem;
1062 * Unload the data for a given language from the object cache.
1063 * Reduces memory usage.
1064 * @param string $code
1066 public function unload( $code ) {
1067 unset( $this->data
[$code] );
1068 unset( $this->loadedItems
[$code] );
1069 unset( $this->loadedSubitems
[$code] );
1070 unset( $this->initialisedLangs
[$code] );
1071 unset( $this->shallowFallbacks
[$code] );
1073 foreach ( $this->shallowFallbacks
as $shallowCode => $fbCode ) {
1074 if ( $fbCode === $code ) {
1075 $this->unload( $shallowCode );
1083 public function unloadAll() {
1084 foreach ( $this->initialisedLangs
as $lang => $unused ) {
1085 $this->unload( $lang );
1090 * Disable the storage backend
1092 public function disableBackend() {
1093 $this->store
= new LCStoreNull
;
1094 $this->manualRecache
= false;