Requirements

• PHP 7.4 and above
• October CMS v1.1 or v2 or v3

Installation

php artisan plugin:install BizMark.Quicksilver

Optional configuration

Quicksilver can be configured additionally so webserver can check for cached pages by itself, completely ignoring application booting.

Apache

1. Open .htaccess and add the following before Standard routes section

   ##
   ## Serve Cached Page If Available
   ##
   RewriteCond %{REQUEST_URI} ^/?$
   RewriteCond %{DOCUMENT_ROOT}/storage/quicksilver/cache/qs_index_qs.html -f
   RewriteRule .? /storage/quicksilver/cache/qs_index_qs.html [L]
   RewriteCond %{DOCUMENT_ROOT}/storage/quicksilver/cache%{REQUEST_URI}.html -f
   RewriteRule . /storage/quicksilver/cache%{REQUEST_URI}.html [L]
   RewriteCond %{HTTP:X-Requested-With} XMLHttpRequest
   RewriteRule !^index.php index.php [L,NC]

2. Comment out following line in White listed folders section.

   RewriteRule !^index.php index.php [L,NC]

3. Be sure that plugin can create/write/read "storage/quicksilver/cache" folder in your storage path.

Nginx

location = / {
    try_files /storage/quicksilver/cache/qs_index_qs.html /index.php?$query_string;
}

location / {
    try_files $uri $uri/ /storage/quicksilver/cache/$uri.html /storage/quicksilver/cache/$uri.json /index.php?$query_string;
}

If you need to send ajax requests to cached url, you should use this construction

location / {
    if ($request_method = POST ) {
        rewrite ^/.*$ /index.php last;
    }

    try_files $uri $uri/ /storage/quicksilver/cache/$uri.html /storage/quicksilver/cache/$uri.json /index.php?$query_string;
}

Ignoring the cached files

Don't forget to put Quicksilver folder in your .gitignore.

/storage/quicksilver

Clearing the cache

php artisan quicksilver:clear

Or to clear specific route

php artisan quicksilver:clear {path}

Events

These events called when request and response are validated, if returned true Quicksilver will continue validation.

• bizmark.quicksilver.is_request_valid - bool

Event::listen('bizmark.quicksilver.is_request_valid', function(\Illuminate\Http\Request $request) {
    // request is valid, cache.
    return true;

    // request is invalid, don't cache.
    return false;
});

• bizmark.quicksilver.is_response_valid - bool

Event::listen('bizmark.quicksilver.is_response_valid', function(\Symfony\Component\HttpFoundation\Response; $response) {
    // response is valid, cache.
    return true;

    // response is invalid, don't cache.
    return false;
});

These events called before and after storing cached page, so you can modify contents of it.

• bizmark.quicksilver.before_store - void

  Event::listen('bizmark.quicksilver.before_store', function(array $fileInformation) {
  // Contents of fileInformation
  // $fileInformation = [
  //     name
  //     extension
  //     directory
  //     mimeType
  //     path
  // ];
  // ...
  });

• bizmark.quicksilver.after_store - void

  Event::listen('bizmark.quicksilver.after_store', function(array $fileInformation) {
  // Contents of fileInformation
  // $fileInformation = [
  //     name
  //     extension
  //     directory
  //     mimeType
  //     path
  // ];
  // ...
  });

© 2023, Nick Khaetsky at Biz-Mark under the GNU General Public License v2.0.

Upgrading To 3.0

1. Cache folder changed from /storage/page-cache to /storage/quicksilver/cache
2. Webserver configuration (.htaccess or nginx) is optional now, and can be removed. Quicksilver has more features without webserver configuration.

Upgrading To 1.3

Open your .htaccess file, and replace old section of "serving cache rules" with new from documentation

If you edited this section, or don't want to replace whole section, you need to add this two lines right after section headline.

RewriteCond %{QUERY_STRING} ^(.)
RewriteRule !^index.php index.php [L,NC]

© 2022, Nick Khaetsky at Biz-Mark under the GNU General Public License v2.0.