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.
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', 'bookstoreList',
85 'magicWords', 'messages', 'rtl', 'capitalizeAllNouns', 'digitTransformTable',
86 'separatorTransformTable', 'fallback8bitEncoding', 'linkPrefixExtension',
87 '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',
98 'dateFormats', 'imageFiles', 'preloadedMessages',
102 * Keys for items which are a numbered array.
104 static public $mergeableListKeys = array( 'extraUserToggles' );
107 * Keys for items which contain an array of arrays of equivalent aliases
108 * for each subitem. The aliases may be merged by a fallback sequence.
110 static public $mergeableAliasListKeys = array( 'specialPageAliases' );
113 * Keys for items which contain an associative array, and may be merged if
114 * the primary value contains the special array key "inherit". That array
115 * key is removed after the first merge.
117 static public $optionalMergeKeys = array( 'bookstoreList' );
120 * Keys for items that are formatted like $magicWords
122 static public $magicWordKeys = array( 'magicWords' );
125 * Keys for items where the subitems are stored in the backend separately.
127 static public $splitKeys = array( 'messages' );
130 * Keys which are loaded automatically by initLanguage()
132 static public $preloadedKeys = array( 'dateFormats', 'namespaceNames' );
136 * For constructor parameters, see the documentation in DefaultSettings.php
137 * 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 # If the code is of the wrong form for a Messages*.php file, do a shallow fallback
347 if ( !Language
::isValidBuiltInCode( $code ) ) {
348 $this->initShallowFallback( $code, 'en' );
352 # Recache the data if necessary
353 if ( !$this->manualRecache
&& $this->isExpired( $code ) ) {
354 if ( file_exists( Language
::getMessagesFileName( $code ) ) ) {
355 $this->recache( $code );
356 } elseif ( $code === 'en' ) {
357 throw new MWException( 'MessagesEn.php is missing.' );
359 $this->initShallowFallback( $code, 'en' );
365 $preload = $this->getItem( $code, 'preload' );
366 if ( $preload === null ) {
367 if ( $this->manualRecache
) {
368 // No Messages*.php file. Do shallow fallback to en.
369 if ( $code === 'en' ) {
370 throw new MWException( 'No localisation cache found for English. ' .
371 'Please run maintenance/rebuildLocalisationCache.php.' );
373 $this->initShallowFallback( $code, 'en' );
376 throw new MWException( 'Invalid or missing localisation cache.' );
379 $this->data
[$code] = $preload;
380 foreach ( $preload as $key => $item ) {
381 if ( in_array( $key, self
::$splitKeys ) ) {
382 foreach ( $item as $subkey => $subitem ) {
383 $this->loadedSubitems
[$code][$key][$subkey] = true;
386 $this->loadedItems
[$code][$key] = true;
392 * Create a fallback from one language to another, without creating a
393 * complete persistent cache.
395 public function initShallowFallback( $primaryCode, $fallbackCode ) {
396 $this->data
[$primaryCode] =& $this->data
[$fallbackCode];
397 $this->loadedItems
[$primaryCode] =& $this->loadedItems
[$fallbackCode];
398 $this->loadedSubitems
[$primaryCode] =& $this->loadedSubitems
[$fallbackCode];
399 $this->shallowFallbacks
[$primaryCode] = $fallbackCode;
403 * Read a PHP file containing localisation data.
405 protected function readPHPFile( $_fileName, $_fileType ) {
406 // Disable APC caching
407 $_apcEnabled = ini_set( 'apc.cache_by_default', '0' );
408 include( $_fileName );
409 ini_set( 'apc.cache_by_default', $_apcEnabled );
411 if ( $_fileType == 'core' ||
$_fileType == 'extension' ) {
412 $data = compact( self
::$allKeys );
413 } elseif ( $_fileType == 'aliases' ) {
414 $data = compact( 'aliases' );
416 throw new MWException( __METHOD__
.": Invalid file type: $_fileType" );
422 * Merge two localisation values, a primary and a fallback, overwriting the
423 * primary value in place.
425 protected function mergeItem( $key, &$value, $fallbackValue ) {
426 if ( !is_null( $value ) ) {
427 if ( !is_null( $fallbackValue ) ) {
428 if ( in_array( $key, self
::$mergeableMapKeys ) ) {
429 $value = $value +
$fallbackValue;
430 } elseif ( in_array( $key, self
::$mergeableListKeys ) ) {
431 $value = array_unique( array_merge( $fallbackValue, $value ) );
432 } elseif ( in_array( $key, self
::$mergeableAliasListKeys ) ) {
433 $value = array_merge_recursive( $value, $fallbackValue );
434 } elseif ( in_array( $key, self
::$optionalMergeKeys ) ) {
435 if ( !empty( $value['inherit'] ) ) {
436 $value = array_merge( $fallbackValue, $value );
438 if ( isset( $value['inherit'] ) ) {
439 unset( $value['inherit'] );
441 } elseif ( in_array( $key, self
::$magicWordKeys ) ) {
442 $this->mergeMagicWords( $value, $fallbackValue );
446 $value = $fallbackValue;
450 protected function mergeMagicWords( &$value, $fallbackValue ) {
451 foreach ( $fallbackValue as $magicName => $fallbackInfo ) {
452 if ( !isset( $value[$magicName] ) ) {
453 $value[$magicName] = $fallbackInfo;
455 $oldSynonyms = array_slice( $fallbackInfo, 1 );
456 $newSynonyms = array_slice( $value[$magicName], 1 );
457 $synonyms = array_values( array_unique( array_merge(
458 $newSynonyms, $oldSynonyms ) ) );
459 $value[$magicName] = array_merge( array( $fallbackInfo[0] ), $synonyms );
465 * Given an array mapping language code to localisation value, such as is
466 * found in extension *.i18n.php files, iterate through a fallback sequence
467 * to merge the given data with an existing primary value.
469 * Returns true if any data from the extension array was used, false
472 protected function mergeExtensionItem( $codeSequence, $key, &$value, $fallbackValue ) {
474 foreach ( $codeSequence as $code ) {
475 if ( isset( $fallbackValue[$code] ) ) {
476 $this->mergeItem( $key, $value, $fallbackValue[$code] );
484 * Load localisation data for a given language for both core and extensions
485 * and save it to the persistent cache store and the process cache
487 public function recache( $code ) {
488 global $wgExtensionMessagesFiles, $wgExtensionAliasesFiles;
489 wfProfileIn( __METHOD__
);
492 throw new MWException( "Invalid language code requested" );
494 $this->recachedLangs
[$code] = true;
497 $initialData = array_combine(
499 array_fill( 0, count( self
::$allKeys ), null ) );
500 $coreData = $initialData;
503 # Load the primary localisation from the source file
504 $fileName = Language
::getMessagesFileName( $code );
505 if ( !file_exists( $fileName ) ) {
506 wfDebug( __METHOD__
.": no localisation file for $code, using fallback to en\n" );
507 $coreData['fallback'] = 'en';
509 $deps[] = new FileDependency( $fileName );
510 $data = $this->readPHPFile( $fileName, 'core' );
511 wfDebug( __METHOD__
.": got localisation for $code from source\n" );
513 # Merge primary localisation
514 foreach ( $data as $key => $value ) {
515 $this->mergeItem( $key, $coreData[$key], $value );
519 # Fill in the fallback if it's not there already
520 if ( is_null( $coreData['fallback'] ) ) {
521 $coreData['fallback'] = $code === 'en' ?
false : 'en';
524 if ( $coreData['fallback'] === false ) {
525 $coreData['fallbackSequence'] = array();
527 $coreData['fallbackSequence'] = array_map( 'trim', explode( ',', $coreData['fallback'] ) );
528 $len = count( $coreData['fallbackSequence'] );
529 # Ensure that the sequence ends at en
530 if ( $coreData['fallbackSequence'][$len - 1] !== 'en' ) {
531 $coreData['fallbackSequence'][] = 'en';
534 # Load the fallback localisation item by item and merge it
535 foreach ( $coreData['fallbackSequence'] as $fallback ) {
536 $deps = array_merge( $deps, $this->getItem( $fallback, 'deps' ) );
537 foreach ( self
::$allKeys as $key ) {
538 if ( is_null( $coreData[$key] ) ||
$this->isMergeableKey( $key ) ) {
539 $fallbackValue = $this->getItem( $fallback, $key );
540 $this->mergeItem( $key, $coreData[$key], $fallbackValue );
546 $codeSequence = array_merge( array( $code ), $coreData['fallbackSequence'] );
548 # Load the extension localisations
549 # This is done after the core because we know the fallback sequence now.
550 # But it has a higher precedence for merging so that we can support things
551 # like site-specific message overrides.
552 $allData = $initialData;
553 foreach ( $wgExtensionMessagesFiles as $fileName ) {
554 $data = $this->readPHPFile( $fileName, 'extension' );
556 foreach ( $data as $key => $item ) {
557 if( $this->mergeExtensionItem( $codeSequence, $key, $allData[$key], $item ) ) {
562 $deps[] = new FileDependency( $fileName );
566 # Load deprecated $wgExtensionAliasesFiles
567 foreach ( $wgExtensionAliasesFiles as $fileName ) {
568 $data = $this->readPHPFile( $fileName, 'aliases' );
569 if ( !isset( $data['aliases'] ) ) {
572 $used = $this->mergeExtensionItem( $codeSequence, 'specialPageAliases',
573 $allData['specialPageAliases'], $data['aliases'] );
575 $deps[] = new FileDependency( $fileName );
579 # Merge core data into extension data
580 foreach ( $coreData as $key => $item ) {
581 $this->mergeItem( $key, $allData[$key], $item );
584 # Add cache dependencies for any referenced globals
585 $deps['wgExtensionMessagesFiles'] = new GlobalDependency( 'wgExtensionMessagesFiles' );
586 $deps['wgExtensionAliasesFiles'] = new GlobalDependency( 'wgExtensionAliasesFiles' );
587 $deps['version'] = new ConstantDependency( 'MW_LC_VERSION' );
589 # Add dependencies to the cache entry
590 $allData['deps'] = $deps;
592 # Replace spaces with underscores in namespace names
593 $allData['namespaceNames'] = str_replace( ' ', '_', $allData['namespaceNames'] );
595 # And do the same for special page aliases. $page is an array.
596 foreach ( $allData['specialPageAliases'] as &$page ) {
597 $page = str_replace( ' ', '_', $page );
599 # Decouple the reference to prevent accidental damage
603 $allData['list'] = array();
604 foreach ( self
::$splitKeys as $key ) {
605 $allData['list'][$key] = array_keys( $allData[$key] );
609 wfRunHooks( 'LocalisationCacheRecache', array( $this, $code, &$allData ) );
611 # Set the preload key
612 $allData['preload'] = $this->buildPreload( $allData );
614 # Save to the process cache and register the items loaded
615 $this->data
[$code] = $allData;
616 foreach ( $allData as $key => $item ) {
617 $this->loadedItems
[$code][$key] = true;
620 # Save to the persistent cache
621 $this->store
->startWrite( $code );
622 foreach ( $allData as $key => $value ) {
623 if ( in_array( $key, self
::$splitKeys ) ) {
624 foreach ( $value as $subkey => $subvalue ) {
625 $this->store
->set( "$key:$subkey", $subvalue );
628 $this->store
->set( $key, $value );
631 $this->store
->finishWrite();
633 # Clear out the MessageBlobStore
634 # HACK: If using a null (i.e. disabled) storage backend, we
635 # can't write to the MessageBlobStore either
636 if ( !$this->store
instanceof LCStore_Null
) {
637 MessageBlobStore
::clear();
640 wfProfileOut( __METHOD__
);
644 * Build the preload item from the given pre-cache data.
646 * The preload item will be loaded automatically, improving performance
647 * for the commonly-requested items it contains.
649 protected function buildPreload( $data ) {
650 $preload = array( 'messages' => array() );
651 foreach ( self
::$preloadedKeys as $key ) {
652 $preload[$key] = $data[$key];
654 foreach ( $data['preloadedMessages'] as $subkey ) {
655 if ( isset( $data['messages'][$subkey] ) ) {
656 $subitem = $data['messages'][$subkey];
660 $preload['messages'][$subkey] = $subitem;
666 * Unload the data for a given language from the object cache.
667 * Reduces memory usage.
669 public function unload( $code ) {
670 unset( $this->data
[$code] );
671 unset( $this->loadedItems
[$code] );
672 unset( $this->loadedSubitems
[$code] );
673 unset( $this->initialisedLangs
[$code] );
674 foreach ( $this->shallowFallbacks
as $shallowCode => $fbCode ) {
675 if ( $fbCode === $code ) {
676 $this->unload( $shallowCode );
684 public function unloadAll() {
685 foreach ( $this->initialisedLangs
as $lang => $unused ) {
686 $this->unload( $lang );
691 * Disable the storage backend
693 public function disableBackend() {
694 $this->store
= new LCStore_Null
;
695 $this->manualRecache
= false;
700 * Interface for the persistence layer of LocalisationCache.
702 * The persistence layer is two-level hierarchical cache. The first level
703 * is the language, the second level is the item or subitem.
705 * Since the data for a whole language is rebuilt in one operation, it needs
706 * to have a fast and atomic method for deleting or replacing all of the
707 * current data for a given language. The interface reflects this bulk update
708 * operation. Callers writing to the cache must first call startWrite(), then
709 * will call set() a couple of thousand times, then will call finishWrite()
710 * to commit the operation. When finishWrite() is called, the cache is
711 * expected to delete all data previously stored for that language.
713 * The values stored are PHP variables suitable for serialize(). Implementations
714 * of LCStore are responsible for serializing and unserializing.
719 * @param $code Language code
720 * @param $key Cache key
722 function get( $code, $key );
725 * Start a write transaction.
726 * @param $code Language code
728 function startWrite( $code );
731 * Finish a write transaction.
733 function finishWrite();
736 * Set a key to a given value. startWrite() must be called before this
737 * is called, and finishWrite() must be called afterwards.
739 function set( $key, $value );
744 * LCStore implementation which uses the standard DB functions to store data.
745 * This will work on any MediaWiki installation.
747 class LCStore_DB
implements LCStore
{
749 var $writesDone = false;
751 var $readOnly = false;
753 public function get( $code, $key ) {
754 if ( $this->writesDone
) {
755 $db = wfGetDB( DB_MASTER
);
757 $db = wfGetDB( DB_SLAVE
);
759 $row = $db->selectRow( 'l10n_cache', array( 'lc_value' ),
760 array( 'lc_lang' => $code, 'lc_key' => $key ), __METHOD__
);
762 return unserialize( $row->lc_value
);
768 public function startWrite( $code ) {
769 if ( $this->readOnly
) {
773 throw new MWException( __METHOD__
.": Invalid language \"$code\"" );
775 $this->dbw
= wfGetDB( DB_MASTER
);
778 $this->dbw
->delete( 'l10n_cache', array( 'lc_lang' => $code ), __METHOD__
);
779 } catch ( DBQueryError
$e ) {
780 if ( $this->dbw
->wasReadOnlyError() ) {
781 $this->readOnly
= true;
782 $this->dbw
->rollback();
783 $this->dbw
->ignoreErrors( false );
789 $this->currentLang
= $code;
790 $this->batch
= array();
793 public function finishWrite() {
794 if ( $this->readOnly
) {
797 if ( $this->batch
) {
798 $this->dbw
->insert( 'l10n_cache', $this->batch
, __METHOD__
);
800 $this->dbw
->commit();
801 $this->currentLang
= null;
803 $this->batch
= array();
804 $this->writesDone
= true;
807 public function set( $key, $value ) {
808 if ( $this->readOnly
) {
811 if ( is_null( $this->currentLang
) ) {
812 throw new MWException( __CLASS__
.': must call startWrite() before calling set()' );
814 $this->batch
[] = array(
815 'lc_lang' => $this->currentLang
,
817 'lc_value' => serialize( $value ) );
818 if ( count( $this->batch
) >= 100 ) {
819 $this->dbw
->insert( 'l10n_cache', $this->batch
, __METHOD__
);
820 $this->batch
= array();
826 * LCStore implementation which stores data as a collection of CDB files in the
827 * directory given by $wgCacheDirectory. If $wgCacheDirectory is not set, this
828 * will throw an exception.
830 * Profiling indicates that on Linux, this implementation outperforms MySQL if
831 * the directory is on a local filesystem and there is ample kernel cache
832 * space. The performance advantage is greater when the DBA extension is
833 * available than it is with the PHP port.
835 * See Cdb.php and http://cr.yp.to/cdb.html
837 class LCStore_CDB
implements LCStore
{
838 var $readers, $writer, $currentLang, $directory;
840 function __construct( $conf = array() ) {
841 global $wgCacheDirectory;
842 if ( isset( $conf['directory'] ) ) {
843 $this->directory
= $conf['directory'];
845 $this->directory
= $wgCacheDirectory;
849 public function get( $code, $key ) {
850 if ( !isset( $this->readers
[$code] ) ) {
851 $fileName = $this->getFileName( $code );
852 if ( !file_exists( $fileName ) ) {
853 $this->readers
[$code] = false;
855 $this->readers
[$code] = CdbReader
::open( $fileName );
858 if ( !$this->readers
[$code] ) {
861 $value = $this->readers
[$code]->get( $key );
862 if ( $value === false ) {
865 return unserialize( $value );
869 public function startWrite( $code ) {
870 if ( !file_exists( $this->directory
) ) {
871 if ( !wfMkdirParents( $this->directory
, null, __METHOD__
) ) {
872 throw new MWException( "Unable to create the localisation store " .
873 "directory \"{$this->directory}\"" );
876 // Close reader to stop permission errors on write
877 if( !empty($this->readers
[$code]) ) {
878 $this->readers
[$code]->close();
880 $this->writer
= CdbWriter
::open( $this->getFileName( $code ) );
881 $this->currentLang
= $code;
884 public function finishWrite() {
886 $this->writer
->close();
887 $this->writer
= null;
888 unset( $this->readers
[$this->currentLang
] );
889 $this->currentLang
= null;
892 public function set( $key, $value ) {
893 if ( is_null( $this->writer
) ) {
894 throw new MWException( __CLASS__
.': must call startWrite() before calling set()' );
896 $this->writer
->set( $key, serialize( $value ) );
899 protected function getFileName( $code ) {
900 if ( !$code ||
strpos( $code, '/' ) !== false ) {
901 throw new MWException( __METHOD__
.": Invalid language \"$code\"" );
903 return "{$this->directory}/l10n_cache-$code.cdb";
908 * Null store backend, used to avoid DB errors during install
910 class LCStore_Null
implements LCStore
{
911 public function get( $code, $key ) {
915 public function startWrite( $code ) {}
916 public function finishWrite() {}
917 public function set( $key, $value ) {}
921 * A localisation cache optimised for loading large amounts of data for many
922 * languages. Used by rebuildLocalisationCache.php.
924 class LocalisationCache_BulkLoad
extends LocalisationCache
{
926 * A cache of the contents of data files.
927 * Core files are serialized to avoid using ~1GB of RAM during a recache.
929 var $fileCache = array();
932 * Most recently used languages. Uses the linked-list aspect of PHP hashtables
933 * to keep the most recently used language codes at the end of the array, and
934 * the language codes that are ready to be deleted at the beginning.
936 var $mruLangs = array();
939 * Maximum number of languages that may be loaded into $this->data
941 var $maxLoadedLangs = 10;
943 protected function readPHPFile( $fileName, $fileType ) {
944 $serialize = $fileType === 'core';
945 if ( !isset( $this->fileCache
[$fileName][$fileType] ) ) {
946 $data = parent
::readPHPFile( $fileName, $fileType );
948 $encData = serialize( $data );
952 $this->fileCache
[$fileName][$fileType] = $encData;
954 } elseif ( $serialize ) {
955 return unserialize( $this->fileCache
[$fileName][$fileType] );
957 return $this->fileCache
[$fileName][$fileType];
961 public function getItem( $code, $key ) {
962 unset( $this->mruLangs
[$code] );
963 $this->mruLangs
[$code] = true;
964 return parent
::getItem( $code, $key );
967 public function getSubitem( $code, $key, $subkey ) {
968 unset( $this->mruLangs
[$code] );
969 $this->mruLangs
[$code] = true;
970 return parent
::getSubitem( $code, $key, $subkey );
973 public function recache( $code ) {
974 parent
::recache( $code );
975 unset( $this->mruLangs
[$code] );
976 $this->mruLangs
[$code] = true;
980 public function unload( $code ) {
981 unset( $this->mruLangs
[$code] );
982 parent
::unload( $code );
986 * Unload cached languages until there are less than $this->maxLoadedLangs
988 protected function trimCache() {
989 while ( count( $this->data
) > $this->maxLoadedLangs
&& count( $this->mruLangs
) ) {
990 reset( $this->mruLangs
);
991 $code = key( $this->mruLangs
);
992 wfDebug( __METHOD__
.": unloading $code\n" );
993 $this->unload( $code );