fixes #8

Signed-off-by: Bruno Meilick <[email protected]>

Author: bnomei

README.md

@@ -48,6 +48,7 @@ $json = janitor('clean', true); // array
     label: Enter Bank
     progress: Performing Heist...
     job: heist
+    data: Grand # (string) forwarded to job context
 ```
 
 **Kirby API (post Authentification)**
@@ -87,15 +88,23 @@ Go build your own jobs. Trigger APIs, create ZIPs, rename Files, ...
 <?php
     return [
         'bnomei.janitor.jobs' => [
-            'heist' => function() {
+            'heist' => function(Kirby\Cms\Page $page = null, string $data = null) {
                 \Bnomei\Janitor::log('heist.mask '.time());
+                
                 $grand = \Bnomei\Janitor::lootTheSafe();
                 // or trigger a snippet like this:
                 // snippet('call-police');
+                
+                // $page is Kirby Page Object if job issued by Panel
+                $location = $page ? $page->title() : 'Bank';
+                
+                // $data is optional [data] prop from the Janitor Panel Field
+                $currency = $data ? $data : 'Coins';
+                
                 \Bnomei\Janitor::log('heist.exit '.time());
                 return [
                     'status' => $grand > 0 ? 200 : 404,
-                    'label' => $grand . ' Grand looted!'
+                    'label' => $grand . ' ' . $currency . '  looted at ' . $location . '!'
                 ];
             }
         ],
@@ -110,6 +119,27 @@ Go build your own jobs. Trigger APIs, create ZIPs, rename Files, ...
 - **flush** calls `flush()` on *all* cache-folders. Dangerous!
 - **repair** creates the root cache folder if it is missing.
 
+
+## Panel context page and data
+
+Since 1.3.0 you can access the Page-Object the Panel-Field was called at and the forwarded custom data prop.
+
+
+```yaml
+  myjob:
+    type: janitor
+    label: Perform Job
+    progress: Performing Job...
+    job: myjob
+    data: my custom data
+```
+
+```php
+'myjob' => function(Kirby\Cms\Page $page = null, string $data = null) {
+    // $data == 'my custom data'
+}
+```
+
 ## Settings
 
 All settings must be prefixed with `bnomei.janitor.`.

classes/Janitor.php

@@ -2,6 +2,7 @@
 
 namespace Bnomei;
 
+use Kirby\Exception\Exception;
 use \Kirby\Toolkit;
 
 class Janitor
@@ -122,24 +123,34 @@ public static function cacheFolders(bool $all = false): array
         return \array_keys($folders);
     }
 
-    public static function api(string $job, bool $remote = false, string $secret = null): array
+    public static function api(string $job, bool $remote = false, string $secret = null, string $context = null, string $contextData = null): array
     {
         if (!$remote || ($secret && $secret == option('bnomei.janitor.secret'))) {
             $defaults = option('bnomei.janitor.jobs.defaults', []);
             $jobs = \array_merge($defaults, option('bnomei.janitor.jobs', []));
             foreach (option('bnomei.janitor.jobs.extends', []) as $optionID) {
                 $jobs = \array_merge($jobs, option($optionID, []));
             }
-            
+
             $before = \time();
             $data = [];
             $success = false;
 
             if (\array_key_exists($job, $jobs)) {
                 $c = $jobs[$job];
                 if (\is_callable($c)) {
+                    $r = null;
                     static::log('@' . $job . ' started');
-                    $r = $c();
+                    try {
+                        if($context) {
+                            $r = $c(kirby()->page(urldecode($context)), urldecode($contextData));
+                        }
+                        if( ! $r) {
+                            $r = $c();
+                        }
+                    } catch (Exception $ex) {
+                        $success = false;
+                    }
                     if (\is_array($r)) {
                         $data = $r;
                         $v = \Kirby\Toolkit\A::get($data, 'status', 404);

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "bnomei/kirby3-janitor",
     "type": "kirby-plugin",
-    "version": "1.2.1",
+    "version": "1.3.0",
     "license": "MIT",
     "description": "Kirby 3 Plugin for running jobs like cleaning the cache from within the Panel, PHP code or a cronjob",
     "authors": [

index.js

@@ -56,6 +56,12 @@
                 },
                 'cooldown' => function (int $cooldownMilliseconds = 2000) {
                     return intval(option('bnomei.janitor.label.cooldown', $cooldownMilliseconds));
+                },
+                'data' => function (string $data = null) {
+                  return \Kirby\Toolkit\I18n::translate($data, $data);
+                },
+                'pageURI' => function () {
+                    return $this->model()->uri();
                 }
             ]
         ]
@@ -72,11 +78,27 @@
     ],
     'api' => [
         'routes' => [
+            [
+                'pattern' => 'plugin-janitor/(:any)/(:any)/(:any)',
+                'action' => function (string $job, string $context, string $data) {
+                    \Bnomei\Janitor::log('janitor-api-auth', 'debug');
+                    $api = \Bnomei\Janitor::api($job, false, null, $context, $data);
+                    return $api;
+                }
+            ],
+            [
+              'pattern' => 'plugin-janitor/(:any)/(:any)',
+              'action' => function (string $job, string $context) {
+                \Bnomei\Janitor::log('janitor-api-auth', 'debug');
+                $api = \Bnomei\Janitor::api($job, false, null, $context);
+                return $api;
+              }
+            ],
             [
                 'pattern' => 'plugin-janitor/(:any)',
                 'action' => function (string $job) {
                     \Bnomei\Janitor::log('janitor-api-auth', 'debug');
-                    $api = \Bnomei\Janitor::api($job);
+                    $api = \Bnomei\Janitor::api($job, false, null);
                     return $api;
                 }
             ]

index.php

@@ -10,11 +10,20 @@ export default {
     progress: String,
     job: String,
     cooldown: Number,
-    status: String
+    status: String,
+    data: String,
+    pageURI: String,
   },
   methods: {
     janitor() {
-      this.getRequest(this.job)
+      let url = this.job
+      if(true) {
+        url = url + '/' + encodeURIComponent(this.pageURI)
+      }
+      if(this.data != undefined) {
+        url = url + '/' + encodeURIComponent(this.data)
+      }
+      this.getRequest(url)
     },
     getRequest (url) {
       let that = this