Clean up after r14751:

[lhc/web/wiklou.git] / includes / CacheManager.php

diff --git a/includes/CacheManager.php b/includes/CacheManager.php
index f42c530..b9e307f 100644 (file)
--- a/includes/CacheManager.php
+++ b/includes/CacheManager.php
@@ -1,30 +1,45 @@
-<?
-
-include_once( "Title.php" );
+<?php
+/**
+ * Contain the CacheManager class
+ * @package MediaWiki
+ * @subpackage Cache
+ */
 
+/**
+ * Handles talking to the file cache, putting stuff in and taking it back out.
+ * Mostly called from Article.php, also from DatabaseFunctions.php for the
+ * emergency abort/fallback to cache.
+ *
+ * Global options that affect this module:
+ * $wgCachePages
+ * $wgCacheEpoch
+ * $wgUseFileCache
+ * $wgFileCacheDirectory
+ * $wgUseGzip
+ * @package MediaWiki
+ */
 class CacheManager {
        var $mTitle, $mFileCache;
-       
+
        function CacheManager( &$title ) {
                $this->mTitle =& $title;
-               $this->mFileCache = "";
+               $this->mFileCache = '';
        }
-       
+
        function fileCacheName() {
-               global $wgFileCacheDirectory, $wgLang;
+               global $wgFileCacheDirectory;
                if( !$this->mFileCache ) {
-                       $hash = md5( $key = $this->mTitle->getDbkey() );
-                       if( $this->mTitle->getNamespace() )
-                               $key = $wgLang->getNsText( $this->mTitle->getNamespace() ) . ":" . $key;
-                       $key = str_replace( ".", "%2E", urlencode( $key ) );
-                       
+                       $key = $this->mTitle->getPrefixedDbkey();
+                       $hash = md5( $key );
+                       $key = str_replace( '.', '%2E', urlencode( $key ) );
+
                        $hash1 = substr( $hash, 0, 1 );
                        $hash2 = substr( $hash, 0, 2 );
                        $this->mFileCache = "{$wgFileCacheDirectory}/{$hash1}/{$hash2}/{$key}.html";
-                       
+
                        if($this->useGzip())
-                               $this->mFileCache .= ".gz";
-                       
+                               $this->mFileCache .= '.gz';
+
                        wfDebug( " fileCacheName() - {$this->mFileCache}\n" );
                }
                return $this->mFileCache;
@@ -33,21 +48,21 @@ class CacheManager {
        function isFileCached() {
                return file_exists( $this->fileCacheName() );
        }
-       
+
        function fileCacheTime() {
-               return wfUnix2Timestamp( filemtime( $this->fileCacheName() ) );
+               return wfTimestamp( TS_MW, filemtime( $this->fileCacheName() ) );
        }
-       
+
        function isFileCacheGood( $timestamp ) {
-               global $wgUser, $wgCacheEpoch;
-               
+               global $wgCacheEpoch;
+
                if( !$this->isFileCached() ) return false;
-               
+
                $cachetime = $this->fileCacheTime();
                $good = (( $timestamp <= $cachetime ) &&
                         ( $wgCacheEpoch <= $cachetime ));
-               
-               wfDebug(" isFileCacheGood() - cachetime $cachetime, touched {$this->mTouched} epoch {$wgCacheEpoch}, good $good\n");
+
+               wfDebug(" isFileCacheGood() - cachetime $cachetime, touched {$timestamp} epoch {$wgCacheEpoch}, good $good\n");
                return $good;
        }
 
@@ -55,77 +70,79 @@ class CacheManager {
                global $wgUseGzip;
                return $wgUseGzip;
        }
-       
+
        /* In handy string packages */
        function fetchRawText() {
                return file_get_contents( $this->fileCacheName() );
        }
-       
+
        function fetchPageText() {
                if( $this->useGzip() ) {
                        /* Why is there no gzfile_get_contents() or gzdecode()? */
-                       return implode( "", gzfile( $this->fileCacheName() ) );
+                       return implode( '', gzfile( $this->fileCacheName() ) );
                } else {
                        return $this->fetchRawText();
                }
        }
-       
+
        /* Working directory to/from output */
        function loadFromFileCache() {
-               global $wgOut;
+               global $wgOut, $wgMimeType, $wgOutputEncoding, $wgContLanguageCode;
                wfDebug(" loadFromFileCache()\n");
-               
+
                $filename=$this->fileCacheName();
                $wgOut->sendCacheControl();
-               
+
+               header( "Content-type: $wgMimeType; charset={$wgOutputEncoding}" );
+               header( "Content-language: $wgContLanguageCode" );
+
                if( $this->useGzip() ) {
                        if( wfClientAcceptsGzip() ) {
-                               header( "Content-Encoding: gzip" );
-                               readfile( $filename );
+                               header( 'Content-Encoding: gzip' );
                        } else {
                                /* Send uncompressed */
                                readgzfile( $filename );
+                               return;
                        }
-               } else {
-                       readfile( $filename );
                }
+               readfile( $filename );
        }
-       
+
        function checkCacheDirs() {
                $filename = $this->fileCacheName();
-                $mydir2=substr($filename,0,strrpos($filename,"/")); # subdirectory level 2
-               $mydir1=substr($mydir2,0,strrpos($mydir2,"/")); # subdirectory level 1
-               
+               $mydir2=substr($filename,0,strrpos($filename,'/')); # subdirectory level 2
+               $mydir1=substr($mydir2,0,strrpos($mydir2,'/')); # subdirectory level 1
+
                if(!file_exists($mydir1)) { mkdir($mydir1,0775); } # create if necessary
                if(!file_exists($mydir2)) { mkdir($mydir2,0775); }
        }
-       
-       function saveToFileCache( $text ) {
-               if(strcmp($text,"") == 0) return "";
-               
+
+       function saveToFileCache( $origtext ) {
+               $text = $origtext;
+               if(strcmp($text,'') == 0) return '';
+
                wfDebug(" saveToFileCache()\n", false);
-               
+
                $this->checkCacheDirs();
-               
-               $f = fopen( $this->fileCacheName(), "w" );
+
+               $f = fopen( $this->fileCacheName(), 'w' );
                if($f) {
                        $now = wfTimestampNow();
                        if( $this->useGzip() ) {
-                               $rawtext = str_replace( "</html>",
-                                       "<!-- Cached/compressed $now -->\n</html>",
+                               $rawtext = str_replace( '</html>',
+                                       '<!-- Cached/compressed '.$now." -->\n</html>",
                                        $text );
                                $text = gzencode( $rawtext );
                        } else {
-                               $text = str_replace( "</html>",
-                                       "<!-- Cached $now -->\n</html>",
+                               $text = str_replace( '</html>',
+                                       '<!-- Cached '.$now." -->\n</html>",
                                        $text );
                        }
                        fwrite( $f, $text );
                        fclose( $f );
                        if( $this->useGzip() ) {
                                if( wfClientAcceptsGzip() ) {
-                                       header( "Content-Encoding: gzip" );
-                                       header( "Vary: Accept-Encoding" );
+                                       header( 'Content-Encoding: gzip' );
                                        return $text;
                                } else {
                                        return $rawtext;