Cache of messages that are defined by MediaWiki namespace pages or by hooks. More...

Collaboration diagram for MessageCache:

[legend]

Public Member Functions
	__construct (WANObjectCache $wanCache, BagOStuff $clusterCache, BagOStuff $serverCache, $useDB, Language $contLang=null)

	clear ()
	Clear all stored messages in global and local cache.

	disable ()

	enable ()

	figureMessage ( $key)

	get ( $key, $useDB=true, $langcode=true)
	Get a message from either the content language or the user language.

	getAllMessageKeys ( $code)
	Get all message keys stored in the message cache for a given language.

	getCheckKey ( $code)

	getMsgFromNamespace ( $title, $code)
	Get a message from the MediaWiki namespace, with caching.

	getParser ()

	getParserOptions ()
	ParserOptions is lazy initialised.

	isDisabled ()
	Whether DB/cache usage is disabled for determining messages.

	parse ( $text, $title=null, $linestart=true, $interface=false, $language=null)

	refreshAndReplaceInternal ( $code, array $replacements)

	replace ( $title, $text)
	Updates cache as necessary when message page is changed.

	transform ( $message, $interface=false, $language=null, $title=null)

	updateMessageOverride (Title $title, Content $content=null)
	Purge message caches when a MediaWiki: page is created, updated, or deleted.

Static Public Member Functions
static	normalizeKey ( $key)
	Normalize message key input.

static	singleton ()
	Get the singleton instance of this class.

Public Attributes
const	FOR_UPDATE = 1

const	LOCK_TTL = 30
	How long memcached locks last.

const	WAIT_SEC = 15
	How long to wait for memcached locks.

Protected Member Functions
	getLocalCache ( $code)
	Try to load the cache from APC.

	getMessageFromFallbackChain ( $lang, $lckey, $useDB)
	Given a language, try and fetch messages from that language.

	getReentrantScopedLock ( $key, $timeout=self::WAIT_SEC)

	getValidationHash ( $code)
	Get the md5 used to validate the local APC cache.

	isCacheExpired ( $cache)
	Is the given cache array expired due to time passing or a version change?

	load ( $code, $mode=null)
	Loads messages from caches or from database in this order: (1) local message cache (if $wgUseLocalMessageCache is enabled) (2) memcached (3) from the database.

	loadFromDB ( $code, $mode=null)
	Loads cacheable messages from the database.

	loadFromDBWithLock ( $code, array &$where, $mode=null)

	saveToCaches (array $cache, $dest, $code=false)
	Shortcut to update caches.

	saveToLocalCache ( $code, $cache)
	Save the cache to APC.

	setValidationHash ( $code, array $cache)
	Set the md5 used to validate the local disk cache.

Protected Attributes
MapCacheLRU	$cache
	Process cache of loaded messages that are defined in MediaWiki namespace.

bool[]	$cacheVolatile = []
	Map of (language code => boolean)

BagOStuff	$clusterCache

Language	$contLang

	$mDisable
	Should mean that database cannot be used, but check.

	$mInParser = false

Parser	$mParser

ParserOptions	$mParserOptions
	Message cache has its own parser which it uses to transform messages.

array	$overridable
	Map of (lowercase message key => index) for all software defined messages.

BagOStuff	$srvCache

WANObjectCache	$wanCache

Private Member Functions
	bigMessageCacheKey ( $hash, $title)

	getMessageForLang ( $lang, $lckey, $useDB, &$alreadyTried)
	Given a language, try and fetch messages from that language and its fallbacks.

	getMessagePageName ( $langcode, $uckey)
	Get the message page name for a given language.

	getMessageTextFromContent (Content $content=null)

	isMainCacheable ( $name, array $overridable)

	loadCachedMessagePageEntry ( $dbKey, $code, $hash)

Private Attributes
array	$loadedLanguages = []
	Track which languages have been loaded by load().

Detailed Description

Cache of messages that are defined by MediaWiki namespace pages or by hooks.

Performs various MediaWiki namespace-related functions

Definition at line 40 of file MessageCache.php.

