3 * Cache of the contents of localisation files.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 use Cdb\Exception
as CdbException
;
24 use Cdb\Reader
as CdbReader
;
25 use Cdb\Writer
as CdbWriter
;
28 * Class for caching the contents of localisation files, Messages*.php
31 * An instance of this class is available using Language::getLocalisationCache().
33 * The values retrieved from here are merged, containing items from extension
34 * files, core messages files and the language fallback sequence (e.g. zh-cn ->
35 * zh-hans -> en ). Some common errors are corrected, for example namespace
36 * names with spaces instead of underscores, but heavyweight processing, such
37 * as grammatical transformation, is done by the caller.
39 class LocalisationCache
{
42 /** Configuration associative array */
46 * True if recaching should only be done on an explicit call to recache().
47 * Setting this reduces the overhead of cache freshness checking, which
48 * requires doing a stat() for every extension i18n file.
50 private $manualRecache = false;
53 * True to treat all files as expired until they are regenerated by this object.
55 private $forceRecache = false;
58 * The cache data. 3-d array, where the first key is the language code,
59 * the second key is the item key e.g. 'messages', and the third key is
60 * an item specific subkey index. Some items are not arrays and so for those
61 * items, there are no subkeys.
63 protected $data = array();
66 * The persistent store object. An instance of LCStore.
73 * A 2-d associative array, code/key, where presence indicates that the item
74 * is loaded. Value arbitrary.
76 * For split items, if set, this indicates that all of the subitems have been
79 private $loadedItems = array();
82 * A 3-d associative array, code/key/subkey, where presence indicates that
83 * the subitem is loaded. Only used for the split items, i.e. messages.
85 private $loadedSubitems = array();
88 * An array where presence of a key indicates that that language has been
89 * initialised. Initialisation includes checking for cache expiry and doing
90 * any necessary updates.
92 private $initialisedLangs = array();
95 * An array mapping non-existent pseudo-languages to fallback languages. This
96 * is filled by initShallowFallback() when data is requested from a language
97 * that lacks a Messages*.php file.
99 private $shallowFallbacks = array();
102 * An array where the keys are codes that have been recached by this instance.
104 private $recachedLangs = array();
109 static public $allKeys = array(
110 'fallback', 'namespaceNames', 'bookstoreList',
111 'magicWords', 'messages', 'rtl', 'capitalizeAllNouns', 'digitTransformTable',
112 'separatorTransformTable', 'fallback8bitEncoding', 'linkPrefixExtension',
113 'linkTrail', 'linkPrefixCharset', 'namespaceAliases',
114 'dateFormats', 'datePreferences', 'datePreferenceMigrationMap',
115 'defaultDateFormat', 'extraUserToggles', 'specialPageAliases',
116 'imageFiles', 'preloadedMessages', 'namespaceGenderAliases',
117 'digitGroupingPattern', 'pluralRules', 'pluralRuleTypes', 'compiledPluralRules',
121 * Keys for items which consist of associative arrays, which may be merged
122 * by a fallback sequence.
124 static public $mergeableMapKeys = array( 'messages', 'namespaceNames',
125 'dateFormats', 'imageFiles', 'preloadedMessages'
129 * Keys for items which are a numbered array.
131 static public $mergeableListKeys = array( 'extraUserToggles' );
134 * Keys for items which contain an array of arrays of equivalent aliases
135 * for each subitem. The aliases may be merged by a fallback sequence.
137 static public $mergeableAliasListKeys = array( 'specialPageAliases' );
140 * Keys for items which contain an associative array, and may be merged if
141 * the primary value contains the special array key "inherit". That array
142 * key is removed after the first merge.
144 static public $optionalMergeKeys = array( 'bookstoreList' );
147 * Keys for items that are formatted like $magicWords
149 static public $magicWordKeys = array( 'magicWords' );
152 * Keys for items where the subitems are stored in the backend separately.
154 static public $splitKeys = array( 'messages' );
157 * Keys which are loaded automatically by initLanguage()
159 static public $preloadedKeys = array( 'dateFormats', 'namespaceNames' );
162 * Associative array of cached plural rules. The key is the language code,
163 * the value is an array of plural rules for that language.
165 private $pluralRules = null;
168 * Associative array of cached plural rule types. The key is the language
169 * code, the value is an array of plural rule types for that language. For
170 * example, $pluralRuleTypes['ar'] = ['zero', 'one', 'two', 'few', 'many'].
171 * The index for each rule type matches the index for the rule in
172 * $pluralRules, thus allowing correlation between the two. The reason we
173 * don't just use the type names as the keys in $pluralRules is because
174 * Language::convertPlural applies the rules based on numeric order (or
175 * explicit numeric parameter), not based on the name of the rule type. For
176 * example, {{plural:count|wordform1|wordform2|wordform3}}, rather than
177 * {{plural:count|one=wordform1|two=wordform2|many=wordform3}}.
179 private $pluralRuleTypes = null;
181 private $mergeableKeys = null;
185 * For constructor parameters, see the documentation in DefaultSettings.php
186 * for $wgLocalisationCacheConf.
189 * @throws MWException
191 function __construct( $conf ) {
192 global $wgCacheDirectory;
195 $storeConf = array();
196 if ( !empty( $conf['storeClass'] ) ) {
197 $storeClass = $conf['storeClass'];
199 switch ( $conf['store'] ) {
202 $storeClass = 'LCStoreCDB';
205 $storeClass = 'LCStoreDB';
208 $storeClass = $wgCacheDirectory ?
'LCStoreCDB' : 'LCStoreDB';
211 throw new MWException(
212 'Please set $wgLocalisationCacheConf[\'store\'] to something sensible.' );
216 wfDebugLog( 'caches', get_class( $this ) . ": using store $storeClass" );
217 if ( !empty( $conf['storeDirectory'] ) ) {
218 $storeConf['directory'] = $conf['storeDirectory'];
221 $this->store
= new $storeClass( $storeConf );
222 foreach ( array( 'manualRecache', 'forceRecache' ) as $var ) {
223 if ( isset( $conf[$var] ) ) {
224 $this->$var = $conf[$var];
230 * Returns true if the given key is mergeable, that is, if it is an associative
231 * array which can be merged through a fallback sequence.
235 public function isMergeableKey( $key ) {
236 if ( $this->mergeableKeys
=== null ) {
237 $this->mergeableKeys
= array_flip( array_merge(
238 self
::$mergeableMapKeys,
239 self
::$mergeableListKeys,
240 self
::$mergeableAliasListKeys,
241 self
::$optionalMergeKeys,
246 return isset( $this->mergeableKeys
[$key] );
252 * Warning: this may be slow for split items (messages), since it will
253 * need to fetch all of the subitems from the cache individually.
254 * @param string $code
258 public function getItem( $code, $key ) {
259 if ( !isset( $this->loadedItems
[$code][$key] ) ) {
260 wfProfileIn( __METHOD__
. '-load' );
261 $this->loadItem( $code, $key );
262 wfProfileOut( __METHOD__
. '-load' );
265 if ( $key === 'fallback' && isset( $this->shallowFallbacks
[$code] ) ) {
266 return $this->shallowFallbacks
[$code];
269 return $this->data
[$code][$key];
273 * Get a subitem, for instance a single message for a given language.
274 * @param string $code
276 * @param string $subkey
279 public function getSubitem( $code, $key, $subkey ) {
280 if ( !isset( $this->loadedSubitems
[$code][$key][$subkey] ) &&
281 !isset( $this->loadedItems
[$code][$key] )
283 wfProfileIn( __METHOD__
. '-load' );
284 $this->loadSubitem( $code, $key, $subkey );
285 wfProfileOut( __METHOD__
. '-load' );
288 if ( isset( $this->data
[$code][$key][$subkey] ) ) {
289 return $this->data
[$code][$key][$subkey];
296 * Get the list of subitem keys for a given item.
298 * This is faster than array_keys($lc->getItem(...)) for the items listed in
301 * Will return null if the item is not found, or false if the item is not an
303 * @param string $code
305 * @return bool|null|string
307 public function getSubitemList( $code, $key ) {
308 if ( in_array( $key, self
::$splitKeys ) ) {
309 return $this->getSubitem( $code, 'list', $key );
311 $item = $this->getItem( $code, $key );
312 if ( is_array( $item ) ) {
313 return array_keys( $item );
321 * Load an item into the cache.
322 * @param string $code
325 protected function loadItem( $code, $key ) {
326 if ( !isset( $this->initialisedLangs
[$code] ) ) {
327 $this->initLanguage( $code );
330 // Check to see if initLanguage() loaded it for us
331 if ( isset( $this->loadedItems
[$code][$key] ) ) {
335 if ( isset( $this->shallowFallbacks
[$code] ) ) {
336 $this->loadItem( $this->shallowFallbacks
[$code], $key );
341 if ( in_array( $key, self
::$splitKeys ) ) {
342 $subkeyList = $this->getSubitem( $code, 'list', $key );
343 foreach ( $subkeyList as $subkey ) {
344 if ( isset( $this->data
[$code][$key][$subkey] ) ) {
347 $this->data
[$code][$key][$subkey] = $this->getSubitem( $code, $key, $subkey );
350 $this->data
[$code][$key] = $this->store
->get( $code, $key );
353 $this->loadedItems
[$code][$key] = true;
357 * Load a subitem into the cache
358 * @param string $code
360 * @param string $subkey
362 protected function loadSubitem( $code, $key, $subkey ) {
363 if ( !in_array( $key, self
::$splitKeys ) ) {
364 $this->loadItem( $code, $key );
369 if ( !isset( $this->initialisedLangs
[$code] ) ) {
370 $this->initLanguage( $code );
373 // Check to see if initLanguage() loaded it for us
374 if ( isset( $this->loadedItems
[$code][$key] ) ||
375 isset( $this->loadedSubitems
[$code][$key][$subkey] )
380 if ( isset( $this->shallowFallbacks
[$code] ) ) {
381 $this->loadSubitem( $this->shallowFallbacks
[$code], $key, $subkey );
386 $value = $this->store
->get( $code, "$key:$subkey" );
387 $this->data
[$code][$key][$subkey] = $value;
388 $this->loadedSubitems
[$code][$key][$subkey] = true;
392 * Returns true if the cache identified by $code is missing or expired.
394 * @param string $code
398 public function isExpired( $code ) {
399 if ( $this->forceRecache
&& !isset( $this->recachedLangs
[$code] ) ) {
400 wfDebug( __METHOD__
. "($code): forced reload\n" );
405 $deps = $this->store
->get( $code, 'deps' );
406 $keys = $this->store
->get( $code, 'list' );
407 $preload = $this->store
->get( $code, 'preload' );
408 // Different keys may expire separately for some stores
409 if ( $deps === null ||
$keys === null ||
$preload === null ) {
410 wfDebug( __METHOD__
. "($code): cache missing, need to make one\n" );
415 foreach ( $deps as $dep ) {
416 // Because we're unserializing stuff from cache, we
417 // could receive objects of classes that don't exist
418 // anymore (e.g. uninstalled extensions)
419 // When this happens, always expire the cache
420 if ( !$dep instanceof CacheDependency ||
$dep->isExpired() ) {
421 wfDebug( __METHOD__
. "($code): cache for $code expired due to " .
422 get_class( $dep ) . "\n" );
432 * Initialise a language in this object. Rebuild the cache if necessary.
433 * @param string $code
434 * @throws MWException
436 protected function initLanguage( $code ) {
437 if ( isset( $this->initialisedLangs
[$code] ) ) {
441 $this->initialisedLangs
[$code] = true;
443 # If the code is of the wrong form for a Messages*.php file, do a shallow fallback
444 if ( !Language
::isValidBuiltInCode( $code ) ) {
445 $this->initShallowFallback( $code, 'en' );
450 # Recache the data if necessary
451 if ( !$this->manualRecache
&& $this->isExpired( $code ) ) {
452 if ( Language
::isSupportedLanguage( $code ) ) {
453 $this->recache( $code );
454 } elseif ( $code === 'en' ) {
455 throw new MWException( 'MessagesEn.php is missing.' );
457 $this->initShallowFallback( $code, 'en' );
464 $preload = $this->getItem( $code, 'preload' );
465 if ( $preload === null ) {
466 if ( $this->manualRecache
) {
467 // No Messages*.php file. Do shallow fallback to en.
468 if ( $code === 'en' ) {
469 throw new MWException( 'No localisation cache found for English. ' .
470 'Please run maintenance/rebuildLocalisationCache.php.' );
472 $this->initShallowFallback( $code, 'en' );
476 throw new MWException( 'Invalid or missing localisation cache.' );
479 $this->data
[$code] = $preload;
480 foreach ( $preload as $key => $item ) {
481 if ( in_array( $key, self
::$splitKeys ) ) {
482 foreach ( $item as $subkey => $subitem ) {
483 $this->loadedSubitems
[$code][$key][$subkey] = true;
486 $this->loadedItems
[$code][$key] = true;
492 * Create a fallback from one language to another, without creating a
493 * complete persistent cache.
494 * @param string $primaryCode
495 * @param string $fallbackCode
497 public function initShallowFallback( $primaryCode, $fallbackCode ) {
498 $this->data
[$primaryCode] =& $this->data
[$fallbackCode];
499 $this->loadedItems
[$primaryCode] =& $this->loadedItems
[$fallbackCode];
500 $this->loadedSubitems
[$primaryCode] =& $this->loadedSubitems
[$fallbackCode];
501 $this->shallowFallbacks
[$primaryCode] = $fallbackCode;
505 * Read a PHP file containing localisation data.
506 * @param string $_fileName
507 * @param string $_fileType
508 * @throws MWException
511 protected function readPHPFile( $_fileName, $_fileType ) {
512 wfProfileIn( __METHOD__
);
513 // Disable APC caching
514 wfSuppressWarnings();
515 $_apcEnabled = ini_set( 'apc.cache_by_default', '0' );
520 wfSuppressWarnings();
521 ini_set( 'apc.cache_by_default', $_apcEnabled );
524 if ( $_fileType == 'core' ||
$_fileType == 'extension' ) {
525 $data = compact( self
::$allKeys );
526 } elseif ( $_fileType == 'aliases' ) {
527 $data = compact( 'aliases' );
529 wfProfileOut( __METHOD__
);
530 throw new MWException( __METHOD__
. ": Invalid file type: $_fileType" );
532 wfProfileOut( __METHOD__
);
538 * Read a JSON file containing localisation messages.
539 * @param string $fileName Name of file to read
540 * @throws MWException If there is a syntax error in the JSON file
541 * @return array Array with a 'messages' key, or empty array if the file doesn't exist
543 public function readJSONFile( $fileName ) {
544 wfProfileIn( __METHOD__
);
546 if ( !is_readable( $fileName ) ) {
547 wfProfileOut( __METHOD__
);
552 $json = file_get_contents( $fileName );
553 if ( $json === false ) {
554 wfProfileOut( __METHOD__
);
559 $data = FormatJson
::decode( $json, true );
560 if ( $data === null ) {
561 wfProfileOut( __METHOD__
);
563 throw new MWException( __METHOD__
. ": Invalid JSON file: $fileName" );
566 // Remove keys starting with '@', they're reserved for metadata and non-message data
567 foreach ( $data as $key => $unused ) {
568 if ( $key === '' ||
$key[0] === '@' ) {
569 unset( $data[$key] );
573 wfProfileOut( __METHOD__
);
575 // The JSON format only supports messages, none of the other variables, so wrap the data
576 return array( 'messages' => $data );
580 * Get the compiled plural rules for a given language from the XML files.
582 * @param string $code
585 public function getCompiledPluralRules( $code ) {
586 $rules = $this->getPluralRules( $code );
587 if ( $rules === null ) {
591 $compiledRules = CLDRPluralRuleEvaluator
::compile( $rules );
592 } catch ( CLDRPluralRuleError
$e ) {
593 wfDebugLog( 'l10n', $e->getMessage() );
598 return $compiledRules;
602 * Get the plural rules for a given language from the XML files.
605 * @param string $code
608 public function getPluralRules( $code ) {
609 if ( $this->pluralRules
=== null ) {
610 $this->loadPluralFiles();
612 if ( !isset( $this->pluralRules
[$code] ) ) {
615 return $this->pluralRules
[$code];
620 * Get the plural rule types for a given language from the XML files.
623 * @param string $code
626 public function getPluralRuleTypes( $code ) {
627 if ( $this->pluralRuleTypes
=== null ) {
628 $this->loadPluralFiles();
630 if ( !isset( $this->pluralRuleTypes
[$code] ) ) {
633 return $this->pluralRuleTypes
[$code];
638 * Load the plural XML files.
640 protected function loadPluralFiles() {
642 $cldrPlural = "$IP/languages/data/plurals.xml";
643 $mwPlural = "$IP/languages/data/plurals-mediawiki.xml";
644 // Load CLDR plural rules
645 $this->loadPluralFile( $cldrPlural );
646 if ( file_exists( $mwPlural ) ) {
647 // Override or extend
648 $this->loadPluralFile( $mwPlural );
653 * Load a plural XML file with the given filename, compile the relevant
654 * rules, and save the compiled rules in a process-local cache.
656 * @param string $fileName
658 protected function loadPluralFile( $fileName ) {
659 $doc = new DOMDocument
;
660 $doc->load( $fileName );
661 $rulesets = $doc->getElementsByTagName( "pluralRules" );
662 foreach ( $rulesets as $ruleset ) {
663 $codes = $ruleset->getAttribute( 'locales' );
665 $ruleTypes = array();
666 $ruleElements = $ruleset->getElementsByTagName( "pluralRule" );
667 foreach ( $ruleElements as $elt ) {
668 $ruleType = $elt->getAttribute( 'count' );
669 if ( $ruleType === 'other' ) {
670 // Don't record "other" rules, which have an empty condition
673 $rules[] = $elt->nodeValue
;
674 $ruleTypes[] = $ruleType;
676 foreach ( explode( ' ', $codes ) as $code ) {
677 $this->pluralRules
[$code] = $rules;
678 $this->pluralRuleTypes
[$code] = $ruleTypes;
684 * Read the data from the source files for a given language, and register
685 * the relevant dependencies in the $deps array. If the localisation
686 * exists, the data array is returned, otherwise false is returned.
688 * @param string $code
692 protected function readSourceFilesAndRegisterDeps( $code, &$deps ) {
694 wfProfileIn( __METHOD__
);
696 // This reads in the PHP i18n file with non-messages l10n data
697 $fileName = Language
::getMessagesFileName( $code );
698 if ( !file_exists( $fileName ) ) {
701 $deps[] = new FileDependency( $fileName );
702 $data = $this->readPHPFile( $fileName, 'core' );
705 # Load CLDR plural rules for JavaScript
706 $data['pluralRules'] = $this->getPluralRules( $code );
708 $data['compiledPluralRules'] = $this->getCompiledPluralRules( $code );
709 # Load plural rule types
710 $data['pluralRuleTypes'] = $this->getPluralRuleTypes( $code );
712 $deps['plurals'] = new FileDependency( "$IP/languages/data/plurals.xml" );
713 $deps['plurals-mw'] = new FileDependency( "$IP/languages/data/plurals-mediawiki.xml" );
715 wfProfileOut( __METHOD__
);
721 * Merge two localisation values, a primary and a fallback, overwriting the
722 * primary value in place.
724 * @param mixed $value
725 * @param mixed $fallbackValue
727 protected function mergeItem( $key, &$value, $fallbackValue ) {
728 if ( !is_null( $value ) ) {
729 if ( !is_null( $fallbackValue ) ) {
730 if ( in_array( $key, self
::$mergeableMapKeys ) ) {
731 $value = $value +
$fallbackValue;
732 } elseif ( in_array( $key, self
::$mergeableListKeys ) ) {
733 $value = array_unique( array_merge( $fallbackValue, $value ) );
734 } elseif ( in_array( $key, self
::$mergeableAliasListKeys ) ) {
735 $value = array_merge_recursive( $value, $fallbackValue );
736 } elseif ( in_array( $key, self
::$optionalMergeKeys ) ) {
737 if ( !empty( $value['inherit'] ) ) {
738 $value = array_merge( $fallbackValue, $value );
741 if ( isset( $value['inherit'] ) ) {
742 unset( $value['inherit'] );
744 } elseif ( in_array( $key, self
::$magicWordKeys ) ) {
745 $this->mergeMagicWords( $value, $fallbackValue );
749 $value = $fallbackValue;
754 * @param mixed $value
755 * @param mixed $fallbackValue
757 protected function mergeMagicWords( &$value, $fallbackValue ) {
758 foreach ( $fallbackValue as $magicName => $fallbackInfo ) {
759 if ( !isset( $value[$magicName] ) ) {
760 $value[$magicName] = $fallbackInfo;
762 $oldSynonyms = array_slice( $fallbackInfo, 1 );
763 $newSynonyms = array_slice( $value[$magicName], 1 );
764 $synonyms = array_values( array_unique( array_merge(
765 $newSynonyms, $oldSynonyms ) ) );
766 $value[$magicName] = array_merge( array( $fallbackInfo[0] ), $synonyms );
772 * Given an array mapping language code to localisation value, such as is
773 * found in extension *.i18n.php files, iterate through a fallback sequence
774 * to merge the given data with an existing primary value.
776 * Returns true if any data from the extension array was used, false
778 * @param array $codeSequence
780 * @param mixed $value
781 * @param mixed $fallbackValue
784 protected function mergeExtensionItem( $codeSequence, $key, &$value, $fallbackValue ) {
786 foreach ( $codeSequence as $code ) {
787 if ( isset( $fallbackValue[$code] ) ) {
788 $this->mergeItem( $key, $value, $fallbackValue[$code] );
797 * Gets the combined list of messages dirs from
798 * core and extensions
803 public function getMessagesDirs() {
804 global $wgMessagesDirs, $IP;
806 'core' => "$IP/languages/i18n",
807 'api' => "$IP/includes/api/i18n",
808 'oojs-ui' => "$IP/resources/lib/oojs-ui/i18n",
813 * Load localisation data for a given language for both core and extensions
814 * and save it to the persistent cache store and the process cache
815 * @param string $code
816 * @throws MWException
818 public function recache( $code ) {
819 global $wgExtensionMessagesFiles;
820 wfProfileIn( __METHOD__
);
823 wfProfileOut( __METHOD__
);
824 throw new MWException( "Invalid language code requested" );
826 $this->recachedLangs
[$code] = true;
829 $initialData = array_combine(
831 array_fill( 0, count( self
::$allKeys ), null ) );
832 $coreData = $initialData;
835 # Load the primary localisation from the source file
836 $data = $this->readSourceFilesAndRegisterDeps( $code, $deps );
837 if ( $data === false ) {
838 wfDebug( __METHOD__
. ": no localisation file for $code, using fallback to en\n" );
839 $coreData['fallback'] = 'en';
841 wfDebug( __METHOD__
. ": got localisation for $code from source\n" );
843 # Merge primary localisation
844 foreach ( $data as $key => $value ) {
845 $this->mergeItem( $key, $coreData[$key], $value );
849 # Fill in the fallback if it's not there already
850 if ( is_null( $coreData['fallback'] ) ) {
851 $coreData['fallback'] = $code === 'en' ?
false : 'en';
853 if ( $coreData['fallback'] === false ) {
854 $coreData['fallbackSequence'] = array();
856 $coreData['fallbackSequence'] = array_map( 'trim', explode( ',', $coreData['fallback'] ) );
857 $len = count( $coreData['fallbackSequence'] );
859 # Ensure that the sequence ends at en
860 if ( $coreData['fallbackSequence'][$len - 1] !== 'en' ) {
861 $coreData['fallbackSequence'][] = 'en';
865 $codeSequence = array_merge( array( $code ), $coreData['fallbackSequence'] );
866 $messageDirs = $this->getMessagesDirs();
868 wfProfileIn( __METHOD__
. '-fallbacks' );
870 # Load non-JSON localisation data for extensions
871 $extensionData = array_combine(
873 array_fill( 0, count( $codeSequence ), $initialData ) );
874 foreach ( $wgExtensionMessagesFiles as $extension => $fileName ) {
875 if ( isset( $messageDirs[$extension] ) ) {
876 # This extension has JSON message data; skip the PHP shim
880 $data = $this->readPHPFile( $fileName, 'extension' );
883 foreach ( $data as $key => $item ) {
884 foreach ( $codeSequence as $csCode ) {
885 if ( isset( $item[$csCode] ) ) {
886 $this->mergeItem( $key, $extensionData[$csCode][$key], $item[$csCode] );
893 $deps[] = new FileDependency( $fileName );
897 # Load the localisation data for each fallback, then merge it into the full array
898 $allData = $initialData;
899 foreach ( $codeSequence as $csCode ) {
900 $csData = $initialData;
902 # Load core messages and the extension localisations.
903 foreach ( $messageDirs as $dirs ) {
904 foreach ( (array)$dirs as $dir ) {
905 $fileName = "$dir/$csCode.json";
906 $data = $this->readJSONFile( $fileName );
908 foreach ( $data as $key => $item ) {
909 $this->mergeItem( $key, $csData[$key], $item );
912 $deps[] = new FileDependency( $fileName );
916 # Merge non-JSON extension data
917 if ( isset( $extensionData[$csCode] ) ) {
918 foreach ( $extensionData[$csCode] as $key => $item ) {
919 $this->mergeItem( $key, $csData[$key], $item );
923 if ( $csCode === $code ) {
924 # Merge core data into extension data
925 foreach ( $coreData as $key => $item ) {
926 $this->mergeItem( $key, $csData[$key], $item );
929 # Load the secondary localisation from the source file to
930 # avoid infinite cycles on cyclic fallbacks
931 $fbData = $this->readSourceFilesAndRegisterDeps( $csCode, $deps );
932 if ( $fbData !== false ) {
933 # Only merge the keys that make sense to merge
934 foreach ( self
::$allKeys as $key ) {
935 if ( !isset( $fbData[$key] ) ) {
939 if ( is_null( $coreData[$key] ) ||
$this->isMergeableKey( $key ) ) {
940 $this->mergeItem( $key, $csData[$key], $fbData[$key] );
946 # Allow extensions an opportunity to adjust the data for this
948 wfRunHooks( 'LocalisationCacheRecacheFallback', array( $this, $csCode, &$csData ) );
950 # Merge the data for this fallback into the final array
951 if ( $csCode === $code ) {
954 foreach ( self
::$allKeys as $key ) {
955 if ( !isset( $csData[$key] ) ) {
959 if ( is_null( $allData[$key] ) ||
$this->isMergeableKey( $key ) ) {
960 $this->mergeItem( $key, $allData[$key], $csData[$key] );
966 wfProfileOut( __METHOD__
. '-fallbacks' );
968 # Add cache dependencies for any referenced globals
969 $deps['wgExtensionMessagesFiles'] = new GlobalDependency( 'wgExtensionMessagesFiles' );
970 // $wgMessagesDirs is used in LocalisationCache::getMessagesDirs()
971 $deps['wgMessagesDirs'] = new GlobalDependency( 'wgMessagesDirs' );
972 $deps['version'] = new ConstantDependency( 'LocalisationCache::VERSION' );
974 # Add dependencies to the cache entry
975 $allData['deps'] = $deps;
977 # Replace spaces with underscores in namespace names
978 $allData['namespaceNames'] = str_replace( ' ', '_', $allData['namespaceNames'] );
980 # And do the same for special page aliases. $page is an array.
981 foreach ( $allData['specialPageAliases'] as &$page ) {
982 $page = str_replace( ' ', '_', $page );
984 # Decouple the reference to prevent accidental damage
987 # If there were no plural rules, return an empty array
988 if ( $allData['pluralRules'] === null ) {
989 $allData['pluralRules'] = array();
991 if ( $allData['compiledPluralRules'] === null ) {
992 $allData['compiledPluralRules'] = array();
994 # If there were no plural rule types, return an empty array
995 if ( $allData['pluralRuleTypes'] === null ) {
996 $allData['pluralRuleTypes'] = array();
1000 $allData['list'] = array();
1001 foreach ( self
::$splitKeys as $key ) {
1002 $allData['list'][$key] = array_keys( $allData[$key] );
1006 wfRunHooks( 'LocalisationCacheRecache', array( $this, $code, &$allData, &$purgeBlobs ) );
1008 if ( is_null( $allData['namespaceNames'] ) ) {
1009 wfProfileOut( __METHOD__
);
1010 throw new MWException( __METHOD__
. ': Localisation data failed sanity check! ' .
1011 'Check that your languages/messages/MessagesEn.php file is intact.' );
1014 # Set the preload key
1015 $allData['preload'] = $this->buildPreload( $allData );
1017 # Save to the process cache and register the items loaded
1018 $this->data
[$code] = $allData;
1019 foreach ( $allData as $key => $item ) {
1020 $this->loadedItems
[$code][$key] = true;
1023 # Save to the persistent cache
1024 wfProfileIn( __METHOD__
. '-write' );
1025 $this->store
->startWrite( $code );
1026 foreach ( $allData as $key => $value ) {
1027 if ( in_array( $key, self
::$splitKeys ) ) {
1028 foreach ( $value as $subkey => $subvalue ) {
1029 $this->store
->set( "$key:$subkey", $subvalue );
1032 $this->store
->set( $key, $value );
1035 $this->store
->finishWrite();
1036 wfProfileOut( __METHOD__
. '-write' );
1038 # Clear out the MessageBlobStore
1039 # HACK: If using a null (i.e. disabled) storage backend, we
1040 # can't write to the MessageBlobStore either
1041 if ( $purgeBlobs && !$this->store
instanceof LCStoreNull
) {
1042 MessageBlobStore
::getInstance()->clear();
1045 wfProfileOut( __METHOD__
);
1049 * Build the preload item from the given pre-cache data.
1051 * The preload item will be loaded automatically, improving performance
1052 * for the commonly-requested items it contains.
1053 * @param array $data
1056 protected function buildPreload( $data ) {
1057 $preload = array( 'messages' => array() );
1058 foreach ( self
::$preloadedKeys as $key ) {
1059 $preload[$key] = $data[$key];
1062 foreach ( $data['preloadedMessages'] as $subkey ) {
1063 if ( isset( $data['messages'][$subkey] ) ) {
1064 $subitem = $data['messages'][$subkey];
1068 $preload['messages'][$subkey] = $subitem;
1075 * Unload the data for a given language from the object cache.
1076 * Reduces memory usage.
1077 * @param string $code
1079 public function unload( $code ) {
1080 unset( $this->data
[$code] );
1081 unset( $this->loadedItems
[$code] );
1082 unset( $this->loadedSubitems
[$code] );
1083 unset( $this->initialisedLangs
[$code] );
1084 unset( $this->shallowFallbacks
[$code] );
1086 foreach ( $this->shallowFallbacks
as $shallowCode => $fbCode ) {
1087 if ( $fbCode === $code ) {
1088 $this->unload( $shallowCode );
1096 public function unloadAll() {
1097 foreach ( $this->initialisedLangs
as $lang => $unused ) {
1098 $this->unload( $lang );
1103 * Disable the storage backend
1105 public function disableBackend() {
1106 $this->store
= new LCStoreNull
;
1107 $this->manualRecache
= false;
1112 * Interface for the persistence layer of LocalisationCache.
1114 * The persistence layer is two-level hierarchical cache. The first level
1115 * is the language, the second level is the item or subitem.
1117 * Since the data for a whole language is rebuilt in one operation, it needs
1118 * to have a fast and atomic method for deleting or replacing all of the
1119 * current data for a given language. The interface reflects this bulk update
1120 * operation. Callers writing to the cache must first call startWrite(), then
1121 * will call set() a couple of thousand times, then will call finishWrite()
1122 * to commit the operation. When finishWrite() is called, the cache is
1123 * expected to delete all data previously stored for that language.
1125 * The values stored are PHP variables suitable for serialize(). Implementations
1126 * of LCStore are responsible for serializing and unserializing.
1131 * @param string $code Language code
1132 * @param string $key Cache key
1134 function get( $code, $key );
1137 * Start a write transaction.
1138 * @param string $code Language code
1140 function startWrite( $code );
1143 * Finish a write transaction.
1145 function finishWrite();
1148 * Set a key to a given value. startWrite() must be called before this
1149 * is called, and finishWrite() must be called afterwards.
1150 * @param string $key
1151 * @param mixed $value
1153 function set( $key, $value );
1157 * LCStore implementation which uses the standard DB functions to store data.
1158 * This will work on any MediaWiki installation.
1160 class LCStoreDB
implements LCStore
{
1161 private $currentLang;
1162 private $writesDone = false;
1164 /** @var DatabaseBase */
1167 private $batch = array();
1169 private $readOnly = false;
1171 public function get( $code, $key ) {
1172 if ( $this->writesDone
) {
1173 $db = wfGetDB( DB_MASTER
);
1175 $db = wfGetDB( DB_SLAVE
);
1177 $row = $db->selectRow( 'l10n_cache', array( 'lc_value' ),
1178 array( 'lc_lang' => $code, 'lc_key' => $key ), __METHOD__
);
1180 return unserialize( $db->decodeBlob( $row->lc_value
) );
1186 public function startWrite( $code ) {
1187 if ( $this->readOnly
) {
1189 } elseif ( !$code ) {
1190 throw new MWException( __METHOD__
. ": Invalid language \"$code\"" );
1193 $this->dbw
= wfGetDB( DB_MASTER
);
1195 $this->currentLang
= $code;
1196 $this->batch
= array();
1199 public function finishWrite() {
1200 if ( $this->readOnly
) {
1202 } elseif ( is_null( $this->currentLang
) ) {
1203 throw new MWException( __CLASS__
. ': must call startWrite() before finishWrite()' );
1206 $this->dbw
->begin( __METHOD__
);
1208 $this->dbw
->delete( 'l10n_cache',
1209 array( 'lc_lang' => $this->currentLang
), __METHOD__
);
1210 foreach ( array_chunk( $this->batch
, 500 ) as $rows ) {
1211 $this->dbw
->insert( 'l10n_cache', $rows, __METHOD__
);
1213 $this->writesDone
= true;
1214 } catch ( DBQueryError
$e ) {
1215 if ( $this->dbw
->wasReadOnlyError() ) {
1216 $this->readOnly
= true; // just avoid site down time
1221 $this->dbw
->commit( __METHOD__
);
1223 $this->currentLang
= null;
1224 $this->batch
= array();
1227 public function set( $key, $value ) {
1228 if ( $this->readOnly
) {
1230 } elseif ( is_null( $this->currentLang
) ) {
1231 throw new MWException( __CLASS__
. ': must call startWrite() before set()' );
1234 $this->batch
[] = array(
1235 'lc_lang' => $this->currentLang
,
1237 'lc_value' => $this->dbw
->encodeBlob( serialize( $value ) ) );
1242 * LCStore implementation which stores data as a collection of CDB files in the
1243 * directory given by $wgCacheDirectory. If $wgCacheDirectory is not set, this
1244 * will throw an exception.
1246 * Profiling indicates that on Linux, this implementation outperforms MySQL if
1247 * the directory is on a local filesystem and there is ample kernel cache
1248 * space. The performance advantage is greater when the DBA extension is
1249 * available than it is with the PHP port.
1251 * See Cdb.php and http://cr.yp.to/cdb.html
1253 class LCStoreCDB
implements LCStore
{
1254 /** @var CdbReader[] */
1257 /** @var CdbWriter */
1260 /** @var string Current language code */
1261 private $currentLang;
1263 /** @var bool|string Cache directory. False if not set */
1266 function __construct( $conf = array() ) {
1267 global $wgCacheDirectory;
1269 if ( isset( $conf['directory'] ) ) {
1270 $this->directory
= $conf['directory'];
1272 $this->directory
= $wgCacheDirectory;
1276 public function get( $code, $key ) {
1277 if ( !isset( $this->readers
[$code] ) ) {
1278 $fileName = $this->getFileName( $code );
1280 $this->readers
[$code] = false;
1281 if ( file_exists( $fileName ) ) {
1283 $this->readers
[$code] = CdbReader
::open( $fileName );
1284 } catch ( CdbException
$e ) {
1285 wfDebug( __METHOD__
. ": unable to open cdb file for reading\n" );
1290 if ( !$this->readers
[$code] ) {
1295 $value = $this->readers
[$code]->get( $key );
1296 } catch ( CdbException
$e ) {
1297 wfDebug( __METHOD__
. ": CdbException caught, error message was "
1298 . $e->getMessage() . "\n" );
1300 if ( $value === false ) {
1304 return unserialize( $value );
1308 public function startWrite( $code ) {
1309 if ( !file_exists( $this->directory
) ) {
1310 if ( !wfMkdirParents( $this->directory
, null, __METHOD__
) ) {
1311 throw new MWException( "Unable to create the localisation store " .
1312 "directory \"{$this->directory}\"" );
1316 // Close reader to stop permission errors on write
1317 if ( !empty( $this->readers
[$code] ) ) {
1318 $this->readers
[$code]->close();
1322 $this->writer
= CdbWriter
::open( $this->getFileName( $code ) );
1323 } catch ( CdbException
$e ) {
1324 throw new MWException( $e->getMessage() );
1326 $this->currentLang
= $code;
1329 public function finishWrite() {
1332 $this->writer
->close();
1333 } catch ( CdbException
$e ) {
1334 throw new MWException( $e->getMessage() );
1336 $this->writer
= null;
1337 unset( $this->readers
[$this->currentLang
] );
1338 $this->currentLang
= null;
1341 public function set( $key, $value ) {
1342 if ( is_null( $this->writer
) ) {
1343 throw new MWException( __CLASS__
. ': must call startWrite() before calling set()' );
1346 $this->writer
->set( $key, serialize( $value ) );
1347 } catch ( CdbException
$e ) {
1348 throw new MWException( $e->getMessage() );
1352 protected function getFileName( $code ) {
1353 if ( strval( $code ) === '' ||
strpos( $code, '/' ) !== false ) {
1354 throw new MWException( __METHOD__
. ": Invalid language \"$code\"" );
1357 return "{$this->directory}/l10n_cache-$code.cdb";
1362 * Null store backend, used to avoid DB errors during install
1364 class LCStoreNull
implements LCStore
{
1365 public function get( $code, $key ) {
1369 public function startWrite( $code ) {
1372 public function finishWrite() {
1375 public function set( $key, $value ) {
1380 * A localisation cache optimised for loading large amounts of data for many
1381 * languages. Used by rebuildLocalisationCache.php.
1383 class LocalisationCacheBulkLoad
extends LocalisationCache
{
1385 * A cache of the contents of data files.
1386 * Core files are serialized to avoid using ~1GB of RAM during a recache.
1388 private $fileCache = array();
1391 * Most recently used languages. Uses the linked-list aspect of PHP hashtables
1392 * to keep the most recently used language codes at the end of the array, and
1393 * the language codes that are ready to be deleted at the beginning.
1395 private $mruLangs = array();
1398 * Maximum number of languages that may be loaded into $this->data
1400 private $maxLoadedLangs = 10;
1403 * @param string $fileName
1404 * @param string $fileType
1405 * @return array|mixed
1407 protected function readPHPFile( $fileName, $fileType ) {
1408 $serialize = $fileType === 'core';
1409 if ( !isset( $this->fileCache
[$fileName][$fileType] ) ) {
1410 $data = parent
::readPHPFile( $fileName, $fileType );
1413 $encData = serialize( $data );
1418 $this->fileCache
[$fileName][$fileType] = $encData;
1421 } elseif ( $serialize ) {
1422 return unserialize( $this->fileCache
[$fileName][$fileType] );
1424 return $this->fileCache
[$fileName][$fileType];
1429 * @param string $code
1430 * @param string $key
1433 public function getItem( $code, $key ) {
1434 unset( $this->mruLangs
[$code] );
1435 $this->mruLangs
[$code] = true;
1437 return parent
::getItem( $code, $key );
1441 * @param string $code
1442 * @param string $key
1443 * @param string $subkey
1446 public function getSubitem( $code, $key, $subkey ) {
1447 unset( $this->mruLangs
[$code] );
1448 $this->mruLangs
[$code] = true;
1450 return parent
::getSubitem( $code, $key, $subkey );
1454 * @param string $code
1456 public function recache( $code ) {
1457 parent
::recache( $code );
1458 unset( $this->mruLangs
[$code] );
1459 $this->mruLangs
[$code] = true;
1464 * @param string $code
1466 public function unload( $code ) {
1467 unset( $this->mruLangs
[$code] );
1468 parent
::unload( $code );
1472 * Unload cached languages until there are less than $this->maxLoadedLangs
1474 protected function trimCache() {
1475 while ( count( $this->data
) > $this->maxLoadedLangs
&& count( $this->mruLangs
) ) {
1476 reset( $this->mruLangs
);
1477 $code = key( $this->mruLangs
);
1478 wfDebug( __METHOD__
. ": unloading $code\n" );
1479 $this->unload( $code );