X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FMessageCache.php;h=577c812fa9f018b0f5364715d91339ef967d464e;hb=1a69f893509b8cc08c1675655e59d6fe74866f46;hp=0b5b7e681df037928884182e10dc355ecbeb8133;hpb=784e69d028c275d3ad919b77486d4c54f2f3ff9f;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/MessageCache.php b/includes/MessageCache.php index 0b5b7e681d..577c812fa9 100644 --- a/includes/MessageCache.php +++ b/includes/MessageCache.php @@ -1,53 +1,108 @@ mUseCache = !is_null( $memCached ); - $this->mMemc = &$memCached; + function __construct( $memCached, $useDB, $expiry ) { + if ( !$memCached ) { + $memCached = wfGetCache( CACHE_NONE ); + } + + $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; - - # 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( __METHOD__ ); } + /** + * ParserOptions is lazy initialised. + */ function getParserOptions() { if ( !$this->mParserOptions ) { $this->mParserOptions = new ParserOptions; @@ -56,51 +111,68 @@ class MessageCache { } /** - * Try to load the cache from a local file + * Try to load the cache from a local file. + * Actual format of the file depends on the $wgLocalMessageCacheSerialized + * setting. + * + * @param $hash String: the hash of contents, to check validity. + * @param $code Mixed: Optional language code, see documenation of load(). + * @return false on failure. */ - function loadFromLocal( $hash ) { - global $wgLocalMessageCache; + function loadFromLocal( $hash, $code ) { + global $wgCacheDirectory, $wgLocalMessageCacheSerialized; - $this->mCache = false; - if ( $wgLocalMessageCache === false ) { - return; - } - - $filename = "$wgLocalMessageCache/messages-" . wfWikiID(); + $filename = "$wgCacheDirectory/messages-" . wfWikiID() . "-$code"; + # Check file existence wfSuppressWarnings(); $file = fopen( $filename, 'r' ); wfRestoreWarnings(); if ( !$file ) { - return; + return false; // No cache file } - // 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, 10000000 ); - $this->setCache( unserialize( $serialized ) ); + if ( $wgLocalMessageCacheSerialized ) { + // 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 = ''; + while ( !feof( $file ) ) { + $serialized .= fread( $file, 100000 ); + } + fclose( $file ); + return $this->setCache( unserialize( $serialized ), $code ); + } else { + fclose( $file ); + return false; // Wrong hash + } + } else { + $localHash = substr( fread( $file, 40 ), 8 ); + fclose( $file ); + if ( $hash != $localHash ) { + return false; // Wrong hash + } + + # Require overwrites the member variable or just shadows it? + require( $filename ); + return $this->setCache( $this->mCache, $code ); } - fclose( $file ); } /** - * Save the cache to a local file + * Save the cache to a local file. */ - function saveToLocal( $serialized, $hash ) { - global $wgLocalMessageCache; - - if ( $wgLocalMessageCache === false ) { - return; - } + function saveToLocal( $serialized, $hash, $code ) { + global $wgCacheDirectory; - $filename = "$wgLocalMessageCache/messages-" . wfWikiID(); - $oldUmask = umask( 0 ); - wfMkdirParents( $wgLocalMessageCache, 0777 ); - umask( $oldUmask ); + $filename = "$wgCacheDirectory/messages-" . wfWikiID() . "-$code"; + wfMkdirParents( $wgCacheDirectory ); // might fail + wfSuppressWarnings(); $file = fopen( $filename, 'w' ); + wfRestoreWarnings(); + if ( !$file ) { wfDebug( "Unable to open local cache file for writing\n" ); return; @@ -111,53 +183,36 @@ class MessageCache { @chmod( $filename, 0666 ); } - function loadFromScript( $hash ) { - global $wgLocalMessageCache; - if ( $wgLocalMessageCache === false ) { - return; - } - - $filename = "$wgLocalMessageCache/messages-" . wfWikiID(); - + function saveToScript( $array, $hash, $code ) { + global $wgCacheDirectory; + + $filename = "$wgCacheDirectory/messages-" . wfWikiID() . "-$code"; + $tempFilename = $filename . '.tmp'; + wfMkdirParents( $wgCacheDirectory ); // might fail + wfSuppressWarnings(); - $file = fopen( $filename, 'r' ); + $file = fopen( $tempFilename, 'w' ); wfRestoreWarnings(); + if ( !$file ) { + wfDebug( "Unable to open local cache file for writing\n" ); return; } - $localHash=substr(fread($file,40),8); - fclose($file); - if ($hash!=$localHash) { - return; - } - require("$wgLocalMessageCache/messages-" . wfWikiID()); - $this->setCache( $this->mCache); - } - - function saveToScript($array, $hash) { - global $wgLocalMessageCache; - if ( $wgLocalMessageCache === false ) { - return; + + fwrite( $file, "mCache = array(" ); + + foreach ( $array as $key => $message ) { + $key = $this->escapeForScript( $key ); + $message = $this->escapeForScript( $message ); + fwrite( $file, "'$key' => '$message',\n" ); } - $filename = "$wgLocalMessageCache/messages-" . wfWikiID(); - $oldUmask = umask( 0 ); - wfMkdirParents( $wgLocalMessageCache, 0777 ); - umask( $oldUmask ); - $file = fopen( $filename.'.tmp', 'w'); - fwrite($file,"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); + fwrite( $file, ");\n?>" ); + fclose( $file); + rename( $tempFilename, $filename ); } - function escapeForScript($string) { + function escapeForScript( $string ) { $string = str_replace( '\\', '\\\\', $string ); $string = str_replace( '\'', '\\\'', $string ); return $string; @@ -166,518 +221,648 @@ class MessageCache { /** * 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 ) { - $this->mCache = $cache; + $this->mCache[$code] = $cache; + return true; } else { - $this->mCache = false; + return false; } } /** - * 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 + * Loads messages from caches or from database in this order: + * (1) local message cache (if $wgUseLocalMessageCache is enabled) + * (2) memcached + * (3) from the database. + * + * When succesfully loading from (2) or (3), all higher level caches are + * updated for the newest version. + * + * 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, + * or false if populating empty cache fails. Also returns true if MessageCache + * is disabled. + * + * @param $code String: language to which load messages */ - function load() { - global $wgLocalMessageCache, $wgLocalMessageCacheSerialized; + function load( $code = false ) { + global $wgUseLocalMessageCache; + + 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 ( isset( $this->mLoadedLanguages[$code] ) ) { + return true; + } + + # 8 lines of code just to say (once) that message cache is disabled if ( $this->mDisable ) { static $shownDisabled = false; if ( !$shownDisabled ) { - wfDebug( "MessageCache::load(): disabled\n" ); + wfDebug( __METHOD__ . ": disabled\n" ); $shownDisabled = true; } return true; } - if ( !$this->mUseCache ) { - $this->mDeferred = false; - return true; - } - - $fname = 'MessageCache::load'; - wfProfileIn( $fname ); - $success = true; - $this->mCache = false; - - # Try local cache - wfProfileIn( $fname.'-fromlocal' ); - $hash = $this->mMemc->get( "{$this->mMemcKey}-hash" ); - if ( $hash ) { - if ($wgLocalMessageCacheSerialized) { - $this->loadFromLocal( $hash ); - } else { - $this->loadFromScript( $hash ); - } - if ( $this->mCache ) { - wfDebug( "MessageCache::load(): got from local cache\n" ); + # Loading code starts + 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 ( $wgUseLocalMessageCache ) { + wfProfileIn( __METHOD__ . '-fromlocal' ); + + $hash = $this->mMemc->get( wfMemcKey( 'messages', $code, 'hash' ) ); + if ( $hash ) { + $success = $this->loadFromLocal( $hash, $code ); + if ( $success ) $where[] = 'got from local cache'; } + wfProfileOut( __METHOD__ . '-fromlocal' ); } - wfProfileOut( $fname.'-fromlocal' ); - - # Try memcached - if ( !$this->mCache ) { - wfProfileIn( $fname.'-fromcache' ); - $this->setCache( $this->mMemc->get( $this->mMemcKey ) ); - 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 ); - } - } + + # (2) memcache + # Fails if nothing in cache, or in the wrong version. + if ( !$success ) { + wfProfileIn( __METHOD__ . '-fromcache' ); + $cache = $this->mMemc->get( $cacheKey ); + $success = $this->setCache( $cache, $code ); + if ( $success ) { + $where[] = 'got from global cache'; + $this->saveToCaches( $cache, false, $code ); } - wfProfileOut( $fname.'-fromcache' ); + wfProfileOut( __METHOD__ . '-fromcache' ); } + # (3) + # Nothing in caches... so we need create one and store it in caches + if ( !$success ) { + $where[] = 'cache is empty'; + $where[] = 'loading from database'; - # If there's nothing in memcached, load all the messages from the database - if ( !$this->mCache ) { - wfDebug( "MessageCache::load(): cache is empty\n" ); - $this->lock(); - # Other threads don't need to load the messages if another thread is doing it. - $success = $this->mMemc->add( $this->mMemcKey.'-status', "loading", MSG_LOAD_TIMEOUT ); - if ( $success ) { - wfProfileIn( $fname.'-load' ); - wfDebug( "MessageCache::load(): loading all messages from DB\n" ); - $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++ ) { - 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 ); - if ($wgLocalMessageCacheSerialized) { - $this->saveToLocal( $serialized,$hash ); - } else { - $this->saveToScript( $this->mCache, $hash ); - } - } + $this->lock( $cacheKey ); - wfProfileOut( $fname.'-save' ); - if ( $i == 20 ) { - $this->mMemc->set( $this->mMemcKey.'-status', 'error', 60*5 ); - wfDebug( "MemCached set error in MessageCache: restart memcached server!\n" ); + # 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 ); + if ( $success ) { + $cache = $this->loadFromDB( $code ); + $success = $this->setCache( $cache, $code ); + } + if ( $success ) { + $success = $this->saveToCaches( $cache, true, $code ); + if ( $success ) { + $this->mMemc->delete( $statusKey ); } else { - $this->mMemc->delete( $this->mMemcKey.'-status' ); + $this->mMemc->set( $statusKey, 'error', 60 * 5 ); + wfDebug( "MemCached set error in MessageCache: restart memcached server!\n" ); } } - $this->unlock(); + $this->unlock($cacheKey); } - if ( !is_array( $this->mCache ) ) { - wfDebug( "MessageCache::load(): unable to load cache, disabled\n" ); + if ( !$success ) { + # Bad luck... this should not happen + $where[] = 'loading FAILED - cache is disabled'; + $info = implode( ', ', $where ); + wfDebug( __METHOD__ . ": Loading $code... $info\n" ); $this->mDisable = true; $this->mCache = false; + } else { + # All good, just record the success + $info = implode( ', ', $where ); + wfDebug( __METHOD__ . ": Loading $code... $info\n" ); + $this->mLoadedLanguages[$code] = true; } - wfProfileOut( $fname ); - $this->mDeferred = false; + wfProfileOut( __METHOD__ ); return $success; } /** - * Loads all or main part of cacheable messages from the database + * Loads cacheable messages from the database. Messages bigger than + * $wgMaxMsgCacheEntrySize are assigned a special value, and are loaded + * on-demand from the database later. + * + * @param $code String: language code. + * @return Array: loaded messages for storing in caches. */ - function loadFromDB() { - global $wgMaxMsgCacheEntrySize; - + function loadFromDB( $code ) { wfProfileIn( __METHOD__ ); - $dbr =& wfGetDB( DB_SLAVE ); - $this->mCache = array(); + global $wgMaxMsgCacheEntrySize, $wgLanguageCode, $wgAdaptiveMessageCache; + $dbr = wfGetDB( DB_SLAVE ); + $cache = array(); + + # Common conditions + $conds = array( + 'page_is_redirect' => 0, + 'page_namespace' => NS_MEDIAWIKI, + ); + + $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', - array( - 'page_len > ' . intval( $wgMaxMsgCacheEntrySize ), - 'page_is_redirect' => 0, - 'page_namespace' => NS_MEDIAWIKI, - ), - __METHOD__ ); - while ( $row = $dbr->fetchObject( $res ) ) { - $this->mCache[$row->page_title] = '!TOO BIG'; - } - $dbr->freeResult( $res ); - - # Load text for the remaining pages - $res = $dbr->select( array( 'page', 'revision', 'text' ), + $res = $dbr->select( 'page', 'page_title', $bigConds, __METHOD__ . "($code)-big" ); + foreach ( $res as $row ) { + $cache[$row->page_title] = '!TOO BIG'; + } + + # Conditions to load the remaining pages with their contents + $smallConds = $conds; + $smallConds[] = 'page_latest=rev_id'; + $smallConds[] = 'rev_text_id=old_id'; + $smallConds[] = 'page_len <= ' . intval( $wgMaxMsgCacheEntrySize ); + + $res = $dbr->select( + array( 'page', 'revision', 'text' ), array( 'page_title', 'old_text', 'old_flags' ), - array( - 'page_is_redirect' => 0, - 'page_namespace' => NS_MEDIAWIKI, - 'page_latest=rev_id', - 'rev_text_id=old_id', - 'page_len <= ' . intval( $wgMaxMsgCacheEntrySize ) ), - __METHOD__ ); - - for ( $row = $dbr->fetchObject( $res ); $row; $row = $dbr->fetchObject( $res ) ) { - $this->mCache[$row->page_title] = ' ' . Revision::getRevisionText( $row ); - } - $this->mCache['VERSION'] = MSG_CACHE_VERSION; - $dbr->freeResult( $res ); + $smallConds, + __METHOD__ . "($code)-small" + ); + + foreach ( $res as $row ) { + $cache[$row->page_title] = ' ' . Revision::getRevisionText( $row ); + } + + foreach ( $mostused as $key ) { + if ( !isset( $cache[$key] ) ) { + $cache[$key] = '!NONEXISTENT'; + } + } + + $cache['VERSION'] = MSG_CACHE_VERSION; wfProfileOut( __METHOD__ ); + return $cache; } /** - * Not really needed anymore + * Updates cache as necessary when message page is changed + * + * @param $title String: name of the page changed. + * @param $text Mixed: new contents of the page. */ - function getKeys() { - global $wgContLang; - if ( !$this->mKeys ) { - $this->mKeys = array(); - $allMessages = Language::getMessagesFor( 'en' ); - foreach ( $allMessages as $key => $unused ) { - $title = $wgContLang->ucfirst( $key ); - array_push( $this->mKeys, $title ); - } + public function replace( $title, $text ) { + global $wgMaxMsgCacheEntrySize; + wfProfileIn( __METHOD__ ); + + if ( $this->mDisable ) { + return; } - return $this->mKeys; - } - function replace( $title, $text ) { - global $wgLocalMessageCache, $wgLocalMessageCacheSerialized, $parserMemc; - global $wgMaxMsgCacheEntrySize; + list( $msg, $code ) = $this->figureMessage( $title ); + + $cacheKey = wfMemcKey( 'messages', $code ); + $this->load( $code ); + $this->lock( $cacheKey ); + $titleKey = wfMemcKey( 'messages', 'individual', $title ); + + 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 ); + } else { + $this->mCache[$code][$title] = ' ' . $text; + $this->mMemc->delete( $titleKey ); + } + + # Update caches + $this->saveToCaches( $this->mCache[$code], true, $code ); + $this->unlock( $cacheKey ); + + // Also delete cached sidebar... just in case it is affected + $codes = array( $code ); + if ( $code === 'en' ) { + // Delete all sidebars, like for example on action=purge on the + // sidebar messages + $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 ) ); + + wfProfileOut( __METHOD__ ); + } + + /** + * Shortcut to update caches. + * + * @param $cache Array: cached messages with a version. + * @param $memc Bool: Wether to update or not memcache. + * @param $code String: Language code. + * @return False on somekind of error. + */ + protected function saveToCaches( $cache, $memc = true, $code = false ) { wfProfileIn( __METHOD__ ); - $this->lock(); - $this->load(); - $parserMemc->delete(wfMemcKey('sidebar')); - if ( is_array( $this->mCache ) ) { - if ( $text === false ) { - # Article was deleted - unset( $this->mCache[$title] ); - $this->mMemc->delete( "$this->mMemcKey:{$title}" ); - } elseif ( strlen( $text ) > $wgMaxMsgCacheEntrySize ) { - $this->mCache[$title] = '!TOO BIG'; - $this->mMemc->set( "$this->mMemcKey:{$title}", ' '.$text, $this->mExpiry ); + global $wgUseLocalMessageCache, $wgLocalMessageCacheSerialized; + + $cacheKey = wfMemcKey( 'messages', $code ); + + if ( $memc ) { + $success = $this->mMemc->set( $cacheKey, $cache, $this->mExpiry ); + } else { + $success = true; + } + + # Save to local cache + if ( $wgUseLocalMessageCache ) { + $serialized = serialize( $cache ); + $hash = md5( $serialized ); + $this->mMemc->set( wfMemcKey( 'messages', $code, 'hash' ), $hash, $this->mExpiry ); + if ($wgLocalMessageCacheSerialized) { + $this->saveToLocal( $serialized, $hash, $code ); } else { - $this->mCache[$title] = ' ' . $text; - $this->mMemc->delete( "$this->mMemcKey:{$title}" ); - } - $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 ); - if ($wgLocalMessageCacheSerialized) { - $this->saveToLocal( $serialized,$hash ); - } else { - $this->saveToScript( $this->mCache, $hash ); - } + $this->saveToScript( $cache, $hash, $code ); } } - $this->unlock(); + wfProfileOut( __METHOD__ ); + return $success; } /** - * Returns success * Represents a write lock on the messages key + * + * @return Boolean: success */ - function lock() { - if ( !$this->mUseCache ) { - return true; - } - - $lockKey = $this->mMemcKey . 'lock'; - for ($i=0; $i < MSG_WAIT_TIMEOUT && !$this->mMemc->add( $lockKey, 1, MSG_LOCK_TIMEOUT ); $i++ ) { - sleep(1); + function lock( $key ) { + $lockKey = $key . ':lock'; + for ( $i = 0; $i < MSG_WAIT_TIMEOUT && !$this->mMemc->add( $lockKey, 1, MSG_LOCK_TIMEOUT ); $i++ ) { + sleep( 1 ); } return $i >= MSG_WAIT_TIMEOUT; } - function unlock() { - if ( !$this->mUseCache ) { - return; - } - - $lockKey = $this->mMemcKey . 'lock'; + function unlock( $key ) { + $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 bool $forContent Get the message from the content language rather than the - * user language - * @param bool $isFullKey Specifies whether $key is a two part key "lang/msg". + * @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, $forContent = true, $isFullKey = false ) { - global $wgContLanguageCode, $wgContLang, $wgLang; - if( $forContent ) { - $lang =& $wgContLang; - } else { - $lang =& $wgLang; + function get( $key, $useDB = true, $langcode = true, $isFullKey = false ) { + global $wgLanguageCode, $wgContLang; + + if ( !is_string( $key ) ) { + throw new MWException( 'Non-string key given' ); } - $langcode = $lang->getCode(); - # If uninitialised, someone is trying to call this halfway through Setup.php - if( !$this->mInitialised ) { - return '<' . htmlspecialchars($key) . '>'; + + if ( strval( $key ) === '' ) { + # Shortcut: the empty key is always missing + return false; } - # If cache initialization was deferred, start it now. - if( $this->mDeferred && !$this->mDisable && $useDB ) { - $this->load(); + + $lang = wfGetLangObj( $langcode ); + 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; - # Normalise title-case input - $lckey = $wgContLang->lcfirst( $key ); - $lckey = str_replace( ' ', '_', $lckey ); + # Normalise title-case input (with some inlining) + $lckey = str_replace( ' ', '_', $key ); + if ( ord( $key ) < 128 ) { + $lckey[0] = strtolower( $lckey[0] ); + $uckey = ucfirst( $lckey ); + } else { + $lckey = $wgContLang->lcfirst( $lckey ); + $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 = $wgContLang->ucfirst( $lckey ); - if(!$isFullKey && ($langcode != $wgContLanguageCode) ) { + $title = $uckey; + if( !$isFullKey && ( $langcode != $wgLanguageCode ) ) { $title .= '/' . $langcode; } - $message = $this->getMsgFromNamespace( $title ); - } - # Try the extension array - if( $message === false && isset( $this->mExtensionMessages[$langcode][$lckey] ) ) { - $message = $this->mExtensionMessages[$langcode][$lckey]; - } - if ( $message === false && isset( $this->mExtensionMessages['en'][$lckey] ) ) { - $message = $this->mExtensionMessages['en'][$lckey]; + $message = $this->getMsgFromNamespace( $title, $langcode ); } # Try the array in the language object - if( $message === false ) { - #wfDebug( "Trying language object for message $key\n" ); - wfSuppressWarnings(); + if ( $message === false ) { $message = $lang->getMessage( $lckey ); - wfRestoreWarnings(); if ( is_null( $message ) ) { $message = false; } } # Try the array of another language - if( $message === false && strpos( $lckey, '/' ) ) { - $message = explode( '/', $lckey ); - if ( $message[1] ) { - wfSuppressWarnings(); - $message = Language::getMessageFor( $message[0], $message[1] ); - wfRestoreWarnings(); + if( $message === false ) { + $parts = explode( '/', $lckey ); + # We may get calls for things that are http-urls from sidebar + # Let's not load nonexistent languages for those + # They usually have more than one slash. + if ( count( $parts ) == 2 && $parts[1] !== '' ) { + $message = Language::getMessageFor( $parts[0], $parts[1] ); if ( is_null( $message ) ) { $message = false; } - } else { - $message = false; } } # Is this a custom message? Try the default language in the db... - if( ($message === false || $message === '-' ) && + if( ( $message === false || $message === '-' ) && !$this->mDisable && $useDB && - !$isFullKey && ($langcode != $wgContLanguageCode) ) { - $message = $this->getMsgFromNamespace( $wgContLang->ucfirst( $lckey ) ); + !$isFullKey && ( $langcode != $wgLanguageCode ) ) { + $message = $this->getMsgFromNamespace( $uckey, $wgLanguageCode ); } # Final fallback if( $message === false ) { - return '<' . htmlspecialchars($key) . '>'; + return false; } - # Replace brace tags - $message = $this->transform( $message ); + # Fix whitespace + $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; } /** - * Get a message from the MediaWiki namespace, with caching. The key must + * Get a message from the MediaWiki namespace, with caching. The key must * first be converted to two-part lang/msg form if necessary. * - * @param string $title Message cache key with initial uppercase letter + * @param $title String: Message cache key with initial uppercase letter. + * @param $code String: code denoting the language to try. */ - function getMsgFromNamespace( $title ) { - $message = false; - $type = false; + function getMsgFromNamespace( $title, $code ) { + global $wgAdaptiveMessageCache; - # Try the cache - if( $this->mUseCache && isset( $this->mCache[$title] ) ) { - $entry = $this->mCache[$title]; - $type = substr( $entry, 0, 1 ); - if ( $type == ' ' ) { + $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; + } 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 != '!' && $message === false ) { - 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; + } } - $memcKey = $this->mMemcKey . ':' . $title; - # Try the individual message cache - if ( $this->mUseCache ) { - $entry = $this->mMemc->get( $memcKey ); - if ( $entry ) { - $type = substr( $entry, 0, 1 ); - - if ( $type == ' ' ) { - $message = substr( $entry, 1 ); - $this->mCache[$title] = $message; - return $message; - } elseif ( $entry == '!NONEXISTENT' ) { - return false; - } else { - # Corrupt/obsolete entry, delete it - $this->mMemc->delete( $memcKey ); - } - + $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[$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; + $message = false; + $this->mCache[$code][$title] = '!NONEXISTENT'; + $this->mMemc->set( $titleKey, '!NONEXISTENT', $this->mExpiry ); } return $message; } - function transform( $message ) { - global $wgParser; + function transform( $message, $interface = false, $language = null ) { + // Avoid creating parser if nothing to transform + if( strpos( $message, '{{' ) === false ) { + return $message; + } + + global $wgParser, $wgParserConf; 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->getParserOptions() ); + $class = $wgParserConf['class']; + if ( $class == 'Parser_DiffTest' ) { + # Uncloneable + $this->mParser = new $class( $wgParserConf ); + } else { + $this->mParser = clone $wgParser; } + #wfDebug( __METHOD__ . ": following contents triggered transform: $message\n" ); + } + if ( $this->mParser ) { + $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; } - function disableTransform() { $this->mDisableTransform = true; } - function enableTransform() { $this->mDisableTransform = false; } - function setTransform( $x ) { $this->mDisableTransform = $x; } - function getTransform() { return $this->mDisableTransform; } + function disable() { + $this->mDisable = true; + } - /** - * 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, $lang = 'en' ) { - $this->mExtensionMessages[$lang][$key] = $value; + function enable() { + $this->mDisable = false; } /** - * 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 + * Clear all stored messages. Mainly used after a mass rebuild. */ - function addMessages( $messages, $lang = 'en' ) { - wfProfileIn( __METHOD__ ); - if ( isset( $this->mExtensionMessages[$lang] ) ) { - $this->mExtensionMessages[$lang] = $messages + $this->mExtensionMessages[$lang]; - } else { - $this->mExtensionMessages[$lang] = $messages; + function clear() { + $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' ) ); } - wfProfileOut( __METHOD__ ); + $this->mLoadedLanguages = array(); } - /** - * Add a 2-D array of messages by lang. Useful for extensions. - * Introduced in 1.9. Please do not use it for now, for backwards compatibility. - * - * @param array $messages The array to be added - */ - function addMessagesByLang( $messages ) { - wfProfileIn( __METHOD__ ); - foreach ( $messages as $key => $value ) { - $this->addMessages( $value, $key ); + public function figureMessage( $key ) { + global $wgLanguageCode; + $pieces = explode( '/', $key ); + if( count( $pieces ) < 2 ) { + return array( $key, $wgLanguageCode ); } - wfProfileOut( __METHOD__ ); + + $lang = array_pop( $pieces ); + $validCodes = Language::getLanguageNames(); + if( !array_key_exists( $lang, $validCodes ) ) { + return array( $key, $wgLanguageCode ); + } + + $message = implode( '/', $pieces ); + return array( $message, $lang ); } - /** - * Get the extension messages for a specific language - * - * @param string $lang The messages language, English by default - */ - function getExtensionMessagesFor( $lang = 'en' ) { - wfProfileIn( __METHOD__ ); - $messages = array(); - if ( isset( $this->mExtensionMessages[$lang] ) ) { - $messages = $this->mExtensionMessages[$lang]; + public static function logMessages() { + global $wgAdaptiveMessageCache; + if ( !$wgAdaptiveMessageCache || !self::$instance instanceof MessageCache ) { + return; } - if ( $lang != 'en' ) { - $messages = $messages + $this->mExtensionMessages['en']; + + $cachekey = wfMemckey( 'message-profiling' ); + $cache = wfGetCache( CACHE_DB ); + $data = $cache->get( $cachekey ); + + if ( !$data ) { + $data = array(); } - wfProfileOut( __METHOD__ ); - return $messages; - } - /** - * 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" ); + $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 ); } - static function loadAllMessages() { - # Some extensions will load their messages when you load their class file - wfLoadAllExtensions(); - # Others will respond to this hook - wfRunHooks( 'LoadAllMessages' ); - # Still others will respond to neither, they are EVIL. We sometimes need to know! + 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 ); } + } -?>