Hintergrundjob-Validierung: 'keine Spec' als '* * * * *' behandeln
[kivitendo-erp.git] / SL / DB / BackgroundJob.pm
1 package SL::DB::BackgroundJob;
2
3 use strict;
4
5 use DateTime::Event::Cron;
6 use English qw(-no_match_vars);
7
8 use SL::DB::MetaSetup::BackgroundJob;
9 use SL::DB::Manager::BackgroundJob;
10
11 use SL::DB::BackgroundJobHistory;
12
13 use SL::BackgroundJob::Test;
14 use SL::System::Process;
15
16 __PACKAGE__->before_save('_before_save_set_next_run_at');
17
18 sub _before_save_set_next_run_at {
19   my ($self) = @_;
20
21   $self->update_next_run_at if !$self->next_run_at;
22   return 1;
23 }
24
25 sub update_next_run_at {
26   my $self = shift;
27
28   my $cron = DateTime::Event::Cron->new_from_cron($self->cron_spec || '* * * * *');
29   $self->update_attributes(next_run_at => $cron->next(DateTime->now_local));
30   return $self;
31 }
32
33 sub run {
34   my $self = shift;
35
36   my $package = "SL::BackgroundJob::" . $self->package_name;
37   my $run_at  = DateTime->now_local;
38   my $history;
39
40   my $ok = eval {
41     my $result = $package->new->run($self);
42
43     $history = SL::DB::BackgroundJobHistory
44       ->new(package_name => $self->package_name,
45             run_at       => $run_at,
46             status       => 'success',
47             result       => $result,
48             data         => $self->data);
49     $history->save;
50
51     1;
52   };
53
54   if (!$ok) {
55     my $error = $EVAL_ERROR;
56     $history = SL::DB::BackgroundJobHistory
57       ->new(package_name => $self->package_name,
58             run_at       => $run_at,
59             status       => 'failure',
60             error_col    => $error,
61             data         => $self->data);
62     $history->save;
63
64     $::lxdebug->message(LXDebug->WARN(), "BackgroundJob ID " . $self->id . " execution error (first three lines): " . join("\n", (split(m/\n/, $error))[0..2]));
65   }
66
67   $self->assign_attributes(last_run_at => $run_at)->update_next_run_at;
68
69   return $history;
70 }
71
72 sub data_as_hash {
73   my $self = shift;
74   return {}                        if !$self->data;
75   return $self->data               if ref($self->{data}) eq 'HASH';
76   return YAML::Load($self->{data}) if !ref($self->{data});
77   return {};
78 }
79
80 sub validate {
81   my ($self) = @_;
82
83   my @errors;
84
85   push @errors, $::locale->text('The execution type is invalid.') if ($self->type         || '') !~ m/^(?: once | interval )$/x;
86
87   if (   (($self->package_name || '') !~ m/^ [A-Z][A-Za-z0-9]+ $/x)
88       || ! -f (SL::System::Process::exe_dir() . "/SL/BackgroundJob/" . $self->package_name . ".pm")) {
89     push @errors, $::locale->text('The package name is invalid.');
90   }
91
92   eval {
93     DateTime::Event::Cron->new_from_cron($self->cron_spec || '* * * * *')->next(DateTime->now_local);
94     1;
95   } or push @errors, $::locale->text('The execution schedule is invalid.');
96
97   return @errors;
98 }
99
100 1;