* @subpackage Cache
*/
-/** */
-require_once( 'Revision.php' );
-
/**
*
*/
*
* @package MediaWiki
*/
-class MessageCache
-{
+class MessageCache {
var $mCache, $mUseCache, $mDisable, $mExpiry;
var $mMemcKey, $mKeys, $mParserOptions, $mParser;
var $mExtensionMessages = array();
var $mInitialised = false;
var $mDeferred = true;
- function initialise( &$memCached, $useDB, $expiry, $memcPrefix) {
- global $wgLocalMessageCache;
- $fname = 'MessageCache::initialise';
- wfProfileIn( $fname );
+ function __construct( &$memCached, $useDB, $expiry, $memcPrefix) {
+ wfProfileIn( __METHOD__ );
$this->mUseCache = !is_null( $memCached );
$this->mMemc = &$memCached;
$this->mMemcKey = $memcPrefix.':messages';
$this->mKeys = false; # initialised on demand
$this->mInitialised = true;
-
- wfProfileIn( $fname.'-parseropt' );
- $this->mParserOptions = ParserOptions::newFromUser( $u=NULL );
- wfProfileOut( $fname.'-parseropt' );
- wfProfileIn( $fname.'-parser' );
- $this->mParser = new Parser;
- wfProfileOut( $fname.'-parser' );
+ $this->mParser = null;
# When we first get asked for a message,
# then we'll fill up the cache. If we
# some extra milliseconds
$this->mDeferred = true;
- wfProfileOut( $fname );
+ wfProfileOut( __METHOD__ );
}
- /**
+ function getParserOptions() {
+ if ( !$this->mParserOptions ) {
+ $this->mParserOptions = new ParserOptions;
+ }
+ return $this->mParserOptions;
+ }
+
+ /**
* Try to load the cache from a local file
*/
function loadFromLocal( $hash ) {
if ( $wgLocalMessageCache === false ) {
return;
}
-
+
$filename = "$wgLocalMessageCache/messages-$wgDBname";
+ wfSuppressWarnings();
$file = fopen( $filename, 'r' );
+ wfRestoreWarnings();
if ( !$file ) {
return;
}
if ( $wgLocalMessageCache === false ) {
return;
}
-
+
$filename = "$wgLocalMessageCache/messages-$wgDBname";
+ $oldUmask = umask( 0 );
wfMkdirParents( $wgLocalMessageCache, 0777 );
+ umask( $oldUmask );
$file = fopen( $filename, 'w' );
if ( !$file ) {
fwrite( $file, $hash . $serialized );
fclose( $file );
+ @chmod( $filename, 0666 );
}
+ function loadFromScript( $hash ) {
+ global $wgLocalMessageCache, $wgDBname;
+ if ( $wgLocalMessageCache === false ) {
+ return;
+ }
+
+ $filename = "$wgLocalMessageCache/messages-$wgDBname";
+
+ wfSuppressWarnings();
+ $file = fopen( $filename, 'r' );
+ wfRestoreWarnings();
+ if ( !$file ) {
+ return;
+ }
+ $localHash=substr(fread($file,40),8);
+ fclose($file);
+ if ($hash!=$localHash) {
+ return;
+ }
+ require("$wgLocalMessageCache/messages-$wgDBname");
+ }
+
+ function saveToScript($array, $hash) {
+ global $wgLocalMessageCache, $wgDBname;
+ if ( $wgLocalMessageCache === false ) {
+ return;
+ }
+
+ $filename = "$wgLocalMessageCache/messages-$wgDBname";
+ $oldUmask = umask( 0 );
+ wfMkdirParents( $wgLocalMessageCache, 0777 );
+ umask( $oldUmask );
+ $file = fopen( $filename.'.tmp', 'w');
+ fwrite($file,"<?php\n//$hash\n\n \$this->mCache = array(");
+
+ foreach ($array as $key => $message) {
+ fwrite($file, "'". $this->escapeForScript($key).
+ "' => '" . $this->escapeForScript($message).
+ "',\n");
+ }
+ fwrite($file,");\n?>");
+ fclose($file);
+ rename($filename.'.tmp',$filename);
+ }
+
+ function escapeForScript($string) {
+ $string = str_replace( '\\', '\\\\', $string );
+ $string = str_replace( '\'', '\\\'', $string );
+ return $string;
+ }
/**
* Loads messages either from memcached or the database, if not disabled
* Returns false for a reportable error, true otherwise
*/
function load() {
- global $wgAllMessagesEn, $wgLocalMessageCache;
+ global $wgLocalMessageCache, $wgLocalMessageCacheSerialized;
if ( $this->mDisable ) {
static $shownDisabled = false;
wfProfileIn( $fname.'-fromlocal' );
$hash = $this->mMemc->get( "{$this->mMemcKey}-hash" );
if ( $hash ) {
- $this->loadFromLocal( $hash );
+ if ($wgLocalMessageCacheSerialized) {
+ $this->loadFromLocal( $hash );
+ } else {
+ $this->loadFromScript( $hash );
+ }
+ if ( $this->mCache ) {
+ wfDebug( "MessageCache::load(): got from local cache\n" );
+ }
}
wfProfileOut( $fname.'-fromlocal' );
if ( !$this->mCache ) {
wfProfileIn( $fname.'-fromcache' );
$this->mCache = $this->mMemc->get( $this->mMemcKey );
-
- # Save to local cache
- if ( $wgLocalMessageCache !== false ) {
- $serialized = serialize( $this->mCache );
- if ( !$hash ) {
- $hash = md5( $serialized );
- $this->mMemc->set( "{$this->mMemcKey}-hash", $hash, $this->mExpiry );
+ if ( $this->mCache ) {
+ wfDebug( "MessageCache::load(): got from global cache\n" );
+ # Save to local cache
+ if ( $wgLocalMessageCache !== false ) {
+ $serialized = serialize( $this->mCache );
+ if ( !$hash ) {
+ $hash = md5( $serialized );
+ $this->mMemc->set( "{$this->mMemcKey}-hash", $hash, $this->mExpiry );
+ }
+ if ($wgLocalMessageCacheSerialized) {
+ $this->saveToLocal( $serialized,$hash );
+ } else {
+ $this->saveToScript( $this->mCache, $hash );
+ }
}
- $this->saveToLocal( $serialized, $hash );
}
wfProfileOut( $fname.'-fromcache' );
}
}
# Save to local cache
- if ( $wgLocalMessageCache !== false ) {
+ if ( $wgLocalMessageCache !== false ) {
$serialized = serialize( $this->mCache );
$hash = md5( $serialized );
$this->mMemc->set( "{$this->mMemcKey}-hash", $hash, $this->mExpiry );
- $this->saveToLocal( $serialized, $hash );
+ if ($wgLocalMessageCacheSerialized) {
+ $this->saveToLocal( $serialized,$hash );
+ } else {
+ $this->saveToScript( $this->mCache, $hash );
+ }
}
wfProfileOut( $fname.'-save' );
* Loads all or main part of cacheable messages from the database
*/
function loadFromDB() {
- global $wgAllMessagesEn, $wgLang;
-
+ global $wgLang;
+
$fname = 'MessageCache::loadFromDB';
$dbr =& wfGetDB( DB_SLAVE );
if ( !$dbr ) {
- wfDebugDieBacktrace( 'Invalid database object' );
+ throw new MWException( 'Invalid database object' );
}
$conditions = array( 'page_is_redirect' => 0,
'page_namespace' => NS_MEDIAWIKI);
}
# Negative caching
- # Go through the language array and the extension array and make a note of
+ # Go through the language array and the extension array and make a note of
# any keys missing from the cache
- foreach ( $wgAllMessagesEn as $key => $value ) {
+ $allMessages = Language::getMessagesFor( 'en' );
+ foreach ( $allMessages as $key => $value ) {
$uckey = $wgLang->ucfirst( $key );
if ( !array_key_exists( $uckey, $this->mCache ) ) {
$this->mCache[$uckey] = false;
}
}
+
+ # Make sure all extension messages are available
+ wfLoadAllExtensions();
+
+ # Add them to the cache
foreach ( $this->mExtensionMessages as $key => $value ) {
$uckey = $wgLang->ucfirst( $key );
- if ( !array_key_exists( $uckey, $this->mCache ) ) {
+ if ( !array_key_exists( $uckey, $this->mCache ) &&
+ ( isset( $this->mExtensionMessages[$key][$wgLang->getCode()] ) || isset( $this->mExtensionMessages[$key]['en'] ) ) ) {
$this->mCache[$uckey] = false;
}
- }
+ }
$dbr->freeResult( $res );
}
* Not really needed anymore
*/
function getKeys() {
- global $wgAllMessagesEn, $wgContLang;
+ global $wgContLang;
if ( !$this->mKeys ) {
$this->mKeys = array();
- foreach ( $wgAllMessagesEn as $key => $value ) {
+ $allMessages = Language::getMessagesFor( 'en' );
+ foreach ( $allMessages as $key => $value ) {
$title = $wgContLang->ucfirst( $key );
array_push( $this->mKeys, $title );
}
}
function replace( $title, $text ) {
- global $wgLocalMessageCache;
+ global $wgLocalMessageCache, $wgLocalMessageCacheSerialized, $parserMemc, $wgDBname;
$this->lock();
$this->load();
+ $parserMemc->delete("$wgDBname:sidebar");
if ( is_array( $this->mCache ) ) {
$this->mCache[$title] = $text;
$this->mMemc->set( $this->mMemcKey, $this->mCache, $this->mExpiry );
-
+
# Save to local cache
- if ( $wgLocalMessageCache !== false ) {
+ if ( $wgLocalMessageCache !== false ) {
$serialized = serialize( $this->mCache );
$hash = md5( $serialized );
$this->mMemc->set( "{$this->mMemcKey}-hash", $hash, $this->mExpiry );
- $this->saveToLocal( $serialized, $hash );
+ if ($wgLocalMessageCacheSerialized) {
+ $this->saveToLocal( $serialized,$hash );
+ } else {
+ $this->saveToScript( $this->mCache, $hash );
+ }
}
$this->mMemc->delete( $lockKey );
}
- function get( $key, $useDB, $forcontent=true, $isfullkey = false ) {
- global $wgContLanguageCode;
+ function get( $key, $useDB = true, $forcontent = true, $isfullkey = false ) {
+ global $wgContLanguageCode, $wgContLang;
if( $forcontent ) {
- global $wgContLang;
$lang =& $wgContLang;
$langcode = $wgContLanguageCode;
} else {
$message = false;
if( !$this->mDisable && $useDB ) {
- $title = $lang->ucfirst( $key );
+ $title = $wgContLang->ucfirst( $key );
if(!$isfullkey && ($langcode != $wgContLanguageCode) ) {
$title .= '/' . $langcode;
}
}
# Try the extension array
if( $message === false && array_key_exists( $key, $this->mExtensionMessages ) ) {
- $message = $this->mExtensionMessages[$key];
+ if ( isset( $this->mExtensionMessages[$key][$langcode] ) ) {
+ $message = $this->mExtensionMessages[$key][$langcode];
+ } elseif ( isset( $this->mExtensionMessages[$key]['en'] ) ) {
+ $message = $this->mExtensionMessages[$key]['en'];
+ }
}
# Try the array in the language object
if( $message === false ) {
+ #wfDebug( "Trying language object for message $key\n" );
wfSuppressWarnings();
$message = $lang->getMessage( $key );
wfRestoreWarnings();
}
# Is this a custom message? Try the default language in the db...
- if( $message === false &&
+ if( ($message === false || $message === '-' ) &&
!$this->mDisable && $useDB &&
!$isfullkey && ($langcode != $wgContLanguageCode) ) {
- $message = $this->getFromCache( $lang->ucfirst( $key ) );
+ $message = $this->getFromCache( $wgContLang->ucfirst( $key ) );
}
# Final fallback
}
}
+ # Call message Hooks, in case they are defined
+ wfRunHooks('MessagesPreLoad',array($title,&$message));
+
# If it wasn't in the cache, load each message from the DB individually
$revision = Revision::newFromTitle( Title::makeTitle( NS_MEDIAWIKI, $title ) );
if( $revision ) {
}
function transform( $message ) {
- if( !$this->mDisableTransform ) {
+ 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;
+ }
+ if ( !$this->mDisableTransform && $this->mParser ) {
if( strpos( $message, '{{' ) !== false ) {
- $message = $this->mParser->transformMsg( $message, $this->mParserOptions );
+ $message = $this->mParser->transformMsg( $message, $this->getParserOptions() );
}
}
return $message;
function enable() { $this->mDisable = false; }
function disableTransform() { $this->mDisableTransform = true; }
function enableTransform() { $this->mDisableTransform = false; }
+ function setTransform( $x ) { $this->mDisableTransform = $x; }
+ function getTransform() { return $this->mDisableTransform; }
/**
* Add a message to the cache
*
* @param mixed $key
* @param mixed $value
+ * @param string $lang The messages language, English by default
*/
- function addMessage( $key, $value ) {
- $this->mExtensionMessages[$key] = $value;
+ function addMessage( $key, $value, $lang = 'en' ) {
+ $this->mExtensionMessages[$key][$lang] = $value;
}
/**
* Add an associative array of message to the cache
*
* @param array $messages An associative array of key => values to be added
+ * @param string $lang The messages language, English by default
*/
- function addMessages( $messages ) {
+ function addMessages( $messages, $lang = 'en' ) {
+ wfProfileIn( __METHOD__ );
foreach ( $messages as $key => $value ) {
- $this->addMessage( $key, $value );
+ $this->addMessage( $key, $value, $lang );
}
+ wfProfileOut( __METHOD__ );
}
/**
* Clear all stored messages. Mainly used after a mass rebuild.
*/
function clear() {
+ global $wgLocalMessageCache, $wgDBname;
if( $this->mUseCache ) {
+ # Global cache
$this->mMemc->delete( $this->mMemcKey );
+ # Invalidate all local caches
+ $this->mMemc->delete( "{$this->mMemcKey}-hash" );
}
}
}