3 define( 'MW_LC_VERSION', 1 );
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.
47 * A 2-d associative array, code/key, where presence indicates that the item
48 * is loaded. Value arbitrary.
50 * For split items, if set, this indicates that all of the subitems have been
53 var $loadedItems = array();
56 * A 3-d associative array, code/key/subkey, where presence indicates that
57 * the subitem is loaded. Only used for the split items, i.e. messages.
59 var $loadedSubitems = array();
62 * An array where presence of a key indicates that that language has been
63 * initialised. Initialisation includes checking for cache expiry and doing
64 * any necessary updates.
66 var $initialisedLangs = array();
69 * An array mapping non-existent pseudo-languages to fallback languages. This
70 * is filled by initShallowFallback() when data is requested from a language
71 * that lacks a Messages*.php file.
73 var $shallowFallbacks = array();
76 * An array where the keys are codes that have been recached by this instance.
78 var $recachedLangs = array();
83 static public $allKeys = array(
84 'fallback', 'namespaceNames', 'mathNames', 'bookstoreList',
85 'magicWords', 'messages', 'rtl', 'capitalizeAllNouns', 'digitTransformTable',
86 'separatorTransformTable', 'fallback8bitEncoding', 'linkPrefixExtension',
87 'defaultUserOptionOverrides', 'linkTrail', 'namespaceAliases',
88 'dateFormats', 'datePreferences', 'datePreferenceMigrationMap',
89 'defaultDateFormat', 'extraUserToggles', 'specialPageAliases',
90 'imageFiles', 'preloadedMessages', 'namespaceGenderAliases',
94 * Keys for items which consist of associative arrays, which may be merged
95 * by a fallback sequence.
97 static public $mergeableMapKeys = array( 'messages', 'namespaceNames', 'mathNames',
98 'dateFormats', 'defaultUserOptionOverrides', 'imageFiles',
103 * Keys for items which are a numbered array.
105 static public $mergeableListKeys = array( 'extraUserToggles' );
108 * Keys for items which contain an array of arrays of equivalent aliases
109 * for each subitem. The aliases may be merged by a fallback sequence.
111 static public $mergeableAliasListKeys = array( 'specialPageAliases' );
114 * Keys for items which contain an associative array, and may be merged if
115 * the primary value contains the special array key "inherit". That array
116 * key is removed after the first merge.
118 static public $optionalMergeKeys = array( 'bookstoreList' );
121 * Keys for items that are formatted like $magicWords
123 static public $magicWordKeys = array( 'magicWords' );
126 * Keys for items where the subitems are stored in the backend separately.
128 static public $splitKeys = array( 'messages' );
131 * Keys which are loaded automatically by initLanguage()
133 static public $preloadedKeys = array( 'dateFormats', 'namespaceNames',
134 'defaultUserOptionOverrides' );
138 * For constructor parameters, see the documentation in DefaultSettings.php
139 * for $wgLocalisationCacheConf.
141 function __construct( $conf ) {
142 global $wgCacheDirectory;
145 $storeConf = array();
146 if ( !empty( $conf['storeClass'] ) ) {
147 $storeClass = $conf['storeClass'];
149 switch ( $conf['store'] ) {
152 $storeClass = 'LCStore_CDB';
155 $storeClass = 'LCStore_DB';
158 $storeClass = $wgCacheDirectory ?
'LCStore_CDB' : 'LCStore_DB';
161 throw new MWException(
162 'Please set $wgLocalisationCacheConf[\'store\'] to something sensible.' );
166 wfDebug( get_class( $this ) . ": using store $storeClass\n" );
167 if ( !empty( $conf['storeDirectory'] ) ) {
168 $storeConf['directory'] = $conf['storeDirectory'];
171 $this->store
= new $storeClass( $storeConf );
172 foreach ( array( 'manualRecache', 'forceRecache' ) as $var ) {
173 if ( isset( $conf[$var] ) ) {
174 $this->$var = $conf[$var];
180 * Returns true if the given key is mergeable, that is, if it is an associative
181 * array which can be merged through a fallback sequence.
183 public function isMergeableKey( $key ) {
184 if ( !isset( $this->mergeableKeys
) ) {
185 $this->mergeableKeys
= array_flip( array_merge(
186 self
::$mergeableMapKeys,
187 self
::$mergeableListKeys,
188 self
::$mergeableAliasListKeys,
189 self
::$optionalMergeKeys,
193 return isset( $this->mergeableKeys
[$key] );
199 * Warning: this may be slow for split items (messages), since it will
200 * need to fetch all of the subitems from the cache individually.
202 public function getItem( $code, $key ) {
203 if ( !isset( $this->loadedItems
[$code][$key] ) ) {
204 wfProfileIn( __METHOD__
.'-load' );
205 $this->loadItem( $code, $key );
206 wfProfileOut( __METHOD__
.'-load' );
208 if ( $key === 'fallback' && isset( $this->shallowFallbacks
[$code] ) ) {
209 return $this->shallowFallbacks
[$code];
211 return $this->data
[$code][$key];
215 * Get a subitem, for instance a single message for a given language.
217 public function getSubitem( $code, $key, $subkey ) {
218 if ( !isset( $this->loadedSubitems
[$code][$key][$subkey] )
219 && !isset( $this->loadedItems
[$code][$key] ) )
221 wfProfileIn( __METHOD__
.'-load' );
222 $this->loadSubitem( $code, $key, $subkey );
223 wfProfileOut( __METHOD__
.'-load' );
225 if ( isset( $this->data
[$code][$key][$subkey] ) ) {
226 return $this->data
[$code][$key][$subkey];
233 * Get the list of subitem keys for a given item.
235 * This is faster than array_keys($lc->getItem(...)) for the items listed in
238 * Will return null if the item is not found, or false if the item is not an
241 public function getSubitemList( $code, $key ) {
242 if ( in_array( $key, self
::$splitKeys ) ) {
243 return $this->getSubitem( $code, 'list', $key );
245 $item = $this->getItem( $code, $key );
246 if ( is_array( $item ) ) {
247 return array_keys( $item );
255 * Load an item into the cache.
257 protected function loadItem( $code, $key ) {
258 if ( !isset( $this->initialisedLangs
[$code] ) ) {
259 $this->initLanguage( $code );
261 // Check to see if initLanguage() loaded it for us
262 if ( isset( $this->loadedItems
[$code][$key] ) ) {
265 if ( isset( $this->shallowFallbacks
[$code] ) ) {
266 $this->loadItem( $this->shallowFallbacks
[$code], $key );
269 if ( in_array( $key, self
::$splitKeys ) ) {
270 $subkeyList = $this->getSubitem( $code, 'list', $key );
271 foreach ( $subkeyList as $subkey ) {
272 if ( isset( $this->data
[$code][$key][$subkey] ) ) {
275 $this->data
[$code][$key][$subkey] = $this->getSubitem( $code, $key, $subkey );
278 $this->data
[$code][$key] = $this->store
->get( $code, $key );
280 $this->loadedItems
[$code][$key] = true;
284 * Load a subitem into the cache
286 protected function loadSubitem( $code, $key, $subkey ) {
287 if ( !in_array( $key, self
::$splitKeys ) ) {
288 $this->loadItem( $code, $key );
291 if ( !isset( $this->initialisedLangs
[$code] ) ) {
292 $this->initLanguage( $code );
294 // Check to see if initLanguage() loaded it for us
295 if ( isset( $this->loadedItems
[$code][$key] )
296 ||
isset( $this->loadedSubitems
[$code][$key][$subkey] ) )
300 if ( isset( $this->shallowFallbacks
[$code] ) ) {
301 $this->loadSubitem( $this->shallowFallbacks
[$code], $key, $subkey );
304 $value = $this->store
->get( $code, "$key:$subkey" );
305 $this->data
[$code][$key][$subkey] = $value;
306 $this->loadedSubitems
[$code][$key][$subkey] = true;
310 * Returns true if the cache identified by $code is missing or expired.
312 public function isExpired( $code ) {
313 if ( $this->forceRecache
&& !isset( $this->recachedLangs
[$code] ) ) {
314 wfDebug( __METHOD__
."($code): forced reload\n" );
318 $deps = $this->store
->get( $code, 'deps' );
319 if ( $deps === null ) {
320 wfDebug( __METHOD__
."($code): cache missing, need to make one\n" );
323 foreach ( $deps as $dep ) {
324 // Because we're unserializing stuff from cache, we
325 // could receive objects of classes that don't exist
326 // anymore (e.g. uninstalled extensions)
327 // When this happens, always expire the cache
328 if ( !$dep instanceof CacheDependency ||
$dep->isExpired() ) {
329 wfDebug( __METHOD__
."($code): cache for $code expired due to " .
330 get_class( $dep ) . "\n" );
338 * Initialise a language in this object. Rebuild the cache if necessary.
340 protected function initLanguage( $code ) {
341 if ( isset( $this->initialisedLangs
[$code] ) ) {
344 $this->initialisedLangs
[$code] = true;
346 # Recache the data if necessary
347 if ( !$this->manualRecache
&& $this->isExpired( $code ) ) {
348 if ( file_exists( Language
::getMessagesFileName( $code ) ) ) {
349 $this->recache( $code );
350 } elseif ( $code === 'en' ) {
351 throw new MWException( 'MessagesEn.php is missing.' );
353 $this->initShallowFallback( $code, 'en' );
359 $preload = $this->getItem( $code, 'preload' );
360 if ( $preload === null ) {
361 if ( $this->manualRecache
) {
362 // No Messages*.php file. Do shallow fallback to en.
363 if ( $code === 'en' ) {
364 throw new MWException( 'No localisation cache found for English. ' .
365 'Please run maintenance/rebuildLocalisationCache.php.' );
367 $this->initShallowFallback( $code, 'en' );
370 throw new MWException( 'Invalid or missing localisation cache.' );
373 $this->data
[$code] = $preload;
374 foreach ( $preload as $key => $item ) {
375 if ( in_array( $key, self
::$splitKeys ) ) {
376 foreach ( $item as $subkey => $subitem ) {
377 $this->loadedSubitems
[$code][$key][$subkey] = true;
380 $this->loadedItems
[$code][$key] = true;
386 * Create a fallback from one language to another, without creating a
387 * complete persistent cache.
389 public function initShallowFallback( $primaryCode, $fallbackCode ) {
390 $this->data
[$primaryCode] =& $this->data
[$fallbackCode];
391 $this->loadedItems
[$primaryCode] =& $this->loadedItems
[$fallbackCode];
392 $this->loadedSubitems
[$primaryCode] =& $this->loadedSubitems
[$fallbackCode];
393 $this->shallowFallbacks
[$primaryCode] = $fallbackCode;
397 * Read a PHP file containing localisation data.
399 protected function readPHPFile( $_fileName, $_fileType ) {
400 // Disable APC caching
401 $_apcEnabled = ini_set( 'apc.cache_by_default', '0' );
402 include( $_fileName );
403 ini_set( 'apc.cache_by_default', $_apcEnabled );
405 if ( $_fileType == 'core' ||
$_fileType == 'extension' ) {
406 $data = compact( self
::$allKeys );
407 } elseif ( $_fileType == 'aliases' ) {
408 $data = compact( 'aliases' );
410 throw new MWException( __METHOD__
.": Invalid file type: $_fileType" );
416 * Merge two localisation values, a primary and a fallback, overwriting the
417 * primary value in place.
419 protected function mergeItem( $key, &$value, $fallbackValue ) {
420 if ( !is_null( $value ) ) {
421 if ( !is_null( $fallbackValue ) ) {
422 if ( in_array( $key, self
::$mergeableMapKeys ) ) {
423 $value = $value +
$fallbackValue;
424 } elseif ( in_array( $key, self
::$mergeableListKeys ) ) {
425 $value = array_unique( array_merge( $fallbackValue, $value ) );
426 } elseif ( in_array( $key, self
::$mergeableAliasListKeys ) ) {
427 $value = array_merge_recursive( $value, $fallbackValue );
428 } elseif ( in_array( $key, self
::$optionalMergeKeys ) ) {
429 if ( !empty( $value['inherit'] ) ) {
430 $value = array_merge( $fallbackValue, $value );
432 if ( isset( $value['inherit'] ) ) {
433 unset( $value['inherit'] );
435 } elseif ( in_array( $key, self
::$magicWordKeys ) ) {
436 $this->mergeMagicWords( $value, $fallbackValue );
440 $value = $fallbackValue;
444 protected function mergeMagicWords( &$value, $fallbackValue ) {
445 foreach ( $fallbackValue as $magicName => $fallbackInfo ) {
446 if ( !isset( $value[$magicName] ) ) {
447 $value[$magicName] = $fallbackInfo;
449 $oldSynonyms = array_slice( $fallbackInfo, 1 );
450 $newSynonyms = array_slice( $value[$magicName], 1 );
451 $synonyms = array_unique( array_merge( $oldSynonyms, $newSynonyms ) );
452 $value[$magicName] = array_merge( array( $fallbackInfo[0] ), $synonyms );
458 * Given an array mapping language code to localisation value, such as is
459 * found in extension *.i18n.php files, iterate through a fallback sequence
460 * to merge the given data with an existing primary value.
462 * Returns true if any data from the extension array was used, false
465 protected function mergeExtensionItem( $codeSequence, $key, &$value, $fallbackValue ) {
467 foreach ( $codeSequence as $code ) {
468 if ( isset( $fallbackValue[$code] ) ) {
469 $this->mergeItem( $key, $value, $fallbackValue[$code] );
477 * Load localisation data for a given language for both core and extensions
478 * and save it to the persistent cache store and the process cache
480 public function recache( $code ) {
481 static $recursionGuard = array();
482 global $wgExtensionMessagesFiles, $wgExtensionAliasesFiles;
483 wfProfileIn( __METHOD__
);
486 throw new MWException( "Invalid language code requested" );
488 $this->recachedLangs
[$code] = true;
491 $initialData = array_combine(
493 array_fill( 0, count( self
::$allKeys ), null ) );
494 $coreData = $initialData;
497 # Load the primary localisation from the source file
498 $fileName = Language
::getMessagesFileName( $code );
499 if ( !file_exists( $fileName ) ) {
500 wfDebug( __METHOD__
.": no localisation file for $code, using fallback to en\n" );
501 $coreData['fallback'] = 'en';
503 $deps[] = new FileDependency( $fileName );
504 $data = $this->readPHPFile( $fileName, 'core' );
505 wfDebug( __METHOD__
.": got localisation for $code from source\n" );
507 # Merge primary localisation
508 foreach ( $data as $key => $value ) {
509 $this->mergeItem( $key, $coreData[$key], $value );
513 # Fill in the fallback if it's not there already
514 if ( is_null( $coreData['fallback'] ) ) {
515 $coreData['fallback'] = $code === 'en' ?
false : 'en';
518 if ( $coreData['fallback'] !== false ) {
519 # Guard against circular references
520 if ( isset( $recursionGuard[$code] ) ) {
521 throw new MWException( "Error: Circular fallback reference in language code $code" );
523 $recursionGuard[$code] = true;
525 # Load the fallback localisation item by item and merge it
526 $deps = array_merge( $deps, $this->getItem( $coreData['fallback'], 'deps' ) );
527 foreach ( self
::$allKeys as $key ) {
528 if ( is_null( $coreData[$key] ) ||
$this->isMergeableKey( $key ) ) {
529 $fallbackValue = $this->getItem( $coreData['fallback'], $key );
530 $this->mergeItem( $key, $coreData[$key], $fallbackValue );
533 $fallbackSequence = $this->getItem( $coreData['fallback'], 'fallbackSequence' );
534 array_unshift( $fallbackSequence, $coreData['fallback'] );
535 $coreData['fallbackSequence'] = $fallbackSequence;
536 unset( $recursionGuard[$code] );
538 $coreData['fallbackSequence'] = array();
540 $codeSequence = array_merge( array( $code ), $coreData['fallbackSequence'] );
542 # Load the extension localisations
543 # This is done after the core because we know the fallback sequence now.
544 # But it has a higher precedence for merging so that we can support things
545 # like site-specific message overrides.
546 $allData = $initialData;
547 foreach ( $wgExtensionMessagesFiles as $fileName ) {
548 $data = $this->readPHPFile( $fileName, 'extension' );
550 foreach ( $data as $key => $item ) {
551 if( $this->mergeExtensionItem( $codeSequence, $key, $allData[$key], $item ) ) {
556 $deps[] = new FileDependency( $fileName );
560 # Load deprecated $wgExtensionAliasesFiles
561 foreach ( $wgExtensionAliasesFiles as $fileName ) {
562 $data = $this->readPHPFile( $fileName, 'aliases' );
563 if ( !isset( $data['aliases'] ) ) {
566 $used = $this->mergeExtensionItem( $codeSequence, 'specialPageAliases',
567 $allData['specialPageAliases'], $data['aliases'] );
569 $deps[] = new FileDependency( $fileName );
573 # Merge core data into extension data
574 foreach ( $coreData as $key => $item ) {
575 $this->mergeItem( $key, $allData[$key], $item );
578 # Add cache dependencies for any referenced globals
579 $deps['wgExtensionMessagesFiles'] = new GlobalDependency( 'wgExtensionMessagesFiles' );
580 $deps['wgExtensionAliasesFiles'] = new GlobalDependency( 'wgExtensionAliasesFiles' );
581 $deps['version'] = new ConstantDependency( 'MW_LC_VERSION' );
583 # Add dependencies to the cache entry
584 $allData['deps'] = $deps;
586 # Replace spaces with underscores in namespace names
587 $allData['namespaceNames'] = str_replace( ' ', '_', $allData['namespaceNames'] );
589 # And do the same for special page aliases. $page is an array.
590 foreach ( $allData['specialPageAliases'] as &$page ) {
591 $page = str_replace( ' ', '_', $page );
593 # Decouple the reference to prevent accidental damage
596 # Fix broken defaultUserOptionOverrides
597 if ( !is_array( $allData['defaultUserOptionOverrides'] ) ) {
598 $allData['defaultUserOptionOverrides'] = array();
602 $allData['list'] = array();
603 foreach ( self
::$splitKeys as $key ) {
604 $allData['list'][$key] = array_keys( $allData[$key] );
608 wfRunHooks( 'LocalisationCacheRecache', array( $this, $code, &$allData ) );
610 if ( is_null( $allData['defaultUserOptionOverrides'] ) ) {
611 throw new MWException( __METHOD__
.': Localisation data failed sanity check! ' .
612 'Check that your languages/messages/MessagesEn.php file is intact.' );
615 # Set the preload key
616 $allData['preload'] = $this->buildPreload( $allData );
618 # Save to the process cache and register the items loaded
619 $this->data
[$code] = $allData;
620 foreach ( $allData as $key => $item ) {
621 $this->loadedItems
[$code][$key] = true;
624 # Save to the persistent cache
625 $this->store
->startWrite( $code );
626 foreach ( $allData as $key => $value ) {
627 if ( in_array( $key, self
::$splitKeys ) ) {
628 foreach ( $value as $subkey => $subvalue ) {
629 $this->store
->set( "$key:$subkey", $subvalue );
632 $this->store
->set( $key, $value );
635 $this->store
->finishWrite();
637 # Clear out the MessageBlobStore
638 # HACK: If using a null (i.e. disabled) storage backend, we
639 # can't write to the MessageBlobStore either
640 if ( !$this->store
instanceof LCStore_Null
) {
641 MessageBlobStore
::clear();
644 wfProfileOut( __METHOD__
);
648 * Build the preload item from the given pre-cache data.
650 * The preload item will be loaded automatically, improving performance
651 * for the commonly-requested items it contains.
653 protected function buildPreload( $data ) {
654 $preload = array( 'messages' => array() );
655 foreach ( self
::$preloadedKeys as $key ) {
656 $preload[$key] = $data[$key];
658 foreach ( $data['preloadedMessages'] as $subkey ) {
659 if ( isset( $data['messages'][$subkey] ) ) {
660 $subitem = $data['messages'][$subkey];
664 $preload['messages'][$subkey] = $subitem;
670 * Unload the data for a given language from the object cache.
671 * Reduces memory usage.
673 public function unload( $code ) {
674 unset( $this->data
[$code] );
675 unset( $this->loadedItems
[$code] );
676 unset( $this->loadedSubitems
[$code] );
677 unset( $this->initialisedLangs
[$code] );
678 foreach ( $this->shallowFallbacks
as $shallowCode => $fbCode ) {
679 if ( $fbCode === $code ) {
680 $this->unload( $shallowCode );
688 public function unloadAll() {
689 foreach ( $this->initialisedLangs
as $lang => $unused ) {
690 $this->unload( $lang );
695 * Disable the storage backend
697 public function disableBackend() {
698 $this->store
= new LCStore_Null
;
699 $this->manualRecache
= false;
704 * Interface for the persistence layer of LocalisationCache.
706 * The persistence layer is two-level hierarchical cache. The first level
707 * is the language, the second level is the item or subitem.
709 * Since the data for a whole language is rebuilt in one operation, it needs
710 * to have a fast and atomic method for deleting or replacing all of the
711 * current data for a given language. The interface reflects this bulk update
712 * operation. Callers writing to the cache must first call startWrite(), then
713 * will call set() a couple of thousand times, then will call finishWrite()
714 * to commit the operation. When finishWrite() is called, the cache is
715 * expected to delete all data previously stored for that language.
717 * The values stored are PHP variables suitable for serialize(). Implementations
718 * of LCStore are responsible for serializing and unserializing.
723 * @param $code Language code
724 * @param $key Cache key
726 function get( $code, $key );
729 * Start a write transaction.
730 * @param $code Language code
732 function startWrite( $code );
735 * Finish a write transaction.
737 function finishWrite();
740 * Set a key to a given value. startWrite() must be called before this
741 * is called, and finishWrite() must be called afterwards.
743 function set( $key, $value );
748 * LCStore implementation which uses the standard DB functions to store data.
749 * This will work on any MediaWiki installation.
751 class LCStore_DB
implements LCStore
{
753 var $writesDone = false;
755 var $readOnly = false;
757 public function get( $code, $key ) {
758 if ( $this->writesDone
) {
759 $db = wfGetDB( DB_MASTER
);
761 $db = wfGetDB( DB_SLAVE
);
763 $row = $db->selectRow( 'l10n_cache', array( 'lc_value' ),
764 array( 'lc_lang' => $code, 'lc_key' => $key ), __METHOD__
);
766 return unserialize( $row->lc_value
);
772 public function startWrite( $code ) {
773 if ( $this->readOnly
) {
777 throw new MWException( __METHOD__
.": Invalid language \"$code\"" );
779 $this->dbw
= wfGetDB( DB_MASTER
);
782 $this->dbw
->delete( 'l10n_cache', array( 'lc_lang' => $code ), __METHOD__
);
783 } catch ( DBQueryError
$e ) {
784 if ( $this->dbw
->wasReadOnlyError() ) {
785 $this->readOnly
= true;
786 $this->dbw
->rollback();
787 $this->dbw
->ignoreErrors( false );
793 $this->currentLang
= $code;
794 $this->batch
= array();
797 public function finishWrite() {
798 if ( $this->readOnly
) {
801 if ( $this->batch
) {
802 $this->dbw
->insert( 'l10n_cache', $this->batch
, __METHOD__
);
804 $this->dbw
->commit();
805 $this->currentLang
= null;
807 $this->batch
= array();
808 $this->writesDone
= true;
811 public function set( $key, $value ) {
812 if ( $this->readOnly
) {
815 if ( is_null( $this->currentLang
) ) {
816 throw new MWException( __CLASS__
.': must call startWrite() before calling set()' );
818 $this->batch
[] = array(
819 'lc_lang' => $this->currentLang
,
821 'lc_value' => serialize( $value ) );
822 if ( count( $this->batch
) >= 100 ) {
823 $this->dbw
->insert( 'l10n_cache', $this->batch
, __METHOD__
);
824 $this->batch
= array();
830 * LCStore implementation which stores data as a collection of CDB files in the
831 * directory given by $wgCacheDirectory. If $wgCacheDirectory is not set, this
832 * will throw an exception.
834 * Profiling indicates that on Linux, this implementation outperforms MySQL if
835 * the directory is on a local filesystem and there is ample kernel cache
836 * space. The performance advantage is greater when the DBA extension is
837 * available than it is with the PHP port.
839 * See Cdb.php and http://cr.yp.to/cdb.html
841 class LCStore_CDB
implements LCStore
{
842 var $readers, $writer, $currentLang, $directory;
844 function __construct( $conf = array() ) {
845 global $wgCacheDirectory;
846 if ( isset( $conf['directory'] ) ) {
847 $this->directory
= $conf['directory'];
849 $this->directory
= $wgCacheDirectory;
853 public function get( $code, $key ) {
854 if ( !isset( $this->readers
[$code] ) ) {
855 $fileName = $this->getFileName( $code );
856 if ( !file_exists( $fileName ) ) {
857 $this->readers
[$code] = false;
859 $this->readers
[$code] = CdbReader
::open( $fileName );
862 if ( !$this->readers
[$code] ) {
865 $value = $this->readers
[$code]->get( $key );
866 if ( $value === false ) {
869 return unserialize( $value );
873 public function startWrite( $code ) {
874 if ( !file_exists( $this->directory
) ) {
875 if ( !wfMkdirParents( $this->directory
) ) {
876 throw new MWException( "Unable to create the localisation store " .
877 "directory \"{$this->directory}\"" );
880 // Close reader to stop permission errors on write
881 if( !empty($this->readers
[$code]) ) {
882 $this->readers
[$code]->close();
884 $this->writer
= CdbWriter
::open( $this->getFileName( $code ) );
885 $this->currentLang
= $code;
888 public function finishWrite() {
890 $this->writer
->close();
891 $this->writer
= null;
892 unset( $this->readers
[$this->currentLang
] );
893 $this->currentLang
= null;
896 public function set( $key, $value ) {
897 if ( is_null( $this->writer
) ) {
898 throw new MWException( __CLASS__
.': must call startWrite() before calling set()' );
900 $this->writer
->set( $key, serialize( $value ) );
903 protected function getFileName( $code ) {
904 if ( !$code ||
strpos( $code, '/' ) !== false ) {
905 throw new MWException( __METHOD__
.": Invalid language \"$code\"" );
907 return "{$this->directory}/l10n_cache-$code.cdb";
912 * Null store backend, used to avoid DB errors during install
914 class LCStore_Null
implements LCStore
{
915 public function get( $code, $key ) {
919 public function startWrite( $code ) {}
920 public function finishWrite() {}
921 public function set( $key, $value ) {}
925 * A localisation cache optimised for loading large amounts of data for many
926 * languages. Used by rebuildLocalisationCache.php.
928 class LocalisationCache_BulkLoad
extends LocalisationCache
{
930 * A cache of the contents of data files.
931 * Core files are serialized to avoid using ~1GB of RAM during a recache.
933 var $fileCache = array();
936 * Most recently used languages. Uses the linked-list aspect of PHP hashtables
937 * to keep the most recently used language codes at the end of the array, and
938 * the language codes that are ready to be deleted at the beginning.
940 var $mruLangs = array();
943 * Maximum number of languages that may be loaded into $this->data
945 var $maxLoadedLangs = 10;
947 protected function readPHPFile( $fileName, $fileType ) {
948 $serialize = $fileType === 'core';
949 if ( !isset( $this->fileCache
[$fileName][$fileType] ) ) {
950 $data = parent
::readPHPFile( $fileName, $fileType );
952 $encData = serialize( $data );
956 $this->fileCache
[$fileName][$fileType] = $encData;
958 } elseif ( $serialize ) {
959 return unserialize( $this->fileCache
[$fileName][$fileType] );
961 return $this->fileCache
[$fileName][$fileType];
965 public function getItem( $code, $key ) {
966 unset( $this->mruLangs
[$code] );
967 $this->mruLangs
[$code] = true;
968 return parent
::getItem( $code, $key );
971 public function getSubitem( $code, $key, $subkey ) {
972 unset( $this->mruLangs
[$code] );
973 $this->mruLangs
[$code] = true;
974 return parent
::getSubitem( $code, $key, $subkey );
977 public function recache( $code ) {
978 parent
::recache( $code );
979 unset( $this->mruLangs
[$code] );
980 $this->mruLangs
[$code] = true;
984 public function unload( $code ) {
985 unset( $this->mruLangs
[$code] );
986 parent
::unload( $code );
990 * Unload cached languages until there are less than $this->maxLoadedLangs
992 protected function trimCache() {
993 while ( count( $this->data
) > $this->maxLoadedLangs
&& count( $this->mruLangs
) ) {
994 reset( $this->mruLangs
);
995 $code = key( $this->mruLangs
);
996 wfDebug( __METHOD__
.": unloading $code\n" );
997 $this->unload( $code );