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 public static $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 public static $mergeableMapKeys = [ 'messages', 'namespaceNames',
126 'namespaceAliases', 'dateFormats', 'imageFiles', 'preloadedMessages'
130 * Keys for items which are a numbered array.
132 public static $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 public static $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 public static $optionalMergeKeys = [ 'bookstoreList' ];
148 * Keys for items that are formatted like $magicWords
150 public static $magicWordKeys = [ 'magicWords' ];
153 * Keys for items where the subitems are stored in the backend separately.
155 public static $splitKeys = [ 'messages' ];
158 * Keys which are loaded automatically by initLanguage()
160 public static $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;
206 $storeArg['server'] = $conf['storeServer'] ??
[];
209 $storeClass = LCStoreStaticArray
::class;
212 if ( !empty( $conf['storeDirectory'] ) ) {
213 $storeClass = LCStoreCDB
::class;
214 } elseif ( $wgCacheDirectory ) {
215 $storeArg['directory'] = $wgCacheDirectory;
216 $storeClass = LCStoreCDB
::class;
218 $storeClass = LCStoreDB
::class;
219 $storeArg['server'] = $conf['storeServer'] ??
[];
223 throw new MWException(
224 'Please set $wgLocalisationCacheConf[\'store\'] to something sensible.'
229 wfDebugLog( 'caches', static::class . ": using store $storeClass" );
230 if ( !empty( $conf['storeDirectory'] ) ) {
231 $storeArg['directory'] = $conf['storeDirectory'];
234 $this->store
= new $storeClass( $storeArg );
235 foreach ( [ 'manualRecache', 'forceRecache' ] as $var ) {
236 if ( isset( $conf[$var] ) ) {
237 $this->$var = $conf[$var];
243 * Returns true if the given key is mergeable, that is, if it is an associative
244 * array which can be merged through a fallback sequence.
248 public function isMergeableKey( $key ) {
249 if ( $this->mergeableKeys
=== null ) {
250 $this->mergeableKeys
= array_flip( array_merge(
251 self
::$mergeableMapKeys,
252 self
::$mergeableListKeys,
253 self
::$mergeableAliasListKeys,
254 self
::$optionalMergeKeys,
259 return isset( $this->mergeableKeys
[$key] );
265 * Warning: this may be slow for split items (messages), since it will
266 * need to fetch all of the subitems from the cache individually.
267 * @param string $code
271 public function getItem( $code, $key ) {
272 if ( !isset( $this->loadedItems
[$code][$key] ) ) {
273 $this->loadItem( $code, $key );
276 if ( $key === 'fallback' && isset( $this->shallowFallbacks
[$code] ) ) {
277 return $this->shallowFallbacks
[$code];
280 return $this->data
[$code][$key];
284 * Get a subitem, for instance a single message for a given language.
285 * @param string $code
287 * @param string $subkey
290 public function getSubitem( $code, $key, $subkey ) {
291 if ( !isset( $this->loadedSubitems
[$code][$key][$subkey] ) &&
292 !isset( $this->loadedItems
[$code][$key] )
294 $this->loadSubitem( $code, $key, $subkey );
297 return $this->data
[$code][$key][$subkey] ??
null;
301 * Get the list of subitem keys for a given item.
303 * This is faster than array_keys($lc->getItem(...)) for the items listed in
306 * Will return null if the item is not found, or false if the item is not an
308 * @param string $code
310 * @return bool|null|string|string[]
312 public function getSubitemList( $code, $key ) {
313 if ( in_array( $key, self
::$splitKeys ) ) {
314 return $this->getSubitem( $code, 'list', $key );
316 $item = $this->getItem( $code, $key );
317 if ( is_array( $item ) ) {
318 return array_keys( $item );
326 * Load an item into the cache.
327 * @param string $code
330 protected function loadItem( $code, $key ) {
331 if ( !isset( $this->initialisedLangs
[$code] ) ) {
332 $this->initLanguage( $code );
335 // Check to see if initLanguage() loaded it for us
336 if ( isset( $this->loadedItems
[$code][$key] ) ) {
340 if ( isset( $this->shallowFallbacks
[$code] ) ) {
341 $this->loadItem( $this->shallowFallbacks
[$code], $key );
346 if ( in_array( $key, self
::$splitKeys ) ) {
347 $subkeyList = $this->getSubitem( $code, 'list', $key );
348 foreach ( $subkeyList as $subkey ) {
349 if ( isset( $this->data
[$code][$key][$subkey] ) ) {
352 $this->data
[$code][$key][$subkey] = $this->getSubitem( $code, $key, $subkey );
355 $this->data
[$code][$key] = $this->store
->get( $code, $key );
358 $this->loadedItems
[$code][$key] = true;
362 * Load a subitem into the cache
363 * @param string $code
365 * @param string $subkey
367 protected function loadSubitem( $code, $key, $subkey ) {
368 if ( !in_array( $key, self
::$splitKeys ) ) {
369 $this->loadItem( $code, $key );
374 if ( !isset( $this->initialisedLangs
[$code] ) ) {
375 $this->initLanguage( $code );
378 // Check to see if initLanguage() loaded it for us
379 if ( isset( $this->loadedItems
[$code][$key] ) ||
380 isset( $this->loadedSubitems
[$code][$key][$subkey] )
385 if ( isset( $this->shallowFallbacks
[$code] ) ) {
386 $this->loadSubitem( $this->shallowFallbacks
[$code], $key, $subkey );
391 $value = $this->store
->get( $code, "$key:$subkey" );
392 $this->data
[$code][$key][$subkey] = $value;
393 $this->loadedSubitems
[$code][$key][$subkey] = true;
397 * Returns true if the cache identified by $code is missing or expired.
399 * @param string $code
403 public function isExpired( $code ) {
404 if ( $this->forceRecache
&& !isset( $this->recachedLangs
[$code] ) ) {
405 wfDebug( __METHOD__
. "($code): forced reload\n" );
410 $deps = $this->store
->get( $code, 'deps' );
411 $keys = $this->store
->get( $code, 'list' );
412 $preload = $this->store
->get( $code, 'preload' );
413 // Different keys may expire separately for some stores
414 if ( $deps === null ||
$keys === null ||
$preload === null ) {
415 wfDebug( __METHOD__
. "($code): cache missing, need to make one\n" );
420 foreach ( $deps as $dep ) {
421 // Because we're unserializing stuff from cache, we
422 // could receive objects of classes that don't exist
423 // anymore (e.g. uninstalled extensions)
424 // When this happens, always expire the cache
425 if ( !$dep instanceof CacheDependency ||
$dep->isExpired() ) {
426 wfDebug( __METHOD__
. "($code): cache for $code expired due to " .
427 get_class( $dep ) . "\n" );
437 * Initialise a language in this object. Rebuild the cache if necessary.
438 * @param string $code
439 * @throws MWException
441 protected function initLanguage( $code ) {
442 if ( isset( $this->initialisedLangs
[$code] ) ) {
446 $this->initialisedLangs
[$code] = true;
448 # If the code is of the wrong form for a Messages*.php file, do a shallow fallback
449 if ( !Language
::isValidBuiltInCode( $code ) ) {
450 $this->initShallowFallback( $code, 'en' );
455 # Recache the data if necessary
456 if ( !$this->manualRecache
&& $this->isExpired( $code ) ) {
457 if ( Language
::isSupportedLanguage( $code ) ) {
458 $this->recache( $code );
459 } elseif ( $code === 'en' ) {
460 throw new MWException( 'MessagesEn.php is missing.' );
462 $this->initShallowFallback( $code, 'en' );
469 $preload = $this->getItem( $code, 'preload' );
470 if ( $preload === null ) {
471 if ( $this->manualRecache
) {
472 // No Messages*.php file. Do shallow fallback to en.
473 if ( $code === 'en' ) {
474 throw new MWException( 'No localisation cache found for English. ' .
475 'Please run maintenance/rebuildLocalisationCache.php.' );
477 $this->initShallowFallback( $code, 'en' );
481 throw new MWException( 'Invalid or missing localisation cache.' );
484 $this->data
[$code] = $preload;
485 foreach ( $preload as $key => $item ) {
486 if ( in_array( $key, self
::$splitKeys ) ) {
487 foreach ( $item as $subkey => $subitem ) {
488 $this->loadedSubitems
[$code][$key][$subkey] = true;
491 $this->loadedItems
[$code][$key] = true;
497 * Create a fallback from one language to another, without creating a
498 * complete persistent cache.
499 * @param string $primaryCode
500 * @param string $fallbackCode
502 public function initShallowFallback( $primaryCode, $fallbackCode ) {
503 $this->data
[$primaryCode] =& $this->data
[$fallbackCode];
504 $this->loadedItems
[$primaryCode] =& $this->loadedItems
[$fallbackCode];
505 $this->loadedSubitems
[$primaryCode] =& $this->loadedSubitems
[$fallbackCode];
506 $this->shallowFallbacks
[$primaryCode] = $fallbackCode;
510 * Read a PHP file containing localisation data.
511 * @param string $_fileName
512 * @param string $_fileType
513 * @throws MWException
516 protected function readPHPFile( $_fileName, $_fileType ) {
517 // Disable APC caching
518 Wikimedia\
suppressWarnings();
519 $_apcEnabled = ini_set( 'apc.cache_by_default', '0' );
520 Wikimedia\restoreWarnings
();
524 Wikimedia\
suppressWarnings();
525 ini_set( 'apc.cache_by_default', $_apcEnabled );
526 Wikimedia\restoreWarnings
();
529 if ( $_fileType == 'core' ||
$_fileType == 'extension' ) {
530 foreach ( self
::$allKeys as $key ) {
531 // Not all keys are set in language files, so
532 // check they exist first
533 if ( isset( $
$key ) ) {
537 } elseif ( $_fileType == 'aliases' ) {
538 if ( isset( $aliases ) ) {
539 $data['aliases'] = $aliases;
542 throw new MWException( __METHOD__
. ": Invalid file type: $_fileType" );
549 * Read a JSON file containing localisation messages.
550 * @param string $fileName Name of file to read
551 * @throws MWException If there is a syntax error in the JSON file
552 * @return array Array with a 'messages' key, or empty array if the file doesn't exist
554 public function readJSONFile( $fileName ) {
555 if ( !is_readable( $fileName ) ) {
559 $json = file_get_contents( $fileName );
560 if ( $json === false ) {
564 $data = FormatJson
::decode( $json, true );
565 if ( $data === null ) {
566 throw new MWException( __METHOD__
. ": Invalid JSON file: $fileName" );
569 // Remove keys starting with '@', they're reserved for metadata and non-message data
570 foreach ( $data as $key => $unused ) {
571 if ( $key === '' ||
$key[0] === '@' ) {
572 unset( $data[$key] );
576 // The JSON format only supports messages, none of the other variables, so wrap the data
577 return [ 'messages' => $data ];
581 * Get the compiled plural rules for a given language from the XML files.
583 * @param string $code
586 public function getCompiledPluralRules( $code ) {
587 $rules = $this->getPluralRules( $code );
588 if ( $rules === null ) {
592 $compiledRules = Evaluator
::compile( $rules );
593 } catch ( CLDRPluralRuleError
$e ) {
594 wfDebugLog( 'l10n', $e->getMessage() );
599 return $compiledRules;
603 * Get the plural rules for a given language from the XML files.
606 * @param string $code
609 public function getPluralRules( $code ) {
610 if ( $this->pluralRules
=== null ) {
611 $this->loadPluralFiles();
613 return $this->pluralRules
[$code] ??
null;
617 * Get the plural rule types for a given language from the XML files.
620 * @param string $code
623 public function getPluralRuleTypes( $code ) {
624 if ( $this->pluralRuleTypes
=== null ) {
625 $this->loadPluralFiles();
627 return $this->pluralRuleTypes
[$code] ??
null;
631 * Load the plural XML files.
633 protected function loadPluralFiles() {
635 $cldrPlural = "$IP/languages/data/plurals.xml";
636 $mwPlural = "$IP/languages/data/plurals-mediawiki.xml";
637 // Load CLDR plural rules
638 $this->loadPluralFile( $cldrPlural );
639 if ( file_exists( $mwPlural ) ) {
640 // Override or extend
641 $this->loadPluralFile( $mwPlural );
646 * Load a plural XML file with the given filename, compile the relevant
647 * rules, and save the compiled rules in a process-local cache.
649 * @param string $fileName
650 * @throws MWException
652 protected function loadPluralFile( $fileName ) {
653 // Use file_get_contents instead of DOMDocument::load (T58439)
654 $xml = file_get_contents( $fileName );
656 throw new MWException( "Unable to read plurals file $fileName" );
658 $doc = new DOMDocument
;
659 $doc->loadXML( $xml );
660 $rulesets = $doc->getElementsByTagName( "pluralRules" );
661 foreach ( $rulesets as $ruleset ) {
662 $codes = $ruleset->getAttribute( 'locales' );
665 $ruleElements = $ruleset->getElementsByTagName( "pluralRule" );
666 foreach ( $ruleElements as $elt ) {
667 $ruleType = $elt->getAttribute( 'count' );
668 if ( $ruleType === 'other' ) {
669 // Don't record "other" rules, which have an empty condition
672 $rules[] = $elt->nodeValue
;
673 $ruleTypes[] = $ruleType;
675 foreach ( explode( ' ', $codes ) as $code ) {
676 $this->pluralRules
[$code] = $rules;
677 $this->pluralRuleTypes
[$code] = $ruleTypes;
683 * Read the data from the source files for a given language, and register
684 * the relevant dependencies in the $deps array. If the localisation
685 * exists, the data array is returned, otherwise false is returned.
687 * @param string $code
688 * @param array &$deps
691 protected function readSourceFilesAndRegisterDeps( $code, &$deps ) {
694 // This reads in the PHP i18n file with non-messages l10n data
695 $fileName = Language
::getMessagesFileName( $code );
696 if ( !file_exists( $fileName ) ) {
699 $deps[] = new FileDependency( $fileName );
700 $data = $this->readPHPFile( $fileName, 'core' );
703 # Load CLDR plural rules for JavaScript
704 $data['pluralRules'] = $this->getPluralRules( $code );
706 $data['compiledPluralRules'] = $this->getCompiledPluralRules( $code );
707 # Load plural rule types
708 $data['pluralRuleTypes'] = $this->getPluralRuleTypes( $code );
710 $deps['plurals'] = new FileDependency( "$IP/languages/data/plurals.xml" );
711 $deps['plurals-mw'] = new FileDependency( "$IP/languages/data/plurals-mediawiki.xml" );
717 * Merge two localisation values, a primary and a fallback, overwriting the
718 * primary value in place.
720 * @param mixed &$value
721 * @param mixed $fallbackValue
723 protected function mergeItem( $key, &$value, $fallbackValue ) {
724 if ( !is_null( $value ) ) {
725 if ( !is_null( $fallbackValue ) ) {
726 if ( in_array( $key, self
::$mergeableMapKeys ) ) {
727 $value = $value +
$fallbackValue;
728 } elseif ( in_array( $key, self
::$mergeableListKeys ) ) {
729 $value = array_unique( array_merge( $fallbackValue, $value ) );
730 } elseif ( in_array( $key, self
::$mergeableAliasListKeys ) ) {
731 $value = array_merge_recursive( $value, $fallbackValue );
732 } elseif ( in_array( $key, self
::$optionalMergeKeys ) ) {
733 if ( !empty( $value['inherit'] ) ) {
734 $value = array_merge( $fallbackValue, $value );
737 if ( isset( $value['inherit'] ) ) {
738 unset( $value['inherit'] );
740 } elseif ( in_array( $key, self
::$magicWordKeys ) ) {
741 $this->mergeMagicWords( $value, $fallbackValue );
745 $value = $fallbackValue;
750 * @param mixed &$value
751 * @param mixed $fallbackValue
753 protected function mergeMagicWords( &$value, $fallbackValue ) {
754 foreach ( $fallbackValue as $magicName => $fallbackInfo ) {
755 if ( !isset( $value[$magicName] ) ) {
756 $value[$magicName] = $fallbackInfo;
758 $oldSynonyms = array_slice( $fallbackInfo, 1 );
759 $newSynonyms = array_slice( $value[$magicName], 1 );
760 $synonyms = array_values( array_unique( array_merge(
761 $newSynonyms, $oldSynonyms ) ) );
762 $value[$magicName] = array_merge( [ $fallbackInfo[0] ], $synonyms );
768 * Given an array mapping language code to localisation value, such as is
769 * found in extension *.i18n.php files, iterate through a fallback sequence
770 * to merge the given data with an existing primary value.
772 * Returns true if any data from the extension array was used, false
774 * @param array $codeSequence
776 * @param mixed &$value
777 * @param mixed $fallbackValue
780 protected function mergeExtensionItem( $codeSequence, $key, &$value, $fallbackValue ) {
782 foreach ( $codeSequence as $code ) {
783 if ( isset( $fallbackValue[$code] ) ) {
784 $this->mergeItem( $key, $value, $fallbackValue[$code] );
793 * Gets the combined list of messages dirs from
794 * core and extensions
799 public function getMessagesDirs() {
802 $config = MediaWikiServices
::getInstance()->getMainConfig();
803 $messagesDirs = $config->get( 'MessagesDirs' );
805 'core' => "$IP/languages/i18n",
806 'exif' => "$IP/languages/i18n/exif",
807 'api' => "$IP/includes/api/i18n",
808 'oojs-ui' => "$IP/resources/lib/ooui/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'] ) ||
$coreData['fallback'] === false ) && $code === 'en' ) {
847 $coreData['fallback'] = false;
848 $coreData['originalFallbackSequence'] = $coreData['fallbackSequence'] = [];
850 if ( !is_null( $coreData['fallback'] ) ) {
851 $coreData['fallbackSequence'] = array_map( 'trim', explode( ',', $coreData['fallback'] ) );
853 $coreData['fallbackSequence'] = [];
855 $len = count( $coreData['fallbackSequence'] );
857 # Before we add the 'en' fallback for messages, keep a copy of
858 # the original fallback sequence
859 $coreData['originalFallbackSequence'] = $coreData['fallbackSequence'];
861 # Ensure that the sequence ends at 'en' for messages
862 if ( !$len ||
$coreData['fallbackSequence'][$len - 1] !== 'en' ) {
863 $coreData['fallbackSequence'][] = 'en';
867 $codeSequence = array_merge( [ $code ], $coreData['fallbackSequence'] );
868 $messageDirs = $this->getMessagesDirs();
870 # Load non-JSON localisation data for extensions
871 $extensionData = array_fill_keys( $codeSequence, $initialData );
872 foreach ( $wgExtensionMessagesFiles as $extension => $fileName ) {
873 if ( isset( $messageDirs[$extension] ) ) {
874 # This extension has JSON message data; skip the PHP shim
878 $data = $this->readPHPFile( $fileName, 'extension' );
881 foreach ( $data as $key => $item ) {
882 foreach ( $codeSequence as $csCode ) {
883 if ( isset( $item[$csCode] ) ) {
884 $this->mergeItem( $key, $extensionData[$csCode][$key], $item[$csCode] );
891 $deps[] = new FileDependency( $fileName );
895 # Load the localisation data for each fallback, then merge it into the full array
896 $allData = $initialData;
897 foreach ( $codeSequence as $csCode ) {
898 $csData = $initialData;
900 # Load core messages and the extension localisations.
901 foreach ( $messageDirs as $dirs ) {
902 foreach ( (array)$dirs as $dir ) {
903 $fileName = "$dir/$csCode.json";
904 $data = $this->readJSONFile( $fileName );
906 foreach ( $data as $key => $item ) {
907 $this->mergeItem( $key, $csData[$key], $item );
910 $deps[] = new FileDependency( $fileName );
914 # Merge non-JSON extension data
915 if ( isset( $extensionData[$csCode] ) ) {
916 foreach ( $extensionData[$csCode] as $key => $item ) {
917 $this->mergeItem( $key, $csData[$key], $item );
921 if ( $csCode === $code ) {
922 # Merge core data into extension data
923 foreach ( $coreData as $key => $item ) {
924 $this->mergeItem( $key, $csData[$key], $item );
927 # Load the secondary localisation from the source file to
928 # avoid infinite cycles on cyclic fallbacks
929 $fbData = $this->readSourceFilesAndRegisterDeps( $csCode, $deps );
930 if ( $fbData !== false ) {
931 # Only merge the keys that make sense to merge
932 foreach ( self
::$allKeys as $key ) {
933 if ( !isset( $fbData[$key] ) ) {
937 if ( is_null( $coreData[$key] ) ||
$this->isMergeableKey( $key ) ) {
938 $this->mergeItem( $key, $csData[$key], $fbData[$key] );
944 # Allow extensions an opportunity to adjust the data for this
946 Hooks
::run( 'LocalisationCacheRecacheFallback', [ $this, $csCode, &$csData ] );
948 # Merge the data for this fallback into the final array
949 if ( $csCode === $code ) {
952 foreach ( self
::$allKeys as $key ) {
953 if ( !isset( $csData[$key] ) ) {
957 if ( is_null( $allData[$key] ) ||
$this->isMergeableKey( $key ) ) {
958 $this->mergeItem( $key, $allData[$key], $csData[$key] );
964 # Add cache dependencies for any referenced globals
965 $deps['wgExtensionMessagesFiles'] = new GlobalDependency( 'wgExtensionMessagesFiles' );
966 // The 'MessagesDirs' config setting is used in LocalisationCache::getMessagesDirs().
967 // We use the key 'wgMessagesDirs' for historical reasons.
968 $deps['wgMessagesDirs'] = new MainConfigDependency( 'MessagesDirs' );
969 $deps['version'] = new ConstantDependency( 'LocalisationCache::VERSION' );
971 # Add dependencies to the cache entry
972 $allData['deps'] = $deps;
974 # Replace spaces with underscores in namespace names
975 $allData['namespaceNames'] = str_replace( ' ', '_', $allData['namespaceNames'] );
977 # And do the same for special page aliases. $page is an array.
978 foreach ( $allData['specialPageAliases'] as &$page ) {
979 $page = str_replace( ' ', '_', $page );
981 # Decouple the reference to prevent accidental damage
984 # If there were no plural rules, return an empty array
985 if ( $allData['pluralRules'] === null ) {
986 $allData['pluralRules'] = [];
988 if ( $allData['compiledPluralRules'] === null ) {
989 $allData['compiledPluralRules'] = [];
991 # If there were no plural rule types, return an empty array
992 if ( $allData['pluralRuleTypes'] === null ) {
993 $allData['pluralRuleTypes'] = [];
997 $allData['list'] = [];
998 foreach ( self
::$splitKeys as $key ) {
999 $allData['list'][$key] = array_keys( $allData[$key] );
1003 Hooks
::run( 'LocalisationCacheRecache', [ $this, $code, &$allData, &$purgeBlobs ] );
1005 if ( is_null( $allData['namespaceNames'] ) ) {
1006 throw new MWException( __METHOD__
. ': Localisation data failed sanity check! ' .
1007 'Check that your languages/messages/MessagesEn.php file is intact.' );
1010 # Set the preload key
1011 $allData['preload'] = $this->buildPreload( $allData );
1013 # Save to the process cache and register the items loaded
1014 $this->data
[$code] = $allData;
1015 foreach ( $allData as $key => $item ) {
1016 $this->loadedItems
[$code][$key] = true;
1019 # Save to the persistent cache
1020 $this->store
->startWrite( $code );
1021 foreach ( $allData as $key => $value ) {
1022 if ( in_array( $key, self
::$splitKeys ) ) {
1023 foreach ( $value as $subkey => $subvalue ) {
1024 $this->store
->set( "$key:$subkey", $subvalue );
1027 $this->store
->set( $key, $value );
1030 $this->store
->finishWrite();
1032 # Clear out the MessageBlobStore
1033 # HACK: If using a null (i.e. disabled) storage backend, we
1034 # can't write to the MessageBlobStore either
1035 if ( $purgeBlobs && !$this->store
instanceof LCStoreNull
) {
1036 $blobStore = MediaWikiServices
::getInstance()->getResourceLoader()->getMessageBlobStore();
1037 $blobStore->clear();
1042 * Build the preload item from the given pre-cache data.
1044 * The preload item will be loaded automatically, improving performance
1045 * for the commonly-requested items it contains.
1046 * @param array $data
1049 protected function buildPreload( $data ) {
1050 $preload = [ 'messages' => [] ];
1051 foreach ( self
::$preloadedKeys as $key ) {
1052 $preload[$key] = $data[$key];
1055 foreach ( $data['preloadedMessages'] as $subkey ) {
1056 $subitem = $data['messages'][$subkey] ??
null;
1057 $preload['messages'][$subkey] = $subitem;
1064 * Unload the data for a given language from the object cache.
1065 * Reduces memory usage.
1066 * @param string $code
1068 public function unload( $code ) {
1069 unset( $this->data
[$code] );
1070 unset( $this->loadedItems
[$code] );
1071 unset( $this->loadedSubitems
[$code] );
1072 unset( $this->initialisedLangs
[$code] );
1073 unset( $this->shallowFallbacks
[$code] );
1075 foreach ( $this->shallowFallbacks
as $shallowCode => $fbCode ) {
1076 if ( $fbCode === $code ) {
1077 $this->unload( $shallowCode );
1085 public function unloadAll() {
1086 foreach ( $this->initialisedLangs
as $lang => $unused ) {
1087 $this->unload( $lang );
1092 * Disable the storage backend
1094 public function disableBackend() {
1095 $this->store
= new LCStoreNull
;
1096 $this->manualRecache
= false;