* @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;
+
+ /// Variable for tracking which variables are already loaded
+ protected $mLoadedLanguages = array();
+
+ /**
+ * Used for automatic detection of most used messages.
+ */
+ protected $mRequestedMessages = array();
+
+ /**
+ * How long the message request counts are stored. Longer period gives
+ * better sample, but also takes longer to adapt changes. The counts
+ * are aggregrated per day, regardless of the value of this variable.
+ */
+ protected static $mAdaptiveDataAge = 604800; // Is 7*24*3600
+
+ /**
+ * Filter the tail of less used messages that are requested more seldom
+ * than this factor times the number of request of most requested message.
+ * These messages are not loaded in the default set, but are still cached
+ * individually on demand with the normal cache expiry time.
+ */
+ protected static $mAdaptiveInclusionThreshold = 0.05;
+
+ /**
+ * Singleton instance
+ */
+ private static $instance;
- var $mDisable, $mExpiry;
- var $mKeys, $mParserOptions, $mParser;
+ /**
+ * Get the signleton instance of this class
+ *
+ * @since 1.18
+ * @return MessageCache object
+ */
+ public static function singleton() {
+ if ( is_null( self::$instance ) ) {
+ global $wgUseDatabaseMessages, $wgMsgCacheExpiry;
+ self::$instance = new self( wfGetMessageCacheStorage(), $wgUseDatabaseMessages, $wgMsgCacheExpiry );
+ }
+ return self::$instance;
+ }
- // Variable for tracking which variables are loaded
- var $mLoadedLanguages = array();
+ /**
+ * Destroy the signleton instance
+ *
+ * @since 1.18
+ */
+ public static function destroyInstance() {
+ self::$instance = null;
+ }
- function __construct( $memCached, $useDB, $expiry, /*ignored*/ $memcPrefix ) {
+ function __construct( $memCached, $useDB, $expiry ) {
if ( !$memCached ) {
$memCached = wfGetCache( CACHE_NONE );
}
$this->mMemc = $memCached;
$this->mDisable = !$useDB;
$this->mExpiry = $expiry;
- $this->mDisableTransform = false;
- $this->mKeys = false; # initialised on demand
- $this->mParser = null;
}
fwrite($file,"<?php\n//$hash\n\n \$this->mCache = array(");
- foreach ($array as $key => $message) {
+ foreach ( $array as $key => $message ) {
$key = $this->escapeForScript($key);
- $messages = $this->escapeForScript($message);
+ $message = $this->escapeForScript($message);
fwrite($file, "'$key' => '$message',\n");
}
* 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,
* $wgMaxMsgCacheEntrySize are assigned a special value, and are loaded
* on-demand from the database later.
*
- * @param $code Optional language code, see documenation of load().
- * @return Array: Loaded messages for storing in caches.
+ * @param $code \string Language code.
+ * @return \array Loaded messages for storing in caches.
*/
- function loadFromDB( $code = false ) {
+ function loadFromDB( $code ) {
wfProfileIn( __METHOD__ );
- global $wgMaxMsgCacheEntrySize, $wgContLanguageCode;
+ global $wgMaxMsgCacheEntrySize, $wgLanguageCode, $wgAdaptiveMessageCache;
$dbr = wfGetDB( DB_SLAVE );
$cache = array();
'page_namespace' => NS_MEDIAWIKI,
);
- if ( $code ) {
- # 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' . $dbr->buildLike( $dbr->anyString(), "/$code" );
- } else {
- # Effectively disallows use of '/' character in NS_MEDIAWIKI for uses
- # other than language code.
- $conds[] = 'page_title NOT' . $dbr->buildLike( $dbr->anyString(), '/', $dbr->anyString() );
+ $mostused = array();
+ if ( $wgAdaptiveMessageCache ) {
+ $mostused = $this->getMostUsedMessages();
+ if ( $code !== $wgLanguageCode ) {
+ foreach ( $mostused as $key => $value ) $mostused[$key] = "$value/$code";
}
}
+ if ( count( $mostused ) ) {
+ $conds['page_title'] = $mostused;
+ } elseif ( $code !== $wgLanguageCode ) {
+ $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' . $dbr->buildLike( $dbr->anyString(), '/', $dbr->anyString() );
+ }
+
# Conditions to fetch oversized pages to ignore them
$bigConds = $conds;
$bigConds[] = 'page_len > ' . intval( $wgMaxMsgCacheEntrySize );
# Load titles for all oversized pages in the MediaWiki namespace
$res = $dbr->select( 'page', 'page_title', $bigConds, __METHOD__ . "($code)-big" );
- while ( $row = $dbr->fetchObject( $res ) ) {
+ foreach ( $res as $row ) {
$cache[$row->page_title] = '!TOO BIG';
}
- $dbr->freeResult( $res );
# Conditions to load the remaining pages with their contents
$smallConds = $conds;
array( 'page_title', 'old_text', 'old_flags' ),
$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 );
+
+ foreach ( $mostused as $key ) {
+ if ( !isset( $cache[$key] ) ) {
+ $cache[$key] = '!NONEXISTENT';
+ }
+ }
$cache['VERSION'] = MSG_CACHE_VERSION;
wfProfileOut( __METHOD__ );
global $wgMaxMsgCacheEntrySize;
wfProfileIn( __METHOD__ );
+ if ( $this->mDisable ) {
+ return;
+ }
- list( , $code ) = $this->figureMessage( $title );
+ list( $msg, $code ) = $this->figureMessage( $title );
$cacheKey = wfMemcKey( 'messages', $code );
- $this->load($code);
- $this->lock($cacheKey);
-
- if ( is_array($this->mCache[$code]) ) {
- $titleKey = wfMemcKey( 'messages', 'individual', $title );
+ $this->load( $code );
+ $this->lock( $cacheKey );
- if ( $text === false ) {
- # Article was deleted
- unset( $this->mCache[$code][$title] );
- $this->mMemc->delete( $titleKey );
+ $titleKey = wfMemcKey( 'messages', 'individual', $title );
- } elseif ( strlen( $text ) > $wgMaxMsgCacheEntrySize ) {
- # Check for size
- $this->mCache[$code][$title] = '!TOO BIG';
- $this->mMemc->set( $titleKey, ' ' . $text, $this->mExpiry );
+ if ( $text === false ) {
+ # Article was deleted
+ $this->mCache[$code][$title] = '!NONEXISTENT';
+ $this->mMemc->delete( $titleKey );
- } else {
- $this->mCache[$code][$title] = ' ' . $text;
- $this->mMemc->delete( $titleKey );
- }
+ } elseif ( strlen( $text ) > $wgMaxMsgCacheEntrySize ) {
+ # Check for size
+ $this->mCache[$code][$title] = '!TOO BIG';
+ $this->mMemc->set( $titleKey, ' ' . $text, $this->mExpiry );
- # 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 );
}
+
+ // Update the message in the message blob store
+ global $wgContLang;
+ MessageBlobStore::updateMessage( $wgContLang->lcfirst( $msg ) );
wfRunHooks( "MessageCacheReplace", array( $title, $text ) );
* "msg/lang".
*/
function get( $key, $useDB = true, $langcode = true, $isFullKey = false ) {
- global $wgContLanguageCode, $wgContLang;
+ global $wgLanguageCode, $wgContLang;
if ( !is_string( $key ) ) {
throw new MWException( "Non-string key given" );
}
$lang = wfGetLangObj( $langcode );
- $langcode = $lang->getCode();
+ if ( !$lang ) {
+ throw new MWException( "Bad lang code $langcode given" );
+ }
+
+ // Don't change getPreferredVariant() to getCode() / mCode, for
+ // more details, see the comment in Language::getMessage().
+ $langcode = $lang->getPreferredVariant();
$message = false;
$uckey = $wgContLang->ucfirst( $lckey );
}
+ /* Record each message request, but only once per request.
+ * This information is not used unless $wgAdaptiveMessageCache
+ * is enabled. */
+ $this->mRequestedMessages[$uckey] = true;
+
# Try the MediaWiki namespace
if( !$this->mDisable && $useDB ) {
$title = $uckey;
- if(!$isFullKey && ( $langcode != $wgContLanguageCode ) ) {
+ if(!$isFullKey && ( $langcode != $wgLanguageCode ) ) {
$title .= '/' . $langcode;
}
$message = $this->getMsgFromNamespace( $title, $langcode );
# Is this a custom message? Try the default language in the db...
if( ($message === false || $message === '-' ) &&
!$this->mDisable && $useDB &&
- !$isFullKey && ($langcode != $wgContLanguageCode) ) {
- $message = $this->getMsgFromNamespace( $uckey, $wgContLanguageCode );
+ !$isFullKey && ($langcode != $wgLanguageCode) ) {
+ $message = $this->getMsgFromNamespace( $uckey, $wgLanguageCode );
}
# Final fallback
* @param $code String: code denoting the language to try.
*/
function getMsgFromNamespace( $title, $code ) {
- $type = false;
- $message = false;
+ global $wgAdaptiveMessageCache;
$this->load( $code );
- if (isset( $this->mCache[$code][$title] ) ) {
+ if ( isset( $this->mCache[$code][$title] ) ) {
$entry = $this->mCache[$code][$title];
- $type = substr( $entry, 0, 1 );
- if ( $type == ' ' ) {
+ if ( substr( $entry, 0, 1 ) === ' ' ) {
return substr( $entry, 1 );
+ } elseif ( $entry === '!NONEXISTENT' ) {
+ return false;
+ } elseif( $entry === '!TOO BIG' ) {
+ // Fall through and try invididual message cache below
+ }
+ } else {
+ // XXX: This is not cached in process cache, should it?
+ $message = false;
+ wfRunHooks('MessagesPreLoad', array( $title, &$message ) );
+ if ( $message !== false ) {
+ return $message;
}
- }
-
- # Call message hooks, in case they are defined
- wfRunHooks('MessagesPreLoad', array( $title, &$message ) );
- if ( $message !== false ) {
- return $message;
- }
- # If there is no cache entry and no placeholder, it doesn't exist
- if ( $type !== '!' ) {
- return false;
+ /* If message cache is in normal mode, it is guaranteed
+ * (except bugs) that there is always entry (or placeholder)
+ * in the cache if message exists. Thus we can do minor
+ * performance improvement and return false early.
+ */
+ if ( !$wgAdaptiveMessageCache ) {
+ return false;
+ }
}
- $titleKey = wfMemcKey( 'messages', 'individual', $title );
-
# Try the individual message cache
+ $titleKey = wfMemcKey( 'messages', 'individual', $title );
$entry = $this->mMemc->get( $titleKey );
if ( $entry ) {
- $type = substr( $entry, 0, 1 );
-
- if ( $type === ' ' ) {
- # Ok!
- $message = substr( $entry, 1 );
+ if ( substr( $entry, 0, 1 ) === ' ' ) {
$this->mCache[$code][$title] = $entry;
- return $message;
+ return substr( $entry, 1 );
} elseif ( $entry === '!NONEXISTENT' ) {
+ $this->mCache[$code][$title] = '!NONEXISTENT';
return false;
} else {
# Corrupt/obsolete entry, delete it
}
}
- # 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();
$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
+ $message = false;
+ $this->mCache[$code][$title] = '!NONEXISTENT';
$this->mMemc->set( $titleKey, '!NONEXISTENT', $this->mExpiry );
- $this->mCache[$code][$title] = false;
}
+
return $message;
}
$popts = $this->getParserOptions();
$popts->setInterfaceMessage( $interface );
$popts->setTargetLanguage( $language );
+ $popts->setUserLang( $language );
$message = $this->mParser->transformMsg( $message, $popts );
}
return $message;
function disable() { $this->mDisable = true; }
function enable() { $this->mDisable = false; }
- /** @deprecated */
- function disableTransform(){
- wfDeprecated( __METHOD__ );
- }
- function enableTransform() {
- wfDeprecated( __METHOD__ );
- }
- function setTransform( $x ) {
- wfDeprecated( __METHOD__ );
- }
- function getTransform() {
- wfDeprecated( __METHOD__ );
- return false;
- }
-
/**
* Clear all stored messages. Mainly used after a mass rebuild.
*/
# Invalidate all local caches
$this->mMemc->delete( wfMemcKey( 'messages', $code, 'hash' ) );
}
- }
-
- /**
- * Add a message to the cache
- * @deprecated Use $wgExtensionMessagesFiles
- *
- * @param $key Mixed
- * @param $value Mixed
- * @param $lang String: the messages language, English by default
- */
- function addMessage( $key, $value, $lang = 'en' ) {
- wfDeprecated( __METHOD__ );
- $lc = Language::getLocalisationCache();
- $lc->addLegacyMessages( array( $lang => array( $key => $value ) ) );
- }
-
- /**
- * Add an associative array of message to the cache
- * @deprecated Use $wgExtensionMessagesFiles
- *
- * @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__ );
- $lc = Language::getLocalisationCache();
- $lc->addLegacyMessages( array( $lang => $messages ) );
- }
-
- /**
- * Add a 2-D array of messages by lang. Useful for extensions.
- * @deprecated Use $wgExtensionMessagesFiles
- *
- * @param $messages Array: the array to be added
- */
- function addMessagesByLang( $messages ) {
- wfDeprecated( __METHOD__ );
- $lc = Language::getLocalisationCache();
- $lc->addLegacyMessages( $messages );
- }
-
- /**
- * Set a hook for addMessagesByLang()
- */
- function setExtensionMessagesHook( $callback ) {
- $this->mAddMessagesHook = $callback;
- }
-
- /**
- * @deprecated
- */
- function loadAllMessages( $lang = false ) {
- }
-
- /**
- * @deprecated
- */
- function loadMessagesFile( $filename, $langcode = false ) {
+ $this->mLoadedLanguages = array();
}
public function figureMessage( $key ) {
- global $wgContLanguageCode;
+ global $wgLanguageCode;
$pieces = explode( '/', $key );
if( count( $pieces ) < 2 )
- return array( $key, $wgContLanguageCode );
+ return array( $key, $wgLanguageCode );
$lang = array_pop( $pieces );
$validCodes = Language::getLanguageNames();
if( !array_key_exists( $lang, $validCodes ) )
- return array( $key, $wgContLanguageCode );
+ return array( $key, $wgLanguageCode );
$message = implode( '/', $pieces );
return array( $message, $lang );
}
+ public static function logMessages() {
+ global $wgAdaptiveMessageCache;
+ if ( !$wgAdaptiveMessageCache || !self::$instance instanceof MessageCache ) {
+ return;
+ }
+
+ $cachekey = wfMemckey( 'message-profiling' );
+ $cache = wfGetCache( CACHE_DB );
+ $data = $cache->get( $cachekey );
+
+ if ( !$data ) $data = array();
+
+ $age = self::$mAdaptiveDataAge;
+ $filterDate = substr( wfTimestamp( TS_MW, time()-$age ), 0, 8 );
+ foreach ( array_keys( $data ) as $key ) {
+ if ( $key < $filterDate ) unset( $data[$key] );
+ }
+
+ $index = substr( wfTimestampNow(), 0, 8 );
+ if ( !isset( $data[$index] ) ) $data[$index] = array();
+
+ foreach ( self::$instance->mRequestedMessages as $message => $_ ) {
+ if ( !isset( $data[$index][$message] ) ) $data[$index][$message] = 0;
+ $data[$index][$message]++;
+ }
+
+ $cache->set( $cachekey, $data );
+ }
+
+ public function getMostUsedMessages() {
+ $cachekey = wfMemckey( 'message-profiling' );
+ $cache = wfGetCache( CACHE_DB );
+ $data = $cache->get( $cachekey );
+ if ( !$data ) return array();
+
+ $list = array();
+
+ foreach( $data as $messages ) {
+ foreach( $messages as $message => $count ) {
+ $key = $message;
+ if ( !isset( $list[$key] ) ) $list[$key] = 0;
+ $list[$key] += $count;
+ }
+ }
+
+ $max = max( $list );
+ foreach ( $list as $message => $count ) {
+ if ( $count < intval( $max * self::$mAdaptiveInclusionThreshold ) ) {
+ unset( $list[$message] );
+ }
+ }
+
+ return array_keys( $list );
+ }
+
}
dépôts / lhc / web / wiklou.git / blobdiff