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 define( 'MW_LC_VERSION', 2 );
26 * Class for caching the contents of localisation files, Messages*.php
29 * An instance of this class is available using Language::getLocalisationCache().
31 * The values retrieved from here are merged, containing items from extension
32 * files, core messages files and the language fallback sequence (e.g. zh-cn ->
33 * zh-hans -> en ). Some common errors are corrected, for example namespace
34 * names with spaces instead of underscores, but heavyweight processing, such
35 * as grammatical transformation, is done by the caller.
37 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 wfDebug( get_class( $this ) . ": using store $storeClass\n" );
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.
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.
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
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.
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
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.
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 ( file_exists( Language
::getMessagesFileName( $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 $primaryCode
494 * @param $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.
507 * @throws MWException
510 protected function readPHPFile( $_fileName, $_fileType ) {
511 wfProfileIn( __METHOD__
);
512 // Disable APC caching
513 $_apcEnabled = ini_set( 'apc.cache_by_default', '0' );
515 ini_set( 'apc.cache_by_default', $_apcEnabled );
517 if ( $_fileType == 'core' ||
$_fileType == 'extension' ) {
518 $data = compact( self
::$allKeys );
519 } elseif ( $_fileType == 'aliases' ) {
520 $data = compact( 'aliases' );
522 wfProfileOut( __METHOD__
);
523 throw new MWException( __METHOD__
. ": Invalid file type: $_fileType" );
525 wfProfileOut( __METHOD__
);
531 * Read a JSON file containing localisation messages.
532 * @param string $fileName Name of file to read
533 * @throws MWException if there is a syntax error in the JSON file
534 * @return array with a 'messages' key, or empty array if the file doesn't exist
536 protected function readJSONFile( $fileName ) {
537 wfProfileIn( __METHOD__
);
538 if ( !is_readable( $fileName ) ) {
542 $json = file_get_contents( $fileName );
543 if ( $json === false ) {
546 $data = FormatJson
::decode( $json, true );
547 if ( $data === null ) {
548 throw new MWException( __METHOD__
. ": Invalid JSON file: $fileName" );
550 // Remove keys starting with '@', they're reserved for metadata and non-message data
551 foreach ( $data as $key => $unused ) {
552 if ( $key === '' ||
$key[0] === '@' ) {
553 unset( $data[$key] );
556 // The JSON format only supports messages, none of the other variables, so wrap the data
557 return array( 'messages' => $data );
561 * Get the compiled plural rules for a given language from the XML files.
564 public function getCompiledPluralRules( $code ) {
565 $rules = $this->getPluralRules( $code );
566 if ( $rules === null ) {
570 $compiledRules = CLDRPluralRuleEvaluator
::compile( $rules );
571 } catch ( CLDRPluralRuleError
$e ) {
572 wfDebugLog( 'l10n', $e->getMessage() . "\n" );
577 return $compiledRules;
581 * Get the plural rules for a given language from the XML files.
585 public function getPluralRules( $code ) {
586 if ( $this->pluralRules
=== null ) {
587 $this->loadPluralFiles();
589 if ( !isset( $this->pluralRules
[$code] ) ) {
592 return $this->pluralRules
[$code];
597 * Get the plural rule types for a given language from the XML files.
601 public function getPluralRuleTypes( $code ) {
602 if ( $this->pluralRuleTypes
=== null ) {
603 $this->loadPluralFiles();
605 if ( !isset( $this->pluralRuleTypes
[$code] ) ) {
608 return $this->pluralRuleTypes
[$code];
613 * Load the plural XML files.
615 protected function loadPluralFiles() {
617 $cldrPlural = "$IP/languages/data/plurals.xml";
618 $mwPlural = "$IP/languages/data/plurals-mediawiki.xml";
619 // Load CLDR plural rules
620 $this->loadPluralFile( $cldrPlural );
621 if ( file_exists( $mwPlural ) ) {
622 // Override or extend
623 $this->loadPluralFile( $mwPlural );
628 * Load a plural XML file with the given filename, compile the relevant
629 * rules, and save the compiled rules in a process-local cache.
631 protected function loadPluralFile( $fileName ) {
632 $doc = new DOMDocument
;
633 $doc->load( $fileName );
634 $rulesets = $doc->getElementsByTagName( "pluralRules" );
635 foreach ( $rulesets as $ruleset ) {
636 $codes = $ruleset->getAttribute( 'locales' );
638 $ruleTypes = array();
639 $ruleElements = $ruleset->getElementsByTagName( "pluralRule" );
640 foreach ( $ruleElements as $elt ) {
641 $ruleType = $elt->getAttribute( 'count' );
642 if ( $ruleType === 'other' ) {
643 // Don't record "other" rules, which have an empty condition
646 $rules[] = $elt->nodeValue
;
647 $ruleTypes[] = $ruleType;
649 foreach ( explode( ' ', $codes ) as $code ) {
650 $this->pluralRules
[$code] = $rules;
651 $this->pluralRuleTypes
[$code] = $ruleTypes;
657 * Read the data from the source files for a given language, and register
658 * the relevant dependencies in the $deps array. If the localisation
659 * exists, the data array is returned, otherwise false is returned.
661 protected function readSourceFilesAndRegisterDeps( $code, &$deps ) {
663 wfProfileIn( __METHOD__
);
665 $fileName = Language
::getMessagesFileName( $code );
666 if ( !file_exists( $fileName ) ) {
667 wfProfileOut( __METHOD__
);
672 $deps[] = new FileDependency( $fileName );
673 $data = $this->readPHPFile( $fileName, 'core' );
675 # Load CLDR plural rules for JavaScript
676 $data['pluralRules'] = $this->getPluralRules( $code );
678 $data['compiledPluralRules'] = $this->getCompiledPluralRules( $code );
679 # Load plural rule types
680 $data['pluralRuleTypes'] = $this->getPluralRuleTypes( $code );
682 $deps['plurals'] = new FileDependency( "$IP/languages/data/plurals.xml" );
683 $deps['plurals-mw'] = new FileDependency( "$IP/languages/data/plurals-mediawiki.xml" );
685 wfProfileOut( __METHOD__
);
691 * Merge two localisation values, a primary and a fallback, overwriting the
692 * primary value in place.
695 * @param $fallbackValue
697 protected function mergeItem( $key, &$value, $fallbackValue ) {
698 if ( !is_null( $value ) ) {
699 if ( !is_null( $fallbackValue ) ) {
700 if ( in_array( $key, self
::$mergeableMapKeys ) ) {
701 $value = $value +
$fallbackValue;
702 } elseif ( in_array( $key, self
::$mergeableListKeys ) ) {
703 $value = array_unique( array_merge( $fallbackValue, $value ) );
704 } elseif ( in_array( $key, self
::$mergeableAliasListKeys ) ) {
705 $value = array_merge_recursive( $value, $fallbackValue );
706 } elseif ( in_array( $key, self
::$optionalMergeKeys ) ) {
707 if ( !empty( $value['inherit'] ) ) {
708 $value = array_merge( $fallbackValue, $value );
711 if ( isset( $value['inherit'] ) ) {
712 unset( $value['inherit'] );
714 } elseif ( in_array( $key, self
::$magicWordKeys ) ) {
715 $this->mergeMagicWords( $value, $fallbackValue );
719 $value = $fallbackValue;
725 * @param $fallbackValue
727 protected function mergeMagicWords( &$value, $fallbackValue ) {
728 foreach ( $fallbackValue as $magicName => $fallbackInfo ) {
729 if ( !isset( $value[$magicName] ) ) {
730 $value[$magicName] = $fallbackInfo;
732 $oldSynonyms = array_slice( $fallbackInfo, 1 );
733 $newSynonyms = array_slice( $value[$magicName], 1 );
734 $synonyms = array_values( array_unique( array_merge(
735 $newSynonyms, $oldSynonyms ) ) );
736 $value[$magicName] = array_merge( array( $fallbackInfo[0] ), $synonyms );
742 * Given an array mapping language code to localisation value, such as is
743 * found in extension *.i18n.php files, iterate through a fallback sequence
744 * to merge the given data with an existing primary value.
746 * Returns true if any data from the extension array was used, false
748 * @param $codeSequence
751 * @param $fallbackValue
754 protected function mergeExtensionItem( $codeSequence, $key, &$value, $fallbackValue ) {
756 foreach ( $codeSequence as $code ) {
757 if ( isset( $fallbackValue[$code] ) ) {
758 $this->mergeItem( $key, $value, $fallbackValue[$code] );
767 * Load localisation data for a given language for both core and extensions
768 * and save it to the persistent cache store and the process cache
770 * @throws MWException
772 public function recache( $code ) {
773 global $wgExtensionMessagesFiles, $wgMessagesDirs;
774 wfProfileIn( __METHOD__
);
777 wfProfileOut( __METHOD__
);
778 throw new MWException( "Invalid language code requested" );
780 $this->recachedLangs
[$code] = true;
783 $initialData = array_combine(
785 array_fill( 0, count( self
::$allKeys ), null ) );
786 $coreData = $initialData;
789 # Load the primary localisation from the source file
790 $data = $this->readSourceFilesAndRegisterDeps( $code, $deps );
791 if ( $data === false ) {
792 wfDebug( __METHOD__
. ": no localisation file for $code, using fallback to en\n" );
793 $coreData['fallback'] = 'en';
795 wfDebug( __METHOD__
. ": got localisation for $code from source\n" );
797 # Merge primary localisation
798 foreach ( $data as $key => $value ) {
799 $this->mergeItem( $key, $coreData[$key], $value );
803 # Fill in the fallback if it's not there already
804 if ( is_null( $coreData['fallback'] ) ) {
805 $coreData['fallback'] = $code === 'en' ?
false : 'en';
807 if ( $coreData['fallback'] === false ) {
808 $coreData['fallbackSequence'] = array();
810 $coreData['fallbackSequence'] = array_map( 'trim', explode( ',', $coreData['fallback'] ) );
811 $len = count( $coreData['fallbackSequence'] );
813 # Ensure that the sequence ends at en
814 if ( $coreData['fallbackSequence'][$len - 1] !== 'en' ) {
815 $coreData['fallbackSequence'][] = 'en';
818 # Load the fallback localisation item by item and merge it
819 foreach ( $coreData['fallbackSequence'] as $fbCode ) {
820 # Load the secondary localisation from the source file to
821 # avoid infinite cycles on cyclic fallbacks
822 $fbData = $this->readSourceFilesAndRegisterDeps( $fbCode, $deps );
823 if ( $fbData === false ) {
827 foreach ( self
::$allKeys as $key ) {
828 if ( !isset( $fbData[$key] ) ) {
832 if ( is_null( $coreData[$key] ) ||
$this->isMergeableKey( $key ) ) {
833 $this->mergeItem( $key, $coreData[$key], $fbData[$key] );
839 $codeSequence = array_merge( array( $code ), $coreData['fallbackSequence'] );
841 # Load the extension localisations
842 # This is done after the core because we know the fallback sequence now.
843 # But it has a higher precedence for merging so that we can support things
844 # like site-specific message overrides.
845 wfProfileIn( __METHOD__
. '-extensions' );
846 $allData = $initialData;
847 foreach ( $wgMessagesDirs as $dirs ) {
848 foreach ( (array)$dirs as $dir ) {
849 foreach ( $codeSequence as $csCode ) {
850 $fileName = "$dir/$csCode.json";
851 $data = $this->readJSONFile( $fileName );
853 foreach ( $data as $key => $item ) {
854 $this->mergeItem( $key, $allData[$key], $item );
857 $deps[] = new FileDependency( $fileName );
862 foreach ( $wgExtensionMessagesFiles as $extension => $fileName ) {
863 $data = $this->readPHPFile( $fileName, 'extension' );
866 foreach ( $data as $key => $item ) {
867 if ( $key === 'messages' && isset( $wgMessagesDirs[$extension] ) ) {
868 # For backwards compatibility, ignore messages from extensions in
869 # $wgExtensionMessagesFiles that are also present in $wgMessagesDirs.
870 # This allows extensions to use both and be backwards compatible.
871 # Variables other than $messages still need to be supported though.
874 if ( $this->mergeExtensionItem( $codeSequence, $key, $allData[$key], $item ) ) {
880 $deps[] = new FileDependency( $fileName );
884 # Merge core data into extension data
885 foreach ( $coreData as $key => $item ) {
886 $this->mergeItem( $key, $allData[$key], $item );
888 wfProfileOut( __METHOD__
. '-extensions' );
890 # Add cache dependencies for any referenced globals
891 $deps['wgExtensionMessagesFiles'] = new GlobalDependency( 'wgExtensionMessagesFiles' );
892 $deps['wgMessagesDirs'] = new GlobalDependency( 'wgMessagesDirs' );
893 $deps['version'] = new ConstantDependency( 'MW_LC_VERSION' );
895 # Add dependencies to the cache entry
896 $allData['deps'] = $deps;
898 # Replace spaces with underscores in namespace names
899 $allData['namespaceNames'] = str_replace( ' ', '_', $allData['namespaceNames'] );
901 # And do the same for special page aliases. $page is an array.
902 foreach ( $allData['specialPageAliases'] as &$page ) {
903 $page = str_replace( ' ', '_', $page );
905 # Decouple the reference to prevent accidental damage
908 # If there were no plural rules, return an empty array
909 if ( $allData['pluralRules'] === null ) {
910 $allData['pluralRules'] = array();
912 if ( $allData['compiledPluralRules'] === null ) {
913 $allData['compiledPluralRules'] = array();
915 # If there were no plural rule types, return an empty array
916 if ( $allData['pluralRuleTypes'] === null ) {
917 $allData['pluralRuleTypes'] = array();
921 $allData['list'] = array();
922 foreach ( self
::$splitKeys as $key ) {
923 $allData['list'][$key] = array_keys( $allData[$key] );
927 wfRunHooks( 'LocalisationCacheRecache', array( $this, $code, &$allData, &$purgeBlobs ) );
929 if ( is_null( $allData['namespaceNames'] ) ) {
930 wfProfileOut( __METHOD__
);
931 throw new MWException( __METHOD__
. ': Localisation data failed sanity check! ' .
932 'Check that your languages/messages/MessagesEn.php file is intact.' );
935 # Set the preload key
936 $allData['preload'] = $this->buildPreload( $allData );
938 # Save to the process cache and register the items loaded
939 $this->data
[$code] = $allData;
940 foreach ( $allData as $key => $item ) {
941 $this->loadedItems
[$code][$key] = true;
944 # Save to the persistent cache
945 wfProfileIn( __METHOD__
. '-write' );
946 $this->store
->startWrite( $code );
947 foreach ( $allData as $key => $value ) {
948 if ( in_array( $key, self
::$splitKeys ) ) {
949 foreach ( $value as $subkey => $subvalue ) {
950 $this->store
->set( "$key:$subkey", $subvalue );
953 $this->store
->set( $key, $value );
956 $this->store
->finishWrite();
957 wfProfileOut( __METHOD__
. '-write' );
959 # Clear out the MessageBlobStore
960 # HACK: If using a null (i.e. disabled) storage backend, we
961 # can't write to the MessageBlobStore either
962 if ( $purgeBlobs && !$this->store
instanceof LCStoreNull
) {
963 MessageBlobStore
::clear();
966 wfProfileOut( __METHOD__
);
970 * Build the preload item from the given pre-cache data.
972 * The preload item will be loaded automatically, improving performance
973 * for the commonly-requested items it contains.
977 protected function buildPreload( $data ) {
978 $preload = array( 'messages' => array() );
979 foreach ( self
::$preloadedKeys as $key ) {
980 $preload[$key] = $data[$key];
983 foreach ( $data['preloadedMessages'] as $subkey ) {
984 if ( isset( $data['messages'][$subkey] ) ) {
985 $subitem = $data['messages'][$subkey];
989 $preload['messages'][$subkey] = $subitem;
996 * Unload the data for a given language from the object cache.
997 * Reduces memory usage.
1000 public function unload( $code ) {
1001 unset( $this->data
[$code] );
1002 unset( $this->loadedItems
[$code] );
1003 unset( $this->loadedSubitems
[$code] );
1004 unset( $this->initialisedLangs
[$code] );
1005 unset( $this->shallowFallbacks
[$code] );
1007 foreach ( $this->shallowFallbacks
as $shallowCode => $fbCode ) {
1008 if ( $fbCode === $code ) {
1009 $this->unload( $shallowCode );
1017 public function unloadAll() {
1018 foreach ( $this->initialisedLangs
as $lang => $unused ) {
1019 $this->unload( $lang );
1024 * Disable the storage backend
1026 public function disableBackend() {
1027 $this->store
= new LCStoreNull
;
1028 $this->manualRecache
= false;
1033 * Interface for the persistence layer of LocalisationCache.
1035 * The persistence layer is two-level hierarchical cache. The first level
1036 * is the language, the second level is the item or subitem.
1038 * Since the data for a whole language is rebuilt in one operation, it needs
1039 * to have a fast and atomic method for deleting or replacing all of the
1040 * current data for a given language. The interface reflects this bulk update
1041 * operation. Callers writing to the cache must first call startWrite(), then
1042 * will call set() a couple of thousand times, then will call finishWrite()
1043 * to commit the operation. When finishWrite() is called, the cache is
1044 * expected to delete all data previously stored for that language.
1046 * The values stored are PHP variables suitable for serialize(). Implementations
1047 * of LCStore are responsible for serializing and unserializing.
1052 * @param string $code Language code
1053 * @param string $key Cache key
1055 function get( $code, $key );
1058 * Start a write transaction.
1059 * @param string $code Language code
1061 function startWrite( $code );
1064 * Finish a write transaction.
1066 function finishWrite();
1069 * Set a key to a given value. startWrite() must be called before this
1070 * is called, and finishWrite() must be called afterwards.
1071 * @param string $key
1072 * @param mixed $value
1074 function set( $key, $value );
1078 * LCStore implementation which uses PHP accelerator to store data.
1079 * This will work if one of XCache, WinCache or APC cacher is configured.
1080 * (See ObjectCache.php)
1082 class LCStoreAccel
implements LCStore
{
1083 private $currentLang;
1086 public function __construct() {
1087 $this->cache
= wfGetCache( CACHE_ACCEL
);
1090 public function get( $code, $key ) {
1091 $k = wfMemcKey( 'l10n', $code, 'k', $key );
1092 $r = $this->cache
->get( $k );
1094 return $r === false ?
null : $r;
1097 public function startWrite( $code ) {
1098 $k = wfMemcKey( 'l10n', $code, 'l' );
1099 $keys = $this->cache
->get( $k );
1101 foreach ( $keys as $k ) {
1102 $this->cache
->delete( $k );
1105 $this->currentLang
= $code;
1106 $this->keys
= array();
1109 public function finishWrite() {
1110 if ( $this->currentLang
) {
1111 $k = wfMemcKey( 'l10n', $this->currentLang
, 'l' );
1112 $this->cache
->set( $k, array_keys( $this->keys
) );
1114 $this->currentLang
= null;
1115 $this->keys
= array();
1118 public function set( $key, $value ) {
1119 if ( $this->currentLang
) {
1120 $k = wfMemcKey( 'l10n', $this->currentLang
, 'k', $key );
1121 $this->keys
[$k] = true;
1122 $this->cache
->set( $k, $value );
1128 * LCStore implementation which uses the standard DB functions to store data.
1129 * This will work on any MediaWiki installation.
1131 class LCStoreDB
implements LCStore
{
1132 private $currentLang;
1133 private $writesDone = false;
1140 private $readOnly = false;
1142 public function get( $code, $key ) {
1143 if ( $this->writesDone
) {
1144 $db = wfGetDB( DB_MASTER
);
1146 $db = wfGetDB( DB_SLAVE
);
1148 $row = $db->selectRow( 'l10n_cache', array( 'lc_value' ),
1149 array( 'lc_lang' => $code, 'lc_key' => $key ), __METHOD__
);
1151 return unserialize( $row->lc_value
);
1157 public function startWrite( $code ) {
1158 if ( $this->readOnly
) {
1163 throw new MWException( __METHOD__
. ": Invalid language \"$code\"" );
1166 $this->dbw
= wfGetDB( DB_MASTER
);
1168 $this->dbw
->begin( __METHOD__
);
1169 $this->dbw
->delete( 'l10n_cache', array( 'lc_lang' => $code ), __METHOD__
);
1170 } catch ( DBQueryError
$e ) {
1171 if ( $this->dbw
->wasReadOnlyError() ) {
1172 $this->readOnly
= true;
1173 $this->dbw
->rollback( __METHOD__
);
1181 $this->currentLang
= $code;
1182 $this->batch
= array();
1185 public function finishWrite() {
1186 if ( $this->readOnly
) {
1190 if ( $this->batch
) {
1191 $this->dbw
->insert( 'l10n_cache', $this->batch
, __METHOD__
);
1194 $this->dbw
->commit( __METHOD__
);
1195 $this->currentLang
= null;
1197 $this->batch
= array();
1198 $this->writesDone
= true;
1201 public function set( $key, $value ) {
1202 if ( $this->readOnly
) {
1206 if ( is_null( $this->currentLang
) ) {
1207 throw new MWException( __CLASS__
. ': must call startWrite() before calling set()' );
1210 $this->batch
[] = array(
1211 'lc_lang' => $this->currentLang
,
1213 'lc_value' => serialize( $value ) );
1215 if ( count( $this->batch
) >= 100 ) {
1216 $this->dbw
->insert( 'l10n_cache', $this->batch
, __METHOD__
);
1217 $this->batch
= array();
1223 * LCStore implementation which stores data as a collection of CDB files in the
1224 * directory given by $wgCacheDirectory. If $wgCacheDirectory is not set, this
1225 * will throw an exception.
1227 * Profiling indicates that on Linux, this implementation outperforms MySQL if
1228 * the directory is on a local filesystem and there is ample kernel cache
1229 * space. The performance advantage is greater when the DBA extension is
1230 * available than it is with the PHP port.
1232 * See Cdb.php and http://cr.yp.to/cdb.html
1234 class LCStoreCDB
implements LCStore
{
1235 /** @var CdbReader[] */
1238 /** @var CdbWriter */
1241 /** @var string Current language code */
1242 private $currentLang;
1244 /** @var bool|string Cache directory. False if not set */
1247 function __construct( $conf = array() ) {
1248 global $wgCacheDirectory;
1250 if ( isset( $conf['directory'] ) ) {
1251 $this->directory
= $conf['directory'];
1253 $this->directory
= $wgCacheDirectory;
1257 public function get( $code, $key ) {
1258 if ( !isset( $this->readers
[$code] ) ) {
1259 $fileName = $this->getFileName( $code );
1261 $this->readers
[$code] = false;
1262 if ( file_exists( $fileName ) ) {
1264 $this->readers
[$code] = CdbReader
::open( $fileName );
1265 } catch ( CdbException
$e ) {
1266 wfDebug( __METHOD__
. ": unable to open cdb file for reading" );
1271 if ( !$this->readers
[$code] ) {
1276 $value = $this->readers
[$code]->get( $key );
1277 } catch ( CdbException
$e ) {
1278 wfDebug( __METHOD__
. ": CdbException caught, error message was "
1279 . $e->getMessage() );
1281 if ( $value === false ) {
1285 return unserialize( $value );
1289 public function startWrite( $code ) {
1290 if ( !file_exists( $this->directory
) ) {
1291 if ( !wfMkdirParents( $this->directory
, null, __METHOD__
) ) {
1292 throw new MWException( "Unable to create the localisation store " .
1293 "directory \"{$this->directory}\"" );
1297 // Close reader to stop permission errors on write
1298 if ( !empty( $this->readers
[$code] ) ) {
1299 $this->readers
[$code]->close();
1303 $this->writer
= CdbWriter
::open( $this->getFileName( $code ) );
1304 } catch ( CdbException
$e ) {
1305 throw new MWException( $e->getMessage() );
1307 $this->currentLang
= $code;
1310 public function finishWrite() {
1313 $this->writer
->close();
1314 } catch ( CdbException
$e ) {
1315 throw new MWException( $e->getMessage() );
1317 $this->writer
= null;
1318 unset( $this->readers
[$this->currentLang
] );
1319 $this->currentLang
= null;
1322 public function set( $key, $value ) {
1323 if ( is_null( $this->writer
) ) {
1324 throw new MWException( __CLASS__
. ': must call startWrite() before calling set()' );
1327 $this->writer
->set( $key, serialize( $value ) );
1328 } catch ( CdbException
$e ) {
1329 throw new MWException( $e->getMessage() );
1333 protected function getFileName( $code ) {
1334 if ( strval( $code ) === '' ||
strpos( $code, '/' ) !== false ) {
1335 throw new MWException( __METHOD__
. ": Invalid language \"$code\"" );
1338 return "{$this->directory}/l10n_cache-$code.cdb";
1343 * Null store backend, used to avoid DB errors during install
1345 class LCStoreNull
implements LCStore
{
1346 public function get( $code, $key ) {
1350 public function startWrite( $code ) {
1353 public function finishWrite() {
1356 public function set( $key, $value ) {
1361 * A localisation cache optimised for loading large amounts of data for many
1362 * languages. Used by rebuildLocalisationCache.php.
1364 class LocalisationCacheBulkLoad
extends LocalisationCache
{
1366 * A cache of the contents of data files.
1367 * Core files are serialized to avoid using ~1GB of RAM during a recache.
1369 private $fileCache = array();
1372 * Most recently used languages. Uses the linked-list aspect of PHP hashtables
1373 * to keep the most recently used language codes at the end of the array, and
1374 * the language codes that are ready to be deleted at the beginning.
1376 private $mruLangs = array();
1379 * Maximum number of languages that may be loaded into $this->data
1381 private $maxLoadedLangs = 10;
1386 * @return array|mixed
1388 protected function readPHPFile( $fileName, $fileType ) {
1389 $serialize = $fileType === 'core';
1390 if ( !isset( $this->fileCache
[$fileName][$fileType] ) ) {
1391 $data = parent
::readPHPFile( $fileName, $fileType );
1394 $encData = serialize( $data );
1399 $this->fileCache
[$fileName][$fileType] = $encData;
1402 } elseif ( $serialize ) {
1403 return unserialize( $this->fileCache
[$fileName][$fileType] );
1405 return $this->fileCache
[$fileName][$fileType];
1414 public function getItem( $code, $key ) {
1415 unset( $this->mruLangs
[$code] );
1416 $this->mruLangs
[$code] = true;
1418 return parent
::getItem( $code, $key );
1427 public function getSubitem( $code, $key, $subkey ) {
1428 unset( $this->mruLangs
[$code] );
1429 $this->mruLangs
[$code] = true;
1431 return parent
::getSubitem( $code, $key, $subkey );
1437 public function recache( $code ) {
1438 parent
::recache( $code );
1439 unset( $this->mruLangs
[$code] );
1440 $this->mruLangs
[$code] = true;
1447 public function unload( $code ) {
1448 unset( $this->mruLangs
[$code] );
1449 parent
::unload( $code );
1453 * Unload cached languages until there are less than $this->maxLoadedLangs
1455 protected function trimCache() {
1456 while ( count( $this->data
) > $this->maxLoadedLangs
&& count( $this->mruLangs
) ) {
1457 reset( $this->mruLangs
);
1458 $code = key( $this->mruLangs
);
1459 wfDebug( __METHOD__
. ": unloading $code\n" );
1460 $this->unload( $code );