Skip to content
Static file extension for the native Craft CMS cache.
PHP HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
resources/img Update plugin logo May 18, 2018
src Add typeof entry check to event Jul 12, 2019
.craftplugin Add cache warming Nov 3, 2018
.editorconfig
.gitattributes Initial beta commit Mar 14, 2016
.gitignore Initial beta commit Mar 14, 2016
CHANGELOG.md Add options to clear cache after certain sections Jun 13, 2019
LICENSE.md Add cache warming Nov 3, 2018
README.md Add ability to remove cache items individually Nov 6, 2018
composer.json Remove version from composer Jan 30, 2019
presto-settings.jpg

README.md

Presto

Presto is a static file extension for the native Craft cache. It works alongside standard Twig {% cache %} tag pairs and includes cache-busting features. Just like standard caching, Presto is automatic. Simply install, update your layouts, and then the cache will bust automatically as you create, update, or delete content.

Requirements

This plugin requires Craft CMS 3.0.0 or later.

Installation

To install the plugin, follow these instructions.

  1. Open your terminal and go to your Craft project:

     cd /path/to/project
    
  2. Then tell Composer to load the plugin:

     composer require lewiscom/presto
    
  3. In the Control Panel, go to Settings → Plugins and click the “Install” button for Presto.

Setup Guide

Step 1 - Turn off element query caching

Turn off element query caching in your general config file. This will stop the DeleteStaleTemplateCaches task from running in the admin. Since Presto busts the entire cache when a new element is saved, element query caching is not necessary.

'cacheElementQueries' => false

Step 2 - Add cache tags

Presto lets Craft do the heavy lifting of calculating the elements within the template. As a result, all you need to do in your templates is pass the cache key returned from craft.presto.cache to the native cache tag pair. Presto will return a cache key that includes the host, group (if one is set), and path.

Note that the entirety of your template logic must be wrapped by the cache tags. In addition, it is recommended that you add the globally tag so that Craft does not overload the cache (i.e. query string requests).

{% cache globally using key craft.presto.cache %}
	{# Template Logic #}
{% endcache %}

Parameters

{% craft.presto.cache({
	group: 'pjax',
	static: false
}) %}
Parameter Type Description
group string When set, the requested page will write into a sub-folder within the top-level cache directory. This is useful for pjax implementations where you load a separate template.
static boolean Setting to false will disable static caching for the request and fall back to native caching logic. The cache key will still be returned, but a static file won't be written.

Step 3 - Configure your server

Your host needs to check for matching static files before Craft handles the request. If the file exists, it's served statically. This block should typically be set immediately preceding the primary Craft "index.php" rewrite. Use these examples as a general guideline, your implementation may vary.

Apache

# Check Presto cache
RewriteCond %{REQUEST_FILENAME} !\.(css|eot|gif|ico|jpe?g|otf|png|svg|ttf|webp|woff2?)$ [NC]
RewriteCond %{REQUEST_METHOD} GET
RewriteCond %{DOCUMENT_ROOT}/cache/%{HTTP_HOST}/presto%{REQUEST_URI}/index.html -f
RewriteRule .* /cache/%{HTTP_HOST}/presto%{REQUEST_URI}/index.html [L,E=nocache:1]]

# Craft rewrite here

If you add a cache group, you'll need to add additional configuration. Below is an example of a pjax implementation:

RewriteCond %{REQUEST_FILENAME} !\.(css|eot|gif|ico|jpe?g|otf|png|svg|ttf|webp|woff2?)$ [NC]
RewriteCond %{HTTP:X-PJAX} true
RewriteCond %{REQUEST_METHOD} GET
RewriteCond %{DOCUMENT_ROOT}/cache/%{HTTP_HOST}/presto/pjax%{REQUEST_URI}/index.html -f
RewriteRule .* /cache/%{HTTP_HOST}/presto/pjax%{REQUEST_URI}/index.html [L,E=nocache:1]]

Nginx

