--- /dev/null
+<?php
+/**
+ * Contain the HTMLFileCache class
+ * @file
+ * @ingroup Cache
+ */
+abstract class FileCacheBase {
+ protected $mKey;
+ protected $mType;
+ protected $mExt;
+ protected $mFilePath;
+ protected $mUseGzip;
+
+ protected function __construct() {
+ global $wgUseGzip;
+
+ $this->mUseGzip = (bool)$wgUseGzip;
+ $this->mExt = 'cache';
+ }
+
+ /**
+ * Get the base cache directory (not speficic to this file)
+ * @return string
+ */
+ abstract protected function cacheDirectory();
+
+ /**
+ * Get the path to the cache file
+ * @return string
+ */
+ protected function cachePath() {
+ if ( $this->mFilePath !== null ) {
+ return $this->mFilePath;
+ }
+
+ $dir = $this->cacheDirectory();
+ $subDirs = $this->mType . '/' . $this->hashSubdirectory(); // includes '/'
+ # Avoid extension confusion
+ $key = str_replace( '.', '%2E', urlencode( $this->mKey ) );
+ # Build the full file path
+ $this->mFilePath = "{$dir}/{$subDirs}{$key}.{$this->mExt}";
+ if ( $this->useGzip() ) {
+ $this->mFilePath .= '.gz';
+ }
+
+ return $this->mFilePath;
+ }
+
+ /**
+ * Check if the cache file exists
+ * @return bool
+ */
+ public function isCached() {
+ return file_exists( $this->cachePath() );
+ }
+
+ /**
+ * Get the last-modified timestamp of the cache file
+ * @return string|false TS_MW timestamp
+ */
+ public function cacheTimestamp() {
+ $timestamp = filemtime( $this->cachePath() );
+ return ( $timestamp !== false )
+ ? wfTimestamp( TS_MW, $timestamp )
+ : false;
+ }
+
+ /**
+ * Check if up to date cache file exists
+ * @param $timestamp string MW_TS timestamp
+ *
+ * @return bool
+ */
+ public function isCacheGood( $timestamp = '' ) {
+ global $wgCacheEpoch;
+
+ if ( !$this->isCached() ) {
+ return false;
+ }
+
+ $cachetime = $this->cacheTimestamp();
+ $good = ( $timestamp <= $cachetime && $wgCacheEpoch <= $cachetime );
+ wfDebug( __METHOD__ . ": cachetime $cachetime, touched '{$timestamp}' epoch {$wgCacheEpoch}, good $good\n");
+
+ return $good;
+ }
+
+ /**
+ * Check if the cache is gzipped
+ * @return bool
+ */
+ protected function useGzip() {
+ return $this->mUseGzip;
+ }
+
+ /**
+ * Get the uncompressed text from the cache
+ * @return string
+ */
+ public function fetchText() {
+ if ( $this->useGzip() ) {
+ /* Why is there no gzfile_get_contents() or gzdecode()? */
+ return implode( '', gzfile( $this->cachePath() ) );
+ } else {
+ return file_get_contents( $this->cachePath() );
+ }
+ }
+
+ /**
+ * Save and compress text to the cache
+ * @return string compressed text
+ */
+ public function saveText( $text ) {
+ global $wgUseFileCache;
+ if ( !$wgUseFileCache ) {
+ return false;
+ }
+
+ if ( $this->useGzip() ) {
+ $text = gzencode( $text );
+ }
+
+ $this->checkCacheDirs(); // build parent dir
+ if ( !file_put_contents( $this->cachePath(), $text ) ) {
+ return false;
+ }
+
+ return $text;
+ }
+
+ /*
+ * Clear the cache for this page
+ * @return void
+ */
+ public function clearCache() {
+ wfSuppressWarnings();
+ unlink( $this->cachePath() );
+ wfRestoreWarnings();
+ }
+
+ /*
+ * Create parent directors of $this->cachePath()
+ * @TODO: why call wfMkdirParents() twice?
+ * @return void
+ */
+ protected function checkCacheDirs() {
+ $filename = $this->cachePath();
+ $mydir2 = substr( $filename, 0, strrpos( $filename, '/') ); # subdirectory level 2
+ $mydir1 = substr( $mydir2, 0, strrpos( $mydir2, '/') ); # subdirectory level 1
+
+ wfMkdirParents( $mydir1, null, __METHOD__ );
+ wfMkdirParents( $mydir2, null, __METHOD__ );
+ }
+
+ /*
+ * Return relative multi-level hash subdirectory with the trailing
+ * slash or the empty string if $wgFileCacheDepth is off
+ * @return string
+ */
+ protected function hashSubdirectory() {
+ global $wgFileCacheDepth;
+
+ $subdir = '';
+ if ( $wgFileCacheDepth > 0 ) {
+ $hash = md5( $this->mKey );
+ for ( $i = 1; $i <= $wgFileCacheDepth; $i++ ) {
+ $subdir .= substr( $hash, 0, $i ) . '/';
+ }
+ }
+
+ return $subdir;
+ }
+}
* @file
* @ingroup Cache
*/
+class HTMLFileCache extends FileCacheBase {
-/**
- * Handles talking to the file cache, putting stuff in and taking it back out.
- * Mostly called from Article.php for the emergency abort/fallback to cache.
- *
- * Global options that affect this module:
- * - $wgCachePages
- * - $wgCacheEpoch
- * - $wgUseFileCache
- * - $wgCacheDirectory
- * - $wgFileCacheDirectory
- * - $wgUseGzip
- *
- * @ingroup Cache
- */
-class HTMLFileCache {
+ public static function newFromTitle( Title $title, $action ) {
+ $cache = new self();
- /**
- * @var Title
- */
- var $mTitle;
- var $mFileCache, $mType;
+ $allowedTypes = self::cacheablePageActions();
+ if ( !in_array( $action, $allowedTypes ) ) {
+ throw new MWException( "Invalid filecache type given." );
+ }
+ $cache->mKey = $title->getPrefixedDBkey();
+ $cache->mType = (string)$action;
+ $cache->mExt = 'html';
- public function __construct( $title, $type = 'view' ) {
- $this->mTitle = $title;
- $this->mType = in_array( $type, self::cacheableActions() ) ? $type : false;
- $this->fileCacheName(); // init name
+ return $cache;
}
- protected static function cacheableActions() {
+ /*
+ * Cacheable actions
+ * @return array
+ */
+ protected static function cacheablePageActions() {
return array( 'view', 'history' );
}
- public function fileCacheName() {
- if( !$this->mFileCache ) {
- global $wgCacheDirectory, $wgFileCacheDirectory, $wgFileCacheDepth;
-
- 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 other views of aspects of pages elsewhere
- $subdir = ($this->mType === 'view') ? '' : "{$this->mType}/";
-
- $key = $this->mTitle->getPrefixedDbkey();
- if ( $wgFileCacheDepth > 0 ) {
- $hash = md5( $key );
- for ( $i = 1; $i <= $wgFileCacheDepth; $i++ ) {
- $subdir .= substr( $hash, 0, $i ) . '/';
- }
- }
- # Avoid extension confusion
- $key = str_replace( '.', '%2E', urlencode( $key ) );
- $this->mFileCache = "{$dir}/{$subdir}{$key}.html";
-
- if( $this->useGzip() ) {
- $this->mFileCache .= '.gz';
- }
-
- wfDebug( __METHOD__ . ": {$this->mFileCache}\n" );
- }
- return $this->mFileCache;
- }
-
- public function isFileCached() {
- if( $this->mType === false ) {
- return false;
+ /**
+ * Get the base file cache directory
+ * @return string
+ */
+ protected function cacheDirectory() {
+ global $wgCacheDirectory, $wgFileCacheDirectory, $wgFileCacheDepth;
+ if ( $wgFileCacheDirectory ) {
+ $dir = $wgFileCacheDirectory;
+ } elseif ( $wgCacheDirectory ) {
+ $dir = "$wgCacheDirectory/object";
+ } else {
+ throw new MWException( 'Please set $wgCacheDirectory in LocalSettings.php if you wish to use the HTML file cache' );
}
- return file_exists( $this->fileCacheName() );
- }
-
- public function fileCacheTime() {
- return wfTimestamp( TS_MW, filemtime( $this->fileCacheName() ) );
+ return $dir;
}
/**
* Check if pages can be cached for this request/user
+ * @param $context RequestContext
* @return bool
*/
- public static function useFileCache() {
- global $wgUser, $wgUseFileCache, $wgShowIPinHeader, $wgRequest, $wgLang, $wgContLang;
- if( !$wgUseFileCache ) {
+ public static function useFileCache( RequestContext $context ) {
+ global $wgUseFileCache, $wgShowIPinHeader, $wgContLang;
+ if ( !$wgUseFileCache ) {
return false;
}
// Get all query values
- $queryVals = $wgRequest->getValues();
- foreach( $queryVals as $query => $val ) {
- if( $query == 'title' || $query == 'curid' ) {
+ $queryVals = $context->getRequest()->getValues();
+ foreach ( $queryVals as $query => $val ) {
+ if ( $query == 'title' || $query == 'curid' ) {
continue; // note: curid sets title
// Normal page view in query form can have action=view.
// Raw hits for pages also stored, like .css pages for example.
- } elseif( $query == 'action' && in_array( $val, self::cacheableActions() ) ) {
+ } elseif ( $query == 'action' && in_array( $val, self::cacheablePageActions() ) ) {
continue;
// Below are header setting params
- } elseif( $query == 'maxage' || $query == 'smaxage' ) {
+ } elseif ( $query == 'maxage' || $query == 'smaxage' ) {
continue;
} else {
return false;
}
}
+ $user = $context->getUser();
// Check for non-standard user language; this covers uselang,
// and extensions for auto-detecting user language.
- $ulang = $wgLang->getCode();
+ $ulang = $context->getLang()->getCode();
$clang = $wgContLang->getCode();
// Check that there are no other sources of variation
- return !$wgShowIPinHeader && !$wgUser->getId() && !$wgUser->getNewtalk() && $ulang == $clang;
+ return !$wgShowIPinHeader && !$user->getId() && !$user->getNewtalk() && $ulang == $clang;
}
/**
- * Check if up to date cache file exists
- * @param $timestamp string
- *
- * @return bool
+ * Read from cache to context output
+ * @param $context RequestContext
+ * @return void
*/
- public function isFileCacheGood( $timestamp = '' ) {
- global $wgCacheEpoch;
-
- if( !$this->isFileCached() ) {
- return false;
- }
-
- $cachetime = $this->fileCacheTime();
- $good = $timestamp <= $cachetime && $wgCacheEpoch <= $cachetime;
-
- wfDebug( __METHOD__ . ": cachetime $cachetime, touched '{$timestamp}' epoch {$wgCacheEpoch}, good $good\n");
- return $good;
- }
-
- public function useGzip() {
- global $wgUseGzip;
- return $wgUseGzip;
- }
-
- /* In handy string packages */
- public function fetchRawText() {
- return file_get_contents( $this->fileCacheName() );
- }
+ public function loadFromFileCache( RequestContext $context ) {
+ global $wgMimeType, $wgLanguageCode;
- public function fetchPageText() {
- if( $this->useGzip() ) {
- /* Why is there no gzfile_get_contents() or gzdecode()? */
- return implode( '', gzfile( $this->fileCacheName() ) );
- } else {
- return $this->fetchRawText();
- }
- }
-
- /* Working directory to/from output */
- public function loadFromFileCache() {
- global $wgOut, $wgMimeType, $wgLanguageCode;
wfDebug( __METHOD__ . "()\n");
- $filename = $this->fileCacheName();
- $wgOut->sendCacheControl();
+ $filename = $this->cachePath();
+ $context->getOutput()->sendCacheControl();
header( "Content-Type: $wgMimeType; charset=UTF-8" );
header( "Content-Language: $wgLanguageCode" );
- if( $this->useGzip() ) {
- if( wfClientAcceptsGzip() ) {
+ if ( $this->useGzip() ) {
+ if ( wfClientAcceptsGzip() ) {
header( 'Content-Encoding: gzip' );
} else {
/* Send uncompressed */
}
}
readfile( $filename );
- $wgOut->disable(); // tell $wgOut that output is taken care of
- }
-
- protected function checkCacheDirs() {
- $filename = $this->fileCacheName();
- $mydir2 = substr($filename,0,strrpos($filename,'/')); # subdirectory level 2
- $mydir1 = substr($mydir2,0,strrpos($mydir2,'/')); # subdirectory level 1
-
- wfMkdirParents( $mydir1, null, __METHOD__ );
- wfMkdirParents( $mydir2, null, __METHOD__ );
+ $context->getOutput()->disable(); // tell $wgOut that output is taken care of
}
+ /**
+ * Save this cache object with the given text.
+ * Use this as an ob_start() handler.
+ * @param $text string
+ * @return bool Whether $wgUseFileCache is enabled
+ */
public function saveToFileCache( $text ) {
global $wgUseFileCache;
- if( !$wgUseFileCache || strlen( $text ) < 512 ) {
+
+ if ( !$wgUseFileCache || strlen( $text ) < 512 ) {
// Disabled or empty/broken output (OOM and PHP errors)
return $text;
}
wfDebug( __METHOD__ . "()\n", false);
- $this->checkCacheDirs();
+ $now = wfTimestampNow();
+ if ( $this->useGzip() ) {
+ $text = str_replace(
+ '</html>', '<!-- Cached/compressed '.$now." -->\n</html>", $text );
+ } else {
+ $text = str_replace(
+ '</html>', '<!-- Cached '.$now." -->\n</html>", $text );
+ }
- $f = fopen( $this->fileCacheName(), 'w' );
- if($f) {
- $now = wfTimestampNow();
- if( $this->useGzip() ) {
- $rawtext = str_replace( '</html>',
- '<!-- Cached/compressed '.$now." -->\n</html>",
- $text );
- $text = gzencode( $rawtext );
- } else {
- $text = str_replace( '</html>',
- '<!-- Cached '.$now." -->\n</html>",
- $text );
- }
- fwrite( $f, $text );
- fclose( $f );
- if( $this->useGzip() ) {
- if( wfClientAcceptsGzip() ) {
- header( 'Content-Encoding: gzip' );
- return $text;
- } else {
- return $rawtext;
- }
+ // Store text to FS...
+ $compressed = $this->saveText( $text );
+ if ( $compressed === false ) {
+ return $text; // error
+ }
+
+ // gzip output to buffer as needed and set headers...
+ if ( $this->useGzip() ) {
+ // @TODO: ugly wfClientAcceptsGzip() function - use context!
+ if ( wfClientAcceptsGzip() ) {
+ header( 'Content-Encoding: gzip' );
+ return $compressed;
} else {
return $text;
}
+ } else {
+ return $text;
}
- return $text;
}
- public static function clearFileCache( $title ) {
+ /**
+ * Clear the file caches for a page for all actions
+ * @param $title Title
+ * @return bool Whether $wgUseFileCache is enabled
+ */
+ public static function clearFileCache( Title $title ) {
global $wgUseFileCache;
if ( !$wgUseFileCache ) {
return false;
}
- wfSuppressWarnings();
- foreach( self::cacheableActions() as $type ) {
- $fc = new self( $title, $type );
- unlink( $fc->fileCacheName() );
+ foreach ( self::cacheablePageActions() as $type ) {
+ $fc = self::newFromTitle( $title, $type );
+ $fc->clearCache();
}
- wfRestoreWarnings();
return true;
}
dépôts / lhc / web / wiklou.git / commitdiff