Constructor & Destructor Documentation

◆ __construct()

MessageCache::__construct	(	WANObjectCache	$wanCache,
		BagOStuff	$clusterCache,
		BagOStuff	$serverCache,
			$useDB,
		Language	$contLang = null )

Parameters

WANObjectCache	$wanCache
BagOStuff	$clusterCache
BagOStuff	$serverCache
bool	$useDB	Whether to look for message overrides (e.g. MediaWiki: pages)
Language \| null	$contLang	Content language of site

Definition at line 142 of file MessageCache.php.

Member Function Documentation

◆ bigMessageCacheKey()

MessageCache::bigMessageCacheKey	(		$hash,
			$title )

private

Parameters

string	$hash	Hash for this version of the entire key/value overrides map
string	$title	Message cache key with initial uppercase letter

Returns: string

Definition at line 1396 of file MessageCache.php.

References $title.

Referenced by loadCachedMessagePageEntry(), and refreshAndReplaceInternal().

◆ clear()

MessageCache::clear ( )

Clear all stored messages in global and local cache.

Mainly used after a mass rebuild

Definition at line 1278 of file MessageCache.php.

References getCheckKey().

◆ disable()

MessageCache::disable ( )

Definition at line 1249 of file MessageCache.php.

◆ enable()

MessageCache::enable ( )

Definition at line 1253 of file MessageCache.php.

◆ figureMessage()

MessageCache::figureMessage ( $key )

Parameters

string $key

Returns: array

Definition at line 1291 of file MessageCache.php.

References $lang, and $wgLanguageCode.

Referenced by replace().

◆ get()

MessageCache::get	(	$key,
		$useDB = true,
		$langcode = true )

Get a message from either the content language or the user language.

First, assemble a list of languages to attempt getting the message from. This chain begins with the requested language and its fallbacks and then continues with the content language and its fallbacks. For each language in the chain, the following process will occur (in this order):

If a language-specific override, i.e., [[MW:msg/lang]], is available, use that. Note: for the content language, there is no /lang subpage.
Fetch from the static CDB cache.
If available, check the database for fallback language overrides.

This process provides a number of guarantees. When changing this code, make sure all of these guarantees are preserved.

If the requested language is not the content language, then the CDB cache for that specific language will take precedence over the root database page ([[MW:msg]]).
Fallbacks will be just that: fallbacks. A fallback language will never be reached if the message is available anywhere in the language for which it is a fallback.

Parameters

string	$key	The message key
bool	$useDB	If true, look for the message in the DB, false to use only the compiled l10n cache.
bool \| string \| object	$langcode	Code of the language to get the message for. If string and a valid code, will create a standard language object If string but not a valid code, will create a basic language object If boolean and false, create object from the current users language If boolean and true, create object from the wikis content language If language object, use it as given

Exceptions

MWException When given an invalid key

Returns: string|bool False if the message doesn't exist, otherwise the message (which can be empty)

Definition at line 849 of file MessageCache.php.

References getMessageFromFallbackChain(), and wfGetLangObj().

◆ getAllMessageKeys()

MessageCache::getAllMessageKeys ( $code )

Get all message keys stored in the message cache for a given language.

If $code is the content language code, this will return all message keys for which MediaWiki:msgkey exists. If $code is another language code, this will ONLY return message keys for which MediaWiki:msgkey/$code exists.

Parameters

string $code Language code

Returns: array Array of message keys (strings)

Definition at line 1317 of file MessageCache.php.

References $cache, and load().

◆ getCheckKey()

MessageCache::getCheckKey ( $code )

Parameters

string $code Language code

Returns: string WAN cache key usable as a "check key" against language page edits

Definition at line 1359 of file MessageCache.php.

Referenced by clear(), and refreshAndReplaceInternal().

◆ getLocalCache()

MessageCache::getLocalCache ( $code )

protected

Try to load the cache from APC.

Parameters

string $code Optional language code, see documentation of load().

Returns: array|bool The cache array, or false if not in cache.

Definition at line 196 of file MessageCache.php.

Referenced by load().

