]> wagnertech.de Git - mfinanz.git/blobdiff - SL/Dispatcher.pm
projects / mfinanz.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
weitere Verbesserungen für die helper-funktion
[mfinanz.git] / SL / Dispatcher.pm
diff --git a/SL/Dispatcher.pm b/SL/Dispatcher.pm
index 8a8d5bbcf50263211e27b9a19ee0e73f392ee746..7ce18a4765c3e41f080eb3cad02520371ab14cc7 100644 (file)
--- a/SL/Dispatcher.pm
+++ b/SL/Dispatcher.pm
@@ -2,35 +2,57 @@ package SL::Dispatcher;
 
 use strict;
 
 
 use strict;
 
+# Force scripts/locales.pl to parse these templates:
+#   parse_html_template('login_screen/auth_db_unreachable')
+#   parse_html_template('login_screen/user_login')
+#   parse_html_template('generic/error')
+
 BEGIN {
 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.
+  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 CGI qw( -no_xhtml);
 use Config::Std;
 use DateTime;
 use Encode;
 use English qw(-no_match_vars);
+use File::Basename;
+use List::MoreUtils qw(all);
+use List::Util qw(first);
+use POSIX;
+use SL::ArchiveZipFixes;
 use SL::Auth;
 use SL::Auth;
+use SL::Dispatcher::AuthHandler;
 use SL::LXDebug;
 use SL::LxOfficeConf;
 use SL::Locale;
 use SL::LXDebug;
 use SL::LxOfficeConf;
 use SL::Locale;
+use SL::ClientJS;
 use SL::Common;
 use SL::Form;
 use SL::Helper::DateTime;
 use SL::Common;
 use SL::Form;
 use SL::Helper::DateTime;
-use List::Util qw(first);
-use File::Basename;
+use SL::InstanceConfiguration;
+use SL::Template::Plugin::HTMLFixes;
 
 # 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";
 
 
 # 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";
 
+my %fcgi_file_cache;
+
 sub new {
   my ($class, $interface) = @_;
 
   my $self           = bless {}, $class;
   $self->{interface} = lc($interface || 'cgi');
 sub new {
   my ($class, $interface) = @_;
 
   my $self           = bless {}, $class;
   $self->{interface} = lc($interface || 'cgi');
+  $self->{auth_handler} = SL::Dispatcher::AuthHandler->new;
+
+  SL::ArchiveZipFixes->apply_fixes;
 
   return $self;
 }
 
   return $self;
 }
@@ -40,39 +62,88 @@ sub interface_type {
   return $self->{interface} eq 'cgi' ? 'CGI' : 'FastCGI';
 }
 
   return $self->{interface} eq 'cgi' ? 'CGI' : 'FastCGI';
 }
 
