* using htmlspecialchars() for safe XHTML output
[lhc/web/wiklou.git] / includes / MessageCache.php
index 86f95c7..be44654 100755 (executable)
@@ -2,8 +2,12 @@
 /**
  *
  * @package MediaWiki
+ * @subpackage Cache
  */
 
+/** */
+require_once( 'Revision.php' );
+
 /**
  *
  */
@@ -21,7 +25,7 @@ class MessageCache
 {
        var $mCache, $mUseCache, $mDisable, $mExpiry;
        var $mMemcKey, $mKeys, $mParserOptions, $mParser;
-       var $mExtensionMessages;
+       var $mExtensionMessages = array();
        var $mInitialised = false;
        var $mDeferred = true;
 
@@ -50,7 +54,7 @@ class MessageCache
                # can return a cache hit, this saves
                # some extra milliseconds
                $this->mDeferred = true;
-               
+
                wfProfileOut( $fname );
        }
 
@@ -63,7 +67,11 @@ class MessageCache
                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';
@@ -80,7 +88,7 @@ class MessageCache
                                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, "loading", MSG_LOAD_TIMEOUT );
+                               $success = $this->mMemc->add( $this->mMemcKey.'-status', "loading", MSG_LOAD_TIMEOUT );
                                if ( $success ) {
                                        wfProfileIn( $fname.'-load' );
                                        $this->loadFromDB();
@@ -88,12 +96,14 @@ 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" );
                                        }
                                }
@@ -101,7 +111,7 @@ class MessageCache
                        }
 
                        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
                                $this->mDisable = true;
@@ -127,26 +137,41 @@ class MessageCache
         * Loads all or main part of cacheable messages from the database
         */
        function loadFromDB() {
-               global $wgPartialMessageCache;
+               global $wgAllMessagesEn, $wgLang;
+               
                $fname = 'MessageCache::loadFromDB';
                $dbr =& wfGetDB( DB_SLAVE );
-               $conditions = array( 'cur_is_redirect' => 0, 
-                                       'cur_namespace' => NS_MEDIAWIKI);
-               if ($wgPartialMessageCache) {
-                       if (is_array($wgPartialMessageCache)) {
-                               $conditions['cur_title']=$wgPartialMessageCache;
-                       } else {
-                               require_once("MessageCacheHints.php");
-                               $conditions['cur_title']=MessageCacheHints::get();
-                       }
+               if ( !$dbr ) {
+                       wfDebugDieBacktrace( 'Invalid database object' );
                }
-               $res = $dbr->select( 'cur',
-                       array( 'cur_title', 'cur_text' ), $conditions, $fname);
+               $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 );
+               }
+
+               # Negative caching
+               # Go through the language array and the extension array and make a note of 
+               # any keys missing from the cache
+               foreach ( $wgAllMessagesEn as $key => $value ) {
+                       $uckey = $wgLang->ucfirst( $key );
+                       if ( !array_key_exists( $uckey, $this->mCache ) ) {
+                               $this->mCache[$uckey] = false;
+                       }
                }
+               foreach ( $this->mExtensionMessages as $key => $value ) {
+                       $uckey = $wgLang->ucfirst( $key );
+                       if ( !array_key_exists( $uckey, $this->mCache ) ) {
+                               $this->mCache[$uckey] = false;
+                       }
+               }       
 
                $dbr->freeResult( $res );
        }
@@ -159,8 +184,7 @@ class MessageCache
                if ( !$this->mKeys ) {
                        $this->mKeys = array();
                        foreach ( $wgAllMessagesEn as $key => $value ) {
-                               global $wgCapitalLinks;
-                               $title = $wgCapitalLinks ? $wgContLang->ucfirst( $key ) : $key;
+                               $title = $wgContLang->ucfirst( $key );
                                array_push( $this->mKeys, $title );
                        }
                }
