README

ZF2 Cachebuster is a cache buster module closely modeled after https://github.com/gordonknoppe/magento-cachebuster. It facilitates automatic purging of static assets from HTTP caches such as browser cache, CDN, Varnish, etc using best practices outlined within the HTML5 boilerplate community.

See section "Filename-based cache busting" in: https://github.com/h5bp/server-configs-apache/blob/2.14.0/dist/.htaccess#L968

Overview

The module provides cachebusting by automatically altering the URI created by Magento for static files by adding the timestamp of the file to the filename:

Before: http://www.example.com/js/file.js
After: http://www.example.com/js/file.1324429472.js

Example uses

Automatically invalidating cache when using Cloudfront CDN
- Amazon's Cloudfront CDN can be configured to use an origin server but by it's nature will not refresh your updated file until it's cache time expires or you send an invalidation request using their API.
No more browser cache issues (ie. Them: "Where's that CSS change I requested?". You: "Oh, did you hit refresh?")
- Adding far-future expires headers, which is good for reducing the number of requests to your server, means that even without a CDN you have probably experienced browser cache causing a waste of time on what turns out to be a non-issues.

Installation

Composer

Install Composer
Install the module using Composer into your application's vendor directory. Add the following line to your composer.json.

{
   "require": {
       "vcomedia/vco-zf-mediapath": "dev-master"
   }
}

Execute composer update
Enable the module in your ZF2 application.config.php file.

return array(
    'modules' => array(
        'VcoZfMediaPath'
    )
);

Copy and paste the vco-zf-logger/config/module.vco-zf-mediapath.local.php.dist file to your config/autoload folder and customize it with your configuration settings. Make sure to remove .dist from your file. Your module.vco-zf-mediapath.local.php might look something like the following:

<?php
/**
* VcoZfMediaPath - Zend Framework 2 basePath view helper wrapper.
*
* @category Module
* @package  VcoZfMediaPath
* @author   Vahag Dudukgian (valeeum)
* @license  http://opensource.org/licenses/MIT The MIT License (MIT)
* @link     http://github.com/vcomedia/vco-zf-mediapath/
*/

namespace VcoZfMediaPath;

return array(
  'VcoZfMediaPath' => array(
      'docRoot' => '/public',
      'cdnOptions' => array(
          'enabled' => true,
          'defaultDomain' => array(
              'http' => 'http://cdn.domain.com',
              'https' => 'http://cdn.domain.com'
          )
      ),
      'cacheBusterOptions' => array(
          'enabled' => true,
          'basePaths' => array(
              '/skin/',
              '/js/',
              '/scripts/',
              '/css/',
              '/stylesheets/',
              '/media/',
              '/uploads/',
              '/images/',
              '/img/',
              '/imgs/',
              '/cache/',
              '/fonts/'
          ),
         'extensions' => array(
              'js',
              'css',
              'jpg',
              'jpeg',
              'gif',
              'png',
              'ttf',
              'woff',
              'pdf'
          )            
      )
  )
);

Note: The configuration array returned by the top level 'VcoZfLogger' key is passed directly into the Log class constructor with the exception of the mail transport and mongo credential injection which are both optional.

mod_rewrite configuration

The following mod_rewrite rules need to be enabled for your store when using this module, potentially via .htaccess file or Virtualhost definition.

<IfModule mod_rewrite.c>

############################################
## rewrite files for magento cachebuster

    RewriteCond %{REQUEST_FILENAME} !-f
    RewriteCond %{REQUEST_FILENAME} !-d
    RewriteRule ^(.+)\.(\d+)\.(js|css|png|jpeg|jpg|gif)$ $1.$3 [L]

</IfModule>

nginx configuration

For nginx you will need to add a rule like the following to your site definition.

location ~* (.+)\.(\d+)\.(js|css|png|jpg|jpeg|gif)$ {
    try_files $uri $1.$3;
}

Duplicate Content Considerations and Restricting to Specific Static Folders When Using AWS Cloudfront (approach can apply to any CDN)

Create 2 origins:
- One origin would be "domain.com"
- The other origin would be a custom error page such as "domain.com/403.html" or however you want to handle this aspect.
Create Cache Behaviors for each static file folder you have. For example:
- For "/css" you would create a Cache Behavior path pattern of "css/*"
- For "/js" you would create a Cache Behavior path pattern of "js/*"
- etc.
- For each of those Cache Behaviors, you would then want to make sure that the Origin you specify is for "domain.com".
- That way, any request for "http://cdn.domain.com/css/" etc will be similar to making a request to "http://domain.com/css/"
Then for the Default Cache Behavior (*), you can point that to the second origin you had created. Following the example from Step 1, that origin would be "domain.com/403.html".

So essentially, how the above would work is that any request to http://cdn.domain.com/css/, /js/, etc; it will go to your origin appropriately. If they try and go to "http://cdn.domain.com/notspecified/", that will only match the Default Cache Behavior (*) which will then point them to the 403 page you have created. That should make it so anything that crawls cdn.domain.com should only see your static content and nothing else if it wasn't specified in your Cache Behavior path patterns.

This will at the very least restrict duplicate content issues to static files.

License

Licensed under the Apache License, Version 2.0

vcomedia / vco-zf-mediapath

Maintainers

Details