X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2FHTMLFileCache.php;h=fd7d048bf49a44c37d9454bb80e62f173cc7ce79;hb=e78af18401fadb77a5c36bfb11991b33d1188135;hp=d85a441106140a339a854cb282b15c1469868d90;hpb=d411e0b1e0a23dc54e1d39573e5ee4b9f3019141;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/HTMLFileCache.php b/includes/HTMLFileCache.php
index d85a441106..fd7d048bf4 100644
--- a/includes/HTMLFileCache.php
+++ b/includes/HTMLFileCache.php
@@ -1,82 +1,129 @@
 <?php
 /**
  * Contain the HTMLFileCache class
- * @package MediaWiki
- * @subpackage Cache
+ * @file
+ * @ingroup 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.
+ * Mostly called from Article.php for the emergency abort/fallback to cache.
  *
  * Global options that affect this module:
- * $wgCachePages
- * $wgCacheEpoch
- * $wgUseFileCache
- * $wgFileCacheDirectory
- * $wgUseGzip
- * @package MediaWiki
+ * - $wgCachePages
+ * - $wgCacheEpoch
+ * - $wgUseFileCache
+ * - $wgCacheDirectory
+ * - $wgFileCacheDirectory
+ * - $wgUseGzip
+ *
+ * @ingroup Cache
  */
 class HTMLFileCache {
-	var $mTitle, $mFileCache;
+	var $mTitle, $mFileCache, $mType;
 
-	function HTMLFileCache( &$title ) {
-		$this->mTitle =& $title;
-		$this->mFileCache = '';
+	public function __construct( &$title, $type = 'view' ) {
+		$this->mTitle = $title;
+		$this->mType = ($type == 'raw' || $type == 'view' ) ? $type : false;
+		$this->fileCacheName(); // init name
 	}
 
-	function fileCacheName() {
-		global $wgFileCacheDirectory;
+	public function fileCacheName() {
 		if( !$this->mFileCache ) {
+			global $wgCacheDirectory, $wgFileCacheDirectory, $wgRequest;
+
+			if ( $wgFileCacheDirectory ) {
+				$dir = $wgFileCacheDirectory;
+			} elseif ( $wgCacheDirectory ) {
+				$dir = "$wgCacheDirectory/html";
+			} else {
+				throw new MWException( 'Please set $wgCacheDirectory in LocalSettings.php if you wish to use the HTML file cache' );
+			}
+
+			# Store raw pages (like CSS hits) elsewhere
+			$subdir = ($this->mType === 'raw') ? 'raw/' : '';
 			$key = $this->mTitle->getPrefixedDbkey();
 			$hash = md5( $key );
+			# Avoid extension confusion
 			$key = str_replace( '.', '%2E', urlencode( $key ) );
-
+	
 			$hash1 = substr( $hash, 0, 1 );
 			$hash2 = substr( $hash, 0, 2 );
-			$this->mFileCache = "{$wgFileCacheDirectory}/{$hash1}/{$hash2}/{$key}.html";
+			$this->mFileCache = "{$wgFileCacheDirectory}/{$subdir}{$hash1}/{$hash2}/{$key}.html";
 
-			if($this->useGzip())
+			if( $this->useGzip() )
 				$this->mFileCache .= '.gz';
 
-			wfDebug( " fileCacheName() - {$this->mFileCache}\n" );
+			wfDebug( __METHOD__ . ": {$this->mFileCache}\n" );
 		}
 		return $this->mFileCache;
 	}
 
-	function isFileCached() {
+	public function isFileCached() {
+		if( $this->mType === false ) return false;
 		return file_exists( $this->fileCacheName() );
 	}
 
-	function fileCacheTime() {
+	public function fileCacheTime() {
 		return wfTimestamp( TS_MW, filemtime( $this->fileCacheName() ) );
 	}
+	
+	/**
+	 * Check if pages can be cached for this request/user
+	 * @return bool
+	 */
+	public static function useFileCache() {
+		global $wgUser, $wgUseFileCache, $wgShowIPinHeader, $wgRequest, $wgLang, $wgContLang;
+		if( !$wgUseFileCache ) return false;
+		// Get all query values
+		$queryVals = $wgRequest->getValues();
+		foreach( $queryVals as $query => $val ) {
+			if( $query == 'title' || $query == 'curid' ) continue;
+			// Normal page view in query form can have action=view.
+			// Raw hits for pages also stored, like .css pages for example.
+			else if( $query == 'action' && ($val == 'view' || $val == 'raw') ) continue;
+			else if( $query == 'usemsgcache' && $val == 'yes' ) continue;
+			// Below are header setting params
+			else if( $query == 'maxage' || $query == 'smaxage' || $query == 'ctype' || $query == 'gen' )
+				continue;
+			else
+				return false;
+		}
+		// Check for non-standard user language; this covers uselang,
+		// and extensions for auto-detecting user language.
+		$ulang = $wgLang->getCode();
+		$clang = $wgContLang->getCode();
+		// Check that there are no other sources of variation
+		return !$wgShowIPinHeader && !$wgUser->getId() && !$wgUser->getNewtalk() && $ulang == $clang;
+	}
 
-	function isFileCacheGood( $timestamp ) {
+	/* 
+	* Check if up to date cache file exists
+	* @param $timestamp string
+	*/
+	public function isFileCacheGood( $timestamp = '' ) {
 		global $wgCacheEpoch;
 
 		if( !$this->isFileCached() ) return false;
 
 		$cachetime = $this->fileCacheTime();
-		$good = (( $timestamp <= $cachetime ) &&
-			 ( $wgCacheEpoch <= $cachetime ));
+		$good = $timestamp <= $cachetime && $wgCacheEpoch <= $cachetime;
 
-		wfDebug(" isFileCacheGood() - cachetime $cachetime, touched {$timestamp} epoch {$wgCacheEpoch}, good $good\n");
+		wfDebug( __METHOD__ . ": cachetime $cachetime, touched '{$timestamp}' epoch {$wgCacheEpoch}, good $good\n");
 		return $good;
 	}
 
-	function useGzip() {
+	public function useGzip() {
 		global $wgUseGzip;
 		return $wgUseGzip;
 	}
 
 	/* In handy string packages */
-	function fetchRawText() {
+	public function fetchRawText() {
 		return file_get_contents( $this->fileCacheName() );
 	}
 
-	function fetchPageText() {
+	public function fetchPageText() {
 		if( $this->useGzip() ) {
 			/* Why is there no gzfile_get_contents() or gzdecode()? */
 			return implode( '', gzfile( $this->fileCacheName() ) );
@@ -86,15 +133,17 @@ class HTMLFileCache {
 	}
 
 	/* Working directory to/from output */
-	function loadFromFileCache() {
+	public function loadFromFileCache() {
 		global $wgOut, $wgMimeType, $wgOutputEncoding, $wgContLanguageCode;
-		wfDebug(" loadFromFileCache()\n");
-
-		$filename=$this->fileCacheName();
-		$wgOut->sendCacheControl();
-
-		header( "Content-type: $wgMimeType; charset={$wgOutputEncoding}" );
-		header( "Content-language: $wgContLanguageCode" );
+		wfDebug( __METHOD__ . "()\n");
+		$filename = $this->fileCacheName();
+		// Raw pages should handle cache control on their own,
+		// even when using file cache. This reduces hits from clients.
+		if( $this->mType !== 'raw' ) {
+			$wgOut->sendCacheControl();
+			header( "Content-Type: $wgMimeType; charset={$wgOutputEncoding}" );
+			header( "Content-Language: $wgContLanguageCode" );
+		}
 
 		if( $this->useGzip() ) {
 			if( wfClientAcceptsGzip() ) {
@@ -106,22 +155,26 @@ class HTMLFileCache {
 			}
 		}
 		readfile( $filename );
+		$wgOut->disable(); // tell $wgOut that output is taken care of
 	}
 
-	function checkCacheDirs() {
+	protected 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); }
+		wfMkdirParents( $mydir1 );
+		wfMkdirParents( $mydir2 );
 	}
 
-	function saveToFileCache( $origtext ) {
-		$text = $origtext;
-		if(strcmp($text,'') == 0) return '';
+	public function saveToFileCache( $text ) {
+		global $wgUseFileCache;
+		if( !$wgUseFileCache || strlen( $text ) < 512 ) {
+			// Disabled or empty/broken output (OOM and PHP errors)
+			return $text;
+		}
 
-		wfDebug(" saveToFileCache()\n", false);
+		wfDebug( __METHOD__ . "()\n", false);
 
 		$this->checkCacheDirs();
 
@@ -154,6 +207,13 @@ class HTMLFileCache {
 		return $text;
 	}
 
+	public static function clearFileCache( $title ) {
+		global $wgUseFileCache;
+		if( !$wgUseFileCache ) return false;
+		$fc = new self( $title, 'view' );
+		@unlink( $fc->fileCacheName() );
+		$fc = new self( $title, 'raw' );
+		@unlink( $fc->fileCacheName() );
+		return true;
+	}
 }
-
-?>