Merge branch 'b-3.6.1' of ../kivitendo-erp_20220811
[kivitendo-erp.git] / SL / Dispatcher.pm
index 77074cc..31c76a5 100644 (file)
@@ -7,25 +7,18 @@ use strict;
 #   parse_html_template('login_screen/user_login')
 #   parse_html_template('generic/error')
 
-BEGIN {
-  use SL::System::Process;
-  my $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;
-}
-
 use Carp;
 use CGI qw( -no_xhtml);
 use Config::Std;
 use DateTime;
 use Encode;
 use English qw(-no_match_vars);
+use FCGI;
 use File::Basename;
+use IO::File;
 use List::MoreUtils qw(all);
 use List::Util qw(first);
-use SL::ArchiveZipFixes;
+use POSIX qw(setlocale);
 use SL::Auth;
 use SL::Dispatcher::AuthHandler;
 use SL::LXDebug;
@@ -36,9 +29,14 @@ use SL::Common;
 use SL::Form;
 use SL::Helper::DateTime;
 use SL::InstanceConfiguration;
+use SL::MoreCommon qw(uri_encode);
 use SL::Template::Plugin::HTMLFixes;
 use SL::User;
 
+use Rose::Object::MakeMethods::Generic (
+  scalar => [ qw(restart_after_request) ],
+);
+
 # Trailing new line is added so that Perl will not add the line
 # number 'die' was called in.
 use constant END_OF_REQUEST => "END-OF-REQUEST\n";
@@ -52,7 +50,10 @@ sub new {
   $self->{interface} = lc($interface || 'cgi');
   $self->{auth_handler} = SL::Dispatcher::AuthHandler->new;
 
-  SL::ArchiveZipFixes->apply_fixes;
+  # 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);
+  }
 
   return $self;
 }
