MediaWiki REL1_30
HTMLFileCache.php
Go to the documentation of this file.
1<?php
25
34 const MODE_NORMAL = 0; // normal cache mode
35 const MODE_OUTAGE = 1; // fallback cache for DB outages
36 const MODE_REBUILD = 2; // background cache rebuild mode
37
43 public function __construct( $title, $action ) {
44 parent::__construct();
45
46 $allowedTypes = self::cacheablePageActions();
47 if ( !in_array( $action, $allowedTypes ) ) {
48 throw new MWException( 'Invalid file cache type given.' );
49 }
50 $this->mKey = ( $title instanceof Title )
51 ? $title->getPrefixedDBkey()
52 : (string)$title;
53 $this->mType = (string)$action;
54 $this->mExt = 'html';
55 }
56
61 protected static function cacheablePageActions() {
62 return [ 'view', 'history' ];
63 }
64
69 protected function cacheDirectory() {
70 return $this->baseCacheDirectory(); // no subdir for b/c with old cache files
71 }
72
79 protected function typeSubdirectory() {
80 if ( $this->mType === 'view' ) {
81 return ''; // b/c to not skip existing cache
82 } else {
83 return $this->mType . '/';
84 }
85 }
86
93 public static function useFileCache( IContextSource $context, $mode = self::MODE_NORMAL ) {
94 $config = MediaWikiServices::getInstance()->getMainConfig();
95
96 if ( !$config->get( 'UseFileCache' ) && $mode !== self::MODE_REBUILD ) {
97 return false;
98 } elseif ( $config->get( 'DebugToolbar' ) ) {
99 wfDebug( "HTML file cache skipped. \$wgDebugToolbar on\n" );
100
101 return false;
102 }
103
104 // Get all query values
105 $queryVals = $context->getRequest()->getValues();
106 foreach ( $queryVals as $query => $val ) {
107 if ( $query === 'title' || $query === 'curid' ) {
108 continue; // note: curid sets title
109 // Normal page view in query form can have action=view.
110 } elseif ( $query === 'action' && in_array( $val, self::cacheablePageActions() ) ) {
111 continue;
112 // Below are header setting params
113 } elseif ( $query === 'maxage' || $query === 'smaxage' ) {
114 continue;
115 }
116
117 return false;
118 }
119
120 $user = $context->getUser();
121 // Check for non-standard user language; this covers uselang,
122 // and extensions for auto-detecting user language.
123 $ulang = $context->getLanguage();
124
125 // Check that there are no other sources of variation
126 if ( $user->getId() || $ulang->getCode() !== $config->get( 'LanguageCode' ) ) {
127 return false;
128 }
129
130 if ( $mode === self::MODE_NORMAL ) {
131 if ( $user->getNewtalk() ) {
132 return false;
133 }
134 }
135
136 // Allow extensions to disable caching
137 return Hooks::run( 'HTMLFileCache::useFileCache', [ $context ] );
138 }
139
146 public function loadFromFileCache( IContextSource $context, $mode = self::MODE_NORMAL ) {
148 $config = MediaWikiServices::getInstance()->getMainConfig();
149
150 wfDebug( __METHOD__ . "()\n" );
151 $filename = $this->cachePath();
152
153 if ( $mode === self::MODE_OUTAGE ) {
154 // Avoid DB errors for queries in sendCacheControl()
155 $context->getTitle()->resetArticleID( 0 );
156 }
157
158 $context->getOutput()->sendCacheControl();
159 header( "Content-Type: {$config->get( 'MimeType' )}; charset=UTF-8" );
160 header( "Content-Language: {$wgContLang->getHtmlCode()}" );
161 if ( $this->useGzip() ) {
162 if ( wfClientAcceptsGzip() ) {
163 header( 'Content-Encoding: gzip' );
164 readfile( $filename );
165 } else {
166 /* Send uncompressed */
167 wfDebug( __METHOD__ . " uncompressing cache file and sending it\n" );
168 readgzfile( $filename );
169 }
170 } else {
171 readfile( $filename );
172 }
173
174 $context->getOutput()->disable(); // tell $wgOut that output is taken care of
175 }
176
189 public function saveToFileCache( $text ) {
190 if ( strlen( $text ) < 512 ) {
191 // Disabled or empty/broken output (OOM and PHP errors)
192 return $text;
193 }
194
195 wfDebug( __METHOD__ . "()\n", 'private' );
196
197 $now = wfTimestampNow();
198 if ( $this->useGzip() ) {
199 $text = str_replace(
200 '</html>', '<!-- Cached/compressed ' . $now . " -->\n</html>", $text );
201 } else {
202 $text = str_replace(
203 '</html>', '<!-- Cached ' . $now . " -->\n</html>", $text );
204 }
205
206 // Store text to FS...
207 $compressed = $this->saveText( $text );
208 if ( $compressed === false ) {
209 return $text; // error
210 }
211
212 // gzip output to buffer as needed and set headers...
213 if ( $this->useGzip() ) {
214 // @todo Ugly wfClientAcceptsGzip() function - use context!
215 if ( wfClientAcceptsGzip() ) {
216 header( 'Content-Encoding: gzip' );
217
218 return $compressed;
219 } else {
220 return $text;
221 }
222 } else {
223 return $text;
224 }
225 }
226
232 public static function clearFileCache( Title $title ) {
233 $config = MediaWikiServices::getInstance()->getMainConfig();
234
235 if ( !$config->get( 'UseFileCache' ) ) {
236 return false;
237 }
238
239 foreach ( self::cacheablePageActions() as $type ) {
240 $fc = new self( $title, $type );
241 $fc->clearCache();
242 }
243
244 return true;
245 }
246}
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
wfClientAcceptsGzip( $force=false)
Whether the client accept gzip encoding.
Base class for data storage in the file system.
useGzip()
Check if the cache is gzipped.
cachePath()
Get the path to the cache file.
saveText( $text)
Save and compress text to the cache.
baseCacheDirectory()
Get the base file cache directory.
Page view caching in the file system.
static useFileCache(IContextSource $context, $mode=self::MODE_NORMAL)
Check if pages can be cached for this request/user.
loadFromFileCache(IContextSource $context, $mode=self::MODE_NORMAL)
Read from cache to context output.
saveToFileCache( $text)
Save this cache object with the given text.
cacheDirectory()
Get the base file cache directory.
static clearFileCache(Title $title)
Clear the file caches for a page for all actions.
typeSubdirectory()
Get the cache type subdirectory (with the trailing slash) or the empty string Alter the type -> direc...
static cacheablePageActions()
Cacheable actions.
__construct( $title, $action)
MediaWiki exception.
MediaWikiServices is the service locator for the application scope of MediaWiki.
getTitle()
Get the Title object that we'll be acting on, as specified in the WebRequest.
Represents a title within MediaWiki.
Definition Title.php:39
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition design.txt:57
when a variable name is used in a it is silently declared as a new local masking the global
Definition design.txt:95
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
Definition hooks.txt:181
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition hooks.txt:2780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:962
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition hooks.txt:1610
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:247
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition injection.txt:37
Interface for objects which can provide a MediaWiki context on request.