kivitendo/SL/Controller/BackgroundJob.pm @ f9210dae
32ccf639 | Moritz Bunkus | package SL::Controller::BackgroundJob;
|
||
use strict;
|
||||
use parent qw(SL::Controller::Base);
|
||||
ef8a858d | Moritz Bunkus | use SL::BackgroundJob::Base;
|
||
5be585d1 | Moritz Bunkus | use SL::Controller::Helper::GetModels;
|
||
32ccf639 | Moritz Bunkus | use SL::DB::BackgroundJob;
|
||
use SL::Helper::Flash;
|
||||
d83769ec | Moritz Bunkus | use SL::JSON;
|
||
3e52fa98 | Moritz Bunkus | use SL::Locale::String;
|
||
32ccf639 | Moritz Bunkus | use SL::System::TaskServer;
|
||
use Rose::Object::MakeMethods::Generic
|
||||
(
|
||||
f751112d | Moritz Bunkus | 'scalar --get_set_init' => [ qw(task_server back_to models background_job) ],
|
||
32ccf639 | Moritz Bunkus | );
|
||
__PACKAGE__->run_before('check_auth');
|
||||
__PACKAGE__->run_before('check_task_server');
|
||||
#
|
||||
# actions
|
||||
#
|
||||
sub action_list {
|
||||
my ($self) = @_;
|
||||
1df575c4 | Moritz Bunkus | $self->setup_list_action_bar;
|
||
32ccf639 | Moritz Bunkus | $self->render('background_job/list',
|
||
title => $::locale->text('Background jobs'),
|
||||
783342e0 | Sven Schöling | BACKGROUND_JOBS => $self->models->get,
|
||
MODELS => $self->models);
|
||||
32ccf639 | Moritz Bunkus | }
|
||
sub action_new {
|
||||
my ($self) = @_;
|
||||
2394dc67 | Moritz Bunkus | $self->background_job(SL::DB::BackgroundJob->new(cron_spec => '* * * * *', package_name => 'Test')) unless $self->background_job;
|
||
1df575c4 | Moritz Bunkus | $self->setup_form_action_bar;
|
||
ef8a858d | Moritz Bunkus | $self->render('background_job/form',
|
||
title => $::locale->text('Create a new background job'),
|
||||
JOB_CLASSES => [ SL::BackgroundJob::Base->get_known_job_classes ]);
|
||||
32ccf639 | Moritz Bunkus | }
|
||
sub action_edit {
|
||||
my ($self) = @_;
|
||||
ef8a858d | Moritz Bunkus | |||
1df575c4 | Moritz Bunkus | $self->setup_form_action_bar;
|
||
ef8a858d | Moritz Bunkus | $self->render('background_job/form',
|
||
title => $::locale->text('Edit background job'),
|
||||
JOB_CLASSES => [ SL::BackgroundJob::Base->get_known_job_classes ]);
|
||||
32ccf639 | Moritz Bunkus | }
|
||
2394dc67 | Moritz Bunkus | sub action_edit_as_new {
|
||
my ($self) = @_;
|
||||
9445af68 | Moritz Bunkus | delete $::form->{background_job}->{id};
|
||
$self->background_job(SL::DB::BackgroundJob->new(%{ $::form->{background_job} }));
|
||||
2394dc67 | Moritz Bunkus | $self->action_new;
|
||
}
|
||||
2c597c2d | Sven Schöling | 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;
|
||||
}
|
||||
}
|
||||
32ccf639 | Moritz Bunkus | sub action_create {
|
||
my ($self) = @_;
|
||||
$self->background_job(SL::DB::BackgroundJob->new);
|
||||
$self->create_or_update;
|
||||
}
|
||||
sub action_update {
|
||||
my ($self) = @_;
|
||||
$self->create_or_update;
|
||||
}
|
||||
sub action_destroy {
|
||||
my ($self) = @_;
|
||||
if (eval { $self->background_job->delete; 1; }) {
|
||||
flash_later('info', $::locale->text('The background job has been deleted.'));
|
||||
} else {
|
||||
flash_later('error', $::locale->text('The background job could not be destroyed.'));
|
||||
}
|
||||
5be585d1 | Moritz Bunkus | $self->redirect_to($self->back_to);
|
||
32ccf639 | Moritz Bunkus | }
|
||
sub action_save_and_execute {
|
||||
my ($self) = @_;
|
||||
0dc2d52f | Moritz Bunkus | $self->background_job(SL::DB::BackgroundJob->new) if !$self->background_job;
|
||
32ccf639 | Moritz Bunkus | return unless $self->create_or_update;
|
||
$self->action_execute;
|
||||
}
|
||||
sub action_execute {
|
||||
my ($self) = @_;
|
||||
my $history = $self->background_job->run;
|
||||
if ($history->status eq 'success') {
|
||||
flash_later('info', $::locale->text('The background job was executed successfully.'));
|
||||
} else {
|
||||
flash_later('error', $::locale->text('There was an error executing the background job.'));
|
||||
}
|
||||
23a8d2c0 | Moritz Bunkus | $self->redirect_to(controller => 'BackgroundJobHistory',
|
||
action => 'show',
|
||||
id => $history->id,
|
||||
back_to => $self->url_for(action => 'edit', id => $self->background_job->id));
|
||||
32ccf639 | Moritz Bunkus | }
|
||
d83769ec | Moritz Bunkus | 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 $@;
|
||||
59c8afd6 | Moritz Bunkus | 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);
|
||||
d83769ec | Moritz Bunkus | |||
1;
|
||||
};
|
||||
my $reply = {
|
||||
status => $ok ? 'succeeded' : 'failed',
|
||||
result => $ok ? $result : $@,
|
||||
};
|
||||
$self->render(\to_json($reply), { type => 'json' });
|
||||
}
|
||||
32ccf639 | Moritz Bunkus | #
|
||
# filters
|
||||
#
|
||||
sub check_auth {
|
||||
$::auth->assert('admin');
|
||||
}
|
||||
#
|
||||
# helpers
|
||||
#
|
||||
sub create_or_update {
|
||||
my $self = shift;
|
||||
my $return = shift;
|
||||
my $is_new = !$self->background_job->id;
|
||||
my $params = delete($::form->{background_job}) || { };
|
||||
$self->background_job->assign_attributes(%{ $params });
|
||||
my @errors = $self->background_job->validate;
|
||||
if (@errors) {
|
||||
flash('error', @errors);
|
||||
$self->render('background_job/form', title => $is_new ? $::locale->text('Create a new background job') : $::locale->text('Edit background job'));
|
||||
return;
|
||||
}
|
||||
$self->background_job->update_next_run_at;
|
||||
$self->background_job->save;
|
||||
flash_later('info', $is_new ? $::locale->text('The background job has been created.') : $::locale->text('The background job has been saved.'));
|
||||
return if $return;
|
||||
5be585d1 | Moritz Bunkus | $self->redirect_to($self->back_to);
|
||
32ccf639 | Moritz Bunkus | }
|
||
f751112d | Moritz Bunkus | sub init_background_job {
|
||
return $::form->{id} ? SL::DB::BackgroundJob->new(id => $::form->{id})->load : undef;
|
||||
32ccf639 | Moritz Bunkus | }
|
||
sub init_task_server {
|
||||
return SL::System::TaskServer->new;
|
||||
}
|
||||
sub check_task_server {
|
||||
my ($self) = @_;
|
||||
flash('warning', $::locale->text('The task server does not appear to be running.')) if !$self->task_server->is_running;
|
||||
}
|
||||
5be585d1 | Moritz Bunkus | sub init_back_to {
|
||
my ($self) = @_;
|
||||
return $::form->{back_to} || $self->url_for(action => 'list');
|
||||
}
|
||||
783342e0 | Sven Schöling | 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'),
|
||||
},
|
||||
8e09219f | Moritz Bunkus | query => [
|
||
package_name => [ SL::BackgroundJob::Base->get_known_job_classes ],
|
||||
],
|
||||
783342e0 | Sven Schöling | );
|
||
}
|
||||
1df575c4 | Moritz Bunkus | 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' } ],
|
||||
],
|
||||
2394dc67 | Moritz Bunkus | action => [
|
||
t8('Use as new'),
|
||||
submit => [ '#form', { action => 'BackgroundJob/edit_as_new' } ],
|
||||
disabled => $is_new ? t8('The object has not been saved yet.') : undef,
|
||||
],
|
||||
1df575c4 | Moritz Bunkus | ], # end of combobox "Save"
|
||
action => [
|
||||
t8('Delete'),
|
||||
8101dcde | Bernd Bleßmann | submit => [ '#form', { action => 'BackgroundJob/destroy' } ],
|
||
1df575c4 | Moritz Bunkus | 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,
|
||||
],
|
||||
);
|
||||
}
|
||||
}
|
||||
32ccf639 | Moritz Bunkus | 1;
|