MediaWiki  1.28.0
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 
47  public static function newFromTitle( $title, $action ) {
48  return new self( $title, $action );
49  }
50 
56  public function __construct( $title, $action ) {
57  parent::__construct();
58 
59  $allowedTypes = self::cacheablePageActions();
60  if ( !in_array( $action, $allowedTypes ) ) {
61  throw new MWException( 'Invalid file cache type given.' );
62  }
63  $this->mKey = ( $title instanceof Title )
64  ? $title->getPrefixedDBkey()
65  : (string)$title;
66  $this->mType = (string)$action;
67  $this->mExt = 'html';
68  }
69 
74  protected static function cacheablePageActions() {
75  return [ 'view', 'history' ];
76  }
77 
82  protected function cacheDirectory() {
83  return $this->baseCacheDirectory(); // no subdir for b/c with old cache files
84  }
85 
92  protected function typeSubdirectory() {
93  if ( $this->mType === 'view' ) {
94  return ''; // b/c to not skip existing cache
95  } else {
96  return $this->mType . '/';
97  }
98  }
99 
106  public static function useFileCache( IContextSource $context, $mode = self::MODE_NORMAL ) {
107  $config = MediaWikiServices::getInstance()->getMainConfig();
108 
109  if ( !$config->get( 'UseFileCache' ) && $mode !== self::MODE_REBUILD ) {
110  return false;
111  } elseif ( $config->get( 'DebugToolbar' ) ) {
112  wfDebug( "HTML file cache skipped. \$wgDebugToolbar on\n" );
113 
114  return false;
115  }
116 
117  // Get all query values
118  $queryVals = $context->getRequest()->getValues();
119  foreach ( $queryVals as $query => $val ) {
120  if ( $query === 'title' || $query === 'curid' ) {
121  continue; // note: curid sets title
122  // Normal page view in query form can have action=view.
123  } elseif ( $query === 'action' && in_array( $val, self::cacheablePageActions() ) ) {
124  continue;
125  // Below are header setting params
126  } elseif ( $query === 'maxage' || $query === 'smaxage' ) {
127  continue;
128  }
129 
130  return false;
131  }
132 
133  $user = $context->getUser();
134  // Check for non-standard user language; this covers uselang,
135  // and extensions for auto-detecting user language.
136  $ulang = $context->getLanguage();
137 
138  // Check that there are no other sources of variation
139  if ( $user->getId() || $ulang->getCode() !== $config->get( 'LanguageCode' ) ) {
140  return false;
141  }
142 
143  if ( $mode === self::MODE_NORMAL ) {
144  if ( $user->getNewtalk() ) {
145  return false;
146  }
147  }
148 
149  // Allow extensions to disable caching
150  return Hooks::run( 'HTMLFileCache::useFileCache', [ $context ] );
151  }
152 
159  public function loadFromFileCache( IContextSource $context, $mode = self::MODE_NORMAL ) {
161  $config = MediaWikiServices::getInstance()->getMainConfig();
162 
163  wfDebug( __METHOD__ . "()\n" );
164  $filename = $this->cachePath();
165 
166  if ( $mode === self::MODE_OUTAGE ) {
167  // Avoid DB errors for queries in sendCacheControl()
168  $context->getTitle()->resetArticleID( 0 );
169  }
170 
171  $context->getOutput()->sendCacheControl();
172  header( "Content-Type: {$config->get( 'MimeType' )}; charset=UTF-8" );
173  header( "Content-Language: {$wgContLang->getHtmlCode()}" );
174  if ( $this->useGzip() ) {
175  if ( wfClientAcceptsGzip() ) {
176  header( 'Content-Encoding: gzip' );
177  readfile( $filename );
178  } else {
179  /* Send uncompressed */
180  wfDebug( __METHOD__ . " uncompressing cache file and sending it\n" );
181  readgzfile( $filename );
182  }
183  } else {
184  readfile( $filename );
185  }
186 
187  $context->getOutput()->disable(); // tell $wgOut that output is taken care of
188  }
189 
202  public function saveToFileCache( $text ) {
203  if ( strlen( $text ) < 512 ) {
204  // Disabled or empty/broken output (OOM and PHP errors)
205  return $text;
206  }
207 
208  wfDebug( __METHOD__ . "()\n", 'private' );
209 
210  $now = wfTimestampNow();
211  if ( $this->useGzip() ) {
212  $text = str_replace(
213  '</html>', '<!-- Cached/compressed ' . $now . " -->\n</html>", $text );
214  } else {
215  $text = str_replace(
216  '</html>', '<!-- Cached ' . $now . " -->\n</html>", $text );
217  }
218 
219  // Store text to FS...
220  $compressed = $this->saveText( $text );
221  if ( $compressed === false ) {
222  return $text; // error
223  }
224 
225  // gzip output to buffer as needed and set headers...
226  if ( $this->useGzip() ) {
227  // @todo Ugly wfClientAcceptsGzip() function - use context!
228  if ( wfClientAcceptsGzip() ) {
229  header( 'Content-Encoding: gzip' );
230 
231  return $compressed;
232  } else {
233  return $text;
234  }
235  } else {
236  return $text;
237  }
238  }
239 
245  public static function clearFileCache( Title $title ) {
246  $config = MediaWikiServices::getInstance()->getMainConfig();
247 
248  if ( !$config->get( 'UseFileCache' ) ) {
249  return false;
250  }
251 
252  foreach ( self::cacheablePageActions() as $type ) {
253  $fc = new self( $title, $type );
254  $fc->clearCache();
255  }
256 
257  return true;
258  }
259 }
saveText($text)
Save and compress text to the cache.
Interface for objects which can provide a MediaWiki context on request.
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:1555
$context
Definition: load.php:50
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static useFileCache(IContextSource $context, $mode=self::MODE_NORMAL)
Check if pages can be cached for this request/user.
static newFromTitle($title, $action)
Construct an HTMLFileCache object from a Title and an action.
baseCacheDirectory()
Get the base file cache directory.
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:177
Page view caching in the file system.
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 MediaWikiServices
Definition: injection.txt:23
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
static cacheablePageActions()
Cacheable actions.
loadFromFileCache(IContextSource $context, $mode=self::MODE_NORMAL)
Read from cache to context output.
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
getUser()
Get the User object.
typeSubdirectory()
Get the cache type subdirectory (with the trailing slash) or the empty string Alter the type -> direc...
static clearFileCache(Title $title)
Clear the file caches for a page for all actions.
wfClientAcceptsGzip($force=false)
Base class for data storage in the file system.
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
cachePath()
Get the path to the cache file.
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
getLanguage()
Get the Language object.
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
Definition: distributors.txt:9
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:242
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:35
saveToFileCache($text)
Save this cache object with the given text.
useGzip()
Check if the cache is gzipped.
__construct($title, $action)
getTitle()
Get the Title object.
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:56
cacheDirectory()
Get the base file cache directory.
getOutput()
Get the OutputPage object.
getRequest()
Get the WebRequest object.
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:2491