Merge branch 'master' of ssh://git-sdonath@lx-office.linet-services.de/~/lx-office-erp
[kivitendo-erp.git] / SL / Dispatcher.pm
index 9d968ad..8bd2968 100644 (file)
@@ -2,6 +2,12 @@ package SL::Dispatcher;
 
 use strict;
 
+BEGIN {
+  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.
+  push    @INC, "SL";               # FCGI won't find modules that are not properly named. Help it by inclduging SL
+}
+
 use CGI qw( -no_xhtml);
 use English qw(-no_match_vars);
 use SL::Auth;
@@ -9,23 +15,33 @@ use SL::LXDebug;
 use SL::Locale;
 use SL::Common;
 use Form;
-use Moose;
-use Rose::DB;
-use Rose::DB::Object;
+use List::Util qw(first);
 use File::Basename;
 
+# 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";
+
 sub pre_request_checks {
-  show_error('login/auth_db_unreachable') unless $::auth->session_tables_present;
+  if (!$::auth->session_tables_present) {
+    if ($::form->{script} eq 'admin.pl') {
+      ::run();
+      ::end_of_request();
+    } else {
+      show_error('login/auth_db_unreachable');
+    }
+  }
   $::auth->expire_sessions;
 }
 
 sub show_error {
   $::lxdebug->enter_sub;
-  my $template           = shift;
-  my $error_type         = shift || '';
-  my $locale             = Locale->new($::language, 'all');
-  $::form->{error}       = $::locale->text('The session is invalid or has expired.') if ($error_type eq 'session');
-  $::form->{error}       = $::locale->text('Incorrect password!.')                   if ($error_type eq 'password');
+  my $template             = shift;
+  my $error_type           = shift || '';
+
+  $::locale                = Locale->new($::language);
+  $::form->{error}         = $::locale->text('The session is invalid or has expired.') if ($error_type eq 'session');
+  $::form->{error}         = $::locale->text('Incorrect password!.')                   if ($error_type eq 'password');
   $::myconfig{countrycode} = $::language;
   $::form->{stylesheet}    = 'css/lx-office-erp.css';
 
@@ -33,7 +49,7 @@ sub show_error {
   print $::form->parse_html_template($template);
   $::lxdebug->leave_sub;
 
-  exit;
+  ::end_of_request();
 }
 
 sub pre_startup_setup {
@@ -52,16 +68,23 @@ sub pre_startup_setup {
     require "bin/mozilla/installationcheck.pl";
   } or die $EVAL_ERROR;
 
-  # dummy globals
+  # canonial globals. if it's not here, chances are it will get refactored someday.
   {
     no warnings 'once';
-    $::userspath  = "users";
-    $::templates  = "templates";
-    $::memberfile = "users/members";
-    $::sendmail   = "| /usr/sbin/sendmail -t";
-    $::lxdebug    = LXDebug->new;
-    $::auth       = SL::Auth->new;
-    %::myconfig   = ();
+    $::userspath   = "users";
+    $::templates   = "templates";
+    $::memberfile  = "users/members";
+    $::menufile    = "menu.ini";
+    $::sendmail    = "| /usr/sbin/sendmail -t";
+    $::lxdebug     = LXDebug->new;
+    $::auth        = SL::Auth->new;
+    $::form        = undef;
+    %::myconfig    = ();
+    %::called_subs = (); # currently used for recursion detection
+  }
+
+  $SIG{__WARN__} = sub {
+    $::lxdebug->warn(@_);
   }
 }
 
@@ -75,6 +98,7 @@ sub pre_startup {
 }
 
 sub require_main_code {
+  $::lxdebug->enter_sub;
   my ($script, $suffix) = @_;
 
   eval {
@@ -89,13 +113,14 @@ sub require_main_code {
     };
     $::form->error($EVAL_ERROR) if ($EVAL_ERROR);
   }
-  if ($::form->{login} && -f "bin/mozilla/$::form->{login}_$::form->{script}") {
+  if ($::form->{login} && -f "bin/mozilla/$::form->{login}_$script") {
     eval {
       package main;
-      require "bin/mozilla/$::form->{login}_$::form->{script}";
+      require "bin/mozilla/$::form->{login}_$script";
     };
     $::form->error($EVAL_ERROR) if ($EVAL_ERROR);
   }
+  $::lxdebug->leave_sub;
 }
 
 sub handle_request {
@@ -103,35 +128,35 @@ sub handle_request {
   $::lxdebug->begin_request;
 
   my $interface = lc(shift || 'cgi');
-  my $script_name;
+  my ($script_name, $action);
 
-  if ($interface =~ m/^(?:fastcgi|fcgid|fcgi)$/) {
-    $script_name = $ENV{SCRIPT_NAME};
-    unrequire_bin_mozilla();
+  $script_name = $ENV{SCRIPT_NAME};
 
-  } else {
-    $script_name = $0;
-  }
+  unrequire_bin_mozilla($interface);
+
+  $::cgi         = CGI->new('');
+  $::locale      = Locale->new($::language);
+  $::form        = Form->new;
+  %::called_subs = ();
+
+  eval { ($script_name, $action) = _route_request($script_name); 1; } or return;
 
   my ($script, $path, $suffix) = fileparse($script_name, ".pl");
   require_main_code($script, $suffix);
 
-  $::cgi            = CGI->new('');
-  $::locale         = Locale->new($::language, $script);
-  $::form           = Form->new;
   $::form->{script} = $script . $suffix;
 
   pre_request_checks();
 
   eval {
+    $::form->error($::locale->text('System currently down for maintenance!')) if -e "$::userspath/nologin" && $script ne 'admin';
+
     if ($script eq 'login' or $script eq 'admin' or $script eq 'kopf') {
       $::form->{titlebar} = "Lx-Office " . $::locale->text('Version') . " $::form->{version}";
       ::run($::auth->restore_session);
 
-    } elsif ($::form->{action}) {
+    } elsif ($action) {
       # copy from am.pl routines
-      $::form->error($::locale->text('System currently down for maintenance!')) if -e "$main::userspath/nologin" && $script ne 'admin';
-
       my $session_result = $::auth->restore_session;
 
       show_error('login/password_error', 'session') if SL::Auth::SESSION_EXPIRED == $session_result;
@@ -139,7 +164,7 @@ sub handle_request {
 
       show_error('login/password_error', 'password') unless $::myconfig{login};
 
-      $::locale = Locale->new($::myconfig{countrycode}, $script);
+      $::locale = Locale->new($::myconfig{countrycode});
 
       show_error('login/password_error', 'password') if SL::Auth::OK != $::auth->authenticate($::form->{login}, $::form->{password}, 0);
 
@@ -148,10 +173,10 @@ sub handle_request {
       delete $::form->{password};
 
       map { $::form->{$_} = $::myconfig{$_} } qw(stylesheet charset)
-        unless $::form->{action} eq 'save' && $::form->{type} eq 'preferences';
+        unless $action eq 'save' && $::form->{type} eq 'preferences';
 
       $::form->set_standard_title;
-      ::call_sub('::' . $::locale->findsub($::form->{action}));
+      ::call_sub('::' . $::locale->findsub($action));
 
     } else {
       $::form->error($::locale->text('action= not defined!'));
@@ -159,20 +184,25 @@ sub handle_request {
 
     1;
   } or do {
-    $::form->{label_error} = $::cgi->pre($EVAL_ERROR);
-    show_error('generic/error');
+    if ($EVAL_ERROR ne END_OF_REQUEST) {
+      $::form->{label_error} = $::cgi->pre($EVAL_ERROR);
+      eval { show_error('generic/error') };
+    }
   };
 
   # cleanup
   $::locale   = undef;
   $::form     = undef;
   $::myconfig = ();
+  Form::disconnect_standard_dbh();
 
   $::lxdebug->end_request;
   $::lxdebug->leave_sub;
 }
 
 sub unrequire_bin_mozilla {
+  return unless $_[0] =~ m/^(?:fastcgi|fcgid|fcgi)$/;
+
   for (keys %INC) {
     next unless m#^bin/mozilla/#;
     next if /\bcommon.pl$/;
@@ -181,4 +211,48 @@ sub unrequire_bin_mozilla {
   }
 }
 
+sub _route_request {
+  my $script_name = shift;
+
+  return $script_name =~ m/dispatcher\.pl$/ ? _route_dispatcher_request() : ($script_name, $::form->{action});
+}
+
+sub _route_dispatcher_request {
+  my $name_re = qr{[a-z]\w*};
+  my ($script_name, $action);
+
+  eval {
+    die "Unroutable request -- inavlid module name.\n" if !$::form->{M} || ($::form->{M} !~ m/^${name_re}$/);
+    $script_name = $::form->{M} . '.pl';
+
+    if ($::form->{A}) {
+      $action = $::form->{A};
+
+    } else {
+      $action = first { m/^A_${name_re}$/ } keys %{ $::form };
+      die "Unroutable request -- inavlid action name.\n" if !$action;
+
+      delete $::form->{$action};
+      $action = substr $action, 2;
+    }
+
+    delete @{$::form}{qw(M A)};
+
+    1;
+  } or do {
+    $::form->{label_error} = $::cgi->pre($EVAL_ERROR);
+    show_error('generic/error');
+  };
+
+  return ($script_name, $action);
+}
+
+package main;
+
+use strict;
+
+sub end_of_request {
+  die SL::Dispatcher->END_OF_REQUEST;
+}
+
 1;