scripts/task_server.pl

   1 #!/usr/bin/perl
   2
   3
   4 use List::MoreUtils qw(any);
   5
   6 use strict;
   7
   8 my $exe_dir;
   9
  10 BEGIN {
  11   use FindBin;
  12   use lib "$FindBin::Bin/..";
  13
  14   use SL::System::Process;
  15   $exe_dir = SL::System::Process::exe_dir;
  16
  17   unshift @INC, "${exe_dir}/modules/override"; # Use our own versions of various modules (e.g. YAML).
  18   push    @INC, "${exe_dir}/modules/fallback"; # Only use our own versions of modules if there's no system version.
  19   unshift @INC, $exe_dir;
  20
  21   chdir($exe_dir) || die "Cannot change directory to ${exe_dir}\n";
  22 }
  23
  24 use CGI qw( -no_xhtml);
  25 use Cwd;
  26 use Daemon::Generic;
  27 use Data::Dumper;
  28 use DateTime;
  29 use Encode qw();
  30 use English qw(-no_match_vars);
  31 use File::Spec;
  32 use List::Util qw(first);
  33 use POSIX qw(setuid setgid);
  34 use SL::Auth;
  35 use SL::DB::BackgroundJob;
  36 use SL::BackgroundJob::ALL;
  37 use SL::Form;
  38 use SL::Helper::DateTime;
  39 use SL::InstanceConfiguration;
  40 use SL::LXDebug;
  41 use SL::LxOfficeConf;
  42 use SL::Locale;
  43 use SL::Mailer;
  44 use SL::System::TaskServer;
  45 use Template;
  46
  47 our %lx_office_conf;
  48
  49 sub debug {
  50   return if !$lx_office_conf{task_server}->{debug};
  51   $::lxdebug->message(0, @_);
  52 }
  53
  54 sub lxinit {
  55   my $login  = $lx_office_conf{task_server}->{login};
  56   my $client = $lx_office_conf{task_server}->{client};
  57
  58   package main;
  59
  60   $::lxdebug       = LXDebug->new;
  61   $::locale        = Locale->new($::lx_office_conf{system}->{language});
  62   $::form          = Form->new;
  63   $::auth          = SL::Auth->new;
  64   die "No client configured or no client found with the name/ID '$client'" unless $::auth->set_client($client);
  65   $::instance_conf = SL::InstanceConfiguration->new;
  66   $::request       = { cgi => CGI->new({}) };
  67
  68   die 'cannot reach auth db'               unless $::auth->session_tables_present;
  69
  70   $::auth->restore_session;
  71
  72   require "bin/mozilla/common.pl";
  73
  74   die "cannot find user $login"            unless %::myconfig = $::auth->read_user(login => $login);
  75   die "cannot find locale for user $login" unless $::locale   = Locale->new('de');
  76 }
  77
  78 sub per_job_initialization {
  79   $::locale        = Locale->new($::myconfig{countrycode} || $::lx_office_conf{system}->{language});
  80   $::form          = Form->new;
  81   $::instance_conf = SL::InstanceConfiguration->new;
  82   $::request       = SL::Request->new(
  83     cgi            => CGI->new({}),
  84     layout         => SL::Layout::None->new,
  85   );
  86
  87   $::auth->restore_session;
  88
  89   $::form->{login} = $lx_office_conf{task_server}->{login};
  90   $::instance_conf->init;
  91
  92   $::form->{__ERROR_HANDLER} = sub { die @_ };
  93 }
  94
  95 sub drop_privileges {
  96   my $user = $lx_office_conf{task_server}->{run_as};
  97   return unless $user;
  98
  99   my ($uid, $gid);
 100   while (my @details = getpwent()) {
 101     next unless $details[0] eq $user;
 102     ($uid, $gid) = @details[2, 3];
 103     last;
 104   }
 105   endpwent();
 106
 107   if (!$uid) {
 108     print "Error: Cannot drop privileges to ${user}: user does not exist\n";
 109     exit 1;
 110   }
 111
 112   if (!setgid($gid)) {
 113     print "Error: Cannot drop group privileges to ${user} (group ID $gid): $!\n";
 114     exit 1;
 115   }
 116
 117   if (!setuid($uid)) {
 118     print "Error: Cannot drop user privileges to ${user} (user ID $uid): $!\n";
 119     exit 1;
 120   }
 121 }
 122
 123 sub notify_on_failure {
 124   my (%params) = @_;
 125
 126   my $cfg = $lx_office_conf{'task_server/notify_on_failure'} || {};
 127
 128   return if any { !$cfg->{$_} } qw(send_email_to email_from email_subject email_template);
 129
 130   chdir $exe_dir;
 131
 132   return debug("Template " . $cfg->{email_template} . " missing!") unless -f $cfg->{email_template};
 133
 134   my $email_to = $cfg->{send_email_to};
 135   if ($email_to !~ m{\@}) {
 136     my %user = $::auth->read_user(login => $email_to);
 137     return debug("cannot find user for notification $email_to") unless %user;
 138
 139     $email_to = $user{email};
 140     return debug("user for notification " . $user{login} . " doesn't have a valid email address") unless $email_to =~ m{\@};
 141   }
 142
 143   my $template  = Template->new({
 144     INTERPOLATE => 0,
 145     EVAL_PERL   => 0,
 146     ABSOLUTE    => 1,
 147     CACHE_SIZE  => 0,
 148   });
 149
 150   return debug("Could not create Template instance") unless $template;
 151
 152   $params{client} = $::auth->client;
 153
 154   my $body;
 155   $template->process($cfg->{email_template}, \%params, \$body);
 156
 157   Mailer->new(
 158     from         => $cfg->{email_from},
 159     to           => $email_to,
 160     subject      => $cfg->{email_subject},
 161     content_type => 'text/plain',
 162     charset      => 'utf-8',
 163     message      => Encode::decode('utf-8', $body),
 164   )->send;
 165 }
 166
 167 sub gd_preconfig {
 168   my $self = shift;
 169
 170   SL::LxOfficeConf->read($self->{configfile});
 171
 172   die "Missing section [task_server] in config file"                 unless $lx_office_conf{task_server};
 173   die "Missing key 'login' in section [task_server] in config file"  unless $lx_office_conf{task_server}->{login};
 174   die "Missing key 'client' in section [task_server] in config file" unless $lx_office_conf{task_server}->{client};
 175
 176   drop_privileges();
 177   lxinit();
 178
 179   return ();
 180 }
 181
 182 sub gd_run {
 183   while (1) {
 184     my $ok = eval {
 185       debug("Retrieving jobs");
 186
 187       my $jobs = SL::DB::Manager::BackgroundJob->get_all_need_to_run;
 188
 189       debug("  Found: " . join(' ', map { $_->package_name } @{ $jobs })) if @{ $jobs };
 190
 191       foreach my $job (@{ $jobs }) {
 192         # Provide fresh global variables in case legacy code modifies
 193         # them somehow.
 194         per_job_initialization();
 195
 196         chdir $exe_dir;
 197
 198         my $history = $job->run;
 199
 200         notify_on_failure(history => $history) if $history && $history->has_failed;
 201       }
 202
 203       1;
 204     };
 205
 206     if (!$ok) {
 207       my $error = $EVAL_ERROR;
 208       debug("Exception during execution: ${error}");
 209       notify_on_failure(exception => $error);
 210     }
 211
 212     debug("Sleeping");
 213
 214     my $seconds = 60 - (localtime)[0];
 215     if (!eval {
 216       local $SIG{'ALRM'} = sub {
 217         debug("Got woken up by SIGALRM");
 218         die "Alarm!\n"
 219       };
 220       sleep($seconds < 30 ? $seconds + 60 : $seconds);
 221       1;
 222     }) {
 223       die $@ unless $@ eq "Alarm!\n";
 224     }
 225   }
 226 }
 227
 228 sub end_of_request {
 229   $main::lxdebug->show_backtrace();
 230   die <<EOF;
 231 Job called ::end_of_request()!
 232
 233 This usually indicates success but should not be used by background jobs. A
 234 backtrace has been logged. Please tell the job author to have a look at it.
 235 EOF
 236
 237 }
 238
 239 chdir $exe_dir;
 240
 241 mkdir SL::System::TaskServer::PID_BASE() if !-d SL::System::TaskServer::PID_BASE();
 242
 243 my $file = first { -f } ("${exe_dir}/config/kivitendo.conf", "${exe_dir}/config/lx_office.conf", "${exe_dir}/config/kivitendo.conf.default");
 244
 245 die "No configuration file found." unless $file;
 246
 247 $file = File::Spec->abs2rel(Cwd::abs_path($file), Cwd::abs_path($exe_dir));
 248
 249 newdaemon(configfile => $file,
 250           progname   => 'kivitendo-background-jobs',
 251           pidbase    => SL::System::TaskServer::PID_BASE() . '/',
 252           );
 253
 254 1;