* @ingroup Cache
*/
class MessageCache {
- var $mCache, $mUseCache, $mDisable, $mExpiry;
- var $mMemcKey, $mKeys, $mParserOptions, $mParser;
+ // Holds loaded messages that are defined in MediaWiki namespace.
+ var $mCache;
+
+ var $mUseCache, $mDisable, $mExpiry;
+ var $mKeys, $mParserOptions, $mParser;
var $mExtensionMessages = array();
var $mInitialised = false;
var $mAllMessagesLoaded; // Extension messages
- function __construct( &$memCached, $useDB, $expiry, $memcPrefix) {
- wfProfileIn( __METHOD__ );
+ // Variable for tracking which variables are loaded
+ var $mLoadedLanguages = array();
+ function __construct( &$memCached, $useDB, $expiry, /*ignored*/ $memcPrefix ) {
$this->mUseCache = !is_null( $memCached );
$this->mMemc = &$memCached;
$this->mDisable = !$useDB;
$this->mExpiry = $expiry;
$this->mDisableTransform = false;
- $this->mMemcKey = $memcPrefix.':messages';
$this->mKeys = false; # initialised on demand
$this->mInitialised = true;
$this->mParser = null;
-
- wfProfileOut( __METHOD__ );
}
/**
* ParserOptions is lazy initialised.
- * Access should probably be protected.
*/
function getParserOptions() {
if ( !$this->mParserOptions ) {
function loadFromLocal( $hash, $code ) {
global $wgLocalMessageCache, $wgLocalMessageCacheSerialized;
- $filename = "$wgLocalMessageCache/messages-" . wfWikiID();
- if ( $code ) $filename .= '-' . $code;
+ $filename = "$wgLocalMessageCache/messages-" . wfWikiID() . "-$code";
# Check file existence
wfSuppressWarnings();
$serialized .= fread( $file, 100000 );
}
fclose( $file );
- return $this->setCache( unserialize( $serialized ) );
+ return $this->setCache( unserialize( $serialized ), $code );
} else {
fclose( $file );
return false; // Wrong hash
return false; // Wrong hash
}
+ # Require overwrites the member variable or just shadows it?
require( $filename );
- return $this->setCache( $this->mCache );
+ return $this->setCache( $this->mCache, $code );
}
}
/**
- * Save the cache to a local file
+ * Save the cache to a local file.
*/
- function saveToLocal( $serialized, $hash, $code ) {
+ function saveToLocal( $serialized, $hash, $code ) {
global $wgLocalMessageCache;
- $filename = "$wgLocalMessageCache/messages-" . wfWikiID();
- if ( $code ) $filename .= '-' . $code;
-
- # Make sure the directories exist
- $this->createCacheDir( $wgLocalMessageCache );
+ $filename = "$wgLocalMessageCache/messages-" . wfWikiID() . "-$code";
+ wfMkdirParents( $wgLocalMessageCache ); // might fail
+ wfSuppressWarnings();
$file = fopen( $filename, 'w' );
+ wfRestoreWarnings();
+
if ( !$file ) {
wfDebug( "Unable to open local cache file for writing\n" );
return;
function saveToScript( $array, $hash, $code ) {
global $wgLocalMessageCache;
- $filename = "$wgLocalMessageCache/messages-" . wfWikiID();
- if ( $code ) $filename .= '-' . $code;
+ $filename = "$wgLocalMessageCache/messages-" . wfWikiID() . "-$code";
$tempFilename = $filename . '.tmp';
+ wfMkdirParents( $wgLocalMessageCache ); // might fail
- # Make sure the directories exist
- $this->createCacheDir( $wgLocalMessageCache );
-
+ wfSuppressWarnings();
$file = fopen( $tempFilename, 'w');
+ wfRestoreWarnings();
+
+ if ( !$file ) {
+ wfDebug( "Unable to open local cache file for writing\n" );
+ return;
+ }
+
fwrite($file,"<?php\n//$hash\n\n \$this->mCache = array(");
foreach ($array as $key => $message) {
rename($tempFilename, $filename);
}
- /**
- * Creates directory with correct permissions.
- *
- * @param $path String: path that is created if it does not exist.
- */
- protected function createCacheDir( $path ) {
- $oldUmask = umask( 0 );
- wfMkdirParents( $path, 0777 );
- umask( $oldUmask );
- }
-
function escapeForScript($string) {
$string = str_replace( '\\', '\\\\', $string );
$string = str_replace( '\'', '\\\'', $string );
/**
* Set the cache to $cache, if it is valid. Otherwise set the cache to false.
*/
- function setCache( $cache ) {
+ function setCache( $cache, $code ) {
if ( isset( $cache['VERSION'] ) && $cache['VERSION'] == MSG_CACHE_VERSION ) {
- if ( $this->mCache ) {
- $this->mCache = $cache + $this->mCache;
- } else {
- $this->mCache = $cache;
- }
+ $this->mCache[$code] = $cache;
return true;
} else {
return false;
* or false if populating empty cache fails. Also returns true if MessageCache
* is disabled.
*
- * @param $code Mixed: if evaluates to false, messages for all languages is
- * loaded and stored in cache as one object. If code is provided
- * and $wgPerLanguageCaching is true, messages are loaded per
- * language and stored individually in caches 1 to 2.
+ * @param $code String: language to which load messages
*/
function load( $code = false ) {
- global $wgLocalMessageCache, $wgPerLanguageCaching;
+ global $wgLocalMessageCache;
if ( !$this->mUseCache ) {
return true;
}
- # Keep track of loaded messages. Either array of loaded codes as keys,
- # or just true if all languages are loaded.
- static $loaded = false;
-
- if ( !$wgPerLanguageCaching ) {
- // Disable language separation for normal use case
- $code = false;
- } elseif( !is_string( $code ) ) {
- # This isn't really nice, so at least make a note about it
+ if( !is_string( $code ) ) {
+ # This isn't really nice, so at least make a note about it and try to
+ # fall back
wfDebug( __METHOD__ . " called without providing a language code\n" );
+ $code = 'en';
}
# Don't do double loading...
- if ( $loaded === true || ($code && isset($loaded[$code])) ) return true;
-
- # Adjust cache key if we are handling only single language
- $cacheKey = wfMemcKeyLang( $this->mMemcKey, $code );
+ if ( isset($this->mLoadedLanguages[$code]) ) return true;
# 8 lines of code just to say (once) that message cache is disabled
if ( $this->mDisable ) {
wfProfileIn( __METHOD__ );
$success = false; # Keep track of success
$where = array(); # Debug info, delayed to avoid spamming debug log too much
+ $cacheKey = wfMemcKey( 'messages', $code ); # Key in memc for messages
+
# (1) local cache
# Hash of the contents is stored in memcache, to detect if local cache goes
# out of date (due to update in other thread?)
if ( $wgLocalMessageCache !== false ) {
wfProfileIn( __METHOD__ . '-fromlocal' );
- $hash = $this->mMemc->get( "$cacheKey-hash" );
+
+ $hash = $this->mMemc->get( wfMemcKey( 'messages', $code, 'hash' ) );
if ( $hash ) {
$success = $this->loadFromLocal( $hash, $code );
if ( $success ) $where[] = 'got from local cache';
if ( !$success ) {
wfProfileIn( __METHOD__ . '-fromcache' );
$cache = $this->mMemc->get( $cacheKey );
- $success = $this->setCache( $cache );
+ $success = $this->setCache( $cache, $code );
if ( $success ) {
$where[] = 'got from global cache';
- $this->saveToCaches( $cache, $cacheKey, false, $code );
+ $this->saveToCaches( $cache, false, $code );
}
wfProfileOut( __METHOD__ . '-fromcache' );
}
# Nothing in caches... so we need create one and store it in caches
if ( !$success ) {
$where[] = 'cache is empty';
- $this->lock($cacheKey);
- wfProfileIn( __METHOD__ . '-load' );
$where[] = 'loading from database';
- # We want to store messages of particular language here, not everything
- # from mCache.
+
+ $this->lock($cacheKey);
+
$cache = $this->loadFromDB( $code );
- $success = $this->setCache( $cache );
- wfProfileOut( __METHOD__ . '-load' );
+ $success = $this->setCache( $cache, $code );
if ( $success ) {
- $this->saveToCaches( $cache, $cacheKey, true, $code );
+ $this->saveToCaches( $cache, true, $code );
}
+
$this->unlock($cacheKey);
}
# All good, just record the success
$info = implode( ', ', $where );
wfDebug( __METHOD__ . ": Loading $code... $info\n" );
- if ( $code ) {
- $loaded[$code] = true;
- } else {
- $loaded = true;
- }
+ $this->mLoadedLanguages[$code] = true;
}
wfProfileOut( __METHOD__ );
return $success;
);
if ( $code ) {
- # Should $code be escaped?
# Is this fast enough. Should not matter if the filtering is done in the
# database or in code.
if ( $code !== $wgContLanguageCode ) {
# Messages for particular language
- $conds[] = "page_title like '%%/$code'";
+ $escapedCode = $dbr->escapeLike( $code );
+ $conds[] = "page_title like '%%/$escapedCode'";
} else {
# Effectively disallows use of '/' character in NS_MEDIAWIKI for uses
# other than language code.
* @param $text Mixed: new contents of the page.
*/
public function replace( $title, $text ) {
- global $wgMaxMsgCacheEntrySize, $wgPerLanguageCaching;
-
- list( $message, $code ) = $this->figureMessage( $title );
+ global $wgMaxMsgCacheEntrySize;
+ wfProfileIn( __METHOD__ );
- # TODO: Should we define the sidebar key name somewhere?
- $sidebarKey = wfMemcKeyLang( 'sidebar' , $code );
- # Load only messages for affected language, if possible
- if ( !$wgPerLanguageCaching ) $code = false;
- $cacheKey = wfMemcKeyLang( $this->mMemcKey, $code );
+ list( , $code ) = $this->figureMessage( $title );
- wfProfileIn( __METHOD__ );
+ $cacheKey = wfMemcKey( 'messages', $code );
+ $this->load($code);
$this->lock($cacheKey);
- $cache = $this->mMemc->get( $cacheKey );
- if ( is_array( $cache ) ) {
+ if ( is_array($this->mCache[$code]) ) {
+ $titleKey = wfMemcKey( 'messages', 'individual', $title );
+
if ( $text === false ) {
# Article was deleted
- unset( $this->mCache[$title] );
- $this->mMemc->delete( "$this->mMemcKey:{$title}" );
+ unset( $this->mCache[$code][$title] );
+ $this->mMemc->delete( $titleKey );
+
} elseif ( strlen( $text ) > $wgMaxMsgCacheEntrySize ) {
- $cache[$title] = $this->mCache[$title] = '!TOO BIG';
- $this->mMemc->set( "$this->mMemcKey:{$title}", ' '.$text, $this->mExpiry );
+ # Check for size
+ $this->mCache[$code][$title] = '!TOO BIG';
+ $this->mMemc->set( $titleKey, ' ' . $text, $this->mExpiry );
+
} else {
- $cache[$title] = $this->mCache[$title] = ' ' . $text;
- $this->mMemc->delete( "$this->mMemcKey:{$title}" );
+ $this->mCache[$code][$title] = ' ' . $text;
+ $this->mMemc->delete( $titleKey );
}
- # Update per-request cache
- $success = $this->setCache( $cache, $cacheKey );
- if ( $success ) {
- # And then all caches
- $this->saveToCaches( $cache, $cacheKey, true, $code );
- }
+ # Update caches
+ $this->saveToCaches( $this->mCache[$code], true, $code );
}
$this->unlock($cacheKey);
// Also delete cached sidebar... just in case it is affected
global $parserMemc;
+ $sidebarKey = wfMemcKey( 'sidebar', $code );
$parserMemc->delete( $sidebarKey );
+
wfProfileOut( __METHOD__ );
}
* @param $code String: Language code.
* @return False on somekind of error.
*/
- protected function saveToCaches( $cache, $cacheKey, $memc = true, $code = false ) {
+ protected function saveToCaches( $cache, $memc = true, $code = false ) {
wfProfileIn( __METHOD__ );
global $wgLocalMessageCache, $wgLocalMessageCacheSerialized;
- $success = $this->mMemc->add( $cacheKey.'-status', "loading", MSG_LOAD_TIMEOUT );
+ $cacheKey = wfMemcKey( 'messages', $code );
+ $statusKey = wfMemcKey( 'messages', $code, 'status' );
+
+ $success = $this->mMemc->add( $statusKey, 'loading', MSG_LOAD_TIMEOUT );
if ( !$success ) return true; # Other process should be updating them now
$i = 0;
# Keep trying if it fails, this is kind of important
for ($i=0; $i<20 &&
- !$this->mMemc->set( $cacheKey, $cache, $this->mExpiry );
- $i++ ) {
+ !$this->mMemc->set( $cacheKey, $cache, $this->mExpiry );
+ $i++ ) {
usleep(mt_rand(500000,1500000));
}
}
if ( $wgLocalMessageCache !== false ) {
$serialized = serialize( $cache );
$hash = md5( $serialized );
- $this->mMemc->set( "$cacheKey-hash", $hash, $this->mExpiry );
+ $this->mMemc->set( wfMemcKey( 'messages', $code, 'hash' ), $hash, $this->mExpiry );
if ($wgLocalMessageCacheSerialized) {
$this->saveToLocal( $serialized, $hash, $code );
} else {
}
if ( $i == 20 ) {
- $this->mMemc->set( $cacheKey.'-status', 'error', 60*5 );
+ $this->mMemc->set( $statusKey, 'error', 60*5 );
wfDebug( "MemCached set error in MessageCache: restart memcached server!\n" );
$success = false;
} else {
- $this->mMemc->delete( $cacheKey.'-status' );
+ $this->mMemc->delete( $statusKey );
$success = true;
}
wfProfileOut( __METHOD__ );
return true;
}
- $lockKey = $key . 'lock';
+ $lockKey = $key . ':lock';
for ($i=0; $i < MSG_WAIT_TIMEOUT && !$this->mMemc->add( $lockKey, 1, MSG_LOCK_TIMEOUT ); $i++ ) {
sleep(1);
}
return;
}
- $lockKey = $key . 'lock';
+ $lockKey = $key . ':lock';
$this->mMemc->delete( $lockKey );
}
* @param bool $isFullKey Specifies whether $key is a two part key "lang/msg".
*/
function get( $key, $useDB = true, $langcode = true, $isFullKey = false ) {
- global $wgContLanguageCode, $wgContLang, $wgLang;
-
- # Identify which language to get or create a language object for.
- if( $langcode === $wgContLang->getCode() || $langcode === true ) {
- # $langcode is the language code of the wikis content language object.
- # or it is a boolean and value is true
- $lang =& $wgContLang;
- } elseif( $langcode === $wgLang->getCode() || $langcode === false ) {
- # $langcode is the language code of user language object.
- # or it was a boolean and value is false
- $lang =& $wgLang;
- } else {
- $validCodes = array_keys( Language::getLanguageNames() );
- if( in_array( $langcode, $validCodes ) ) {
- # $langcode corresponds to a valid language.
- $lang = Language::factory( $langcode );
- } else {
- # $langcode is a string, but not a valid language code; use content language.
- $lang =& $wgContLang;
- wfDebug( 'Invalid language code passed to MessageCache::get, falling back to content language.' );
- }
- }
+ global $wgContLanguageCode, $wgContLang;
+ $lang = wfGetLangObj( $langcode );
$langcode = $lang->getCode();
# If uninitialised, someone is trying to call this halfway through Setup.php
$mkey = substr( $lckey, 0, $pos );
$code = substr( $lckey, $pos+1 );
if ( $code ) {
+ # We may get calls for things that are http-urls from sidebar
+ # Let's not load nonexistent languages for those
$validCodes = array_keys( Language::getLanguageNames() );
if ( in_array( $code, $validCodes ) ) {
$message = Language::getMessageFor( $mkey, $code );
if ( is_null( $message ) ) {
$message = false;
}
- } else {
- wfDebug( __METHOD__ . ": Invalid code $code for $mkey/$code, not trying messages array\n" );
}
}
}
* @param $code String: code denoting the language to try.
*/
function getMsgFromNamespace( $title, $code ) {
- $message = false;
$type = false;
+ $message = false;
if ( $this->mUseCache ) {
- if ( !isset($this->mCache[$title]) ) {
- # Delay loading as far as possible, and only load messages for requested
- # language.
- $this->load( $code );
- }
- if (isset( $this->mCache[$title] ) ) {
- $entry = $this->mCache[$title];
+ $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 );
}
# If there is no cache entry and no placeholder, it doesn't exist
- if ( $type != '!' && $message === false ) {
+ if ( $type !== '!' ) {
return false;
}
- $memcKey = $this->mMemcKey . ':' . $title;
+ $titleKey = wfMemcKey( 'messages', 'individual', $title );
# Try the individual message cache
if ( $this->mUseCache ) {
- $entry = $this->mMemc->get( $memcKey );
+ $entry = $this->mMemc->get( $titleKey );
if ( $entry ) {
$type = substr( $entry, 0, 1 );
- if ( $type == ' ' ) {
+ if ( $type === ' ' ) {
# Ok!
$message = substr( $entry, 1 );
- $this->mCache[$title] = $entry;
+ $this->mCache[$code][$title] = $entry;
return $message;
- } elseif ( $entry == '!NONEXISTENT' ) {
+ } elseif ( $entry === '!NONEXISTENT' ) {
return false;
} else {
# Corrupt/obsolete entry, delete it
- $this->mMemc->delete( $memcKey );
+ $this->mMemc->delete( $titleKey );
}
}
if( $revision ) {
$message = $revision->getText();
if ($this->mUseCache) {
- $this->mCache[$title] = ' ' . $message;
- $this->mMemc->set( $memcKey, $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->mMemc->set( $memcKey, '!NONEXISTENT', $this->mExpiry );
- $this->mCache[$title] = false;
+ $this->mMemc->set( $titleKey, '!NONEXISTENT', $this->mExpiry );
+ $this->mCache[$code][$title] = false;
}
return $message;
}
function transform( $message, $interface = false ) {
+ // Avoid creating parser if nothing to transfrom
+ if( strpos( $message, '{{' ) === false ) {
+ return $message;
+ }
+
global $wgParser;
if ( !$this->mParser && isset( $wgParser ) ) {
# Do some initialisation so that we don't have to do it twice
$wgParser->firstCallInit();
# Clone it and store it
$this->mParser = clone $wgParser;
+ #wfDebug( __METHOD__ . ": following contents triggered transform: $message\n" );
}
if ( $this->mParser ) {
- if( strpos( $message, '{{' ) !== false ) {
- $popts = $this->getParserOptions();
- $popts->setInterfaceMessage( $interface );
- $message = $this->mParser->transformMsg( $message, $popts );
- }
+ $popts = $this->getParserOptions();
+ $popts->setInterfaceMessage( $interface );
+ $message = $this->mParser->transformMsg( $message, $popts );
}
return $message;
}
* Clear all stored messages. Mainly used after a mass rebuild.
*/
function clear() {
- global $wgLocalMessageCache;
if( $this->mUseCache ) {
- # Global cache
- $this->mMemc->delete( $this->mMemcKey );
- # Invalidate all local caches
- $this->mMemc->delete( "{$this->mMemcKey}-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' ) );
+ }
}
}
dépôts / lhc / web / wiklou.git / blobdiff