Merge branch 'b-3.6.1' of ../kivitendo-erp_20220811

[mfinanz.git] / SL / Controller / BackgroundJob.pm

diff --git a/SL/Controller/BackgroundJob.pm b/SL/Controller/BackgroundJob.pm
index 3176eb66d5692ea5fc31d6b01dc8686deeaf601d..27a1c69a62f45d0c7d0d7e93ef36838a2af63755 100644 (file)
--- a/SL/Controller/BackgroundJob.pm
+++ b/SL/Controller/BackgroundJob.pm
@@ -4,19 +4,21 @@ use strict;
 
 use parent qw(SL::Controller::Base);
 
 
 use parent qw(SL::Controller::Base);
 

+use SL::BackgroundJob::Base;
+use SL::Controller::Helper::GetModels;

 use SL::DB::BackgroundJob;
 use SL::Helper::Flash;
 use SL::DB::BackgroundJob;
 use SL::Helper::Flash;

+use SL::JSON;
+use SL::Locale::String;

 use SL::System::TaskServer;
 
 use Rose::Object::MakeMethods::Generic
 (
 use SL::System::TaskServer;
 
 use Rose::Object::MakeMethods::Generic
 (

-  scalar                  => [ qw(background_job) ],
-  'scalar --get_set_init' => [ qw(task_server) ],
+  'scalar --get_set_init' => [ qw(task_server back_to models background_job) ],

 );
 
 __PACKAGE__->run_before('check_auth');
 __PACKAGE__->run_before('check_task_server');
 );
 
 __PACKAGE__->run_before('check_auth');
 __PACKAGE__->run_before('check_task_server');

-__PACKAGE__->run_before('load_background_job', only => [ qw(edit update destroy execute) ]);

 
 #
 # actions
 
 #
 # actions


@@ -25,21 +27,48 @@ __PACKAGE__->run_before('load_background_job', only => [ qw(edit update destroy
 sub action_list {
   my ($self) = @_;
 
 sub action_list {
   my ($self) = @_;
 

+  $self->setup_list_action_bar;

   $self->render('background_job/list',
                 title           => $::locale->text('Background jobs'),
   $self->render('background_job/list',
                 title           => $::locale->text('Background jobs'),

-                BACKGROUND_JOBS => SL::DB::Manager::BackgroundJob->get_all_sorted);
+                BACKGROUND_JOBS => $self->models->get,
+                MODELS          => $self->models);

 }
 
 sub action_new {
   my ($self) = @_;
 
 }
 
 sub action_new {
   my ($self) = @_;
 

-  $self->background_job(SL::DB::BackgroundJob->new(cron_spec => '* * * * *'));
-  $self->render('background_job/form', title => $::locale->text('Create a new background job'));
+  $self->background_job(SL::DB::BackgroundJob->new(cron_spec => '* * * * *',  package_name => 'Test')) unless $self->background_job;
+  $self->setup_form_action_bar;
+  $self->render('background_job/form',
+                title       => $::locale->text('Create a new background job'),
+                JOB_CLASSES => [ SL::BackgroundJob::Base->get_known_job_classes ]);

 }
 
 sub action_edit {
   my ($self) = @_;
 }
 
 sub action_edit {
   my ($self) = @_;

-  $self->render('background_job/form', title => $::locale->text('Edit background job'));
+
+  $self->setup_form_action_bar;
+  $self->render('background_job/form',
+                title       => $::locale->text('Edit background job'),
+                JOB_CLASSES => [ SL::BackgroundJob::Base->get_known_job_classes ]);
+}
+
+sub action_edit_as_new {
+  my ($self) = @_;
+
+  delete $::form->{background_job}->{id};
+  $self->background_job(SL::DB::BackgroundJob->new(%{ $::form->{background_job} }));
+  $self->action_new;
+}
+
+sub action_show {
+  my ($self) = @_;
+
+  if ($::request->type eq 'json') {
+    $self->render(\ SL::JSON::to_json($self->background_job->as_tree), { type => 'json' });
+  } else {
+    $self->action_edit;
+  }

 }
 
 sub action_create {
 }
 
 sub action_create {


@@ -63,12 +92,13 @@ sub action_destroy {
     flash_later('error', $::locale->text('The background job could not be destroyed.'));
   }
 
     flash_later('error', $::locale->text('The background job could not be destroyed.'));
   }
 

-  $self->redirect_to(action => 'list');
+  $self->redirect_to($self->back_to);

 }
 
 sub action_save_and_execute {
   my ($self) = @_;
 
 }
 
 sub action_save_and_execute {
   my ($self) = @_;
 

+  $self->background_job(SL::DB::BackgroundJob->new) if !$self->background_job;

   return unless $self->create_or_update;
   $self->action_execute;
 }
   return unless $self->create_or_update;
   $self->action_execute;
 }


@@ -83,7 +113,37 @@ sub action_execute {
     flash_later('error', $::locale->text('There was an error executing the background job.'));
   }
 
     flash_later('error', $::locale->text('There was an error executing the background job.'));
   }
 

-  $self->redirect_to(controller => 'BackgroundJobHistory', action => 'show', id => $history->id);
+  $self->redirect_to(controller => 'BackgroundJobHistory',
+                     action     => 'show',
+                     id         => $history->id,
+                     back_to    => $self->url_for(action => 'edit', id => $self->background_job->id));
+}
+
+sub action_execute_class {
+  my ($self) = @_;
+
+  my $result;
+
+  my $ok = eval {
+    die "no class name given in parameter 'class'" if !$::form->{class} || ($::form->{class} =~ m{[^a-z0-9]}i);
+    die "invalid class"                            if ! -f "SL/BackgroundJob/" . $::form->{class} . ".pm";
+
+    my $package = "SL::BackgroundJob::" . $::form->{class};
+
+    eval "require $package" or die $@;
+    my $job = SL::DB::BackgroundJob->new(data => $::form->{data});
+    $job->data(decode_json($::form->{json_data})) if $::form->{json_data};
+    $result = $package->new->run($job);
+
+    1;
+  };
+
+  my $reply = {
+    status => $ok ? 'succeeded' : 'failed',
+    result => $ok ? $result     : $@,
+  };
+
+  $self->render(\to_json($reply), { type => 'json' });

 }
 
 #
 }
 
 #


