* Support a third paramater to Parser::setHook() that can contain the object
[lhc/web/wiklou.git] / includes / MessageCache.php
index 9403a10..a02bd62 100755 (executable)
@@ -25,11 +25,12 @@ class MessageCache
 {
        var $mCache, $mUseCache, $mDisable, $mExpiry;
        var $mMemcKey, $mKeys, $mParserOptions, $mParser;
-       var $mExtensionMessages;
+       var $mExtensionMessages = array();
        var $mInitialised = false;
        var $mDeferred = true;
 
        function initialise( &$memCached, $useDB, $expiry, $memcPrefix) {
+               global $wgLocalMessageCache;
                $fname = 'MessageCache::initialise';
                wfProfileIn( $fname );
 
@@ -58,13 +59,65 @@ class MessageCache
                wfProfileOut( $fname );
        }
 
+       /** 
+        * Try to load the cache from a local file
+        */
+       function loadFromLocal( $hash ) {
+               global $wgLocalMessageCache, $wgDBname;
+
+               $this->mCache = false;
+               if ( $wgLocalMessageCache === false ) {
+                       return;
+               }
+               
+               $filename = "$wgLocalMessageCache/messages-$wgDBname";
+
+               $file = fopen( $filename, 'r' );
+               if ( !$file ) {
+                       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, 1000000 );
+                       $this->mCache = unserialize( $serialized );
+               }
+               fclose( $file );
+       }
+
+       /**
+        * Save the cache to a local file
+        */
+       function saveToLocal( $serialized, $hash ) {
+               global $wgLocalMessageCache, $wgDBname;
+
+               if ( $wgLocalMessageCache === false ) {
+                       return;
+               }
+               
+               $filename = "$wgLocalMessageCache/messages-$wgDBname";
+               wfMkdirParents( $wgLocalMessageCache, 0777 );
+
+               $file = fopen( $filename, 'w' );
+               if ( !$file ) {
+                       wfDebug( "Unable to open local cache file for writing\n" );
+                       return;
+               }
+
+               fwrite( $file, $hash . $serialized );
+               fclose( $file );
+       }
+
+
        /**
         * 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
         */
        function load() {
-               global $wgAllMessagesEn;
+               global $wgAllMessagesEn, $wgLocalMessageCache;
 
                if ( $this->mDisable ) {
                        static $shownDisabled = false;
@@ -79,9 +132,33 @@ class MessageCache
                $success = true;
 
                if ( $this->mUseCache ) {
-                       wfProfileIn( $fname.'-fromcache' );
-                       $this->mCache = $this->mMemc->get( $this->mMemcKey );
-                       wfProfileOut( $fname.'-fromcache' );
+                       $this->mCache = false;
+
+                       # Try local cache
+                       wfProfileIn( $fname.'-fromlocal' );
+                       $hash = $this->mMemc->get( "{$this->mMemcKey}-hash" );
+                       if ( $hash ) {
+                               $this->loadFromLocal( $hash );
+                       }
+                       wfProfileOut( $fname.'-fromlocal' );
+
+                       # Try memcached
+                       if ( !$this->mCache ) {
+                               wfProfileIn( $fname.'-fromcache' );
+                               $this->mCache = $this->mMemc->get( $this->mMemcKey );
+
+                               # 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 );
+                                       }
+                                       $this->saveToLocal( $serialized, $hash );
+                               }
+                               wfProfileOut( $fname.'-fromcache' );
+                       }
+
 
                        # If there's nothing in memcached, load all the messages from the database
                        if ( !$this->mCache ) {
@@ -93,6 +170,7 @@ class MessageCache
                                        wfProfileIn( $fname.'-load' );
                                        $this->loadFromDB();
                                        wfProfileOut( $fname.'-load' );
+
                                        # Save in memcached
                                        # Keep trying if it fails, this is kind of important
                                        wfProfileIn( $fname.'-save' );
@@ -101,6 +179,15 @@ class MessageCache
                                             $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 );
+                                               $this->saveToLocal( $serialized, $hash );
+                                       }
+
                                        wfProfileOut( $fname.'-save' );
                                        if ( $i == 20 ) {
                                                $this->mMemc->set( $this->mMemcKey.'-status', 'error', 60*5 );
@@ -137,8 +224,13 @@ class MessageCache
         * Loads all or main part of cacheable messages from the database
         */
        function loadFromDB() {
+               global $wgAllMessagesEn, $wgLang;
+               
                $fname = 'MessageCache::loadFromDB';
                $dbr =& wfGetDB( DB_SLAVE );
+               if ( !$dbr ) {
+                       wfDebugDieBacktrace( 'Invalid database object' );
+               }
                $conditions = array( 'page_is_redirect' => 0,
                                        'page_namespace' => NS_MEDIAWIKI);
                $res = $dbr->select( array( 'page', 'revision', 'text' ),
@@ -152,21 +244,23 @@ class MessageCache
                        $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();
+               # 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;
+                       }
                }
-               $resultSet->free();
-               */
+               foreach ( $this->mExtensionMessages as $key => $value ) {
+                       $uckey = $wgLang->ucfirst( $key );
+                       if ( !array_key_exists( $uckey, $this->mCache ) ) {
+                               $this->mCache[$uckey] = false;
+                       }
+               }       
+
+               $dbr->freeResult( $res );
        }
 
        /**
@@ -192,11 +286,23 @@ class MessageCache
        }
 
        function replace( $title, $text ) {
+               global $wgLocalMessageCache;
+
                $this->lock();
                $this->load();
                if ( is_array( $this->mCache ) ) {
                        $this->mCache[$title] = $text;
                        $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 );
+                               $this->saveToLocal( $serialized, $hash );
+                       }
+
+
                }
                $this->unlock();
        }
@@ -243,7 +349,7 @@ class MessageCache
                        return '<' . htmlspecialchars($key) . '>';
                }
                # If cache initialization was deferred, start it now.
-               if( $this->mDeferred ) {
+               if( $this->mDeferred && !$this->mDisable && $useDB ) {
                        $this->load();
                }
 
@@ -256,33 +362,39 @@ class MessageCache
                        $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();
+                       if ( is_null( $message ) ) {
+                               $message = false;
+                       }
                }
 
                # Try the English array
-               if( !$message && $langcode != 'en' ) {
+               if( $message === false && $langcode != 'en' ) {
                        wfSuppressWarnings();
                        $message = Language::getMessage( $key );
                        wfRestoreWarnings();
+                       if ( is_null( $message ) ) {
+                               $message = false;
+                       }
                }
 
                # Is this a custom message? Try the default language in the db...
-               if( !$message &&
+               if( $message === false &&
                        !$this->mDisable && $useDB &&
                        !$isfullkey && ($langcode != $wgContLanguageCode) ) {
                        $message = $this->getFromCache( $lang->ucfirst( $key ) );
                }
 
                # Final fallback
-               if( !$message ) {
+               if( $message === false ) {
                        return '<' . htmlspecialchars($key) . '>';
                }
 
@@ -296,29 +408,37 @@ class MessageCache
 
                # Try the cache
                if( $this->mUseCache && is_array( $this->mCache ) && array_key_exists( $title, $this->mCache ) ) {
-                       $message = $this->mCache[$title];
+                       return $this->mCache[$title];
                }
 
-               if ( !$message && $this->mUseCache ) {
+               # Try individual message cache
+               if ( $this->mUseCache ) {
                        $message = $this->mMemc->get( $this->mMemcKey . ':' . $title );
-                       if( $message ) {
+                       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
-               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 );
-                               }
+               $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;