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 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.
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 ( 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 $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 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 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.
582 public function getCompiledPluralRules( $code ) {
583 $rules = $this->getPluralRules( $code );
584 if ( $rules === null ) {
588 $compiledRules = CLDRPluralRuleEvaluator
::compile( $rules );
589 } catch ( CLDRPluralRuleError
$e ) {
590 wfDebugLog( 'l10n', $e->getMessage() );
595 return $compiledRules;
599 * Get the plural rules for a given language from the XML files.
603 public function getPluralRules( $code ) {
604 if ( $this->pluralRules
=== null ) {
605 $this->loadPluralFiles();
607 if ( !isset( $this->pluralRules
[$code] ) ) {
610 return $this->pluralRules
[$code];
615 * Get the plural rule types for a given language from the XML files.
619 public function getPluralRuleTypes( $code ) {
620 if ( $this->pluralRuleTypes
=== null ) {
621 $this->loadPluralFiles();
623 if ( !isset( $this->pluralRuleTypes
[$code] ) ) {
626 return $this->pluralRuleTypes
[$code];
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 protected function loadPluralFile( $fileName ) {
650 $doc = new DOMDocument
;
651 $doc->load( $fileName );
652 $rulesets = $doc->getElementsByTagName( "pluralRules" );
653 foreach ( $rulesets as $ruleset ) {
654 $codes = $ruleset->getAttribute( 'locales' );
656 $ruleTypes = array();
657 $ruleElements = $ruleset->getElementsByTagName( "pluralRule" );
658 foreach ( $ruleElements as $elt ) {
659 $ruleType = $elt->getAttribute( 'count' );
660 if ( $ruleType === 'other' ) {
661 // Don't record "other" rules, which have an empty condition
664 $rules[] = $elt->nodeValue
;
665 $ruleTypes[] = $ruleType;
667 foreach ( explode( ' ', $codes ) as $code ) {
668 $this->pluralRules
[$code] = $rules;
669 $this->pluralRuleTypes
[$code] = $ruleTypes;
675 * Read the data from the source files for a given language, and register
676 * the relevant dependencies in the $deps array. If the localisation
677 * exists, the data array is returned, otherwise false is returned.
679 protected function readSourceFilesAndRegisterDeps( $code, &$deps ) {
681 wfProfileIn( __METHOD__
);
684 // This reads in the PHP i18n file with non-messages l10n data
685 $fileName = Language
::getMessagesFileName( $code );
686 if ( !file_exists( $fileName ) ) {
689 $deps[] = new FileDependency( $fileName );
690 $data = $this->readPHPFile( $fileName, 'core' );
693 # Load CLDR plural rules for JavaScript
694 $data['pluralRules'] = $this->getPluralRules( $code );
696 $data['compiledPluralRules'] = $this->getCompiledPluralRules( $code );
697 # Load plural rule types
698 $data['pluralRuleTypes'] = $this->getPluralRuleTypes( $code );
700 $deps['plurals'] = new FileDependency( "$IP/languages/data/plurals.xml" );
701 $deps['plurals-mw'] = new FileDependency( "$IP/languages/data/plurals-mediawiki.xml" );
703 wfProfileOut( __METHOD__
);
709 * Merge two localisation values, a primary and a fallback, overwriting the
710 * primary value in place.
713 * @param $fallbackValue
715 protected function mergeItem( $key, &$value, $fallbackValue ) {
716 if ( !is_null( $value ) ) {
717 if ( !is_null( $fallbackValue ) ) {
718 if ( in_array( $key, self
::$mergeableMapKeys ) ) {
719 $value = $value +
$fallbackValue;
720 } elseif ( in_array( $key, self
::$mergeableListKeys ) ) {
721 $value = array_unique( array_merge( $fallbackValue, $value ) );
722 } elseif ( in_array( $key, self
::$mergeableAliasListKeys ) ) {
723 $value = array_merge_recursive( $value, $fallbackValue );
724 } elseif ( in_array( $key, self
::$optionalMergeKeys ) ) {
725 if ( !empty( $value['inherit'] ) ) {
726 $value = array_merge( $fallbackValue, $value );
729 if ( isset( $value['inherit'] ) ) {
730 unset( $value['inherit'] );
732 } elseif ( in_array( $key, self
::$magicWordKeys ) ) {
733 $this->mergeMagicWords( $value, $fallbackValue );
737 $value = $fallbackValue;
743 * @param $fallbackValue
745 protected function mergeMagicWords( &$value, $fallbackValue ) {
746 foreach ( $fallbackValue as $magicName => $fallbackInfo ) {
747 if ( !isset( $value[$magicName] ) ) {
748 $value[$magicName] = $fallbackInfo;
750 $oldSynonyms = array_slice( $fallbackInfo, 1 );
751 $newSynonyms = array_slice( $value[$magicName], 1 );
752 $synonyms = array_values( array_unique( array_merge(
753 $newSynonyms, $oldSynonyms ) ) );
754 $value[$magicName] = array_merge( array( $fallbackInfo[0] ), $synonyms );
760 * Given an array mapping language code to localisation value, such as is
761 * found in extension *.i18n.php files, iterate through a fallback sequence
762 * to merge the given data with an existing primary value.
764 * Returns true if any data from the extension array was used, false
766 * @param $codeSequence
769 * @param $fallbackValue
772 protected function mergeExtensionItem( $codeSequence, $key, &$value, $fallbackValue ) {
774 foreach ( $codeSequence as $code ) {
775 if ( isset( $fallbackValue[$code] ) ) {
776 $this->mergeItem( $key, $value, $fallbackValue[$code] );
785 * Load localisation data for a given language for both core and extensions
786 * and save it to the persistent cache store and the process cache
788 * @throws MWException
790 public function recache( $code ) {
791 global $wgExtensionMessagesFiles, $wgMessagesDirs;
792 wfProfileIn( __METHOD__
);
795 wfProfileOut( __METHOD__
);
796 throw new MWException( "Invalid language code requested" );
798 $this->recachedLangs
[$code] = true;
801 $initialData = array_combine(
803 array_fill( 0, count( self
::$allKeys ), null ) );
804 $coreData = $initialData;
807 # Load the primary localisation from the source file
808 $data = $this->readSourceFilesAndRegisterDeps( $code, $deps );
809 if ( $data === false ) {
810 wfDebug( __METHOD__
. ": no localisation file for $code, using fallback to en\n" );
811 $coreData['fallback'] = 'en';
813 wfDebug( __METHOD__
. ": got localisation for $code from source\n" );
815 # Merge primary localisation
816 foreach ( $data as $key => $value ) {
817 $this->mergeItem( $key, $coreData[$key], $value );
821 # Fill in the fallback if it's not there already
822 if ( is_null( $coreData['fallback'] ) ) {
823 $coreData['fallback'] = $code === 'en' ?
false : 'en';
825 if ( $coreData['fallback'] === false ) {
826 $coreData['fallbackSequence'] = array();
828 $coreData['fallbackSequence'] = array_map( 'trim', explode( ',', $coreData['fallback'] ) );
829 $len = count( $coreData['fallbackSequence'] );
831 # Ensure that the sequence ends at en
832 if ( $coreData['fallbackSequence'][$len - 1] !== 'en' ) {
833 $coreData['fallbackSequence'][] = 'en';
836 # Load the fallback localisation item by item and merge it
837 foreach ( $coreData['fallbackSequence'] as $fbCode ) {
838 # Load the secondary localisation from the source file to
839 # avoid infinite cycles on cyclic fallbacks
840 $fbData = $this->readSourceFilesAndRegisterDeps( $fbCode, $deps );
841 if ( $fbData === false ) {
845 foreach ( self
::$allKeys as $key ) {
846 if ( !isset( $fbData[$key] ) ) {
850 if ( is_null( $coreData[$key] ) ||
$this->isMergeableKey( $key ) ) {
851 $this->mergeItem( $key, $coreData[$key], $fbData[$key] );
857 $codeSequence = array_merge( array( $code ), $coreData['fallbackSequence'] );
859 # Load core messages and the extension localisations.
860 wfProfileIn( __METHOD__
. '-extensions' );
861 $allData = $initialData;
862 foreach ( $wgMessagesDirs as $dirs ) {
863 foreach ( (array)$dirs as $dir ) {
864 foreach ( $codeSequence as $csCode ) {
865 $fileName = "$dir/$csCode.json";
866 $data = $this->readJSONFile( $fileName );
868 foreach ( $data as $key => $item ) {
869 $this->mergeItem( $key, $allData[$key], $item );
872 $deps[] = new FileDependency( $fileName );
877 foreach ( $wgExtensionMessagesFiles as $extension => $fileName ) {
878 if ( isset( $wgMessagesDirs[$extension] ) ) {
879 # Already loaded the JSON files for this extension; skip the PHP shim
883 $data = $this->readPHPFile( $fileName, 'extension' );
886 foreach ( $data as $key => $item ) {
887 if ( $this->mergeExtensionItem( $codeSequence, $key, $allData[$key], $item ) ) {
893 $deps[] = new FileDependency( $fileName );
897 # Merge core data into extension data
898 foreach ( $coreData as $key => $item ) {
899 $this->mergeItem( $key, $allData[$key], $item );
901 wfProfileOut( __METHOD__
. '-extensions' );
903 # Add cache dependencies for any referenced globals
904 $deps['wgExtensionMessagesFiles'] = new GlobalDependency( 'wgExtensionMessagesFiles' );
905 $deps['wgMessagesDirs'] = new GlobalDependency( 'wgMessagesDirs' );
906 $deps['version'] = new ConstantDependency( 'MW_LC_VERSION' );
908 # Add dependencies to the cache entry
909 $allData['deps'] = $deps;
911 # Replace spaces with underscores in namespace names
912 $allData['namespaceNames'] = str_replace( ' ', '_', $allData['namespaceNames'] );
914 # And do the same for special page aliases. $page is an array.
915 foreach ( $allData['specialPageAliases'] as &$page ) {
916 $page = str_replace( ' ', '_', $page );
918 # Decouple the reference to prevent accidental damage
921 # If there were no plural rules, return an empty array
922 if ( $allData['pluralRules'] === null ) {
923 $allData['pluralRules'] = array();
925 if ( $allData['compiledPluralRules'] === null ) {
926 $allData['compiledPluralRules'] = array();
928 # If there were no plural rule types, return an empty array
929 if ( $allData['pluralRuleTypes'] === null ) {
930 $allData['pluralRuleTypes'] = array();
934 $allData['list'] = array();
935 foreach ( self
::$splitKeys as $key ) {
936 $allData['list'][$key] = array_keys( $allData[$key] );
940 wfRunHooks( 'LocalisationCacheRecache', array( $this, $code, &$allData, &$purgeBlobs ) );
942 if ( is_null( $allData['namespaceNames'] ) ) {
943 wfProfileOut( __METHOD__
);
944 throw new MWException( __METHOD__
. ': Localisation data failed sanity check! ' .
945 'Check that your languages/messages/MessagesEn.php file is intact.' );
948 # Set the preload key
949 $allData['preload'] = $this->buildPreload( $allData );
951 # Save to the process cache and register the items loaded
952 $this->data
[$code] = $allData;
953 foreach ( $allData as $key => $item ) {
954 $this->loadedItems
[$code][$key] = true;
957 # Save to the persistent cache
958 wfProfileIn( __METHOD__
. '-write' );
959 $this->store
->startWrite( $code );
960 foreach ( $allData as $key => $value ) {
961 if ( in_array( $key, self
::$splitKeys ) ) {
962 foreach ( $value as $subkey => $subvalue ) {
963 $this->store
->set( "$key:$subkey", $subvalue );
966 $this->store
->set( $key, $value );
969 $this->store
->finishWrite();
970 wfProfileOut( __METHOD__
. '-write' );
972 # Clear out the MessageBlobStore
973 # HACK: If using a null (i.e. disabled) storage backend, we
974 # can't write to the MessageBlobStore either
975 if ( $purgeBlobs && !$this->store
instanceof LCStoreNull
) {
976 MessageBlobStore
::clear();
979 wfProfileOut( __METHOD__
);
983 * Build the preload item from the given pre-cache data.
985 * The preload item will be loaded automatically, improving performance
986 * for the commonly-requested items it contains.
990 protected function buildPreload( $data ) {
991 $preload = array( 'messages' => array() );
992 foreach ( self
::$preloadedKeys as $key ) {
993 $preload[$key] = $data[$key];
996 foreach ( $data['preloadedMessages'] as $subkey ) {
997 if ( isset( $data['messages'][$subkey] ) ) {
998 $subitem = $data['messages'][$subkey];
1002 $preload['messages'][$subkey] = $subitem;
1009 * Unload the data for a given language from the object cache.
1010 * Reduces memory usage.
1013 public function unload( $code ) {
1014 unset( $this->data
[$code] );
1015 unset( $this->loadedItems
[$code] );
1016 unset( $this->loadedSubitems
[$code] );
1017 unset( $this->initialisedLangs
[$code] );
1018 unset( $this->shallowFallbacks
[$code] );
1020 foreach ( $this->shallowFallbacks
as $shallowCode => $fbCode ) {
1021 if ( $fbCode === $code ) {
1022 $this->unload( $shallowCode );
1030 public function unloadAll() {
1031 foreach ( $this->initialisedLangs
as $lang => $unused ) {
1032 $this->unload( $lang );
1037 * Disable the storage backend
1039 public function disableBackend() {
1040 $this->store
= new LCStoreNull
;
1041 $this->manualRecache
= false;
1046 * Interface for the persistence layer of LocalisationCache.
1048 * The persistence layer is two-level hierarchical cache. The first level
1049 * is the language, the second level is the item or subitem.
1051 * Since the data for a whole language is rebuilt in one operation, it needs
1052 * to have a fast and atomic method for deleting or replacing all of the
1053 * current data for a given language. The interface reflects this bulk update
1054 * operation. Callers writing to the cache must first call startWrite(), then
1055 * will call set() a couple of thousand times, then will call finishWrite()
1056 * to commit the operation. When finishWrite() is called, the cache is
1057 * expected to delete all data previously stored for that language.
1059 * The values stored are PHP variables suitable for serialize(). Implementations
1060 * of LCStore are responsible for serializing and unserializing.
1065 * @param string $code Language code
1066 * @param string $key Cache key
1068 function get( $code, $key );
1071 * Start a write transaction.
1072 * @param string $code Language code
1074 function startWrite( $code );
1077 * Finish a write transaction.
1079 function finishWrite();
1082 * Set a key to a given value. startWrite() must be called before this
1083 * is called, and finishWrite() must be called afterwards.
1084 * @param string $key
1085 * @param mixed $value
1087 function set( $key, $value );
1091 * LCStore implementation which uses PHP accelerator to store data.
1092 * This will work if one of XCache, WinCache or APC cacher is configured.
1093 * (See ObjectCache.php)
1095 class LCStoreAccel
implements LCStore
{
1096 private $currentLang;
1099 public function __construct() {
1100 $this->cache
= wfGetCache( CACHE_ACCEL
);
1103 public function get( $code, $key ) {
1104 $k = wfMemcKey( 'l10n', $code, 'k', $key );
1105 $r = $this->cache
->get( $k );
1107 return $r === false ?
null : $r;
1110 public function startWrite( $code ) {
1111 $k = wfMemcKey( 'l10n', $code, 'l' );
1112 $keys = $this->cache
->get( $k );
1114 foreach ( $keys as $k ) {
1115 $this->cache
->delete( $k );
1118 $this->currentLang
= $code;
1119 $this->keys
= array();
1122 public function finishWrite() {
1123 if ( $this->currentLang
) {
1124 $k = wfMemcKey( 'l10n', $this->currentLang
, 'l' );
1125 $this->cache
->set( $k, array_keys( $this->keys
) );
1127 $this->currentLang
= null;
1128 $this->keys
= array();
1131 public function set( $key, $value ) {
1132 if ( $this->currentLang
) {
1133 $k = wfMemcKey( 'l10n', $this->currentLang
, 'k', $key );
1134 $this->keys
[$k] = true;
1135 $this->cache
->set( $k, $value );
1141 * LCStore implementation which uses the standard DB functions to store data.
1142 * This will work on any MediaWiki installation.
1144 class LCStoreDB
implements LCStore
{
1145 private $currentLang;
1146 private $writesDone = false;
1153 private $readOnly = false;
1155 public function get( $code, $key ) {
1156 if ( $this->writesDone
) {
1157 $db = wfGetDB( DB_MASTER
);
1159 $db = wfGetDB( DB_SLAVE
);
1161 $row = $db->selectRow( 'l10n_cache', array( 'lc_value' ),
1162 array( 'lc_lang' => $code, 'lc_key' => $key ), __METHOD__
);
1164 return unserialize( $row->lc_value
);
1170 public function startWrite( $code ) {
1171 if ( $this->readOnly
) {
1176 throw new MWException( __METHOD__
. ": Invalid language \"$code\"" );
1179 $this->dbw
= wfGetDB( DB_MASTER
);
1181 $this->dbw
->begin( __METHOD__
);
1182 $this->dbw
->delete( 'l10n_cache', array( 'lc_lang' => $code ), __METHOD__
);
1183 } catch ( DBQueryError
$e ) {
1184 if ( $this->dbw
->wasReadOnlyError() ) {
1185 $this->readOnly
= true;
1186 $this->dbw
->rollback( __METHOD__
);
1194 $this->currentLang
= $code;
1195 $this->batch
= array();
1198 public function finishWrite() {
1199 if ( $this->readOnly
) {
1203 if ( $this->batch
) {
1204 $this->dbw
->insert( 'l10n_cache', $this->batch
, __METHOD__
);
1207 $this->dbw
->commit( __METHOD__
);
1208 $this->currentLang
= null;
1210 $this->batch
= array();
1211 $this->writesDone
= true;
1214 public function set( $key, $value ) {
1215 if ( $this->readOnly
) {
1219 if ( is_null( $this->currentLang
) ) {
1220 throw new MWException( __CLASS__
. ': must call startWrite() before calling set()' );
1223 $this->batch
[] = array(
1224 'lc_lang' => $this->currentLang
,
1226 'lc_value' => serialize( $value ) );
1228 if ( count( $this->batch
) >= 100 ) {
1229 $this->dbw
->insert( 'l10n_cache', $this->batch
, __METHOD__
);
1230 $this->batch
= array();
1236 * LCStore implementation which stores data as a collection of CDB files in the
1237 * directory given by $wgCacheDirectory. If $wgCacheDirectory is not set, this
1238 * will throw an exception.
1240 * Profiling indicates that on Linux, this implementation outperforms MySQL if
1241 * the directory is on a local filesystem and there is ample kernel cache
1242 * space. The performance advantage is greater when the DBA extension is
1243 * available than it is with the PHP port.
1245 * See Cdb.php and http://cr.yp.to/cdb.html
1247 class LCStoreCDB
implements LCStore
{
1248 /** @var CdbReader[] */
1251 /** @var CdbWriter */
1254 /** @var string Current language code */
1255 private $currentLang;
1257 /** @var bool|string Cache directory. False if not set */
1260 function __construct( $conf = array() ) {
1261 global $wgCacheDirectory;
1263 if ( isset( $conf['directory'] ) ) {
1264 $this->directory
= $conf['directory'];
1266 $this->directory
= $wgCacheDirectory;
1270 public function get( $code, $key ) {
1271 if ( !isset( $this->readers
[$code] ) ) {
1272 $fileName = $this->getFileName( $code );
1274 $this->readers
[$code] = false;
1275 if ( file_exists( $fileName ) ) {
1277 $this->readers
[$code] = CdbReader
::open( $fileName );
1278 } catch ( CdbException
$e ) {
1279 wfDebug( __METHOD__
. ": unable to open cdb file for reading\n" );
1284 if ( !$this->readers
[$code] ) {
1289 $value = $this->readers
[$code]->get( $key );
1290 } catch ( CdbException
$e ) {
1291 wfDebug( __METHOD__
. ": CdbException caught, error message was "
1292 . $e->getMessage() . "\n" );
1294 if ( $value === false ) {
1298 return unserialize( $value );
1302 public function startWrite( $code ) {
1303 if ( !file_exists( $this->directory
) ) {
1304 if ( !wfMkdirParents( $this->directory
, null, __METHOD__
) ) {
1305 throw new MWException( "Unable to create the localisation store " .
1306 "directory \"{$this->directory}\"" );
1310 // Close reader to stop permission errors on write
1311 if ( !empty( $this->readers
[$code] ) ) {
1312 $this->readers
[$code]->close();
1316 $this->writer
= CdbWriter
::open( $this->getFileName( $code ) );
1317 } catch ( CdbException
$e ) {
1318 throw new MWException( $e->getMessage() );
1320 $this->currentLang
= $code;
1323 public function finishWrite() {
1326 $this->writer
->close();
1327 } catch ( CdbException
$e ) {
1328 throw new MWException( $e->getMessage() );
1330 $this->writer
= null;
1331 unset( $this->readers
[$this->currentLang
] );
1332 $this->currentLang
= null;
1335 public function set( $key, $value ) {
1336 if ( is_null( $this->writer
) ) {
1337 throw new MWException( __CLASS__
. ': must call startWrite() before calling set()' );
1340 $this->writer
->set( $key, serialize( $value ) );
1341 } catch ( CdbException
$e ) {
1342 throw new MWException( $e->getMessage() );
1346 protected function getFileName( $code ) {
1347 if ( strval( $code ) === '' ||
strpos( $code, '/' ) !== false ) {
1348 throw new MWException( __METHOD__
. ": Invalid language \"$code\"" );
1351 return "{$this->directory}/l10n_cache-$code.cdb";
1356 * Null store backend, used to avoid DB errors during install
1358 class LCStoreNull
implements LCStore
{
1359 public function get( $code, $key ) {
1363 public function startWrite( $code ) {
1366 public function finishWrite() {
1369 public function set( $key, $value ) {
1374 * A localisation cache optimised for loading large amounts of data for many
1375 * languages. Used by rebuildLocalisationCache.php.
1377 class LocalisationCacheBulkLoad
extends LocalisationCache
{
1379 * A cache of the contents of data files.
1380 * Core files are serialized to avoid using ~1GB of RAM during a recache.
1382 private $fileCache = array();
1385 * Most recently used languages. Uses the linked-list aspect of PHP hashtables
1386 * to keep the most recently used language codes at the end of the array, and
1387 * the language codes that are ready to be deleted at the beginning.
1389 private $mruLangs = array();
1392 * Maximum number of languages that may be loaded into $this->data
1394 private $maxLoadedLangs = 10;
1399 * @return array|mixed
1401 protected function readPHPFile( $fileName, $fileType ) {
1402 $serialize = $fileType === 'core';
1403 if ( !isset( $this->fileCache
[$fileName][$fileType] ) ) {
1404 $data = parent
::readPHPFile( $fileName, $fileType );
1407 $encData = serialize( $data );
1412 $this->fileCache
[$fileName][$fileType] = $encData;
1415 } elseif ( $serialize ) {
1416 return unserialize( $this->fileCache
[$fileName][$fileType] );
1418 return $this->fileCache
[$fileName][$fileType];
1427 public function getItem( $code, $key ) {
1428 unset( $this->mruLangs
[$code] );
1429 $this->mruLangs
[$code] = true;
1431 return parent
::getItem( $code, $key );
1440 public function getSubitem( $code, $key, $subkey ) {
1441 unset( $this->mruLangs
[$code] );
1442 $this->mruLangs
[$code] = true;
1444 return parent
::getSubitem( $code, $key, $subkey );
1450 public function recache( $code ) {
1451 parent
::recache( $code );
1452 unset( $this->mruLangs
[$code] );
1453 $this->mruLangs
[$code] = true;
1460 public function unload( $code ) {
1461 unset( $this->mruLangs
[$code] );
1462 parent
::unload( $code );
1466 * Unload cached languages until there are less than $this->maxLoadedLangs
1468 protected function trimCache() {
1469 while ( count( $this->data
) > $this->maxLoadedLangs
&& count( $this->mruLangs
) ) {
1470 reset( $this->mruLangs
);
1471 $code = key( $this->mruLangs
);
1472 wfDebug( __METHOD__
. ": unloading $code\n" );
1473 $this->unload( $code );