DokuWiki

It's better when it's simple

User Tools

Site Tools


Sidebar

Translations of this page?:

Learn about DokuWiki

Advanced Use

Corporate Use

Our Community


Follow us on Facebook, Twitter and other social networks.

devel:caching

Caching

DokuWiki speeds up browsing through the wiki by caching parsed files. If a currently cached version of a document exists, this cached copy is delivered instead of parsing the data again. On editing and previewing no cache is used.

Purging the cache

To force the recaching of a single page just add the parameter purge to the URL. Example:

http://www.example.com/namespace/page?purge=true

Some of your URL might look like this ?id=pagename then use & between parameters:

http://localhost/dokuwiki/doku.php?id=my_page_name&purge=true

To force recaching of all pages, including page instructions, touch1) the local configuration file, conf/local.php. Saving the configuration settings form over the admin interface will have the same effect.

To only force recaching of page xhtml, touch inc/parser/xhtml.php.

To purge the editor toolbar (and other cached JavaScript) call

http://www.example.com/lib/exe/js.php?purge=true

and clean up your browser's cache as well. This especially helps if a new button introduced by a plugin does not show up.

You can also clear the CSS cache in the same way:

http://www.example.com/lib/exe/css.php?purge=true

Two-Stage-Caching

DokuWiki uses two cache files per page. To understand this you need to know that a page is parsed to an intermediate instruction format first before it is rendered to XHTML. DokuWiki caches both – the instructions and the rendered XHTML.

  • Instruction Cache
    The instruction cachefile only gets updated when the page, the config files2), some of DokuWiki's PHP files3) are changed or plugins are added/removed/enabled/disabled using the plugin manager.
  • XHTML Cache
    The XHTML cache is also affected by a maximum cache age setting (cachetime), its metadata, some more php files4), whenever the existence state of an internal link changes (i.e. the link target page is created or deleted) or when an RSS feed needs refreshing.

Location

The XHTML and instruction cache are located in data/cache/* 5). The files end in .xhtml, .i. Other files are also stored under the cache directory, including:

  • .feed — any rss feeds generated for the wiki
  • .code — portions of the page between <code> ... </code> tags after highlighting has been applied.

Metadata

DokuWiki can also store metadata e.g. additional information of pages. Metadata is generated from the Instruction Cache, of which the XHTML of a page is generated too. The metadata has its own caching mechanism.

Metadata can furthermore be added to the Metadata Index. Here is the added information searchable.

Images

To improve the performance for the user, DokuWiki tries to cache external images. If someone wants to use an external image in the wiki content without caching or cache the image with a certain interval, there is syntax to influence the caching behavior.

FIXME howto link (external) images in plugins with caching.

Plugins

Plugins can influence cache use via the PARSER_CACHE_USE event. This allows plugins which introduce additional dependencies for specific pages to check those dependencies and force DokuWiki to refresh the page when it wouldn't normally.

developer note

A simple measure to avoid caching is that plugin developers turn off caching completely. This is discouraged due to the extra rendering activities, in particular adversely for high traffic wikis. Instead of the plugin developers make use of the functionality to influence the cache by checking (themself formulated) dependencies. Therefore a syntax plugin will need to:

  • save some information relating to the pages it's involved with and the dependency specific to each of those pages. The page's metadata is a useful place for this. Metadata can be accessed via $INFO['metadata'] and the p_get_metadata() and p_set_metadata() functions. If using metadata please try to stick to Dublin Core Metadata standards.
  • add an action_plugin component to handle the PARSER_CACHE_USE event.

Caching itself is handled by the cache object6). The key parts of that object of interest to plugins are:

  • the depends array — DokuWiki fills this all the known dependencies of the page and then uses standard routines to process them. Plugins can add/modify these dependencies before they are processed. The different types of dependencies are:
    • purge — expire the cache
    • age — expire the cache if its older than age (affected by the metadata value 'date valid')
    • files — expire the cache if it is older than any of the files in this array. Only local files may be added. Take a look at inc/cache.php for a list of the files. Perhaps most interestingly the cached xhtml is dependent on the page's metadata.
  • the cache name, cache — a unique identifier under which the cache is stored. Normally it is dependent on the page name, HTTP_HOST and the server port. Plugins can generate more complex identifiers, e.g. the include generates identifiers using included page names and whether or not the current user has read access to those pages.

Individual Page Cache Expiry

As described above, DokuWiki verifies the validity of the cache rather than actively expiring the cache. However, the page xhtml is dependent on its metadata. That is, if the metadata file is more recent than the cache, DokuWiki will determine that the cache is invalid and re-render the page. So, we can update the metadata to expire the cache.

/* code to expire the cached xhtml of page ns:page
 * $id = 'ns:page';
 * $data = array('cache' => 'expire');  // the metadata being added
 * $render = false;                     // no need to re-render metadata now
 * $persistent = false;                 // this change doesn't need to persist passed the next metadata render.
 */
p_set_metadata($id, $data, $render, $persistent);

Purge cache button

In the default theme I tend to add a button for end users to purge cache if they want to. Edit lib/tpl/default/main.php.

    <div class="bar-left" id="bar__topleft">
      <?php tpl_button('edit')?>
      <?php tpl_button('history')?>
      <?php print html_btn('purgecache', $ID, '', array('purge' => 'true')) ?>
    </div>
1)
Non-Unix users can simply open the file and save it again – the idea is to change the file's timestamp
2)
conf/dokuwiki.php & conf/local.php
3)
inc/parser/parser.php & inc/parser/handler.php
4)
inc/parser/xhtml & inc/parser/metadata
5)
* being a single character directory name,
data being configurable by savedir
6)
inc/cache.php
devel/caching.txt · Last modified: 2016-10-09 22:22 by glen