X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FMessageCache.php;h=351c65d7cbc47b5f60f237f56ab4265c1eb96be5;hb=7a7cf1a2f9468e0ac27dcd078da4a53e10cbe017;hp=18256aaab97d521f043b36dbc1318c9b6d3853ea;hpb=dfe83d198c2a39c51a194c0149f1b12097fbe431;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/MessageCache.php b/includes/MessageCache.php index 18256aaab9..351c65d7cb 100644 --- a/includes/MessageCache.php +++ b/includes/MessageCache.php @@ -1,8 +1,7 @@ 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; - - # 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; @@ -55,51 +49,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, $wgDBname; - - $this->mCache = false; - if ( $wgLocalMessageCache === false ) { - return; - } + function loadFromLocal( $hash, $code ) { + global $wgCacheDirectory, $wgLocalMessageCacheSerialized; - $filename = "$wgLocalMessageCache/messages-$wgDBname"; + $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, 1000000 ); - $this->mCache = 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, $wgDBname; - - if ( $wgLocalMessageCache === false ) { - return; - } + function saveToLocal( $serialized, $hash, $code ) { + global $wgCacheDirectory; - $filename = "$wgLocalMessageCache/messages-$wgDBname"; - $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; @@ -110,49 +121,33 @@ class MessageCache { @chmod( $filename, 0666 ); } - function loadFromScript( $hash ) { - global $wgLocalMessageCache, $wgDBname; - if ( $wgLocalMessageCache === false ) { - return; - } - - $filename = "$wgLocalMessageCache/messages-$wgDBname"; - + 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 ) { - 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 ) { + wfDebug( "Unable to open local cache file for writing\n" ); return; } - $filename = "$wgLocalMessageCache/messages-$wgDBname"; - $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"); + $key = $this->escapeForScript($key); + $messages = $this->escapeForScript($message); + fwrite($file, "'$key' => '$message',\n"); } + fwrite($file,");\n?>"); fclose($file); - rename($filename.'.tmp',$filename); + rename($tempFilename, $filename); } function escapeForScript($string) { @@ -162,241 +157,315 @@ class MessageCache { } /** - * 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 + * Set the cache to $cache, if it is valid. Otherwise set the cache to false. + */ + function setCache( $cache, $code ) { + if ( isset( $cache['VERSION'] ) && $cache['VERSION'] == MSG_CACHE_VERSION ) { + $this->mCache[$code] = $cache; + return true; + } else { + return false; + } + } + + /** + * 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 mDisabled 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 ( !$this->mUseCache ) { + return true; + } + + 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; } - $fname = 'MessageCache::load'; - wfProfileIn( $fname ); - $success = true; - if ( $this->mUseCache ) { - $this->mCache = false; + # 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 + - # Try local cache - wfProfileIn( $fname.'-fromlocal' ); - $hash = $this->mMemc->get( "{$this->mMemcKey}-hash" ); + # (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 ) { - if ($wgLocalMessageCacheSerialized) { - $this->loadFromLocal( $hash ); - } else { - $this->loadFromScript( $hash ); - } - if ( $this->mCache ) { - wfDebug( "MessageCache::load(): got from local cache\n" ); - } + $success = $this->loadFromLocal( $hash, $code ); + if ( $success ) $where[] = 'got from local cache'; } - wfProfileOut( $fname.'-fromlocal' ); - - # Try memcached - if ( !$this->mCache ) { - wfProfileIn( $fname.'-fromcache' ); - $this->mCache = $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 ); - } - } - } - wfProfileOut( $fname.'-fromcache' ); + wfProfileOut( __METHOD__ . '-fromlocal' ); + } + + # (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( __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(): loading all messages\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 ); + $this->lock($cacheKey); + + # 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 ) { - 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++ ) { - 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 ); - } - } - - 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" ); - } + $this->mMemc->delete( $statusKey ); + } else { + $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(): 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; - /* - if ( $this->mCache == "loading" ) { - $this->mUseCache = false; - } elseif ( $this->mCache == "error" ) { - $this->mUseCache = false; - $success = false; - } else { - $this->mDisable = true; - $success = false; - }*/ - $this->mCache = false; - } + 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 Optional language code, see documenation of load(). + * @return Array: Loaded messages for storing in caches. */ - function loadFromDB() { - global $wgLang; - - $fname = 'MessageCache::loadFromDB'; - $dbr =& wfGetDB( DB_SLAVE ); - if ( !$dbr ) { - throw new MWException( 'Invalid database object' ); - } - $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 + function loadFromDB( $code = false ) { + wfProfileIn( __METHOD__ ); + global $wgMaxMsgCacheEntrySize, $wgContLanguageCode; + $dbr = wfGetDB( DB_SLAVE ); + $cache = array(); + + # Common conditions + $conds = array( + 'page_is_redirect' => 0, + 'page_namespace' => NS_MEDIAWIKI, ); - $this->mCache = array(); - for ( $row = $dbr->fetchObject( $res ); $row; $row = $dbr->fetchObject( $res ) ) { - $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 - $allMessages = Language::getMessagesFor( 'en' ); - foreach ( $allMessages as $key => $value ) { - $uckey = $wgLang->ucfirst( $key ); - if ( !array_key_exists( $uckey, $this->mCache ) ) { - $this->mCache[$uckey] = false; + 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 + $escapedCode = $dbr->escapeLike( $code ); + $conds[] = "page_title like '%%/$escapedCode'"; + } else { + # Effectively disallows use of '/' character in NS_MEDIAWIKI for uses + # other than language code. + $conds[] = "page_title not like '%%/%%'"; } } - # Make sure all extension messages are available - wfLoadAllExtensions(); + # Conditions to fetch oversized pages to ignore them + $bigConds = $conds; + $bigConds[] = 'page_len > ' . intval( $wgMaxMsgCacheEntrySize ); - # Add them to the cache - foreach ( $this->mExtensionMessages as $key => $value ) { - $uckey = $wgLang->ucfirst( $key ); - if ( !array_key_exists( $uckey, $this->mCache ) && - ( isset( $this->mExtensionMessages[$key][$wgLang->getCode()] ) || isset( $this->mExtensionMessages[$key]['en'] ) ) ) { - $this->mCache[$uckey] = false; - } + # Load titles for all oversized pages in the MediaWiki namespace + $res = $dbr->select( 'page', 'page_title', $bigConds, __METHOD__ ); + while ( $row = $dbr->fetchObject( $res ) ) { + $cache[$row->page_title] = '!TOO BIG'; } + $dbr->freeResult( $res ); + + # 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' ), + $smallConds, __METHOD__ ); + + for ( $row = $dbr->fetchObject( $res ); $row; $row = $dbr->fetchObject( $res ) ) { + $cache[$row->page_title] = ' ' . Revision::getRevisionText( $row ); + } $dbr->freeResult( $res ); + + $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 => $value ) { - $title = $wgContLang->ucfirst( $key ); - array_push( $this->mKeys, $title ); + public function replace( $title, $text ) { + global $wgMaxMsgCacheEntrySize; + wfProfileIn( __METHOD__ ); + + + list( , $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 ); + + if ( $text === false ) { + # Article was deleted + unset( $this->mCache[$code][$title] ); + $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 ); } - return $this->mKeys; + $this->unlock($cacheKey); + + // Also delete cached sidebar... just in case it is affected + global $parserMemc; + $sidebarKey = wfMemcKey( 'sidebar', $code ); + $parserMemc->delete( $sidebarKey ); + + wfRunHooks( "MessageCacheReplace", array( $title, $text ) ); + + wfProfileOut( __METHOD__ ); } /** - * @deprecated + * Shortcut to update caches. + * + * @param $cache Array: cached messages with a version. + * @param $cacheKey String: Identifier for the cache. + * @param $memc Bool: Wether to update or not memcache. + * @param $code String: Language code. + * @return False on somekind of error. */ - function isCacheable( $key ) { - return true; - } + protected function saveToCaches( $cache, $memc = true, $code = false ) { + wfProfileIn( __METHOD__ ); + global $wgUseLocalMessageCache, $wgLocalMessageCacheSerialized; - function replace( $title, $text ) { - 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 ) { - $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 ); - } + $cacheKey = wfMemcKey( 'messages', $code ); + + $i = 0; + if ( $memc ) { + # Save in memcached + # Keep trying if it fails, this is kind of important + + for ($i=0; $i<20 && + !$this->mMemc->set( $cacheKey, $cache, $this->mExpiry ); + $i++ ) { + usleep(mt_rand(500000,1500000)); } + } + # 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->saveToScript( $cache, $hash, $code ); + } + } + if ( $i == 20 ) { + $success = false; + } else { + $success = true; } - $this->unlock(); + wfProfileOut( __METHOD__ ); + return $success; } /** * Returns success * Represents a write lock on the messages key */ - function lock() { + function lock($key) { if ( !$this->mUseCache ) { return true; } - $lockKey = $this->mMemcKey . 'lock'; + $lockKey = $key . ':lock'; for ($i=0; $i < MSG_WAIT_TIMEOUT && !$this->mMemc->add( $lockKey, 1, MSG_LOCK_TIMEOUT ); $i++ ) { sleep(1); } @@ -404,90 +473,85 @@ class MessageCache { return $i >= MSG_WAIT_TIMEOUT; } - function unlock() { + function unlock($key) { if ( !$this->mUseCache ) { return; } - $lockKey = $this->mMemcKey . 'lock'; + $lockKey = $key . ':lock'; $this->mMemc->delete( $lockKey ); } - function get( $key, $useDB = true, $forcontent = true, $isfullkey = false ) { - global $wgContLanguageCode, $wgContLang, $wgLang; - if( $forcontent ) { - $lang =& $wgContLang; - } else { - $lang =& $wgLang; + /** + * 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 string $langcode 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 bool $isFullKey Specifies whether $key is a two part key "msg/lang". + */ + function get( $key, $useDB = true, $langcode = true, $isFullKey = false ) { + global $wgContLanguageCode, $wgContLang; + + if ( strval( $key ) === '' ) { + # Shortcut: the empty key is always missing + return '<>'; } + + $lang = wfGetLangObj( $langcode ); $langcode = $lang->getCode(); - # If uninitialised, someone is trying to call this halfway through Setup.php - if( !$this->mInitialised ) { - return '<' . htmlspecialchars($key) . '>'; - } - # If cache initialization was deferred, start it now. - if( $this->mDeferred && !$this->mDisable && $useDB ) { - $this->load(); - } $message = false; + + # Normalise title-case input + $lckey = str_replace( ' ', '_', $key ); + $lckey[0] = strtolower( $lckey[0] ); + $uckey = ucfirst( $lckey ); + + # Try the MediaWiki namespace if( !$this->mDisable && $useDB ) { - $title = $wgContLang->ucfirst( $key ); - if(!$isfullkey && ($langcode != $wgContLanguageCode) ) { + $title = $uckey; + if(!$isFullKey && ( $langcode != $wgContLanguageCode ) ) { $title .= '/' . $langcode; } - $message = $this->getFromCache( $title ); - } - # Try the extension array - if( $message === false && array_key_exists( $key, $this->mExtensionMessages ) ) { - if ( isset( $this->mExtensionMessages[$key][$langcode] ) ) { - $message = $this->mExtensionMessages[$key][$langcode]; - } elseif ( isset( $this->mExtensionMessages[$key]['en'] ) ) { - $message = $this->mExtensionMessages[$key]['en']; - } + $message = $this->getMsgFromNamespace( $title, $langcode ); } # Try the array in the language object - if( $message === false ) { - #wfDebug( "Trying language object for message $key\n" ); - wfSuppressWarnings(); - $message = $lang->getMessage( $key ); - wfRestoreWarnings(); - if ( is_null( $message ) ) { - $message = false; - } - } - - # Try the English array - if( $message === false && $langcode != 'en' ) { - wfSuppressWarnings(); - $message = Language::getMessage( $key ); - wfRestoreWarnings(); + if ( $message === false ) { + $message = $lang->getMessage( $lckey ); if ( is_null( $message ) ) { $message = false; } } # Try the array of another language - if( $message === false && strpos( $key, '/' ) ) { - $message = explode( '/', $key ); - 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 === '-' ) && !$this->mDisable && $useDB && - !$isfullkey && ($langcode != $wgContLanguageCode) ) { - $message = $this->getFromCache( $wgContLang->ucfirst( $key ) ); + !$isFullKey && ($langcode != $wgContLanguageCode) ) { + $message = $this->getMsgFromNamespace( $uckey, $wgContLanguageCode ); } # Final fallback @@ -495,116 +559,224 @@ class MessageCache { return '<' . htmlspecialchars($key) . '>'; } - # 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", + ) ); + return $message; } - function getFromCache( $title ) { + /** + * Get a message from the MediaWiki namespace, with caching. The key must + * first be converted to two-part lang/msg form if necessary. + * + * @param $title String: Message cache key with initial uppercase letter. + * @param $code String: code denoting the language to try. + */ + function getMsgFromNamespace( $title, $code ) { + $type = false; $message = false; - # Try the cache - if( $this->mUseCache && is_array( $this->mCache ) && array_key_exists( $title, $this->mCache ) ) { - return $this->mCache[$title]; + if ( $this->mUseCache ) { + $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 ); + } + } } - # Try individual message cache + # 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; + } + + $titleKey = wfMemcKey( 'messages', 'individual', $title ); + + # Try the individual message cache if ( $this->mUseCache ) { - $message = $this->mMemc->get( $this->mMemcKey . ':' . $title ); - if ( $message == '###NONEXISTENT###' ) { - $this->mCache[$title] = false; - return false; - } elseif( !is_null( $message ) ) { - $this->mCache[$title] = $message; - return $message; - } else { - $message = false; + $entry = $this->mMemc->get( $titleKey ); + if ( $entry ) { + $type = substr( $entry, 0, 1 ); + + if ( $type === ' ' ) { + # Ok! + $message = substr( $entry, 1 ); + $this->mCache[$code][$title] = $entry; + return $message; + } elseif ( $entry === '!NONEXISTENT' ) { + return false; + } else { + # Corrupt/obsolete entry, delete it + $this->mMemc->delete( $titleKey ); + } + } } - # 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 + # Try loading it from the DB $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 ); + $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( $this->mMemcKey . ':' . $title, '###NONEXISTENT###', $this->mExpiry ); - $this->mCache[$title] = false; + $this->mMemc->set( $titleKey, '!NONEXISTENT', $this->mExpiry ); + $this->mCache[$code][$title] = false; } - 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 ); + $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; } + + /** @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. + */ + function clear() { + if( $this->mUseCache ) { + $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' ) ); + } + } + } + + /** * Add a message to the cache + * @deprecated Use $wgExtensionMessagesFiles * * @param mixed $key * @param mixed $value * @param string $lang The messages language, English by default */ function addMessage( $key, $value, $lang = 'en' ) { - $this->mExtensionMessages[$key][$lang] = $value; + 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 array $messages An associative array of key => values to be added * @param string $lang The messages language, English by default */ function addMessages( $messages, $lang = 'en' ) { - wfProfileIn( __METHOD__ ); - foreach ( $messages as $key => $value ) { - $this->addMessage( $key, $value, $lang ); - } - wfProfileOut( __METHOD__ ); + wfDeprecated( __METHOD__ ); + $lc = Language::getLocalisationCache(); + $lc->addLegacyMessages( array( $lang => $messages ) ); } /** - * Clear all stored messages. Mainly used after a mass rebuild. + * Add a 2-D array of messages by lang. Useful for extensions. + * @deprecated Use $wgExtensionMessagesFiles + * + * @param array $messages The array to be added */ - 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" ); - } + 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 ) { + } + + public function figureMessage( $key ) { + global $wgContLanguageCode; + $pieces = explode( '/', $key ); + if( count( $pieces ) < 2 ) + return array( $key, $wgContLanguageCode ); + + $lang = array_pop( $pieces ); + $validCodes = Language::getLanguageNames(); + if( !array_key_exists( $lang, $validCodes ) ) + return array( $key, $wgContLanguageCode ); + + $message = implode( '/', $pieces ); + return array( $message, $lang ); + } + } -?>