Is it expected that my custom janitor job button doesn't work from site.yml blueprint without adding a data (which I don't need) property to it?

This is my site.yml:

janitor:
  type: janitor
  label: Replenish my custom cache
  progress: Replenishing (can take a few secs)...
  cooldown: 5000
  job: replenishMyCache
  data: blablabla

and this is the job defined in my config.php:

'bnomei.janitor.jobs' => [
    'replenishMyCache' => function (Kirby\Cms\Page $page = null, string $data = null) {
        var_dump($page);
        var_dump($data);
        die;
        return [
            'status' => 200,
            'label' => 'External stuff fetched',
        ];
    },
]

When I remove data: blablabla from the blueprint, the button doesn't work and I get a 404 in the panel for the call: http://mywebsite.test/api/plugin-janitor/replenishMyCache/$ -> I notice a $ is appended? Is this expected? FYI: when data: blablabla is in the blueprint, the url that is fetched looks like this: http://mywebsite.test/api/plugin-janitor/replenishMyCache/%24/mlkqsjdf

Am I doing something wrong?

When I test this on a page blueprint, I don't need to add the data property. It just works as expected then?

First of all thanks for this great plugin!

I build a panel-button and corresponding custom job to import data from json and copying external image-files to create new pages out of that. Because it´s a larger data-set I run into an php max_execution_time timeout. Is there any mechanism inside janitor to avoid that?

Thanks for any help in advance!

With version 1.4.0 installed through Composer on a Kirby 3.2 instance, I get the following error in the panel:

Error: Cannot find module 'function () {var a={name:"Janitor",props:{label:String,progress:String,job:String,cooldown:Number,status:String,data:String,pageURI:String},methods:{janitor:function(){var t=this.job;t=t+"/"+encodeURIComponent(this.pageURI),null!=this.data&&(t=t+"/"+encodeURIComponent(this.data)),this.getRequest(t)},getRequest:function(t){var s=this,e=this.label;this.label=this.progress.length>0?this.progress:this.label+"...",this.status="doing-job",this.$api.get(t).then(function(t){void 0!==t.label&&(s.label=t.label),void 0!==t.status?s.status=200==t.status?"is-success":"has-error":s.status="has-response",setTimeout(function(){s.label=e,s.status=""},s.cooldown)})}}};if(typeof a==="function"){a=a.options}Object.assign(a,function(){var render=function(){var _vm=this;var _h=_vm.$createElement;var _c=_vm._self._c||_h;return _c("k-button",{staticClass:"janitor",class:_vm.status,attrs:{"job":_vm.job},on:{"click":function($event){return _vm.janitor()}}},[_vm._v(_vm._s(_vm.label))])};var staticRenderFns=[];return{render:render,staticRenderFns:staticRenderFns,_compiled:true,_scopeId:null,functional:undefined}}());panel.plugin("bnomei/janitor",{fields:{janitor:a}});}'

From the file media/plugins/index.js line 37

It breaks all my custom fields for some reason. If I disable the plugin everything works fine again.

The blueprint looks like this:

janitor:
  type: janitor
  label: Vider le cache
  progress: Nettoyage en cours…
  job: clean

In the panel, where the button is supposed to show up, Kirby throws:

 The field type "janitor" does not exist

Let me know what extra info would help you debug this issue.

Edit: with Kirby 3.1.x everything works fine.

Follow up from Discord:

Are you thinking what I'm thinking, like: I'm telling janitor what fields I need and upon pressing a button, I'm prompted for those fields, and then I can use the entered information inside a job? That would be AWESOME!

hey there 🌻 ✨ i was just trying to get a draft page by using data: '{{ page.id }}'. first of all, the basic solution ->findById() from the wiki page has been deprecated. so i was trying with ->findPageOrDraft() first. but looks like this only works for direct children. so i just thought i’d post this here in case anyone else struggles with it.

$page = site()->findPageOrDraft($data);   //not working
$page = site()->index(true)->find($data); //working
$page = kirby()->page($data, null, true); //working

to get a more performant solution, i also tried with the auto id plugin. but so far the suggested solution from the wiki page doesn’t seem to work. there is even an info in the auto id wiki that says the autoid() helper function "will not find drafts". so i am confused now. any thoughts @bnomei?

thank youuu! ♥️

I've set up a brand new starterkit on Laravel Valet, installed the plugin and ran php janitor -v render. This is the output I get. Any idea why this happens?

