View source for Manual:File cache

<languages />
<translate>
<!--T:1-->
MediaWiki has an optional simplistic scheme for caching the rendered HTML of article pages.

== Operation and usage == <!--T:2-->
</translate>
<translate><!--T:94--> The file cache serves anonymous users only and they see the same HTML rendered.</translate> 
<translate><!--T:95--> Logged-in users don't benefit from this cache because their page contains user name, selected skin, etc.</translate>

<translate>
<!--T:3-->
The '''file cache''' is enabled by setting <tvar name=1>{{ll|Manual:$wgUseFileCache|$wgUseFileCache}}</tvar> and <tvar name=2>{{ll|Manual:$wgFileCacheDirectory|$wgFileCacheDirectory}}</tvar> variables in LocalSettings.php:
</translate>

<syntaxhighlight lang="php">
$wgUseFileCache = true; // <translate nowrap><!--T:55--> default:</translate> false
$wgFileCacheDirectory = "$IP/images/cache"; // <translate nowrap><!--T:56--> default: <tvar name=cache>"{$wgUploadDirectory}/cache"</tvar> which equals to <tvar name=default>"$IP/images/cache"</tvar></translate>
</syntaxhighlight>

<translate>
<!--T:5-->
This causes the rendered HTML webpage for each page of the wiki to be stored in an individual file on the hard disk. Any subsequent requests from anonymous users are met not by rendering the page again, but by simply sending the stored HTML version which is on the disk. This saves time.

<!--T:6-->
The generated HTML web text is stored to disk in directories under the <tvar name=FileCacheDirectory><code>$wgFileCacheDirectory</code></tvar> and looks somewhat like:
</translate>

<pre style="overflow:auto;">
-rw-r--r-- 1 apache apache 57421 Jan  7 01:58 cache/0/04/P%C3%A1gina_principal.html
-rw-r--r-- 1 apache apache 29608 Jan  4 16:37 cache/1/17/P%C3%A1gina_Riscada.html
-rw-r--r-- 1 apache apache 21592 Jan  3 07:27 cache/1/1c/P%C3%A1gina_Duplicada.html
-rw-r--r-- 1 apache apache 36088 Jan  7 02:03 cache/2/24/P%C3%A1gina_principal_alternativa.html
-rw-r--r-- 1 apache apache 44205 Jan  7 06:10 cache/a/a4/P%C3%A1gina_linkada.html
-rw-r--r-- 1 apache apache 24686 Jan  3 07:27 cache/d/db/P%C3%A1gina_Invertida.html
-rw-r--r-- 1 apache apache 17222 Jan  3 06:28 cache/f/f0/P%C3%A1gina_n%C3%A3o_encontrada.html
</pre>

<translate><!--T:7--> In this example, the file cache directory is ''cache/'' and the stored wiki pages are named ''Página ...'', yielding one corresponding ''Página_...''.html file for each.</translate>
<translate><!--T:96--> These files will be created as users visit articles on the wiki; you can create them all in one go with the <tvar name=1>{{ll|Manual:rebuildFileCache.php|rebuildFileCache.php}}</tvar> [[<tvar name=2>Special:MyLanguage/Manual:Maintenance scripts</tvar>|maintenance script]].</translate>

<translate>
<!--T:8-->
The file cache tends to cache aggressively; there is no set expiry date for the cached pages and pages are cached unconditionally even if they contain variables, extensions and other changeable output. Some extensions disable file cache for pages with dynamic content.

<!--T:9-->
Consider using <tvar name=1>{{ll|Manual:$wgUseGzip|$wgUseGzip}}</tvar> instead or in combination for much more effective results.

<!--T:10-->
For larger sites, the use of an external cache such as [[<tvar name=squid>Special:MyLanguage/Manual:Squid caching</tvar>|Squid]] or [[<tvar name=varnish>Special:MyLanguage/Manual:Varnish caching</tvar>|Varnish]] is preferable to enabling the file cache.

<!--T:11-->
If the file cache appears not to be working, make sure that the webserver has permission to write to the directory you chose.

== Limitations == <!--T:59-->
</translate>
<translate><!--T:60--> The file names of the cache files are determined by the according page titles.</translate>
<translate><!--T:61--> Depending on the language, which is used in the page titles, some characters in the file names will have to be encoded in order to make up a valid file name for the according file system.</translate>
<translate><!--T:62--> For languages like Arabic, Chinese and so on this may result in the following PHP warning:</translate>

<pre>PHP Warning:  file_put_contents(cache/......html.gz): failed to open stream: File name too long in includes/cache/FileCacheBase.php on line 171</pre>

