3 define( 'MW_LC_VERSION', 2 );
6 * Class for caching the contents of localisation files, Messages*.php
9 * An instance of this class is available using Language::getLocalisationCache().
11 * The values retrieved from here are merged, containing items from extension
12 * files, core messages files and the language fallback sequence (e.g. zh-cn ->
13 * zh-hans -> en ). Some common errors are corrected, for example namespace
14 * names with spaces instead of underscores, but heavyweight processing, such
15 * as grammatical transformation, is done by the caller.
17 class LocalisationCache
{
18 /** Configuration associative array */
22 * True if recaching should only be done on an explicit call to recache().
23 * Setting this reduces the overhead of cache freshness checking, which
24 * requires doing a stat() for every extension i18n file.
26 var $manualRecache = false;
29 * True to treat all files as expired until they are regenerated by this object.
31 var $forceRecache = false;
34 * The cache data. 3-d array, where the first key is the language code,
35 * the second key is the item key e.g. 'messages', and the third key is
36 * an item specific subkey index. Some items are not arrays and so for those
37 * items, there are no subkeys.
42 * The persistent store object. An instance of LCStore.
49 * A 2-d associative array, code/key, where presence indicates that the item
50 * is loaded. Value arbitrary.
52 * For split items, if set, this indicates that all of the subitems have been
55 var $loadedItems = array();
58 * A 3-d associative array, code/key/subkey, where presence indicates that
59 * the subitem is loaded. Only used for the split items, i.e. messages.
61 var $loadedSubitems = array();
64 * An array where presence of a key indicates that that language has been
65 * initialised. Initialisation includes checking for cache expiry and doing
66 * any necessary updates.
68 var $initialisedLangs = array();
71 * An array mapping non-existent pseudo-languages to fallback languages. This
72 * is filled by initShallowFallback() when data is requested from a language
73 * that lacks a Messages*.php file.
75 var $shallowFallbacks = array();
78 * An array where the keys are codes that have been recached by this instance.
80 var $recachedLangs = array();
85 static public $allKeys = array(
86 'fallback', 'namespaceNames', 'bookstoreList',
87 'magicWords', 'messages', 'rtl', 'capitalizeAllNouns', 'digitTransformTable',
88 'separatorTransformTable', 'fallback8bitEncoding', 'linkPrefixExtension',
89 'linkTrail', 'namespaceAliases',
90 'dateFormats', 'datePreferences', 'datePreferenceMigrationMap',
91 'defaultDateFormat', 'extraUserToggles', 'specialPageAliases',
92 'imageFiles', 'preloadedMessages', 'namespaceGenderAliases',
93 'digitGroupingPattern'
97 * Keys for items which consist of associative arrays, which may be merged
98 * by a fallback sequence.
100 static public $mergeableMapKeys = array( 'messages', 'namespaceNames',
101 'dateFormats', 'imageFiles', 'preloadedMessages',
105 * Keys for items which are a numbered array.
107 static public $mergeableListKeys = array( 'extraUserToggles' );
110 * Keys for items which contain an array of arrays of equivalent aliases
111 * for each subitem. The aliases may be merged by a fallback sequence.
113 static public $mergeableAliasListKeys = array( 'specialPageAliases' );
116 * Keys for items which contain an associative array, and may be merged if
117 * the primary value contains the special array key "inherit". That array
118 * key is removed after the first merge.
120 static public $optionalMergeKeys = array( 'bookstoreList' );
123 * Keys for items that are formatted like $magicWords
125 static public $magicWordKeys = array( 'magicWords' );
128 * Keys for items where the subitems are stored in the backend separately.
130 static public $splitKeys = array( 'messages' );
133 * Keys which are loaded automatically by initLanguage()
135 static public $preloadedKeys = array( 'dateFormats', 'namespaceNames' );
137 var $mergeableKeys = null;
141 * For constructor parameters, see the documentation in DefaultSettings.php
142 * for $wgLocalisationCacheConf.
146 function __construct( $conf ) {
147 global $wgCacheDirectory;
150 $storeConf = array();
151 if ( !empty( $conf['storeClass'] ) ) {
152 $storeClass = $conf['storeClass'];
154 switch ( $conf['store'] ) {
157 $storeClass = 'LCStore_CDB';
160 $storeClass = 'LCStore_DB';
164 if ( !( wfGetCache( CACHE_ACCEL
) instanceof FakeMemCachedClient
) ) {
165 $storeClass = 'LCStore_Accel';
167 $storeClass = $wgCacheDirectory ?
'LCStore_CDB' : 'LCStore_DB';
171 throw new MWException(
172 'Please set $wgLocalisationCacheConf[\'store\'] to something sensible.' );
176 wfDebug( get_class( $this ) . ": using store $storeClass\n" );
177 if ( !empty( $conf['storeDirectory'] ) ) {
178 $storeConf['directory'] = $conf['storeDirectory'];
181 $this->store
= new $storeClass( $storeConf );
182 foreach ( array( 'manualRecache', 'forceRecache' ) as $var ) {
183 if ( isset( $conf[$var] ) ) {
184 $this->$var = $conf[$var];
190 * Returns true if the given key is mergeable, that is, if it is an associative
191 * array which can be merged through a fallback sequence.
195 public function isMergeableKey( $key ) {
196 if ( !isset( $this->mergeableKeys
) ) {
197 $this->mergeableKeys
= array_flip( array_merge(
198 self
::$mergeableMapKeys,
199 self
::$mergeableListKeys,
200 self
::$mergeableAliasListKeys,
201 self
::$optionalMergeKeys,
205 return isset( $this->mergeableKeys
[$key] );
211 * Warning: this may be slow for split items (messages), since it will
212 * need to fetch all of the subitems from the cache individually.
217 public function getItem( $code, $key ) {
218 if ( !isset( $this->loadedItems
[$code][$key] ) ) {
219 wfProfileIn( __METHOD__
.'-load' );
220 $this->loadItem( $code, $key );
221 wfProfileOut( __METHOD__
.'-load' );
224 if ( $key === 'fallback' && isset( $this->shallowFallbacks
[$code] ) ) {
225 return $this->shallowFallbacks
[$code];
228 return $this->data
[$code][$key];
232 * Get a subitem, for instance a single message for a given language.
238 public function getSubitem( $code, $key, $subkey ) {
239 if ( !isset( $this->loadedSubitems
[$code][$key][$subkey] ) &&
240 !isset( $this->loadedItems
[$code][$key] ) ) {
241 wfProfileIn( __METHOD__
.'-load' );
242 $this->loadSubitem( $code, $key, $subkey );
243 wfProfileOut( __METHOD__
.'-load' );
246 if ( isset( $this->data
[$code][$key][$subkey] ) ) {
247 return $this->data
[$code][$key][$subkey];
254 * Get the list of subitem keys for a given item.
256 * This is faster than array_keys($lc->getItem(...)) for the items listed in
259 * Will return null if the item is not found, or false if the item is not an
263 * @return bool|null|string
265 public function getSubitemList( $code, $key ) {
266 if ( in_array( $key, self
::$splitKeys ) ) {
267 return $this->getSubitem( $code, 'list', $key );
269 $item = $this->getItem( $code, $key );
270 if ( is_array( $item ) ) {
271 return array_keys( $item );
279 * Load an item into the cache.
283 protected function loadItem( $code, $key ) {
284 if ( !isset( $this->initialisedLangs
[$code] ) ) {
285 $this->initLanguage( $code );
288 // Check to see if initLanguage() loaded it for us
289 if ( isset( $this->loadedItems
[$code][$key] ) ) {
293 if ( isset( $this->shallowFallbacks
[$code] ) ) {
294 $this->loadItem( $this->shallowFallbacks
[$code], $key );
298 if ( in_array( $key, self
::$splitKeys ) ) {
299 $subkeyList = $this->getSubitem( $code, 'list', $key );
300 foreach ( $subkeyList as $subkey ) {
301 if ( isset( $this->data
[$code][$key][$subkey] ) ) {
304 $this->data
[$code][$key][$subkey] = $this->getSubitem( $code, $key, $subkey );
307 $this->data
[$code][$key] = $this->store
->get( $code, $key );
310 $this->loadedItems
[$code][$key] = true;
314 * Load a subitem into the cache
320 protected function loadSubitem( $code, $key, $subkey ) {
321 if ( !in_array( $key, self
::$splitKeys ) ) {
322 $this->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] ) ||
332 isset( $this->loadedSubitems
[$code][$key][$subkey] ) ) {
336 if ( isset( $this->shallowFallbacks
[$code] ) ) {
337 $this->loadSubitem( $this->shallowFallbacks
[$code], $key, $subkey );
341 $value = $this->store
->get( $code, "$key:$subkey" );
342 $this->data
[$code][$key][$subkey] = $value;
343 $this->loadedSubitems
[$code][$key][$subkey] = true;
347 * Returns true if the cache identified by $code is missing or expired.
349 public function isExpired( $code ) {
350 if ( $this->forceRecache
&& !isset( $this->recachedLangs
[$code] ) ) {
351 wfDebug( __METHOD__
."($code): forced reload\n" );
355 $deps = $this->store
->get( $code, 'deps' );
356 $keys = $this->store
->get( $code, 'list', 'messages' );
357 // 'list:messages' sometimes expires separately of 'deps' in LCStore_Accel
358 if ( $deps === null ||
$keys === null ) {
359 wfDebug( __METHOD__
."($code): cache missing, need to make one\n" );
363 foreach ( $deps as $dep ) {
364 // Because we're unserializing stuff from cache, we
365 // could receive objects of classes that don't exist
366 // anymore (e.g. uninstalled extensions)
367 // When this happens, always expire the cache
368 if ( !$dep instanceof CacheDependency ||
$dep->isExpired() ) {
369 wfDebug( __METHOD__
."($code): cache for $code expired due to " .
370 get_class( $dep ) . "\n" );
379 * Initialise a language in this object. Rebuild the cache if necessary.
382 protected function initLanguage( $code ) {
383 if ( isset( $this->initialisedLangs
[$code] ) ) {
387 $this->initialisedLangs
[$code] = true;
389 # If the code is of the wrong form for a Messages*.php file, do a shallow fallback
390 if ( !Language
::isValidBuiltInCode( $code ) ) {
391 $this->initShallowFallback( $code, 'en' );
395 # Recache the data if necessary
396 if ( !$this->manualRecache
&& $this->isExpired( $code ) ) {
397 if ( file_exists( Language
::getMessagesFileName( $code ) ) ) {
398 $this->recache( $code );
399 } elseif ( $code === 'en' ) {
400 throw new MWException( 'MessagesEn.php is missing.' );
402 $this->initShallowFallback( $code, 'en' );
408 $preload = $this->getItem( $code, 'preload' );
409 if ( $preload === null ) {
410 if ( $this->manualRecache
) {
411 // No Messages*.php file. Do shallow fallback to en.
412 if ( $code === 'en' ) {
413 throw new MWException( 'No localisation cache found for English. ' .
414 'Please run maintenance/rebuildLocalisationCache.php.' );
416 $this->initShallowFallback( $code, 'en' );
419 throw new MWException( 'Invalid or missing localisation cache.' );
422 $this->data
[$code] = $preload;
423 foreach ( $preload as $key => $item ) {
424 if ( in_array( $key, self
::$splitKeys ) ) {
425 foreach ( $item as $subkey => $subitem ) {
426 $this->loadedSubitems
[$code][$key][$subkey] = true;
429 $this->loadedItems
[$code][$key] = true;
435 * Create a fallback from one language to another, without creating a
436 * complete persistent cache.
437 * @param $primaryCode
438 * @param $fallbackCode
440 public function initShallowFallback( $primaryCode, $fallbackCode ) {
441 $this->data
[$primaryCode] =& $this->data
[$fallbackCode];
442 $this->loadedItems
[$primaryCode] =& $this->loadedItems
[$fallbackCode];
443 $this->loadedSubitems
[$primaryCode] =& $this->loadedSubitems
[$fallbackCode];
444 $this->shallowFallbacks
[$primaryCode] = $fallbackCode;
448 * Read a PHP file containing localisation data.
453 protected function readPHPFile( $_fileName, $_fileType ) {
454 // Disable APC caching
455 $_apcEnabled = ini_set( 'apc.cache_by_default', '0' );
456 include( $_fileName );
457 ini_set( 'apc.cache_by_default', $_apcEnabled );
459 if ( $_fileType == 'core' ||
$_fileType == 'extension' ) {
460 $data = compact( self
::$allKeys );
461 } elseif ( $_fileType == 'aliases' ) {
462 $data = compact( 'aliases' );
464 throw new MWException( __METHOD__
.": Invalid file type: $_fileType" );
471 * Merge two localisation values, a primary and a fallback, overwriting the
472 * primary value in place.
475 * @param $fallbackValue
477 protected function mergeItem( $key, &$value, $fallbackValue ) {
478 if ( !is_null( $value ) ) {
479 if ( !is_null( $fallbackValue ) ) {
480 if ( in_array( $key, self
::$mergeableMapKeys ) ) {
481 $value = $value +
$fallbackValue;
482 } elseif ( in_array( $key, self
::$mergeableListKeys ) ) {
483 $value = array_unique( array_merge( $fallbackValue, $value ) );
484 } elseif ( in_array( $key, self
::$mergeableAliasListKeys ) ) {
485 $value = array_merge_recursive( $value, $fallbackValue );
486 } elseif ( in_array( $key, self
::$optionalMergeKeys ) ) {
487 if ( !empty( $value['inherit'] ) ) {
488 $value = array_merge( $fallbackValue, $value );
491 if ( isset( $value['inherit'] ) ) {
492 unset( $value['inherit'] );
494 } elseif ( in_array( $key, self
::$magicWordKeys ) ) {
495 $this->mergeMagicWords( $value, $fallbackValue );
499 $value = $fallbackValue;
505 * @param $fallbackValue
507 protected function mergeMagicWords( &$value, $fallbackValue ) {
508 foreach ( $fallbackValue as $magicName => $fallbackInfo ) {
509 if ( !isset( $value[$magicName] ) ) {
510 $value[$magicName] = $fallbackInfo;
512 $oldSynonyms = array_slice( $fallbackInfo, 1 );
513 $newSynonyms = array_slice( $value[$magicName], 1 );
514 $synonyms = array_values( array_unique( array_merge(
515 $newSynonyms, $oldSynonyms ) ) );
516 $value[$magicName] = array_merge( array( $fallbackInfo[0] ), $synonyms );
522 * Given an array mapping language code to localisation value, such as is
523 * found in extension *.i18n.php files, iterate through a fallback sequence
524 * to merge the given data with an existing primary value.
526 * Returns true if any data from the extension array was used, false
528 * @param $codeSequence
531 * @param $fallbackValue
534 protected function mergeExtensionItem( $codeSequence, $key, &$value, $fallbackValue ) {
536 foreach ( $codeSequence as $code ) {
537 if ( isset( $fallbackValue[$code] ) ) {
538 $this->mergeItem( $key, $value, $fallbackValue[$code] );
547 * Load localisation data for a given language for both core and extensions
548 * and save it to the persistent cache store and the process cache
551 public function recache( $code ) {
552 global $wgExtensionMessagesFiles, $wgExtensionAliasesFiles;
553 wfProfileIn( __METHOD__
);
556 throw new MWException( "Invalid language code requested" );
558 $this->recachedLangs
[$code] = true;
561 $initialData = array_combine(
563 array_fill( 0, count( self
::$allKeys ), null ) );
564 $coreData = $initialData;
567 # Load the primary localisation from the source file
568 $fileName = Language
::getMessagesFileName( $code );
569 if ( !file_exists( $fileName ) ) {
570 wfDebug( __METHOD__
.": no localisation file for $code, using fallback to en\n" );
571 $coreData['fallback'] = 'en';
573 $deps[] = new FileDependency( $fileName );
574 $data = $this->readPHPFile( $fileName, 'core' );
575 wfDebug( __METHOD__
.": got localisation for $code from source\n" );
577 # Merge primary localisation
578 foreach ( $data as $key => $value ) {
579 $this->mergeItem( $key, $coreData[$key], $value );
584 # Fill in the fallback if it's not there already
585 if ( is_null( $coreData['fallback'] ) ) {
586 $coreData['fallback'] = $code === 'en' ?
false : 'en';
589 if ( $coreData['fallback'] === false ) {
590 $coreData['fallbackSequence'] = array();
592 $coreData['fallbackSequence'] = array_map( 'trim', explode( ',', $coreData['fallback'] ) );
593 $len = count( $coreData['fallbackSequence'] );
595 # Ensure that the sequence ends at en
596 if ( $coreData['fallbackSequence'][$len - 1] !== 'en' ) {
597 $coreData['fallbackSequence'][] = 'en';
600 # Load the fallback localisation item by item and merge it
601 foreach ( $coreData['fallbackSequence'] as $fbCode ) {
602 # Load the secondary localisation from the source file to
603 # avoid infinite cycles on cyclic fallbacks
604 $fbFilename = Language
::getMessagesFileName( $fbCode );
606 if ( !file_exists( $fbFilename ) ) {
610 $deps[] = new FileDependency( $fbFilename );
611 $fbData = $this->readPHPFile( $fbFilename, 'core' );
613 foreach ( self
::$allKeys as $key ) {
614 if ( !isset( $fbData[$key] ) ) {
618 if ( is_null( $coreData[$key] ) ||
$this->isMergeableKey( $key ) ) {
619 $this->mergeItem( $key, $coreData[$key], $fbData[$key] );
625 $codeSequence = array_merge( array( $code ), $coreData['fallbackSequence'] );
627 # Load the extension localisations
628 # This is done after the core because we know the fallback sequence now.
629 # But it has a higher precedence for merging so that we can support things
630 # like site-specific message overrides.
631 $allData = $initialData;
632 foreach ( $wgExtensionMessagesFiles as $fileName ) {
633 $data = $this->readPHPFile( $fileName, 'extension' );
636 foreach ( $data as $key => $item ) {
637 if( $this->mergeExtensionItem( $codeSequence, $key, $allData[$key], $item ) ) {
643 $deps[] = new FileDependency( $fileName );
647 # Load deprecated $wgExtensionAliasesFiles
648 foreach ( $wgExtensionAliasesFiles as $fileName ) {
649 $data = $this->readPHPFile( $fileName, 'aliases' );
651 if ( !isset( $data['aliases'] ) ) {
655 $used = $this->mergeExtensionItem( $codeSequence, 'specialPageAliases',
656 $allData['specialPageAliases'], $data['aliases'] );
659 $deps[] = new FileDependency( $fileName );
663 # Merge core data into extension data
664 foreach ( $coreData as $key => $item ) {
665 $this->mergeItem( $key, $allData[$key], $item );
668 # Add cache dependencies for any referenced globals
669 $deps['wgExtensionMessagesFiles'] = new GlobalDependency( 'wgExtensionMessagesFiles' );
670 $deps['wgExtensionAliasesFiles'] = new GlobalDependency( 'wgExtensionAliasesFiles' );
671 $deps['version'] = new ConstantDependency( 'MW_LC_VERSION' );
673 # Add dependencies to the cache entry
674 $allData['deps'] = $deps;
676 # Replace spaces with underscores in namespace names
677 $allData['namespaceNames'] = str_replace( ' ', '_', $allData['namespaceNames'] );
679 # And do the same for special page aliases. $page is an array.
680 foreach ( $allData['specialPageAliases'] as &$page ) {
681 $page = str_replace( ' ', '_', $page );
683 # Decouple the reference to prevent accidental damage
687 $allData['list'] = array();
688 foreach ( self
::$splitKeys as $key ) {
689 $allData['list'][$key] = array_keys( $allData[$key] );
693 wfRunHooks( 'LocalisationCacheRecache', array( $this, $code, &$allData ) );
695 if ( is_null( $allData['namespaceNames'] ) ) {
696 throw new MWException( __METHOD__
.': Localisation data failed sanity check! ' .
697 'Check that your languages/messages/MessagesEn.php file is intact.' );
700 # Set the preload key
701 $allData['preload'] = $this->buildPreload( $allData );
703 # Save to the process cache and register the items loaded
704 $this->data
[$code] = $allData;
705 foreach ( $allData as $key => $item ) {
706 $this->loadedItems
[$code][$key] = true;
709 # Save to the persistent cache
710 $this->store
->startWrite( $code );
711 foreach ( $allData as $key => $value ) {
712 if ( in_array( $key, self
::$splitKeys ) ) {
713 foreach ( $value as $subkey => $subvalue ) {
714 $this->store
->set( "$key:$subkey", $subvalue );
717 $this->store
->set( $key, $value );
720 $this->store
->finishWrite();
722 # Clear out the MessageBlobStore
723 # HACK: If using a null (i.e. disabled) storage backend, we
724 # can't write to the MessageBlobStore either
725 if ( !$this->store
instanceof LCStore_Null
) {
726 MessageBlobStore
::clear();
729 wfProfileOut( __METHOD__
);
733 * Build the preload item from the given pre-cache data.
735 * The preload item will be loaded automatically, improving performance
736 * for the commonly-requested items it contains.
740 protected function buildPreload( $data ) {
741 $preload = array( 'messages' => array() );
742 foreach ( self
::$preloadedKeys as $key ) {
743 $preload[$key] = $data[$key];
746 foreach ( $data['preloadedMessages'] as $subkey ) {
747 if ( isset( $data['messages'][$subkey] ) ) {
748 $subitem = $data['messages'][$subkey];
752 $preload['messages'][$subkey] = $subitem;
759 * Unload the data for a given language from the object cache.
760 * Reduces memory usage.
763 public function unload( $code ) {
764 unset( $this->data
[$code] );
765 unset( $this->loadedItems
[$code] );
766 unset( $this->loadedSubitems
[$code] );
767 unset( $this->initialisedLangs
[$code] );
769 foreach ( $this->shallowFallbacks
as $shallowCode => $fbCode ) {
770 if ( $fbCode === $code ) {
771 $this->unload( $shallowCode );
779 public function unloadAll() {
780 foreach ( $this->initialisedLangs
as $lang => $unused ) {
781 $this->unload( $lang );
786 * Disable the storage backend
788 public function disableBackend() {
789 $this->store
= new LCStore_Null
;
790 $this->manualRecache
= false;
795 * Interface for the persistence layer of LocalisationCache.
797 * The persistence layer is two-level hierarchical cache. The first level
798 * is the language, the second level is the item or subitem.
800 * Since the data for a whole language is rebuilt in one operation, it needs
801 * to have a fast and atomic method for deleting or replacing all of the
802 * current data for a given language. The interface reflects this bulk update
803 * operation. Callers writing to the cache must first call startWrite(), then
804 * will call set() a couple of thousand times, then will call finishWrite()
805 * to commit the operation. When finishWrite() is called, the cache is
806 * expected to delete all data previously stored for that language.
808 * The values stored are PHP variables suitable for serialize(). Implementations
809 * of LCStore are responsible for serializing and unserializing.
814 * @param $code Language code
815 * @param $key Cache key
817 function get( $code, $key );
820 * Start a write transaction.
821 * @param $code Language code
823 function startWrite( $code );
826 * Finish a write transaction.
828 function finishWrite();
831 * Set a key to a given value. startWrite() must be called before this
832 * is called, and finishWrite() must be called afterwards.
836 function set( $key, $value );
840 * LCStore implementation which uses PHP accelerator to store data.
841 * This will work if one of XCache, eAccelerator, or APC cacher is configured.
842 * (See ObjectCache.php)
844 class LCStore_Accel
implements LCStore
{
848 public function __construct() {
849 $this->cache
= wfGetCache( CACHE_ACCEL
);
852 public function get( $code, $key ) {
853 $k = wfMemcKey( 'l10n', $code, 'k', $key );
854 return $this->cache
->get( $k );
857 public function startWrite( $code ) {
858 $k = wfMemcKey( 'l10n', $code, 'l' );
859 $keys = $this->cache
->get( $k );
861 foreach ( $keys as $k ) {
862 $this->cache
->delete( $k );
865 $this->currentLang
= $code;
866 $this->keys
= array();
869 public function finishWrite() {
870 if ( $this->currentLang
) {
871 $k = wfMemcKey( 'l10n', $this->currentLang
, 'l' );
872 $this->cache
->set( $k, array_keys( $this->keys
) );
874 $this->currentLang
= null;
875 $this->keys
= array();
878 public function set( $key, $value ) {
879 if ( $this->currentLang
) {
880 $k = wfMemcKey( 'l10n', $this->currentLang
, 'k', $key );
881 $this->keys
[$k] = true;
882 $this->cache
->set( $k, $value );
888 * LCStore implementation which uses the standard DB functions to store data.
889 * This will work on any MediaWiki installation.
891 class LCStore_DB
implements LCStore
{
893 var $writesDone = false;
900 var $readOnly = false;
902 public function get( $code, $key ) {
903 if ( $this->writesDone
) {
904 $db = wfGetDB( DB_MASTER
);
906 $db = wfGetDB( DB_SLAVE
);
908 $row = $db->selectRow( 'l10n_cache', array( 'lc_value' ),
909 array( 'lc_lang' => $code, 'lc_key' => $key ), __METHOD__
);
911 return unserialize( $row->lc_value
);
917 public function startWrite( $code ) {
918 if ( $this->readOnly
) {
923 throw new MWException( __METHOD__
.": Invalid language \"$code\"" );
926 $this->dbw
= wfGetDB( DB_MASTER
);
929 $this->dbw
->delete( 'l10n_cache', array( 'lc_lang' => $code ), __METHOD__
);
930 } catch ( DBQueryError
$e ) {
931 if ( $this->dbw
->wasReadOnlyError() ) {
932 $this->readOnly
= true;
933 $this->dbw
->rollback();
934 $this->dbw
->ignoreErrors( false );
941 $this->currentLang
= $code;
942 $this->batch
= array();
945 public function finishWrite() {
946 if ( $this->readOnly
) {
950 if ( $this->batch
) {
951 $this->dbw
->insert( 'l10n_cache', $this->batch
, __METHOD__
);
954 $this->dbw
->commit();
955 $this->currentLang
= null;
957 $this->batch
= array();
958 $this->writesDone
= true;
961 public function set( $key, $value ) {
962 if ( $this->readOnly
) {
966 if ( is_null( $this->currentLang
) ) {
967 throw new MWException( __CLASS__
.': must call startWrite() before calling set()' );
970 $this->batch
[] = array(
971 'lc_lang' => $this->currentLang
,
973 'lc_value' => serialize( $value ) );
975 if ( count( $this->batch
) >= 100 ) {
976 $this->dbw
->insert( 'l10n_cache', $this->batch
, __METHOD__
);
977 $this->batch
= array();
983 * LCStore implementation which stores data as a collection of CDB files in the
984 * directory given by $wgCacheDirectory. If $wgCacheDirectory is not set, this
985 * will throw an exception.
987 * Profiling indicates that on Linux, this implementation outperforms MySQL if
988 * the directory is on a local filesystem and there is ample kernel cache
989 * space. The performance advantage is greater when the DBA extension is
990 * available than it is with the PHP port.
992 * See Cdb.php and http://cr.yp.to/cdb.html
994 class LCStore_CDB
implements LCStore
{
995 var $readers, $writer, $currentLang, $directory;
997 function __construct( $conf = array() ) {
998 global $wgCacheDirectory;
1000 if ( isset( $conf['directory'] ) ) {
1001 $this->directory
= $conf['directory'];
1003 $this->directory
= $wgCacheDirectory;
1007 public function get( $code, $key ) {
1008 if ( !isset( $this->readers
[$code] ) ) {
1009 $fileName = $this->getFileName( $code );
1011 if ( !file_exists( $fileName ) ) {
1012 $this->readers
[$code] = false;
1014 $this->readers
[$code] = CdbReader
::open( $fileName );
1018 if ( !$this->readers
[$code] ) {
1021 $value = $this->readers
[$code]->get( $key );
1023 if ( $value === false ) {
1026 return unserialize( $value );
1030 public function startWrite( $code ) {
1031 if ( !file_exists( $this->directory
) ) {
1032 if ( !wfMkdirParents( $this->directory
, null, __METHOD__
) ) {
1033 throw new MWException( "Unable to create the localisation store " .
1034 "directory \"{$this->directory}\"" );
1038 // Close reader to stop permission errors on write
1039 if( !empty($this->readers
[$code]) ) {
1040 $this->readers
[$code]->close();
1043 $this->writer
= CdbWriter
::open( $this->getFileName( $code ) );
1044 $this->currentLang
= $code;
1047 public function finishWrite() {
1049 $this->writer
->close();
1050 $this->writer
= null;
1051 unset( $this->readers
[$this->currentLang
] );
1052 $this->currentLang
= null;
1055 public function set( $key, $value ) {
1056 if ( is_null( $this->writer
) ) {
1057 throw new MWException( __CLASS__
.': must call startWrite() before calling set()' );
1059 $this->writer
->set( $key, serialize( $value ) );
1062 protected function getFileName( $code ) {
1063 if ( !$code ||
strpos( $code, '/' ) !== false ) {
1064 throw new MWException( __METHOD__
.": Invalid language \"$code\"" );
1066 return "{$this->directory}/l10n_cache-$code.cdb";
1071 * Null store backend, used to avoid DB errors during install
1073 class LCStore_Null
implements LCStore
{
1074 public function get( $code, $key ) {
1078 public function startWrite( $code ) {}
1079 public function finishWrite() {}
1080 public function set( $key, $value ) {}
1084 * A localisation cache optimised for loading large amounts of data for many
1085 * languages. Used by rebuildLocalisationCache.php.
1087 class LocalisationCache_BulkLoad
extends LocalisationCache
{
1089 * A cache of the contents of data files.
1090 * Core files are serialized to avoid using ~1GB of RAM during a recache.
1092 var $fileCache = array();
1095 * Most recently used languages. Uses the linked-list aspect of PHP hashtables
1096 * to keep the most recently used language codes at the end of the array, and
1097 * the language codes that are ready to be deleted at the beginning.
1099 var $mruLangs = array();
1102 * Maximum number of languages that may be loaded into $this->data
1104 var $maxLoadedLangs = 10;
1109 * @return array|mixed
1111 protected function readPHPFile( $fileName, $fileType ) {
1112 $serialize = $fileType === 'core';
1113 if ( !isset( $this->fileCache
[$fileName][$fileType] ) ) {
1114 $data = parent
::readPHPFile( $fileName, $fileType );
1117 $encData = serialize( $data );
1122 $this->fileCache
[$fileName][$fileType] = $encData;
1125 } elseif ( $serialize ) {
1126 return unserialize( $this->fileCache
[$fileName][$fileType] );
1128 return $this->fileCache
[$fileName][$fileType];
1137 public function getItem( $code, $key ) {
1138 unset( $this->mruLangs
[$code] );
1139 $this->mruLangs
[$code] = true;
1140 return parent
::getItem( $code, $key );
1149 public function getSubitem( $code, $key, $subkey ) {
1150 unset( $this->mruLangs
[$code] );
1151 $this->mruLangs
[$code] = true;
1152 return parent
::getSubitem( $code, $key, $subkey );
1158 public function recache( $code ) {
1159 parent
::recache( $code );
1160 unset( $this->mruLangs
[$code] );
1161 $this->mruLangs
[$code] = true;
1168 public function unload( $code ) {
1169 unset( $this->mruLangs
[$code] );
1170 parent
::unload( $code );
1174 * Unload cached languages until there are less than $this->maxLoadedLangs
1176 protected function trimCache() {
1177 while ( count( $this->data
) > $this->maxLoadedLangs
&& count( $this->mruLangs
) ) {
1178 reset( $this->mruLangs
);
1179 $code = key( $this->mruLangs
);
1180 wfDebug( __METHOD__
.": unloading $code\n" );
1181 $this->unload( $code );