➜  kirby3-janitor git:(master) php janitor -v render
ATTENTION! Janitor created this file to load the Kirby instance: /Users/username/ubilabs/starterkit/janitor-b9767f1d0d2be1a0598bcd40b6d7dbec98952a66.php
Using Kirby instance from: /Users/username/ubilabs/starterkit/janitor-b9767f1d0d2be1a0598bcd40b6d7dbec98952a66.php
Pages: 20
Languages: 0
Rendering...
======================================================================> 100%
Found images with media/pages/* : 0
Render failed: 20
3_about: Invalid page object
home: preg_match_all(): Compilation failed: invalid range in character class at offset 20
1_photography: Invalid page object
1_photography/desert: Invalid page object
1_photography/mountains: Invalid page object
1_photography/landscape: Invalid page object
1_photography/plants: Invalid page object
1_photography/sky: Invalid page object
1_photography/trees: Invalid page object
1_photography/ocean: Invalid page object
1_photography/waterfall: Invalid page object
sandbox: preg_match_all(): Compilation failed: invalid range in character class at offset 20
2_notes: Invalid page object
2_notes/through-the-desert: Invalid page object
2_notes/a-night-in-the-forest: Invalid page object
2_notes/chasing-waterfalls: Invalid page object
2_notes/across-the-ocean: Invalid page object
2_notes/exploring-the-universe: Invalid page object
2_notes/himalaya-and-back: Invalid page object
error: preg_match_all(): Compilation failed: invalid range in character class at offset 20
200

In the current version of janitor, the data property only works for page and file models. It could be nice to be able to query data property for user too.

My use case: I need a janitor button in a user blueprint to trigger a user field update. For this, I need to get the user id in the Janitor jobs by the data property to update the right fields.

/blueprints/users/journalist.yml

journalistUpdate:
  type: janitor
  label: Confirm this update
  job: updateJournalistValidated
  data: '{{ user.id }}'

config.php

'updateJournalistValidated' => function (Kirby\Cms\Page $page = null, string $data = null ) {
            $kirby = kirby();
            $kirby->impersonate();
            $journalist = $kirby->user( $data );
            if ( !empty( $journalist ) ) :
                $journalist->update([
                    'journalistState'  => '',
                    'updateJournalistValidatedInfo' => '',
                ]);
            endif;
            return [
                'status'    => 200,
                'reload'    => true,
            ];
        },

The title says it all; I was getting multiple 404 errors from API calls while testing some of the plugin functions; search for backupzip classes and didn’t find anything ’bout it in the plugin directory.. because there’s anything about it.

I am getting

TypeError: array_merge(): Argument #2 must be of type array, null given in file /.../site/plugins/kirby3-janitor/classes/Janitor.php on line 37

when trying to use the CLI. Both my machine and server are PHP8.0. It's line

$extends = array_merge($this->options['jobs-defaults'], $this->options['jobs-extends']);

but when i get $this->options after defaults merge

array:6 [[▼]()
  "debug" => null
  "log" => null
  "jobs" => null
  "jobs-defaults" => array:1 [[▶]()]
  "jobs-extends" => null
  "secret" => null
]

So i am not loading the generated index. Surprisingly what fixes it is if i do

php site/plugins/kirby3-janitor/janitor --kirby .

now what i don't understand is that . should be same as pwd and if i put the absolute path from pwd it doesn't work.

Also this is happening on both linux and mac. Kind of wierd that . fixes it for me?

Hey, I’m using this plugin: https://github.com/thathoff/kirby-git-content which creates an endpoint like /git-content/push and I’d like to add a button in site.yml that calls that endpoint.

This example https://github.com/bnomei/kirby3-janitor/wiki/Example:-Trigger-jons-with-JS-and-Panel-Vue shows how to call endpoints but I am not sure where would I place this code. Can you advice?

Thanks!

Navigator.clipboard is available only in secure context - i.e. HTTPS active or localhost (not local domain, actual localhost).

• https://github.com/bnomei/kirby3-janitor/wiki/Panel-Field:-Copy-to-Clipboard
• https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API#interfaces

Bumps json5 from 2.2.0 to 2.2.3.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Janitor field doesn't support multi-lang labels in blueprints.

Blueprint

              downloadContent:
                label:
                  de: Content herunterladen (.zip)
                  en: Download content (.zip)
                type: janitor
                command: 'download-content'

Error:

Expected behavior

Button text would be "Content herunterladen (.zip)" if logged in with a German account, but "Download content (.zip)" if logged in with an English account.

Hello :)

When I disable UUID generation in the config, the janitor field crashes with this message:

Call to a member function toString() on null in file: /var/www/site/plugins/kirby3-janitor/index.php line: 52

This is because $model->uuid() returns null when uuids are disabled, you are however calling the toString() method on it. Since you already are providing fallback values via a null coalescing operator, a simple fix would be to use optional chaining:

                    // append model
                    if ($this->model() instanceof \Kirby\Cms\Page) {
                        $command .= ' --page ' . $this->model()->uuid()?->toString() ?? $this->model()->id();
                    } elseif ($this->model() instanceof \Kirby\Cms\File) {
                        $command .= ' --file ' . $this->model()->uuid()?->toString() ?? $this->model()->id();
                    } elseif ($this->model() instanceof \Kirby\Cms\User) {
                        $command .= ' --user ' . $this->model()->uuid()?->toString() ?? $this->model()->id();
                    } elseif ($this->model() instanceof \Kirby\Cms\Site) {
                        $command .= ' --site'; // boolean argument
                    }
                    $command .= ' --model '. $this->model()->uuid()?->toString() ??
                        ($this->model() instanceof \Kirby\Cms\Site ? 'site://' : $this->model()->id());
                    return $command;

Optional chaining is supported since PHP 8.

Hello Bruno :)

what are your thoughts about adding an info prop? Something like:

The above screenshot was done by adding 2 lines: under the button:

    <k-text v-if="help" theme="help" class="k-field-help" :html="help" />

and in the props:

    help: String,

Bumps minimatch from 3.0.4 to 3.1.2.

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.