✨ maintenance mode check callback and 503 https status

closes #103

Signed-off-by: bnomei <[email protected]>

Author: bnomei

README.md

@@ -358,6 +358,37 @@ in your cron scheduler add the following command
 cd /path/to/my/kirby/project/root && vendor/bin/kirby janitor:backupzip
 ```
 
+## Maintenance Mode
+
+You can toggle maintenance mode with a janitor button like this:
+
+```yml
+  janitor_maintenance:
+    type: janitor
+    command: 'janitor:maintenance --user {{ user.uuid }}'
+    cooldown: 5000
+    label: 'Maintenance: {{ site.isUnderMaintenance.ecco("DOWN","UP") }}'
+    icon: '{{ site.isUnderMaintenance.ecco("cancel","circle") }}'
+```
+
+If you need to add a custom check when maintenance mode is enforced you can do this by providing a callback for the `bnomei.janitor.maintenance.check` option.
+
+**site/config/config.php**
+```php
+<?php
+
+return [
+    // return `true` for maintenance and `false` to skip maintenance
+    'bnomei.janitor.maintenance.check' => function(): bool {
+        // example: block unless it is a logged-in user and it has the admin role
+        return kirby()->users()->current()?->role()->isAdmin() !== true;
+    },
+    // other options...
+];
+```
+
+You can also overwrite the maintenance snippet if you create your own and store it as `site/snippets/maintenance.php`.
+
 ## Dependencies
 
 - [Kirby CLI](https://github.com/getkirby/cli)

classes/Janitor.php

@@ -179,7 +179,13 @@ public static function requestBlockedByMaintenance(): bool
                 return false;
             }
         }
-        return true;
+
+        $isBlocked = option('bnomei.janitor.maintenance.check', true);
+        if ($isBlocked && !is_string($isBlocked) && is_callable($isBlocked)) {
+            $isBlocked = $isBlocked();
+        }
+
+        return boolval($isBlocked);
     }
 
     public static function resolveModel(string $uuid): mixed

composer.json

@@ -1,8 +1,9 @@
 {
     "name": "bnomei/kirby3-janitor",
     "type": "kirby-plugin",
-    "version": "3.4.3",
+    "version": "3.4.5",
     "license": "MIT",
+    "homepage": "https://github.com/bnomei/kirby3-janitor",
     "description": "Kirby 3 Plugin for running commands like cleaning the cache from within the Panel, PHP code or a cronjob",
     "authors": [
         {