* @ingroup Cache
*/
class MessageCache {
- // Holds loaded messages that are defined in MediaWiki namespace.
- var $mCache;
+ /**
+ * Process local cache of loaded messages that are defined in
+ * MediaWiki namespace. First array level is a language code,
+ * second level is message key and the values are either message
+ * content prefixed with space, or !NONEXISTENT for negative
+ * caching.
+ */
+ protected $mCache;
+
+ // Should mean that database cannot be used, but check
+ protected $mDisable;
+
+ /// Lifetime for cache, used by object caching
+ protected $mExpiry;
+
+ /**
+ * Message cache has it's own parser which it uses to transform
+ * messages.
+ */
+ protected $mParserOptions, $mParser;
- var $mUseCache, $mDisable, $mExpiry;
- var $mKeys, $mParserOptions, $mParser;
+ /// Variable for tracking which variables are already loaded
+ protected $mLoadedLanguages = array();
- // Variable for tracking which variables are loaded
- var $mLoadedLanguages = array();
+ function __construct( $memCached, $useDB, $expiry ) {
+ if ( !$memCached ) {
+ $memCached = wfGetCache( CACHE_NONE );
+ }
- function __construct( &$memCached, $useDB, $expiry, /*ignored*/ $memcPrefix ) {
- $this->mUseCache = !is_null( $memCached );
- $this->mMemc = &$memCached;
+ $this->mMemc = $memCached;
$this->mDisable = !$useDB;
$this->mExpiry = $expiry;
- $this->mDisableTransform = false;
- $this->mKeys = false; # initialised on demand
- $this->mParser = null;
}
* When succesfully loading from (2) or (3), all higher level caches are
* updated for the newest version.
*
- * Nothing is loaded if member variable mDisabled is true, either manually
+ * 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 succesfully populated,
function load( $code = false ) {
global $wgUseLocalMessageCache;
- if ( !$this->mUseCache ) {
- return true;
- }
-
if( !is_string( $code ) ) {
# This isn't really nice, so at least make a note about it and try to
# fall back
$this->lock($cacheKey);
- # Limit the concurrency of loadFromDB to a single process
+ # Limit the concurrency of loadFromDB to a single process
# This prevents the site from going down when the cache expires
$statusKey = wfMemcKey( 'messages', $code, 'status' );
$success = $this->mMemc->add( $statusKey, 'loading', MSG_LOAD_TIMEOUT );
# database or in code.
if ( $code !== $wgContLanguageCode ) {
# Messages for particular language
- $escapedCode = $dbr->escapeLike( $code );
- $conds[] = "page_title like '%%/$escapedCode'";
+ $conds[] = 'page_title' . $dbr->buildLike( $dbr->anyString(), "/$code" );
} else {
# Effectively disallows use of '/' character in NS_MEDIAWIKI for uses
# other than language code.
- $conds[] = "page_title not like '%%/%%'";
+ $conds[] = 'page_title NOT' . $dbr->buildLike( $dbr->anyString(), '/', $dbr->anyString() );
}
}
$bigConds[] = 'page_len > ' . intval( $wgMaxMsgCacheEntrySize );
# Load titles for all oversized pages in the MediaWiki namespace
- $res = $dbr->select( 'page', 'page_title', $bigConds, __METHOD__ );
- while ( $row = $dbr->fetchObject( $res ) ) {
+ $res = $dbr->select( 'page', 'page_title', $bigConds, __METHOD__ . "($code)-big" );
+ foreach ( $res as $row ) {
$cache[$row->page_title] = '!TOO BIG';
}
- $dbr->freeResult( $res );
# Conditions to load the remaining pages with their contents
$smallConds = $conds;
$res = $dbr->select( array( 'page', 'revision', 'text' ),
array( 'page_title', 'old_text', 'old_flags' ),
- $smallConds, __METHOD__. "($code)" );
+ $smallConds, __METHOD__ . "($code)-small" );
- for ( $row = $dbr->fetchObject( $res ); $row; $row = $dbr->fetchObject( $res ) ) {
+ foreach ( $res as $row ) {
$cache[$row->page_title] = ' ' . Revision::getRevisionText( $row );
}
- $dbr->freeResult( $res );
$cache['VERSION'] = MSG_CACHE_VERSION;
wfProfileOut( __METHOD__ );
global $wgMaxMsgCacheEntrySize;
wfProfileIn( __METHOD__ );
+ if ( $this->mDisable ) {
+ return;
+ }
list( , $code ) = $this->figureMessage( $title );
$cacheKey = wfMemcKey( 'messages', $code );
- $this->load($code);
- $this->lock($cacheKey);
+ $this->load( $code );
+ $this->lock( $cacheKey );
- if ( is_array($this->mCache[$code]) ) {
- $titleKey = wfMemcKey( 'messages', 'individual', $title );
+ $titleKey = wfMemcKey( 'messages', 'individual', $title );
- if ( $text === false ) {
- # Article was deleted
- unset( $this->mCache[$code][$title] );
- $this->mMemc->delete( $titleKey );
+ if ( $text === false ) {
+ # Article was deleted
+ $this->mCache[$code][$title] = '!NONEXISTENT';
+ $this->mMemc->delete( $titleKey );
- } elseif ( strlen( $text ) > $wgMaxMsgCacheEntrySize ) {
- # Check for size
- $this->mCache[$code][$title] = '!TOO BIG';
- $this->mMemc->set( $titleKey, ' ' . $text, $this->mExpiry );
+ } elseif ( strlen( $text ) > $wgMaxMsgCacheEntrySize ) {
+ # Check for size
+ $this->mCache[$code][$title] = '!TOO BIG';
+ $this->mMemc->set( $titleKey, ' ' . $text, $this->mExpiry );
- } else {
- $this->mCache[$code][$title] = ' ' . $text;
- $this->mMemc->delete( $titleKey );
- }
-
- # Update caches
- $this->saveToCaches( $this->mCache[$code], true, $code );
+ } else {
+ $this->mCache[$code][$title] = ' ' . $text;
+ $this->mMemc->delete( $titleKey );
}
- $this->unlock($cacheKey);
+
+ # Update caches
+ $this->saveToCaches( $this->mCache[$code], true, $code );
+ $this->unlock( $cacheKey );
// Also delete cached sidebar... just in case it is affected
- global $parserMemc;
$codes = array( $code );
if ( $code === 'en' ) {
// Delete all sidebars, like for example on action=purge on the
$codes = array_keys( Language::getLanguageNames() );
}
+ global $parserMemc;
foreach ( $codes as $code ) {
$sidebarKey = wfMemcKey( 'sidebar', $code );
$parserMemc->delete( $sidebarKey );
* Shortcut to update caches.
*
* @param $cache Array: cached messages with a version.
- * @param $cacheKey String: Identifier for the cache.
* @param $memc Bool: Wether to update or not memcache.
* @param $code String: Language code.
* @return False on somekind of error.
}
/**
- * Returns success
* Represents a write lock on the messages key
+ *
+ * @return Boolean: success
*/
function lock($key) {
- if ( !$this->mUseCache ) {
- return true;
- }
-
$lockKey = $key . ':lock';
for ($i=0; $i < MSG_WAIT_TIMEOUT && !$this->mMemc->add( $lockKey, 1, MSG_LOCK_TIMEOUT ); $i++ ) {
sleep(1);
}
function unlock($key) {
- if ( !$this->mUseCache ) {
- return;
- }
-
$lockKey = $key . ':lock';
$this->mMemc->delete( $lockKey );
}
/**
* Get a message from either the content language or the user language.
*
- * @param string $key The message cache key
- * @param bool $useDB Get the message from the DB, false to use only the localisation
- * @param string $langcode Code of the language to get the message for, if
- * it is a valid code create a language for that
- * language, if it is a string but not a valid code
- * then make a basic language object, if it is a
- * false boolean then use the current users
- * language (as a fallback for the old parameter
- * functionality), or if it is a true boolean then
- * use the wikis content language (also as a
- * fallback).
- * @param bool $isFullKey Specifies whether $key is a two part key "msg/lang".
+ * @param $key String: the message cache key
+ * @param $useDB Boolean: get the message from the DB, false to use only
+ * the localisation
+ * @param $langcode String: code of the language to get the message for, if
+ * it is a valid code create a language for that language,
+ * if it is a string but not a valid code then make a basic
+ * language object, if it is a false boolean then use the
+ * current users language (as a fallback for the old
+ * parameter functionality), or if it is a true boolean
+ * then use the wikis content language (also as a
+ * fallback).
+ * @param $isFullKey Boolean: specifies whether $key is a two part key
+ * "msg/lang".
*/
function get( $key, $useDB = true, $langcode = true, $isFullKey = false ) {
global $wgContLanguageCode, $wgContLang;
+ if ( !is_string( $key ) ) {
+ throw new MWException( "Non-string key given" );
+ }
+
if ( strval( $key ) === '' ) {
# Shortcut: the empty key is always missing
- return '<>';
+ return false;
}
$lang = wfGetLangObj( $langcode );
$message = false;
- # Normalise title-case input
+ # Normalise title-case input (with some inlining)
$lckey = str_replace( ' ', '_', $key );
- $lckey[0] = strtolower( $lckey[0] );
- $uckey = ucfirst( $lckey );
+ if ( ord( $key ) < 128 ) {
+ $lckey[0] = strtolower( $lckey[0] );
+ $uckey = ucfirst( $lckey );
+ } else {
+ $lckey = $wgContLang->lcfirst( $lckey );
+ $uckey = $wgContLang->ucfirst( $lckey );
+ }
# Try the MediaWiki namespace
if( !$this->mDisable && $useDB ) {
# Final fallback
if( $message === false ) {
- return '<' . htmlspecialchars($key) . '>';
+ return false;
}
# Fix whitespace
- $message = strtr( $message,
+ $message = strtr( $message,
array(
# Fix for trailing whitespace, removed by textarea
' ' => ' ',
# Fix for NBSP, converted to space by firefox
' ' => "\xc2\xa0",
+ ' ' => "\xc2\xa0",
) );
return $message;
$type = false;
$message = false;
- if ( $this->mUseCache ) {
- $this->load( $code );
- if (isset( $this->mCache[$code][$title] ) ) {
- $entry = $this->mCache[$code][$title];
- $type = substr( $entry, 0, 1 );
- if ( $type == ' ' ) {
- return substr( $entry, 1 );
- }
+ $this->load( $code );
+ if ( isset( $this->mCache[$code][$title] ) ) {
+ $entry = $this->mCache[$code][$title];
+ if ( substr( $entry, 0, 1 ) === ' ' ) {
+ return substr( $entry, 1 );
+ } elseif ( $entry === '!NONEXISTENT' ) {
+ return false;
}
}
return $message;
}
- # If there is no cache entry and no placeholder, it doesn't exist
- if ( $type !== '!' ) {
- return false;
- }
-
- $titleKey = wfMemcKey( 'messages', 'individual', $title );
-
# Try the individual message cache
- if ( $this->mUseCache ) {
- $entry = $this->mMemc->get( $titleKey );
- if ( $entry ) {
- $type = substr( $entry, 0, 1 );
-
- if ( $type === ' ' ) {
- # Ok!
- $message = substr( $entry, 1 );
- $this->mCache[$code][$title] = $entry;
- return $message;
- } elseif ( $entry === '!NONEXISTENT' ) {
- return false;
- } else {
- # Corrupt/obsolete entry, delete it
- $this->mMemc->delete( $titleKey );
- }
-
+ $titleKey = wfMemcKey( 'messages', 'individual', $title );
+ $entry = $this->mMemc->get( $titleKey );
+ if ( $entry ) {
+ if ( substr( $entry, 0, 1 ) === ' ' ) {
+ $this->mCache[$code][$title] = $entry;
+ return substr( $entry, 1 );
+ } elseif ( $entry === '!NONEXISTENT' ) {
+ $this->mCache[$code][$title] = '!NONEXISTENT';
+ return false;
+ } else {
+ # Corrupt/obsolete entry, delete it
+ $this->mMemc->delete( $titleKey );
}
}
- # Try loading it from the DB
+ # Try loading it from the database
$revision = Revision::newFromTitle( Title::makeTitle( NS_MEDIAWIKI, $title ) );
- if( $revision ) {
+ if ( $revision ) {
$message = $revision->getText();
- if ($this->mUseCache) {
- $this->mCache[$code][$title] = ' ' . $message;
- $this->mMemc->set( $titleKey, $message, $this->mExpiry );
- }
+ $this->mCache[$code][$title] = ' ' . $message;
+ $this->mMemc->set( $titleKey, ' ' . $message, $this->mExpiry );
} else {
- # Negative caching
- # Use some special text instead of false, because false gets converted to '' somewhere
+ $this->mCache[$code][$title] = '!NONEXISTENT';
$this->mMemc->set( $titleKey, '!NONEXISTENT', $this->mExpiry );
- $this->mCache[$code][$title] = false;
}
+
return $message;
}
function disable() { $this->mDisable = true; }
function enable() { $this->mDisable = false; }
-
+
/** @deprecated */
function disableTransform(){
wfDeprecated( __METHOD__ );
* Clear all stored messages. Mainly used after a mass rebuild.
*/
function clear() {
- if( $this->mUseCache ) {
- $langs = Language::getLanguageNames( false );
- foreach ( array_keys($langs) as $code ) {
- # Global cache
- $this->mMemc->delete( wfMemcKey( 'messages', $code ) );
- # Invalidate all local caches
- $this->mMemc->delete( wfMemcKey( 'messages', $code, 'hash' ) );
- }
+ $langs = Language::getLanguageNames( false );
+ foreach ( array_keys($langs) as $code ) {
+ # Global cache
+ $this->mMemc->delete( wfMemcKey( 'messages', $code ) );
+ # Invalidate all local caches
+ $this->mMemc->delete( wfMemcKey( 'messages', $code, 'hash' ) );
}
}
* Add a message to the cache
* @deprecated Use $wgExtensionMessagesFiles
*
- * @param mixed $key
- * @param mixed $value
- * @param string $lang The messages language, English by default
+ * @param $key Mixed
+ * @param $value Mixed
+ * @param $lang String: the messages language, English by default
*/
function addMessage( $key, $value, $lang = 'en' ) {
wfDeprecated( __METHOD__ );
* Add an associative array of message to the cache
* @deprecated Use $wgExtensionMessagesFiles
*
- * @param array $messages An associative array of key => values to be added
- * @param string $lang The messages language, English by default
+ * @param $messages Array: an associative array of key => values to be added
+ * @param $lang String: the messages language, English by default
*/
function addMessages( $messages, $lang = 'en' ) {
wfDeprecated( __METHOD__ );
* Add a 2-D array of messages by lang. Useful for extensions.
* @deprecated Use $wgExtensionMessagesFiles
*
- * @param array $messages The array to be added
+ * @param $messages Array: the array to be added
*/
function addMessagesByLang( $messages ) {
wfDeprecated( __METHOD__ );