#!/usr/bin/perl
+
+use List::MoreUtils qw(any);
+
use strict;
+my $exe_dir;
+
BEGIN {
- require Cwd;
+ use FindBin;
+ use lib "$FindBin::Bin/..";
- my $dir = $0;
- $dir = Cwd::getcwd() . '/' . $dir unless $dir =~ m|^/|;
- $dir =~ s|[^/]+$|..|;
+ use SL::System::Process;
+ $exe_dir = SL::System::Process::exe_dir;
- chdir($dir) || die "Cannot change directory to ${dir}\n";
+ unshift @INC, "${exe_dir}/modules/override"; # Use our own versions of various modules (e.g. YAML).
+ push @INC, "${exe_dir}/modules/fallback"; # Only use our own versions of modules if there's no system version.
+ unshift @INC, $exe_dir;
- unshift @INC, "modules/override"; # Use our own versions of various modules (e.g. YAML).
- push @INC, "modules/fallback"; # Only use our own versions of modules if there's no system version.
+ chdir($exe_dir) || die "Cannot change directory to ${exe_dir}\n";
}
use CGI qw( -no_xhtml);
-use Config::Std;
use Cwd;
use Daemon::Generic;
use Data::Dumper;
use DateTime;
+use Encode qw();
use English qw(-no_match_vars);
+use File::Spec;
+use List::Util qw(first);
use POSIX qw(setuid setgid);
use SL::Auth;
use SL::DB::BackgroundJob;
use SL::BackgroundJob::ALL;
use SL::Form;
use SL::Helper::DateTime;
+use SL::InstanceConfiguration;
use SL::LXDebug;
+use SL::LxOfficeConf;
use SL::Locale;
+use SL::Mailer;
+use SL::System::TaskServer;
+use Template;
our %lx_office_conf;
-# this is a cleaned up version of am.pl
-# it lacks redirection, some html setup and most of the authentication process.
-# it is assumed that anyone with physical access and execution rights on this script
-# won't be hindered by authentication anyway.
-sub lxinit {
- my $login = $lx_office_conf{task_server}->{login};
+sub debug {
+ return if !$lx_office_conf{task_server}->{debug};
+ $::lxdebug->message(0, @_);
+}
- package main;
+sub initialize_kivitendo {
+ chdir $exe_dir;
- eval { require "config/lx-erp.conf"; 1; } or die $EVAL_ERROR;
- eval { require "config/lx-erp-local.conf"; 1; } or die $EVAL_ERROR if -f "config/lx-erp-local.conf";
+ my $login = $lx_office_conf{task_server}->{login};
+ my $client = $lx_office_conf{task_server}->{client};
- $::lxdebug = LXDebug->new;
- $::locale = Locale->new($::language);
- $::cgi = CGI->new qw();
- $::form = Form->new;
- $::auth = SL::Auth->new;
+ package main;
+
+ Form::disconnect_standard_dbh;
+ $::lxdebug = LXDebug->new;
+ $::locale = Locale->new($::lx_office_conf{system}->{language});
+ $::form = Form->new;
+ $::auth = SL::Auth->new;
+ die "No client configured or no client found with the name/ID '$client'" unless $::auth->set_client($client);
+ $::instance_conf = SL::InstanceConfiguration->new;
+ $::request = SL::Request->new(
+ cgi => CGI->new({}),
+ layout => SL::Layout::None->new,
+ );
die 'cannot reach auth db' unless $::auth->session_tables_present;
$::auth->restore_session;
+ $::auth->create_or_refresh_session;
- require "bin/mozilla/common.pl";
+ die "cannot find user $login" unless %::myconfig = $::auth->read_user(login => $login);
+ die "cannot find locale for user $login" unless $::locale = Locale->new($::myconfig{countrycode} || $::lx_office_conf{system}->{language});
- die "cannot find user $login" unless %::myconfig = $::auth->read_user($login);
- die "cannot find locale for user $login" unless $::locale = Locale->new('de');
+ $::form->{__ERROR_HANDLER} = sub { die @_ };
+}
+
+sub cleanup_kivitendo {
+ eval { SL::DB::Auth->new->db->dbh->rollback; };
+ eval { SL::DB::BackgroundJob->new->db->dbh->rollback; };
+
+ $::auth->save_session;
+ $::auth->expire_sessions;
+ $::auth->reset;
+
+ $::form = undef;
+ $::myconfig = ();
+ $::request = undef;
+ Form::disconnect_standard_dbh;
}
sub drop_privileges {
}
}
+sub notify_on_failure {
+ my (%params) = @_;
+
+ my $cfg = $lx_office_conf{'task_server/notify_on_failure'} || {};
+
+ return if any { !$cfg->{$_} } qw(send_email_to email_from email_subject email_template);
+
+ chdir $exe_dir;
+
+ return debug("Template " . $cfg->{email_template} . " missing!") unless -f $cfg->{email_template};
+
+ my $email_to = $cfg->{send_email_to};
+ if ($email_to !~ m{\@}) {
+ my %user = $::auth->read_user(login => $email_to);
+ return debug("cannot find user for notification $email_to") unless %user;
+
+ $email_to = $user{email};
+ return debug("user for notification " . $user{login} . " doesn't have a valid email address") unless $email_to =~ m{\@};
+ }
+
+ my $template = Template->new({
+ INTERPOLATE => 0,
+ EVAL_PERL => 0,
+ ABSOLUTE => 1,
+ CACHE_SIZE => 0,
+ });
+
+ return debug("Could not create Template instance") unless $template;
+
+ $params{client} = $::auth->client;
+
+ my $body;
+ $template->process($cfg->{email_template}, \%params, \$body);
+
+ Mailer->new(
+ from => $cfg->{email_from},
+ to => $email_to,
+ subject => $cfg->{email_subject},
+ content_type => 'text/plain',
+ charset => 'utf-8',
+ message => Encode::decode('utf-8', $body),
+ )->send;
+}
+
sub gd_preconfig {
my $self = shift;
- read_config $self->{configfile} => %lx_office_conf;
+ SL::LxOfficeConf->read($self->{configfile});
- die "Missing section [task_server] in config file" unless $lx_office_conf{task_server};
- die "Missing key 'login' in section [task_server] in config file" unless $lx_office_conf{task_server}->{login};
+ die "Missing section [task_server] in config file" unless $lx_office_conf{task_server};
+ die "Missing key 'login' in section [task_server] in config file" unless $lx_office_conf{task_server}->{login};
+ die "Missing key 'client' in section [task_server] in config file" unless $lx_office_conf{task_server}->{client};
drop_privileges();
- lxinit();
+ initialize_kivitendo();
return ();
}
sub gd_run {
while (1) {
my $ok = eval {
- $::lxdebug->message(0, "Retrieving jobs") if $lx_office_conf{task_server}->{debug};
+ initialize_kivitendo();
+
+ debug("Retrieving jobs");
my $jobs = SL::DB::Manager::BackgroundJob->get_all_need_to_run;
- $::lxdebug->message(0, " Found: " . join(' ', map { $_->package_name } @{ $jobs })) if $lx_office_conf{task_server}->{debug} && @{ $jobs };
+ debug(" Found: " . join(' ', map { $_->package_name } @{ $jobs })) if @{ $jobs };
foreach my $job (@{ $jobs }) {
# Provide fresh global variables in case legacy code modifies
# them somehow.
- $::locale = Locale->new($::language);
- $::form = Form->new;
+ initialize_kivitendo();
+
+ my $history = $job->run;
- $job->run;
+ notify_on_failure(history => $history) if $history && $history->has_failed;
}
1;
};
- if ($lx_office_conf{task_server}->{debug}) {
- $::lxdebug->message(0, "Exception during execution: ${EVAL_ERROR}") if !$ok;
- $::lxdebug->message(0, "Sleeping");
+ if (!$ok) {
+ my $error = $EVAL_ERROR;
+ debug("Exception during execution: ${error}");
+ notify_on_failure(exception => $error);
}
+ cleanup_kivitendo();
+
+ debug("Sleeping");
+
my $seconds = 60 - (localtime)[0];
- sleep($seconds < 30 ? $seconds + 60 : $seconds);
+ if (!eval {
+ local $SIG{'ALRM'} = sub {
+ debug("Got woken up by SIGALRM");
+ die "Alarm!\n"
+ };
+ sleep($seconds < 30 ? $seconds + 60 : $seconds);
+ 1;
+ }) {
+ die $@ unless $@ eq "Alarm!\n";
+ }
}
}
-my $cwd = getcwd();
-my $pidbase = "${cwd}/users/pid";
+sub end_of_request {
+ $main::lxdebug->show_backtrace();
+ die <<EOF;
+Job called ::end_of_request()!
+
+This usually indicates success but should not be used by background jobs. A
+backtrace has been logged. Please tell the job author to have a look at it.
+EOF
+
+}
+
+chdir $exe_dir;
+
+mkdir SL::System::TaskServer::PID_BASE() if !-d SL::System::TaskServer::PID_BASE();
+
+my $file = first { -f } ("${exe_dir}/config/kivitendo.conf", "${exe_dir}/config/lx_office.conf", "${exe_dir}/config/kivitendo.conf.default");
+
+die "No configuration file found." unless $file;
-mkdir($pidbase) if !-d $pidbase;
+$file = File::Spec->abs2rel(Cwd::abs_path($file), Cwd::abs_path($exe_dir));
-newdaemon(configfile => "${cwd}/config/lx_office.conf",
- progname => 'lx-office-task-server',
- pidbase => "${pidbase}/",
+newdaemon(configfile => $file,
+ progname => 'kivitendo-background-jobs',
+ pidbase => SL::System::TaskServer::PID_BASE() . '/',
);
1;