◆ getMessageForLang()

MessageCache::getMessageForLang	(		$lang,
			$lckey,
			$useDB,
		&	$alreadyTried )

private

Given a language, try and fetch messages from that language and its fallbacks.

See also: MessageCache::get

Parameters

Language \| StubObject	$lang	Preferred language
string	$lckey	Lowercase key for the message (as for localisation cache)
bool	$useDB	Whether to include messages from the wiki database
bool[]	$alreadyTried	Contains true for each language that has been tried already

Returns: string|bool The message, or false if not found

Definition at line 948 of file MessageCache.php.

References $lang, getMessagePageName(), and getMsgFromNamespace().

Referenced by getMessageFromFallbackChain().

◆ getMessageFromFallbackChain()

MessageCache::getMessageFromFallbackChain	(	$lang,
		$lckey,
		$useDB )

protected

Given a language, try and fetch messages from that language.

Will also consider fallbacks of that language, the site language, and fallbacks for the site language.

See also: MessageCache::get

Parameters

Language \| StubObject	$lang	Preferred language
string	$lckey	Lowercase key for the message (as for localisation cache)
bool	$useDB	Whether to include messages from the wiki database

Returns: string|bool The message, or false if not found

Definition at line 924 of file MessageCache.php.

References $lang, and getMessageForLang().

Referenced by get().

◆ getMessagePageName()

MessageCache::getMessagePageName	(		$langcode,
			$uckey )

private

Get the message page name for a given language.

Parameters

string	$langcode
string	$uckey	Uppercase key for the message

Returns: string The page name

Definition at line 1004 of file MessageCache.php.

References $wgLanguageCode.

Referenced by getMessageForLang().

◆ getMessageTextFromContent()

MessageCache::getMessageTextFromContent ( Content $content = null )

private

Parameters

Content | null $content Content or null if the message page does not exist

Returns: string|bool|null Returns false if $content is null and null on error

Definition at line 1367 of file MessageCache.php.

References $content.

Referenced by loadCachedMessagePageEntry(), loadFromDB(), refreshAndReplaceInternal(), and updateMessageOverride().

◆ getMsgFromNamespace()

MessageCache::getMsgFromNamespace	(		$title,
			$code )

Get a message from the MediaWiki namespace, with caching.

The key must first be converted to two-part lang/msg form if necessary.

Unlike self::get(), this function doesn't resolve fallback chains, and some callers require this behavior. LanguageConverter::parseCachedTable() and self::get() are some examples in core.

Parameters

string	$title	Message cache key with initial uppercase letter
string	$code	Code denoting the language to try

Returns: string|bool The message, or false if it does not exist or on error

Definition at line 1027 of file MessageCache.php.

References $title, isMainCacheable(), load(), and loadCachedMessagePageEntry().

Referenced by getMessageForLang().

◆ getParser()

MessageCache::getParser ( )

Returns: Parser

Definition at line 1184 of file MessageCache.php.

References $wgParserConf.

Referenced by parse(), and transform().

◆ getParserOptions()

MessageCache::getParserOptions ( )

ParserOptions is lazy initialised.

Returns: ParserOptions

Definition at line 164 of file MessageCache.php.

References ParserOptions\setAllowUnsafeRawHtml().

Referenced by parse(), and transform().

◆ getReentrantScopedLock()

MessageCache::getReentrantScopedLock	(		$key,
			$timeout = self::WAIT_SEC )

protected

Parameters

string	$key	A language message cache key that stores blobs
int	$timeout	Wait timeout in seconds

Returns: null|ScopedCallback

Definition at line 812 of file MessageCache.php.

Referenced by load(), loadFromDBWithLock(), and refreshAndReplaceInternal().

◆ getValidationHash()

MessageCache::getValidationHash ( $code )

protected

Get the md5 used to validate the local APC cache.

Parameters

string $code

Returns: array (hash or false, bool expiry/volatility status)

Definition at line 758 of file MessageCache.php.

Referenced by load().

◆ isCacheExpired()

MessageCache::isCacheExpired ( $cache )

protected