<translate><!--T:63--> This is a known limitation.</translate>
<translate><!--T:65--> See <tvar name=1>{{phabricator|T148684}}</tvar>.</translate>

<translate><!--T:66--> Category and image description pages aren't purged from file cache.</translate>
<translate><!--T:67--> For example, adding or removing a page from a category doesn't update the category page, causing not logged in users to not see the changes in the category page.</translate>
<translate><!--T:68--> This is a known limitation.</translate>
<translate><!--T:69--> See <tvar name=1>{{phabricator|T26575}}</tvar></translate>

<translate>
== Domain and range == <!--T:12-->

<!--T:13-->
Caching is only done for users who:
* are not logged in.
* do not have their [[<tvar name=newtalk>Special:MyLanguage/user newtalk table</tvar>|user_newtalk]] flag active.

<!--T:14-->
Caching is only done for pages which:
* are not special pages.
* are not redirects.
* are being viewed in current version, plain view, no url parameters

<!--T:15-->
This covers the majority of requests to the wiki, but it is still important to set up [[<tvar name=1>Special:MyLanguage/Manual:Cache</tvar>|bytecode and application caching]] to handle the rest.

== Validation == <!--T:16-->

<!--T:17-->
The modification time of the cached file is compared with the global <tvar name=1><code>{{ll|Manual:$wgCacheEpoch|$wgCacheEpoch}}</code></tvar> timestamp set in <tvar name=2>{{ll|Manual:LocalSettings.php|LocalSettings.php}}</tvar> on each view.

<!--T:18-->
If the file is at least as new as both of these, it is considered valid and is sent directly to the client. If it is older or does not exist, parsing and rendering continues and the results are saved for future use.

=== Invalidation === <!--T:19-->

<!--T:20-->
The entire cache can be invalidated by setting <tvar name=1><code>$wgCacheEpoch</code></tvar> to the current time, or by deleting all files in the cache.
</translate>

