includes/cache/LocalisationCache.php

   1 <?php
   2 /**
   3  * Cache of the contents of localisation files.
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * Class for caching the contents of localisation files, Messages*.php
  25  * and *.i18n.php.
  26  *
  27  * An instance of this class is available using Language::getLocalisationCache().
  28  *
  29  * The values retrieved from here are merged, containing items from extension
  30  * files, core messages files and the language fallback sequence (e.g. zh-cn ->
  31  * zh-hans -> en ). Some common errors are corrected, for example namespace
  32  * names with spaces instead of underscores, but heavyweight processing, such
  33  * as grammatical transformation, is done by the caller.
  34  */
  35 class LocalisationCache {
  36         const VERSION = 2;
  37
  38         /** Configuration associative array */
  39         private $conf;
  40
  41         /**
  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.
  45          */
  46         private $manualRecache = false;
  47
  48         /**
  49          * True to treat all files as expired until they are regenerated by this object.
  50          */
  51         private $forceRecache = false;
  52
  53         /**
  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.
  58          */
  59         protected $data = array();
  60
  61         /**
  62          * The persistent store object. An instance of LCStore.
  63          *
  64          * @var LCStore
  65          */
  66         private $store;
  67
  68         /**
  69          * A 2-d associative array, code/key, where presence indicates that the item
  70          * is loaded. Value arbitrary.
  71          *
  72          * For split items, if set, this indicates that all of the subitems have been
  73          * loaded.
  74          */
  75         private $loadedItems = array();
  76
  77         /**
  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.
  80          */
  81         private $loadedSubitems = array();
  82
  83         /**
  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.
  87          */
  88         private $initialisedLangs = array();
  89
  90         /**
  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.
  94          */
  95         private $shallowFallbacks = array();
  96
  97         /**
  98          * An array where the keys are codes that have been recached by this instance.
  99          */
 100         private $recachedLangs = array();
 101
 102         /**
 103          * All item keys
 104          */
 105         static public $allKeys = array(
 106                 'fallback', 'namespaceNames', 'bookstoreList',
 107                 'magicWords', 'messages', 'rtl', 'capitalizeAllNouns', 'digitTransformTable',
 108                 'separatorTransformTable', 'fallback8bitEncoding', 'linkPrefixExtension',
 109                 'linkTrail', 'linkPrefixCharset', 'namespaceAliases',
 110                 'dateFormats', 'datePreferences', 'datePreferenceMigrationMap',
 111                 'defaultDateFormat', 'extraUserToggles', 'specialPageAliases',
 112                 'imageFiles', 'preloadedMessages', 'namespaceGenderAliases',
 113                 'digitGroupingPattern', 'pluralRules', 'pluralRuleTypes', 'compiledPluralRules',
 114         );
 115
 116         /**
 117          * Keys for items which consist of associative arrays, which may be merged
 118          * by a fallback sequence.
 119          */
 120         static public $mergeableMapKeys = array( 'messages', 'namespaceNames',
 121                 'dateFormats', 'imageFiles', 'preloadedMessages'
 122         );
 123
 124         /**
 125          * Keys for items which are a numbered array.
 126          */
 127         static public $mergeableListKeys = array( 'extraUserToggles' );
 128
 129         /**
 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.
 132          */
 133         static public $mergeableAliasListKeys = array( 'specialPageAliases' );
 134
 135         /**
 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.
 139          */
 140         static public $optionalMergeKeys = array( 'bookstoreList' );
 141
 142         /**
 143          * Keys for items that are formatted like $magicWords
 144          */
 145         static public $magicWordKeys = array( 'magicWords' );
 146
 147         /**
 148          * Keys for items where the subitems are stored in the backend separately.
 149          */
 150         static public $splitKeys = array( 'messages' );
 151
 152         /**
 153          * Keys which are loaded automatically by initLanguage()
 154          */
 155         static public $preloadedKeys = array( 'dateFormats', 'namespaceNames' );
 156
 157         /**
 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.
 160          */
 161         private $pluralRules = null;
 162
 163         /**
 164          * Associative array of cached plural rule types. The key is the language
 165          * code, the value is an array of plural rule types for that language. For
 166          * example, $pluralRuleTypes['ar'] = ['zero', 'one', 'two', 'few', 'many'].
 167          * The index for each rule type matches the index for the rule in
 168          * $pluralRules, thus allowing correlation between the two. The reason we
 169          * don't just use the type names as the keys in $pluralRules is because
 170          * Language::convertPlural applies the rules based on numeric order (or
 171          * explicit numeric parameter), not based on the name of the rule type. For
 172          * example, {{plural:count|wordform1|wordform2|wordform3}}, rather than
 173          * {{plural:count|one=wordform1|two=wordform2|many=wordform3}}.
 174          */
 175         private $pluralRuleTypes = null;
 176
 177         private $mergeableKeys = null;
 178
 179         /**
 180          * Constructor.
 181          * For constructor parameters, see the documentation in DefaultSettings.php
 182          * for $wgLocalisationCacheConf.
 183          *
 184          * @param array $conf
 185          * @throws MWException
 186          */
 187         function __construct( $conf ) {
 188                 global $wgCacheDirectory;
 189
 190                 $this->conf = $conf;
 191                 $storeConf = array();
 192                 if ( !empty( $conf['storeClass'] ) ) {
 193                         $storeClass = $conf['storeClass'];
 194                 } else {
 195                         switch ( $conf['store'] ) {
 196                                 case 'files':
 197                                 case 'file':
 198                                         $storeClass = 'LCStoreCDB';
 199                                         break;
 200                                 case 'db':
 201                                         $storeClass = 'LCStoreDB';
 202                                         break;
 203                                 case 'accel':
 204                                         $storeClass = 'LCStoreAccel';
 205                                         break;
 206                                 case 'detect':
 207                                         $storeClass = $wgCacheDirectory ? 'LCStoreCDB' : 'LCStoreDB';
 208                                         break;
 209                                 default:
 210                                         throw new MWException(
 211                                                 'Please set $wgLocalisationCacheConf[\'store\'] to something sensible.' );
 212                         }
 213                 }
 214
 215                 wfDebugLog( 'caches', get_class( $this ) . ": using store $storeClass" );
 216                 if ( !empty( $conf['storeDirectory'] ) ) {
 217                         $storeConf['directory'] = $conf['storeDirectory'];
 218                 }
 219
 220                 $this->store = new $storeClass( $storeConf );
 221                 foreach ( array( 'manualRecache', 'forceRecache' ) as $var ) {
 222                         if ( isset( $conf[$var] ) ) {
 223                                 $this->$var = $conf[$var];
 224                         }
 225                 }
 226         }
 227
 228         /**
 229          * Returns true if the given key is mergeable, that is, if it is an associative
 230          * array which can be merged through a fallback sequence.
 231          * @param string $key
 232          * @return bool
 233          */
 234         public function isMergeableKey( $key ) {
 235                 if ( $this->mergeableKeys === null ) {
 236                         $this->mergeableKeys = array_flip( array_merge(
 237                                 self::$mergeableMapKeys,
 238                                 self::$mergeableListKeys,
 239                                 self::$mergeableAliasListKeys,
 240                                 self::$optionalMergeKeys,
 241                                 self::$magicWordKeys
 242                         ) );
 243                 }
 244
 245                 return isset( $this->mergeableKeys[$key] );
 246         }
 247
 248         /**
 249          * Get a cache item.
 250          *
 251          * Warning: this may be slow for split items (messages), since it will
 252          * need to fetch all of the subitems from the cache individually.
 253          * @param string $code
 254          * @param string $key
 255          * @return mixed
 256          */
 257         public function getItem( $code, $key ) {
 258                 if ( !isset( $this->loadedItems[$code][$key] ) ) {
 259                         wfProfileIn( __METHOD__ . '-load' );
 260                         $this->loadItem( $code, $key );
 261                         wfProfileOut( __METHOD__ . '-load' );
 262                 }
 263
 264                 if ( $key === 'fallback' && isset( $this->shallowFallbacks[$code] ) ) {
 265                         return $this->shallowFallbacks[$code];
 266                 }
 267
 268                 return $this->data[$code][$key];
 269         }
 270
 271         /**
 272          * Get a subitem, for instance a single message for a given language.
 273          * @param string $code
 274          * @param string $key
 275          * @param string $subkey
 276          * @return mixed|null
 277          */
 278         public function getSubitem( $code, $key, $subkey ) {
 279                 if ( !isset( $this->loadedSubitems[$code][$key][$subkey] ) &&
 280                         !isset( $this->loadedItems[$code][$key] )
 281                 ) {
 282                         wfProfileIn( __METHOD__ . '-load' );
 283                         $this->loadSubitem( $code, $key, $subkey );
 284                         wfProfileOut( __METHOD__ . '-load' );
 285                 }
 286
 287                 if ( isset( $this->data[$code][$key][$subkey] ) ) {
 288                         return $this->data[$code][$key][$subkey];
 289                 } else {
 290                         return null;
 291                 }
 292         }
 293
 294         /**
 295          * Get the list of subitem keys for a given item.
 296          *
 297          * This is faster than array_keys($lc->getItem(...)) for the items listed in
 298          * self::$splitKeys.
 299          *
 300          * Will return null if the item is not found, or false if the item is not an
 301          * array.
 302          * @param string $code
 303          * @param string $key
 304          * @return bool|null|string
 305          */
 306         public function getSubitemList( $code, $key ) {
 307                 if ( in_array( $key, self::$splitKeys ) ) {
 308                         return $this->getSubitem( $code, 'list', $key );
 309                 } else {
 310                         $item = $this->getItem( $code, $key );
 311                         if ( is_array( $item ) ) {
 312                                 return array_keys( $item );
 313                         } else {
 314                                 return false;
 315                         }
 316                 }
 317         }
 318
 319         /**
 320          * Load an item into the cache.
 321          * @param string $code
 322          * @param string $key
 323          */
 324         protected function loadItem( $code, $key ) {
 325                 if ( !isset( $this->initialisedLangs[$code] ) ) {
 326                         $this->initLanguage( $code );
 327                 }
 328
 329                 // Check to see if initLanguage() loaded it for us
 330                 if ( isset( $this->loadedItems[$code][$key] ) ) {
 331                         return;
 332                 }
 333
 334                 if ( isset( $this->shallowFallbacks[$code] ) ) {
 335                         $this->loadItem( $this->shallowFallbacks[$code], $key );
 336
 337                         return;
 338                 }
 339
 340                 if ( in_array( $key, self::$splitKeys ) ) {
 341                         $subkeyList = $this->getSubitem( $code, 'list', $key );
 342                         foreach ( $subkeyList as $subkey ) {
 343                                 if ( isset( $this->data[$code][$key][$subkey] ) ) {
 344                                         continue;
 345                                 }
 346                                 $this->data[$code][$key][$subkey] = $this->getSubitem( $code, $key, $subkey );
 347                         }
 348                 } else {
 349                         $this->data[$code][$key] = $this->store->get( $code, $key );
 350                 }
 351
 352                 $this->loadedItems[$code][$key] = true;
 353         }
 354
 355         /**
 356          * Load a subitem into the cache
 357          * @param string $code
 358          * @param string $key
 359          * @param string $subkey
 360          */
 361         protected function loadSubitem( $code, $key, $subkey ) {
 362                 if ( !in_array( $key, self::$splitKeys ) ) {
 363                         $this->loadItem( $code, $key );
 364
 365                         return;
 366                 }
 367
 368                 if ( !isset( $this->initialisedLangs[$code] ) ) {
 369                         $this->initLanguage( $code );
 370                 }
 371
 372                 // Check to see if initLanguage() loaded it for us
 373                 if ( isset( $this->loadedItems[$code][$key] ) ||
 374                         isset( $this->loadedSubitems[$code][$key][$subkey] )
 375                 ) {
 376                         return;
 377                 }
 378
 379                 if ( isset( $this->shallowFallbacks[$code] ) ) {
 380                         $this->loadSubitem( $this->shallowFallbacks[$code], $key, $subkey );
 381
 382                         return;
 383                 }
 384
 385                 $value = $this->store->get( $code, "$key:$subkey" );
 386                 $this->data[$code][$key][$subkey] = $value;
 387                 $this->loadedSubitems[$code][$key][$subkey] = true;
 388         }
 389
 390         /**
 391          * Returns true if the cache identified by $code is missing or expired.
 392          *
 393          * @param string $code
 394          *
 395          * @return bool
 396          */
 397         public function isExpired( $code ) {
 398                 if ( $this->forceRecache && !isset( $this->recachedLangs[$code] ) ) {
 399                         wfDebug( __METHOD__ . "($code): forced reload\n" );
 400
 401                         return true;
 402                 }
 403
 404                 $deps = $this->store->get( $code, 'deps' );
 405                 $keys = $this->store->get( $code, 'list' );
 406                 $preload = $this->store->get( $code, 'preload' );
 407                 // Different keys may expire separately, at least in LCStoreAccel
 408                 if ( $deps === null || $keys === null || $preload === null ) {
 409                         wfDebug( __METHOD__ . "($code): cache missing, need to make one\n" );
 410
 411                         return true;
 412                 }
 413
 414                 foreach ( $deps as $dep ) {
 415                         // Because we're unserializing stuff from cache, we
 416                         // could receive objects of classes that don't exist
 417                         // anymore (e.g. uninstalled extensions)
 418                         // When this happens, always expire the cache
 419                         if ( !$dep instanceof CacheDependency || $dep->isExpired() ) {
 420                                 wfDebug( __METHOD__ . "($code): cache for $code expired due to " .
 421                                         get_class( $dep ) . "\n" );
 422
 423                                 return true;
 424                         }
 425                 }
 426
 427                 return false;
 428         }
 429
 430         /**
 431          * Initialise a language in this object. Rebuild the cache if necessary.
 432          * @param string $code
 433          * @throws MWException
 434          */
 435         protected function initLanguage( $code ) {
 436                 if ( isset( $this->initialisedLangs[$code] ) ) {
 437                         return;
 438                 }
 439
 440                 $this->initialisedLangs[$code] = true;
 441
 442                 # If the code is of the wrong form for a Messages*.php file, do a shallow fallback
 443                 if ( !Language::isValidBuiltInCode( $code ) ) {
 444                         $this->initShallowFallback( $code, 'en' );
 445
 446                         return;
 447                 }
 448
 449                 # Recache the data if necessary
 450                 if ( !$this->manualRecache && $this->isExpired( $code ) ) {
 451                         if ( Language::isSupportedLanguage( $code ) ) {
 452                                 $this->recache( $code );
 453                         } elseif ( $code === 'en' ) {
 454                                 throw new MWException( 'MessagesEn.php is missing.' );
 455                         } else {
 456                                 $this->initShallowFallback( $code, 'en' );
 457                         }
 458
 459                         return;
 460                 }
 461
 462                 # Preload some stuff
 463                 $preload = $this->getItem( $code, 'preload' );
 464                 if ( $preload === null ) {
 465                         if ( $this->manualRecache ) {
 466                                 // No Messages*.php file. Do shallow fallback to en.
 467                                 if ( $code === 'en' ) {
 468                                         throw new MWException( 'No localisation cache found for English. ' .
 469                                                 'Please run maintenance/rebuildLocalisationCache.php.' );
 470                                 }
 471                                 $this->initShallowFallback( $code, 'en' );
 472
 473                                 return;
 474                         } else {
 475                                 throw new MWException( 'Invalid or missing localisation cache.' );
 476                         }
 477                 }
 478                 $this->data[$code] = $preload;
 479                 foreach ( $preload as $key => $item ) {
 480                         if ( in_array( $key, self::$splitKeys ) ) {
 481                                 foreach ( $item as $subkey => $subitem ) {
 482                                         $this->loadedSubitems[$code][$key][$subkey] = true;
 483                                 }
 484                         } else {
 485                                 $this->loadedItems[$code][$key] = true;
 486                         }
 487                 }
 488         }
 489
 490         /**
 491          * Create a fallback from one language to another, without creating a
 492          * complete persistent cache.
 493          * @param string $primaryCode
 494          * @param string $fallbackCode
 495          */
 496         public function initShallowFallback( $primaryCode, $fallbackCode ) {
 497                 $this->data[$primaryCode] =& $this->data[$fallbackCode];
 498                 $this->loadedItems[$primaryCode] =& $this->loadedItems[$fallbackCode];
 499                 $this->loadedSubitems[$primaryCode] =& $this->loadedSubitems[$fallbackCode];
 500                 $this->shallowFallbacks[$primaryCode] = $fallbackCode;
 501         }
 502
 503         /**
 504          * Read a PHP file containing localisation data.
 505          * @param string $_fileName
 506          * @param string $_fileType
 507          * @throws MWException
 508          * @return array
 509          */
 510         protected function readPHPFile( $_fileName, $_fileType ) {
 511                 wfProfileIn( __METHOD__ );
 512                 // Disable APC caching
 513                 wfSuppressWarnings();
 514                 $_apcEnabled = ini_set( 'apc.cache_by_default', '0' );
 515                 wfRestoreWarnings();
 516
 517                 include $_fileName;
 518
 519                 wfSuppressWarnings();
 520                 ini_set( 'apc.cache_by_default', $_apcEnabled );
 521                 wfRestoreWarnings();
 522
 523                 if ( $_fileType == 'core' || $_fileType == 'extension' ) {
 524                         $data = compact( self::$allKeys );
 525                 } elseif ( $_fileType == 'aliases' ) {
 526                         $data = compact( 'aliases' );
 527                 } else {
 528                         wfProfileOut( __METHOD__ );
 529                         throw new MWException( __METHOD__ . ": Invalid file type: $_fileType" );
 530                 }
 531                 wfProfileOut( __METHOD__ );
 532
 533                 return $data;
 534         }
 535
 536         /**
 537          * Read a JSON file containing localisation messages.
 538          * @param string $fileName Name of file to read
 539          * @throws MWException If there is a syntax error in the JSON file
 540          * @return array Array with a 'messages' key, or empty array if the file doesn't exist
 541          */
 542         public function readJSONFile( $fileName ) {
 543                 wfProfileIn( __METHOD__ );
 544
 545                 if ( !is_readable( $fileName ) ) {
 546                         wfProfileOut( __METHOD__ );
 547
 548                         return array();
 549                 }
 550
 551                 $json = file_get_contents( $fileName );
 552                 if ( $json === false ) {
 553                         wfProfileOut( __METHOD__ );
 554
 555                         return array();
 556                 }
 557
 558                 $data = FormatJson::decode( $json, true );
 559                 if ( $data === null ) {
 560                         wfProfileOut( __METHOD__ );
 561
 562                         throw new MWException( __METHOD__ . ": Invalid JSON file: $fileName" );
 563                 }
 564
 565                 // Remove keys starting with '@', they're reserved for metadata and non-message data
 566                 foreach ( $data as $key => $unused ) {
 567                         if ( $key === '' || $key[0] === '@' ) {
 568                                 unset( $data[$key] );
 569                         }
 570                 }
 571
 572                 wfProfileOut( __METHOD__ );
 573
 574                 // The JSON format only supports messages, none of the other variables, so wrap the data
 575                 return array( 'messages' => $data );
 576         }
 577
 578         /**
 579          * Get the compiled plural rules for a given language from the XML files.
 580          * @since 1.20
 581          * @param string $code
 582          * @return array|null
 583          */
 584         public function getCompiledPluralRules( $code ) {
 585                 $rules = $this->getPluralRules( $code );
 586                 if ( $rules === null ) {
 587                         return null;
 588                 }
 589                 try {
 590                         $compiledRules = CLDRPluralRuleEvaluator::compile( $rules );
 591                 } catch ( CLDRPluralRuleError $e ) {
 592                         wfDebugLog( 'l10n', $e->getMessage() );
 593
 594                         return array();
 595                 }
 596
 597                 return $compiledRules;
 598         }
 599
 600         /**
 601          * Get the plural rules for a given language from the XML files.
 602          * Cached.
 603          * @since 1.20
 604          * @param string $code
 605          * @return array|null
 606          */
 607         public function getPluralRules( $code ) {
 608                 if ( $this->pluralRules === null ) {
 609                         $this->loadPluralFiles();
 610                 }
 611                 if ( !isset( $this->pluralRules[$code] ) ) {
 612                         return null;
 613                 } else {
 614                         return $this->pluralRules[$code];
 615                 }
 616         }
 617
 618         /**
 619          * Get the plural rule types for a given language from the XML files.
 620          * Cached.
 621          * @since 1.22
 622          * @param string $code
 623          * @return array|null
 624          */
 625         public function getPluralRuleTypes( $code ) {
 626                 if ( $this->pluralRuleTypes === null ) {
 627                         $this->loadPluralFiles();
 628                 }
 629                 if ( !isset( $this->pluralRuleTypes[$code] ) ) {
 630                         return null;
 631                 } else {
 632                         return $this->pluralRuleTypes[$code];
 633                 }
 634         }
 635
 636         /**
 637          * Load the plural XML files.
 638          */
 639         protected function loadPluralFiles() {
 640                 global $IP;
 641                 $cldrPlural = "$IP/languages/data/plurals.xml";
 642                 $mwPlural = "$IP/languages/data/plurals-mediawiki.xml";
 643                 // Load CLDR plural rules
 644                 $this->loadPluralFile( $cldrPlural );
 645                 if ( file_exists( $mwPlural ) ) {
 646                         // Override or extend
 647                         $this->loadPluralFile( $mwPlural );
 648                 }
 649         }
 650
 651         /**
 652          * Load a plural XML file with the given filename, compile the relevant
 653          * rules, and save the compiled rules in a process-local cache.
 654          *
 655          * @param string $fileName
 656          */
 657         protected function loadPluralFile( $fileName ) {
 658                 $doc = new DOMDocument;
 659                 $doc->load( $fileName );
 660                 $rulesets = $doc->getElementsByTagName( "pluralRules" );
 661                 foreach ( $rulesets as $ruleset ) {
 662                         $codes = $ruleset->getAttribute( 'locales' );
 663                         $rules = array();
 664                         $ruleTypes = array();
 665                         $ruleElements = $ruleset->getElementsByTagName( "pluralRule" );
 666                         foreach ( $ruleElements as $elt ) {
 667                                 $ruleType = $elt->getAttribute( 'count' );
 668                                 if ( $ruleType === 'other' ) {
 669                                         // Don't record "other" rules, which have an empty condition
 670                                         continue;
 671                                 }
 672                                 $rules[] = $elt->nodeValue;
 673                                 $ruleTypes[] = $ruleType;
 674                         }
 675                         foreach ( explode( ' ', $codes ) as $code ) {
 676                                 $this->pluralRules[$code] = $rules;
 677                                 $this->pluralRuleTypes[$code] = $ruleTypes;
 678                         }
 679                 }
 680         }
 681
 682         /**
 683          * Read the data from the source files for a given language, and register
 684          * the relevant dependencies in the $deps array. If the localisation
 685          * exists, the data array is returned, otherwise false is returned.
 686          *
 687          * @param string $code
 688          * @param array $deps
 689          * @return array
 690          */
 691         protected function readSourceFilesAndRegisterDeps( $code, &$deps ) {
 692                 global $IP;
 693                 wfProfileIn( __METHOD__ );
 694
 695                 // This reads in the PHP i18n file with non-messages l10n data
 696                 $fileName = Language::getMessagesFileName( $code );
 697                 if ( !file_exists( $fileName ) ) {
 698                         $data = array();
 699                 } else {
 700                         $deps[] = new FileDependency( $fileName );
 701                         $data = $this->readPHPFile( $fileName, 'core' );
 702                 }
 703
 704                 # Load CLDR plural rules for JavaScript
 705                 $data['pluralRules'] = $this->getPluralRules( $code );
 706                 # And for PHP
 707                 $data['compiledPluralRules'] = $this->getCompiledPluralRules( $code );
 708                 # Load plural rule types
 709                 $data['pluralRuleTypes'] = $this->getPluralRuleTypes( $code );
 710
 711                 $deps['plurals'] = new FileDependency( "$IP/languages/data/plurals.xml" );
 712                 $deps['plurals-mw'] = new FileDependency( "$IP/languages/data/plurals-mediawiki.xml" );
 713
 714                 wfProfileOut( __METHOD__ );
 715
 716                 return $data;
 717         }
 718
 719         /**
 720          * Merge two localisation values, a primary and a fallback, overwriting the
 721          * primary value in place.
 722          * @param string $key
 723          * @param mixed $value
 724          * @param mixed $fallbackValue
 725          */
 726         protected function mergeItem( $key, &$value, $fallbackValue ) {
 727                 if ( !is_null( $value ) ) {
 728                         if ( !is_null( $fallbackValue ) ) {
 729                                 if ( in_array( $key, self::$mergeableMapKeys ) ) {
 730                                         $value = $value + $fallbackValue;
 731                                 } elseif ( in_array( $key, self::$mergeableListKeys ) ) {
 732                                         $value = array_unique( array_merge( $fallbackValue, $value ) );
 733                                 } elseif ( in_array( $key, self::$mergeableAliasListKeys ) ) {
 734                                         $value = array_merge_recursive( $value, $fallbackValue );
 735                                 } elseif ( in_array( $key, self::$optionalMergeKeys ) ) {
 736                                         if ( !empty( $value['inherit'] ) ) {
 737                                                 $value = array_merge( $fallbackValue, $value );
 738                                         }
 739
 740                                         if ( isset( $value['inherit'] ) ) {
 741                                                 unset( $value['inherit'] );
 742                                         }
 743                                 } elseif ( in_array( $key, self::$magicWordKeys ) ) {
 744                                         $this->mergeMagicWords( $value, $fallbackValue );
 745                                 }
 746                         }
 747                 } else {
 748                         $value = $fallbackValue;
 749                 }
 750         }
 751
 752         /**
 753          * @param mixed $value
 754          * @param mixed $fallbackValue
 755          */
 756         protected function mergeMagicWords( &$value, $fallbackValue ) {
 757                 foreach ( $fallbackValue as $magicName => $fallbackInfo ) {
 758                         if ( !isset( $value[$magicName] ) ) {
 759                                 $value[$magicName] = $fallbackInfo;
 760                         } else {
 761                                 $oldSynonyms = array_slice( $fallbackInfo, 1 );
 762                                 $newSynonyms = array_slice( $value[$magicName], 1 );
 763                                 $synonyms = array_values( array_unique( array_merge(
 764                                         $newSynonyms, $oldSynonyms ) ) );
 765                                 $value[$magicName] = array_merge( array( $fallbackInfo[0] ), $synonyms );
 766                         }
 767                 }
 768         }
 769
 770         /**
 771          * Given an array mapping language code to localisation value, such as is
 772          * found in extension *.i18n.php files, iterate through a fallback sequence
 773          * to merge the given data with an existing primary value.
 774          *
 775          * Returns true if any data from the extension array was used, false
 776          * otherwise.
 777          * @param array $codeSequence
 778          * @param string $key
 779          * @param mixed $value
 780          * @param mixed $fallbackValue
 781          * @return bool
 782          */
 783         protected function mergeExtensionItem( $codeSequence, $key, &$value, $fallbackValue ) {
 784                 $used = false;
 785                 foreach ( $codeSequence as $code ) {
 786                         if ( isset( $fallbackValue[$code] ) ) {
 787                                 $this->mergeItem( $key, $value, $fallbackValue[$code] );
 788                                 $used = true;
 789                         }
 790                 }
 791
 792                 return $used;
 793         }
 794
 795         /**
 796          * Load localisation data for a given language for both core and extensions
 797          * and save it to the persistent cache store and the process cache
 798          * @param string $code
 799          * @throws MWException
 800          */
 801         public function recache( $code ) {
 802                 global $wgExtensionMessagesFiles, $wgMessagesDirs;
 803                 wfProfileIn( __METHOD__ );
 804
 805                 if ( !$code ) {
 806                         wfProfileOut( __METHOD__ );
 807                         throw new MWException( "Invalid language code requested" );
 808                 }
 809                 $this->recachedLangs[$code] = true;
 810
 811                 # Initial values
 812                 $initialData = array_combine(
 813                         self::$allKeys,
 814                         array_fill( 0, count( self::$allKeys ), null ) );
 815                 $coreData = $initialData;
 816                 $deps = array();
 817
 818                 # Load the primary localisation from the source file
 819                 $data = $this->readSourceFilesAndRegisterDeps( $code, $deps );
 820                 if ( $data === false ) {
 821                         wfDebug( __METHOD__ . ": no localisation file for $code, using fallback to en\n" );
 822                         $coreData['fallback'] = 'en';
 823                 } else {
 824                         wfDebug( __METHOD__ . ": got localisation for $code from source\n" );
 825
 826                         # Merge primary localisation
 827                         foreach ( $data as $key => $value ) {
 828                                 $this->mergeItem( $key, $coreData[$key], $value );
 829                         }
 830                 }
 831
 832                 # Fill in the fallback if it's not there already
 833                 if ( is_null( $coreData['fallback'] ) ) {
 834                         $coreData['fallback'] = $code === 'en' ? false : 'en';
 835                 }
 836                 if ( $coreData['fallback'] === false ) {
 837                         $coreData['fallbackSequence'] = array();
 838                 } else {
 839                         $coreData['fallbackSequence'] = array_map( 'trim', explode( ',', $coreData['fallback'] ) );
 840                         $len = count( $coreData['fallbackSequence'] );
 841
 842                         # Ensure that the sequence ends at en
 843                         if ( $coreData['fallbackSequence'][$len - 1] !== 'en' ) {
 844                                 $coreData['fallbackSequence'][] = 'en';
 845                         }
 846                 }
 847
 848                 $codeSequence = array_merge( array( $code ), $coreData['fallbackSequence'] );
 849
 850                 wfProfileIn( __METHOD__ . '-fallbacks' );
 851
 852                 # Load non-JSON localisation data for extensions
 853                 $extensionData = array_combine(
 854                         $codeSequence,
 855                         array_fill( 0, count( $codeSequence ), $initialData ) );
 856                 foreach ( $wgExtensionMessagesFiles as $extension => $fileName ) {
 857                         if ( isset( $wgMessagesDirs[$extension] ) ) {
 858                                 # This extension has JSON message data; skip the PHP shim
 859                                 continue;
 860                         }
 861
 862                         $data = $this->readPHPFile( $fileName, 'extension' );
 863                         $used = false;
 864
 865                         foreach ( $data as $key => $item ) {
 866                                 foreach ( $codeSequence as $csCode ) {
 867                                         if ( isset( $item[$csCode] ) ) {
 868                                                 $this->mergeItem( $key, $extensionData[$csCode][$key], $item[$csCode] );
 869                                                 $used = true;
 870                                         }
 871                                 }
 872                         }
 873
 874                         if ( $used ) {
 875                                 $deps[] = new FileDependency( $fileName );
 876                         }
 877                 }
 878
 879                 # Load the localisation data for each fallback, then merge it into the full array
 880                 $allData = $initialData;
 881                 foreach ( $codeSequence as $csCode ) {
 882                         $csData = $initialData;
 883
 884                         # Load core messages and the extension localisations.
 885                         foreach ( $wgMessagesDirs as $dirs ) {
 886                                 foreach ( (array)$dirs as $dir ) {
 887                                         $fileName = "$dir/$csCode.json";
 888                                         $data = $this->readJSONFile( $fileName );
 889
 890                                         foreach ( $data as $key => $item ) {
 891                                                 $this->mergeItem( $key, $csData[$key], $item );
 892                                         }
 893
 894                                         $deps[] = new FileDependency( $fileName );
 895                                 }
 896                         }
 897
 898                         # Merge non-JSON extension data
 899                         if ( isset( $extensionData[$csCode] ) ) {
 900                                 foreach ( $extensionData[$csCode] as $key => $item ) {
 901                                         $this->mergeItem( $key, $csData[$key], $item );
 902                                 }
 903                         }
 904
 905                         if ( $csCode === $code ) {
 906                                 # Merge core data into extension data
 907                                 foreach ( $coreData as $key => $item ) {
 908                                         $this->mergeItem( $key, $csData[$key], $item );
 909                                 }
 910                         } else {
 911                                 # Load the secondary localisation from the source file to
 912                                 # avoid infinite cycles on cyclic fallbacks
 913                                 $fbData = $this->readSourceFilesAndRegisterDeps( $csCode, $deps );
 914                                 if ( $fbData !== false ) {
 915                                         # Only merge the keys that make sense to merge
 916                                         foreach ( self::$allKeys as $key ) {
 917                                                 if ( !isset( $fbData[$key] ) ) {
 918                                                         continue;
 919                                                 }
 920
 921                                                 if ( is_null( $coreData[$key] ) || $this->isMergeableKey( $key ) ) {
 922                                                         $this->mergeItem( $key, $csData[$key], $fbData[$key] );
 923                                                 }
 924                                         }
 925                                 }
 926                         }
 927
 928                         # Allow extensions an opportunity to adjust the data for this
 929                         # fallback
 930                         wfRunHooks( 'LocalisationCacheRecacheFallback', array( $this, $csCode, &$csData ) );
 931
 932                         # Merge the data for this fallback into the final array
 933                         if ( $csCode === $code ) {
 934                                 $allData = $csData;
 935                         } else {
 936                                 foreach ( self::$allKeys as $key ) {
 937                                         if ( !isset( $csData[$key] ) ) {
 938                                                 continue;
 939                                         }
 940
 941                                         if ( is_null( $allData[$key] ) || $this->isMergeableKey( $key ) ) {
 942                                                 $this->mergeItem( $key, $allData[$key], $csData[$key] );
 943                                         }
 944                                 }
 945                         }
 946                 }
 947
 948                 wfProfileOut( __METHOD__ . '-fallbacks' );
 949
 950                 # Add cache dependencies for any referenced globals
 951                 $deps['wgExtensionMessagesFiles'] = new GlobalDependency( 'wgExtensionMessagesFiles' );
 952                 $deps['wgMessagesDirs'] = new GlobalDependency( 'wgMessagesDirs' );
 953                 $deps['version'] = new ConstantDependency( 'LocalisationCache::VERSION' );
 954
 955                 # Add dependencies to the cache entry
 956                 $allData['deps'] = $deps;
 957
 958                 # Replace spaces with underscores in namespace names
 959                 $allData['namespaceNames'] = str_replace( ' ', '_', $allData['namespaceNames'] );
 960
 961                 # And do the same for special page aliases. $page is an array.
 962                 foreach ( $allData['specialPageAliases'] as &$page ) {
 963                         $page = str_replace( ' ', '_', $page );
 964                 }
 965                 # Decouple the reference to prevent accidental damage
 966                 unset( $page );
 967
 968                 # If there were no plural rules, return an empty array
 969                 if ( $allData['pluralRules'] === null ) {
 970                         $allData['pluralRules'] = array();
 971                 }
 972                 if ( $allData['compiledPluralRules'] === null ) {
 973                         $allData['compiledPluralRules'] = array();
 974                 }
 975                 # If there were no plural rule types, return an empty array
 976                 if ( $allData['pluralRuleTypes'] === null ) {
 977                         $allData['pluralRuleTypes'] = array();
 978                 }
 979
 980                 # Set the list keys
 981                 $allData['list'] = array();
 982                 foreach ( self::$splitKeys as $key ) {
 983                         $allData['list'][$key] = array_keys( $allData[$key] );
 984                 }
 985                 # Run hooks
 986                 $purgeBlobs = true;
 987                 wfRunHooks( 'LocalisationCacheRecache', array( $this, $code, &$allData, &$purgeBlobs ) );
 988
 989                 if ( is_null( $allData['namespaceNames'] ) ) {
 990                         wfProfileOut( __METHOD__ );
 991                         throw new MWException( __METHOD__ . ': Localisation data failed sanity check! ' .
 992                                 'Check that your languages/messages/MessagesEn.php file is intact.' );
 993                 }
 994
 995                 # Set the preload key
 996                 $allData['preload'] = $this->buildPreload( $allData );
 997
 998                 # Save to the process cache and register the items loaded
 999                 $this->data[$code] = $allData;
1000                 foreach ( $allData as $key => $item ) {
1001                         $this->loadedItems[$code][$key] = true;
1002                 }
1003
1004                 # Save to the persistent cache
1005                 wfProfileIn( __METHOD__ . '-write' );
1006                 $this->store->startWrite( $code );
1007                 foreach ( $allData as $key => $value ) {
1008                         if ( in_array( $key, self::$splitKeys ) ) {
1009                                 foreach ( $value as $subkey => $subvalue ) {
1010                                         $this->store->set( "$key:$subkey", $subvalue );
1011                                 }
1012                         } else {
1013                                 $this->store->set( $key, $value );
1014                         }
1015                 }
1016                 $this->store->finishWrite();
1017                 wfProfileOut( __METHOD__ . '-write' );
1018
1019                 # Clear out the MessageBlobStore
1020                 # HACK: If using a null (i.e. disabled) storage backend, we
1021                 # can't write to the MessageBlobStore either
1022                 if ( $purgeBlobs && !$this->store instanceof LCStoreNull ) {
1023                         MessageBlobStore::getInstance()->clear();
1024                 }
1025
1026                 wfProfileOut( __METHOD__ );
1027         }
1028
1029         /**
1030          * Build the preload item from the given pre-cache data.
1031          *
1032          * The preload item will be loaded automatically, improving performance
1033          * for the commonly-requested items it contains.
1034          * @param array $data
1035          * @return array
1036          */
1037         protected function buildPreload( $data ) {
1038                 $preload = array( 'messages' => array() );
1039                 foreach ( self::$preloadedKeys as $key ) {
1040                         $preload[$key] = $data[$key];
1041                 }
1042
1043                 foreach ( $data['preloadedMessages'] as $subkey ) {
1044                         if ( isset( $data['messages'][$subkey] ) ) {
1045                                 $subitem = $data['messages'][$subkey];
1046                         } else {
1047                                 $subitem = null;
1048                         }
1049                         $preload['messages'][$subkey] = $subitem;
1050                 }
1051
1052                 return $preload;
1053         }
1054
1055         /**
1056          * Unload the data for a given language from the object cache.
1057          * Reduces memory usage.
1058          * @param string $code
1059          */
1060         public function unload( $code ) {
1061                 unset( $this->data[$code] );
1062                 unset( $this->loadedItems[$code] );
1063                 unset( $this->loadedSubitems[$code] );
1064                 unset( $this->initialisedLangs[$code] );
1065                 unset( $this->shallowFallbacks[$code] );
1066
1067                 foreach ( $this->shallowFallbacks as $shallowCode => $fbCode ) {
1068                         if ( $fbCode === $code ) {
1069                                 $this->unload( $shallowCode );
1070                         }
1071                 }
1072         }
1073
1074         /**
1075          * Unload all data
1076          */
1077         public function unloadAll() {
1078                 foreach ( $this->initialisedLangs as $lang => $unused ) {
1079                         $this->unload( $lang );
1080                 }
1081         }
1082
1083         /**
1084          * Disable the storage backend
1085          */
1086         public function disableBackend() {
1087                 $this->store = new LCStoreNull;
1088                 $this->manualRecache = false;
1089         }
1090 }
1091
1092 /**
1093  * Interface for the persistence layer of LocalisationCache.
1094  *
1095  * The persistence layer is two-level hierarchical cache. The first level
1096  * is the language, the second level is the item or subitem.
1097  *
1098  * Since the data for a whole language is rebuilt in one operation, it needs
1099  * to have a fast and atomic method for deleting or replacing all of the
1100  * current data for a given language. The interface reflects this bulk update
1101  * operation. Callers writing to the cache must first call startWrite(), then
1102  * will call set() a couple of thousand times, then will call finishWrite()
1103  * to commit the operation. When finishWrite() is called, the cache is
1104  * expected to delete all data previously stored for that language.
1105  *
1106  * The values stored are PHP variables suitable for serialize(). Implementations
1107  * of LCStore are responsible for serializing and unserializing.
1108  */
1109 interface LCStore {
1110         /**
1111          * Get a value.
1112          * @param string $code Language code
1113          * @param string $key Cache key
1114          */
1115         function get( $code, $key );
1116
1117         /**
1118          * Start a write transaction.
1119          * @param string $code Language code
1120          */
1121         function startWrite( $code );
1122
1123         /**
1124          * Finish a write transaction.
1125          */
1126         function finishWrite();
1127
1128         /**
1129          * Set a key to a given value. startWrite() must be called before this
1130          * is called, and finishWrite() must be called afterwards.
1131          * @param string $key
1132          * @param mixed $value
1133          */
1134         function set( $key, $value );
1135 }
1136
1137 /**
1138  * LCStore implementation which uses PHP accelerator to store data.
1139  * This will work if one of XCache, WinCache or APC cacher is configured.
1140  * (See ObjectCache.php)
1141  */
1142 class LCStoreAccel implements LCStore {
1143         private $currentLang;
1144         private $keys;
1145
1146         public function __construct() {
1147                 $this->cache = wfGetCache( CACHE_ACCEL );
1148         }
1149
1150         public function get( $code, $key ) {
1151                 $k = wfMemcKey( 'l10n', $code, 'k', $key );
1152                 $r = $this->cache->get( $k );
1153
1154                 return $r === false ? null : $r;
1155         }
1156
1157         public function startWrite( $code ) {
1158                 $k = wfMemcKey( 'l10n', $code, 'l' );
1159                 $keys = $this->cache->get( $k );
1160                 if ( $keys ) {
1161                         foreach ( $keys as $k ) {
1162                                 $this->cache->delete( $k );
1163                         }
1164                 }
1165                 $this->currentLang = $code;
1166                 $this->keys = array();
1167         }
1168
1169         public function finishWrite() {
1170                 if ( $this->currentLang ) {
1171                         $k = wfMemcKey( 'l10n', $this->currentLang, 'l' );
1172                         $this->cache->set( $k, array_keys( $this->keys ) );
1173                 }
1174                 $this->currentLang = null;
1175                 $this->keys = array();
1176         }
1177
1178         public function set( $key, $value ) {
1179                 if ( $this->currentLang ) {
1180                         $k = wfMemcKey( 'l10n', $this->currentLang, 'k', $key );
1181                         $this->keys[$k] = true;
1182                         $this->cache->set( $k, $value );
1183                 }
1184         }
1185 }
1186
1187 /**
1188  * LCStore implementation which uses the standard DB functions to store data.
1189  * This will work on any MediaWiki installation.
1190  */
1191 class LCStoreDB implements LCStore {
1192         private $currentLang;
1193         private $writesDone = false;
1194
1195         /** @var DatabaseBase */
1196         private $dbw;
1197         /** @var array */
1198         private $batch = array();
1199
1200         private $readOnly = false;
1201
1202         public function get( $code, $key ) {
1203                 if ( $this->writesDone ) {
1204                         $db = wfGetDB( DB_MASTER );
1205                 } else {
1206                         $db = wfGetDB( DB_SLAVE );
1207                 }
1208                 $row = $db->selectRow( 'l10n_cache', array( 'lc_value' ),
1209                         array( 'lc_lang' => $code, 'lc_key' => $key ), __METHOD__ );
1210                 if ( $row ) {
1211                         return unserialize( $db->decodeBlob( $row->lc_value ) );
1212                 } else {
1213                         return null;
1214                 }
1215         }
1216
1217         public function startWrite( $code ) {
1218                 if ( $this->readOnly ) {
1219                         return;
1220                 } elseif ( !$code ) {
1221                         throw new MWException( __METHOD__ . ": Invalid language \"$code\"" );
1222                 }
1223
1224                 $this->dbw = wfGetDB( DB_MASTER );
1225
1226                 $this->currentLang = $code;
1227                 $this->batch = array();
1228         }
1229
1230         public function finishWrite() {
1231                 if ( $this->readOnly ) {
1232                         return;
1233                 } elseif ( is_null( $this->currentLang ) ) {
1234                         throw new MWException( __CLASS__ . ': must call startWrite() before finishWrite()' );
1235                 }
1236
1237                 $this->dbw->begin( __METHOD__ );
1238                 try {
1239                         $this->dbw->delete( 'l10n_cache',
1240                                 array( 'lc_lang' => $this->currentLang ), __METHOD__ );
1241                         foreach ( array_chunk( $this->batch, 500 ) as $rows ) {
1242                                 $this->dbw->insert( 'l10n_cache', $rows, __METHOD__ );
1243                         }
1244                         $this->writesDone = true;
1245                 } catch ( DBQueryError $e ) {
1246                         if ( $this->dbw->wasReadOnlyError() ) {
1247                                 $this->readOnly = true; // just avoid site down time
1248                         } else {
1249                                 throw $e;
1250                         }
1251                 }
1252                 $this->dbw->commit( __METHOD__ );
1253
1254                 $this->currentLang = null;
1255                 $this->batch = array();
1256         }
1257
1258         public function set( $key, $value ) {
1259                 if ( $this->readOnly ) {
1260                         return;
1261                 } elseif ( is_null( $this->currentLang ) ) {
1262                         throw new MWException( __CLASS__ . ': must call startWrite() before set()' );
1263                 }
1264
1265                 $this->batch[] = array(
1266                         'lc_lang' => $this->currentLang,
1267                         'lc_key' => $key,
1268                         'lc_value' => $this->dbw->encodeBlob( serialize( $value ) ) );
1269         }
1270 }
1271
1272 /**
1273  * LCStore implementation which stores data as a collection of CDB files in the
1274  * directory given by $wgCacheDirectory. If $wgCacheDirectory is not set, this
1275  * will throw an exception.
1276  *
1277  * Profiling indicates that on Linux, this implementation outperforms MySQL if
1278  * the directory is on a local filesystem and there is ample kernel cache
1279  * space. The performance advantage is greater when the DBA extension is
1280  * available than it is with the PHP port.
1281  *
1282  * See Cdb.php and http://cr.yp.to/cdb.html
1283  */
1284 class LCStoreCDB implements LCStore {
1285         /** @var CdbReader[] */
1286         private $readers;
1287
1288         /** @var CdbWriter */
1289         private $writer;
1290
1291         /** @var string Current language code */
1292         private $currentLang;
1293
1294         /** @var bool|string Cache directory. False if not set */
1295         private $directory;
1296
1297         function __construct( $conf = array() ) {
1298                 global $wgCacheDirectory;
1299
1300                 if ( isset( $conf['directory'] ) ) {
1301                         $this->directory = $conf['directory'];
1302                 } else {
1303                         $this->directory = $wgCacheDirectory;
1304                 }
1305         }
1306
1307         public function get( $code, $key ) {
1308                 if ( !isset( $this->readers[$code] ) ) {
1309                         $fileName = $this->getFileName( $code );
1310
1311                         $this->readers[$code] = false;
1312                         if ( file_exists( $fileName ) ) {
1313                                 try {
1314                                         $this->readers[$code] = CdbReader::open( $fileName );
1315                                 } catch ( CdbException $e ) {
1316                                         wfDebug( __METHOD__ . ": unable to open cdb file for reading\n" );
1317                                 }
1318                         }
1319                 }
1320
1321                 if ( !$this->readers[$code] ) {
1322                         return null;
1323                 } else {
1324                         $value = false;
1325                         try {
1326                                 $value = $this->readers[$code]->get( $key );
1327                         } catch ( CdbException $e ) {
1328                                 wfDebug( __METHOD__ . ": CdbException caught, error message was "
1329                                         . $e->getMessage() . "\n" );
1330                         }
1331                         if ( $value === false ) {
1332                                 return null;
1333                         }
1334
1335                         return unserialize( $value );
1336                 }
1337         }
1338
1339         public function startWrite( $code ) {
1340                 if ( !file_exists( $this->directory ) ) {
1341                         if ( !wfMkdirParents( $this->directory, null, __METHOD__ ) ) {
1342                                 throw new MWException( "Unable to create the localisation store " .
1343                                         "directory \"{$this->directory}\"" );
1344                         }
1345                 }
1346
1347                 // Close reader to stop permission errors on write
1348                 if ( !empty( $this->readers[$code] ) ) {
1349                         $this->readers[$code]->close();
1350                 }
1351
1352                 try {
1353                         $this->writer = CdbWriter::open( $this->getFileName( $code ) );
1354                 } catch ( CdbException $e ) {
1355                         throw new MWException( $e->getMessage() );
1356                 }
1357                 $this->currentLang = $code;
1358         }
1359
1360         public function finishWrite() {
1361                 // Close the writer
1362                 try {
1363                         $this->writer->close();
1364                 } catch ( CdbException $e ) {
1365                         throw new MWException( $e->getMessage() );
1366                 }
1367                 $this->writer = null;
1368                 unset( $this->readers[$this->currentLang] );
1369                 $this->currentLang = null;
1370         }
1371
1372         public function set( $key, $value ) {
1373                 if ( is_null( $this->writer ) ) {
1374                         throw new MWException( __CLASS__ . ': must call startWrite() before calling set()' );
1375                 }
1376                 try {
1377                         $this->writer->set( $key, serialize( $value ) );
1378                 } catch ( CdbException $e ) {
1379                         throw new MWException( $e->getMessage() );
1380                 }
1381         }
1382
1383         protected function getFileName( $code ) {
1384                 if ( strval( $code ) === '' || strpos( $code, '/' ) !== false ) {
1385                         throw new MWException( __METHOD__ . ": Invalid language \"$code\"" );
1386                 }
1387
1388                 return "{$this->directory}/l10n_cache-$code.cdb";
1389         }
1390 }
1391
1392 /**
1393  * Null store backend, used to avoid DB errors during install
1394  */
1395 class LCStoreNull implements LCStore {
1396         public function get( $code, $key ) {
1397                 return null;
1398         }
1399
1400         public function startWrite( $code ) {
1401         }
1402
1403         public function finishWrite() {
1404         }
1405
1406         public function set( $key, $value ) {
1407         }
1408 }
1409
1410 /**
1411  * A localisation cache optimised for loading large amounts of data for many
1412  * languages. Used by rebuildLocalisationCache.php.
1413  */
1414 class LocalisationCacheBulkLoad extends LocalisationCache {
1415         /**
1416          * A cache of the contents of data files.
1417          * Core files are serialized to avoid using ~1GB of RAM during a recache.
1418          */
1419         private $fileCache = array();
1420
1421         /**
1422          * Most recently used languages. Uses the linked-list aspect of PHP hashtables
1423          * to keep the most recently used language codes at the end of the array, and
1424          * the language codes that are ready to be deleted at the beginning.
1425          */
1426         private $mruLangs = array();
1427
1428         /**
1429          * Maximum number of languages that may be loaded into $this->data
1430          */
1431         private $maxLoadedLangs = 10;
1432
1433         /**
1434          * @param string $fileName
1435          * @param string $fileType
1436          * @return array|mixed
1437          */
1438         protected function readPHPFile( $fileName, $fileType ) {
1439                 $serialize = $fileType === 'core';
1440                 if ( !isset( $this->fileCache[$fileName][$fileType] ) ) {
1441                         $data = parent::readPHPFile( $fileName, $fileType );
1442
1443                         if ( $serialize ) {
1444                                 $encData = serialize( $data );
1445                         } else {
1446                                 $encData = $data;
1447                         }
1448
1449                         $this->fileCache[$fileName][$fileType] = $encData;
1450
1451                         return $data;
1452                 } elseif ( $serialize ) {
1453                         return unserialize( $this->fileCache[$fileName][$fileType] );
1454                 } else {
1455                         return $this->fileCache[$fileName][$fileType];
1456                 }
1457         }
1458
1459         /**
1460          * @param string $code
1461          * @param string $key
1462          * @return mixed
1463          */
1464         public function getItem( $code, $key ) {
1465                 unset( $this->mruLangs[$code] );
1466                 $this->mruLangs[$code] = true;
1467
1468                 return parent::getItem( $code, $key );
1469         }
1470
1471         /**
1472          * @param string $code
1473          * @param string $key
1474          * @param string $subkey
1475          * @return mixed
1476          */
1477         public function getSubitem( $code, $key, $subkey ) {
1478                 unset( $this->mruLangs[$code] );
1479                 $this->mruLangs[$code] = true;
1480
1481                 return parent::getSubitem( $code, $key, $subkey );
1482         }
1483
1484         /**
1485          * @param string $code
1486          */
1487         public function recache( $code ) {
1488                 parent::recache( $code );
1489                 unset( $this->mruLangs[$code] );
1490                 $this->mruLangs[$code] = true;
1491                 $this->trimCache();
1492         }
1493
1494         /**
1495          * @param string $code
1496          */
1497         public function unload( $code ) {
1498                 unset( $this->mruLangs[$code] );
1499                 parent::unload( $code );
1500         }
1501
1502         /**
1503          * Unload cached languages until there are less than $this->maxLoadedLangs
1504          */
1505         protected function trimCache() {
1506                 while ( count( $this->data ) > $this->maxLoadedLangs && count( $this->mruLangs ) ) {
1507                         reset( $this->mruLangs );
1508                         $code = key( $this->mruLangs );
1509                         wfDebug( __METHOD__ . ": unloading $code\n" );
1510                         $this->unload( $code );
1511                 }
1512         }
1513 }