implement global cache time to live. close #552

- set default to one week
- move cache setting to a new admin panel

Author: vincent-peugnet

app/class/Config.php

@@ -71,6 +71,9 @@ abstract class Config
     /** Indicate if img should have loading="lazy" attribute */
     protected static bool $lazyloadimg = true;
 
+    /** Global cache duration in seconds. Default is one week */
+    protected static int $cachettl = 604800;
+
     /** LDAP auth */
     protected static string $ldapserver = '';
     protected static string $ldaptree = '';
@@ -430,6 +433,11 @@ public static function lazyloadimg(): bool
         return self::$lazyloadimg;
     }
 
+    public static function cachettl(): int
+    {
+        return self::$cachettl;
+    }
+
     public static function ldapserver(): string
     {
         return self::$ldapserver;
@@ -731,6 +739,13 @@ public static function setlazyloadimg(bool $lazyloadimg): bool
         return self::$lazyloadimg = $lazyloadimg;
     }
 
+    public static function setcachettl(int $cachettl): void
+    {
+        if ($cachettl >= 0 && $cachettl <= Model::MAX_CACHE_TTL) {
+            self::$cachettl = $cachettl;
+        }
+    }
+
     public static function setldapserver(string $ldapserver): void
     {
         self::$ldapserver = $ldapserver;

app/class/Model.php

@@ -72,6 +72,7 @@ abstract class Model
     public const PASSWORD_MAX_LENGTH         = 128;
     public const MAX_COOKIE_CONSERVATION     = 365;
     public const MAX_QUERY_LENGH             = 512;
+    public const MAX_CACHE_TTL               = 1000000000;
 
 
     public static function dirtopath(string $dir): string

app/class/Modelpage.php

@@ -439,14 +439,15 @@ protected function reset(Page $page, array $reset): Page
      * 1. render file(s) are missing
      * 2. edit date is more recent than render date
      * 3. if the templatebody is set, exist and has been updated
+     * 4. cache time to live is reached
      *
      * @param Page $page                    Page to be checked
      *
      * @param int<1, max> $level
      *
      * @return bool                         true if the page need to be rendered otherwise false
      */
-    public function needtoberendered(Page $page, int $level = 3): bool
+    public function needtoberendered(Page $page, int $level = 4): bool
     {
         if ($level < 1) {
             throw new DomainException('minimum level is 1');
@@ -462,14 +463,25 @@ public function needtoberendered(Page $page, int $level = 3): bool
         if ($level >= 2 && $page->daterender() <= $page->datemodif()) {
             return true;
         }
+
         if ($level >= 3 && !empty($page->templatebody())) {
             try {
                 $bodytemplate = $this->get($page->templatebody());
-                return $page->daterender() <= $bodytemplate->datemodif();
+                if ($page->daterender() <= $bodytemplate->datemodif()) {
+                    return true;
+                }
             } catch (RuntimeException $e) {
                 Logger::errorex($e);
             }
         }
+
+        if ($level >= 4 && Config::cachettl() !== 0) {
+            $maxttl = $page->daterender()->getTimestamp() + Config::cachettl();
+            if (time() > $maxttl) {
+                return true;
+            }
+        }
+
         return false;
     }
 

app/view/templates/admin.php

@@ -345,19 +345,6 @@
         <p class="info">To be applied, these modifications need the re-rendering of all pages.
         </p>
 
-        <h3>Rendering details</h3>
-        <p class="info">When a page is modified, this may affect the rendering of other pages linked to it.
-            The pages to which it points have a strong possibility of needing to be updated too.
-            This option will invalidate their rendering each time the page pointing to them is updated.
-            They will therefore be re-rendered the next time they are viewed.
-        </p>
-
-        <p class="field">
-            <input type="hidden" name="deletelinktocache" value="0" form="admin">
-            <label for="deletelinktocache">invalidates the rendering of linked pages when updating</label>
-            <input type="checkbox" name="deletelinktocache" id="deletelinktocache" value="1" <?= Wcms\Config::deletelinktocache() ? 'checked' : '' ?> form="admin">
-        </p>
-
         <h3>Base page language</h3>
 
         <p class="info">If the page language is not specified in metadatas, then this default will be used.
@@ -448,6 +435,42 @@
         </p>
     </div>
 
+    <div class="grid-item" id="cache">
+        <h2>Cache</h2>
+
+        <p class="info">
+            Number of seconds before a page render expires.
+            Set it to zero if you want no cache expiration.
+            <br>
+            (604800 seconds is one week, 86400 is a day, 3600 is one hour)
+        </p>
+
+        <p class="field">
+            <label for="cachettl">cache life time (in seconds)</label>
+            <input
+                type="number"
+                name="cachettl"
+                id="cachettl"
+                value="<?= Wcms\Config::cachettl() ?>"
+                min="0"
+                max="<?= Wcms\Model::MAX_CACHE_TTL ?>"
+                form="admin"
+            >
+        </p>
+
+        <p class="info">When a page is modified, this may affect the rendering of other pages linked to it.
+            The pages to which it points have a strong possibility of needing to be updated too.
+            This option will invalidate their rendering each time the page pointing to them is updated.
+            They will therefore be re-rendered the next time they are viewed.
+        </p>
+
+        <p class="field">
+            <input type="hidden" name="deletelinktocache" value="0" form="admin">
+            <label for="deletelinktocache">invalidates the rendering of linked pages when updating</label>
+            <input type="checkbox" name="deletelinktocache" id="deletelinktocache" value="1" <?= Wcms\Config::deletelinktocache() ? 'checked' : '' ?> form="admin">
+        </p>
+    </div>
+
     <div class="grid-item"  id="style">
 
         <h2>Style</h2>