Use formatNum for counts on category page.
[lhc/web/wiklou.git] / includes / MessageCache.php
index fd79790..99fc2f5 100644 (file)
@@ -1,8 +1,7 @@
 <?php
 /**
  *
- * @package MediaWiki
- * @subpackage Cache
+ * @addtogroup Cache
  */
 
 /**
@@ -17,7 +16,6 @@ define( 'MSG_CACHE_VERSION', 1 );
  * Message cache
  * Performs various MediaWiki namespace-related functions
  *
- * @package MediaWiki
  */
 class MessageCache {
        var $mCache, $mUseCache, $mDisable, $mExpiry;
@@ -25,6 +23,7 @@ class MessageCache {
        var $mExtensionMessages = array();
        var $mInitialised = false;
        var $mDeferred = true;
+       var $mAllMessagesLoaded;
 
        function __construct( &$memCached, $useDB, $expiry, $memcPrefix) {
                wfProfileIn( __METHOD__ );
@@ -59,9 +58,8 @@ class MessageCache {
         * Try to load the cache from a local file
         */
        function loadFromLocal( $hash ) {
-               global $wgLocalMessageCache;
+               global $wgLocalMessageCache, $wgLocalMessageCacheSerialized;
 
-               $this->mCache = false;
                if ( $wgLocalMessageCache === false ) {
                        return;
                }
@@ -75,21 +73,35 @@ class MessageCache {
                        return;
                }
 
-               // Check to see if the file has the hash specified
-               $localHash = fread( $file, 32 );
-               if ( $hash == $localHash ) {
-                       // All good, get the rest of it
-                       $serialized = fread( $file, 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 );
+                               }
+                               $this->setCache( unserialize( $serialized ) );
+                       }
+                       fclose( $file );
+               } else {
+                       $localHash=substr(fread($file,40),8);
+                       fclose($file);
+                       if ($hash!=$localHash) {
+                               return;
+                       }
+
+                       require("$wgLocalMessageCache/messages-" . wfWikiID());
+                       $this->setCache( $this->mCache);
                }
-               fclose( $file );
        }
 
        /**
         * Save the cache to a local file
         */
        function saveToLocal( $serialized, $hash ) {
-               global $wgLocalMessageCache;
+               global $wgLocalMessageCache, $wgLocalMessageCacheSerialized;
 
                if ( $wgLocalMessageCache === false ) {
                        return;
@@ -112,26 +124,8 @@ class MessageCache {
        }
 
        function loadFromScript( $hash ) {
-               global $wgLocalMessageCache;
-               if ( $wgLocalMessageCache === false ) {
-                       return;
-               }
-               
-               $filename = "$wgLocalMessageCache/messages-" . wfWikiID();
-               
-               wfSuppressWarnings();
-               $file = fopen( $filename, 'r' );
-               wfRestoreWarnings();
-               if ( !$file ) {
-                       return;
-               }
-               $localHash=substr(fread($file,40),8);
-               fclose($file);
-               if ($hash!=$localHash) {
-                       return;
-               }
-               require("$wgLocalMessageCache/messages-" . wfWikiID());
-               $this->setCache( $this->mCache);
+               wfDeprecated( __METHOD__ );
+               $this->loadFromLocal( $hash );
        }
        
        function saveToScript($array, $hash) {
@@ -202,19 +196,17 @@ class MessageCache {
                $this->mCache = false;
 
                # Try local cache
-               wfProfileIn( $fname.'-fromlocal' );
-               $hash = $this->mMemc->get( "{$this->mMemcKey}-hash" );
-               if ( $hash ) {
-                       if ($wgLocalMessageCacheSerialized) {
+               if ( $wgLocalMessageCache !== false ) {
+                       wfProfileIn( $fname.'-fromlocal' );
+                       $hash = $this->mMemc->get( "{$this->mMemcKey}-hash" );
+                       if ( $hash ) {
                                $this->loadFromLocal( $hash );
-                       } else {
-                               $this->loadFromScript( $hash );
-                       }
-                       if ( $this->mCache ) {
-                               wfDebug( "MessageCache::load(): got from local cache\n" );
+                               if ( $this->mCache ) {
+                                       wfDebug( "MessageCache::load(): got from local cache\n" );
+                               }
                        }
+                       wfProfileOut( $fname.'-fromlocal' );
                }
-               wfProfileOut( $fname.'-fromlocal' );
 
                # Try memcached
                if ( !$this->mCache ) {
@@ -298,10 +290,10 @@ class MessageCache {
         * Loads all or main part of cacheable messages from the database
         */
        function loadFromDB() {
-               global $wgLang, $wgMaxMsgCacheEntrySize;
+               global $wgMaxMsgCacheEntrySize;
 
                wfProfileIn( __METHOD__ );
-               $dbr =& wfGetDB( DB_SLAVE );
+               $dbr = wfGetDB( DB_SLAVE );
                $this->mCache = array();
 
                # Load titles for all oversized pages in the MediaWiki namespace
@@ -359,7 +351,6 @@ class MessageCache {
                wfProfileIn( __METHOD__ );
                $this->lock();
                $this->load();
-               $parserMemc->delete(wfMemcKey('sidebar'));
                if ( is_array( $this->mCache ) ) {
                        if ( $text === false ) {
                                # Article was deleted
@@ -387,6 +378,7 @@ class MessageCache {
                        }
                }
                $this->unlock();
+               $parserMemc->delete(wfMemcKey('sidebar'));
                wfProfileOut( __METHOD__ );
        }
 
@@ -444,27 +436,31 @@ class MessageCache {
 
                $message = false;
 
+               # Normalise title-case input
+               $lckey = $wgContLang->lcfirst( $key );
+               $lckey = str_replace( ' ', '_', $lckey );
+
                # Try the MediaWiki namespace
                if( !$this->mDisable && $useDB ) {
-                       $title = $wgContLang->ucfirst( $key );
+                       $title = $wgContLang->ucfirst( $lckey );
                        if(!$isFullKey && ($langcode != $wgContLanguageCode) ) {
                                $title .= '/' . $langcode;
                        }
                        $message = $this->getMsgFromNamespace( $title );
                }
                # Try the extension array
-               if( $message === false && isset( $this->mExtensionMessages[$langcode][$key] ) ) {
-                       $message = $this->mExtensionMessages[$langcode][$key];
+               if( $message === false && isset( $this->mExtensionMessages[$langcode][$lckey] ) ) {
+                       $message = $this->mExtensionMessages[$langcode][$lckey];
                }
-               if ( $message === false && isset( $this->mExtensionMessages['en'][$key] ) ) {
-                       $message = $this->mExtensionMessages['en'][$key];
+               if ( $message === false && isset( $this->mExtensionMessages['en'][$lckey] ) ) {
+                       $message = $this->mExtensionMessages['en'][$lckey];
                }
 
                # Try the array in the language object
                if( $message === false ) {
                        #wfDebug( "Trying language object for message $key\n" );
                        wfSuppressWarnings();
-                       $message = $lang->getMessage( $key );
+                       $message = $lang->getMessage( $lckey );
                        wfRestoreWarnings();
                        if ( is_null( $message ) ) {
                                $message = false;
@@ -472,17 +468,20 @@ class MessageCache {
                }
 
                # 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 ( is_null( $message ) ) {
-                                       $message = false;
+               $pos = strrpos( $lckey, '/' );
+               if( $message === false && $pos !== false) {
+                       $mkey = substr( $lckey, 0, $pos );
+                       $code = substr( $lckey, $pos+1 );
+                       if ( $code ) {
+                               $validCodes = array_keys( Language::getLanguageNames() );
+                               if ( in_array( $code, $validCodes ) ) {
+                                       $message = Language::getMessageFor( $mkey, $code );
+                                       if ( is_null( $message ) ) {
+                                               $message = false;
+                                       }
+                               } else {
+                                       wfDebug( __METHOD__ . ": Invalid code $code for $mkey/$code, not trying messages array\n" );
                                }
-                       } else {
-                               $message = false;
                        }
                }
 
@@ -490,16 +489,13 @@ class MessageCache {
                if( ($message === false || $message === '-' ) &&
                        !$this->mDisable && $useDB &&
                        !$isFullKey && ($langcode != $wgContLanguageCode) ) {
-                       $message = $this->getMsgFromNamespace( $wgContLang->ucfirst( $key ) );
+                       $message = $this->getMsgFromNamespace( $wgContLang->ucfirst( $lckey ) );
                }
 
                # Final fallback
                if( $message === false ) {
                        return '&lt;' . htmlspecialchars($key) . '&gt;';
                }
-
-               # Replace brace tags
-               $message = $this->transform( $message );
                return $message;
        }
 
@@ -543,7 +539,7 @@ class MessageCache {
 
                                if ( $type == ' ' ) {
                                        $message = substr( $entry, 1 );
-                                       $this->mCache[$title] = $message;
+                                       $this->mCache[$title] = $entry;
                                        return $message;
                                } elseif ( $entry == '!NONEXISTENT' ) {
                                        return false;
@@ -573,7 +569,7 @@ class MessageCache {
                return $message;
        }
 
-       function transform( $message ) {
+       function transform( $message, $interface = false ) {
                global $wgParser;
                if ( !$this->mParser && isset( $wgParser ) ) {
                        # Do some initialisation so that we don't have to do it twice
@@ -581,9 +577,11 @@ class MessageCache {
                        # Clone it and store it
                        $this->mParser = clone $wgParser;
                }
-               if ( !$this->mDisableTransform && $this->mParser ) {
+               if ( $this->mParser ) {
                        if( strpos( $message, '{{' ) !== false ) {
-                               $message = $this->mParser->transformMsg( $message, $this->getParserOptions() );
+                               $popts = $this->getParserOptions();
+                               $popts->setInterfaceMessage( $interface );
+                               $message = $this->mParser->transformMsg( $message, $popts );
                        }
                }
                return $message;
@@ -591,10 +589,12 @@ class MessageCache {
 
        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() {}
+       function enableTransform() {}
+       function setTransform( $x ) {}
+       function getTransform() { return false; }
 
        /**
         * Add a message to the cache
@@ -615,6 +615,9 @@ class MessageCache {
         */
        function addMessages( $messages, $lang = 'en' ) {
                wfProfileIn( __METHOD__ );
+               if ( !is_array( $messages ) ) {
+                       throw new MWException( __METHOD__.': Invalid message array' );
+               }
                if ( isset( $this->mExtensionMessages[$lang] ) ) {
                        $this->mExtensionMessages[$lang] = $messages + $this->mExtensionMessages[$lang];
                } else {
@@ -624,7 +627,21 @@ class MessageCache {
        }
 
        /**
-        * Get the extension messages for a specific language
+        * Add a 2-D array of messages by lang. Useful for extensions.
+        *
+        * @param array $messages The array to be added
+        */
+       function addMessagesByLang( $messages ) {
+               wfProfileIn( __METHOD__ );
+               foreach ( $messages as $key => $value ) {
+                       $this->addMessages( $value, $key );
+               }
+               wfProfileOut( __METHOD__ );
+       }
+
+       /**
+        * Get the extension messages for a specific language. Only English, interface
+        * and content language are guaranteed to be loaded.
         *
         * @param string $lang The messages language, English by default
         */
@@ -654,12 +671,57 @@ class MessageCache {
                }
        }
 
-       static function loadAllMessages() {
+       function loadAllMessages() {
+               global $wgExtensionMessagesFiles;
+               if ( $this->mAllMessagesLoaded ) {
+                       return;
+               }
+               $this->mAllMessagesLoaded = true;
+
                # Some extensions will load their messages when you load their class file
                wfLoadAllExtensions();
                # Others will respond to this hook
                wfRunHooks( 'LoadAllMessages' );
+               # Some register their messages in $wgExtensionMessagesFiles
+               foreach ( $wgExtensionMessagesFiles as $name => $file ) {
+                       if ( $file ) {
+                               $this->loadMessagesFile( $file );
+                               $wgExtensionMessagesFiles[$name] = false;
+                       }
+               }
                # Still others will respond to neither, they are EVIL. We sometimes need to know!
        }
+
+       /**
+        * Load messages from a given file
+        */
+       function loadMessagesFile( $filename ) {
+               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 );
+               }
+
+               if ( $magicWords !== false ) {
+                       global $wgContLang;
+                       $wgContLang->addMagicWordsByLang( $magicWords );
+               }
+       }
 }
-?>