@@ -120,12 +180,11 @@ sub create_or_update {
   flash_later('info', $is_new ? $::locale->text('The background job has been created.') : $::locale->text('The background job has been saved.'));
   return if $return;
 
   flash_later('info', $is_new ? $::locale->text('The background job has been created.') : $::locale->text('The background job has been saved.'));
   return if $return;
 

-  $self->redirect_to(action => 'list');
+  $self->redirect_to($self->back_to);

 }
 
 }
 

-sub load_background_job {
-  my ($self) = @_;
-  $self->background_job(SL::DB::BackgroundJob->new(id => $::form->{id})->load);
+sub init_background_job {
+  return $::form->{id} ? SL::DB::BackgroundJob->new(id => $::form->{id})->load : undef;

 }
 
 sub init_task_server {
 }
 
 sub init_task_server {


@@ -137,4 +196,94 @@ sub check_task_server {
   flash('warning', $::locale->text('The task server does not appear to be running.')) if !$self->task_server->is_running;
 }
 
   flash('warning', $::locale->text('The task server does not appear to be running.')) if !$self->task_server->is_running;
 }
 

+sub init_back_to {
+  my ($self) = @_;
+  return $::form->{back_to} || $self->url_for(action => 'list');
+}
+
+sub init_models {
+  SL::Controller::Helper::GetModels->new(
+    controller => $_[0],
+    filtered => 0,
+    sorted => {
+      package_name => t8('Package name'),
+      type         => t8('Execution type'),
+      active       => t8('Active'),
+      cron_spec    => t8('Execution schedule'),
+      last_run_at  => t8('Last run at'),
+      next_run_at  => t8('Next run at'),
+    },
+    query => [
+      package_name => [ SL::BackgroundJob::Base->get_known_job_classes ],
+    ],
+  );
+}
+
+sub setup_list_action_bar {
+  my ($self) = @_;
+
+  for my $bar ($::request->layout->get('actionbar')) {
+    $bar->add(
+      link => [
+        t8('Add'),
+        link      => $self->url_for(action => 'new'),
+        accesskey => 'enter',
+      ],
+      link => [
+        t8('Server control'),
+        link => $self->url_for(controller => 'TaskServer', action => 'show'),
+      ],
+      link => [
+        t8('Job history'),
+        link => $self->url_for(controller => 'BackgroundJobHistory', action => 'list'),
+      ],
+    );
+  }
+}
+
+sub setup_form_action_bar {
+  my ($self) = @_;
+
+  my $is_new = !$self->background_job->id;
+
+  for my $bar ($::request->layout->get('actionbar')) {
+    $bar->add(
+      combobox => [
+        action => [
+          t8('Save'),
+          submit    => [ '#form', { action => 'BackgroundJob/' . ($is_new ? 'create' : 'update') } ],
+          accesskey => 'enter',
+        ],
+        action => [
+          t8('Save and execute'),
+          submit => [ '#form', { action => 'BackgroundJob/save_and_execute' } ],
+        ],
+        action => [
+          t8('Use as new'),
+          submit   => [ '#form', { action => 'BackgroundJob/edit_as_new' } ],
+          disabled => $is_new ? t8('The object has not been saved yet.') : undef,
+        ],
+      ], # end of combobox "Save"
+
+      action => [
+        t8('Delete'),
+        submit   => [ '#form', { action => 'BackgroundJob/destroy' } ],
+        confirm  => t8('Do you really want to delete this object?'),
+        disabled => $is_new ? t8('This object has not been saved yet.') : undef,
+      ],
+
+      link => [
+        t8('Abort'),
+        link => $self->url_for(action => 'list'),
+      ],
+
+      link => [
+        t8('Job history'),
+        link     => $self->url_for(controller => 'BackgroundJobHistory', action => 'list', 'filter.package_name:substr::ilike' => $self->background_job->package_name),
+        disabled => $is_new ? t8('This object has not been saved yet.') : undef,
+      ],
+    );
+  }
+}
+

 1;
 1;