* addressed r53282#c3209 moved conditional inclusion of $wgExtensionMessages in mwScr...
[lhc/web/wiklou.git] / includes / MessageCache.php
index f24d3b4..351c65d 100644 (file)
@@ -23,9 +23,6 @@ class MessageCache {
 
        var $mUseCache, $mDisable, $mExpiry;
        var $mKeys, $mParserOptions, $mParser;
-       var $mExtensionMessages = array();
-       var $mInitialised = false;
-       var $mAllMessagesLoaded; // Extension messages
 
        // Variable for tracking which variables are loaded
        var $mLoadedLanguages = array();
@@ -37,14 +34,12 @@ class MessageCache {
                $this->mExpiry = $expiry;
                $this->mDisableTransform = false;
                $this->mKeys = false; # initialised on demand
-               $this->mInitialised = true;
                $this->mParser = null;
        }
 
 
        /**
         * ParserOptions is lazy initialised.
-        * Access should probably be protected.
         */
        function getParserOptions() {
                if ( !$this->mParserOptions ) {
@@ -63,9 +58,9 @@ class MessageCache {
         * @return false on failure.
         */
        function loadFromLocal( $hash, $code ) {
-               global $wgLocalMessageCache, $wgLocalMessageCacheSerialized;
+               global $wgCacheDirectory, $wgLocalMessageCacheSerialized;
 
-               $filename = "$wgLocalMessageCache/messages-" . wfWikiID() . "-$code";
+               $filename = "$wgCacheDirectory/messages-" . wfWikiID() . "-$code";
 
                # Check file existence
                wfSuppressWarnings();
@@ -107,10 +102,10 @@ class MessageCache {
         * Save the cache to a local file.
         */
        function saveToLocal( $serialized, $hash, $code ) {
-               global $wgLocalMessageCache;
+               global $wgCacheDirectory;
 
-               $filename = "$wgLocalMessageCache/messages-" . wfWikiID() . "-$code";
-               wfMkdirParents( $wgLocalMessageCache, 0777 ); // might fail
+               $filename = "$wgCacheDirectory/messages-" . wfWikiID() . "-$code";
+               wfMkdirParents( $wgCacheDirectory ); // might fail
 
                wfSuppressWarnings();
                $file = fopen( $filename, 'w' );
@@ -127,11 +122,11 @@ class MessageCache {
        }
 
        function saveToScript( $array, $hash, $code ) {
-               global $wgLocalMessageCache;
+               global $wgCacheDirectory;
 
-               $filename = "$wgLocalMessageCache/messages-" . wfWikiID() . "-$code";
+               $filename = "$wgCacheDirectory/messages-" . wfWikiID() . "-$code";
                $tempFilename = $filename . '.tmp';
-       wfMkdirParents( $wgLocalMessageCache, 0777 ); // might fail
+               wfMkdirParents( $wgCacheDirectory ); // might fail
 
                wfSuppressWarnings();
                $file = fopen( $tempFilename, 'w');
@@ -175,7 +170,7 @@ class MessageCache {
 
        /**
         * Loads messages from caches or from database in this order:
-        * (1) local message cache (if $wgLocalMessageCache is enabled)
+        * (1) local message cache (if $wgUseLocalMessageCache is enabled)
         * (2) memcached
         * (3) from the database.
         *
@@ -192,7 +187,7 @@ class MessageCache {
         * @param $code String: language to which load messages
         */
        function load( $code = false ) {
-               global $wgLocalMessageCache;
+               global $wgUseLocalMessageCache;
 
                if ( !$this->mUseCache ) {
                        return true;
@@ -228,7 +223,7 @@ class MessageCache {
                # (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 ) {
+               if ( $wgUseLocalMessageCache ) {
                        wfProfileIn( __METHOD__ . '-fromlocal' );
 
                        $hash = $this->mMemc->get( wfMemcKey( 'messages', $code, 'hash' ) );
@@ -261,12 +256,23 @@ class MessageCache {
 
                        $this->lock($cacheKey);
 
-                       $cache = $this->loadFromDB( $code );
-                       $success = $this->setCache( $cache, $code );
+                       # 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 ) {
-                               $this->saveToCaches( $cache, true, $code );
+                               $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->set( $statusKey, 'error', 60*5 );
+                                       wfDebug( "MemCached set error in MessageCache: restart memcached server!\n" );
+                               }
                        }
-
                        $this->unlock($cacheKey);
                }
 
@@ -397,6 +403,8 @@ class MessageCache {
                $sidebarKey = wfMemcKey( 'sidebar', $code );
                $parserMemc->delete( $sidebarKey );
 
+               wfRunHooks( "MessageCacheReplace", array( $title, $text ) );
+
                wfProfileOut( __METHOD__ );
        }
 
@@ -411,13 +419,9 @@ class MessageCache {
         */
        protected function saveToCaches( $cache, $memc = true, $code = false ) {
                wfProfileIn( __METHOD__ );
-               global $wgLocalMessageCache, $wgLocalMessageCacheSerialized;
+               global $wgUseLocalMessageCache, $wgLocalMessageCacheSerialized;
 
                $cacheKey = wfMemcKey( 'messages', $code );
-               $statusKey = wfMemcKey( 'messages', $code, 'status' );
-
-               $success = $this->mMemc->add( $statusKey, 'loading', MSG_LOAD_TIMEOUT );
-               if ( !$success ) return true; # Other process should be updating them now
 
                $i = 0;
                if ( $memc ) {
@@ -432,7 +436,7 @@ class MessageCache {
                }
 
                # Save to local cache
-               if ( $wgLocalMessageCache !== false ) {
+               if ( $wgUseLocalMessageCache ) {
                        $serialized = serialize( $cache );
                        $hash = md5( $serialized );
                        $this->mMemc->set( wfMemcKey( 'messages', $code, 'hash' ), $hash, $this->mExpiry );
@@ -444,11 +448,8 @@ class MessageCache {
                }
 
                if ( $i == 20 ) {
-                       $this->mMemc->set( $statusKey, 'error', 60*5 );
-                       wfDebug( "MemCached set error in MessageCache: restart memcached server!\n" );
                        $success = false;
                } else {
-                       $this->mMemc->delete( $statusKey );
                        $success = true;
                }
                wfProfileOut( __METHOD__ );
@@ -495,62 +496,35 @@ class MessageCache {
         *                         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".
+        * @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, $wgLang;
-
-               # 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;
-               } 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.' );
-                       }
+               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) . '>';
-               }
-
                $message = false;
 
                # Normalise title-case input
-               $lckey = $wgContLang->lcfirst( $key );
-               $lckey = str_replace( ' ', '_', $lckey );
+               $lckey = str_replace( ' ', '_', $key );
+               $lckey[0] = strtolower( $lckey[0] );
+               $uckey = ucfirst( $lckey );
 
                # Try the MediaWiki namespace
                if( !$this->mDisable && $useDB ) {
-                       $title = $wgContLang->ucfirst( $lckey );
-                       if(!$isFullKey && ($langcode != $wgContLanguageCode) ) {
+                       $title = $uckey;
+                       if(!$isFullKey && ( $langcode != $wgContLanguageCode ) ) {
                                $title .= '/' . $langcode;
                        }
                        $message = $this->getMsgFromNamespace( $title, $langcode );
                }
 
-               # 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];
-               }
-
                # Try the array in the language object
                if ( $message === false ) {
                        $message = $lang->getMessage( $lckey );
@@ -560,19 +534,15 @@ class MessageCache {
                }
 
                # Try the array of another language
-               $pos = strrpos( $lckey, '/' );
-               if( $message === false && $pos !== false) {
-                       $mkey = substr( $lckey, 0, $pos );
-                       $code = substr( $lckey, $pos+1 );
-                       if ( $code ) {
-                               # We may get calls for things that are http-urls from sidebar
-                               # Let's not load nonexistent languages for those
-                               $validCodes = array_keys( Language::getLanguageNames() );
-                               if ( in_array( $code, $validCodes ) ) {
-                                       $message = Language::getMessageFor( $mkey, $code );
-                                       if ( is_null( $message ) ) {
-                                               $message = false;
-                                       }
+               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;
                                }
                        }
                }
@@ -581,13 +551,23 @@ class MessageCache {
                if( ($message === false || $message === '-' ) &&
                        !$this->mDisable && $useDB &&
                        !$isFullKey && ($langcode != $wgContLanguageCode) ) {
-                       $message = $this->getMsgFromNamespace( $wgContLang->ucfirst( $lckey ), $wgContLanguageCode );
+                       $message = $this->getMsgFromNamespace( $uckey, $wgContLanguageCode );
                }
 
                # Final fallback
                if( $message === false ) {
                        return '<' . htmlspecialchars($key) . '>';
                }
+
+               # 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;
        }
 
@@ -664,23 +644,30 @@ class MessageCache {
                return $message;
        }
 
-       function transform( $message, $interface = false ) {
-               // Avoid creating parser if nothing to transfrom
+       function transform( $message, $interface = false, $language = null ) {
+               // Avoid creating parser if nothing to transform
                if( strpos( $message, '{{' ) === false ) {
                        return $message;
                }
 
-               global $wgParser;
+               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;
+                       $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;
@@ -705,163 +692,91 @@ class MessageCache {
        }
 
        /**
+        * 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[$lang][$key] = $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__ );
-               if ( !is_array( $messages ) ) {
-                       throw new MWException( __METHOD__.': Invalid message array' );
-               }
-               if ( isset( $this->mExtensionMessages[$lang] ) ) {
-                       $this->mExtensionMessages[$lang] = $messages + $this->mExtensionMessages[$lang];
-               } else {
-                       $this->mExtensionMessages[$lang] = $messages;
-               }
-               wfProfileOut( __METHOD__ );
+               wfDeprecated( __METHOD__ );
+               $lc = Language::getLocalisationCache();
+               $lc->addLegacyMessages( array( $lang => $messages ) );
        }
 
        /**
         * Add a 2-D array of messages by lang. Useful for extensions.
+        * @deprecated Use $wgExtensionMessagesFiles
         *
         * @param array $messages The array to be added
         */
        function addMessagesByLang( $messages ) {
-               wfProfileIn( __METHOD__ );
-               foreach ( $messages as $key => $value ) {
-                       $this->addMessages( $value, $key );
-               }
-               wfProfileOut( __METHOD__ );
+               wfDeprecated( __METHOD__ );
+               $lc = Language::getLocalisationCache();
+               $lc->addLegacyMessages( $messages );
        }
 
        /**
-        * 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
+        * Set a hook for addMessagesByLang()
         */
-       function getExtensionMessagesFor( $lang = 'en' ) {
-               wfProfileIn( __METHOD__ );
-               $messages = array();
-               if ( isset( $this->mExtensionMessages[$lang] ) ) {
-                       $messages = $this->mExtensionMessages[$lang];
-               }
-               if ( $lang != 'en' ) {
-                       $messages = $messages + $this->mExtensionMessages['en'];
-               }
-               wfProfileOut( __METHOD__ );
-               return $messages;
+       function setExtensionMessagesHook( $callback ) {
+               $this->mAddMessagesHook = $callback;
        }
 
        /**
-        * Clear all stored messages. Mainly used after a mass rebuild.
+        * @deprecated
         */
-       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' ) );
-                       }
-               }
-       }
-
-       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 ) {
-                       wfLoadExtensionMessages( $name );
-               }
-               # Still others will respond to neither, they are EVIL. We sometimes need to know!
+       function loadAllMessages( $lang = false ) {
        }
 
        /**
-        * 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).
+        * @deprecated
         */
        function loadMessagesFile( $filename, $langcode = false ) {
-               global $wgLang, $wgContLang;
-               $messages = $magicWords = false;
-               require( $filename );
-
-               $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 ) {
-                       global $wgContLang;
-                       $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);
+               $pieces = explode( '/', $key );
+               if( count( $pieces ) < 2 )
+                       return array( $key, $wgContLanguageCode );
 
-               $key = $pieces[0];
+               $lang = array_pop( $pieces );
+               $validCodes = Language::getLanguageNames();
+               if( !array_key_exists( $lang, $validCodes ) )
+                       return array( $key, $wgContLanguageCode );
 
-               # Language the user is translating to
-               $langCode = isset($pieces[1]) ? $pieces[1] : $wgContLanguageCode;
-               return array( $key, $langCode );
+               $message = implode( '/', $pieces );
+               return array( $message, $lang );
        }
 
 }