<translate><!--T:21--> Individual pages are invalidated by updating their [[<tvar name=touched>Special:MyLanguage/Page table#page_touched</tvar>|page.page_touched]] fields, conveniently done by calling <tvar name=1>{{phpi|Title::invalidateCache()}}</tvar>.</translate>
<translate><!--T:70--> This should be done on article creation, edit saves, renames, and creation and deletion of linked articles (in order to update edit links).</translate>
<translate><!--T:71--> Invalidation operations that occur when editing templates, for example, check pages that use template to compare the cache date against page_touched.</translate>

<translate>
<!--T:22-->
Some cases are not yet handled properly, which probably includes:

<!--T:50-->
* browser 'reload' or 'refresh' (just reloads same cached page without updates)</translate>
<translate>
<!--T:51-->
* output variables from extensions such as <tvar name=1>{{ll|Extension:DynamicPageList}}</tvar> disable filecache for those pages to avoid stale data.</translate> <translate><!--T:72--> Those that don't will return stale data even on browser refresh.</translate>
<translate>
<!--T:52-->
* certain long error messages may be cached indefinitely as if they were valid page content; only ?action=purge will remove these from the file cache once stored.</translate> <translate><!--T:73--> A minimum output size threshold is used to avoid caching most errors, like fatal PHP errors.</translate>

<translate>
<!--T:53-->
Also see: <tvar name=InvalidateCacheOnLocalSettingsChange>{{ll|Manual:$wgInvalidateCacheOnLocalSettingsChange}}</tvar>.

=== Expiration === <!--T:54-->

<!--T:23-->
There should probably be some method of expiration of cache pages, particularly for pages containing variables (it is X date, we have X articles, etc).
</translate>

<translate><!--T:24--> If <tvar name=var>{{phpi|$parserOutput->getCacheTime()}}</tvar> is <tvar name=val><code>-1</code></tvar>, file caching will be disabled for the output of the page.</translate>
<translate><!--T:74--> There is no provision to set an expiry time, so all HTML for all pages is cached forever.</translate>
<translate><!--T:75--> An explicit <tvar name=action><code>?action=purge</code></tvar> command (or an edit to the page) will regenerate that one page, but neither the MediaWiki internal no-cache flags nor the browser refresh will remove outdated extension output once it has been stored as part of a file-cached page.</translate>

<translate>
== Refresh tab == <!--T:25-->

<!--T:26-->
It is possible to add a tab to force one individual page to be invalidated and refreshed by using ?action=purge using the [[<tvar name=ext-purge>Special:MyLanguage/Extension:Purge</tvar>|Purge page extension]].

== Compression == <!--T:27-->

<!--T:28-->
Optionally, the cache may be compressed to save space and bandwidth. (This requires that zlib be enabled in the [[<tvar name=1>Special:MyLanguage/PHP config</tvar>|PHP config]].)
</translate>

<syntaxhighlight lang="php">
$wgUseGzip = true;
</syntaxhighlight>

<translate><!--T:29--> If compression is enabled, the cache files are saved as .html.gz.</translate>
<translate><!--T:76--> Browsers that advertise support for gzip in their Accept-Encoding field will be given the gzipped version straight; for those browsers that don't, we unzip the data on the fly and send them the plaintext.</translate>

<translate><!--T:30--> A <tvar name=useragent>"Vary: User-agent"</tvar> header will be sent to tell proxy caches to be more careful about who it resends data to.</translate>
<translate><!--T:77--> ("<tvar name=acceptencod>Vary: Accept-encoding</tvar>" would be more appropriate, but Internet Explorer refuses to cache pages so marked.)</translate>

{{warning|1=<translate><!--T:31--> Do not enable <tvar name=UseGzip><code>{{ll|Manual:$wgUseGzip|$wgUseGzip}}</code></tvar> if you have output buffering enabled that gzips the content (via <tvar name=handler><code>ob_gzhandler</code></tvar> or <tvar name=compress><code>zlib.output_compression</code></tvar>). Doing so will result in gibberish being shown to users.</translate>}}

<translate>
== Emergency fallback == <!--T:32-->
</translate>
{{outdated}}
<translate>
<!--T:33-->
If the wiki can't contact the database server, it will try to show the cached version of whatever page was requested, regardless of whether it may be current or not, with a "<tvar name=down>database is down</tvar>" message tacked into it.

<!--T:34-->
This has some limitations:
</translate>

* <translate><!--T:78--> special pages are not covered in any way, there's just a warning message</translate>
* <translate><!--T:79--> '''redirect pages are not cached, so clicking a link to a redirect doesn't go through to the final destination'''</translate>
* <translate><!--T:80--> '''pages with colons in the title (other than for a valid namespace) may still fail due to MediaWiki checking the DB to see if the title has a valid interwiki prefix'''. This occurs only if there is no interwiki cache entry for the page's prefix (see <tvar name=InterwikiExpiry><code>{{ll|Manual:$wgInterwikiExpiry|$wgInterwikiExpiry}}</code></tvar>) or <tvar name=MainCacheType><code>{{ll|Manual:$wgMainCacheType|$wgMainCacheType}}</code></tvar> is falling back (or set to) <code>DB_CACHE</code>.</translate>
* <translate><!--T:81--> attempts to use non-view actions result in a plain page view, which may be confusing</translate>
* <translate><!--T:82--> there may be issues with the MySQL connection timeout which make it take prohibitively long before giving up, particularly if using persistent connections and the db dies later. Adjust mysql.connect_timeout (set to <tvar name=nb>3</tvar> or more) in php.ini to deal with this. Edit the webserver's php.ini not the cli php.ini.</translate>
* <translate><!--T:84--> fallback may fail if <tvar name=1><code>{{ll|Manual:$wgStatsMethod|$wgStatsMethod}}</code></tvar> is set to <tvar name=2><code>cache</code></tvar> and <tvar name=3><code>$wgMainCacheType</code></tvar> is falling back (or set to) <tvar name=4>DB_CACHE</tvar></translate>

<translate>

== Serving cached pages directly == <!--T:35-->

<!--T:36-->
By default, MediaWiki passes cache page with php. Here is how we use webserver configuration tricks to serve cached files directly without invoking MediaWiki or PHP at all.

<!--T:37-->
First, setting <tvar name=FileCacheDepth><code>{{ll|Manual:$wgFileCacheDepth|$wgFileCacheDepth}} = 0;</code></tvar>. Then we add rewrite rules. See below.

===Apache=== <!--T:38-->

<!--T:39-->
The following <tvar name=1>[http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html mod_rewrite]</tvar> rule has been found to work in an <tvar name=2><code>.htaccess</code></tvar> file on a shared webhost running Apache 2.2:
</translate>

<pre style="overflow:auto;">
RewriteBase /
# If a cached page exists under /w/html_cache, do an internal redirect to it:
RewriteCond %{HTTP_COOKIE} !UserID=
RewriteCond %{QUERY_STRING} !.
RewriteCond %{DOCUMENT_ROOT}/w/html_cache/$1.html -s
RewriteRule ^wiki/(.+)$ /w/html_cache/$1.html [B,L,NS]
</pre>

<translate><!--T:40--> However, this rewrite rule won't work properly for pages whose titles contain punctuation or non-ASCII characters.</translate>
<translate><!--T:85--> A tidy solution would be to use a RewriteMap, but this is not supported in .htaccess context.</translate>
<translate><!--T:86--> Instead, the following trick can be used to handle non-ASCII titles by pulling the URL-escaped title directly from the raw request line:</translate>

<pre style="overflow:auto;">
RewriteBase /
# If a cached page exists under /w/html_cache, do an internal redirect to it: 
RewriteCond %{HTTP_COOKIE} !UserID=
RewriteCond %{QUERY_STRING} !.
ReWriteCond %{THE_REQUEST} ^GET\x20/wiki/([^\x20/]+)\x20HTTP
RewriteCond %{DOCUMENT_ROOT}/w/html_cache/%1.html -s
RewriteRule ^wiki/(.+)$ /w/html_cache/%1.html [B,L,NS]
</pre>

The previous rewrite rules will handle requests of the form

<pre style="overflow:auto;">https://site/wiki/Page_Name</pre>

To handle requests where the Page_Name is in the QUERY_STRING like

<pre style="overflow:auto;">https://site/w/index.php?title=Page_Name</pre>

the following works:

<pre style="overflow:auto;">
RewriteCond %{HTTP_COOKIE} !UserID=
RewriteCond %{QUERY_STRING} ^title=([^&]+)$
RewriteCond %{DOCUMENT_ROOT}/images/cache/ns0\%3A%1.html -s
RewriteRule ^ /images/cache/ns0\%253A%1.html? [B,L,NS]
</pre>

<translate><!--T:41--> This will still not match titles containing periods, slashes or other punctuation which the file cache escapes but browsers don't (or vice versa).</translate>
<translate><!--T:87--> One should also ensure that the appropriate Vary header gets sent:</translate>

<pre style="overflow:auto;">Header append Vary Cookie</pre>

<translate><!--T:42--> Also note that, since this redirect trick bypasses MediaWiki entirely, it won't respect <tvar name=CacheEpoch><code>{{ll|Manual:$wgCacheEpoch|$wgCacheEpoch}}</code></tvar>.</translate>
<translate><!--T:88--> You may need to clear or rebuild the cache manually as needed instead.</translate>

<translate>
===Nginx=== <!--T:43-->

<!--T:44-->
Since the nginx configuration language is pretty limited (it doesn't allow nested if statements, for example), it requires the [<tvar name=ngxlua>http://wiki.nginx.org/HttpLuaModule</tvar> ngx_lua module].

<!--T:45-->
The following conf should be integrated inside your server block, and it assumes that:
</translate>

* <translate><!--T:89--> you're using fancy urls like example.com/Page;</translate>
* <translate><!--T:90--> your cache folder is inside your MediaWiki folder (default);</translate>
* <translate><!--T:91--> you're already proxying *.php files to php-fpm (or whatever) in the last location block.</translate>

<translate>
<!--T:46-->
And here are the limitations:
</translate>

* <translate><!--T:92--> as with the Apache solution, you have to run a cron job or manually rebuild the cache files when they change;</translate>
* <translate><!--T:93--> pages whose title include non-ASCII characters are served through PHP (which should be transparent to the user anyway).</translate>

<translate>
<!--T:47-->
Change paths as needed.
</translate>

<syntaxhighlight lang="lua" style="overflow:auto;">
 location ~ /cache/(.*) {
     internal;
 }
 
 location / {
     default_type 'text/html';
     rewrite_by_lua '
         local cookie = ngx.req.get_headers()["Cookie"] or ""
         if string.match(cookie, "UserID") then  -- if we are logged in...
             ngx.exec("@rewrite")
         else
             local page = string.sub(ngx.var.request_uri, 2, -1)  -- get the page name without the leading slash
             local filename = page .. ".html"
             local f = io.open("/var/www/w/cache/" .. filename, "r")
             if f ~= nil then  -- if the file exists, close it and serve it directly
                 io.close(f)
                 ngx.header["x-wiki-cache"] = "via nginx"  -- headers to help you debug
                 ngx.exec("/cache/" .. filename)
             else
                 ngx.header["x-wiki-cache"] = "via mediawiki"
                 ngx.exec("@rewrite")
             end
         end
     ';
 }
  
 location @rewrite {
     rewrite ^/([^?]*)(?:\?(.*))? /index.php?title=$1&$2 last;
 }
</syntaxhighlight>

<translate>
== Code stewardship == <!--T:97-->

</translate>
{{Component|mediawiki-core-http-cache}}

<translate>
==See also== <!--T:48-->
</translate>
* {{ll|Manual:Configuration settings}}

[[Category:MediaWiki development{{#translation:}}|File cache]]
[[Category:Cache{{#translation:}}|File cache]]
[[Category:Performance tuning{{#translation:}}]]