3 * Page view caching in the file system.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
25 * Page view caching in the file system.
26 * The only cacheable actions are "view" and "history". Also special pages
31 class HTMLFileCache
extends FileCacheBase
{
33 * Construct an ObjectFileCache from a Title and an action
34 * @param Title|string $title Title object or prefixed DB key string
35 * @param string $action
37 * @return HTMLFileCache
39 * @deprecated Since 1.24, instantiate this class directly
41 public static function newFromTitle( $title, $action ) {
42 return new self( $title, $action );
46 * @param Title|string $title Title object or prefixed DB key string
47 * @param string $action
50 public function __construct( $title, $action ) {
51 $allowedTypes = self
::cacheablePageActions();
52 if ( !in_array( $action, $allowedTypes ) ) {
53 throw new MWException( 'Invalid file cache type given.' );
55 $this->mKey
= ( $title instanceof Title
)
56 ?
$title->getPrefixedDBkey()
58 $this->mType
= (string)$action;
66 protected static function cacheablePageActions() {
67 return array( 'view', 'history' );
71 * Get the base file cache directory
74 protected function cacheDirectory() {
75 return $this->baseCacheDirectory(); // no subdir for b/c with old cache files
79 * Get the cache type subdirectory (with the trailing slash) or the empty string
80 * Alter the type -> directory mapping to put action=view cache at the root.
84 protected function typeSubdirectory() {
85 if ( $this->mType
=== 'view' ) {
86 return ''; // b/c to not skip existing cache
88 return $this->mType
. '/';
93 * Check if pages can be cached for this request/user
94 * @param IContextSource $context
97 public static function useFileCache( IContextSource
$context ) {
98 global $wgUseFileCache, $wgShowIPinHeader, $wgDebugToolbar, $wgContLang;
99 if ( !$wgUseFileCache ) {
102 if ( $wgShowIPinHeader ||
$wgDebugToolbar ) {
103 wfDebug( "HTML file cache skipped. Either \$wgShowIPinHeader and/or \$wgDebugToolbar on\n" );
108 // Get all query values
109 $queryVals = $context->getRequest()->getValues();
110 foreach ( $queryVals as $query => $val ) {
111 if ( $query === 'title' ||
$query === 'curid' ) {
112 continue; // note: curid sets title
113 // Normal page view in query form can have action=view.
114 } elseif ( $query === 'action' && in_array( $val, self
::cacheablePageActions() ) ) {
116 // Below are header setting params
117 } elseif ( $query === 'maxage' ||
$query === 'smaxage' ) {
123 $user = $context->getUser();
124 // Check for non-standard user language; this covers uselang,
125 // and extensions for auto-detecting user language.
126 $ulang = $context->getLanguage()->getCode();
127 $clang = $wgContLang->getCode();
129 // Check that there are no other sources of variation
130 return !$user->getId() && !$user->getNewtalk() && $ulang == $clang;
134 * Read from cache to context output
135 * @param IContextSource $context
138 public function loadFromFileCache( IContextSource
$context ) {
139 global $wgMimeType, $wgLanguageCode;
141 wfDebug( __METHOD__
. "()\n" );
142 $filename = $this->cachePath();
144 $context->getOutput()->sendCacheControl();
145 header( "Content-Type: $wgMimeType; charset=UTF-8" );
146 header( "Content-Language: $wgLanguageCode" );
147 if ( $this->useGzip() ) {
148 if ( wfClientAcceptsGzip() ) {
149 header( 'Content-Encoding: gzip' );
150 readfile( $filename );
152 /* Send uncompressed */
153 wfDebug( __METHOD__
. " uncompressing cache file and sending it\n" );
154 readgzfile( $filename );
157 readfile( $filename );
159 $context->getOutput()->disable(); // tell $wgOut that output is taken care of
163 * Save this cache object with the given text.
164 * Use this as an ob_start() handler.
165 * @param string $text
166 * @return bool Whether $wgUseFileCache is enabled
168 public function saveToFileCache( $text ) {
169 global $wgUseFileCache;
171 if ( !$wgUseFileCache ||
strlen( $text ) < 512 ) {
172 // Disabled or empty/broken output (OOM and PHP errors)
176 wfDebug( __METHOD__
. "()\n", 'log' );
178 $now = wfTimestampNow();
179 if ( $this->useGzip() ) {
181 '</html>', '<!-- Cached/compressed ' . $now . " -->\n</html>", $text );
184 '</html>', '<!-- Cached ' . $now . " -->\n</html>", $text );
187 // Store text to FS...
188 $compressed = $this->saveText( $text );
189 if ( $compressed === false ) {
190 return $text; // error
193 // gzip output to buffer as needed and set headers...
194 if ( $this->useGzip() ) {
195 // @todo Ugly wfClientAcceptsGzip() function - use context!
196 if ( wfClientAcceptsGzip() ) {
197 header( 'Content-Encoding: gzip' );
209 * Clear the file caches for a page for all actions
210 * @param Title $title
211 * @return bool Whether $wgUseFileCache is enabled
213 public static function clearFileCache( Title
$title ) {
214 global $wgUseFileCache;
216 if ( !$wgUseFileCache ) {
220 foreach ( self
::cacheablePageActions() as $type ) {
221 $fc = new self( $title, $type );