Is the given cache array expired due to time passing or a version change?

Parameters

array $cache

Returns: bool

Definition at line 715 of file MessageCache.php.

References $cache, MSG_CACHE_VERSION, and wfTimestampNow().

Referenced by load().

◆ isDisabled()

MessageCache::isDisabled ( )

Whether DB/cache usage is disabled for determining messages.

If so, this typically indicates either:

a) load() failed to find a cached copy nor query the DB
b) we are in a special context or error mode that cannot use the DB If the DB is ignored, any derived HTML output or cached objects may be wrong. To avoid long-term cache pollution, TTLs can be adjusted accordingly.

Returns: bool

Since: 1.27

Definition at line 1269 of file MessageCache.php.

◆ isMainCacheable()

MessageCache::isMainCacheable	(		$name,
		array	$overridable )

private

Parameters

string	$name	Message name (possibly with /code suffix)
array	$overridable	Map of (key => unused) for software-defined messages

Returns: bool

Definition at line 577 of file MessageCache.php.

Referenced by getMsgFromNamespace(), and loadFromDB().

◆ load()

MessageCache::load	(		$code,
			$mode = null )

protected

Loads messages from caches or from database in this order: (1) local message cache (if $wgUseLocalMessageCache is enabled) (2) memcached (3) from the database.

When successfully loading from (2) or (3), all higher level caches are updated for the newest version.

Nothing is loaded if member variable mDisable is true, either manually set by calling code or if message loading fails (is this possible?).

Returns true if cache is already populated or it was successfully populated, or false if populating empty cache fails. Also returns true if MessageCache is disabled.

Parameters

string	$code	Language to which load messages
int \| null	$mode	Use MessageCache::FOR_UPDATE to skip process cache [optional]

Exceptions

InvalidArgumentException

Returns: bool

Definition at line 234 of file MessageCache.php.

References $cache, $success, getLocalCache(), getReentrantScopedLock(), getValidationHash(), isCacheExpired(), loadFromDBWithLock(), saveToCaches(), wfDebug(), and wfDebugLog().

Referenced by getAllMessageKeys(), getMsgFromNamespace(), loadFromDB(), and refreshAndReplaceInternal().

◆ loadCachedMessagePageEntry()

MessageCache::loadCachedMessagePageEntry	(	$dbKey,
		$code,
		$hash )

private

Parameters

string	$dbKey
string	$code
string	$hash

Returns: string Either " <MESSAGE>" or "!NONEXISTANT"

Definition at line 1101 of file MessageCache.php.

References $content, $dbr, $title, bigMessageCacheKey(), DB_REPLICA, getMessageTextFromContent(), NS_MEDIAWIKI, and wfGetDB().

Referenced by getMsgFromNamespace().

◆ loadFromDB()

MessageCache::loadFromDB	(		$code,
			$mode = null )

protected

Loads cacheable messages from the database.

Messages bigger than $wgMaxMsgCacheEntrySize are assigned a special value, and are loaded on-demand from the database later.

Parameters

string	$code	Language code
int \| null	$mode	Use MessageCache::FOR_UPDATE to skip process cache

Returns: array Loaded messages for storing in caches

Definition at line 444 of file MessageCache.php.

References $cache, $content, $dbr, $res, $revQuery, $wgAdaptiveMessageCache, $wgLanguageCode, $wgMaxMsgCacheEntrySize, DB_MASTER, DB_REPLICA, getMessageTextFromContent(), isMainCacheable(), load(), MSG_CACHE_VERSION, NS_MEDIAWIKI, serialize(), wfDebugLog(), wfGetDB(), and wfTimestamp().

Referenced by loadFromDBWithLock(), and refreshAndReplaceInternal().

◆ loadFromDBWithLock()

MessageCache::loadFromDBWithLock	(		$code,
		array &	$where,
			$mode = null )

protected

Parameters

string	$code
array	&$where	List of wfDebug() comments
int \| null	$mode	Use MessageCache::FOR_UPDATE to use DB_MASTER

Returns: bool|string True on success or one of ("cantacquire", "disabled")

