* Fixed unclosed <p> tag
[lhc/web/wiklou.git] / includes / MessageCache.php
index 62c730e..24822b5 100755 (executable)
@@ -2,8 +2,12 @@
 /**
  *
  * @package MediaWiki
+ * @subpackage Cache
  */
 
+/** */
+require_once( 'Revision.php' );
+
 /**
  *
  */
@@ -22,12 +26,13 @@ class MessageCache
        var $mCache, $mUseCache, $mDisable, $mExpiry;
        var $mMemcKey, $mKeys, $mParserOptions, $mParser;
        var $mExtensionMessages;
-
        var $mInitialised = false;
+       var $mDeferred = true;
 
-       function initialise( &$memCached, $useDB, $expiry, $memcPrefix ) {
+       function initialise( &$memCached, $useDB, $expiry, $memcPrefix) {
                $fname = 'MessageCache::initialise';
                wfProfileIn( $fname );
+
                $this->mUseCache = !is_null( $memCached );
                $this->mMemc = &$memCached;
                $this->mDisable = !$useDB;
@@ -36,14 +41,20 @@ class MessageCache
                $this->mMemcKey = $memcPrefix.':messages';
                $this->mKeys = false; # initialised on demand
                $this->mInitialised = true;
+
                wfProfileIn( $fname.'-parseropt' );
                $this->mParserOptions = ParserOptions::newFromUser( $u=NULL );
                wfProfileOut( $fname.'-parseropt' );
                wfProfileIn( $fname.'-parser' );
                $this->mParser = new Parser;
                wfProfileOut( $fname.'-parser' );
-               
-               $this->load();
+
+               # 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( $fname );
        }
 
@@ -54,26 +65,30 @@ class MessageCache
         */
        function load() {
                global $wgAllMessagesEn;
-               
+
                if ( $this->mDisable ) {
-                       wfDebug( "MessageCache::load(): disabled\n" );
+                       static $shownDisabled = false;
+                       if ( !$shownDisabled ) {
+                               wfDebug( "MessageCache::load(): disabled\n" );
+                               $shownDisabled = true;
+                       }
                        return true;
                }
                $fname = 'MessageCache::load';
                wfProfileIn( $fname );
                $success = true;
-               
+
                if ( $this->mUseCache ) {
                        wfProfileIn( $fname.'-fromcache' );
                        $this->mCache = $this->mMemc->get( $this->mMemcKey );
                        wfProfileOut( $fname.'-fromcache' );
-                       
+
                        # 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->set( $this->mMemcKey, "loading", MSG_LOAD_TIMEOUT );
+                               $success = $this->mMemc->add( $this->mMemcKey.'-status', "loading", MSG_LOAD_TIMEOUT );
                                if ( $success ) {
                                        wfProfileIn( $fname.'-load' );
                                        $this->loadFromDB();
@@ -81,22 +96,24 @@ class MessageCache
                                        # 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++ ) {
+                                       for ($i=0; $i<20 &&
+                                                  !$this->mMemc->set( $this->mMemcKey, $this->mCache, $this->mExpiry );
+                                            $i++ ) {
                                                usleep(mt_rand(500000,1500000));
                                        }
                                        wfProfileOut( $fname.'-save' );
                                        if ( $i == 20 ) {
-                                               $this->mMemc->set( $this->mMemcKey, 'error', 86400 );
+                                               $this->mMemc->set( $this->mMemcKey.'-status', 'error', 60*5 );
                                                wfDebug( "MemCached set error in MessageCache: restart memcached server!\n" );
                                        }
                                }
                                $this->unlock();
                        }
-                       
+
                        if ( !is_array( $this->mCache ) ) {
-                               wfMsg( "MessageCache::load(): individual message mode\n" );
+                               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 
+                               # Causing too much DB load, disabling -- TS
                                $this->mDisable = true;
                                /*
                                if ( $this->mCache == "loading" ) {
@@ -112,53 +129,66 @@ class MessageCache
                        }
                }
                wfProfileOut( $fname );
+               $this->mDeferred = false;
                return $success;
        }
 
        /**
-        * Loads all cacheable messages from the database
+        * Loads all or main part of cacheable messages from the database
         */
        function loadFromDB() {
-               $fname = 'MessageCache::loadFromDB';
+               $fname = 'MessageCache::loadFromDB';
                $dbr =& wfGetDB( DB_SLAVE );
-               $res = $dbr->select( 'cur', 
-                       array( 'cur_title', 'cur_text' ), 
-                       array( 'cur_is_redirect' => 0, 'cur_namespace' => NS_MEDIAWIKI ),
+               $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
                );
-               
+
                $this->mCache = array();
                for ( $row = $dbr->fetchObject( $res ); $row; $row = $dbr->fetchObject( $res ) ) {
-                       $this->mCache[$row->cur_title] = $row->cur_text;
+                       $this->mCache[$row->page_title] = Revision::getRevisionText( $row );
                }
 
                $dbr->freeResult( $res );
+               /*
+               # FIXME: This is too slow currently.
+               # We need to bulk-fetch revisions, but in a portable way...
+               $resultSet = Revision::fetchFromConds( $dbr, array(
+                       'page_namespace'   => NS_MEDIAWIKI,
+                       'page_is_redirect' => 0,
+                       'page_id=rev_page' ) );
+               while( $row = $resultSet->fetchObject() ) {
+                       $revision = new Revision( $row );
+                       $title = $revision->getTitle();
+                       $this->mCache[$title->getDBkey()] = $revision->getText();
+               }
+               $resultSet->free();
+               */
        }
-       
+
        /**
         * Not really needed anymore
         */
        function getKeys() {
-               global $wgAllMessagesEn, $wgLang;
+               global $wgAllMessagesEn, $wgContLang;
                if ( !$this->mKeys ) {
                        $this->mKeys = array();
                        foreach ( $wgAllMessagesEn as $key => $value ) {
-                               array_push( $this->mKeys, $wgLang->ucfirst( $key ) );
+                               $title = $wgContLang->ucfirst( $key );
+                               array_push( $this->mKeys, $title );
                        }
                }
                return $this->mKeys;
        }
-       
+
        /**
-        * Obsolete
+        * @deprecated
         */
        function isCacheable( $key ) {
                return true;
-               /*
-               global $wgAllMessagesEn, $wgLang;
-               return array_key_exists( $wgLang->lcfirst( $key ), $wgAllMessagesEn ) || 
-                       array_key_exists( $key, $wgAllMessagesEn );
-               */
        }
 
        function replace( $title, $text ) {
@@ -184,10 +214,10 @@ class MessageCache
                for ($i=0; $i < MSG_WAIT_TIMEOUT && !$this->mMemc->add( $lockKey, 1, MSG_LOCK_TIMEOUT ); $i++ ) {
                        sleep(1);
                }
-               
+
                return $i >= MSG_WAIT_TIMEOUT;
        }
-       
+
        function unlock() {
                if ( !$this->mUseCache ) {
                        return;
@@ -196,89 +226,139 @@ class MessageCache
                $lockKey = $this->mMemcKey . 'lock';
                $this->mMemc->delete( $lockKey );
        }
-       
-       function get( $key, $useDB ) {
-               global $wgLang, $wgLanguageCode;
-               
+
+       function get( $key, $useDB, $forcontent=true, $isfullkey = false ) {
+               global $wgContLanguageCode;
+               if( $forcontent ) {
+                       global $wgContLang;
+                       $lang =& $wgContLang;
+                       $langcode = $wgContLanguageCode;
+               } else {
+                       global $wgLang, $wgLanguageCode;
+                       $lang =& $wgLang;
+                       $langcode = $wgLanguageCode;
+               }
                # If uninitialised, someone is trying to call this halfway through Setup.php
-               if ( !$this->mInitialised ) {
-                       return "&lt;$key&gt;";
+               if( !$this->mInitialised ) {
+                       return '&lt;' . htmlspecialchars($key) . '&gt;';
+               }
+               # If cache initialization was deferred, start it now.
+               if( $this->mDeferred ) {
+                       $this->load();
                }
-               
-               $message = false;
-               if ( !$this->mDisable && $useDB ) {
-                       $title = $wgLang->ucfirst( $key );
-                       
 
-                       # Try the cache
-                       if ( $this->mUseCache && $this->mCache && array_key_exists( $title, $this->mCache ) ) {
-                               $message = $this->mCache[$title];
-                       }
-                       
-                       # If it wasn't in the cache, load each message from the DB individually
-                       if ( !$message ) {
-                               $dbr =& wfGetDB( DB_SLAVE );
-                               $result = $dbr->getArray( 'cur', array('cur_text'), 
-                                 array( 'cur_namespace' => NS_MEDIAWIKI, 'cur_title' => $title ),
-                                 'MessageCache::get' );
-                               if ( $result ) {
-                                       $message = $result->cur_text;
-                               }
+               $message = false;
+               if( !$this->mDisable && $useDB ) {
+                       $title = $lang->ucfirst( $key );
+                       if(!$isfullkey && ($langcode != $wgContLanguageCode) ) {
+                               $title .= '/' . $langcode;
                        }
+                       $message = $this->getFromCache( $title );
                }
                # Try the extension array
-               if ( !$message ) {
+               if( !$message ) {
                        $message = @$this->mExtensionMessages[$key];
                }
 
-               # Try the array in $wgLang
-               if ( !$message ) {
-            wfSuppressWarnings();
-                       $message = $wgLang->getMessage( $key );
-            wfRestoreWarnings();
-               } 
+               # Try the array in the language object
+               if( !$message ) {
+                       wfSuppressWarnings();
+                       $message = $lang->getMessage( $key );
+                       wfRestoreWarnings();
+               }
 
                # Try the English array
-               if ( !$message && $wgLanguageCode != 'en' ) {
-            wfSuppressWarnings();
+               if( !$message && $langcode != 'en' ) {
+                       wfSuppressWarnings();
                        $message = Language::getMessage( $key );
-            wfRestoreWarnings();
+                       wfRestoreWarnings();
+               }
+
+               # Is this a custom message? Try the default language in the db...
+               if( !$message &&
+                       !$this->mDisable && $useDB &&
+                       !$isfullkey && ($langcode != $wgContLanguageCode) ) {
+                       $message = $this->getFromCache( $lang->ucfirst( $key ) );
                }
-               
+
                # Final fallback
-               if ( !$message ) {
-                       $message = "&lt;$key&gt;";
+               if( !$message ) {
+                       return '&lt;' . htmlspecialchars($key) . '&gt;';
                }
-               
+
                # Replace brace tags
                $message = $this->transform( $message );
                return $message;
        }
 
+       function getFromCache( $title ) {
+               $message = false;
+
+               # Try the cache
+               if( $this->mUseCache && is_array( $this->mCache ) && array_key_exists( $title, $this->mCache ) ) {
+                       $message = $this->mCache[$title];
+               }
+
+               if ( !$message && $this->mUseCache ) {
+                       $message = $this->mMemc->get( $this->mMemcKey . ':' . $title );
+                       if( $message ) {
+                               $this->mCache[$title] = $message;
+                       }
+               }
+
+               # If it wasn't in the cache, load each message from the DB individually
+               if ( !$message ) {
+                       $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 );
+                               }
+                       }
+               }
+
+               return $message;
+       }
+
        function transform( $message ) {
-               if( !$this->mDisableTransform ) { 
-                       if ( strstr( $message, '{{' ) !== false ) {
+               if( !$this->mDisableTransform ) {
+                       if( strpos( $message, '{{' ) !== false ) {
                                $message = $this->mParser->transformMsg( $message, $this->mParserOptions );
                        }
                }
                return $message;
        }
-       
+
        function disable() { $this->mDisable = true; }
        function enable() { $this->mDisable = false; }
        function disableTransform() { $this->mDisableTransform = true; }
        function enableTransform() { $this->mDisableTransform = false; }
 
+       /**
+        * Add a message to the cache
+        *
+        * @param mixed $key
+        * @param mixed $value
+        */
        function addMessage( $key, $value ) {
                $this->mExtensionMessages[$key] = $value;
        }
 
+       /**
+        * Add an associative array of message to the cache
+        *
+        * @param array $messages An associative array of key => values to be added
+        */
        function addMessages( $messages ) {
                foreach ( $messages as $key => $value ) {
                        $this->mExtensionMessages[$key] = $value;
                }
        }
-       
+
        /**
         * Clear all stored messages. Mainly used after a mass rebuild.
         */