X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FMessageCache.php;h=a754e03f852c0e1ab250d3bd19b61663b54b21f9;hb=5516fef269e71b5962afa34bd7e7403b13b57d12;hp=7ecec4f98d00c9d636bcf07460bb2fb0350e8f8c;hpb=79d5225c0e864482269e2315f47b899697681e52;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/MessageCache.php b/includes/MessageCache.php index 7ecec4f98d..a754e03f85 100644 --- a/includes/MessageCache.php +++ b/includes/MessageCache.php @@ -1,7 +1,7 @@ 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. + * Access should probably be protected. + */ function getParserOptions() { if ( !$this->mParserOptions ) { $this->mParserOptions = new ParserOptions; @@ -55,22 +53,26 @@ 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 ) { + function loadFromLocal( $hash, $code ) { global $wgLocalMessageCache, $wgLocalMessageCacheSerialized; - if ( $wgLocalMessageCache === false ) { - return; - } - $filename = "$wgLocalMessageCache/messages-" . wfWikiID(); + if ( $code ) $filename .= '-' . $code; + # Check file existence wfSuppressWarnings(); $file = fopen( $filename, 'r' ); wfRestoreWarnings(); if ( !$file ) { - return; + return false; // No cache file } if ( $wgLocalMessageCacheSerialized ) { @@ -82,35 +84,35 @@ class MessageCache { while ( !feof( $file ) ) { $serialized .= fread( $file, 100000 ); } - $this->setCache( unserialize( $serialized ) ); + fclose( $file ); + return $this->setCache( unserialize( $serialized ) ); + } else { + fclose( $file ); + return false; // Wrong hash } - fclose( $file ); } else { $localHash=substr(fread($file,40),8); fclose($file); if ($hash!=$localHash) { - return; + return false; // Wrong hash } - require("$wgLocalMessageCache/messages-" . wfWikiID()); - $this->setCache( $this->mCache); + require( $filename ); + return $this->setCache( $this->mCache ); } } /** * Save the cache to a local file */ - function saveToLocal( $serialized, $hash ) { - global $wgLocalMessageCache, $wgLocalMessageCacheSerialized; - - if ( $wgLocalMessageCache === false ) { - return; - } + function saveToLocal( $serialized, $hash, $code ) { + global $wgLocalMessageCache; $filename = "$wgLocalMessageCache/messages-" . wfWikiID(); - $oldUmask = umask( 0 ); - wfMkdirParents( $wgLocalMessageCache, 0777 ); - umask( $oldUmask ); + if ( $code ) $filename .= '-' . $code; + + # Make sure the directories exist + $this->createCacheDir( $wgLocalMessageCache ); $file = fopen( $filename, 'w' ); if ( !$file ) { @@ -123,32 +125,39 @@ class MessageCache { @chmod( $filename, 0666 ); } - function loadFromScript( $hash ) { - wfDeprecated( __METHOD__ ); - $this->loadFromLocal( $hash ); - } - - function saveToScript($array, $hash) { + function saveToScript( $array, $hash, $code ) { global $wgLocalMessageCache; - if ( $wgLocalMessageCache === false ) { - return; - } $filename = "$wgLocalMessageCache/messages-" . wfWikiID(); - $oldUmask = umask( 0 ); - wfMkdirParents( $wgLocalMessageCache, 0777 ); - umask( $oldUmask ); - $file = fopen( $filename.'.tmp', 'w'); + if ( $code ) $filename .= '-' . $code; + $tempFilename = $filename . '.tmp'; + + # Make sure the directories exist + $this->createCacheDir( $wgLocalMessageCache ); + + $file = fopen( $tempFilename, '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); + } + + /** + * Creates directory with correct permissions. + * + * @param $path String: path that is created if it does not exist. + */ + protected function createCacheDir( $path ) { + $oldUmask = umask( 0 ); + wfMkdirParents( $path, 0777 ); + umask( $oldUmask ); } function escapeForScript($string) { @@ -162,236 +171,320 @@ class MessageCache { */ function setCache( $cache ) { if ( isset( $cache['VERSION'] ) && $cache['VERSION'] == MSG_CACHE_VERSION ) { - $this->mCache = $cache; + if ( $this->mCache ) { + $this->mCache = $cache + $this->mCache; + } else { + $this->mCache = $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 $wgLocalMessageCache 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 Mixed: if evaluates to false, messages for all languages is + * loaded and stored in cache as one object. If code is provided + * and $wgPerLanguageCaching is true, messages are loaded per + * language and stored individually in caches 1 to 2. */ - function load() { - global $wgLocalMessageCache, $wgLocalMessageCacheSerialized; + function load( $code = false ) { + global $wgLocalMessageCache, $wgPerLanguageCaching; + + if ( !$this->mUseCache ) { + return true; + } + + # Keep track of loaded messages. Either array of loaded codes as keys, + # or just true if all languages are loaded. + static $loaded = false; + + if ( !$wgPerLanguageCaching ) { + // Disable language separation for normal use case + $code = false; + } elseif( !is_string( $code ) ) { + # This isn't really nice, so at least make a note about it + wfDebug( __METHOD__ . " called without providing a language code\n" ); + } + # Don't do double loading... + if ( $loaded === true || ($code && isset($loaded[$code])) ) return true; + + # Adjust cache key if we are handling only single language + $cacheKey = wfMemcKeyLang( $this->mMemcKey, $code ); + + # 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; + # Loading code starts + wfProfileIn( __METHOD__ ); + $success = false; # Keep track of success + $where = array(); # Debug info, delayed to avoid spamming debug log too much - # Try local cache + # (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 ( $wgLocalMessageCache !== false ) { - wfProfileIn( $fname.'-fromlocal' ); - $hash = $this->mMemc->get( "{$this->mMemcKey}-hash" ); + wfProfileIn( __METHOD__ . '-fromlocal' ); + $hash = $this->mMemc->get( "$cacheKey-hash" ); if ( $hash ) { - $this->loadFromLocal( $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' ); + wfProfileOut( __METHOD__ . '-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 ); + if ( $success ) { + $where[] = 'got from global cache'; + $this->saveToCaches( $cache, $cacheKey, false ); } - wfProfileOut( $fname.'-fromcache' ); - } - - - # 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 ); + wfProfileOut( __METHOD__ . '-fromcache' ); + } + + + # (3) + # Nothing in caches... so we need create one and store it in caches + if ( !$success ) { + $where[] = 'cache is empty'; + $this->lock($cacheKey); + wfProfileIn( __METHOD__ . '-load' ); + $where[] = 'loading from database'; + # We want to store messages of particular language here, not everything + # from mCache. + $cache = $this->loadFromDB( $code ); + $success = $this->setCache( $cache ); + wfProfileOut( __METHOD__ . '-load' ); 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 ); - } - } - - 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" ); - } else { - $this->mMemc->delete( $this->mMemcKey.'-status' ); - } + $this->saveToCaches( $cache, $cacheKey ); } - $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" ); + if ( $code ) { + $loaded[$code] = true; + } else { + $loaded = 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 $wgMaxMsgCacheEntrySize; - + function loadFromDB( $code = false ) { wfProfileIn( __METHOD__ ); + global $wgMaxMsgCacheEntrySize, $wgContLanguageCode; $dbr = wfGetDB( DB_SLAVE ); - $this->mCache = array(); + $cache = array(); + + # Common conditions + $conds = array( + 'page_is_redirect' => 0, + 'page_namespace' => NS_MEDIAWIKI, + ); + + if ( $code ) { + # Should $code be escaped? + # 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 like '%%/$code'"; + } else { + # Effectively disallows use of '/' character in NS_MEDIAWIKI for uses + # other than language code. + $conds[] = "page_title not like '%%/%%'"; + } + } + + # 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__ ); + $res = $dbr->select( 'page', 'page_title', $bigConds, __METHOD__ ); while ( $row = $dbr->fetchObject( $res ) ) { - $this->mCache[$row->page_title] = '!TOO BIG'; + $cache[$row->page_title] = '!TOO BIG'; } $dbr->freeResult( $res ); - # Load text for the remaining pages + # 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__ ); + $smallConds, __METHOD__ ); for ( $row = $dbr->fetchObject( $res ); $row; $row = $dbr->fetchObject( $res ) ) { - $this->mCache[$row->page_title] = ' ' . Revision::getRevisionText( $row ); + $cache[$row->page_title] = ' ' . Revision::getRevisionText( $row ); } - $this->mCache['VERSION'] = MSG_CACHE_VERSION; $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 => $unused ) { - $title = $wgContLang->ucfirst( $key ); - array_push( $this->mKeys, $title ); - } - } - return $this->mKeys; - } + public function replace( $title, $text ) { + global $wgMaxMsgCacheEntrySize, $wgPerLanguageCaching; + + list( $message, $code ) = $this->figureMessage( $title ); + + # TODO: Should we define the sidebar key name somewhere? + $sidebarKey = wfMemcKeyLang( 'sidebar' , $code ); - function replace( $title, $text ) { - global $wgLocalMessageCache, $wgLocalMessageCacheSerialized, $parserMemc; - global $wgMaxMsgCacheEntrySize; + # Load only messages for affected language, if possible + if ( !$wgPerLanguageCaching ) $code = false; + $cacheKey = wfMemcKeyLang( $this->mMemcKey, $code ); wfProfileIn( __METHOD__ ); - $this->lock(); - $this->load(); - if ( is_array( $this->mCache ) ) { + $this->lock($cacheKey); + + $cache = $this->mMemc->get( $cacheKey ); + if ( is_array( $cache ) ) { 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'; + $cache[$title] = $this->mCache[$title] = '!TOO BIG'; $this->mMemc->set( "$this->mMemcKey:{$title}", ' '.$text, $this->mExpiry ); } else { - $this->mCache[$title] = ' ' . $text; + $cache[$title] = $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 ); - } + + # Update per-request cache + $success = $this->setCache( $cache, $cacheKey ); + if ( $success ) { + # And then all caches + $this->saveToCaches( $cache, $cacheKey ); } } - $this->unlock(); - $parserMemc->delete(wfMemcKey('sidebar')); + $this->unlock($cacheKey); + + // Also delete cached sidebar... just in case it is affected + global $parserMemc; + $parserMemc->delete( $sidebarKey ); wfProfileOut( __METHOD__ ); } + /** + * 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. + * @return False on somekind of error. + */ + protected function saveToCaches( $cache, $cacheKey, $memc = true ) { + wfProfileIn( __METHOD__ ); + global $wgLocalMessageCache, $wgLocalMessageCacheSerialized; + + $success = $this->mMemc->add( $cacheKey.'-status', "loading", MSG_LOAD_TIMEOUT ); + if ( !$success ) return true; # Other process should be updating them now + + $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 ( $wgLocalMessageCache !== false ) { + $serialized = serialize( $cache ); + $hash = md5( $serialized ); + $this->mMemc->set( "$cacheKey-hash", $hash, $this->mExpiry ); + if ($wgLocalMessageCacheSerialized) { + $this->saveToLocal( $serialized, $hash, $code ); + } else { + $this->saveToScript( $cache, $hash, $code ); + } + } + + if ( $i == 20 ) { + $this->mMemc->set( $cacheKey.'-status', 'error', 60*5 ); + wfDebug( "MemCached set error in MessageCache: restart memcached server!\n" ); + $success = false; + } else { + $this->mMemc->delete( $cacheKey.'-status' ); + $success = true; + } + 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); } @@ -399,12 +492,12 @@ 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 ); } @@ -413,26 +506,47 @@ class MessageCache { * * @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 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 "lang/msg". */ - function get( $key, $useDB = true, $forContent = true, $isFullKey = false ) { + function get( $key, $useDB = true, $langcode = true, $isFullKey = false ) { global $wgContLanguageCode, $wgContLang, $wgLang; - if( $forContent ) { + + # Identify which language to get or create a language object for. + if( $langcode === $wgContLang->getCode() || $langcode === true ) { + # $langcode is the language code of the wikis content language object. + # or it is a boolean and value is true $lang =& $wgContLang; - } else { + } elseif( $langcode === $wgLang->getCode() || $langcode === false ) { + # $langcode is the language code of user language object. + # or it was a boolean and value is false $lang =& $wgLang; + } else { + $validCodes = array_keys( Language::getLanguageNames() ); + if( in_array( $langcode, $validCodes ) ) { + # $langcode corresponds to a valid language. + $lang = Language::factory( $langcode ); + } else { + # $langcode is a string, but not a valid language code; use content language. + $lang =& $wgContLang; + wfDebug( 'Invalid language code passed to MessageCache::get, falling back to content language.' ); + } } + $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; @@ -446,10 +560,11 @@ class MessageCache { if(!$isFullKey && ($langcode != $wgContLanguageCode) ) { $title .= '/' . $langcode; } - $message = $this->getMsgFromNamespace( $title ); + $message = $this->getMsgFromNamespace( $title, $langcode ); } + # Try the extension array - if( $message === false && isset( $this->mExtensionMessages[$langcode][$lckey] ) ) { + if ( $message === false && isset( $this->mExtensionMessages[$langcode][$lckey] ) ) { $message = $this->mExtensionMessages[$langcode][$lckey]; } if ( $message === false && isset( $this->mExtensionMessages['en'][$lckey] ) ) { @@ -457,11 +572,8 @@ class MessageCache { } # 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; } @@ -489,7 +601,7 @@ class MessageCache { if( ($message === false || $message === '-' ) && !$this->mDisable && $useDB && !$isFullKey && ($langcode != $wgContLanguageCode) ) { - $message = $this->getMsgFromNamespace( $wgContLang->ucfirst( $lckey ) ); + $message = $this->getMsgFromNamespace( $wgContLang->ucfirst( $lckey ), $wgContLanguageCode ); } # Final fallback @@ -503,18 +615,25 @@ class MessageCache { * 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 ) { + function getMsgFromNamespace( $title, $code ) { $message = false; $type = false; - # Try the cache - if( $this->mUseCache && isset( $this->mCache[$title] ) ) { - $entry = $this->mCache[$title]; - $type = substr( $entry, 0, 1 ); - if ( $type == ' ' ) { - return substr( $entry, 1 ); + if ( $this->mUseCache ) { + if ( !isset($this->mCache[$title]) ) { + # Delay loading as far as possible, and only load messages for requested + # language. + $this->load( $code ); + } + if (isset( $this->mCache[$title] ) ) { + $entry = $this->mCache[$title]; + $type = substr( $entry, 0, 1 ); + if ( $type == ' ' ) { + return substr( $entry, 1 ); + } } } @@ -538,6 +657,7 @@ class MessageCache { $type = substr( $entry, 0, 1 ); if ( $type == ' ' ) { + # Ok! $message = substr( $entry, 1 ); $this->mCache[$title] = $entry; return $message; @@ -565,7 +685,6 @@ class MessageCache { $this->mMemc->set( $memcKey, '!NONEXISTENT', $this->mExpiry ); $this->mCache[$title] = false; } - return $message; } @@ -589,7 +708,7 @@ class MessageCache { function disable() { $this->mDisable = true; } function enable() { $this->mDisable = false; } - + /** @deprecated */ function disableTransform(){ wfDeprecated( __METHOD__ ); @@ -693,39 +812,37 @@ class MessageCache { wfRunHooks( 'LoadAllMessages' ); # Some register their messages in $wgExtensionMessagesFiles foreach ( $wgExtensionMessagesFiles as $name => $file ) { - if ( $file ) { - $this->loadMessagesFile( $file ); - $wgExtensionMessagesFiles[$name] = false; - } + wfLoadExtensionMessages( $name ); } # Still others will respond to neither, they are EVIL. We sometimes need to know! } /** * Load messages from a given file + * + * @param string $filename Filename of file to load. + * @param string $langcode Language to load messages for, or false for + * default behvaiour (en, content language and user + * language). */ - function loadMessagesFile( $filename ) { + function loadMessagesFile( $filename, $langcode = false ) { global $wgLang, $wgContLang; $messages = $magicWords = false; require( $filename ); - /* - * Load only languages that are usually used, and merge all fallbacks, - * except English. - */ - $langs = array_unique( array( 'en', $wgContLang->getCode(), $wgLang->getCode() ) ); - foreach( $langs as $code ) { - $fbcode = $code; - $mergedMessages = array(); - do { - if ( isset($messages[$fbcode]) ) { - $mergedMessages += $messages[$fbcode]; - } - $fbcode = Language::getFallbackfor( $fbcode ); - } while( $fbcode && $fbcode !== 'en' ); - - if ( !empty($mergedMessages) ) - $this->addMessages( $mergedMessages, $code ); + $validCodes = Language::getLanguageNames(); + if( is_string( $langcode ) && array_key_exists( $langcode, $validCodes ) ) { + # Load messages for given language code. + $this->processMessagesArray( $messages, $langcode ); + } elseif( is_string( $langcode ) && !array_key_exists( $langcode, $validCodes ) ) { + wfDebug( "Invalid language '$langcode' code passed to MessageCache::loadMessagesFile()" ); + } else { + # Load only languages that are usually used, and merge all + # fallbacks, except English. + $langs = array_unique( array( 'en', $wgContLang->getCode(), $wgLang->getCode() ) ); + foreach( $langs as $code ) { + $this->processMessagesArray( $messages, $code ); + } } if ( $magicWords !== false ) { @@ -733,4 +850,36 @@ class MessageCache { $wgContLang->addMagicWordsByLang( $magicWords ); } } + + /** + * Process an array of messages, loading it into the message cache. + * + * @param array $messages Messages array. + * @param string $langcode Language code to process. + */ + function processMessagesArray( $messages, $langcode ) { + $fallbackCode = $langcode; + $mergedMessages = array(); + do { + if ( isset($messages[$fallbackCode]) ) { + $mergedMessages += $messages[$fallbackCode]; + } + $fallbackCode = Language::getFallbackfor( $fallbackCode ); + } while( $fallbackCode && $fallbackCode !== 'en' ); + + if ( !empty($mergedMessages) ) + $this->addMessages( $mergedMessages, $langcode ); + } + + public function figureMessage( $key ) { + global $wgContLanguageCode; + $pieces = explode('/', $key, 2); + + $key = $pieces[0]; + + # Language the user is translating to + $langCode = isset($pieces[1]) ? $pieces[1] : $wgContLanguageCode; + return array( $key, $langCode ); + } + }