X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=scripts%2Ftask_server.pl;h=f6c8f59f378910ec0f59e96d566b7fa155c3e151;hb=2b9a68bb2041ebde41a7c52db436efc8dde06350;hp=ff21183da57b1a362de2b26ea7cfe44da3a855b4;hpb=cff0e9be7e6925c22dab7cb0b52ab9e23af0d56a;p=kivitendo-erp.git

diff --git a/scripts/task_server.pl b/scripts/task_server.pl
index ff21183da..f6c8f59f3 100755
--- a/scripts/task_server.pl
+++ b/scripts/task_server.pl
@@ -1,24 +1,14 @@
 #!/usr/bin/perl
 
-
-use List::MoreUtils qw(any);
-
 use strict;
 
 my $exe_dir;
 
 BEGIN {
   use FindBin;
-  use lib "$FindBin::Bin/..";
 
-  use SL::System::Process;
-  $exe_dir = SL::System::Process::exe_dir;
-
-  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;
-
-  chdir($exe_dir) || die "Cannot change directory to ${exe_dir}\n";
+  unshift(@INC, $FindBin::Bin . '/../modules/override'); # Use our own versions of various modules (e.g. YAML).
+  push   (@INC, $FindBin::Bin . '/..');                  # '.' will be removed from @INC soon.
 }
 
 use CGI qw( -no_xhtml);
@@ -26,14 +16,16 @@ use Cwd;
 use Daemon::Generic;
 use Data::Dumper;
 use DateTime;
-use Encode qw();
 use English qw(-no_match_vars);
 use File::Spec;
+use List::MoreUtils qw(any);
 use List::Util qw(first);
-use POSIX qw(setuid setgid);
+use POSIX qw(setlocale setuid setgid);
 use SL::Auth;
+use SL::DBUpgrade2;
+use SL::DB::AuthClient;
 use SL::DB::BackgroundJob;
-use SL::BackgroundJob::ALL;
+use SL::System::Process;
 use SL::Form;
 use SL::Helper::DateTime;
 use SL::InstanceConfiguration;
@@ -41,19 +33,26 @@ use SL::LXDebug;
 use SL::LxOfficeConf;
 use SL::Locale;
 use SL::Mailer;
+use SL::System::Process;
 use SL::System::TaskServer;
 use Template;
 
 our %lx_office_conf;
+our $run_single_job;
 
 sub debug {
   return if !$lx_office_conf{task_server}->{debug};
-  $::lxdebug->message(0, @_);
+  $::lxdebug->message(LXDebug::DEBUG1(), join(' ', "task server:", @_));
 }
 
-sub lxinit {
-  my $login  = $lx_office_conf{task_server}->{login};
-  my $client = $lx_office_conf{task_server}->{client};
+sub enabled_clients {
+  return SL::DB::Manager::AuthClient->get_all(where => [ '!task_server_user_id' => undef ]);
+}
+
+sub initialize_kivitendo {
+  my ($client) = @_;
+
+  chdir $exe_dir;
 
   package main;
 
@@ -61,34 +60,48 @@ sub lxinit {
   $::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       = { cgi => CGI->new({}) };
 
-  die 'cannot reach auth db'               unless $::auth->session_tables_present;
-
-  $::auth->restore_session;
+  return if !$client;
 
-  require "bin/mozilla/common.pl";
+  $::auth->set_client($client->id);
 
-  die "cannot find user $login"            unless %::myconfig = $::auth->read_user(login => $login);
-  die "cannot find locale for user $login" unless $::locale   = Locale->new('de');
-}
+  $::form->{__ERROR_HANDLER} = sub { die @_ };
 
-sub per_job_initialization {
-  $::locale        = Locale->new($::myconfig{countrycode} || $::lx_office_conf{system}->{language});
-  $::form          = Form->new;
   $::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;
 
-  $::instance_conf->init;
+  my $login = $client->task_server_user->login;
 
-  $::form->{__ERROR_HANDLER} = sub { die @_ };
+  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});
+}
+
+sub cleanup_kivitendo {
+  eval { SL::DB->client->dbh->rollback; };
+
+  $::auth->save_session;
+  $::auth->expire_sessions;
+  $::auth->reset;
+
+  $::form     = undef;
+  $::myconfig = ();
+  $::request  = undef;
+  $::auth     = undef;
+}
+
+sub clean_before_sleeping {
+  SL::DBConnect::Cache->disconnect_all_and_clear;
+  SL::DB->db_cache->clear;
+
+  File::Temp::cleanup();
 }
 
 sub drop_privileges {
@@ -144,58 +157,149 @@ sub notify_on_failure {
     EVAL_PERL   => 0,
     ABSOLUTE    => 1,
     CACHE_SIZE  => 0,
+    ENCODING    => 'utf8',
   });
 
   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;
+  eval {
+    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      => $body,
+    )->send;
+
+    1;
+  } or do {
+    debug("Sending a failure notification failed with an exception: $@");
+  };
 }
 
 sub gd_preconfig {
   my $self = shift;
 
+  # Initialize character type locale to be UTF-8 instead of C:
+  foreach my $locale (qw(de_DE.UTF-8 en_US.UTF-8)) {
+    last if setlocale('LC_CTYPE', $locale);
+  }
+
   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 key 'client' in section [task_server] in config file" unless $lx_office_conf{task_server}->{client};
+  die "Missing section [task_server] in config file" unless $lx_office_conf{task_server};
+
+  if ($lx_office_conf{task_server}->{login} || $lx_office_conf{task_server}->{client}) {
+    print STDERR <<EOT;
+ERROR: The keys 'login' and/or 'client' are still present in the
+section [task_server] in the configuration file. These keys are
+deprecated. You have to configure the clients for which to run the
+task server in the web admin interface.
+
+The task server will refuse to start until the keys have been removed from
+the configuration file.
+EOT
+    exit 2;
+  }
+
+  initialize_kivitendo();
+
+  my $dbupdater_auth = SL::DBUpgrade2->new(form => $::form, auth => 1)->parse_dbupdate_controls;
+  if ($dbupdater_auth->unapplied_upgrade_scripts($::auth->dbconnect)) {
+    print STDERR <<EOT;
+The authentication database requires an upgrade. Please login to
+kivitendo's administration interface in order to apply it. The task
+server cannot start until the upgrade has been applied.
+EOT
+    exit 2;
+  }
 
   drop_privileges();
-  lxinit();
 
   return ();
 }
 