Definition at line 382 of file MessageCache.php.

References $cache, getReentrantScopedLock(), loadFromDB(), and saveToCaches().

Referenced by load().

◆ normalizeKey()

static MessageCache::normalizeKey ( $key )

static

Normalize message key input.

Parameters

string $key Input message key to be normalized

Returns: string Normalized message key

Definition at line 124 of file MessageCache.php.

◆ parse()

MessageCache::parse	(	$text,
		$title = null,
		$linestart = true,
		$interface = false,
		$language = null )

Parameters

string	$text
Title \| null	$title
bool	$linestart	Whether or not this is at the start of a line
bool	$interface	Whether this is an interface message
Language \| string \| null	$language	Language code

Returns: ParserOutput|string

Definition at line 1212 of file MessageCache.php.

References $res, $title, $wgTitle, getParser(), getParserOptions(), NS_SPECIAL, wfDebugLog(), and wfGetAllCallers().

◆ refreshAndReplaceInternal()

MessageCache::refreshAndReplaceInternal	(		$code,
		array	$replacements )

Parameters

string	$code
array[]	$replacements	List of (title, message key) pairs

Exceptions

MWException

Definition at line 626 of file MessageCache.php.

References $cache, $title, $wgMaxMsgCacheEntrySize, bigMessageCacheKey(), getCheckKey(), getMessageTextFromContent(), getReentrantScopedLock(), load(), loadFromDB(), NS_MEDIAWIKI, saveToCaches(), and serialize().

◆ replace()

MessageCache::replace	(		$title,
			$text )

Updates cache as necessary when message page is changed.

Parameters

string	$title	Message cache key with initial uppercase letter
string \| bool	$text	New contents of the page (false if deleted)

Definition at line 592 of file MessageCache.php.

References $title, $wgLanguageCode, and figureMessage().

Referenced by updateMessageOverride().

◆ saveToCaches()

MessageCache::saveToCaches	(	array	$cache,
			$dest,
			$code = false )

protected

Shortcut to update caches.

Parameters

array	$cache	Cached messages with a version.
string	$dest	Either "local-only" to save to local caches only or "all" to save to all caches.
string \| bool	$code	Language code (default: false)

Returns: bool

Definition at line 738 of file MessageCache.php.

References $cache, $success, saveToLocalCache(), and setValidationHash().

Referenced by load(), loadFromDBWithLock(), and refreshAndReplaceInternal().

◆ saveToLocalCache()

MessageCache::saveToLocalCache	(		$code,
			$cache )

protected

Save the cache to APC.

Parameters

string	$code
array	$cache	The cache array

Definition at line 208 of file MessageCache.php.

References $cache.

Referenced by saveToCaches().

◆ setValidationHash()

MessageCache::setValidationHash	(		$code,
		array	$cache )

protected

Set the md5 used to validate the local disk cache.

If $cache has a 'LATEST' UNIX timestamp key, then the hash will not be treated as "volatile" by getValidationHash() for the next few seconds. This is triggered when $cache is generated using FOR_UPDATE mode.

Parameters

string	$code
array	$cache	Cached messages with a version

Definition at line 796 of file MessageCache.php.

References $cache.

Referenced by saveToCaches().

◆ singleton()

static MessageCache::singleton ( )

static

Get the singleton instance of this class.

Deprecated: in 1.34 inject an instance of this class instead of using global state

Since: 1.18

Returns: MessageCache

Definition at line 114 of file MessageCache.php.

Referenced by MediaWiki\preOutputCommit().

◆ transform()

MessageCache::transform	(	$message,
		$interface = false,
		$language = null,
		$title = null )

Parameters

string	$message
bool	$interface
Language \| null	$language
Title \| null	$title

Returns: string

Definition at line 1155 of file MessageCache.php.

References $title, getParser(), and getParserOptions().

Referenced by EmailNotification\composeCommonMailtext().

◆ updateMessageOverride()

MessageCache::updateMessageOverride	(	Title	$title,
		Content	$content = null )

Purge message caches when a MediaWiki: page is created, updated, or deleted.