@@ -137,7 +138,7 @@ sub show_error {
   print $::form->parse_html_template($template, \%params);
   $::lxdebug->leave_sub;
 
-  ::end_of_request();
+  end_request();
 }
 
 sub pre_startup_setup {
@@ -221,6 +222,20 @@ sub _run_controller {
   "SL::Controller::$_[0]"->new->_run_action($_[1]);
 }
 
+sub handle_all_requests {
+  my ($self) = @_;
+
+  my $request = FCGI::Request();
+  while ($request->Accept() >= 0) {
+    $self->handle_request($request);
+
+    $self->restart_after_request(1) if $self->_interface_is_fcgi && SL::System::Process::memory_usage_is_too_high();
+    $request->LastCall              if $self->restart_after_request;
+  }
+
+  exec $0 if $self->restart_after_request;
+}
+
 sub handle_request {
   my $self         = shift;
   $self->{request} = shift;
@@ -232,7 +247,7 @@ sub handle_request {
 
   my $session_result = $self->pre_request_initialization;
 
-  $::form->read_cgi_input;
+  $::request->read_cgi_input($::form);
 
   my %routing;
   eval { %routing = $self->_route_request($ENV{SCRIPT_NAME}); 1; } or return;
@@ -274,8 +289,11 @@ sub handle_request {
     if (   (($script eq 'login') && !$action)
         || ($script eq 'admin')
         || (SL::Auth::SESSION_EXPIRED() == $session_result)) {
-      $self->redirect_to_login(script => $script, error => 'session');
-
+      $self->handle_login_error(routing_type => $routing_type,
+                                script       => $script,
+                                controller   => $script_name,
+                                action       => $action,
+                                error        => 'session');
     }
 
     my %auth_result = $self->{auth_handler}->handle(
@@ -285,7 +303,7 @@ sub handle_request {
       action       => $action,
     );
 
-    ::end_of_request() unless $auth_result{auth_ok};
+    $self->end_request unless $auth_result{auth_ok};
 
     delete @{ $::form }{ grep { m/^\{AUTH\}/ } keys %{ $::form } } unless $auth_result{keep_auth_vars};
 
@@ -324,7 +342,7 @@ sub handle_request {
     $self->{request}->Finish;
   }
 
-  $::lxdebug->end_request;
+  $::lxdebug->end_request(routing_type => $routing_type, script_name => $script_name, action => $action);
 
   # cleanup
   $::auth->save_session;
@@ -333,24 +351,112 @@ sub handle_request {
 
   $::locale   = undef;
   $::form     = undef;
-  $::myconfig = ();
+  %::myconfig = ();
   $::request  = undef;
 
   SL::DBConnect::Cache->reset_all;
-  Form::disconnect_standard_dbh;
 
   $self->_watch_for_changed_files;
 
   $::lxdebug->leave_sub;
 }
 
-sub redirect_to_login {
+sub reply_with_json_error {
   my ($self, %params) = @_;
+
+  my %errors = (
+    session  => { code => '401 Unauthorized',          text => 'session expired' },
+    password => { code => '401 Unauthorized',          text => 'incorrect username or password' },
+    action   => { code => '400 Bad request',           text => 'incorrect or missing action' },
+    access   => { code => '403 Forbidden',             text => 'no permissions for accessing this function' },
+    _default => { code => '500 Internal server error', text => 'general server-side error' },
+  );
+
+  my $error = $errors{$params{error}} // $errors{_default};
+  my $reply = SL::JSON::to_json({ status => 'failed', error => $error->{text} });
+
+  print $::request->cgi->header(
+    -type    => 'application/json',
+    -charset => 'utf-8',
+    -status  => $error->{code},
+  );
+
+  print $reply;
+
+  $self->end_request;
+}
+
+sub handle_login_error {
+  my ($self, %params) = @_;
+
+  return $self->reply_with_json_error(error => $params{error}) if $::request->type eq 'json';
+
   my $action          = ($params{script} // '') =~ m/^admin/i ? 'Admin/login' : 'LoginScreen/user_login';
   $action            .= '&error=' . $params{error} if $params{error};
 
-  print $::request->cgi->redirect("controller.pl?action=${action}");
-  ::end_of_request();
+  my $redirect_url = "controller.pl?action=${action}";
+
+  if (   $action =~ m/LoginScreen\/user_login/
+      && $params{action}
+      && 'get' eq lc($ENV{REQUEST_METHOD})
+      && !_is_callback_blacklisted(map {$_ => $params{$_}} qw(routing_type script controller action) )
+  ) {
+
+    require SL::Controller::Base;
+    my $controller = SL::Controller::Base->new;
+
+    delete $params{error};
+    delete $params{routing_type};
+    delete @{ $::form }{ grep { m/^\{AUTH\}/ } keys %{ $::form } };
+
+    my $callback   = $controller->url_for(%params, %{$::form});
+    $redirect_url .= '&callback=' . uri_encode($callback);
+  }
+
+  print $::request->cgi->redirect($redirect_url);
+  $self->end_request;
+}
+
+sub _is_callback_blacklisted {
+  my (%params) = @_;
+
+  # You can give a name only, then all actions are blackisted.
+  # Or you can give name and action, then only this action is blacklisted
+  # examples:
+  # {name => 'is',      action => 'edit'}
+  # {name => 'Project', action => 'edit'},
+  my @script_blacklist = (
+    {name => 'admin'},
+    {name => 'login'},
+  );
+
+  my @controller_blacklist = (
+    {name => 'Admin'},
+    {name => 'LoginScreen'},
+  );
+
+  my ($name, $blacklist);
+  if ('old' eq ($params{routing_type} // '')) {
+    $name      = $params{script};
+    $blacklist = \@script_blacklist;
+  } else {
+    $name      = $params{controller};
+    $blacklist = \@controller_blacklist;
+  }
+
+  foreach my $bl (@$blacklist) {
+    return 1 if _is_name_action_blacklisted($bl->{name}, $bl->{action}, $name, $params{action});
+  }
+
+  return;
+}
+
+sub _is_name_action_blacklisted {
+  my ($blacklisted_name, $blacklisted_action, $name, $action) = @_;
+
+  return 1 if ($name // '') eq $blacklisted_name && !$blacklisted_action;
+  return 1 if ($name // '') eq $blacklisted_name && ($action // '') eq $blacklisted_action;
+  return;
 }
 
 sub unrequire_bin_mozilla {
@@ -416,7 +522,7 @@ sub _route_controller_request {
   eval {
     # Redirect simple requests to controller.pl without any GET/POST
     # param to the login page.
-    $self->redirect_to_login(error => 'action') if !$::form->{action};
+    $self->handle_login_error(error => 'action') if !$::form->{action};
 
     # Show an error if the »action« parameter doesn't match the
     # pattern »Controller/action«.
@@ -461,7 +567,7 @@ sub _watch_for_changed_files {
   my $ok = all { (stat($_))[9] == $fcgi_file_cache{$_} } keys %fcgi_file_cache;
   return if $ok;
   $::lxdebug->message(LXDebug::DEBUG1(), "Program modifications detected. Restarting.");
-  exit;
+  $self->restart_after_request(1);
 }
 
 sub get_standard_filehandles {
@@ -478,14 +584,10 @@ sub _check_for_old_config_files {
   $::form->header;
   print $::form->parse_html_template('login_screen/old_configuration_files', { FILES => \@old_files });
 
-  ::end_of_request();
+  end_request();
 }
 
-package main;
-
-use strict;
-
-sub end_of_request {
+sub end_request {
   die SL::Dispatcher->END_OF_REQUEST;
 }