MediaWiki  master
LocalisationCache.php
Go to the documentation of this file.
1 <?php
21 use CLDRPluralRuleParser\Error as CLDRPluralRuleError;
22 use CLDRPluralRuleParser\Evaluator;
28 use Psr\Log\LoggerInterface;
29 
47  public const VERSION = 4;
48 
50  private $options;
51 
57  private $manualRecache;
58 
65  protected $data = [];
66 
72  private $store;
73 
77  private $logger;
78 
80  private $hookRunner;
81 
83  private $clearStoreCallbacks;
84 
86  private $langNameUtils;
87 
96  private $loadedItems = [];
97 
102  private $loadedSubitems = [];
103 
109  private $initialisedLangs = [];
110 
116  private $shallowFallbacks = [];
117 
121  private $recachedLangs = [];
122 
126  public static $allKeys = [
127  'fallback', 'namespaceNames', 'bookstoreList',
128  'magicWords', 'messages', 'rtl',
129  'digitTransformTable', 'separatorTransformTable',
130  'minimumGroupingDigits', 'fallback8bitEncoding',
131  'linkPrefixExtension', 'linkTrail', 'linkPrefixCharset',
132  'namespaceAliases', 'dateFormats', 'datePreferences',
133  'datePreferenceMigrationMap', 'defaultDateFormat',
134  'specialPageAliases', 'imageFiles', 'preloadedMessages',
135  'namespaceGenderAliases', 'digitGroupingPattern', 'pluralRules',
136  'pluralRuleTypes', 'compiledPluralRules',
137  ];
138 
143  public static $mergeableMapKeys = [ 'messages', 'namespaceNames',
144  'namespaceAliases', 'dateFormats', 'imageFiles', 'preloadedMessages'
145  ];
146 
150  public static $mergeableListKeys = [];
151 
156  public static $mergeableAliasListKeys = [ 'specialPageAliases' ];
157 
163  public static $optionalMergeKeys = [ 'bookstoreList' ];
164 
168  public static $magicWordKeys = [ 'magicWords' ];
169 
173  public static $splitKeys = [ 'messages' ];
174 
178  public static $preloadedKeys = [ 'dateFormats', 'namespaceNames' ];
179 
184  private $pluralRules = null;
185 
198  private $pluralRuleTypes = null;
199 
200  private $mergeableKeys = null;
201 
210  public static function getStoreFromConf( array $conf, $fallbackCacheDir ): LCStore {
211  $storeArg = [];
212  $storeArg['directory'] =
213  $conf['storeDirectory'] ?: $fallbackCacheDir;
214 
215  if ( !empty( $conf['storeClass'] ) ) {
216  $storeClass = $conf['storeClass'];
217  } elseif ( $conf['store'] === 'files' || $conf['store'] === 'file' ||
218  ( $conf['store'] === 'detect' && $storeArg['directory'] )
219  ) {
220  $storeClass = LCStoreCDB::class;
221  } elseif ( $conf['store'] === 'db' || $conf['store'] === 'detect' ) {
222  $storeClass = LCStoreDB::class;
223  $storeArg['server'] = $conf['storeServer'] ?? [];
224  } elseif ( $conf['store'] === 'array' ) {
225  $storeClass = LCStoreStaticArray::class;
226  } else {
227  throw new MWException(
228  'Please set $wgLocalisationCacheConf[\'store\'] to something sensible.'
229  );
230  }
231 
232  return new $storeClass( $storeArg );
233  }
234 
238  public const CONSTRUCTOR_OPTIONS = [
239  // True to treat all files as expired until they are regenerated by this object.
240  'forceRecache',
241  'manualRecache',
242  MainConfigNames::ExtensionMessagesFiles,
243  MainConfigNames::MessagesDirs,
244  ];
245 
259  public function __construct(
260  ServiceOptions $options,
261  LCStore $store,
262  LoggerInterface $logger,
263  array $clearStoreCallbacks,
264  LanguageNameUtils $langNameUtils,
265  HookContainer $hookContainer
266  ) {
267  $options->assertRequiredOptions( self::CONSTRUCTOR_OPTIONS );
268 
269  $this->options = $options;
270  $this->store = $store;
271  $this->logger = $logger;
272  $this->clearStoreCallbacks = $clearStoreCallbacks;
273  $this->langNameUtils = $langNameUtils;
274  $this->hookRunner = new HookRunner( $hookContainer );
275 
276  // Keep this separate from $this->options so it can be mutable
277  $this->manualRecache = $options->get( 'manualRecache' );
278  }
279 
286  public function isMergeableKey( $key ) {
287  if ( $this->mergeableKeys === null ) {
288  $this->mergeableKeys = array_fill_keys( array_merge(
289  self::$mergeableMapKeys,
290  self::$mergeableListKeys,
291  self::$mergeableAliasListKeys,
292  self::$optionalMergeKeys,
293  self::$magicWordKeys
294  ), true );
295  }
296 
297  return isset( $this->mergeableKeys[$key] );
298  }
299 
309  public function getItem( $code, $key ) {
310  if ( !isset( $this->loadedItems[$code][$key] ) ) {
311  $this->loadItem( $code, $key );
312  }
313 
314  if ( $key === 'fallback' && isset( $this->shallowFallbacks[$code] ) ) {
315  return $this->shallowFallbacks[$code];
316  }
317 
318  return $this->data[$code][$key];
319  }
320 
328  public function getSubitem( $code, $key, $subkey ) {
329  if ( !isset( $this->loadedSubitems[$code][$key][$subkey] ) &&
330  !isset( $this->loadedItems[$code][$key] )
331  ) {
332  $this->loadSubitem( $code, $key, $subkey );
333  }
334 
335  return $this->data[$code][$key][$subkey] ?? null;
336  }
337 
350  public function getSubitemList( $code, $key ) {
351  if ( in_array( $key, self::$splitKeys ) ) {
352  return $this->getSubitem( $code, 'list', $key );
353  } else {
354  $item = $this->getItem( $code, $key );
355  if ( is_array( $item ) ) {
356  return array_keys( $item );
357  } else {
358  return false;
359  }
360  }
361  }
362 
368  protected function loadItem( $code, $key ) {
369  if ( !isset( $this->initialisedLangs[$code] ) ) {
370  $this->initLanguage( $code );
371  }
372 
373  // Check to see if initLanguage() loaded it for us
374  if ( isset( $this->loadedItems[$code][$key] ) ) {
375  return;
376  }
377 
378  if ( isset( $this->shallowFallbacks[$code] ) ) {
379  $this->loadItem( $this->shallowFallbacks[$code], $key );
380 
381  return;
382  }
383 
384  if ( in_array( $key, self::$splitKeys ) ) {
385  $subkeyList = $this->getSubitem( $code, 'list', $key );
386  foreach ( $subkeyList as $subkey ) {
387  if ( isset( $this->data[$code][$key][$subkey] ) ) {
388  continue;
389  }
390  $this->data[$code][$key][$subkey] = $this->getSubitem( $code, $key, $subkey );
391  }
392  } else {
393  $this->data[$code][$key] = $this->store->get( $code, $key );
394  }
395 
396  $this->loadedItems[$code][$key] = true;
397  }
398 
405  protected function loadSubitem( $code, $key, $subkey ) {
406  if ( !in_array( $key, self::$splitKeys ) ) {
407  $this->loadItem( $code, $key );
408 
409  return;
410  }
411 
412  if ( !isset( $this->initialisedLangs[$code] ) ) {
413  $this->initLanguage( $code );
414  }
415 
416  // Check to see if initLanguage() loaded it for us
417  if ( isset( $this->loadedItems[$code][$key] ) ||
418  isset( $this->loadedSubitems[$code][$key][$subkey] )
419  ) {
420  return;
421  }
422 
423  if ( isset( $this->shallowFallbacks[$code] ) ) {
424  $this->loadSubitem( $this->shallowFallbacks[$code], $key, $subkey );
425 
426  return;
427  }
428 
429  $value = $this->store->get( $code, "$key:$subkey" );
430  $this->data[$code][$key][$subkey] = $value;
431  $this->loadedSubitems[$code][$key][$subkey] = true;
432  }
433 
441  public function isExpired( $code ) {
442  if ( $this->options->get( 'forceRecache' ) && !isset( $this->recachedLangs[$code] ) ) {
443  $this->logger->debug( __METHOD__ . "($code): forced reload" );
444 
445  return true;
446  }
447 
448  $deps = $this->store->get( $code, 'deps' );
449  $keys = $this->store->get( $code, 'list' );
450  $preload = $this->store->get( $code, 'preload' );
451  // Different keys may expire separately for some stores
452  if ( $deps === null || $keys === null || $preload === null ) {
453  $this->logger->debug( __METHOD__ . "($code): cache missing, need to make one" );
454 
455  return true;
456  }
457 
458  foreach ( $deps as $dep ) {
459  // Because we're unserializing stuff from cache, we
460  // could receive objects of classes that don't exist
461  // anymore (e.g. uninstalled extensions)
462  // When this happens, always expire the cache
463  if ( !$dep instanceof CacheDependency || $dep->isExpired() ) {
464  $this->logger->debug( __METHOD__ . "($code): cache for $code expired due to " .
465  get_class( $dep ) );
466 
467  return true;
468  }
469  }
470 
471  return false;
472  }
473 
479  protected function initLanguage( $code ) {
480  if ( isset( $this->initialisedLangs[$code] ) ) {
481  return;
482  }
483 
484  $this->initialisedLangs[$code] = true;
485 
486  # If the code is of the wrong form for a Messages*.php file, do a shallow fallback
487  if ( !$this->langNameUtils->isValidBuiltInCode( $code ) ) {
488  $this->initShallowFallback( $code, 'en' );
489 
490  return;
491  }
492 
493  # Recache the data if necessary
494  if ( !$this->manualRecache && $this->isExpired( $code ) ) {
495  if ( $this->langNameUtils->isSupportedLanguage( $code ) ) {
496  $this->recache( $code );
497  } elseif ( $code === 'en' ) {
498  throw new MWException( 'MessagesEn.php is missing.' );
499  } else {
500  $this->initShallowFallback( $code, 'en' );
501  }
502 
503  return;
504  }
505 
506  # Preload some stuff
507  $preload = $this->getItem( $code, 'preload' );
508  if ( $preload === null ) {
509  if ( $this->manualRecache ) {
510  // No Messages*.php file. Do shallow fallback to en.
511  if ( $code === 'en' ) {
512  throw new MWException( 'No localisation cache found for English. ' .
513  'Please run maintenance/rebuildLocalisationCache.php.' );
514  }
515  $this->initShallowFallback( $code, 'en' );
516 
517  return;
518  } else {
519  throw new MWException( 'Invalid or missing localisation cache.' );
520  }
521  }
522  $this->data[$code] = $preload;
523  foreach ( $preload as $key => $item ) {
524  if ( in_array( $key, self::$splitKeys ) ) {
525  foreach ( $item as $subkey => $subitem ) {
526  $this->loadedSubitems[$code][$key][$subkey] = true;
527  }
528  } else {
529  $this->loadedItems[$code][$key] = true;
530  }
531  }
532  }
533 
540  public function initShallowFallback( $primaryCode, $fallbackCode ) {
541  $this->data[$primaryCode] =& $this->data[$fallbackCode];
542  $this->loadedItems[$primaryCode] =& $this->loadedItems[$fallbackCode];
543  $this->loadedSubitems[$primaryCode] =& $this->loadedSubitems[$fallbackCode];
544  $this->shallowFallbacks[$primaryCode] = $fallbackCode;
545  }
546 
554  protected function readPHPFile( $_fileName, $_fileType ) {
555  include $_fileName;
556 
557  $data = [];
558  if ( $_fileType == 'core' || $_fileType == 'extension' ) {
559  foreach ( self::$allKeys as $key ) {
560  // Not all keys are set in language files, so
561  // check they exist first
562  if ( isset( $$key ) ) {
563  $data[$key] = $$key;
564  }
565  }
566  } elseif ( $_fileType == 'aliases' ) {
567  // @phan-suppress-next-line PhanImpossibleCondition May be set in included file
568  if ( isset( $aliases ) ) {
569  $data['aliases'] = $aliases;
570  }
571  } else {
572  throw new MWException( __METHOD__ . ": Invalid file type: $_fileType" );
573  }
574 
575  return $data;
576  }
577 
584  public function readJSONFile( $fileName ) {
585  if ( !is_readable( $fileName ) ) {
586  return [];
587  }
588 
589  $json = file_get_contents( $fileName );
590  if ( $json === false ) {
591  return [];
592  }
593 
594  $data = FormatJson::decode( $json, true );
595  if ( $data === null ) {
596  throw new MWException( __METHOD__ . ": Invalid JSON file: $fileName" );
597  }
598 
599  // Remove keys starting with '@', they're reserved for metadata and non-message data
600  foreach ( $data as $key => $unused ) {
601  if ( $key === '' || $key[0] === '@' ) {
602  unset( $data[$key] );
603  }
604  }
605 
606  // The JSON format only supports messages, none of the other variables, so wrap the data
607  return [ 'messages' => $data ];
608  }
609 
616  public function getCompiledPluralRules( $code ) {
617  $rules = $this->getPluralRules( $code );
618  if ( $rules === null ) {
619  return null;
620  }
621  try {
622  $compiledRules = Evaluator::compile( $rules );
623  } catch ( CLDRPluralRuleError $e ) {
624  $this->logger->debug( $e->getMessage() );
625 
626  return [];
627  }
628 
629  return $compiledRules;
630  }
631 
639  public function getPluralRules( $code ) {
640  if ( $this->pluralRules === null ) {
641  $this->loadPluralFiles();
642  }
643  return $this->pluralRules[$code] ?? null;
644  }
645 
653  public function getPluralRuleTypes( $code ) {
654  if ( $this->pluralRuleTypes === null ) {
655  $this->loadPluralFiles();
656  }
657  return $this->pluralRuleTypes[$code] ?? null;
658  }
659 
663  protected function loadPluralFiles() {
664  foreach ( $this->getPluralFiles() as $fileName ) {
665  $this->loadPluralFile( $fileName );
666  }
667  }
668 
669  private function getPluralFiles(): array {
670  global $IP;
671  return [
672  // Load CLDR plural rules
673  "$IP/languages/data/plurals.xml",
674  // Override or extend with MW-specific rules
675  "$IP/languages/data/plurals-mediawiki.xml",
676  ];
677  }
678 
686  protected function loadPluralFile( $fileName ) {
687  // Use file_get_contents instead of DOMDocument::load (T58439)
688  $xml = file_get_contents( $fileName );
689  if ( !$xml ) {
690  throw new MWException( "Unable to read plurals file $fileName" );
691  }
692  $doc = new DOMDocument;
693  $doc->loadXML( $xml );
694  $rulesets = $doc->getElementsByTagName( "pluralRules" );
695  foreach ( $rulesets as $ruleset ) {
696  $codes = $ruleset->getAttribute( 'locales' );
697  $rules = [];
698  $ruleTypes = [];
699  $ruleElements = $ruleset->getElementsByTagName( "pluralRule" );
700  foreach ( $ruleElements as $elt ) {
701  $ruleType = $elt->getAttribute( 'count' );
702  if ( $ruleType === 'other' ) {
703  // Don't record "other" rules, which have an empty condition
704  continue;
705  }
706  $rules[] = $elt->nodeValue;
707  $ruleTypes[] = $ruleType;
708  }
709  foreach ( explode( ' ', $codes ) as $code ) {
710  $this->pluralRules[$code] = $rules;
711  $this->pluralRuleTypes[$code] = $ruleTypes;
712  }
713  }
714  }
715 
725  protected function readSourceFilesAndRegisterDeps( $code, &$deps ) {
726  // This reads in the PHP i18n file with non-messages l10n data
727  $fileName = $this->langNameUtils->getMessagesFileName( $code );
728  if ( !is_file( $fileName ) ) {
729  $data = [];
730  } else {
731  $deps[] = new FileDependency( $fileName );
732  $data = $this->readPHPFile( $fileName, 'core' );
733  }
734 
735  // Load CLDR plural rules for JavaScript
736  $data['pluralRules'] = $this->getPluralRules( $code );
737  // And for PHP
738  $data['compiledPluralRules'] = $this->getCompiledPluralRules( $code );
739  // Load plural rule types
740  $data['pluralRuleTypes'] = $this->getPluralRuleTypes( $code );
741 
742  foreach ( $this->getPluralFiles() as $fileName ) {
743  $deps[] = new FileDependency( $fileName );
744  }
745 
746  return $data;
747  }
748 
756  protected function mergeItem( $key, &$value, $fallbackValue ) {
757  if ( $value !== null ) {
758  if ( $fallbackValue !== null ) {
759  if ( in_array( $key, self::$mergeableMapKeys ) ) {
760  $value += $fallbackValue;
761  } elseif ( in_array( $key, self::$mergeableListKeys ) ) {
762  $value = array_unique( array_merge( $fallbackValue, $value ) );
763  } elseif ( in_array( $key, self::$mergeableAliasListKeys ) ) {
764  $value = array_merge_recursive( $value, $fallbackValue );
765  } elseif ( in_array( $key, self::$optionalMergeKeys ) ) {
766  if ( !empty( $value['inherit'] ) ) {
767  $value = array_merge( $fallbackValue, $value );
768  }
769 
770  unset( $value['inherit'] );
771  } elseif ( in_array( $key, self::$magicWordKeys ) ) {
772  $this->mergeMagicWords( $value, $fallbackValue );
773  }
774  }
775  } else {
776  $value = $fallbackValue;
777  }
778  }
779 
784  protected function mergeMagicWords( &$value, $fallbackValue ) {
785  foreach ( $fallbackValue as $magicName => $fallbackInfo ) {
786  if ( !isset( $value[$magicName] ) ) {
787  $value[$magicName] = $fallbackInfo;
788  } else {
789  $oldSynonyms = array_slice( $fallbackInfo, 1 );
790  $newSynonyms = array_slice( $value[$magicName], 1 );
791  $synonyms = array_values( array_unique( array_merge(
792  $newSynonyms, $oldSynonyms ) ) );
793  $value[$magicName] = array_merge( [ $fallbackInfo[0] ], $synonyms );
794  }
795  }
796  }
797 
805  public function getMessagesDirs() {
806  global $IP;
807 
808  return [
809  'core' => "$IP/languages/i18n",
810  'exif' => "$IP/languages/i18n/exif",
811  'api' => "$IP/includes/api/i18n",
812  'rest' => "$IP/includes/Rest/i18n",
813  'oojs-ui' => "$IP/resources/lib/ooui/i18n",
814  'paramvalidator' => "$IP/includes/libs/ParamValidator/i18n",
815  ] + $this->options->get( MainConfigNames::MessagesDirs );
816  }
817 
824  public function recache( $code ) {
825  if ( !$code ) {
826  throw new MWException( "Invalid language code requested" );
827  }
828  $this->recachedLangs[ $code ] = true;
829 
830  # Initial values
831  $initialData = array_fill_keys( self::$allKeys, null );
832  $coreData = $initialData;
833  $deps = [];
834 
835  # Load the primary localisation from the source file
836  $data = $this->readSourceFilesAndRegisterDeps( $code, $deps );
837  $this->logger->debug( __METHOD__ . ": got localisation for $code from source" );
838 
839  # Merge primary localisation
840  foreach ( $data as $key => $value ) {
841  $this->mergeItem( $key, $coreData[ $key ], $value );
842  }
843 
844  # Fill in the fallback if it's not there already
845  // @phan-suppress-next-line PhanSuspiciousValueComparison
846  if ( ( $coreData['fallback'] === null || $coreData['fallback'] === false ) && $code === 'en' ) {
847  $coreData['fallback'] = false;
848  $coreData['originalFallbackSequence'] = $coreData['fallbackSequence'] = [];
849  } else {
850  if ( $coreData['fallback'] !== null ) {
851  $coreData['fallbackSequence'] = array_map( 'trim', explode( ',', $coreData['fallback'] ) );
852  } else {
853  $coreData['fallbackSequence'] = [];
854  }
855  $len = count( $coreData['fallbackSequence'] );
856 
857  # Before we add the 'en' fallback for messages, keep a copy of
858  # the original fallback sequence
859  $coreData['originalFallbackSequence'] = $coreData['fallbackSequence'];
860 
861  # Ensure that the sequence ends at 'en' for messages
862  if ( !$len || $coreData['fallbackSequence'][$len - 1] !== 'en' ) {
863  $coreData['fallbackSequence'][] = 'en';
864  }
865  }
866 
867  $codeSequence = array_merge( [ $code ], $coreData['fallbackSequence'] );
868  $messageDirs = $this->getMessagesDirs();
869 
870  # Load non-JSON localisation data for extensions
871  $extensionData = array_fill_keys( $codeSequence, $initialData );
872  foreach ( $this->options->get( MainConfigNames::ExtensionMessagesFiles ) as $extension => $fileName ) {
873  if ( isset( $messageDirs[$extension] ) ) {
874  # This extension has JSON message data; skip the PHP shim
875  continue;
876  }
877 
878  $data = $this->readPHPFile( $fileName, 'extension' );
879  $used = false;
880 
881  foreach ( $data as $key => $item ) {
882  foreach ( $codeSequence as $csCode ) {
883  if ( isset( $item[$csCode] ) ) {
884  $this->mergeItem( $key, $extensionData[$csCode][$key], $item[$csCode] );
885  $used = true;
886  }
887  }
888  }
889 
890  if ( $used ) {
891  $deps[] = new FileDependency( $fileName );
892  }
893  }
894 
895  # Load the localisation data for each fallback, then merge it into the full array
896  $allData = $initialData;
897  foreach ( $codeSequence as $csCode ) {
898  $csData = $initialData;
899 
900  # Load core messages and the extension localisations.
901  foreach ( $messageDirs as $dirs ) {
902  foreach ( (array)$dirs as $dir ) {
903  $fileName = "$dir/$csCode.json";
904  $data = $this->readJSONFile( $fileName );
905 
906  foreach ( $data as $key => $item ) {
907  $this->mergeItem( $key, $csData[$key], $item );
908  }
909 
910  $deps[] = new FileDependency( $fileName );
911  }
912  }
913 
914  # Merge non-JSON extension data
915  if ( isset( $extensionData[$csCode] ) ) {
916  foreach ( $extensionData[$csCode] as $key => $item ) {
917  $this->mergeItem( $key, $csData[$key], $item );
918  }
919  }
920 
921  if ( $csCode === $code ) {
922  # Merge core data into extension data
923  foreach ( $coreData as $key => $item ) {
924  $this->mergeItem( $key, $csData[$key], $item );
925  }
926  } else {
927  # Load the secondary localisation from the source file to
928  # avoid infinite cycles on cyclic fallbacks
929  $fbData = $this->readSourceFilesAndRegisterDeps( $csCode, $deps );
930  # Only merge the keys that make sense to merge
931  foreach ( self::$allKeys as $key ) {
932  if ( !isset( $fbData[ $key ] ) ) {
933  continue;
934  }
935 
936  if ( ( $coreData[ $key ] ) === null || $this->isMergeableKey( $key ) ) {
937  $this->mergeItem( $key, $csData[ $key ], $fbData[ $key ] );
938  }
939  }
940  }
941 
942  # Allow extensions an opportunity to adjust the data for this
943  # fallback
944  $this->hookRunner->onLocalisationCacheRecacheFallback( $this, $csCode, $csData );
945 
946  # Merge the data for this fallback into the final array
947  if ( $csCode === $code ) {
948  $allData = $csData;
949  } else {
950  foreach ( self::$allKeys as $key ) {
951  if ( !isset( $csData[$key] ) ) {
952  continue;
953  }
954 
955  // @phan-suppress-next-line PhanTypeArraySuspiciousNullable
956  if ( $allData[$key] === null || $this->isMergeableKey( $key ) ) {
957  $this->mergeItem( $key, $allData[$key], $csData[$key] );
958  }
959  }
960  }
961  }
962 
963  if ( !isset( $allData['rtl'] ) ) {
964  throw new MWException( __METHOD__ . ': Localisation data failed validation check! ' .
965  'Check that your languages/messages/MessagesEn.php file is intact.' );
966  }
967 
968  # Add cache dependencies for any referenced globals
969  $deps['wgExtensionMessagesFiles'] = new GlobalDependency( 'wgExtensionMessagesFiles' );
970  // The 'MessagesDirs' config setting is used in LocalisationCache::getMessagesDirs().
971  // We use the key 'wgMessagesDirs' for historical reasons.
972  $deps['wgMessagesDirs'] = new MainConfigDependency( MainConfigNames::MessagesDirs );
973  $deps['version'] = new ConstantDependency( 'LocalisationCache::VERSION' );
974 
975  # Add dependencies to the cache entry
976  $allData['deps'] = $deps;
977 
978  # Replace spaces with underscores in namespace names
979  $allData['namespaceNames'] = str_replace( ' ', '_', $allData['namespaceNames'] );
980 
981  # And do the same for special page aliases. $page is an array.
982  foreach ( $allData['specialPageAliases'] as &$page ) {
983  $page = str_replace( ' ', '_', $page );
984  }
985  # Decouple the reference to prevent accidental damage
986  unset( $page );
987 
988  # If there were no plural rules, return an empty array
989  if ( $allData['pluralRules'] === null ) {
990  $allData['pluralRules'] = [];
991  }
992  if ( $allData['compiledPluralRules'] === null ) {
993  $allData['compiledPluralRules'] = [];
994  }
995  # If there were no plural rule types, return an empty array
996  if ( $allData['pluralRuleTypes'] === null ) {
997  $allData['pluralRuleTypes'] = [];
998  }
999 
1000  # Set the list keys
1001  $allData['list'] = [];
1002  foreach ( self::$splitKeys as $key ) {
1003  $allData['list'][$key] = array_keys( $allData[$key] );
1004  }
1005  # Run hooks
1006  $unused = true; // Used to be $purgeBlobs, removed in 1.34
1007  $this->hookRunner->onLocalisationCacheRecache( $this, $code, $allData, $unused );
1008 
1009  # Set the preload key
1010  $allData['preload'] = $this->buildPreload( $allData );
1011 
1012  # Save to the process cache and register the items loaded
1013  $this->data[$code] = $allData;
1014  foreach ( $allData as $key => $item ) {
1015  $this->loadedItems[$code][$key] = true;
1016  }
1017 
1018  # Save to the persistent cache
1019  $this->store->startWrite( $code );
1020  foreach ( $allData as $key => $value ) {
1021  if ( in_array( $key, self::$splitKeys ) ) {
1022  foreach ( $value as $subkey => $subvalue ) {
1023  $this->store->set( "$key:$subkey", $subvalue );
1024  }
1025  } else {
1026  $this->store->set( $key, $value );
1027  }
1028  }
1029  $this->store->finishWrite();
1030 
1031  # Clear out the MessageBlobStore
1032  # HACK: If using a null (i.e. disabled) storage backend, we
1033  # can't write to the MessageBlobStore either
1034  if ( !$this->store instanceof LCStoreNull ) {
1035  foreach ( $this->clearStoreCallbacks as $callback ) {
1036  $callback();
1037  }
1038  }
1039  }
1040 
1049  protected function buildPreload( $data ) {
1050  $preload = [ 'messages' => [] ];
1051  foreach ( self::$preloadedKeys as $key ) {
1052  $preload[$key] = $data[$key];
1053  }
1054 
1055  foreach ( $data['preloadedMessages'] as $subkey ) {
1056  $subitem = $data['messages'][$subkey] ?? null;
1057  $preload['messages'][$subkey] = $subitem;
1058  }
1059 
1060  return $preload;
1061  }
1062 
1068  public function unload( $code ) {
1069  unset( $this->data[$code] );
1070  unset( $this->loadedItems[$code] );
1071  unset( $this->loadedSubitems[$code] );
1072  unset( $this->initialisedLangs[$code] );
1073  unset( $this->shallowFallbacks[$code] );
1074 
1075  foreach ( $this->shallowFallbacks as $shallowCode => $fbCode ) {
1076  if ( $fbCode === $code ) {
1077  $this->unload( $shallowCode );
1078  }
1079  }
1080  }
1081 
1085  public function unloadAll() {
1086  foreach ( $this->initialisedLangs as $lang => $unused ) {
1087  $this->unload( $lang );
1088  }
1089  }
1090 
1094  public function disableBackend() {
1095  $this->store = new LCStoreNull;
1096  $this->manualRecache = false;
1097  }
1098 }
if(!defined( 'MEDIAWIKI')) if(ini_get( 'mbstring.func_overload')) if(!defined( 'MW_ENTRY_POINT')) global $IP
Environment checks.
Definition: Setup.php:91
Base class to represent dependencies for LocalisationCache entries.
isExpired()
Returns true if the dependency is expired, false otherwise.
Depend on a PHP constant.
Depend on a file.
static decode( $value, $assoc=false)
Decodes a JSON string.
Definition: FormatJson.php:146
Depend on a PHP global variable.
Null store backend, used to avoid DB errors during install.
Definition: LCStoreNull.php:26
Caching for the contents of localisation files.
static $magicWordKeys
Keys for items that are formatted like $magicWords.
buildPreload( $data)
Build the preload item from the given pre-cache data.
initLanguage( $code)
Initialise a language in this object.
static $mergeableMapKeys
Keys for items which consist of associative arrays, which may be merged by a fallback sequence.
readSourceFilesAndRegisterDeps( $code, &$deps)
Read the data from the source files for a given language, and register the relevant dependencies in t...
isMergeableKey( $key)
Returns true if the given key is mergeable, that is, if it is an associative array which can be merge...
loadPluralFile( $fileName)
Load a plural XML file with the given filename, compile the relevant rules, and save the compiled rul...
getPluralRules( $code)
Get the plural rules for a given language from the XML files.
readPHPFile( $_fileName, $_fileType)
Read a PHP file containing localisation data.
readJSONFile( $fileName)
Read a JSON file containing localisation messages.
loadPluralFiles()
Load the plural XML files.
unload( $code)
Unload the data for a given language from the object cache.
unloadAll()
Unload all data.
disableBackend()
Disable the storage backend.
static $mergeableAliasListKeys
Keys for items which contain an array of arrays of equivalent aliases for each subitem.
getSubitemList( $code, $key)
Get the list of subitem keys for a given item.
$data
The cache data.
__construct(ServiceOptions $options, LCStore $store, LoggerInterface $logger, array $clearStoreCallbacks, LanguageNameUtils $langNameUtils, HookContainer $hookContainer)
For constructor parameters, \MediaWiki\MainConfigSchema::LocalisationCacheConf.
static $mergeableListKeys
Keys for items which are a numbered array.
recache( $code)
Load localisation data for a given language for both core and extensions and save it to the persisten...
isExpired( $code)
Returns true if the cache identified by $code is missing or expired.
mergeItem( $key, &$value, $fallbackValue)
Merge two localisation values, a primary and a fallback, overwriting the primary value in place.
getSubitem( $code, $key, $subkey)
Get a subitem, for instance a single message for a given language.
mergeMagicWords(&$value, $fallbackValue)
initShallowFallback( $primaryCode, $fallbackCode)
Create a fallback from one language to another, without creating a complete persistent cache.
static getStoreFromConf(array $conf, $fallbackCacheDir)
Return a suitable LCStore as specified by the given configuration.
static $allKeys
All item keys.
getCompiledPluralRules( $code)
Get the compiled plural rules for a given language from the XML files.
static $optionalMergeKeys
Keys for items which contain an associative array, and may be merged if the primary value contains th...
getMessagesDirs()
Gets the combined list of messages dirs from core and extensions.
static $preloadedKeys
Keys which are loaded automatically by initLanguage()
getItem( $code, $key)
Get a cache item.
static $splitKeys
Keys for items where the subitems are stored in the backend separately.
loadItem( $code, $key)
Load an item into the cache.
getPluralRuleTypes( $code)
Get the plural rule types for a given language from the XML files.
loadSubitem( $code, $key, $subkey)
Load a subitem into the cache.
MediaWiki exception.
Definition: MWException.php:29
Depend on a MW configuration variable.
A class for passing options to services.
assertRequiredOptions(array $expectedKeys)
Assert that the list of options provided in this instance exactly match $expectedKeys,...
This class provides an implementation of the core hook interfaces, forwarding hook calls to HookConta...
Definition: HookRunner.php:560
A service that provides utilities to do with language names and codes.
A class containing constants representing the names of configuration variables.
Interface for the persistence layer of LocalisationCache.
Definition: LCStore.php:40
if(!isset( $args[0])) $lang