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'
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', 'pluralRules'
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.
172 function __construct( $conf ) {
173 global $wgCacheDirectory;
176 $storeConf = array();
177 if ( !empty( $conf['storeClass'] ) ) {
178 $storeClass = $conf['storeClass'];
180 switch ( $conf['store'] ) {
183 $storeClass = 'LCStore_CDB';
186 $storeClass = 'LCStore_DB';
189 $storeClass = 'LCStore_Accel';
192 $storeClass = $wgCacheDirectory ?
'LCStore_CDB' : 'LCStore_DB';
195 throw new MWException(
196 'Please set $wgLocalisationCacheConf[\'store\'] to something sensible.' );
200 wfDebug( get_class( $this ) . ": using store $storeClass\n" );
201 if ( !empty( $conf['storeDirectory'] ) ) {
202 $storeConf['directory'] = $conf['storeDirectory'];
205 $this->store
= new $storeClass( $storeConf );
206 foreach ( array( 'manualRecache', 'forceRecache' ) as $var ) {
207 if ( isset( $conf[$var] ) ) {
208 $this->$var = $conf[$var];
214 * Returns true if the given key is mergeable, that is, if it is an associative
215 * array which can be merged through a fallback sequence.
219 public function isMergeableKey( $key ) {
220 if ( $this->mergeableKeys
=== null ) {
221 $this->mergeableKeys
= array_flip( array_merge(
222 self
::$mergeableMapKeys,
223 self
::$mergeableListKeys,
224 self
::$mergeableAliasListKeys,
225 self
::$optionalMergeKeys,
229 return isset( $this->mergeableKeys
[$key] );
235 * Warning: this may be slow for split items (messages), since it will
236 * need to fetch all of the subitems from the cache individually.
241 public function getItem( $code, $key ) {
242 if ( !isset( $this->loadedItems
[$code][$key] ) ) {
243 wfProfileIn( __METHOD__
. '-load' );
244 $this->loadItem( $code, $key );
245 wfProfileOut( __METHOD__
. '-load' );
248 if ( $key === 'fallback' && isset( $this->shallowFallbacks
[$code] ) ) {
249 return $this->shallowFallbacks
[$code];
252 return $this->data
[$code][$key];
256 * Get a subitem, for instance a single message for a given language.
262 public function getSubitem( $code, $key, $subkey ) {
263 if ( !isset( $this->loadedSubitems
[$code][$key][$subkey] ) &&
264 !isset( $this->loadedItems
[$code][$key] ) ) {
265 wfProfileIn( __METHOD__
. '-load' );
266 $this->loadSubitem( $code, $key, $subkey );
267 wfProfileOut( __METHOD__
. '-load' );
270 if ( isset( $this->data
[$code][$key][$subkey] ) ) {
271 return $this->data
[$code][$key][$subkey];
278 * Get the list of subitem keys for a given item.
280 * This is faster than array_keys($lc->getItem(...)) for the items listed in
283 * Will return null if the item is not found, or false if the item is not an
287 * @return bool|null|string
289 public function getSubitemList( $code, $key ) {
290 if ( in_array( $key, self
::$splitKeys ) ) {
291 return $this->getSubitem( $code, 'list', $key );
293 $item = $this->getItem( $code, $key );
294 if ( is_array( $item ) ) {
295 return array_keys( $item );
303 * Load an item into the cache.
307 protected function loadItem( $code, $key ) {
308 if ( !isset( $this->initialisedLangs
[$code] ) ) {
309 $this->initLanguage( $code );
312 // Check to see if initLanguage() loaded it for us
313 if ( isset( $this->loadedItems
[$code][$key] ) ) {
317 if ( isset( $this->shallowFallbacks
[$code] ) ) {
318 $this->loadItem( $this->shallowFallbacks
[$code], $key );
322 if ( in_array( $key, self
::$splitKeys ) ) {
323 $subkeyList = $this->getSubitem( $code, 'list', $key );
324 foreach ( $subkeyList as $subkey ) {
325 if ( isset( $this->data
[$code][$key][$subkey] ) ) {
328 $this->data
[$code][$key][$subkey] = $this->getSubitem( $code, $key, $subkey );
331 $this->data
[$code][$key] = $this->store
->get( $code, $key );
334 $this->loadedItems
[$code][$key] = true;
338 * Load a subitem into the cache
344 protected function loadSubitem( $code, $key, $subkey ) {
345 if ( !in_array( $key, self
::$splitKeys ) ) {
346 $this->loadItem( $code, $key );
350 if ( !isset( $this->initialisedLangs
[$code] ) ) {
351 $this->initLanguage( $code );
354 // Check to see if initLanguage() loaded it for us
355 if ( isset( $this->loadedItems
[$code][$key] ) ||
356 isset( $this->loadedSubitems
[$code][$key][$subkey] ) ) {
360 if ( isset( $this->shallowFallbacks
[$code] ) ) {
361 $this->loadSubitem( $this->shallowFallbacks
[$code], $key, $subkey );
365 $value = $this->store
->get( $code, "$key:$subkey" );
366 $this->data
[$code][$key][$subkey] = $value;
367 $this->loadedSubitems
[$code][$key][$subkey] = true;
371 * Returns true if the cache identified by $code is missing or expired.
374 public function isExpired( $code ) {
375 if ( $this->forceRecache
&& !isset( $this->recachedLangs
[$code] ) ) {
376 wfDebug( __METHOD__
. "($code): forced reload\n" );
380 $deps = $this->store
->get( $code, 'deps' );
381 $keys = $this->store
->get( $code, 'list', 'messages' );
382 $preload = $this->store
->get( $code, 'preload' );
383 // Different keys may expire separately, at least in LCStore_Accel
384 if ( $deps === null ||
$keys === null ||
$preload === null ) {
385 wfDebug( __METHOD__
. "($code): cache missing, need to make one\n" );
389 foreach ( $deps as $dep ) {
390 // Because we're unserializing stuff from cache, we
391 // could receive objects of classes that don't exist
392 // anymore (e.g. uninstalled extensions)
393 // When this happens, always expire the cache
394 if ( !$dep instanceof CacheDependency ||
$dep->isExpired() ) {
395 wfDebug( __METHOD__
. "($code): cache for $code expired due to " .
396 get_class( $dep ) . "\n" );
405 * Initialise a language in this object. Rebuild the cache if necessary.
408 protected function initLanguage( $code ) {
409 if ( isset( $this->initialisedLangs
[$code] ) ) {
413 $this->initialisedLangs
[$code] = true;
415 # If the code is of the wrong form for a Messages*.php file, do a shallow fallback
416 if ( !Language
::isValidBuiltInCode( $code ) ) {
417 $this->initShallowFallback( $code, 'en' );
421 # Recache the data if necessary
422 if ( !$this->manualRecache
&& $this->isExpired( $code ) ) {
423 if ( file_exists( Language
::getMessagesFileName( $code ) ) ) {
424 $this->recache( $code );
425 } elseif ( $code === 'en' ) {
426 throw new MWException( 'MessagesEn.php is missing.' );
428 $this->initShallowFallback( $code, 'en' );
434 $preload = $this->getItem( $code, 'preload' );
435 if ( $preload === null ) {
436 if ( $this->manualRecache
) {
437 // No Messages*.php file. Do shallow fallback to en.
438 if ( $code === 'en' ) {
439 throw new MWException( 'No localisation cache found for English. ' .
440 'Please run maintenance/rebuildLocalisationCache.php.' );
442 $this->initShallowFallback( $code, 'en' );
445 throw new MWException( 'Invalid or missing localisation cache.' );
448 $this->data
[$code] = $preload;
449 foreach ( $preload as $key => $item ) {
450 if ( in_array( $key, self
::$splitKeys ) ) {
451 foreach ( $item as $subkey => $subitem ) {
452 $this->loadedSubitems
[$code][$key][$subkey] = true;
455 $this->loadedItems
[$code][$key] = true;
461 * Create a fallback from one language to another, without creating a
462 * complete persistent cache.
463 * @param $primaryCode
464 * @param $fallbackCode
466 public function initShallowFallback( $primaryCode, $fallbackCode ) {
467 $this->data
[$primaryCode] =& $this->data
[$fallbackCode];
468 $this->loadedItems
[$primaryCode] =& $this->loadedItems
[$fallbackCode];
469 $this->loadedSubitems
[$primaryCode] =& $this->loadedSubitems
[$fallbackCode];
470 $this->shallowFallbacks
[$primaryCode] = $fallbackCode;
474 * Read a PHP file containing localisation data.
479 protected function readPHPFile( $_fileName, $_fileType ) {
480 // Disable APC caching
481 $_apcEnabled = ini_set( 'apc.cache_by_default', '0' );
482 include( $_fileName );
483 ini_set( 'apc.cache_by_default', $_apcEnabled );
485 if ( $_fileType == 'core' ||
$_fileType == 'extension' ) {
486 $data = compact( self
::$allKeys );
487 } elseif ( $_fileType == 'aliases' ) {
488 $data = compact( 'aliases' );
490 throw new MWException( __METHOD__
. ": Invalid file type: $_fileType" );
496 * Get the compiled plural rules for a given language from the XML files.
499 public function getCompiledPluralRules( $code ) {
500 $rules = $this->getPluralRules( $code );
502 $compiledRules = CLDRPluralRuleEvaluator
::compile( $rules );
503 } catch( CLDRPluralRuleError
$e ) {
504 wfDebugLog( 'l10n', $e->getMessage() . "\n" );
507 return $compiledRules;
511 * Get the plural rules for a given language from the XML files.
515 public function getPluralRules( $code ) {
516 if ( $this->pluralRules
=== null ) {
517 $cldrPlural = __DIR__
. "/../languages/data/plurals.xml";
518 $mwPlural = __DIR__
. "/../languages/data/plurals-mediawiki.xml";
519 // Load CLDR plural rules
520 $this->loadPluralFile( $cldrPlural );
521 if ( file_exists( $mwPlural ) ) {
522 // Override or extend
523 $this->loadPluralFile( $mwPlural );
526 if ( !isset( $this->pluralRules
[$code] ) ) {
529 return $this->pluralRules
[$code];
534 * Load a plural XML file with the given filename, compile the relevant
535 * rules, and save the compiled rules in a process-local cache.
537 private function loadPluralFile( $fileName ) {
538 $doc = new DOMDocument
;
539 $doc->load( $fileName );
540 $rulesets = $doc->getElementsByTagName( "pluralRules" );
541 foreach ( $rulesets as $ruleset ) {
542 $codes = $ruleset->getAttribute( 'locales' );
544 $ruleElements = $ruleset->getElementsByTagName( "pluralRule" );
545 foreach ( $ruleElements as $elt ) {
546 $rules[] = $elt->nodeValue
;
548 foreach ( explode( ' ', $codes ) as $code ) {
549 $this->pluralRules
[$code] = $rules;
555 * Merge two localisation values, a primary and a fallback, overwriting the
556 * primary value in place.
559 * @param $fallbackValue
561 protected function mergeItem( $key, &$value, $fallbackValue ) {
562 if ( !is_null( $value ) ) {
563 if ( !is_null( $fallbackValue ) ) {
564 if ( in_array( $key, self
::$mergeableMapKeys ) ) {
565 $value = $value +
$fallbackValue;
566 } elseif ( in_array( $key, self
::$mergeableListKeys ) ) {
567 $value = array_unique( array_merge( $fallbackValue, $value ) );
568 } elseif ( in_array( $key, self
::$mergeableAliasListKeys ) ) {
569 $value = array_merge_recursive( $value, $fallbackValue );
570 } elseif ( in_array( $key, self
::$optionalMergeKeys ) ) {
571 if ( !empty( $value['inherit'] ) ) {
572 $value = array_merge( $fallbackValue, $value );
575 if ( isset( $value['inherit'] ) ) {
576 unset( $value['inherit'] );
578 } elseif ( in_array( $key, self
::$magicWordKeys ) ) {
579 $this->mergeMagicWords( $value, $fallbackValue );
583 $value = $fallbackValue;
589 * @param $fallbackValue
591 protected function mergeMagicWords( &$value, $fallbackValue ) {
592 foreach ( $fallbackValue as $magicName => $fallbackInfo ) {
593 if ( !isset( $value[$magicName] ) ) {
594 $value[$magicName] = $fallbackInfo;
596 $oldSynonyms = array_slice( $fallbackInfo, 1 );
597 $newSynonyms = array_slice( $value[$magicName], 1 );
598 $synonyms = array_values( array_unique( array_merge(
599 $newSynonyms, $oldSynonyms ) ) );
600 $value[$magicName] = array_merge( array( $fallbackInfo[0] ), $synonyms );
606 * Given an array mapping language code to localisation value, such as is
607 * found in extension *.i18n.php files, iterate through a fallback sequence
608 * to merge the given data with an existing primary value.
610 * Returns true if any data from the extension array was used, false
612 * @param $codeSequence
615 * @param $fallbackValue
618 protected function mergeExtensionItem( $codeSequence, $key, &$value, $fallbackValue ) {
620 foreach ( $codeSequence as $code ) {
621 if ( isset( $fallbackValue[$code] ) ) {
622 $this->mergeItem( $key, $value, $fallbackValue[$code] );
631 * Load localisation data for a given language for both core and extensions
632 * and save it to the persistent cache store and the process cache
635 public function recache( $code ) {
636 global $wgExtensionMessagesFiles;
637 wfProfileIn( __METHOD__
);
640 throw new MWException( "Invalid language code requested" );
642 $this->recachedLangs
[$code] = true;
645 $initialData = array_combine(
647 array_fill( 0, count( self
::$allKeys ), null ) );
648 $coreData = $initialData;
651 # Load the primary localisation from the source file
652 $fileName = Language
::getMessagesFileName( $code );
653 if ( !file_exists( $fileName ) ) {
654 wfDebug( __METHOD__
. ": no localisation file for $code, using fallback to en\n" );
655 $coreData['fallback'] = 'en';
657 $deps[] = new FileDependency( $fileName );
658 $data = $this->readPHPFile( $fileName, 'core' );
659 wfDebug( __METHOD__
. ": got localisation for $code from source\n" );
661 # Merge primary localisation
662 foreach ( $data as $key => $value ) {
663 $this->mergeItem( $key, $coreData[$key], $value );
668 # Fill in the fallback if it's not there already
669 if ( is_null( $coreData['fallback'] ) ) {
670 $coreData['fallback'] = $code === 'en' ?
false : 'en';
672 if ( $coreData['fallback'] === false ) {
673 $coreData['fallbackSequence'] = array();
675 $coreData['fallbackSequence'] = array_map( 'trim', explode( ',', $coreData['fallback'] ) );
676 $len = count( $coreData['fallbackSequence'] );
678 # Ensure that the sequence ends at en
679 if ( $coreData['fallbackSequence'][$len - 1] !== 'en' ) {
680 $coreData['fallbackSequence'][] = 'en';
683 # Load the fallback localisation item by item and merge it
684 foreach ( $coreData['fallbackSequence'] as $fbCode ) {
685 # Load the secondary localisation from the source file to
686 # avoid infinite cycles on cyclic fallbacks
687 $fbFilename = Language
::getMessagesFileName( $fbCode );
689 if ( !file_exists( $fbFilename ) ) {
693 $deps[] = new FileDependency( $fbFilename );
694 $fbData = $this->readPHPFile( $fbFilename, 'core' );
696 foreach ( self
::$allKeys as $key ) {
697 if ( !isset( $fbData[$key] ) ) {
701 if ( is_null( $coreData[$key] ) ||
$this->isMergeableKey( $key ) ) {
702 $this->mergeItem( $key, $coreData[$key], $fbData[$key] );
708 $codeSequence = array_merge( array( $code ), $coreData['fallbackSequence'] );
710 # Load the extension localisations
711 # This is done after the core because we know the fallback sequence now.
712 # But it has a higher precedence for merging so that we can support things
713 # like site-specific message overrides.
714 $allData = $initialData;
715 foreach ( $wgExtensionMessagesFiles as $fileName ) {
716 $data = $this->readPHPFile( $fileName, 'extension' );
719 foreach ( $data as $key => $item ) {
720 if ( $this->mergeExtensionItem( $codeSequence, $key, $allData[$key], $item ) ) {
726 $deps[] = new FileDependency( $fileName );
730 # Merge core data into extension data
731 foreach ( $coreData as $key => $item ) {
732 $this->mergeItem( $key, $allData[$key], $item );
735 # Add cache dependencies for any referenced globals
736 $deps['wgExtensionMessagesFiles'] = new GlobalDependency( 'wgExtensionMessagesFiles' );
737 $deps['version'] = new ConstantDependency( 'MW_LC_VERSION' );
739 # Add dependencies to the cache entry
740 $allData['deps'] = $deps;
742 # Replace spaces with underscores in namespace names
743 $allData['namespaceNames'] = str_replace( ' ', '_', $allData['namespaceNames'] );
745 # And do the same for special page aliases. $page is an array.
746 foreach ( $allData['specialPageAliases'] as &$page ) {
747 $page = str_replace( ' ', '_', $page );
749 # Decouple the reference to prevent accidental damage
753 $allData['list'] = array();
754 foreach ( self
::$splitKeys as $key ) {
755 $allData['list'][$key] = array_keys( $allData[$key] );
757 # Load CLDR plural rules for JavaScript
758 $allData['pluralRules'] = $this->getPluralRules( $code );
760 $allData['compiledPluralRules'] = $this->getCompiledPluralRules( $code );
762 wfRunHooks( 'LocalisationCacheRecache', array( $this, $code, &$allData ) );
764 if ( is_null( $allData['namespaceNames'] ) ) {
765 throw new MWException( __METHOD__
. ': Localisation data failed sanity check! ' .
766 'Check that your languages/messages/MessagesEn.php file is intact.' );
769 # Set the preload key
770 $allData['preload'] = $this->buildPreload( $allData );
772 # Save to the process cache and register the items loaded
773 $this->data
[$code] = $allData;
774 foreach ( $allData as $key => $item ) {
775 $this->loadedItems
[$code][$key] = true;
778 # Save to the persistent cache
779 $this->store
->startWrite( $code );
780 foreach ( $allData as $key => $value ) {
781 if ( in_array( $key, self
::$splitKeys ) ) {
782 foreach ( $value as $subkey => $subvalue ) {
783 $this->store
->set( "$key:$subkey", $subvalue );
786 $this->store
->set( $key, $value );
789 $this->store
->finishWrite();
791 # Clear out the MessageBlobStore
792 # HACK: If using a null (i.e. disabled) storage backend, we
793 # can't write to the MessageBlobStore either
794 if ( !$this->store
instanceof LCStore_Null
) {
795 MessageBlobStore
::clear();
798 wfProfileOut( __METHOD__
);
802 * Build the preload item from the given pre-cache data.
804 * The preload item will be loaded automatically, improving performance
805 * for the commonly-requested items it contains.
809 protected function buildPreload( $data ) {
810 $preload = array( 'messages' => array() );
811 foreach ( self
::$preloadedKeys as $key ) {
812 $preload[$key] = $data[$key];
815 foreach ( $data['preloadedMessages'] as $subkey ) {
816 if ( isset( $data['messages'][$subkey] ) ) {
817 $subitem = $data['messages'][$subkey];
821 $preload['messages'][$subkey] = $subitem;
828 * Unload the data for a given language from the object cache.
829 * Reduces memory usage.
832 public function unload( $code ) {
833 unset( $this->data
[$code] );
834 unset( $this->loadedItems
[$code] );
835 unset( $this->loadedSubitems
[$code] );
836 unset( $this->initialisedLangs
[$code] );
838 foreach ( $this->shallowFallbacks
as $shallowCode => $fbCode ) {
839 if ( $fbCode === $code ) {
840 $this->unload( $shallowCode );
848 public function unloadAll() {
849 foreach ( $this->initialisedLangs
as $lang => $unused ) {
850 $this->unload( $lang );
855 * Disable the storage backend
857 public function disableBackend() {
858 $this->store
= new LCStore_Null
;
859 $this->manualRecache
= false;
864 * Interface for the persistence layer of LocalisationCache.
866 * The persistence layer is two-level hierarchical cache. The first level
867 * is the language, the second level is the item or subitem.
869 * Since the data for a whole language is rebuilt in one operation, it needs
870 * to have a fast and atomic method for deleting or replacing all of the
871 * current data for a given language. The interface reflects this bulk update
872 * operation. Callers writing to the cache must first call startWrite(), then
873 * will call set() a couple of thousand times, then will call finishWrite()
874 * to commit the operation. When finishWrite() is called, the cache is
875 * expected to delete all data previously stored for that language.
877 * The values stored are PHP variables suitable for serialize(). Implementations
878 * of LCStore are responsible for serializing and unserializing.
883 * @param $code string Language code
884 * @param $key string Cache key
886 function get( $code, $key );
889 * Start a write transaction.
890 * @param $code Language code
892 function startWrite( $code );
895 * Finish a write transaction.
897 function finishWrite();
900 * Set a key to a given value. startWrite() must be called before this
901 * is called, and finishWrite() must be called afterwards.
905 function set( $key, $value );
909 * LCStore implementation which uses PHP accelerator to store data.
910 * This will work if one of XCache, WinCache or APC cacher is configured.
911 * (See ObjectCache.php)
913 class LCStore_Accel
implements LCStore
{
917 public function __construct() {
918 $this->cache
= wfGetCache( CACHE_ACCEL
);
921 public function get( $code, $key ) {
922 $k = wfMemcKey( 'l10n', $code, 'k', $key );
923 $r = $this->cache
->get( $k );
924 return $r === false ?
null : $r;
927 public function startWrite( $code ) {
928 $k = wfMemcKey( 'l10n', $code, 'l' );
929 $keys = $this->cache
->get( $k );
931 foreach ( $keys as $k ) {
932 $this->cache
->delete( $k );
935 $this->currentLang
= $code;
936 $this->keys
= array();
939 public function finishWrite() {
940 if ( $this->currentLang
) {
941 $k = wfMemcKey( 'l10n', $this->currentLang
, 'l' );
942 $this->cache
->set( $k, array_keys( $this->keys
) );
944 $this->currentLang
= null;
945 $this->keys
= array();
948 public function set( $key, $value ) {
949 if ( $this->currentLang
) {
950 $k = wfMemcKey( 'l10n', $this->currentLang
, 'k', $key );
951 $this->keys
[$k] = true;
952 $this->cache
->set( $k, $value );
958 * LCStore implementation which uses the standard DB functions to store data.
959 * This will work on any MediaWiki installation.
961 class LCStore_DB
implements LCStore
{
963 var $writesDone = false;
970 var $readOnly = false;
972 public function get( $code, $key ) {
973 if ( $this->writesDone
) {
974 $db = wfGetDB( DB_MASTER
);
976 $db = wfGetDB( DB_SLAVE
);
978 $row = $db->selectRow( 'l10n_cache', array( 'lc_value' ),
979 array( 'lc_lang' => $code, 'lc_key' => $key ), __METHOD__
);
981 return unserialize( $row->lc_value
);
987 public function startWrite( $code ) {
988 if ( $this->readOnly
) {
993 throw new MWException( __METHOD__
. ": Invalid language \"$code\"" );
996 $this->dbw
= wfGetDB( DB_MASTER
);
998 $this->dbw
->begin( __METHOD__
);
999 $this->dbw
->delete( 'l10n_cache', array( 'lc_lang' => $code ), __METHOD__
);
1000 } catch ( DBQueryError
$e ) {
1001 if ( $this->dbw
->wasReadOnlyError() ) {
1002 $this->readOnly
= true;
1003 $this->dbw
->rollback( __METHOD__
);
1004 $this->dbw
->ignoreErrors( false );
1011 $this->currentLang
= $code;
1012 $this->batch
= array();
1015 public function finishWrite() {
1016 if ( $this->readOnly
) {
1020 if ( $this->batch
) {
1021 $this->dbw
->insert( 'l10n_cache', $this->batch
, __METHOD__
);
1024 $this->dbw
->commit( __METHOD__
);
1025 $this->currentLang
= null;
1027 $this->batch
= array();
1028 $this->writesDone
= true;
1031 public function set( $key, $value ) {
1032 if ( $this->readOnly
) {
1036 if ( is_null( $this->currentLang
) ) {
1037 throw new MWException( __CLASS__
. ': must call startWrite() before calling set()' );
1040 $this->batch
[] = array(
1041 'lc_lang' => $this->currentLang
,
1043 'lc_value' => serialize( $value ) );
1045 if ( count( $this->batch
) >= 100 ) {
1046 $this->dbw
->insert( 'l10n_cache', $this->batch
, __METHOD__
);
1047 $this->batch
= array();
1053 * LCStore implementation which stores data as a collection of CDB files in the
1054 * directory given by $wgCacheDirectory. If $wgCacheDirectory is not set, this
1055 * will throw an exception.
1057 * Profiling indicates that on Linux, this implementation outperforms MySQL if
1058 * the directory is on a local filesystem and there is ample kernel cache
1059 * space. The performance advantage is greater when the DBA extension is
1060 * available than it is with the PHP port.
1062 * See Cdb.php and http://cr.yp.to/cdb.html
1064 class LCStore_CDB
implements LCStore
{
1065 var $readers, $writer, $currentLang, $directory;
1067 function __construct( $conf = array() ) {
1068 global $wgCacheDirectory;
1070 if ( isset( $conf['directory'] ) ) {
1071 $this->directory
= $conf['directory'];
1073 $this->directory
= $wgCacheDirectory;
1077 public function get( $code, $key ) {
1078 if ( !isset( $this->readers
[$code] ) ) {
1079 $fileName = $this->getFileName( $code );
1081 if ( !file_exists( $fileName ) ) {
1082 $this->readers
[$code] = false;
1084 $this->readers
[$code] = CdbReader
::open( $fileName );
1088 if ( !$this->readers
[$code] ) {
1091 $value = $this->readers
[$code]->get( $key );
1093 if ( $value === false ) {
1096 return unserialize( $value );
1100 public function startWrite( $code ) {
1101 if ( !file_exists( $this->directory
) ) {
1102 if ( !wfMkdirParents( $this->directory
, null, __METHOD__
) ) {
1103 throw new MWException( "Unable to create the localisation store " .
1104 "directory \"{$this->directory}\"" );
1108 // Close reader to stop permission errors on write
1109 if ( !empty( $this->readers
[$code] ) ) {
1110 $this->readers
[$code]->close();
1113 $this->writer
= CdbWriter
::open( $this->getFileName( $code ) );
1114 $this->currentLang
= $code;
1117 public function finishWrite() {
1119 $this->writer
->close();
1120 $this->writer
= null;
1121 unset( $this->readers
[$this->currentLang
] );
1122 $this->currentLang
= null;
1125 public function set( $key, $value ) {
1126 if ( is_null( $this->writer
) ) {
1127 throw new MWException( __CLASS__
. ': must call startWrite() before calling set()' );
1129 $this->writer
->set( $key, serialize( $value ) );
1132 protected function getFileName( $code ) {
1133 if ( !$code ||
strpos( $code, '/' ) !== false ) {
1134 throw new MWException( __METHOD__
. ": Invalid language \"$code\"" );
1136 return "{$this->directory}/l10n_cache-$code.cdb";
1141 * Null store backend, used to avoid DB errors during install
1143 class LCStore_Null
implements LCStore
{
1144 public function get( $code, $key ) {
1148 public function startWrite( $code ) {}
1149 public function finishWrite() {}
1150 public function set( $key, $value ) {}
1154 * A localisation cache optimised for loading large amounts of data for many
1155 * languages. Used by rebuildLocalisationCache.php.
1157 class LocalisationCache_BulkLoad
extends LocalisationCache
{
1159 * A cache of the contents of data files.
1160 * Core files are serialized to avoid using ~1GB of RAM during a recache.
1162 var $fileCache = array();
1165 * Most recently used languages. Uses the linked-list aspect of PHP hashtables
1166 * to keep the most recently used language codes at the end of the array, and
1167 * the language codes that are ready to be deleted at the beginning.
1169 var $mruLangs = array();
1172 * Maximum number of languages that may be loaded into $this->data
1174 var $maxLoadedLangs = 10;
1179 * @return array|mixed
1181 protected function readPHPFile( $fileName, $fileType ) {
1182 $serialize = $fileType === 'core';
1183 if ( !isset( $this->fileCache
[$fileName][$fileType] ) ) {
1184 $data = parent
::readPHPFile( $fileName, $fileType );
1187 $encData = serialize( $data );
1192 $this->fileCache
[$fileName][$fileType] = $encData;
1195 } elseif ( $serialize ) {
1196 return unserialize( $this->fileCache
[$fileName][$fileType] );
1198 return $this->fileCache
[$fileName][$fileType];
1207 public function getItem( $code, $key ) {
1208 unset( $this->mruLangs
[$code] );
1209 $this->mruLangs
[$code] = true;
1210 return parent
::getItem( $code, $key );
1219 public function getSubitem( $code, $key, $subkey ) {
1220 unset( $this->mruLangs
[$code] );
1221 $this->mruLangs
[$code] = true;
1222 return parent
::getSubitem( $code, $key, $subkey );
1228 public function recache( $code ) {
1229 parent
::recache( $code );
1230 unset( $this->mruLangs
[$code] );
1231 $this->mruLangs
[$code] = true;
1238 public function unload( $code ) {
1239 unset( $this->mruLangs
[$code] );
1240 parent
::unload( $code );
1244 * Unload cached languages until there are less than $this->maxLoadedLangs
1246 protected function trimCache() {
1247 while ( count( $this->data
) > $this->maxLoadedLangs
&& count( $this->mruLangs
) ) {
1248 reset( $this->mruLangs
);
1249 $code = key( $this->mruLangs
);
1250 wfDebug( __METHOD__
. ": unloading $code\n" );
1251 $this->unload( $code );