110 'fallback',
'namespaceNames',
'bookstoreList',
111 'magicWords',
'messages',
'rtl',
'capitalizeAllNouns',
'digitTransformTable',
112 'separatorTransformTable',
'fallback8bitEncoding',
'linkPrefixExtension',
113 'linkTrail',
'linkPrefixCharset',
'namespaceAliases',
114 'dateFormats',
'datePreferences',
'datePreferenceMigrationMap',
115 'defaultDateFormat',
'extraUserToggles',
'specialPageAliases',
116 'imageFiles',
'preloadedMessages',
'namespaceGenderAliases',
117 'digitGroupingPattern',
'pluralRules',
'pluralRuleTypes',
'compiledPluralRules',
125 'namespaceAliases',
'dateFormats',
'imageFiles',
'preloadedMessages'
196 if ( !empty(
$conf[
'storeClass'] ) ) {
197 $storeClass =
$conf[
'storeClass'];
199 switch (
$conf[
'store'] ) {
202 $storeClass =
'LCStoreCDB';
205 $storeClass =
'LCStoreDB';
208 $storeClass =
'LCStoreStaticArray';
211 if ( !empty(
$conf[
'storeDirectory'] ) ) {
212 $storeClass =
'LCStoreCDB';
213 } elseif ( $wgCacheDirectory ) {
215 $storeClass =
'LCStoreCDB';
217 $storeClass =
'LCStoreDB';
222 'Please set $wgLocalisationCacheConf[\'store\'] to something sensible.'
227 wfDebugLog(
'caches', get_class( $this ) .
": using store $storeClass" );
228 if ( !empty(
$conf[
'storeDirectory'] ) ) {
229 $storeConf[
'directory'] =
$conf[
'storeDirectory'];
232 $this->
store =
new $storeClass( $storeConf );
233 foreach ( [
'manualRecache',
'forceRecache' ]
as $var ) {
234 if ( isset(
$conf[$var] ) ) {
235 $this->$var =
$conf[$var];
247 if ( $this->mergeableKeys === null ) {
248 $this->mergeableKeys = array_flip( array_merge(
249 self::$mergeableMapKeys,
250 self::$mergeableListKeys,
251 self::$mergeableAliasListKeys,
252 self::$optionalMergeKeys,
257 return isset( $this->mergeableKeys[
$key] );
270 if ( !isset( $this->loadedItems[
$code][
$key] ) ) {
274 if ( $key ===
'fallback' && isset( $this->shallowFallbacks[
$code] ) ) {
275 return $this->shallowFallbacks[
$code];
289 if ( !isset( $this->loadedSubitems[
$code][
$key][$subkey] ) &&
290 !isset( $this->loadedItems[
$code][
$key] )
295 if ( isset( $this->
data[
$code][$key][$subkey] ) ) {
315 if ( in_array(
$key, self::$splitKeys ) ) {
319 if ( is_array( $item ) ) {
320 return array_keys( $item );
333 if ( !isset( $this->initialisedLangs[
$code] ) ) {
338 if ( isset( $this->loadedItems[$code][
$key] ) ) {
342 if ( isset( $this->shallowFallbacks[$code] ) ) {
343 $this->
loadItem( $this->shallowFallbacks[$code], $key );
348 if ( in_array( $key, self::$splitKeys ) ) {
349 $subkeyList = $this->
getSubitem( $code,
'list', $key );
350 foreach ( $subkeyList
as $subkey ) {
351 if ( isset( $this->
data[$code][$key][$subkey] ) ) {
370 if ( !in_array(
$key, self::$splitKeys ) ) {
376 if ( !isset( $this->initialisedLangs[
$code] ) ) {
381 if ( isset( $this->loadedItems[$code][
$key] ) ||
382 isset( $this->loadedSubitems[$code][$key][$subkey] )
387 if ( isset( $this->shallowFallbacks[$code] ) ) {
388 $this->
loadSubitem( $this->shallowFallbacks[$code], $key, $subkey );
393 $value = $this->
store->get( $code,
"$key:$subkey" );
395 $this->loadedSubitems[
$code][
$key][$subkey] =
true;
406 if ( $this->forceRecache && !isset( $this->recachedLangs[
$code] ) ) {
407 wfDebug( __METHOD__ .
"($code): forced reload\n" );
412 $deps = $this->
store->get( $code,
'deps' );
414 $preload = $this->
store->get( $code,
'preload' );
416 if ( $deps === null ||
$keys === null || $preload === null ) {
417 wfDebug( __METHOD__ .
"($code): cache missing, need to make one\n" );
422 foreach ( $deps
as $dep ) {
428 wfDebug( __METHOD__ .
"($code): cache for $code expired due to " .
429 get_class( $dep ) .
"\n" );
444 if ( isset( $this->initialisedLangs[
$code] ) ) {
448 $this->initialisedLangs[
$code] =
true;
450 # If the code is of the wrong form for a Messages*.php file, do a shallow fallback
457 # Recache the data if necessary
458 if ( !$this->manualRecache && $this->
isExpired( $code ) ) {
461 } elseif ( $code ===
'en' ) {
462 throw new MWException(
'MessagesEn.php is missing.' );
471 $preload = $this->
getItem( $code,
'preload' );
472 if ( $preload === null ) {
473 if ( $this->manualRecache ) {
475 if ( $code ===
'en' ) {
476 throw new MWException(
'No localisation cache found for English. ' .
477 'Please run maintenance/rebuildLocalisationCache.php.' );
483 throw new MWException(
'Invalid or missing localisation cache.' );
487 foreach ( $preload
as $key => $item ) {
488 if ( in_array(
$key, self::$splitKeys ) ) {
489 foreach ( $item
as $subkey => $subitem ) {
490 $this->loadedSubitems[
$code][
$key][$subkey] =
true;
505 $this->
data[$primaryCode] =& $this->
data[$fallbackCode];
506 $this->loadedItems[$primaryCode] =& $this->loadedItems[$fallbackCode];
507 $this->loadedSubitems[$primaryCode] =& $this->loadedSubitems[$fallbackCode];
508 $this->shallowFallbacks[$primaryCode] = $fallbackCode;
520 MediaWiki\suppressWarnings();
521 $_apcEnabled = ini_set(
'apc.cache_by_default',
'0' );
522 MediaWiki\restoreWarnings();
526 MediaWiki\suppressWarnings();
527 ini_set(
'apc.cache_by_default', $_apcEnabled );
528 MediaWiki\restoreWarnings();
530 if ( $_fileType ==
'core' || $_fileType ==
'extension' ) {
531 $data = compact( self::$allKeys );
532 } elseif ( $_fileType ==
'aliases' ) {
533 $data = compact(
'aliases' );
535 throw new MWException( __METHOD__ .
": Invalid file type: $_fileType" );
549 if ( !is_readable( $fileName ) ) {
553 $json = file_get_contents( $fileName );
554 if ( $json ===
false ) {
559 if (
$data === null ) {
561 throw new MWException( __METHOD__ .
": Invalid JSON file: $fileName" );
566 if (
$key ===
'' ||
$key[0] ===
'@' ) {
572 return [
'messages' =>
$data ];
583 if ( $rules === null ) {
587 $compiledRules = Evaluator::compile( $rules );
588 }
catch ( CLDRPluralRuleError
$e ) {
594 return $compiledRules;
605 if ( $this->pluralRules === null ) {
608 if ( !isset( $this->pluralRules[
$code] ) ) {
611 return $this->pluralRules[
$code];
623 if ( $this->pluralRuleTypes === null ) {
626 if ( !isset( $this->pluralRuleTypes[
$code] ) ) {
629 return $this->pluralRuleTypes[
$code];
638 $cldrPlural =
"$IP/languages/data/plurals.xml";
639 $mwPlural =
"$IP/languages/data/plurals-mediawiki.xml";
642 if ( file_exists( $mwPlural ) ) {
657 $xml = file_get_contents( $fileName );
659 throw new MWException(
"Unable to read plurals file $fileName" );
661 $doc =
new DOMDocument;
662 $doc->loadXML( $xml );
663 $rulesets = $doc->getElementsByTagName(
"pluralRules" );
664 foreach ( $rulesets
as $ruleset ) {
665 $codes = $ruleset->getAttribute(
'locales' );
668 $ruleElements = $ruleset->getElementsByTagName(
"pluralRule" );
669 foreach ( $ruleElements
as $elt ) {
670 $ruleType = $elt->getAttribute(
'count' );
671 if ( $ruleType ===
'other' ) {
675 $rules[] = $elt->nodeValue;
676 $ruleTypes[] = $ruleType;
678 foreach ( explode(
' ', $codes )
as $code ) {
679 $this->pluralRules[
$code] = $rules;
680 $this->pluralRuleTypes[
$code] = $ruleTypes;
699 if ( !file_exists( $fileName ) ) {
706 # Load CLDR plural rules for JavaScript
710 # Load plural rule types
713 $deps[
'plurals'] =
new FileDependency(
"$IP/languages/data/plurals.xml" );
714 $deps[
'plurals-mw'] =
new FileDependency(
"$IP/languages/data/plurals-mediawiki.xml" );
727 if ( !is_null(
$value ) ) {
728 if ( !is_null( $fallbackValue ) ) {
729 if ( in_array(
$key, self::$mergeableMapKeys ) ) {
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'] ) ) {
740 if ( isset(
$value[
'inherit'] ) ) {
741 unset(
$value[
'inherit'] );
743 } elseif ( in_array(
$key, self::$magicWordKeys ) ) {
757 foreach ( $fallbackValue
as $magicName => $fallbackInfo ) {
758 if ( !isset(
$value[$magicName] ) ) {
759 $value[$magicName] = $fallbackInfo;
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( [ $fallbackInfo[0] ], $synonyms );
785 foreach ( $codeSequence
as $code ) {
786 if ( isset( $fallbackValue[$code] ) ) {
805 'core' =>
"$IP/languages/i18n",
806 'api' =>
"$IP/includes/api/i18n",
807 'oojs-ui' =>
"$IP/resources/lib/oojs-ui/i18n",
821 throw new MWException(
"Invalid language code requested" );
823 $this->recachedLangs[
$code] =
true;
826 $initialData = array_fill_keys( self::$allKeys, null );
827 $coreData = $initialData;
830 # Load the primary localisation from the source file
832 if (
$data ===
false ) {
833 wfDebug( __METHOD__ .
": no localisation file for $code, using fallback to en\n" );
834 $coreData[
'fallback'] =
'en';
836 wfDebug( __METHOD__ .
": got localisation for $code from source\n" );
838 # Merge primary localisation
844 # Fill in the fallback if it's not there already
845 if ( is_null( $coreData[
'fallback'] ) ) {
846 $coreData[
'fallback'] =
$code ===
'en' ?
false :
'en';
848 if ( $coreData[
'fallback'] ===
false ) {
849 $coreData[
'fallbackSequence'] = [];
851 $coreData[
'fallbackSequence'] = array_map(
'trim', explode(
',', $coreData[
'fallback'] ) );
852 $len = count( $coreData[
'fallbackSequence'] );
854 # Ensure that the sequence ends at en
855 if ( $coreData[
'fallbackSequence'][$len - 1] !==
'en' ) {
856 $coreData[
'fallbackSequence'][] =
'en';
860 $codeSequence = array_merge( [
$code ], $coreData[
'fallbackSequence'] );
863 # Load non-JSON localisation data for extensions
864 $extensionData = array_fill_keys( $codeSequence, $initialData );
865 foreach ( $wgExtensionMessagesFiles
as $extension => $fileName ) {
866 if ( isset( $messageDirs[$extension] ) ) {
867 # This extension has JSON message data; skip the PHP shim
875 foreach ( $codeSequence
as $csCode ) {
876 if ( isset( $item[$csCode] ) ) {
888 # Load the localisation data for each fallback, then merge it into the full array
889 $allData = $initialData;
890 foreach ( $codeSequence
as $csCode ) {
891 $csData = $initialData;
893 # Load core messages and the extension localisations.
894 foreach ( $messageDirs
as $dirs ) {
896 $fileName =
"$dir/$csCode.json";
907 # Merge non-JSON extension data
908 if ( isset( $extensionData[$csCode] ) ) {
909 foreach ( $extensionData[$csCode]
as $key => $item ) {
914 if ( $csCode ===
$code ) {
915 # Merge core data into extension data
916 foreach ( $coreData
as $key => $item ) {
920 # Load the secondary localisation from the source file to
921 # avoid infinite cycles on cyclic fallbacks
923 if ( $fbData !==
false ) {
924 # Only merge the keys that make sense to merge
925 foreach ( self::$allKeys
as $key ) {
926 if ( !isset( $fbData[$key] ) ) {
930 if ( is_null( $coreData[$key] ) || $this->
isMergeableKey( $key ) ) {
931 $this->
mergeItem( $key, $csData[$key], $fbData[$key] );
937 # Allow extensions an opportunity to adjust the data for this
939 Hooks::run(
'LocalisationCacheRecacheFallback', [ $this, $csCode, &$csData ] );
941 # Merge the data for this fallback into the final array
942 if ( $csCode ===
$code ) {
945 foreach ( self::$allKeys
as $key ) {
946 if ( !isset( $csData[$key] ) ) {
950 if ( is_null( $allData[$key] ) || $this->
isMergeableKey( $key ) ) {
951 $this->
mergeItem( $key, $allData[$key], $csData[$key] );
957 # Add cache dependencies for any referenced globals
958 $deps[
'wgExtensionMessagesFiles'] =
new GlobalDependency(
'wgExtensionMessagesFiles' );
963 # Add dependencies to the cache entry
964 $allData[
'deps'] = $deps;
966 # Replace spaces with underscores in namespace names
967 $allData[
'namespaceNames'] = str_replace(
' ',
'_', $allData[
'namespaceNames'] );
969 # And do the same for special page aliases. $page is an array.
970 foreach ( $allData[
'specialPageAliases']
as &
$page ) {
971 $page = str_replace(
' ',
'_', $page );
973 # Decouple the reference to prevent accidental damage
976 # If there were no plural rules, return an empty array
977 if ( $allData[
'pluralRules'] === null ) {
978 $allData[
'pluralRules'] = [];
980 if ( $allData[
'compiledPluralRules'] === null ) {
981 $allData[
'compiledPluralRules'] = [];
983 # If there were no plural rule types, return an empty array
984 if ( $allData[
'pluralRuleTypes'] === null ) {
985 $allData[
'pluralRuleTypes'] = [];
989 $allData[
'list'] = [];
990 foreach ( self::$splitKeys
as $key ) {
991 $allData[
'list'][
$key] = array_keys( $allData[$key] );
995 Hooks::run(
'LocalisationCacheRecache', [ $this,
$code, &$allData, &$purgeBlobs ] );
997 if ( is_null( $allData[
'namespaceNames'] ) ) {
998 throw new MWException( __METHOD__ .
': Localisation data failed sanity check! ' .
999 'Check that your languages/messages/MessagesEn.php file is intact.' );
1002 # Set the preload key
1005 # Save to the process cache and register the items loaded
1007 foreach ( $allData
as $key => $item ) {
1011 # Save to the persistent cache
1013 foreach ( $allData
as $key =>
$value ) {
1014 if ( in_array( $key, self::$splitKeys ) ) {
1015 foreach (
$value as $subkey => $subvalue ) {
1016 $this->
store->set(
"$key:$subkey", $subvalue );
1022 $this->
store->finishWrite();
1024 # Clear out the MessageBlobStore
1025 # HACK: If using a null (i.e. disabled) storage backend, we
1026 # can't write to the MessageBlobStore either
1029 $blobStore->clear();
1043 $preload = [
'messages' => [] ];
1044 foreach ( self::$preloadedKeys
as $key ) {
1048 foreach (
$data[
'preloadedMessages']
as $subkey ) {
1049 if ( isset(
$data[
'messages'][$subkey] ) ) {
1050 $subitem =
$data[
'messages'][$subkey];
1054 $preload[
'messages'][$subkey] = $subitem;
1067 unset( $this->loadedItems[$code] );
1068 unset( $this->loadedSubitems[$code] );
1069 unset( $this->initialisedLangs[$code] );
1070 unset( $this->shallowFallbacks[$code] );
1072 foreach ( $this->shallowFallbacks
as $shallowCode => $fbCode ) {
1073 if ( $fbCode === $code ) {
1074 $this->
unload( $shallowCode );
1083 foreach ( $this->initialisedLangs
as $lang => $unused ) {
1093 $this->manualRecache =
false;
unloadAll()
Unload all data.
readJSONFile($fileName)
Read a JSON file containing localisation messages.
This class generates message blobs for use by ResourceLoader modules.
static $mergeableAliasListKeys
Keys for items which contain an array of arrays of equivalent aliases for each subitem.
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of data
the array() calling protocol came about after MediaWiki 1.4rc1.
readPHPFile($_fileName, $_fileType)
Read a PHP file containing localisation data.
magic word the default is to use $key to get the and $key value or $key value text $key value html to format the value $key
readSourceFilesAndRegisterDeps($code, &$deps)
Read the data from the source files for a given language, and register the relevant dependencies in t...
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
unload($code)
Unload the data for a given language from the object cache.
loadItem($code, $key)
Load an item into the cache.
LCStore $store
The persistent store object.
if(!isset($args[0])) $lang
$shallowFallbacks
An array mapping non-existent pseudo-languages to fallback languages.
$initialisedLangs
An array where presence of a key indicates that that language has been initialised.
$conf
Configuration associative array.
recache($code)
Load localisation data for a given language for both core and extensions and save it to the persisten...
static $allKeys
All item keys.
isExpired()
Returns true if the dependency is expired, false otherwise.
getMessagesDirs()
Gets the combined list of messages dirs from core and extensions.
__construct($conf)
Constructor.
when a variable name is used in a it is silently declared as a new local masking the global
mergeMagicWords(&$value, $fallbackValue)
$manualRecache
True if recaching should only be done on an explicit call to recache().
loadSubitem($code, $key, $subkey)
Load a subitem into the cache.
getItem($code, $key)
Get a cache item.
MediaWiki s SiteStore can be cached and stored in a flat in a json format If the SiteStore is frequently the file cache may provide a performance benefit over a database store
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
$wgCacheDirectory
Directory for caching data in the local filesystem.
disableBackend()
Disable the storage backend.
static $optionalMergeKeys
Keys for items which contain an associative array, and may be merged if the primary value contains th...
$recachedLangs
An array where the keys are codes that have been recached by this instance.
wfDebugLog($logGroup, $text, $dest= 'all', array $context=[])
Send a line to a supplementary debug log file, if configured, or main debug log if not...
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...
$pluralRules
Associative array of cached plural rules.
static getMessagesFileName($code)
static $preloadedKeys
Keys which are loaded automatically by initLanguage()
static isValidBuiltInCode($code)
Returns true if a language code is of a valid form for the purposes of internal customisation of Medi...
$forceRecache
True to treat all files as expired until they are regenerated by this object.
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Class for caching the contents of localisation files, Messages*.php and *.i18n.php.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
static $mergeableListKeys
Keys for items which are a numbered array.
loadPluralFiles()
Load the plural XML files.
getSubitemList($code, $key)
Get the list of subitem keys for a given item.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
static $magicWordKeys
Keys for items that are formatted like $magicWords.
initLanguage($code)
Initialise a language in this object.
$loadedItems
A 2-d associative array, code/key, where presence indicates that the item is loaded.
static $splitKeys
Keys for items where the subitems are stored in the backend separately.
$loadedSubitems
A 3-d associative array, code/key/subkey, where presence indicates that the subitem is loaded...
getPluralRules($code)
Get the plural rules for a given language from the XML files.
Null store backend, used to avoid DB errors during install.
mergeExtensionItem($codeSequence, $key, &$value, $fallbackValue)
Given an array mapping language code to localisation value, such as is found in extension *...
static $mergeableMapKeys
Keys for items which consist of associative arrays, which may be merged by a fallback sequence...
buildPreload($data)
Build the preload item from the given pre-cache data.
getSubitem($code, $key, $subkey)
Get a subitem, for instance a single message for a given language.
$pluralRuleTypes
Associative array of cached plural rule types.
getCompiledPluralRules($code)
Get the compiled plural rules for a given language from the XML files.
getPluralRuleTypes($code)
Get the plural rule types for a given language from the XML files.
$wgExtensionMessagesFiles['ExtensionNameMagic']
static isSupportedLanguage($code)
Checks whether any localisation is available for that language tag in MediaWiki (MessagesXx.php exists).
initShallowFallback($primaryCode, $fallbackCode)
Create a fallback from one language to another, without creating a complete persistent cache...
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached $page
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...