🚑 multi-language setups did not work, modified check edge cases

✨ read and write options

Author: bnomei

README.md

@@ -318,6 +318,8 @@ echo $page->tinyurl(); // https://devkit.bnomei.com/x/8j5g64hh
 |---------------------------|----------------|---------------------------|
 | fieldname | `'boostid'` | change name of loaded field |
 | expire | `0` | expire in minutes for all caches created |
+| read | `true` | read from cache |
+| write | `true` | write to cache |
 | fileModifiedCheck | `false` | expects file to not be altered outside of kirby |
 | index.generator | callback | the uuid genertor |
 | tinyurl.url | callback | returning `site()->url()`. Use htaccess on that domain to redirect `RewriteRule (.*) http://www.bnomei.com/x/$1 [R=301]` |

classes/BoostIndex.php

@@ -29,7 +29,7 @@ public function __construct()
 
         $cache = $this->cache();
         if ($cache && method_exists($cache, 'register_shutdown_function')) {
-            $cache->register_shutdown_function(function() {
+            $cache->register_shutdown_function(function () {
                 $this->write();
             });
         }
@@ -87,7 +87,7 @@ public function index(bool $force = false, ?Page $target = null): int
             // only search until target is found
             if ($target && $target->id() === $page->id()) {
                 $this->write();
-                break;   
+                break;
             }
         }
         return $count;

classes/PageHasBoost.php

@@ -67,11 +67,11 @@ public function forceNewBoostId(bool $overwrite = false, ?string $id = null)
     public function contentBoostedKey(string $languageCode = null): string
     {
         $key = strval(crc32($this->id()));
-        if (!$languageCode) {
+        if (! $languageCode) {
             $languageCode = kirby()->languages()->count() ? kirby()->language()->code() : null;
-            if ($languageCode) {
-                $key = $key . '-' .  $languageCode;
-            }
+        }
+        if ($languageCode) {
+            $key = $key . '-' .  $languageCode;
         }
 
         return $key;
@@ -84,14 +84,20 @@ public function isContentCacheExpiredByModified(string $languageCode = null): bo
             return true;
         }
 
-        $modified = $this->modified();
         $modifiedCache = $cache->get(
             $this->contentBoostedKey($languageCode).'-modified',
             null
         );
         if (!$modifiedCache) {
             return true;
         }
+
+        $modified = $this->modified();
+        // in rare case the file does not exist or is not readable
+        if ($modified === false) {
+            return true;
+        }
+        // otherwise compare
         if ($modifiedCache && intval($modifiedCache) < intval($modified)) {
             return true;
         }
@@ -116,7 +122,7 @@ public function readContentCache(string $languageCode = null): ?array
     public function readContent(string $languageCode = null): array
     {
         // read from boostedCache if exists
-        $data = option('debug') ? null : $this->readContentCache($languageCode);
+        $data = option('bnomei.boost.read') === false || option('debug') ? null : $this->readContentCache($languageCode);
 
         // read from file and update boostedCache
         if (! $data) {
@@ -132,13 +138,20 @@ public function readContent(string $languageCode = null): array
     public function writeContentCache(?array $data = null, string $languageCode = null): bool
     {
         $cache = BoostCache::singleton();
-        if (! $cache) {
+        if (! $cache || option('bnomei.boost.write') === false) {
             return true;
         }
 
+        $modified = $this->modified();
+
+        // in rare case file does not exists or is not readable
+        if ($modified === false) {
+            return false; // try again another time
+        }
+
         $cache->set(
             $this->contentBoostedKey($languageCode) . '-modified',
-            $this->modified(),
+            $modified,
             option('bnomei.boost.expire')
         );
 

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "bnomei/kirby3-boost",
   "type": "kirby-plugin",
-  "version": "1.6.5",
+  "version": "1.6.6",
   "description": "Boost the speed of Kirby by having content files of pages cached, with automatic unique ID, fast lookup and Tiny-URL.",
   "license": "MIT",
   "authors": [

docker-compose.yml

@@ -7,6 +7,6 @@ services:
       - 8000:80
     environment:
       WEB_DOCUMENT_ROOT: /app/tests/
-      WEB_ALIAS_DOMAIN: boost.test
+      WEB_ALIAS_DOMAIN: localhost
     volumes:
       - .:/app:rw

index.php

@@ -43,6 +43,8 @@ function siteIndexFilterByBoostID(string $id): ?\Kirby\Cms\Page
         'fieldname' => 'boostid', // autoid
         'expire' => 0,
         'fileModifiedCheck' => false, // expects file to not be altered outside of kirby
+        'read' => true, // read from cache
+        'write' => true, // write to cache
         'index' => [
             'generator' => function (?string $seed = null) {
                 // override with custom callback if needed

tests/content/home/home.txt renamed to tests/content/home/home.en.txt

@@ -2,4 +2,6 @@
 
 return [
     'debug' => false, // must be off for cache to stick
+
+    'languages' => true,
 ];

tests/content/site.txt

@@ -0,0 +1,15 @@
+<?php
+
+return [
+    'code' => 'de',
+    'default' => false,
+    'direction' => 'ltr',
+    'locale' => [
+        'LC_ALL' => 'de_DE'
+    ],
+    'name' => 'German',
+    'translations' => [
+
+    ],
+    'url' => null
+];