Parameters

Title	$title	Message page title
Content \| null	$content	New content for edit/create, null on deletion

Since: 1.29

Definition at line 1342 of file MessageCache.php.

References $content, $title, getMessageTextFromContent(), and replace().

Member Data Documentation

◆ $cache

MapCacheLRU MessageCache::$cache

protected

Initial value:

=

const WAN_TTL IExpiringStore::TTL_DAY

Process cache of loaded messages that are defined in MediaWiki namespace.

Map of (language code => key => " <MESSAGE>" or "!TOO BIG" or "!ERROR")

Definition at line 59 of file MessageCache.php.

◆ $cacheVolatile

bool [] MessageCache::$cacheVolatile = []

protected

Map of (language code => boolean)

Definition at line 71 of file MessageCache.php.

◆ $clusterCache

BagOStuff MessageCache::$clusterCache

protected

Definition at line 95 of file MessageCache.php.

◆ $contLang

Language MessageCache::$contLang

protected

Definition at line 99 of file MessageCache.php.

◆ $loadedLanguages

array MessageCache::$loadedLanguages = []

private

Track which languages have been loaded by load().

Definition at line 105 of file MessageCache.php.

◆ $mDisable

bool MessageCache::$mDisable

protected

Should mean that database cannot be used, but check.

Definition at line 77 of file MessageCache.php.

◆ $mInParser

bool MessageCache::$mInParser = false

protected

Definition at line 90 of file MessageCache.php.

◆ $mParser

Parser MessageCache::$mParser

protected

Definition at line 85 of file MessageCache.php.

◆ $mParserOptions

ParserOptions MessageCache::$mParserOptions

protected

Message cache has its own parser which it uses to transform messages.

Definition at line 83 of file MessageCache.php.

◆ $overridable

array MessageCache::$overridable

protected

Map of (lowercase message key => index) for all software defined messages.

Definition at line 66 of file MessageCache.php.

◆ $srvCache

BagOStuff MessageCache::$srvCache

protected

Definition at line 97 of file MessageCache.php.

◆ $wanCache

WANObjectCache MessageCache::$wanCache

protected

Definition at line 93 of file MessageCache.php.

◆ FOR_UPDATE

const MessageCache::FOR_UPDATE = 1

Definition at line 41 of file MessageCache.php.

◆ LOCK_TTL

const MessageCache::LOCK_TTL = 30

How long memcached locks last.

Definition at line 46 of file MessageCache.php.

◆ WAIT_SEC

const MessageCache::WAIT_SEC = 15

How long to wait for memcached locks.

Definition at line 44 of file MessageCache.php.

The documentation for this class was generated from the following file:

includes/cache/MessageCache.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ bigMessageCacheKey()

◆ clear()

◆ disable()

◆ enable()

◆ figureMessage()

◆ get()

◆ getAllMessageKeys()

◆ getCheckKey()

◆ getLocalCache()

◆ getMessageForLang()

◆ getMessageFromFallbackChain()

◆ getMessagePageName()

◆ getMessageTextFromContent()

◆ getMsgFromNamespace()

◆ getParser()

◆ getParserOptions()

◆ getReentrantScopedLock()

◆ getValidationHash()

◆ isCacheExpired()

◆ isDisabled()

◆ isMainCacheable()

◆ load()

◆ loadCachedMessagePageEntry()

◆ loadFromDB()

◆ loadFromDBWithLock()

◆ normalizeKey()

◆ parse()

◆ refreshAndReplaceInternal()

◆ replace()

◆ saveToCaches()

◆ saveToLocalCache()

◆ setValidationHash()

◆ singleton()

◆ transform()

◆ updateMessageOverride()

Member Data Documentation

◆ $cache

◆ $cacheVolatile

◆ $clusterCache

◆ $contLang

◆ $loadedLanguages

◆ $mDisable

◆ $mInParser

◆ $mParser

◆ $mParserOptions

◆ $overridable

◆ $srvCache

◆ $wanCache

◆ FOR_UPDATE

◆ LOCK_TTL

◆ WAIT_SEC