✨ CLI

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

Author: bnomei

.gitignore

@@ -11,6 +11,7 @@ node_modules
 /tests/site/accounts
 /tests/site/cache
 /tests/site/sessions
+/tests/janitor-*.php
 
 # files of Composer dependencies that are not needed for the plugin
 /vendor/**/.*
@@ -32,3 +33,4 @@ node_modules
 /vendor/**/tests/*
 /vendor/**/php4/*
 /vendor/getkirby/composer-installer
+

README.md

@@ -18,12 +18,15 @@ Kirby 3 Plugin for running jobs like cleaning the cache from within the Panel, P
   
 > *TIP 2:* It can also create logs of what it did.
 
+> *TIP 3:* I can also be used as an CLI.
+
 1. [Custom Jobs](https://github.com/bnomei/kirby3-janitor#custom-jobs)
 1. [Query Language](https://github.com/bnomei/kirby3-janitor#queries)
 1. [Reload Panel](https://github.com/bnomei/kirby3-janitor#reload-panel-view)
 1. [Copy to Clipboard](https://github.com/bnomei/kirby3-janitor#copy-to-clipboard)
 1. [Open URL](https://github.com/bnomei/kirby3-janitor#open-url)
 1. [Download File](https://github.com/bnomei/kirby3-janitor#download-file)
+1. [CLI](https://github.com/bnomei/kirby3-janitor#cli)
 
 ## Commerical Usage
 
@@ -109,8 +112,6 @@ janitor_query:
 },
 ```
 
-
-
 ## Panel Features
 
 ### Context page and data
@@ -181,6 +182,68 @@ janitor_query:
 
 > ATTENTION: The download dialog will only appear at [same origin](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/a#Attributes) otherwise it will behave like opening an url.
 
+## CLI
+
+This plugin comes with an executable php script called `janitor` to use in the terminal/console. You can use it with an *alias* like this:
+
+```
+cd your/project/folder/root
+alias janitor='php site/plugins/kirby3-janitor/janitor'
+janitor --help
+```
+
+> TIP: Depending on your OS you might need to make the script executable with `chmod 0755 site/plugins/kirby3-janitor/janitor` first.
+
+> TIP: If you are using a custom folder setup you need to tell the janitor where to get the kirby instance from like this `janitor -kirby /public myJob`. See **Arguments** below. 
+
+### CLI Arguments
+ ```
+janitor --help
+
+Usage: janitor [-f format, --format format (default: label)] [-h, --help] [-k kirby, --kirby kirby (default: /)] [-l, --list] [-v, --verbose] [job]
+...
+ ```
+
+### Kirby Instance Loader
+
+The CLI needs to load the same Kirby Instance you website does. To achieve this the CLI attempts to create a special file named `janitor-{HASH}.php` based on your public `index.php`. It only comments out the `echo` statement.
+
+### CLI Examples 
+
+Examples based on the test from this plugin:
+
+**clean with dynamic progressbar**
+```
+janitor --verbose clean
+
+Using Kirby instance from: {PROJECT}/janitor-7848cb3c7677f4ff109682b2d9cd9978d46f7de8.php
+======================================================================> 100%
+200
+```
+
+**print as table**
+```
+janitor -format table whistle
+
+----------------
+| status | 200 |
+----------------
+| label  | ♫   |
+----------------
+```
+
+**print as json and store as file**
+```
+janitor -format json heist | cat > heist-$(date +%s).json
+cat heist-1573147345.json
+
+{
+    "status": 200,
+    "label": "7 Coins looted at Bank!"
+}
+
+```
+
 ## Settings
 
 | bnomei.janitor.           | Default        | Description               |            
@@ -221,6 +284,11 @@ wget https://devkit.bnomei.com/plugin-janitor/clean/e9fe51f94eadabf54dbf2fbbd571
 curl -s https://devkit.bnomei.com/plugin-janitor/clean/e9fe51f94eadabf54dbf2fbbd57188b9abee436e > /dev/null
 ```
 
+## Dependencies
+
+- [Symfony Finder](https://symfony.com/doc/current/components/finder.html)
+- [CLIMate](https://github.com/thephpleague/climate)
+
 ## Disclaimer
 
 This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please [create a new issue](https://github.com/bnomei/kirby3-janitor/issues/new).

classes/CleanCacheFilesJob.php

@@ -18,9 +18,18 @@ public function job(): array
         $removed = 0;
         $finder = new Finder();
         $finder->files()->name('*.cache')->in($dir);
+        $count = iterator_count($finder);
+        $climate = \Bnomei\Janitor::climate();
+        $progress = null;
+        if ($count && $climate) {
+            $progress = $climate->progress()->total($count);
+        }
         foreach ($finder as $cacheFile) {
             if (F::remove($cacheFile->getRealPath())) {
                 $removed++;
+                if ($progress && $climate) {
+                    $progress->current($removed);
+                }
             }
         }
         return [

classes/FlushSessionFilesJob.php

@@ -18,9 +18,18 @@ public function job(): array
         $removed = 0;
         $finder = new Finder();
         $finder->files()->name('*.sess')->in($dir);
+        $count = iterator_count($finder);
+        $climate = \Bnomei\Janitor::climate();
+        $progress = null;
+        if ($count && $climate) {
+            $progress = $climate->progress()->total($count);
+        }
         foreach ($finder as $cacheFile) {
             if (F::remove($cacheFile->getRealPath())) {
                 $removed++;
+                if ($progress && $climate) {
+                    $progress->current($removed);
+                }
             }
         }
         return [

classes/Janitor.php

@@ -9,6 +9,7 @@
 use Kirby\Cms\Page;
 use Kirby\Toolkit\A;
 use Kirby\Toolkit\Str;
+use League\CLImate\CLImate;
 
 final class Janitor
 {
@@ -94,6 +95,15 @@ public function job(string $name, array $data = []): array
         ];
     }
 
+    /**
+     * @return mixed
+     */
+    public function listJobs()
+    {
+        // find in jobs config
+        return array_keys($this->option('jobs'));
+    }
+
     /**
      * @param string $name
      * @return mixed|string
@@ -227,4 +237,21 @@ public static function isTrue($val, $return_null = false): bool
         $boolval = ($boolval === null && !$return_null ? false : $boolval);
         return $boolval;
     }
+
+    /**
+     * @var \League\CLImate\CLImate
+     */
+    private static $climate;
+
+    /**
+     * @param CLImate|null $climate
+     * @return CLImate|null
+     */
+    public static function climate(?CLImate $climate = null): ?CLImate
+    {
+        if ($climate && !self::$climate) {
+            self::$climate = $climate;
+        }
+        return self::$climate;
+    }
 }

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "bnomei/kirby3-janitor",
     "type": "kirby-plugin",
-    "version": "2.1.0",
+    "version": "2.2.0",
     "license": "MIT",
     "description": "Kirby 3 Plugin for running jobs like cleaning the cache from within the Panel, PHP code or a cronjob",
     "authors": [
@@ -34,6 +34,7 @@
     "require": {
         "php": ">=7.2.0",
         "getkirby/composer-installer": "^1.1",
+        "league/climate": "^3.5",
         "symfony/finder": "^4.3"
     },
     "require-dev": {