@@ -168,15 +192,10 @@ class MessageCache
        }
 
        /**
-        * 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 ) {
@@ -215,7 +234,7 @@ class MessageCache
                $this->mMemc->delete( $lockKey );
        }
 
-       function get( $key, $useDB, $forcontent=true ) {
+       function get( $key, $useDB, $forcontent=true, $isfullkey = false ) {
                global $wgContLanguageCode;
                if( $forcontent ) {
                        global $wgContLang;
@@ -228,73 +247,50 @@ class MessageCache
                }
                # If uninitialised, someone is trying to call this halfway through Setup.php
                if( !$this->mInitialised ) {
-                       return "&lt;$key&gt;";
+                       return '&lt;' . htmlspecialchars($key) . '&gt;';
                }
                # If cache initialization was deferred, start it now.
-               if( $this->mDeferred ) {
+               if( $this->mDeferred && !$this->mDisable && $useDB ) {
                        $this->load();
                }
 
                $message = false;
                if( !$this->mDisable && $useDB ) {
-                       global $wgCapitalLinks;
-                       $title = $wgCapitalLinks ? $lang->ucfirst( $key ) : $key;
-                       if( $langcode != $wgContLanguageCode ) {
+                       $title = $lang->ucfirst( $key );
+                       if(!$isfullkey && ($langcode != $wgContLanguageCode) ) {
                                $title .= '/' . $langcode;
                        }
-
-                       # 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 ) {
-                               $dbr =& wfGetDB( DB_SLAVE );
-                               $result = $dbr->selectRow( 'cur', array('cur_text'),
-                                 array( 'cur_namespace' => NS_MEDIAWIKI, 'cur_title' => $title ),
-                                 'MessageCache::get' );
-                               if ( $result ) {
-                                       $message = $result->cur_text;
-                                       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 );
-                                       }
-                               }
-                       }
+                       $message = $this->getFromCache( $title );
                }
                # Try the extension array
-               if( !$message ) {
-                       $message = @$this->mExtensionMessages[$key];
+               if( $message === false && array_key_exists( $key, $this->mExtensionMessages ) ) {
+                       $message = $this->mExtensionMessages[$key];
                }
 
                # Try the array in the language object
-               if( !$message ) {
+               if( $message === false ) {
                        wfSuppressWarnings();
                        $message = $lang->getMessage( $key );
                        wfRestoreWarnings();
                }
 
                # Try the English array
-               if( !$message && $langcode != 'en' ) {
+               if( $message === false && $langcode != 'en' ) {
                        wfSuppressWarnings();
                        $message = Language::getMessage( $key );
                        wfRestoreWarnings();
                }
 
+               # Is this a custom message? Try the default language in the db...
+               if( $message === false &&
+                       !$this->mDisable && $useDB &&
+                       !$isfullkey && ($langcode != $wgContLanguageCode) ) {
+                       $message = $this->getFromCache( $lang->ucfirst( $key ) );
+               }
+
                # Final fallback
-               if( !$message ) {
-                       $message = "&lt;$key&gt;";
+               if( $message === false ) {
+                       return '&lt;' . htmlspecialchars($key) . '&gt;';
                }
 
                # Replace brace tags
@@ -302,6 +298,47 @@ class MessageCache
                return $message;
        }
 
+       function getFromCache( $title ) {
+               $message = false;
+
+               # Try the cache
+               if( $this->mUseCache && is_array( $this->mCache ) && array_key_exists( $title, $this->mCache ) ) {
+                       return $this->mCache[$title];
+               }
+
+               # Try individual message cache
+               if ( $this->mUseCache ) {
+                       $message = $this->mMemc->get( $this->mMemcKey . ':' . $title );
+                       if ( $message == '###NONEXISTENT###' ) {
+                               return false;
+                       } elseif( !is_null( $message ) ) {
+                               $this->mCache[$title] = $message;
+                               return $message;
+                       } else {
+                               $message = false;
+                       }
+               }
+
+               # If it wasn't in the cache, load each message from the DB individually
+               $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 );
+                       }
+               } 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 );
+               }
+
+               return $message;
+       }
+
        function transform( $message ) {
                if( !$this->mDisableTransform ) {
                        if( strpos( $message, '{{' ) !== false ) {
@@ -316,13 +353,24 @@ class MessageCache
        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;
+                       $this->addMessage( $key, $value );
                }
        }