MediaWiki REL1_27
HTMLFileCache.php
Go to the documentation of this file.
1<?php
41 public static function newFromTitle( $title, $action ) {
42 return new self( $title, $action );
43 }
44
50 public function __construct( $title, $action ) {
51 parent::__construct();
52 $allowedTypes = self::cacheablePageActions();
53 if ( !in_array( $action, $allowedTypes ) ) {
54 throw new MWException( 'Invalid file cache type given.' );
55 }
56 $this->mKey = ( $title instanceof Title )
57 ? $title->getPrefixedDBkey()
58 : (string)$title;
59 $this->mType = (string)$action;
60 $this->mExt = 'html';
61 }
62
67 protected static function cacheablePageActions() {
68 return [ 'view', 'history' ];
69 }
70
75 protected function cacheDirectory() {
76 return $this->baseCacheDirectory(); // no subdir for b/c with old cache files
77 }
78
85 protected function typeSubdirectory() {
86 if ( $this->mType === 'view' ) {
87 return ''; // b/c to not skip existing cache
88 } else {
89 return $this->mType . '/';
90 }
91 }
92
98 public static function useFileCache( IContextSource $context ) {
100 if ( !$wgUseFileCache ) {
101 return false;
102 }
103 if ( $wgDebugToolbar ) {
104 wfDebug( "HTML file cache skipped. \$wgDebugToolbar on\n" );
105
106 return false;
107 }
108
109 // Get all query values
110 $queryVals = $context->getRequest()->getValues();
111 foreach ( $queryVals as $query => $val ) {
112 if ( $query === 'title' || $query === 'curid' ) {
113 continue; // note: curid sets title
114 // Normal page view in query form can have action=view.
115 } elseif ( $query === 'action' && in_array( $val, self::cacheablePageActions() ) ) {
116 continue;
117 // Below are header setting params
118 } elseif ( $query === 'maxage' || $query === 'smaxage' ) {
119 continue;
120 }
121
122 return false;
123 }
124 $user = $context->getUser();
125 // Check for non-standard user language; this covers uselang,
126 // and extensions for auto-detecting user language.
127 $ulang = $context->getLanguage()->getCode();
128 $clang = $wgContLang->getCode();
129
130 // Check that there are no other sources of variation
131 if ( $user->getId() || $user->getNewtalk() || $ulang != $clang ) {
132 return false;
133 }
134 // Allow extensions to disable caching
135 return Hooks::run( 'HTMLFileCache::useFileCache', [ $context ] );
136 }
137
145
146 wfDebug( __METHOD__ . "()\n" );
147 $filename = $this->cachePath();
148
149 $context->getOutput()->sendCacheControl();
150 header( "Content-Type: $wgMimeType; charset=UTF-8" );
151 header( "Content-Language: $wgLanguageCode" );
152 if ( $this->useGzip() ) {
153 if ( wfClientAcceptsGzip() ) {
154 header( 'Content-Encoding: gzip' );
155 readfile( $filename );
156 } else {
157 /* Send uncompressed */
158 wfDebug( __METHOD__ . " uncompressing cache file and sending it\n" );
159 readgzfile( $filename );
160 }
161 } else {
162 readfile( $filename );
163 }
164 $context->getOutput()->disable(); // tell $wgOut that output is taken care of
165 }
166
173 public function saveToFileCache( $text ) {
175
176 if ( !$wgUseFileCache || strlen( $text ) < 512 ) {
177 // Disabled or empty/broken output (OOM and PHP errors)
178 return $text;
179 }
180
181 wfDebug( __METHOD__ . "()\n", 'private' );
182
183 $now = wfTimestampNow();
184 if ( $this->useGzip() ) {
185 $text = str_replace(
186 '</html>', '<!-- Cached/compressed ' . $now . " -->\n</html>", $text );
187 } else {
188 $text = str_replace(
189 '</html>', '<!-- Cached ' . $now . " -->\n</html>", $text );
190 }
191
192 // Store text to FS...
193 $compressed = $this->saveText( $text );
194 if ( $compressed === false ) {
195 return $text; // error
196 }
197
198 // gzip output to buffer as needed and set headers...
199 if ( $this->useGzip() ) {
200 // @todo Ugly wfClientAcceptsGzip() function - use context!
201 if ( wfClientAcceptsGzip() ) {
202 header( 'Content-Encoding: gzip' );
203
204 return $compressed;
205 } else {
206 return $text;
207 }
208 } else {
209 return $text;
210 }
211 }
212
218 public static function clearFileCache( Title $title ) {
220
221 if ( !$wgUseFileCache ) {
222 return false;
223 }
224
225 foreach ( self::cacheablePageActions() as $type ) {
226 $fc = new self( $title, $type );
227 $fc->clearCache();
228 }
229
230 return true;
231 }
232}
$wgLanguageCode
Site language code.
$wgMimeType
The default Content-Type header.
$wgDebugToolbar
Display the new debugging toolbar.
$wgUseFileCache
This will cache static pages for non-logged-in users to reduce database traffic on public sites.
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)
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.
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.
static useFileCache(IContextSource $context)
Check if pages can be cached for this request/user.
typeSubdirectory()
Get the cache type subdirectory (with the trailing slash) or the empty string Alter the type -> direc...
loadFromFileCache(IContextSource $context)
Read from cache to context output.
static cacheablePageActions()
Cacheable actions.
__construct( $title, $action)
static newFromTitle( $title, $action)
Construct an ObjectFileCache from a Title and an action.
MediaWiki exception.
Represents a title within MediaWiki.
Definition Title.php:34
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
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:249
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:183
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition hooks.txt:2413
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:944
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:1458
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.
getOutput()
Get the OutputPage object.
$context
Definition load.php:44