+sub is_admin_request {
+  my %params = @_;
+  return ($params{script} eq 'admin.pl') || (($params{routing_type} eq 'controller') && ($params{script_name} eq 'Admin'));
+}
+
 sub pre_request_checks {
 sub pre_request_checks {
-  if (!$::auth->session_tables_present) {
-    if ($::form->{script} eq 'admin.pl') {
-      ::run();
-      ::end_of_request();
-    } else {
-      show_error('login/auth_db_unreachable');
+  my (%params) = @_;
+
+  _check_for_old_config_files();
+
+  if (!$::auth->session_tables_present && !is_admin_request(%params)) {
+    show_error('login_screen/auth_db_unreachable');
+  }
+
+  if ($::request->type !~ m/^ (?: html | js | json ) $/x) {
+    die $::locale->text("Invalid request type '#1'", $::request->type);
+  }
+}
+
+sub pre_request_initialization {
+  my ($self, %params) = @_;
+
+  $self->unrequire_bin_mozilla;
+
+  $::locale        = Locale->new($::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,
+  );
+
+  my $session_result = $::auth->restore_session;
+  $::auth->create_or_refresh_session;
+
+  if ($params{client}) {
+    $::auth->set_client($params{client}) || die("cannot find client " . $params{client});
+
+    if ($params{login}) {
+      die "cannot find user " . $params{login}            unless %::myconfig = $::auth->read_user(login => $params{login});
+      die "cannot find locale for user " . $params{login} unless $::locale   = Locale->new($::myconfig{countrycode});
+
+      $::form->{login} = $params{login}; # normaly implicit at login
     }
   }
     }
   }
-  $::auth->expire_sessions;
+
+  return $session_result;
+}
+
+sub render_error_ajax {
+  my ($error) = @_;
+
+  SL::ClientJS->new
+    ->error($error)
+    ->render(SL::Controller::Base->new);
 }
 
 sub show_error {
   $::lxdebug->enter_sub;
   my $template             = shift;
   my $error_type           = shift || '';
 }
 
 sub show_error {
   $::lxdebug->enter_sub;
   my $template             = shift;
   my $error_type           = shift || '';
+  my %params               = @_;
 
 
-  $::locale                = Locale->new($::lx_office_conf{system}->{language});
+  $::myconfig{countrycode} = delete($params{countrycode}) || $::lx_office_conf{system}->{language};
+  $::locale                = Locale->new($::myconfig{countrycode});
   $::form->{error}         = $::locale->text('The session is invalid or has expired.') if ($error_type eq 'session');
   $::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} = $::lx_office_conf{system}->{language};
-  $::form->{stylesheet}    = 'css/lx-office-erp.css';
+  $::form->{error}         = $::locale->text('Incorrect password!')                    if ($error_type eq 'password');
+  $::form->{error}         = $::locale->text('The action is missing or invalid.')      if ($error_type eq 'action');
+
+  return render_error_ajax($::form->{error}) if $::request->is_ajax;
 
   $::form->header;
 
   $::form->header;
-  print $::form->parse_html_template($template);
+  print $::form->parse_html_template($template, \%params);
   $::lxdebug->leave_sub;
 
   ::end_of_request();
 }
 
 sub pre_startup_setup {
   $::lxdebug->leave_sub;
 
   ::end_of_request();
 }
 
 sub pre_startup_setup {
+  my ($self) = @_;
+
   SL::LxOfficeConf->read;
   SL::LxOfficeConf->read;
-  _init_environment();
 
   eval {
     package main;
 
   eval {
     package main;
@@ -84,14 +155,19 @@ sub pre_startup_setup {
   {
     no warnings 'once';
     $::lxdebug     = LXDebug->new;
   {
     no warnings 'once';
     $::lxdebug     = LXDebug->new;
+    $::auth        = SL::Auth->new;
     $::form        = undef;
     %::myconfig    = ();
     $::form        = undef;
     %::myconfig    = ();
-    %::called_subs = (); # currently used for recursion detection
+    $::request     = undef;
   }
 
   $SIG{__WARN__} = sub {
     $::lxdebug->warn(@_);
   }
 
   $SIG{__WARN__} = sub {
     $::lxdebug->warn(@_);
-  }
+  };
+
+  $SIG{__DIE__} = sub { Carp::confess( @_ ) } if $::lx_office_conf{debug}->{backtrace_on_die};
+
+  $self->_cache_file_modification_times;
 }
 
 sub pre_startup_checks {
 }
 
 sub pre_startup_checks {
@@ -99,8 +175,9 @@ sub pre_startup_checks {
 }
 
 sub pre_startup {
 }
 
 sub pre_startup {
-  pre_startup_setup();
-  pre_startup_checks();
+  my ($self) = @_;
+  $self->pre_startup_setup;
+  $self->pre_startup_checks;
 }
 
 sub require_main_code {
 }
 
 sub require_main_code {
@@ -132,10 +209,11 @@ sub require_main_code {
 sub _require_controller {
   my $controller =  shift;
   $controller    =~ s|[^A-Za-z0-9_]||g;
 sub _require_controller {
   my $controller =  shift;
   $controller    =~ s|[^A-Za-z0-9_]||g;
+  $controller    =  "SL/Controller/${controller}";
 
   eval {
     package main;
 
   eval {
     package main;
-    require "SL/Controller/${controller}.pm";
+    require "${controller}.pm";
   } or die $EVAL_ERROR;
 }
 
   } or die $EVAL_ERROR;
 }
 
@@ -152,24 +230,23 @@ sub handle_request {
 
   my ($script, $path, $suffix, $script_name, $action, $routing_type);
 
 
   my ($script, $path, $suffix, $script_name, $action, $routing_type);
 
-  $script_name = $ENV{SCRIPT_NAME};
+  my $session_result = $self->pre_request_initialization;
 
 
-  $self->unrequire_bin_mozilla;
+  $::form->read_cgi_input;
 
 
-  $::cgi         = CGI->new('');
-  $::locale      = Locale->new($::lx_office_conf{system}->{language});
-  $::form        = Form->new;
-  $::auth        = SL::Auth->new;
-  %::called_subs = ();
+  my %routing;
+  eval { %routing = $self->_route_request($ENV{SCRIPT_NAME}); 1; } or return;
+  ($routing_type, $script_name, $action) = @routing{qw(type controller action)};
+  $::lxdebug->log_request($routing_type, $script_name, $action);
 
 
-  eval { ($routing_type, $script_name, $action) = _route_request($script_name); 1; } or return;
+  $::request->type(lc($routing{request_type} || 'html'));
 
   if ($routing_type eq 'old') {
     $::form->{action}  =  lc $::form->{action};
     $::form->{action}  =~ s/( |-|,|\#)/_/g;
 
    ($script, $path, $suffix) = fileparse($script_name, ".pl");
 
   if ($routing_type eq 'old') {
     $::form->{action}  =  lc $::form->{action};
     $::form->{action}  =~ s/( |-|,|\#)/_/g;
 
    ($script, $path, $suffix) = fileparse($script_name, ".pl");
-    require_main_code($script, $suffix);
+    require_main_code($script, $suffix) unless $script eq 'admin';
 
     $::form->{script} = $script . $suffix;
 
 
     $::form->{script} = $script . $suffix;
 
@@ -178,69 +255,96 @@ sub handle_request {
     $::form->{script} = "controller.pl";
   }
 
     $::form->{script} = "controller.pl";
   }
 
-  pre_request_checks();
-
   eval {
   eval {
-    my $session_result = $::auth->restore_session;
-    $::auth->create_or_refresh_session;
+    pre_request_checks(script => $script, action => $action, routing_type => $routing_type, script_name => $script_name);
 
 
-    $::form->error($::locale->text('System currently down for maintenance!')) if -e ($::lx_office_conf{paths}->{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($session_result);
+    if (   SL::System::InstallationLock->is_locked
+        && !is_admin_request(script => $script, script_name => $script_name, routing_type => $routing_type)) {
+      $::form->error($::locale->text('System currently down for maintenance!'));
+    }
 
 
-    } else {
-      show_error('login/password_error', 'session') if SL::Auth::SESSION_EXPIRED == $session_result;
-      %::myconfig = $::auth->read_user($::form->{login});
+    # For compatibility with a lot of database upgrade scripts etc:
+    # Re-write request to old 'login.pl?action=login' to new
+    # 'LoginScreen' controller. Make sure to load its code!
+    if (($script eq 'login') && ($action eq 'login')) {
+      ($routing_type, $script, $script_name, $action) = qw(controller controller LoginScreen login);
+      _require_controller('LoginScreen');
+    }
 
 
-      show_error('login/password_error', 'password') unless $::myconfig{login};
+    if (   (($script eq 'login') && !$action)
+        || ($script eq 'admin')
+        || (SL::Auth::SESSION_EXPIRED() == $session_result)) {
+      $self->redirect_to_login(script => $script, error => 'session');
 
 
-      $::locale = Locale->new($::myconfig{countrycode});
+    }
 
 
-      show_error('login/password_error', 'password') if SL::Auth::OK != $::auth->authenticate($::form->{login}, $::form->{password});
+    my %auth_result = $self->{auth_handler}->handle(
+      routing_type => $routing_type,
+      script       => $script,
+      controller   => $script_name,
+      action       => $action,
+    );
 
 
-      $::auth->set_session_value('login', $::form->{login}, 'password', $::form->{password});
-      $::auth->create_or_refresh_session;
-      $::auth->delete_session_value('FLASH');
-      delete $::form->{password};
+    ::end_of_request() unless $auth_result{auth_ok};
 
 
-      if ($action) {
-        map { $::form->{$_} = $::myconfig{$_} } qw(stylesheet charset)
-          unless $action eq 'save' && $::form->{type} eq 'preferences';
+    delete @{ $::form }{ grep { m/^\{AUTH\}/ } keys %{ $::form } } unless $auth_result{keep_auth_vars};
 
 
-        $::form->set_standard_title;
-        if ($routing_type eq 'old') {
-          ::call_sub('::' . $::locale->findsub($action));
-        } else {
-          _run_controller($script_name, $action);
-        }
+    if ($action) {
+      $::form->set_standard_title;
+      if ($routing_type eq 'old') {
+        ::call_sub('::' . $::locale->findsub($action));
       } else {
       } else {
-        $::form->error($::locale->text('action= not defined!'));
+        _run_controller($script_name, $action);
       }
       }
+    } else {
+      $::form->error($::locale->text('action= not defined!'));
     }
 
     1;
   } or do {
     }
 
     1;
   } or do {
-    if ($EVAL_ERROR ne END_OF_REQUEST) {
-      $::form->{label_error} = $::cgi->pre($EVAL_ERROR);
-      eval { show_error('generic/error') };
+    if (substr($EVAL_ERROR, 0, length(END_OF_REQUEST())) ne END_OF_REQUEST()) {
+      my $error = $EVAL_ERROR;
+      print STDERR $error;
+
+      if ($::request->is_ajax) {
+        eval { render_error_ajax($error) };
+      } else {
+        $::form->{label_error} = $::request->{cgi}->pre($error);
+        chdir SL::System::Process::exe_dir;
+        eval { show_error('generic/error') };
+      }
     }
   };
 
     }
   };
 
+  $::form->footer;
+
   # cleanup
   # cleanup
+  $::auth->save_session;
+  $::auth->expire_sessions;
+  $::auth->reset;
+
   $::locale   = undef;
   $::form     = undef;
   $::locale   = undef;
   $::form     = undef;
-  $::auth     = undef;
   $::myconfig = ();
   $::myconfig = ();
+  $::request  = undef;
   Form::disconnect_standard_dbh;
   Form::disconnect_standard_dbh;
-  $::auth->expire_session_keys->save_session;
-  $::auth->dbdisconnect;
 
   $::lxdebug->end_request;
 
   $::lxdebug->end_request;
+
+  $self->_watch_for_changed_files;
+
   $::lxdebug->leave_sub;
 }
 
   $::lxdebug->leave_sub;
 }
 
+sub redirect_to_login {
+  my ($self, %params) = @_;
+  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();
+}
+
 sub unrequire_bin_mozilla {
   my $self = shift;
   return unless $self->_interface_is_fcgi;
 sub unrequire_bin_mozilla {
   my $self = shift;
   return unless $self->_interface_is_fcgi;
@@ -259,19 +363,20 @@ sub _interface_is_fcgi {
 }
 
 sub _route_request {
 }
 
 sub _route_request {
-  my $script_name = shift;
+  my ($self, $script_name) = @_;
 
 
-  return $script_name =~ m/dispatcher\.pl$/ ? ('old',        _route_dispatcher_request())
-       : $script_name =~ m/controller\.pl/  ? ('controller', _route_controller_request())
-       :                                      ('old',        $script_name, $::form->{action});
+  return $script_name =~ m/dispatcher\.pl$/ ? (type => 'old',        $self->_route_dispatcher_request)
+       : $script_name =~ m/controller\.pl/  ? (type => 'controller', $self->_route_controller_request)
+       :                                      (type => 'old',        controller => $script_name, action => $::form->{action});
 }
 
 sub _route_dispatcher_request {
 }
 
 sub _route_dispatcher_request {
+  my ($self)  = @_;
   my $name_re = qr{[a-z]\w*};
   my ($script_name, $action);
 
   eval {
   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}$/);
+    die "Unroutable request -- invalid module name.\n" if !$::form->{M} || ($::form->{M} !~ m/^${name_re}$/);
     $script_name = $::form->{M} . '.pl';
 
     if ($::form->{A}) {
     $script_name = $::form->{M} . '.pl';
 
     if ($::form->{A}) {
@@ -279,7 +384,7 @@ sub _route_dispatcher_request {
 
     } else {
       $action = first { m/^A_${name_re}$/ } keys %{ $::form };
 
     } else {
       $action = first { m/^A_${name_re}$/ } keys %{ $::form };
-      die "Unroutable request -- inavlid action name.\n" if !$action;
+      die "Unroutable request -- invalid action name.\n" if !$action;
 
       delete $::form->{$action};
       $action = substr $action, 2;
 
       delete $::form->{$action};
       $action = substr $action, 2;
@@ -289,28 +394,66 @@ sub _route_dispatcher_request {
 
     1;
   } or do {
 
     1;
   } or do {
-    $::form->{label_error} = $::cgi->pre($EVAL_ERROR);
+    $::form->{label_error} = $::request->{cgi}->pre($EVAL_ERROR);
     show_error('generic/error');
   };
 
     show_error('generic/error');
   };
 
-  return ($script_name, $action);
+  return (controller => $script_name, action => $action);
 }
 
 sub _route_controller_request {
 }
 
 sub _route_controller_request {
-  my ($controller, $action);
+  my ($self) = @_;
+  my ($controller, $action, $request_type);
 
   eval {
 
   eval {
-    $::form->{action}      =~ m|^ ( [A-Z] [A-Za-z0-9_]* ) / ( [a-z] [a-z0-9_]* ) $|x || die "Unroutable request -- inavlid controller/action.\n";
+    # Redirect simple requests to controller.pl without any GET/POST
+    # param to the login page.
+    $self->redirect_to_login(error => 'action') if !$::form->{action};
+
+    # Show an error if the »action« parameter doesn't match the
+    # pattern »Controller/action«.
+    $::form->{action}      =~ m|^ ( [A-Z] [A-Za-z0-9_]* ) / ( [a-z] [a-z0-9_]* ) ( \. [a-zA-Z]+ )? $|x || die "Unroutable request -- invalid controller/action.\n";
     ($controller, $action) =  ($1, $2);
     delete $::form->{action};
 
     ($controller, $action) =  ($1, $2);
     delete $::form->{action};
 
+    $request_type = $3 ? lc(substr($3, 1)) : 'html';
+
     1;
   } or do {
     1;
   } or do {
-    $::form->{label_error} = $::cgi->pre($EVAL_ERROR);
+    $::form->{label_error} = $::request->{cgi}->pre($EVAL_ERROR);
     show_error('generic/error');
   };
 
     show_error('generic/error');
   };
 
-  return ($controller, $action);
+  return (controller => $controller, action => $action, request_type => $request_type);
+}
+
+sub _cache_file_modification_times {
+  my ($self) = @_;
+
+  return unless $self->_interface_is_fcgi && $::lx_office_conf{debug}->{restart_fcgi_process_on_changes};
+
+  require File::Find;
+  require POSIX;
+
+  my $wanted = sub {
+    return unless $File::Find::name =~ m/\.(?:pm|f?pl|html|conf|conf\.default)$/;
+    $fcgi_file_cache{ $File::Find::name } = (stat $File::Find::name)[9];
+  };
+
+  my $cwd = POSIX::getcwd();
+  File::Find::find($wanted, map { "${cwd}/${_}" } qw(config bin SL templates/webpages));
+  map { my $name = "${cwd}/${_}"; $fcgi_file_cache{$name} = (stat $name)[9] } qw(admin.pl dispatcher.fpl);
+}
+
+sub _watch_for_changed_files {
+  my ($self) = @_;
+
+  return unless $self->_interface_is_fcgi && $::lx_office_conf{debug}->{restart_fcgi_process_on_changes};
+
+  my $ok = all { (stat($_))[9] == $fcgi_file_cache{$_} } keys %fcgi_file_cache;
+  return if $ok;
+  $::lxdebug->message(LXDebug::DEBUG1(), "Program modifications detected. Restarting.");
+  exit;
 }
 
 sub get_standard_filehandles {
 }
 
 sub get_standard_filehandles {
@@ -319,25 +462,15 @@ sub get_standard_filehandles {
   return $self->{interface} =~ m/f(?:ast)cgi/i ? $self->{request}->GetHandles() : (\*STDIN, \*STDOUT, \*STDERR);
 }
 
   return $self->{interface} =~ m/f(?:ast)cgi/i ? $self->{request}->GetHandles() : (\*STDIN, \*STDOUT, \*STDERR);
 }
 
-sub _init_environment {
-  my %key_map = ( lib  => { name => 'PERL5LIB', append_path => 1 },
-                  path => { name => 'PATH',     append_path => 1 },
-                );
-  my $cfg     = $::lx_office_conf{environment} || {};
-
-  while (my ($key, $value) = each %{ $cfg }) {
-    next unless $value;
+sub _check_for_old_config_files {
+  my @old_files = grep { -f "config/${_}" } qw(authentication.pl console.conf lx-erp.conf lx-erp-local.conf);
+  return unless @old_files;
 
 
-    my $info = $key_map{$key} || {};
-    $key     = $info->{name}  || $key;
-
-    if ($info->{append_path}) {
-      $value = ':' . $value unless $value =~ m/^:/ || !$ENV{$key};
-      $value = $ENV{$key} . $value;
-    }
+  $::form->{title} = $::locale->text('Old configuration files');
+  $::form->header;
+  print $::form->parse_html_template('login_screen/old_configuration_files', { FILES => \@old_files });
 
 
-    $ENV{$key} = $value;
-  }
+  ::end_of_request();
 }
 
 package main;
 }
 
 package main;
Unnamed repository; edit this file 'description' to name the repository.