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
24 * Class for caching the contents of localisation files, Messages*.php
27 * An instance of this class is available using Language::getLocalisationCache().
29 * The values retrieved from here are merged, containing items from extension
30 * files, core messages files and the language fallback sequence (e.g. zh-cn ->
31 * zh-hans -> en ). Some common errors are corrected, for example namespace
32 * names with spaces instead of underscores, but heavyweight processing, such
33 * as grammatical transformation, is done by the caller.
35 class LocalisationCache
{
38 /** Configuration associative array */
42 * True if recaching should only be done on an explicit call to recache().
43 * Setting this reduces the overhead of cache freshness checking, which
44 * requires doing a stat() for every extension i18n file.
46 private $manualRecache = false;
49 * True to treat all files as expired until they are regenerated by this object.
51 private $forceRecache = false;
54 * The cache data. 3-d array, where the first key is the language code,
55 * the second key is the item key e.g. 'messages', and the third key is
56 * an item specific subkey index. Some items are not arrays and so for those
57 * items, there are no subkeys.
59 protected $data = array();
62 * The persistent store object. An instance of LCStore.
69 * A 2-d associative array, code/key, where presence indicates that the item
70 * is loaded. Value arbitrary.
72 * For split items, if set, this indicates that all of the subitems have been
75 private $loadedItems = array();
78 * A 3-d associative array, code/key/subkey, where presence indicates that
79 * the subitem is loaded. Only used for the split items, i.e. messages.
81 private $loadedSubitems = array();
84 * An array where presence of a key indicates that that language has been
85 * initialised. Initialisation includes checking for cache expiry and doing
86 * any necessary updates.
88 private $initialisedLangs = array();
91 * An array mapping non-existent pseudo-languages to fallback languages. This
92 * is filled by initShallowFallback() when data is requested from a language
93 * that lacks a Messages*.php file.
95 private $shallowFallbacks = array();
98 * An array where the keys are codes that have been recached by this instance.
100 private $recachedLangs = array();
105 static public $allKeys = array(
106 'fallback', 'namespaceNames', 'bookstoreList',
107 'magicWords', 'messages', 'rtl', 'capitalizeAllNouns', 'digitTransformTable',
108 'separatorTransformTable', 'fallback8bitEncoding', 'linkPrefixExtension',
109 'linkTrail', 'linkPrefixCharset', 'namespaceAliases',
110 'dateFormats', 'datePreferences', 'datePreferenceMigrationMap',
111 'defaultDateFormat', 'extraUserToggles', 'specialPageAliases',
112 'imageFiles', 'preloadedMessages', 'namespaceGenderAliases',
113 'digitGroupingPattern', 'pluralRules', 'pluralRuleTypes', 'compiledPluralRules',
117 * Keys for items which consist of associative arrays, which may be merged
118 * by a fallback sequence.
120 static public $mergeableMapKeys = array( 'messages', 'namespaceNames',
121 'dateFormats', 'imageFiles', 'preloadedMessages'
125 * Keys for items which are a numbered array.
127 static public $mergeableListKeys = array( 'extraUserToggles' );
130 * Keys for items which contain an array of arrays of equivalent aliases
131 * for each subitem. The aliases may be merged by a fallback sequence.
133 static public $mergeableAliasListKeys = array( 'specialPageAliases' );
136 * Keys for items which contain an associative array, and may be merged if
137 * the primary value contains the special array key "inherit". That array
138 * key is removed after the first merge.
140 static public $optionalMergeKeys = array( 'bookstoreList' );
143 * Keys for items that are formatted like $magicWords
145 static public $magicWordKeys = array( 'magicWords' );
148 * Keys for items where the subitems are stored in the backend separately.
150 static public $splitKeys = array( 'messages' );
153 * Keys which are loaded automatically by initLanguage()
155 static public $preloadedKeys = array( 'dateFormats', 'namespaceNames' );
158 * Associative array of cached plural rules. The key is the language code,
159 * the value is an array of plural rules for that language.
161 private $pluralRules = null;
164 * Associative array of cached plural rule types. The key is the language
165 * code, the value is an array of plural rule types for that language. For
166 * example, $pluralRuleTypes['ar'] = ['zero', 'one', 'two', 'few', 'many'].
167 * The index for each rule type matches the index for the rule in
168 * $pluralRules, thus allowing correlation between the two. The reason we
169 * don't just use the type names as the keys in $pluralRules is because
170 * Language::convertPlural applies the rules based on numeric order (or
171 * explicit numeric parameter), not based on the name of the rule type. For
172 * example, {{plural:count|wordform1|wordform2|wordform3}}, rather than
173 * {{plural:count|one=wordform1|two=wordform2|many=wordform3}}.
175 private $pluralRuleTypes = null;
177 private $mergeableKeys = null;
181 * For constructor parameters, see the documentation in DefaultSettings.php
182 * for $wgLocalisationCacheConf.
185 * @throws MWException
187 function __construct( $conf ) {
188 global $wgCacheDirectory;
191 $storeConf = array();
192 if ( !empty( $conf['storeClass'] ) ) {
193 $storeClass = $conf['storeClass'];
195 switch ( $conf['store'] ) {
198 $storeClass = 'LCStoreCDB';
201 $storeClass = 'LCStoreDB';
204 $storeClass = 'LCStoreAccel';
207 $storeClass = $wgCacheDirectory ?
'LCStoreCDB' : 'LCStoreDB';
210 throw new MWException(
211 'Please set $wgLocalisationCacheConf[\'store\'] to something sensible.' );
215 wfDebugLog( 'caches', get_class( $this ) . ": using store $storeClass" );
216 if ( !empty( $conf['storeDirectory'] ) ) {
217 $storeConf['directory'] = $conf['storeDirectory'];
220 $this->store
= new $storeClass( $storeConf );
221 foreach ( array( 'manualRecache', 'forceRecache' ) as $var ) {
222 if ( isset( $conf[$var] ) ) {
223 $this->$var = $conf[$var];
229 * Returns true if the given key is mergeable, that is, if it is an associative
230 * array which can be merged through a fallback sequence.
234 public function isMergeableKey( $key ) {
235 if ( $this->mergeableKeys
=== null ) {
236 $this->mergeableKeys
= array_flip( array_merge(
237 self
::$mergeableMapKeys,
238 self
::$mergeableListKeys,
239 self
::$mergeableAliasListKeys,
240 self
::$optionalMergeKeys,
245 return isset( $this->mergeableKeys
[$key] );
251 * Warning: this may be slow for split items (messages), since it will
252 * need to fetch all of the subitems from the cache individually.
253 * @param string $code
257 public function getItem( $code, $key ) {
258 if ( !isset( $this->loadedItems
[$code][$key] ) ) {
259 wfProfileIn( __METHOD__
. '-load' );
260 $this->loadItem( $code, $key );
261 wfProfileOut( __METHOD__
. '-load' );
264 if ( $key === 'fallback' && isset( $this->shallowFallbacks
[$code] ) ) {
265 return $this->shallowFallbacks
[$code];
268 return $this->data
[$code][$key];
272 * Get a subitem, for instance a single message for a given language.
273 * @param string $code
275 * @param string $subkey
278 public function getSubitem( $code, $key, $subkey ) {
279 if ( !isset( $this->loadedSubitems
[$code][$key][$subkey] ) &&
280 !isset( $this->loadedItems
[$code][$key] )
282 wfProfileIn( __METHOD__
. '-load' );
283 $this->loadSubitem( $code, $key, $subkey );
284 wfProfileOut( __METHOD__
. '-load' );
287 if ( isset( $this->data
[$code][$key][$subkey] ) ) {
288 return $this->data
[$code][$key][$subkey];
295 * Get the list of subitem keys for a given item.
297 * This is faster than array_keys($lc->getItem(...)) for the items listed in
300 * Will return null if the item is not found, or false if the item is not an
302 * @param string $code
304 * @return bool|null|string
306 public function getSubitemList( $code, $key ) {
307 if ( in_array( $key, self
::$splitKeys ) ) {
308 return $this->getSubitem( $code, 'list', $key );
310 $item = $this->getItem( $code, $key );
311 if ( is_array( $item ) ) {
312 return array_keys( $item );
320 * Load an item into the cache.
321 * @param string $code
324 protected function loadItem( $code, $key ) {
325 if ( !isset( $this->initialisedLangs
[$code] ) ) {
326 $this->initLanguage( $code );
329 // Check to see if initLanguage() loaded it for us
330 if ( isset( $this->loadedItems
[$code][$key] ) ) {
334 if ( isset( $this->shallowFallbacks
[$code] ) ) {
335 $this->loadItem( $this->shallowFallbacks
[$code], $key );
340 if ( in_array( $key, self
::$splitKeys ) ) {
341 $subkeyList = $this->getSubitem( $code, 'list', $key );
342 foreach ( $subkeyList as $subkey ) {
343 if ( isset( $this->data
[$code][$key][$subkey] ) ) {
346 $this->data
[$code][$key][$subkey] = $this->getSubitem( $code, $key, $subkey );
349 $this->data
[$code][$key] = $this->store
->get( $code, $key );
352 $this->loadedItems
[$code][$key] = true;
356 * Load a subitem into the cache
357 * @param string $code
359 * @param string $subkey
361 protected function loadSubitem( $code, $key, $subkey ) {
362 if ( !in_array( $key, self
::$splitKeys ) ) {
363 $this->loadItem( $code, $key );
368 if ( !isset( $this->initialisedLangs
[$code] ) ) {
369 $this->initLanguage( $code );
372 // Check to see if initLanguage() loaded it for us
373 if ( isset( $this->loadedItems
[$code][$key] ) ||
374 isset( $this->loadedSubitems
[$code][$key][$subkey] )
379 if ( isset( $this->shallowFallbacks
[$code] ) ) {
380 $this->loadSubitem( $this->shallowFallbacks
[$code], $key, $subkey );
385 $value = $this->store
->get( $code, "$key:$subkey" );
386 $this->data
[$code][$key][$subkey] = $value;
387 $this->loadedSubitems
[$code][$key][$subkey] = true;
391 * Returns true if the cache identified by $code is missing or expired.
393 * @param string $code
397 public function isExpired( $code ) {
398 if ( $this->forceRecache
&& !isset( $this->recachedLangs
[$code] ) ) {
399 wfDebug( __METHOD__
. "($code): forced reload\n" );
404 $deps = $this->store
->get( $code, 'deps' );
405 $keys = $this->store
->get( $code, 'list' );
406 $preload = $this->store
->get( $code, 'preload' );
407 // Different keys may expire separately, at least in LCStoreAccel
408 if ( $deps === null ||
$keys === null ||
$preload === null ) {
409 wfDebug( __METHOD__
. "($code): cache missing, need to make one\n" );
414 foreach ( $deps as $dep ) {
415 // Because we're unserializing stuff from cache, we
416 // could receive objects of classes that don't exist
417 // anymore (e.g. uninstalled extensions)
418 // When this happens, always expire the cache
419 if ( !$dep instanceof CacheDependency ||
$dep->isExpired() ) {
420 wfDebug( __METHOD__
. "($code): cache for $code expired due to " .
421 get_class( $dep ) . "\n" );
431 * Initialise a language in this object. Rebuild the cache if necessary.
432 * @param string $code
433 * @throws MWException
435 protected function initLanguage( $code ) {
436 if ( isset( $this->initialisedLangs
[$code] ) ) {
440 $this->initialisedLangs
[$code] = true;
442 # If the code is of the wrong form for a Messages*.php file, do a shallow fallback
443 if ( !Language
::isValidBuiltInCode( $code ) ) {
444 $this->initShallowFallback( $code, 'en' );
449 # Recache the data if necessary
450 if ( !$this->manualRecache
&& $this->isExpired( $code ) ) {
451 if ( Language
::isSupportedLanguage( $code ) ) {
452 $this->recache( $code );
453 } elseif ( $code === 'en' ) {
454 throw new MWException( 'MessagesEn.php is missing.' );
456 $this->initShallowFallback( $code, 'en' );
463 $preload = $this->getItem( $code, 'preload' );
464 if ( $preload === null ) {
465 if ( $this->manualRecache
) {
466 // No Messages*.php file. Do shallow fallback to en.
467 if ( $code === 'en' ) {
468 throw new MWException( 'No localisation cache found for English. ' .
469 'Please run maintenance/rebuildLocalisationCache.php.' );
471 $this->initShallowFallback( $code, 'en' );
475 throw new MWException( 'Invalid or missing localisation cache.' );
478 $this->data
[$code] = $preload;
479 foreach ( $preload as $key => $item ) {
480 if ( in_array( $key, self
::$splitKeys ) ) {
481 foreach ( $item as $subkey => $subitem ) {
482 $this->loadedSubitems
[$code][$key][$subkey] = true;
485 $this->loadedItems
[$code][$key] = true;
491 * Create a fallback from one language to another, without creating a
492 * complete persistent cache.
493 * @param string $primaryCode
494 * @param string $fallbackCode
496 public function initShallowFallback( $primaryCode, $fallbackCode ) {
497 $this->data
[$primaryCode] =& $this->data
[$fallbackCode];
498 $this->loadedItems
[$primaryCode] =& $this->loadedItems
[$fallbackCode];
499 $this->loadedSubitems
[$primaryCode] =& $this->loadedSubitems
[$fallbackCode];
500 $this->shallowFallbacks
[$primaryCode] = $fallbackCode;
504 * Read a PHP file containing localisation data.
505 * @param string $_fileName
506 * @param string $_fileType
507 * @throws MWException
510 protected function readPHPFile( $_fileName, $_fileType ) {
511 wfProfileIn( __METHOD__
);
512 // Disable APC caching
513 wfSuppressWarnings();
514 $_apcEnabled = ini_set( 'apc.cache_by_default', '0' );
519 wfSuppressWarnings();
520 ini_set( 'apc.cache_by_default', $_apcEnabled );
523 if ( $_fileType == 'core' ||
$_fileType == 'extension' ) {
524 $data = compact( self
::$allKeys );
525 } elseif ( $_fileType == 'aliases' ) {
526 $data = compact( 'aliases' );
528 wfProfileOut( __METHOD__
);
529 throw new MWException( __METHOD__
. ": Invalid file type: $_fileType" );
531 wfProfileOut( __METHOD__
);
537 * Read a JSON file containing localisation messages.
538 * @param string $fileName Name of file to read
539 * @throws MWException If there is a syntax error in the JSON file
540 * @return array Array with a 'messages' key, or empty array if the file doesn't exist
542 public function readJSONFile( $fileName ) {
543 wfProfileIn( __METHOD__
);
545 if ( !is_readable( $fileName ) ) {
546 wfProfileOut( __METHOD__
);
551 $json = file_get_contents( $fileName );
552 if ( $json === false ) {
553 wfProfileOut( __METHOD__
);
558 $data = FormatJson
::decode( $json, true );
559 if ( $data === null ) {
560 wfProfileOut( __METHOD__
);
562 throw new MWException( __METHOD__
. ": Invalid JSON file: $fileName" );
565 // Remove keys starting with '@', they're reserved for metadata and non-message data
566 foreach ( $data as $key => $unused ) {
567 if ( $key === '' ||
$key[0] === '@' ) {
568 unset( $data[$key] );
572 wfProfileOut( __METHOD__
);
574 // The JSON format only supports messages, none of the other variables, so wrap the data
575 return array( 'messages' => $data );
579 * Get the compiled plural rules for a given language from the XML files.
581 * @param string $code
584 public function getCompiledPluralRules( $code ) {
585 $rules = $this->getPluralRules( $code );
586 if ( $rules === null ) {
590 $compiledRules = CLDRPluralRuleEvaluator
::compile( $rules );
591 } catch ( CLDRPluralRuleError
$e ) {
592 wfDebugLog( 'l10n', $e->getMessage() );
597 return $compiledRules;
601 * Get the plural rules for a given language from the XML files.
604 * @param string $code
607 public function getPluralRules( $code ) {
608 if ( $this->pluralRules
=== null ) {
609 $this->loadPluralFiles();
611 if ( !isset( $this->pluralRules
[$code] ) ) {
614 return $this->pluralRules
[$code];
619 * Get the plural rule types for a given language from the XML files.
622 * @param string $code
625 public function getPluralRuleTypes( $code ) {
626 if ( $this->pluralRuleTypes
=== null ) {
627 $this->loadPluralFiles();
629 if ( !isset( $this->pluralRuleTypes
[$code] ) ) {
632 return $this->pluralRuleTypes
[$code];
637 * Load the plural XML files.
639 protected function loadPluralFiles() {
641 $cldrPlural = "$IP/languages/data/plurals.xml";
642 $mwPlural = "$IP/languages/data/plurals-mediawiki.xml";
643 // Load CLDR plural rules
644 $this->loadPluralFile( $cldrPlural );
645 if ( file_exists( $mwPlural ) ) {
646 // Override or extend
647 $this->loadPluralFile( $mwPlural );
652 * Load a plural XML file with the given filename, compile the relevant
653 * rules, and save the compiled rules in a process-local cache.
655 * @param string $fileName
657 protected function loadPluralFile( $fileName ) {
658 $doc = new DOMDocument
;
659 $doc->load( $fileName );
660 $rulesets = $doc->getElementsByTagName( "pluralRules" );
661 foreach ( $rulesets as $ruleset ) {
662 $codes = $ruleset->getAttribute( 'locales' );
664 $ruleTypes = array();
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
690 protected function readSourceFilesAndRegisterDeps( $code, &$deps ) {
692 wfProfileIn( __METHOD__
);
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" );
713 wfProfileOut( __METHOD__
);
719 * Merge two localisation values, a primary and a fallback, overwriting the
720 * primary value in place.
722 * @param mixed $value
723 * @param mixed $fallbackValue
725 protected function mergeItem( $key, &$value, $fallbackValue ) {
726 if ( !is_null( $value ) ) {
727 if ( !is_null( $fallbackValue ) ) {
728 if ( in_array( $key, self
::$mergeableMapKeys ) ) {
729 $value = $value +
$fallbackValue;
730 } elseif ( in_array( $key, self
::$mergeableListKeys ) ) {
731 $value = array_unique( array_merge( $fallbackValue, $value ) );
732 } elseif ( in_array( $key, self
::$mergeableAliasListKeys ) ) {
733 $value = array_merge_recursive( $value, $fallbackValue );
734 } elseif ( in_array( $key, self
::$optionalMergeKeys ) ) {
735 if ( !empty( $value['inherit'] ) ) {
736 $value = array_merge( $fallbackValue, $value );
739 if ( isset( $value['inherit'] ) ) {
740 unset( $value['inherit'] );
742 } elseif ( in_array( $key, self
::$magicWordKeys ) ) {
743 $this->mergeMagicWords( $value, $fallbackValue );
747 $value = $fallbackValue;
752 * @param mixed $value
753 * @param mixed $fallbackValue
755 protected function mergeMagicWords( &$value, $fallbackValue ) {
756 foreach ( $fallbackValue as $magicName => $fallbackInfo ) {
757 if ( !isset( $value[$magicName] ) ) {
758 $value[$magicName] = $fallbackInfo;
760 $oldSynonyms = array_slice( $fallbackInfo, 1 );
761 $newSynonyms = array_slice( $value[$magicName], 1 );
762 $synonyms = array_values( array_unique( array_merge(
763 $newSynonyms, $oldSynonyms ) ) );
764 $value[$magicName] = array_merge( array( $fallbackInfo[0] ), $synonyms );
770 * Given an array mapping language code to localisation value, such as is
771 * found in extension *.i18n.php files, iterate through a fallback sequence
772 * to merge the given data with an existing primary value.
774 * Returns true if any data from the extension array was used, false
776 * @param string $codeSequence
778 * @param mixed $value
779 * @param mixed $fallbackValue
782 protected function mergeExtensionItem( $codeSequence, $key, &$value, $fallbackValue ) {
784 foreach ( $codeSequence as $code ) {
785 if ( isset( $fallbackValue[$code] ) ) {
786 $this->mergeItem( $key, $value, $fallbackValue[$code] );
795 * Load localisation data for a given language for both core and extensions
796 * and save it to the persistent cache store and the process cache
797 * @param string $code
798 * @throws MWException
800 public function recache( $code ) {
801 global $wgExtensionMessagesFiles, $wgMessagesDirs;
802 wfProfileIn( __METHOD__
);
805 wfProfileOut( __METHOD__
);
806 throw new MWException( "Invalid language code requested" );
808 $this->recachedLangs
[$code] = true;
811 $initialData = array_combine(
813 array_fill( 0, count( self
::$allKeys ), null ) );
814 $coreData = $initialData;
817 # Load the primary localisation from the source file
818 $data = $this->readSourceFilesAndRegisterDeps( $code, $deps );
819 if ( $data === false ) {
820 wfDebug( __METHOD__
. ": no localisation file for $code, using fallback to en\n" );
821 $coreData['fallback'] = 'en';
823 wfDebug( __METHOD__
. ": got localisation for $code from source\n" );
825 # Merge primary localisation
826 foreach ( $data as $key => $value ) {
827 $this->mergeItem( $key, $coreData[$key], $value );
831 # Fill in the fallback if it's not there already
832 if ( is_null( $coreData['fallback'] ) ) {
833 $coreData['fallback'] = $code === 'en' ?
false : 'en';
835 if ( $coreData['fallback'] === false ) {
836 $coreData['fallbackSequence'] = array();
838 $coreData['fallbackSequence'] = array_map( 'trim', explode( ',', $coreData['fallback'] ) );
839 $len = count( $coreData['fallbackSequence'] );
841 # Ensure that the sequence ends at en
842 if ( $coreData['fallbackSequence'][$len - 1] !== 'en' ) {
843 $coreData['fallbackSequence'][] = 'en';
846 # Load the fallback localisation item by item and merge it
847 foreach ( $coreData['fallbackSequence'] as $fbCode ) {
848 # Load the secondary localisation from the source file to
849 # avoid infinite cycles on cyclic fallbacks
850 $fbData = $this->readSourceFilesAndRegisterDeps( $fbCode, $deps );
851 if ( $fbData === false ) {
855 foreach ( self
::$allKeys as $key ) {
856 if ( !isset( $fbData[$key] ) ) {
860 if ( is_null( $coreData[$key] ) ||
$this->isMergeableKey( $key ) ) {
861 $this->mergeItem( $key, $coreData[$key], $fbData[$key] );
867 $codeSequence = array_merge( array( $code ), $coreData['fallbackSequence'] );
869 # Load core messages and the extension localisations.
870 wfProfileIn( __METHOD__
. '-extensions' );
871 $allData = $initialData;
872 foreach ( $wgMessagesDirs as $dirs ) {
873 foreach ( (array)$dirs as $dir ) {
874 foreach ( $codeSequence as $csCode ) {
875 $fileName = "$dir/$csCode.json";
876 $data = $this->readJSONFile( $fileName );
878 foreach ( $data as $key => $item ) {
879 $this->mergeItem( $key, $allData[$key], $item );
882 $deps[] = new FileDependency( $fileName );
887 foreach ( $wgExtensionMessagesFiles as $extension => $fileName ) {
888 if ( isset( $wgMessagesDirs[$extension] ) ) {
889 # Already loaded the JSON files for this extension; skip the PHP shim
893 $data = $this->readPHPFile( $fileName, 'extension' );
896 foreach ( $data as $key => $item ) {
897 if ( $this->mergeExtensionItem( $codeSequence, $key, $allData[$key], $item ) ) {
903 $deps[] = new FileDependency( $fileName );
907 # Merge core data into extension data
908 foreach ( $coreData as $key => $item ) {
909 $this->mergeItem( $key, $allData[$key], $item );
911 wfProfileOut( __METHOD__
. '-extensions' );
913 # Add cache dependencies for any referenced globals
914 $deps['wgExtensionMessagesFiles'] = new GlobalDependency( 'wgExtensionMessagesFiles' );
915 $deps['wgMessagesDirs'] = new GlobalDependency( 'wgMessagesDirs' );
916 $deps['version'] = new ConstantDependency( 'LocalisationCache::VERSION' );
918 # Add dependencies to the cache entry
919 $allData['deps'] = $deps;
921 # Replace spaces with underscores in namespace names
922 $allData['namespaceNames'] = str_replace( ' ', '_', $allData['namespaceNames'] );
924 # And do the same for special page aliases. $page is an array.
925 foreach ( $allData['specialPageAliases'] as &$page ) {
926 $page = str_replace( ' ', '_', $page );
928 # Decouple the reference to prevent accidental damage
931 # If there were no plural rules, return an empty array
932 if ( $allData['pluralRules'] === null ) {
933 $allData['pluralRules'] = array();
935 if ( $allData['compiledPluralRules'] === null ) {
936 $allData['compiledPluralRules'] = array();
938 # If there were no plural rule types, return an empty array
939 if ( $allData['pluralRuleTypes'] === null ) {
940 $allData['pluralRuleTypes'] = array();
944 $allData['list'] = array();
945 foreach ( self
::$splitKeys as $key ) {
946 $allData['list'][$key] = array_keys( $allData[$key] );
950 wfRunHooks( 'LocalisationCacheRecache', array( $this, $code, &$allData, &$purgeBlobs ) );
952 if ( is_null( $allData['namespaceNames'] ) ) {
953 wfProfileOut( __METHOD__
);
954 throw new MWException( __METHOD__
. ': Localisation data failed sanity check! ' .
955 'Check that your languages/messages/MessagesEn.php file is intact.' );
958 # Set the preload key
959 $allData['preload'] = $this->buildPreload( $allData );
961 # Save to the process cache and register the items loaded
962 $this->data
[$code] = $allData;
963 foreach ( $allData as $key => $item ) {
964 $this->loadedItems
[$code][$key] = true;
967 # Save to the persistent cache
968 wfProfileIn( __METHOD__
. '-write' );
969 $this->store
->startWrite( $code );
970 foreach ( $allData as $key => $value ) {
971 if ( in_array( $key, self
::$splitKeys ) ) {
972 foreach ( $value as $subkey => $subvalue ) {
973 $this->store
->set( "$key:$subkey", $subvalue );
976 $this->store
->set( $key, $value );
979 $this->store
->finishWrite();
980 wfProfileOut( __METHOD__
. '-write' );
982 # Clear out the MessageBlobStore
983 # HACK: If using a null (i.e. disabled) storage backend, we
984 # can't write to the MessageBlobStore either
985 if ( $purgeBlobs && !$this->store
instanceof LCStoreNull
) {
986 MessageBlobStore
::clear();
989 wfProfileOut( __METHOD__
);
993 * Build the preload item from the given pre-cache data.
995 * The preload item will be loaded automatically, improving performance
996 * for the commonly-requested items it contains.
1000 protected function buildPreload( $data ) {
1001 $preload = array( 'messages' => array() );
1002 foreach ( self
::$preloadedKeys as $key ) {
1003 $preload[$key] = $data[$key];
1006 foreach ( $data['preloadedMessages'] as $subkey ) {
1007 if ( isset( $data['messages'][$subkey] ) ) {
1008 $subitem = $data['messages'][$subkey];
1012 $preload['messages'][$subkey] = $subitem;
1019 * Unload the data for a given language from the object cache.
1020 * Reduces memory usage.
1021 * @param string $code
1023 public function unload( $code ) {
1024 unset( $this->data
[$code] );
1025 unset( $this->loadedItems
[$code] );
1026 unset( $this->loadedSubitems
[$code] );
1027 unset( $this->initialisedLangs
[$code] );
1028 unset( $this->shallowFallbacks
[$code] );
1030 foreach ( $this->shallowFallbacks
as $shallowCode => $fbCode ) {
1031 if ( $fbCode === $code ) {
1032 $this->unload( $shallowCode );
1040 public function unloadAll() {
1041 foreach ( $this->initialisedLangs
as $lang => $unused ) {
1042 $this->unload( $lang );
1047 * Disable the storage backend
1049 public function disableBackend() {
1050 $this->store
= new LCStoreNull
;
1051 $this->manualRecache
= false;
1056 * Interface for the persistence layer of LocalisationCache.
1058 * The persistence layer is two-level hierarchical cache. The first level
1059 * is the language, the second level is the item or subitem.
1061 * Since the data for a whole language is rebuilt in one operation, it needs
1062 * to have a fast and atomic method for deleting or replacing all of the
1063 * current data for a given language. The interface reflects this bulk update
1064 * operation. Callers writing to the cache must first call startWrite(), then
1065 * will call set() a couple of thousand times, then will call finishWrite()
1066 * to commit the operation. When finishWrite() is called, the cache is
1067 * expected to delete all data previously stored for that language.
1069 * The values stored are PHP variables suitable for serialize(). Implementations
1070 * of LCStore are responsible for serializing and unserializing.
1075 * @param string $code Language code
1076 * @param string $key Cache key
1078 function get( $code, $key );
1081 * Start a write transaction.
1082 * @param string $code Language code
1084 function startWrite( $code );
1087 * Finish a write transaction.
1089 function finishWrite();
1092 * Set a key to a given value. startWrite() must be called before this
1093 * is called, and finishWrite() must be called afterwards.
1094 * @param string $key
1095 * @param mixed $value
1097 function set( $key, $value );
1101 * LCStore implementation which uses PHP accelerator to store data.
1102 * This will work if one of XCache, WinCache or APC cacher is configured.
1103 * (See ObjectCache.php)
1105 class LCStoreAccel
implements LCStore
{
1106 private $currentLang;
1109 public function __construct() {
1110 $this->cache
= wfGetCache( CACHE_ACCEL
);
1113 public function get( $code, $key ) {
1114 $k = wfMemcKey( 'l10n', $code, 'k', $key );
1115 $r = $this->cache
->get( $k );
1117 return $r === false ?
null : $r;
1120 public function startWrite( $code ) {
1121 $k = wfMemcKey( 'l10n', $code, 'l' );
1122 $keys = $this->cache
->get( $k );
1124 foreach ( $keys as $k ) {
1125 $this->cache
->delete( $k );
1128 $this->currentLang
= $code;
1129 $this->keys
= array();
1132 public function finishWrite() {
1133 if ( $this->currentLang
) {
1134 $k = wfMemcKey( 'l10n', $this->currentLang
, 'l' );
1135 $this->cache
->set( $k, array_keys( $this->keys
) );
1137 $this->currentLang
= null;
1138 $this->keys
= array();
1141 public function set( $key, $value ) {
1142 if ( $this->currentLang
) {
1143 $k = wfMemcKey( 'l10n', $this->currentLang
, 'k', $key );
1144 $this->keys
[$k] = true;
1145 $this->cache
->set( $k, $value );
1151 * LCStore implementation which uses the standard DB functions to store data.
1152 * This will work on any MediaWiki installation.
1154 class LCStoreDB
implements LCStore
{
1155 private $currentLang;
1156 private $writesDone = false;
1158 /** @var DatabaseBase */
1161 private $batch = array();
1163 private $readOnly = false;
1165 public function get( $code, $key ) {
1166 if ( $this->writesDone
&& $this->dbw
) {
1169 $db = wfGetDB( DB_SLAVE
);
1171 $row = $db->selectRow( 'l10n_cache', array( 'lc_value' ),
1172 array( 'lc_lang' => $code, 'lc_key' => $key ), __METHOD__
);
1174 return unserialize( $db->decodeBlob( $row->lc_value
) );
1180 public function startWrite( $code ) {
1181 if ( $this->readOnly
) {
1183 } elseif ( !$code ) {
1184 throw new MWException( __METHOD__
. ": Invalid language \"$code\"" );
1187 // We must keep a separate connection to MySQL in order to avoid breaking
1188 // main transactions. However, SQLite deadlocks when using two connections.
1189 // @todo get this trick to work on PostgreSQL too
1190 if ( wfGetDB( DB_MASTER
)->getType() == 'mysql' ) {
1191 $lb = wfGetLBFactory()->newMainLB();
1192 $this->dbw
= $lb->getConnection( DB_MASTER
);
1193 $this->dbw
->clearFlag( DBO_TRX
); // auto-commit mode
1195 $this->dbw
= wfGetDB( DB_MASTER
);
1198 $this->currentLang
= $code;
1199 $this->batch
= array();
1202 public function finishWrite() {
1203 if ( $this->readOnly
) {
1205 } elseif ( is_null( $this->currentLang
) ) {
1206 throw new MWException( __CLASS__
. ': must call startWrite() before finishWrite()' );
1209 $this->dbw
->begin( __METHOD__
);
1211 $this->dbw
->delete( 'l10n_cache',
1212 array( 'lc_lang' => $this->currentLang
), __METHOD__
);
1213 foreach ( array_chunk( $this->batch
, 500 ) as $rows ) {
1214 $this->dbw
->insert( 'l10n_cache', $rows, __METHOD__
);
1216 $this->writesDone
= true;
1217 } catch ( DBQueryError
$e ) {
1218 if ( $this->dbw
->wasReadOnlyError() ) {
1219 $this->readOnly
= true; // just avoid site down time
1224 $this->dbw
->commit( __METHOD__
);
1226 $this->currentLang
= null;
1227 $this->batch
= array();
1230 public function set( $key, $value ) {
1231 if ( $this->readOnly
) {
1233 } elseif ( is_null( $this->currentLang
) ) {
1234 throw new MWException( __CLASS__
. ': must call startWrite() before set()' );
1237 $this->batch
[] = array(
1238 'lc_lang' => $this->currentLang
,
1240 'lc_value' => $this->dbw
->encodeBlob( serialize( $value ) ) );
1245 * LCStore implementation which stores data as a collection of CDB files in the
1246 * directory given by $wgCacheDirectory. If $wgCacheDirectory is not set, this
1247 * will throw an exception.
1249 * Profiling indicates that on Linux, this implementation outperforms MySQL if
1250 * the directory is on a local filesystem and there is ample kernel cache
1251 * space. The performance advantage is greater when the DBA extension is
1252 * available than it is with the PHP port.
1254 * See Cdb.php and http://cr.yp.to/cdb.html
1256 class LCStoreCDB
implements LCStore
{
1257 /** @var CdbReader[] */
1260 /** @var CdbWriter */
1263 /** @var string Current language code */
1264 private $currentLang;
1266 /** @var bool|string Cache directory. False if not set */
1269 function __construct( $conf = array() ) {
1270 global $wgCacheDirectory;
1272 if ( isset( $conf['directory'] ) ) {
1273 $this->directory
= $conf['directory'];
1275 $this->directory
= $wgCacheDirectory;
1279 public function get( $code, $key ) {
1280 if ( !isset( $this->readers
[$code] ) ) {
1281 $fileName = $this->getFileName( $code );
1283 $this->readers
[$code] = false;
1284 if ( file_exists( $fileName ) ) {
1286 $this->readers
[$code] = CdbReader
::open( $fileName );
1287 } catch ( CdbException
$e ) {
1288 wfDebug( __METHOD__
. ": unable to open cdb file for reading\n" );
1293 if ( !$this->readers
[$code] ) {
1298 $value = $this->readers
[$code]->get( $key );
1299 } catch ( CdbException
$e ) {
1300 wfDebug( __METHOD__
. ": CdbException caught, error message was "
1301 . $e->getMessage() . "\n" );
1303 if ( $value === false ) {
1307 return unserialize( $value );
1311 public function startWrite( $code ) {
1312 if ( !file_exists( $this->directory
) ) {
1313 if ( !wfMkdirParents( $this->directory
, null, __METHOD__
) ) {
1314 throw new MWException( "Unable to create the localisation store " .
1315 "directory \"{$this->directory}\"" );
1319 // Close reader to stop permission errors on write
1320 if ( !empty( $this->readers
[$code] ) ) {
1321 $this->readers
[$code]->close();
1325 $this->writer
= CdbWriter
::open( $this->getFileName( $code ) );
1326 } catch ( CdbException
$e ) {
1327 throw new MWException( $e->getMessage() );
1329 $this->currentLang
= $code;
1332 public function finishWrite() {
1335 $this->writer
->close();
1336 } catch ( CdbException
$e ) {
1337 throw new MWException( $e->getMessage() );
1339 $this->writer
= null;
1340 unset( $this->readers
[$this->currentLang
] );
1341 $this->currentLang
= null;
1344 public function set( $key, $value ) {
1345 if ( is_null( $this->writer
) ) {
1346 throw new MWException( __CLASS__
. ': must call startWrite() before calling set()' );
1349 $this->writer
->set( $key, serialize( $value ) );
1350 } catch ( CdbException
$e ) {
1351 throw new MWException( $e->getMessage() );
1355 protected function getFileName( $code ) {
1356 if ( strval( $code ) === '' ||
strpos( $code, '/' ) !== false ) {
1357 throw new MWException( __METHOD__
. ": Invalid language \"$code\"" );
1360 return "{$this->directory}/l10n_cache-$code.cdb";
1365 * Null store backend, used to avoid DB errors during install
1367 class LCStoreNull
implements LCStore
{
1368 public function get( $code, $key ) {
1372 public function startWrite( $code ) {
1375 public function finishWrite() {
1378 public function set( $key, $value ) {
1383 * A localisation cache optimised for loading large amounts of data for many
1384 * languages. Used by rebuildLocalisationCache.php.
1386 class LocalisationCacheBulkLoad
extends LocalisationCache
{
1388 * A cache of the contents of data files.
1389 * Core files are serialized to avoid using ~1GB of RAM during a recache.
1391 private $fileCache = array();
1394 * Most recently used languages. Uses the linked-list aspect of PHP hashtables
1395 * to keep the most recently used language codes at the end of the array, and
1396 * the language codes that are ready to be deleted at the beginning.
1398 private $mruLangs = array();
1401 * Maximum number of languages that may be loaded into $this->data
1403 private $maxLoadedLangs = 10;
1406 * @param string $fileName
1407 * @param string $fileType
1408 * @return array|mixed
1410 protected function readPHPFile( $fileName, $fileType ) {
1411 $serialize = $fileType === 'core';
1412 if ( !isset( $this->fileCache
[$fileName][$fileType] ) ) {
1413 $data = parent
::readPHPFile( $fileName, $fileType );
1416 $encData = serialize( $data );
1421 $this->fileCache
[$fileName][$fileType] = $encData;
1424 } elseif ( $serialize ) {
1425 return unserialize( $this->fileCache
[$fileName][$fileType] );
1427 return $this->fileCache
[$fileName][$fileType];
1432 * @param string $code
1433 * @param string $key
1436 public function getItem( $code, $key ) {
1437 unset( $this->mruLangs
[$code] );
1438 $this->mruLangs
[$code] = true;
1440 return parent
::getItem( $code, $key );
1444 * @param string $code
1445 * @param string $key
1446 * @param string $subkey
1449 public function getSubitem( $code, $key, $subkey ) {
1450 unset( $this->mruLangs
[$code] );
1451 $this->mruLangs
[$code] = true;
1453 return parent
::getSubitem( $code, $key, $subkey );
1457 * @param string $code
1459 public function recache( $code ) {
1460 parent
::recache( $code );
1461 unset( $this->mruLangs
[$code] );
1462 $this->mruLangs
[$code] = true;
1467 * @param string $code
1469 public function unload( $code ) {
1470 unset( $this->mruLangs
[$code] );
1471 parent
::unload( $code );
1475 * Unload cached languages until there are less than $this->maxLoadedLangs
1477 protected function trimCache() {
1478 while ( count( $this->data
) > $this->maxLoadedLangs
&& count( $this->mruLangs
) ) {
1479 reset( $this->mruLangs
);
1480 $code = key( $this->mruLangs
);
1481 wfDebug( __METHOD__
. ": unloading $code\n" );
1482 $this->unload( $code );