-sub gd_run {
-  while (1) {
+sub run_single_job_for_all_clients {
+  initialize_kivitendo();
+
+  my $clients = enabled_clients();
+
+  foreach my $client (@{ $clients }) {
+    debug("Running single job ID $run_single_job for client ID " . $client->id . " (" . $client->name . ")");
+
     my $ok = eval {
-      debug("Retrieving jobs");
+      initialize_kivitendo($client);
+
+      my $job = SL::DB::Manager::BackgroundJob->find_by(id => $run_single_job);
+
+      if ($job) {
+        debug(" Executing the following job: " . $job->package_name);
+      } else {
+        debug(" No jobs to execute found");
+        next;
+      }
+
+      # Provide fresh global variables in case legacy code modifies
+      # them somehow.
+      initialize_kivitendo($client);
+
+      my $history = $job->run;
+
+      debug("   Executed job " . $job->package_name .
+            "; result: " . (!$history ? "no return value" : $history->has_failed ? "failed" : "succeeded") .
+            ($history && $history->has_failed ? "; error: " . $history->error_col : ""));
+
+      notify_on_failure(history => $history) if $history && $history->has_failed;
+
+      1;
+    };
+
+    if (!$ok) {
+      my $error = $EVAL_ERROR;
+      $::lxdebug->message(LXDebug::WARN(), "Exception during execution: ${error}");
+      notify_on_failure(exception => $error);
+    }
+
+    cleanup_kivitendo();
+  }
+}
+
+sub run_once_for_all_clients {
+  initialize_kivitendo();
+
+  my $clients = enabled_clients();
+
+  foreach my $client (@{ $clients }) {
+    debug("Running for client ID " . $client->id . " (" . $client->name . ")");
+
+    my $ok = eval {
+      initialize_kivitendo($client);
 
       my $jobs = SL::DB::Manager::BackgroundJob->get_all_need_to_run;
 
-      debug("  Found: " . join(' ', map { $_->package_name } @{ $jobs })) if @{ $jobs };
+      if (@{ $jobs }) {
+        debug(" Executing the following jobs: " . join(' ', map { $_->package_name } @{ $jobs }));
+      } else {
+        debug(" No jobs to execute found");
+      }
 
       foreach my $job (@{ $jobs }) {
         # Provide fresh global variables in case legacy code modifies
         # them somehow.
-        per_job_initialization();
-
-        chdir $exe_dir;
+        initialize_kivitendo($client);
 
         my $history = $job->run;
 
+        debug("   Executed job " . $job->package_name .
+              "; result: " . (!$history ? "no return value" : $history->has_failed ? "failed" : "succeeded") .
+              ($history && $history->has_failed ? "; error: " . $history->error_col : ""));
+
         notify_on_failure(history => $history) if $history && $history->has_failed;
       }
 
@@ -204,15 +308,39 @@ sub gd_run {
 
     if (!$ok) {
       my $error = $EVAL_ERROR;
-      debug("Exception during execution: ${error}");
+      $::lxdebug->message(LXDebug::WARN(), "Exception during execution: ${error}");
       notify_on_failure(exception => $error);
     }
 
+    cleanup_kivitendo();
+  }
+}
+
+sub gd_run {
+  if ($run_single_job) {
+    run_single_job_for_all_clients();
+    return;
+  }
+  $::lxdebug->message(LXDebug::INFO(), "The task server for node " . SL::System::TaskServer::node_id() . " is up and running.");
+
+  while (1) {
+    $SIG{'ALRM'} = 'IGNORE';
+
+    run_once_for_all_clients();
+
     debug("Sleeping");
 
+    clean_before_sleeping();
+
+    if (SL::System::Process::memory_usage_is_too_high()) {
+      debug("Memory usage too high - exiting.");
+      return;
+    }
+
     my $seconds = 60 - (localtime)[0];
     if (!eval {
-      local $SIG{'ALRM'} = sub {
+      $SIG{'ALRM'} = sub {
+        $SIG{'ALRM'} = 'IGNORE';
         debug("Got woken up by SIGALRM");
         die "Alarm!\n"
       };
@@ -224,18 +352,14 @@ sub gd_run {
   }
 }
 
-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
-
+sub gd_flags_more {
+  return (
+    '--run-job=<id>' => 'Run the single job with the database ID <id> no matter if it is active or when its next execution is supposed to be; the daemon will exit afterwards',
+  );
 }
 
-chdir $exe_dir;
+$exe_dir = SL::System::Process->exe_dir;
+chdir($exe_dir) || die "Cannot change directory to ${exe_dir}\n";
 
 mkdir SL::System::TaskServer::PID_BASE() if !-d SL::System::TaskServer::PID_BASE();
 
@@ -248,6 +372,9 @@ $file = File::Spec->abs2rel(Cwd::abs_path($file), Cwd::abs_path($exe_dir));
 newdaemon(configfile => $file,
           progname   => 'kivitendo-background-jobs',
           pidbase    => SL::System::TaskServer::PID_BASE() . '/',
+          options    => {
+            'run-job=i' => \$run_single_job,
+          },
           );
 
 1;