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 var $manualRecache = false;
49 * True to treat all files as expired until they are regenerated by this object.
51 var $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.
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 var $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 var $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 var $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 var $shallowFallbacks = array();
98 * An array where the keys are codes that have been recached by this instance.
100 var $recachedLangs = array();
105 static public $allKeys = array(
106 'fallback', 'namespaceNames', 'bookstoreList',
107 'magicWords', 'messages', 'rtl', 'capitalizeAllNouns', 'digitTransformTable',
108 'separatorTransformTable', 'fallback8bitEncoding', 'linkPrefixExtension',
109 'linkTrail', 'namespaceAliases',
110 'dateFormats', 'datePreferences', 'datePreferenceMigrationMap',
111 'defaultDateFormat', 'extraUserToggles', 'specialPageAliases',
112 'imageFiles', 'preloadedMessages', 'namespaceGenderAliases',
113 'digitGroupingPattern', 'pluralRules', '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 var $pluralRules = null;
163 var $mergeableKeys = null;
167 * For constructor parameters, see the documentation in DefaultSettings.php
168 * for $wgLocalisationCacheConf.
171 * @throws MWException
173 function __construct( $conf ) {
174 global $wgCacheDirectory;
177 $storeConf = array();
178 if ( !empty( $conf['storeClass'] ) ) {
179 $storeClass = $conf['storeClass'];
181 switch ( $conf['store'] ) {
184 $storeClass = 'LCStore_CDB';
187 $storeClass = 'LCStore_DB';
190 $storeClass = 'LCStore_Accel';
193 $storeClass = $wgCacheDirectory ?
'LCStore_CDB' : 'LCStore_DB';
196 throw new MWException(
197 'Please set $wgLocalisationCacheConf[\'store\'] to something sensible.' );
201 wfDebug( get_class( $this ) . ": using store $storeClass\n" );
202 if ( !empty( $conf['storeDirectory'] ) ) {
203 $storeConf['directory'] = $conf['storeDirectory'];
206 $this->store
= new $storeClass( $storeConf );
207 foreach ( array( 'manualRecache', 'forceRecache' ) as $var ) {
208 if ( isset( $conf[$var] ) ) {
209 $this->$var = $conf[$var];
215 * Returns true if the given key is mergeable, that is, if it is an associative
216 * array which can be merged through a fallback sequence.
220 public function isMergeableKey( $key ) {
221 if ( $this->mergeableKeys
=== null ) {
222 $this->mergeableKeys
= array_flip( array_merge(
223 self
::$mergeableMapKeys,
224 self
::$mergeableListKeys,
225 self
::$mergeableAliasListKeys,
226 self
::$optionalMergeKeys,
230 return isset( $this->mergeableKeys
[$key] );
236 * Warning: this may be slow for split items (messages), since it will
237 * need to fetch all of the subitems from the cache individually.
242 public function getItem( $code, $key ) {
243 if ( !isset( $this->loadedItems
[$code][$key] ) ) {
244 wfProfileIn( __METHOD__
. '-load' );
245 $this->loadItem( $code, $key );
246 wfProfileOut( __METHOD__
. '-load' );
249 if ( $key === 'fallback' && isset( $this->shallowFallbacks
[$code] ) ) {
250 return $this->shallowFallbacks
[$code];
253 return $this->data
[$code][$key];
257 * Get a subitem, for instance a single message for a given language.
263 public function getSubitem( $code, $key, $subkey ) {
264 if ( !isset( $this->loadedSubitems
[$code][$key][$subkey] ) &&
265 !isset( $this->loadedItems
[$code][$key] ) ) {
266 wfProfileIn( __METHOD__
. '-load' );
267 $this->loadSubitem( $code, $key, $subkey );
268 wfProfileOut( __METHOD__
. '-load' );
271 if ( isset( $this->data
[$code][$key][$subkey] ) ) {
272 return $this->data
[$code][$key][$subkey];
279 * Get the list of subitem keys for a given item.
281 * This is faster than array_keys($lc->getItem(...)) for the items listed in
284 * Will return null if the item is not found, or false if the item is not an
288 * @return bool|null|string
290 public function getSubitemList( $code, $key ) {
291 if ( in_array( $key, self
::$splitKeys ) ) {
292 return $this->getSubitem( $code, 'list', $key );
294 $item = $this->getItem( $code, $key );
295 if ( is_array( $item ) ) {
296 return array_keys( $item );
304 * Load an item into the cache.
308 protected function loadItem( $code, $key ) {
309 if ( !isset( $this->initialisedLangs
[$code] ) ) {
310 $this->initLanguage( $code );
313 // Check to see if initLanguage() loaded it for us
314 if ( isset( $this->loadedItems
[$code][$key] ) ) {
318 if ( isset( $this->shallowFallbacks
[$code] ) ) {
319 $this->loadItem( $this->shallowFallbacks
[$code], $key );
323 if ( in_array( $key, self
::$splitKeys ) ) {
324 $subkeyList = $this->getSubitem( $code, 'list', $key );
325 foreach ( $subkeyList as $subkey ) {
326 if ( isset( $this->data
[$code][$key][$subkey] ) ) {
329 $this->data
[$code][$key][$subkey] = $this->getSubitem( $code, $key, $subkey );
332 $this->data
[$code][$key] = $this->store
->get( $code, $key );
335 $this->loadedItems
[$code][$key] = true;
339 * Load a subitem into the cache
345 protected function loadSubitem( $code, $key, $subkey ) {
346 if ( !in_array( $key, self
::$splitKeys ) ) {
347 $this->loadItem( $code, $key );
351 if ( !isset( $this->initialisedLangs
[$code] ) ) {
352 $this->initLanguage( $code );
355 // Check to see if initLanguage() loaded it for us
356 if ( isset( $this->loadedItems
[$code][$key] ) ||
357 isset( $this->loadedSubitems
[$code][$key][$subkey] ) ) {
361 if ( isset( $this->shallowFallbacks
[$code] ) ) {
362 $this->loadSubitem( $this->shallowFallbacks
[$code], $key, $subkey );
366 $value = $this->store
->get( $code, "$key:$subkey" );
367 $this->data
[$code][$key][$subkey] = $value;
368 $this->loadedSubitems
[$code][$key][$subkey] = true;
372 * Returns true if the cache identified by $code is missing or expired.
375 public function isExpired( $code ) {
376 if ( $this->forceRecache
&& !isset( $this->recachedLangs
[$code] ) ) {
377 wfDebug( __METHOD__
. "($code): forced reload\n" );
381 $deps = $this->store
->get( $code, 'deps' );
382 $keys = $this->store
->get( $code, 'list' );
383 $preload = $this->store
->get( $code, 'preload' );
384 // Different keys may expire separately, at least in LCStore_Accel
385 if ( $deps === null ||
$keys === null ||
$preload === null ) {
386 wfDebug( __METHOD__
. "($code): cache missing, need to make one\n" );
390 foreach ( $deps as $dep ) {
391 // Because we're unserializing stuff from cache, we
392 // could receive objects of classes that don't exist
393 // anymore (e.g. uninstalled extensions)
394 // When this happens, always expire the cache
395 if ( !$dep instanceof CacheDependency ||
$dep->isExpired() ) {
396 wfDebug( __METHOD__
. "($code): cache for $code expired due to " .
397 get_class( $dep ) . "\n" );
406 * Initialise a language in this object. Rebuild the cache if necessary.
408 * @throws MWException
410 protected function initLanguage( $code ) {
411 if ( isset( $this->initialisedLangs
[$code] ) ) {
415 $this->initialisedLangs
[$code] = true;
417 # If the code is of the wrong form for a Messages*.php file, do a shallow fallback
418 if ( !Language
::isValidBuiltInCode( $code ) ) {
419 $this->initShallowFallback( $code, 'en' );
423 # Recache the data if necessary
424 if ( !$this->manualRecache
&& $this->isExpired( $code ) ) {
425 if ( file_exists( Language
::getMessagesFileName( $code ) ) ) {
426 $this->recache( $code );
427 } elseif ( $code === 'en' ) {
428 throw new MWException( 'MessagesEn.php is missing.' );
430 $this->initShallowFallback( $code, 'en' );
436 $preload = $this->getItem( $code, 'preload' );
437 if ( $preload === null ) {
438 if ( $this->manualRecache
) {
439 // No Messages*.php file. Do shallow fallback to en.
440 if ( $code === 'en' ) {
441 throw new MWException( 'No localisation cache found for English. ' .
442 'Please run maintenance/rebuildLocalisationCache.php.' );
444 $this->initShallowFallback( $code, 'en' );
447 throw new MWException( 'Invalid or missing localisation cache.' );
450 $this->data
[$code] = $preload;
451 foreach ( $preload as $key => $item ) {
452 if ( in_array( $key, self
::$splitKeys ) ) {
453 foreach ( $item as $subkey => $subitem ) {
454 $this->loadedSubitems
[$code][$key][$subkey] = true;
457 $this->loadedItems
[$code][$key] = true;
463 * Create a fallback from one language to another, without creating a
464 * complete persistent cache.
465 * @param $primaryCode
466 * @param $fallbackCode
468 public function initShallowFallback( $primaryCode, $fallbackCode ) {
469 $this->data
[$primaryCode] =& $this->data
[$fallbackCode];
470 $this->loadedItems
[$primaryCode] =& $this->loadedItems
[$fallbackCode];
471 $this->loadedSubitems
[$primaryCode] =& $this->loadedSubitems
[$fallbackCode];
472 $this->shallowFallbacks
[$primaryCode] = $fallbackCode;
476 * Read a PHP file containing localisation data.
479 * @throws MWException
482 protected function readPHPFile( $_fileName, $_fileType ) {
483 // Disable APC caching
484 $_apcEnabled = ini_set( 'apc.cache_by_default', '0' );
485 include( $_fileName );
486 ini_set( 'apc.cache_by_default', $_apcEnabled );
488 if ( $_fileType == 'core' ||
$_fileType == 'extension' ) {
489 $data = compact( self
::$allKeys );
490 } elseif ( $_fileType == 'aliases' ) {
491 $data = compact( 'aliases' );
493 throw new MWException( __METHOD__
. ": Invalid file type: $_fileType" );
499 * Get the compiled plural rules for a given language from the XML files.
502 public function getCompiledPluralRules( $code ) {
503 $rules = $this->getPluralRules( $code );
504 if ( $rules === null ) {
508 $compiledRules = CLDRPluralRuleEvaluator
::compile( $rules );
509 } catch( CLDRPluralRuleError
$e ) {
510 wfDebugLog( 'l10n', $e->getMessage() . "\n" );
513 return $compiledRules;
517 * Get the plural rules for a given language from the XML files.
521 public function getPluralRules( $code ) {
524 if ( $this->pluralRules
=== null ) {
525 $cldrPlural = "$IP/languages/data/plurals.xml";
526 $mwPlural = "$IP/languages/data/plurals-mediawiki.xml";
527 // Load CLDR plural rules
528 $this->loadPluralFile( $cldrPlural );
529 if ( file_exists( $mwPlural ) ) {
530 // Override or extend
531 $this->loadPluralFile( $mwPlural );
534 if ( !isset( $this->pluralRules
[$code] ) ) {
537 return $this->pluralRules
[$code];
542 * Load a plural XML file with the given filename, compile the relevant
543 * rules, and save the compiled rules in a process-local cache.
545 protected function loadPluralFile( $fileName ) {
546 $doc = new DOMDocument
;
547 $doc->load( $fileName );
548 $rulesets = $doc->getElementsByTagName( "pluralRules" );
549 foreach ( $rulesets as $ruleset ) {
550 $codes = $ruleset->getAttribute( 'locales' );
552 $ruleElements = $ruleset->getElementsByTagName( "pluralRule" );
553 foreach ( $ruleElements as $elt ) {
554 $rules[] = $elt->nodeValue
;
556 foreach ( explode( ' ', $codes ) as $code ) {
557 $this->pluralRules
[$code] = $rules;
563 * Read the data from the source files for a given language, and register
564 * the relevant dependencies in the $deps array. If the localisation
565 * exists, the data array is returned, otherwise false is returned.
567 protected function readSourceFilesAndRegisterDeps( $code, &$deps ) {
570 $fileName = Language
::getMessagesFileName( $code );
571 if ( !file_exists( $fileName ) ) {
575 $deps[] = new FileDependency( $fileName );
576 $data = $this->readPHPFile( $fileName, 'core' );
578 # Load CLDR plural rules for JavaScript
579 $data['pluralRules'] = $this->getPluralRules( $code );
581 $data['compiledPluralRules'] = $this->getCompiledPluralRules( $code );
583 $deps['plurals'] = new FileDependency( "$IP/languages/data/plurals.xml" );
584 $deps['plurals-mw'] = new FileDependency( "$IP/languages/data/plurals-mediawiki.xml" );
590 * Merge two localisation values, a primary and a fallback, overwriting the
591 * primary value in place.
594 * @param $fallbackValue
596 protected function mergeItem( $key, &$value, $fallbackValue ) {
597 if ( !is_null( $value ) ) {
598 if ( !is_null( $fallbackValue ) ) {
599 if ( in_array( $key, self
::$mergeableMapKeys ) ) {
600 $value = $value +
$fallbackValue;
601 } elseif ( in_array( $key, self
::$mergeableListKeys ) ) {
602 $value = array_unique( array_merge( $fallbackValue, $value ) );
603 } elseif ( in_array( $key, self
::$mergeableAliasListKeys ) ) {
604 $value = array_merge_recursive( $value, $fallbackValue );
605 } elseif ( in_array( $key, self
::$optionalMergeKeys ) ) {
606 if ( !empty( $value['inherit'] ) ) {
607 $value = array_merge( $fallbackValue, $value );
610 if ( isset( $value['inherit'] ) ) {
611 unset( $value['inherit'] );
613 } elseif ( in_array( $key, self
::$magicWordKeys ) ) {
614 $this->mergeMagicWords( $value, $fallbackValue );
618 $value = $fallbackValue;
624 * @param $fallbackValue
626 protected function mergeMagicWords( &$value, $fallbackValue ) {
627 foreach ( $fallbackValue as $magicName => $fallbackInfo ) {
628 if ( !isset( $value[$magicName] ) ) {
629 $value[$magicName] = $fallbackInfo;
631 $oldSynonyms = array_slice( $fallbackInfo, 1 );
632 $newSynonyms = array_slice( $value[$magicName], 1 );
633 $synonyms = array_values( array_unique( array_merge(
634 $newSynonyms, $oldSynonyms ) ) );
635 $value[$magicName] = array_merge( array( $fallbackInfo[0] ), $synonyms );
641 * Given an array mapping language code to localisation value, such as is
642 * found in extension *.i18n.php files, iterate through a fallback sequence
643 * to merge the given data with an existing primary value.
645 * Returns true if any data from the extension array was used, false
647 * @param $codeSequence
650 * @param $fallbackValue
653 protected function mergeExtensionItem( $codeSequence, $key, &$value, $fallbackValue ) {
655 foreach ( $codeSequence as $code ) {
656 if ( isset( $fallbackValue[$code] ) ) {
657 $this->mergeItem( $key, $value, $fallbackValue[$code] );
666 * Load localisation data for a given language for both core and extensions
667 * and save it to the persistent cache store and the process cache
669 * @throws MWException
671 public function recache( $code ) {
672 global $wgExtensionMessagesFiles;
673 wfProfileIn( __METHOD__
);
676 throw new MWException( "Invalid language code requested" );
678 $this->recachedLangs
[$code] = true;
681 $initialData = array_combine(
683 array_fill( 0, count( self
::$allKeys ), null ) );
684 $coreData = $initialData;
687 # Load the primary localisation from the source file
688 $data = $this->readSourceFilesAndRegisterDeps( $code, $deps );
689 if ( $data === false ) {
690 wfDebug( __METHOD__
. ": no localisation file for $code, using fallback to en\n" );
691 $coreData['fallback'] = 'en';
693 wfDebug( __METHOD__
. ": got localisation for $code from source\n" );
695 # Merge primary localisation
696 foreach ( $data as $key => $value ) {
697 $this->mergeItem( $key, $coreData[$key], $value );
702 # Fill in the fallback if it's not there already
703 if ( is_null( $coreData['fallback'] ) ) {
704 $coreData['fallback'] = $code === 'en' ?
false : 'en';
706 if ( $coreData['fallback'] === false ) {
707 $coreData['fallbackSequence'] = array();
709 $coreData['fallbackSequence'] = array_map( 'trim', explode( ',', $coreData['fallback'] ) );
710 $len = count( $coreData['fallbackSequence'] );
712 # Ensure that the sequence ends at en
713 if ( $coreData['fallbackSequence'][$len - 1] !== 'en' ) {
714 $coreData['fallbackSequence'][] = 'en';
717 # Load the fallback localisation item by item and merge it
718 foreach ( $coreData['fallbackSequence'] as $fbCode ) {
719 # Load the secondary localisation from the source file to
720 # avoid infinite cycles on cyclic fallbacks
721 $fbData = $this->readSourceFilesAndRegisterDeps( $fbCode, $deps );
722 if ( $fbData === false ) {
726 foreach ( self
::$allKeys as $key ) {
727 if ( !isset( $fbData[$key] ) ) {
731 if ( is_null( $coreData[$key] ) ||
$this->isMergeableKey( $key ) ) {
732 $this->mergeItem( $key, $coreData[$key], $fbData[$key] );
738 $codeSequence = array_merge( array( $code ), $coreData['fallbackSequence'] );
740 # Load the extension localisations
741 # This is done after the core because we know the fallback sequence now.
742 # But it has a higher precedence for merging so that we can support things
743 # like site-specific message overrides.
744 $allData = $initialData;
745 foreach ( $wgExtensionMessagesFiles as $fileName ) {
746 $data = $this->readPHPFile( $fileName, 'extension' );
749 foreach ( $data as $key => $item ) {
750 if ( $this->mergeExtensionItem( $codeSequence, $key, $allData[$key], $item ) ) {
756 $deps[] = new FileDependency( $fileName );
760 # Merge core data into extension data
761 foreach ( $coreData as $key => $item ) {
762 $this->mergeItem( $key, $allData[$key], $item );
765 # Add cache dependencies for any referenced globals
766 $deps['wgExtensionMessagesFiles'] = new GlobalDependency( 'wgExtensionMessagesFiles' );
767 $deps['version'] = new ConstantDependency( 'MW_LC_VERSION' );
769 # Add dependencies to the cache entry
770 $allData['deps'] = $deps;
772 # Replace spaces with underscores in namespace names
773 $allData['namespaceNames'] = str_replace( ' ', '_', $allData['namespaceNames'] );
775 # And do the same for special page aliases. $page is an array.
776 foreach ( $allData['specialPageAliases'] as &$page ) {
777 $page = str_replace( ' ', '_', $page );
779 # Decouple the reference to prevent accidental damage
782 # If there were no plural rules, return an empty array
783 if ( $allData['pluralRules'] === null ) {
784 $allData['pluralRules'] = array();
786 if ( $allData['compiledPluralRules'] === null ) {
787 $allData['compiledPluralRules'] = array();
791 $allData['list'] = array();
792 foreach ( self
::$splitKeys as $key ) {
793 $allData['list'][$key] = array_keys( $allData[$key] );
796 wfRunHooks( 'LocalisationCacheRecache', array( $this, $code, &$allData ) );
798 if ( is_null( $allData['namespaceNames'] ) ) {
799 throw new MWException( __METHOD__
. ': Localisation data failed sanity check! ' .
800 'Check that your languages/messages/MessagesEn.php file is intact.' );
803 # Set the preload key
804 $allData['preload'] = $this->buildPreload( $allData );
806 # Save to the process cache and register the items loaded
807 $this->data
[$code] = $allData;
808 foreach ( $allData as $key => $item ) {
809 $this->loadedItems
[$code][$key] = true;
812 # Save to the persistent cache
813 $this->store
->startWrite( $code );
814 foreach ( $allData as $key => $value ) {
815 if ( in_array( $key, self
::$splitKeys ) ) {
816 foreach ( $value as $subkey => $subvalue ) {
817 $this->store
->set( "$key:$subkey", $subvalue );
820 $this->store
->set( $key, $value );
823 $this->store
->finishWrite();
825 # Clear out the MessageBlobStore
826 # HACK: If using a null (i.e. disabled) storage backend, we
827 # can't write to the MessageBlobStore either
828 if ( !$this->store
instanceof LCStore_Null
) {
829 MessageBlobStore
::clear();
832 wfProfileOut( __METHOD__
);
836 * Build the preload item from the given pre-cache data.
838 * The preload item will be loaded automatically, improving performance
839 * for the commonly-requested items it contains.
843 protected function buildPreload( $data ) {
844 $preload = array( 'messages' => array() );
845 foreach ( self
::$preloadedKeys as $key ) {
846 $preload[$key] = $data[$key];
849 foreach ( $data['preloadedMessages'] as $subkey ) {
850 if ( isset( $data['messages'][$subkey] ) ) {
851 $subitem = $data['messages'][$subkey];
855 $preload['messages'][$subkey] = $subitem;
862 * Unload the data for a given language from the object cache.
863 * Reduces memory usage.
866 public function unload( $code ) {
867 unset( $this->data
[$code] );
868 unset( $this->loadedItems
[$code] );
869 unset( $this->loadedSubitems
[$code] );
870 unset( $this->initialisedLangs
[$code] );
872 foreach ( $this->shallowFallbacks
as $shallowCode => $fbCode ) {
873 if ( $fbCode === $code ) {
874 $this->unload( $shallowCode );
882 public function unloadAll() {
883 foreach ( $this->initialisedLangs
as $lang => $unused ) {
884 $this->unload( $lang );
889 * Disable the storage backend
891 public function disableBackend() {
892 $this->store
= new LCStore_Null
;
893 $this->manualRecache
= false;
898 * Interface for the persistence layer of LocalisationCache.
900 * The persistence layer is two-level hierarchical cache. The first level
901 * is the language, the second level is the item or subitem.
903 * Since the data for a whole language is rebuilt in one operation, it needs
904 * to have a fast and atomic method for deleting or replacing all of the
905 * current data for a given language. The interface reflects this bulk update
906 * operation. Callers writing to the cache must first call startWrite(), then
907 * will call set() a couple of thousand times, then will call finishWrite()
908 * to commit the operation. When finishWrite() is called, the cache is
909 * expected to delete all data previously stored for that language.
911 * The values stored are PHP variables suitable for serialize(). Implementations
912 * of LCStore are responsible for serializing and unserializing.
917 * @param string $code Language code
918 * @param string $key Cache key
920 function get( $code, $key );
923 * Start a write transaction.
924 * @param $code Language code
926 function startWrite( $code );
929 * Finish a write transaction.
931 function finishWrite();
934 * Set a key to a given value. startWrite() must be called before this
935 * is called, and finishWrite() must be called afterwards.
939 function set( $key, $value );
943 * LCStore implementation which uses PHP accelerator to store data.
944 * This will work if one of XCache, WinCache or APC cacher is configured.
945 * (See ObjectCache.php)
947 class LCStore_Accel
implements LCStore
{
951 public function __construct() {
952 $this->cache
= wfGetCache( CACHE_ACCEL
);
955 public function get( $code, $key ) {
956 $k = wfMemcKey( 'l10n', $code, 'k', $key );
957 $r = $this->cache
->get( $k );
958 return $r === false ?
null : $r;
961 public function startWrite( $code ) {
962 $k = wfMemcKey( 'l10n', $code, 'l' );
963 $keys = $this->cache
->get( $k );
965 foreach ( $keys as $k ) {
966 $this->cache
->delete( $k );
969 $this->currentLang
= $code;
970 $this->keys
= array();
973 public function finishWrite() {
974 if ( $this->currentLang
) {
975 $k = wfMemcKey( 'l10n', $this->currentLang
, 'l' );
976 $this->cache
->set( $k, array_keys( $this->keys
) );
978 $this->currentLang
= null;
979 $this->keys
= array();
982 public function set( $key, $value ) {
983 if ( $this->currentLang
) {
984 $k = wfMemcKey( 'l10n', $this->currentLang
, 'k', $key );
985 $this->keys
[$k] = true;
986 $this->cache
->set( $k, $value );
992 * LCStore implementation which uses the standard DB functions to store data.
993 * This will work on any MediaWiki installation.
995 class LCStore_DB
implements LCStore
{
997 var $writesDone = false;
1004 var $readOnly = false;
1006 public function get( $code, $key ) {
1007 if ( $this->writesDone
) {
1008 $db = wfGetDB( DB_MASTER
);
1010 $db = wfGetDB( DB_SLAVE
);
1012 $row = $db->selectRow( 'l10n_cache', array( 'lc_value' ),
1013 array( 'lc_lang' => $code, 'lc_key' => $key ), __METHOD__
);
1015 return unserialize( $row->lc_value
);
1021 public function startWrite( $code ) {
1022 if ( $this->readOnly
) {
1027 throw new MWException( __METHOD__
. ": Invalid language \"$code\"" );
1030 $this->dbw
= wfGetDB( DB_MASTER
);
1032 $this->dbw
->begin( __METHOD__
);
1033 $this->dbw
->delete( 'l10n_cache', array( 'lc_lang' => $code ), __METHOD__
);
1034 } catch ( DBQueryError
$e ) {
1035 if ( $this->dbw
->wasReadOnlyError() ) {
1036 $this->readOnly
= true;
1037 $this->dbw
->rollback( __METHOD__
);
1044 $this->currentLang
= $code;
1045 $this->batch
= array();
1048 public function finishWrite() {
1049 if ( $this->readOnly
) {
1053 if ( $this->batch
) {
1054 $this->dbw
->insert( 'l10n_cache', $this->batch
, __METHOD__
);
1057 $this->dbw
->commit( __METHOD__
);
1058 $this->currentLang
= null;
1060 $this->batch
= array();
1061 $this->writesDone
= true;
1064 public function set( $key, $value ) {
1065 if ( $this->readOnly
) {
1069 if ( is_null( $this->currentLang
) ) {
1070 throw new MWException( __CLASS__
. ': must call startWrite() before calling set()' );
1073 $this->batch
[] = array(
1074 'lc_lang' => $this->currentLang
,
1076 'lc_value' => serialize( $value ) );
1078 if ( count( $this->batch
) >= 100 ) {
1079 $this->dbw
->insert( 'l10n_cache', $this->batch
, __METHOD__
);
1080 $this->batch
= array();
1086 * LCStore implementation which stores data as a collection of CDB files in the
1087 * directory given by $wgCacheDirectory. If $wgCacheDirectory is not set, this
1088 * will throw an exception.
1090 * Profiling indicates that on Linux, this implementation outperforms MySQL if
1091 * the directory is on a local filesystem and there is ample kernel cache
1092 * space. The performance advantage is greater when the DBA extension is
1093 * available than it is with the PHP port.
1095 * See Cdb.php and http://cr.yp.to/cdb.html
1097 class LCStore_CDB
implements LCStore
{
1098 var $readers, $writer, $currentLang, $directory;
1100 function __construct( $conf = array() ) {
1101 global $wgCacheDirectory;
1103 if ( isset( $conf['directory'] ) ) {
1104 $this->directory
= $conf['directory'];
1106 $this->directory
= $wgCacheDirectory;
1110 public function get( $code, $key ) {
1111 if ( !isset( $this->readers
[$code] ) ) {
1112 $fileName = $this->getFileName( $code );
1114 if ( !file_exists( $fileName ) ) {
1115 $this->readers
[$code] = false;
1117 $this->readers
[$code] = CdbReader
::open( $fileName );
1121 if ( !$this->readers
[$code] ) {
1124 $value = $this->readers
[$code]->get( $key );
1126 if ( $value === false ) {
1129 return unserialize( $value );
1133 public function startWrite( $code ) {
1134 if ( !file_exists( $this->directory
) ) {
1135 if ( !wfMkdirParents( $this->directory
, null, __METHOD__
) ) {
1136 throw new MWException( "Unable to create the localisation store " .
1137 "directory \"{$this->directory}\"" );
1141 // Close reader to stop permission errors on write
1142 if ( !empty( $this->readers
[$code] ) ) {
1143 $this->readers
[$code]->close();
1146 $this->writer
= CdbWriter
::open( $this->getFileName( $code ) );
1147 $this->currentLang
= $code;
1150 public function finishWrite() {
1152 $this->writer
->close();
1153 $this->writer
= null;
1154 unset( $this->readers
[$this->currentLang
] );
1155 $this->currentLang
= null;
1158 public function set( $key, $value ) {
1159 if ( is_null( $this->writer
) ) {
1160 throw new MWException( __CLASS__
. ': must call startWrite() before calling set()' );
1162 $this->writer
->set( $key, serialize( $value ) );
1165 protected function getFileName( $code ) {
1166 if ( strval( $code ) === '' ||
strpos( $code, '/' ) !== false ) {
1167 throw new MWException( __METHOD__
. ": Invalid language \"$code\"" );
1169 return "{$this->directory}/l10n_cache-$code.cdb";
1174 * Null store backend, used to avoid DB errors during install
1176 class LCStore_Null
implements LCStore
{
1177 public function get( $code, $key ) {
1181 public function startWrite( $code ) {}
1182 public function finishWrite() {}
1183 public function set( $key, $value ) {}
1187 * A localisation cache optimised for loading large amounts of data for many
1188 * languages. Used by rebuildLocalisationCache.php.
1190 class LocalisationCache_BulkLoad
extends LocalisationCache
{
1192 * A cache of the contents of data files.
1193 * Core files are serialized to avoid using ~1GB of RAM during a recache.
1195 var $fileCache = array();
1198 * Most recently used languages. Uses the linked-list aspect of PHP hashtables
1199 * to keep the most recently used language codes at the end of the array, and
1200 * the language codes that are ready to be deleted at the beginning.
1202 var $mruLangs = array();
1205 * Maximum number of languages that may be loaded into $this->data
1207 var $maxLoadedLangs = 10;
1212 * @return array|mixed
1214 protected function readPHPFile( $fileName, $fileType ) {
1215 $serialize = $fileType === 'core';
1216 if ( !isset( $this->fileCache
[$fileName][$fileType] ) ) {
1217 $data = parent
::readPHPFile( $fileName, $fileType );
1220 $encData = serialize( $data );
1225 $this->fileCache
[$fileName][$fileType] = $encData;
1228 } elseif ( $serialize ) {
1229 return unserialize( $this->fileCache
[$fileName][$fileType] );
1231 return $this->fileCache
[$fileName][$fileType];
1240 public function getItem( $code, $key ) {
1241 unset( $this->mruLangs
[$code] );
1242 $this->mruLangs
[$code] = true;
1243 return parent
::getItem( $code, $key );
1252 public function getSubitem( $code, $key, $subkey ) {
1253 unset( $this->mruLangs
[$code] );
1254 $this->mruLangs
[$code] = true;
1255 return parent
::getSubitem( $code, $key, $subkey );
1261 public function recache( $code ) {
1262 parent
::recache( $code );
1263 unset( $this->mruLangs
[$code] );
1264 $this->mruLangs
[$code] = true;
1271 public function unload( $code ) {
1272 unset( $this->mruLangs
[$code] );
1273 parent
::unload( $code );
1277 * Unload cached languages until there are less than $this->maxLoadedLangs
1279 protected function trimCache() {
1280 while ( count( $this->data
) > $this->maxLoadedLangs
&& count( $this->mruLangs
) ) {
1281 reset( $this->mruLangs
);
1282 $code = key( $this->mruLangs
);
1283 wfDebug( __METHOD__
. ": unloading $code\n" );
1284 $this->unload( $code );