Allow storing local message cache as PHP source instead of serialized array, this...
[lhc/web/wiklou.git] / includes / MessageCache.php
old mode 100755 (executable)
new mode 100644 (file)
index 506bb19..35ea4d5
@@ -21,8 +21,7 @@ define( 'MSG_WAIT_TIMEOUT', 10);
  *
  * @package MediaWiki
  */
-class MessageCache
-{
+class MessageCache {
        var $mCache, $mUseCache, $mDisable, $mExpiry;
        var $mMemcKey, $mKeys, $mParserOptions, $mParser;
        var $mExtensionMessages = array();
@@ -58,13 +57,114 @@ 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";
+
+               wfSuppressWarnings();
+               $file = fopen( $filename, 'r' );
+               wfRestoreWarnings();
+               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";
+               $oldUmask = umask( 0 );
+               wfMkdirParents( $wgLocalMessageCache, 0777 );
+               umask( $oldUmask );
+
+               $file = fopen( $filename, 'w' );
+               if ( !$file ) {
+                       wfDebug( "Unable to open local cache file for writing\n" );
+                       return;
+               }
+
+               fwrite( $file, $hash . $serialized );
+               fclose( $file );
+               @chmod( $filename, 0666 );
+       }
+
+       function loadFromScript( $hash ) {
+               global $wgLocalMessageCache, $wgDBname;
+               if ( $wgLocalMessageCache === false ) {
+                       return;
+               }
+               
+               $filename = "$wgLocalMessageCache/messages-$wgDBname";
+               
+               wfSuppressWarnings();
+               $file = fopen( $filename, 'r' );
+               wfRestoreWarnings();
+               if ( !$file ) {
+                       return;
+               }
+               $localHash=substr(fread($file,40),8);
+               fclose($file);
+               if ($hash!=$localHash) {
+                       return;
+               }
+               require("$wgLocalMessageCache/messages-$wgDBname");
+       }
+       
+       function saveToScript($array, $hash) {
+               global $wgLocalMessageCache, $wgDBname;
+               if ( $wgLocalMessageCache === false ) {
+                       return;
+               }
+
+               $filename = "$wgLocalMessageCache/messages-$wgDBname";
+               $oldUmask = umask( 0 );
+               wfMkdirParents( $wgLocalMessageCache, 0777 );
+               umask( $oldUmask );
+               $file = fopen( $filename.'.tmp', 'w');
+               fwrite($file,"<?php\n//$hash\n\n \$this->mCache = array(");
+               
+               $re="/(?<!\\\\)'/";
+               foreach ($array as $key => $message) {
+                       fwrite($file, "'". preg_replace($re, "\'", $key).
+                               "' => '" . preg_replace( $re, "\'", $message) . "',\n");
+               }
+               fwrite($file,");\n?>");
+               fclose($file);
+               rename($filename.'.tmp',$filename);
+       }
+
        /**
         * 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 $wgLocalMessageCache, $wgLocalMessageCacheSerialized;
 
                if ( $this->mDisable ) {
                        static $shownDisabled = false;
@@ -79,9 +179,41 @@ 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 ) {
+                               if ($wgLocalMessageCacheSerialized) {
+                                       $this->loadFromLocal( $hash );
+                               } else {
+                                       $this->loadFromScript( $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 );
+                                       }
+                                       if ($wgLocalMessageCacheSerialized) {
+                                               $this->saveToLocal( $serialized,$hash );
+                                       } else {
+                                               $this->saveToScript( $this->mCache, $hash );
+                                       }
+                               }
+                               wfProfileOut( $fname.'-fromcache' );
+                       }
+
 
                        # If there's nothing in memcached, load all the messages from the database
                        if ( !$this->mCache ) {
@@ -93,6 +225,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 +234,19 @@ 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 );
+                                               if ($wgLocalMessageCacheSerialized) {
+                                                       $this->saveToLocal( $serialized,$hash );
+                                               } else {
+                                                       $this->saveToScript( $this->mCache, $hash );
+                                               }
+                                       }
+
                                        wfProfileOut( $fname.'-save' );
                                        if ( $i == 20 ) {
                                                $this->mMemc->set( $this->mMemcKey.'-status', 'error', 60*5 );
@@ -138,7 +284,7 @@ class MessageCache
         */
        function loadFromDB() {
                global $wgAllMessagesEn, $wgLang;
-               
+
                $fname = 'MessageCache::loadFromDB';
                $dbr =& wfGetDB( DB_SLAVE );
                if ( !$dbr ) {
@@ -158,7 +304,7 @@ class MessageCache
                }
 
                # Negative caching
-               # Go through the language array and the extension array and make a note of 
+               # 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 );
@@ -171,7 +317,7 @@ class MessageCache
                        if ( !array_key_exists( $uckey, $this->mCache ) ) {
                                $this->mCache[$uckey] = false;
                        }
-               }       
+               }
 
                $dbr->freeResult( $res );
        }
@@ -199,11 +345,28 @@ class MessageCache
        }
 
        function replace( $title, $text ) {
+               global $wgLocalMessageCache, $wgLocalMessageCacheSerialized, $parserMemc, $wgDBname;
+
                $this->lock();
                $this->load();
+               $parserMemc->delete("$wgDBname:sidebar");
                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 );
+                               if ($wgLocalMessageCacheSerialized) {
+                                       $this->saveToLocal( $serialized,$hash );
+                               } else {
+                                       $this->saveToScript( $this->mCache, $hash );
+                               }
+                       }
+
+
                }
                $this->unlock();
        }
@@ -272,6 +435,9 @@ class MessageCache
                        wfSuppressWarnings();
                        $message = $lang->getMessage( $key );
                        wfRestoreWarnings();
+                       if ( is_null( $message ) ) {
+                               $message = false;
+                       }
                }
 
                # Try the English array
@@ -279,6 +445,9 @@ class MessageCache
                        wfSuppressWarnings();
                        $message = Language::getMessage( $key );
                        wfRestoreWarnings();
+                       if ( is_null( $message ) ) {
+                               $message = false;
+                       }
                }
 
                # Is this a custom message? Try the default language in the db...
@@ -309,7 +478,9 @@ class MessageCache
                # Try individual message cache
                if ( $this->mUseCache ) {
                        $message = $this->mMemc->get( $this->mMemcKey . ':' . $title );
-                       if( !is_null( $message ) ) {
+                       if ( $message == '###NONEXISTENT###' ) {
+                               return false;
+                       } elseif( !is_null( $message ) ) {
                                $this->mCache[$title] = $message;
                                return $message;
                        } else {
@@ -317,6 +488,9 @@ class MessageCache
                        }
                }
 
+               # Call message Hooks, in case they are defined
+               wfRunHooks('MessagesPreLoad',array($title,&$message));
+
                # If it wasn't in the cache, load each message from the DB individually
                $revision = Revision::newFromTitle( Title::makeTitle( NS_MEDIAWIKI, $title ) );
                if( $revision ) {
@@ -330,7 +504,8 @@ class MessageCache
                        }
                } else {
                        # Negative caching
-                       $this->mMemc->set( $this->mMemcKey . ':' . $title, false, $this->mExpiry );
+                       # Use some special text instead of false, because false gets converted to '' somewhere
+                       $this->mMemc->set( $this->mMemcKey . ':' . $title, '###NONEXISTENT###', $this->mExpiry );
                }
 
                return $message;
@@ -349,6 +524,8 @@ class MessageCache
        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; }
 
        /**
         * Add a message to the cache