# Block direct cache access
location /cache {
	internal;
}

# Check Presto cache
location ~ !\.(css|gif|ico|jpe?g|png|svg)$ {
	if ($request_method = GET) {
		try_files $uri /cache/$http_host/presto/$uri/index.html;
	}
}

# Craft rewrite here

Disable Caching

Multi-enviroment

If you use a multi-environment config, set an arbitrary cache variable in your general config. Override this variable on environments where you don't want static caching (e.g. local development).

General Config Variable

`cacheEnabled` => true

Cache Tag

{% cache globally using key craft.presto.cache if conf.cacheEnabled is defined and conf.cacheEnabled %}
	{# Template Logic #}
{% endcache %}

Individual Templates

When using Presto the for, until, if, and unless parameters won't be respected on each request once the static html file is created. To disable the cache on individual templates, set a variable on the main cache tag. Override that variable on each template where you don't want static caching.

Cache Tag

{% cache globally using key craft.presto.cache if cacheEnabled is defined ? cacheEnabled : true %}
    <!doctype html>
    <html>
        <body>
            {{ block('content') }}
        </body>
    </html>
{% endcache %}

Cache Template Override

{% extends '[layout-template-path]' %}

{# Disable caching on this page #}
{% set cacheEnabled = false %}

{% block content %}
	{# page content #}
{% endblock %}

Directory Structure

Presto resolves subdomain hosts automatically. Static html files are created inside a directory named after the requested host (i.e. coolwebsite.com, sub.coolwebsite.com). An additional directory called "presto" is created inside each host directory to avoid .htaccess filename conflicts. See below for an example cache file directory structure:

- cache
	- coolwebsite.com
		- presto
			- index.html
			- blog
				- index.html

Purging the Cache

To purge the cache, navigate to the Presto plugin settings page (Settings > Presto) and click "Purge Cache" (immediate) or "Schedule Purge" (cron).

presto-settings

Note: The Cron purge method does not clear the template cache. Remember to purge the template cache before you schedule a purge.

Purge Method

Presto provides two purge methods: immediate and cron.

Immediate Purge

By default, Presto will purge the static cache and all related Craft template caches immediately. This only occurs in the server instance where the cache was cleared.

Cron Purge

If you run Presto in an environment that spins up multiple server instances, set the purgeMethod config to "cron". Set up a cron job on each server instance that runs the presto/default/check console command. The following example will run it every 10 minutes.

*/10 * * * *  php /var/www/craft presto/default/check

Disabled/Archived Entries

If an entry exists in the CMS but is not displayed on the site (e.g. status is disabled, entry is archived, etc.), enabling the entry will not clear any caches. Presto only clears related entries that are displayed on the site. In order to display your newly enabled entry, purge the entire cache.

Events

Presto comes with a couple of events should you need them.

The following events will emit a CacheEvent event handler with the following properties

  • html - the generated HTML
  • cacheKey - the cache key
  • filePath - the file path that the static file will be saved
  • host - the hostname
  • path - the url segment path
  • config - any configuration passed from the PrestoVariable
Presto::EVENT_BEFORE_GENERATE_CACHE_ITEM
Presto::EVENT_AFTER_GENERATE_CACHE_ITEM

The following events will emit a PurgeEVent event with the following parameters:

  • cacheKey - an array of cache keys that were purged
Presto::EVENT_BEFORE_PURGE_CACHE
Presto::AFTER_BEFORE_PURGE_CACHE
Presto::EVENT_BEFORE_PURGE_CACHE_ALL
Presto::AFTER_BEFORE_PURGE_CACHE_ALL

Note: the purge all events will not pass through the cache keys

Roadmap

  • Display a list of cached pages in the admin
  • Add ability to clear individual cached pages in the admin
  • Warm cache after an entry is saved or created

License

Copyright 2017 Lewis Communications, LLC. Licensed under the Apache License, Version 2.0.

Brought to you by Lewis Communications

You can’t perform that action at this time.