/**
*
* @package MediaWiki
+ * @subpackage Cache
*/
+/** */
+require_once( 'Revision.php' );
+
/**
*
*/
*
* @package MediaWiki
*/
-class MessageCache
-{
+class MessageCache {
var $mCache, $mUseCache, $mDisable, $mExpiry;
var $mMemcKey, $mKeys, $mParserOptions, $mParser;
- var $mExtensionMessages;
+ var $mExtensionMessages = array();
var $mInitialised = false;
+ var $mDeferred = true;
function initialise( &$memCached, $useDB, $expiry, $memcPrefix) {
$fname = 'MessageCache::initialise';
$this->mParser = new Parser;
wfProfileOut( $fname.'-parser' );
- $this->load();
+ # When we first get asked for a message,
+ # then we'll fill up the cache. If we
+ # can return a cache hit, this saves
+ # some extra milliseconds
+ $this->mDeferred = true;
+
wfProfileOut( $fname );
}
+ /**
+ * Try to load the cache from a local file
+ */
+ function loadFromLocal( $hash ) {
+ global $wgLocalMessageCache, $wgDBname;
+
+ $this->mCache = false;
+ if ( $wgLocalMessageCache === false ) {
+ return;
+ }
+
+ $filename = "$wgLocalMessageCache/messages-$wgDBname";
+
+ $file = fopen( $filename, 'r' );
+ if ( !$file ) {
+ return;
+ }
+
+ // Check to see if the file has the hash specified
+ $localHash = fread( $file, 32 );
+ if ( $hash == $localHash ) {
+ // All good, get the rest of it
+ $serialized = fread( $file, 1000000 );
+ $this->mCache = unserialize( $serialized );
+ }
+ fclose( $file );
+ }
+
+ /**
+ * Save the cache to a local file
+ */
+ function saveToLocal( $serialized, $hash ) {
+ global $wgLocalMessageCache, $wgDBname;
+
+ if ( $wgLocalMessageCache === false ) {
+ return;
+ }
+
+ $filename = "$wgLocalMessageCache/messages-$wgDBname";
+ wfMkdirParents( $wgLocalMessageCache, 0777 );
+
+ $file = fopen( $filename, 'w' );
+ if ( !$file ) {
+ wfDebug( "Unable to open local cache file for writing\n" );
+ return;
+ }
+
+ fwrite( $file, $hash . $serialized );
+ fclose( $file );
+ }
+
+
/**
* Loads messages either from memcached or the database, if not disabled
* On error, quietly switches to a fallback mode
* Returns false for a reportable error, true otherwise
*/
function load() {
- global $wgAllMessagesEn;
+ global $wgLocalMessageCache;
if ( $this->mDisable ) {
- wfDebug( "MessageCache::load(): disabled\n" );
+ static $shownDisabled = false;
+ if ( !$shownDisabled ) {
+ wfDebug( "MessageCache::load(): disabled\n" );
+ $shownDisabled = true;
+ }
return true;
}
$fname = 'MessageCache::load';
$success = true;
if ( $this->mUseCache ) {
- wfProfileIn( $fname.'-fromcache' );
- $this->mCache = $this->mMemc->get( $this->mMemcKey );
- wfProfileOut( $fname.'-fromcache' );
+ $this->mCache = false;
+
+ # Try local cache
+ wfProfileIn( $fname.'-fromlocal' );
+ $hash = $this->mMemc->get( "{$this->mMemcKey}-hash" );
+ if ( $hash ) {
+ $this->loadFromLocal( $hash );
+ }
+ wfProfileOut( $fname.'-fromlocal' );
+
+ # Try memcached
+ 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 );
+ }
+ $this->saveToLocal( $serialized, $hash );
+ }
+ wfProfileOut( $fname.'-fromcache' );
+ }
+
# If there's nothing in memcached, load all the messages from the database
if ( !$this->mCache ) {
wfDebug( "MessageCache::load(): loading all messages\n" );
$this->lock();
# Other threads don't need to load the messages if another thread is doing it.
- $success = $this->mMemc->set( $this->mMemcKey, "loading", MSG_LOAD_TIMEOUT );
+ $success = $this->mMemc->add( $this->mMemcKey.'-status', "loading", MSG_LOAD_TIMEOUT );
if ( $success ) {
wfProfileIn( $fname.'-load' );
$this->loadFromDB();
wfProfileOut( $fname.'-load' );
+
# Save in memcached
# Keep trying if it fails, this is kind of important
wfProfileIn( $fname.'-save' );
- for ( $i=0; $i<20 && !$this->mMemc->set( $this->mMemcKey, $this->mCache, $this->mExpiry ); $i++ ) {
+ for ($i=0; $i<20 &&
+ !$this->mMemc->set( $this->mMemcKey, $this->mCache, $this->mExpiry );
+ $i++ ) {
usleep(mt_rand(500000,1500000));
}
+
+ # Save to local cache
+ if ( $wgLocalMessageCache !== false ) {
+ $serialized = serialize( $this->mCache );
+ $hash = md5( $serialized );
+ $this->mMemc->set( "{$this->mMemcKey}-hash", $hash, $this->mExpiry );
+ $this->saveToLocal( $serialized, $hash );
+ }
+
wfProfileOut( $fname.'-save' );
if ( $i == 20 ) {
- $this->mMemc->set( $this->mMemcKey, 'error', 86400 );
+ $this->mMemc->set( $this->mMemcKey.'-status', 'error', 60*5 );
wfDebug( "MemCached set error in MessageCache: restart memcached server!\n" );
}
}
}
if ( !is_array( $this->mCache ) ) {
- wfMsg( "MessageCache::load(): individual message mode\n" );
+ wfDebug( "MessageCache::load(): individual message mode\n" );
# If it is 'loading' or 'error', switch to individual message mode, otherwise disable
# Causing too much DB load, disabling -- TS
$this->mDisable = true;
}
}
wfProfileOut( $fname );
+ $this->mDeferred = false;
return $success;
}
* Loads all or main part of cacheable messages from the database
*/
function loadFromDB() {
- global $wgPartialMessageCache;
+ global $wgAllMessagesEn, $wgLang;
+
$fname = 'MessageCache::loadFromDB';
$dbr =& wfGetDB( DB_SLAVE );
- $conditions = array( 'cur_is_redirect' => 0,
- 'cur_namespace' => NS_MEDIAWIKI);
- if ($wgPartialMessageCache) {
- if (is_array($wgPartialMessageCache)) {
- $conditions['cur_title']=$wgPartialMessageCache;
- } else {
- require_once("MessageCacheHints.php");
- $conditions['cur_title']=MessageCacheHints::get();
- }
+ if ( !$dbr ) {
+ wfDebugDieBacktrace( 'Invalid database object' );
}
- $res = $dbr->select( 'cur',
- array( 'cur_title', 'cur_text' ), $conditions, $fname);
+ $conditions = array( 'page_is_redirect' => 0,
+ 'page_namespace' => NS_MEDIAWIKI);
+ $res = $dbr->select( array( 'page', 'revision', 'text' ),
+ array( 'page_title', 'old_text', 'old_flags' ),
+ 'page_is_redirect=0 AND page_namespace='.NS_MEDIAWIKI.' AND page_latest=rev_id AND rev_text_id=old_id',
+ $fname
+ );
$this->mCache = array();
for ( $row = $dbr->fetchObject( $res ); $row; $row = $dbr->fetchObject( $res ) ) {
- $this->mCache[$row->cur_title] = $row->cur_text;
+ $this->mCache[$row->page_title] = Revision::getRevisionText( $row );
}
+ # Negative caching
+ # 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 ) {
+ $uckey = $wgLang->ucfirst( $key );
+ if ( !array_key_exists( $uckey, $this->mCache ) ) {
+ $this->mCache[$uckey] = false;
+ }
+ }
+ foreach ( $this->mExtensionMessages as $key => $value ) {
+ $uckey = $wgLang->ucfirst( $key );
+ if ( !array_key_exists( $uckey, $this->mCache ) ) {
+ $this->mCache[$uckey] = false;
+ }
+ }
+
$dbr->freeResult( $res );
}
if ( !$this->mKeys ) {
$this->mKeys = array();
foreach ( $wgAllMessagesEn as $key => $value ) {
- array_push( $this->mKeys, $wgContLang->ucfirst( $key ) );
+ $title = $wgContLang->ucfirst( $key );
+ array_push( $this->mKeys, $title );
}
}
return $this->mKeys;
}
/**
- * Obsolete
+ * @deprecated
*/
function isCacheable( $key ) {
return true;
- /*
- global $wgAllMessagesEn, $wgLang;
- return array_key_exists( $wgLang->lcfirst( $key ), $wgAllMessagesEn ) ||
- array_key_exists( $key, $wgAllMessagesEn );
- */
}
function replace( $title, $text ) {
+ global $wgLocalMessageCache;
+
$this->lock();
$this->load();
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 ) {
+ $serialized = serialize( $this->mCache );
+ $hash = md5( $serialized );
+ $this->mMemc->set( "{$this->mMemcKey}-hash", $hash, $this->mExpiry );
+ $this->saveToLocal( $serialized, $hash );
+ }
+
+
}
$this->unlock();
}
$this->mMemc->delete( $lockKey );
}
- function get( $key, $useDB, $forcontent=true ) {
- if($forcontent) {
- global $wgContLang, $wgContLanguageCode;
- $lang = $wgContLang;
+ function get( $key, $useDB, $forcontent=true, $isfullkey = false ) {
+ global $wgContLanguageCode;
+ if( $forcontent ) {
+ global $wgContLang;
+ $lang =& $wgContLang;
$langcode = $wgContLanguageCode;
- }
- else {
+ } else {
global $wgLang, $wgLanguageCode;
- $lang = $wgLang;
+ $lang =& $wgLang;
$langcode = $wgLanguageCode;
}
# If uninitialised, someone is trying to call this halfway through Setup.php
- if ( !$this->mInitialised ) {
- return "<$key>";
+ if( !$this->mInitialised ) {
+ return '<' . htmlspecialchars($key) . '>';
+ }
+ # If cache initialization was deferred, start it now.
+ if( $this->mDeferred && !$this->mDisable && $useDB ) {
+ $this->load();
}
$message = false;
- if ( !$this->mDisable && $useDB ) {
- $title = $lang->ucfirst( $key )."/$langcode";
-
-
- # Try the cache
- if ( $this->mUseCache && $this->mCache && array_key_exists( $title, $this->mCache ) ) {
- $message = $this->mCache[$title];
- }
-
- # If it wasn't in the cache, load each message from the DB individually
- if ( !$message ) {
- $dbr =& wfGetDB( DB_SLAVE );
- $result = $dbr->getArray( 'cur', array('cur_text'),
- array( 'cur_namespace' => NS_MEDIAWIKI, 'cur_title' => $title ),
- 'MessageCache::get' );
- if ( $result ) {
- $message = $result->cur_text;
- }
+ if( !$this->mDisable && $useDB ) {
+ $title = $lang->ucfirst( $key );
+ if(!$isfullkey && ($langcode != $wgContLanguageCode) ) {
+ $title .= '/' . $langcode;
}
+ $message = $this->getFromCache( $title );
}
# Try the extension array
- if ( !$message ) {
- $message = @$this->mExtensionMessages[$key];
+ if( $message === false && array_key_exists( $key, $this->mExtensionMessages ) ) {
+ $message = $this->mExtensionMessages[$key];
}
# Try the array in the language object
- if ( !$message ) {
+ if( $message === false ) {
wfSuppressWarnings();
$message = $lang->getMessage( $key );
wfRestoreWarnings();
+ if ( is_null( $message ) ) {
+ $message = false;
+ }
}
# Try the English array
- if ( !$message && $langcode != 'en' ) {
+ if( $message === false && $langcode != 'en' ) {
wfSuppressWarnings();
$message = Language::getMessage( $key );
wfRestoreWarnings();
+ if ( is_null( $message ) ) {
+ $message = false;
+ }
+ }
+
+ # Is this a custom message? Try the default language in the db...
+ if( $message === false &&
+ !$this->mDisable && $useDB &&
+ !$isfullkey && ($langcode != $wgContLanguageCode) ) {
+ $message = $this->getFromCache( $lang->ucfirst( $key ) );
}
# Final fallback
- if ( !$message ) {
- $message = "<$key>";
+ if( $message === false ) {
+ return '<' . htmlspecialchars($key) . '>';
}
# Replace brace tags
return $message;
}
+ function getFromCache( $title ) {
+ $message = false;
+
+ # Try the cache
+ if( $this->mUseCache && is_array( $this->mCache ) && array_key_exists( $title, $this->mCache ) ) {
+ return $this->mCache[$title];
+ }
+
+ # Try individual message cache
+ if ( $this->mUseCache ) {
+ $message = $this->mMemc->get( $this->mMemcKey . ':' . $title );
+ if ( $message == '###NONEXISTENT###' ) {
+ return false;
+ } elseif( !is_null( $message ) ) {
+ $this->mCache[$title] = $message;
+ return $message;
+ } else {
+ $message = false;
+ }
+ }
+
+ # If it wasn't in the cache, load each message from the DB individually
+ $revision = Revision::newFromTitle( Title::makeTitle( NS_MEDIAWIKI, $title ) );
+ if( $revision ) {
+ $message = $revision->getText();
+ if ($this->mUseCache) {
+ $this->mCache[$title]=$message;
+ /* individual messages may be often
+ recached until proper purge code exists
+ */
+ $this->mMemc->set( $this->mMemcKey . ':' . $title, $message, 300 );
+ }
+ } else {
+ # Negative caching
+ # Use some special text instead of false, because false gets converted to '' somewhere
+ $this->mMemc->set( $this->mMemcKey . ':' . $title, '###NONEXISTENT###', $this->mExpiry );
+ }
+
+ return $message;
+ }
+
function transform( $message ) {
if( !$this->mDisableTransform ) {
- if ( strstr( $message, '{{' ) !== false ) {
+ if( strpos( $message, '{{' ) !== false ) {
$message = $this->mParser->transformMsg( $message, $this->mParserOptions );
}
}
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
+ */
function addMessage( $key, $value ) {
$this->mExtensionMessages[$key] = $value;
}
+ /**
+ * Add an associative array of message to the cache
+ *
+ * @param array $messages An associative array of key => values to be added
+ */
function addMessages( $messages ) {
foreach ( $messages as $key => $value ) {
- $this->mExtensionMessages[$key] = $value;
+ $this->addMessage( $key, $value );
}
}
dépôts / lhc / web / wiklou.git / blobdiff