SL/Dispatcher.pm

   1 package SL::Dispatcher;
   2
   3 use strict;
   4
   5 BEGIN {
   6   unshift @INC, "modules/override"; # Use our own versions of various modules (e.g. YAML).
   7   push    @INC, "modules/fallback"; # Only use our own versions of modules if there's no system version.
   8 }
   9
  10 use CGI qw( -no_xhtml);
  11 use Config::Std;
  12 use DateTime;
  13 use Encode;
  14 use English qw(-no_match_vars);
  15 use SL::Auth;
  16 use SL::LXDebug;
  17 use SL::LxOfficeConf;
  18 use SL::Locale;
  19 use SL::Common;
  20 use SL::Form;
  21 use SL::Helper::DateTime;
  22 use List::Util qw(first);
  23 use File::Basename;
  24
  25 # Trailing new line is added so that Perl will not add the line
  26 # number 'die' was called in.
  27 use constant END_OF_REQUEST => "END-OF-REQUEST\n";
  28
  29 sub new {
  30   my ($class, $interface) = @_;
  31
  32   my $self           = bless {}, $class;
  33   $self->{interface} = lc($interface || 'cgi');
  34
  35   return $self;
  36 }
  37
  38 sub interface_type {
  39   my ($self) = @_;
  40   return $self->{interface} eq 'cgi' ? 'CGI' : 'FastCGI';
  41 }
  42
  43 sub pre_request_checks {
  44   if (!$::auth->session_tables_present) {
  45     if ($::form->{script} eq 'admin.pl') {
  46       ::run();
  47       ::end_of_request();
  48     } else {
  49       show_error('login/auth_db_unreachable');
  50     }
  51   }
  52   $::auth->expire_sessions;
  53 }
  54
  55 sub show_error {
  56   $::lxdebug->enter_sub;
  57   my $template             = shift;
  58   my $error_type           = shift || '';
  59
  60   $::locale                = Locale->new($::lx_office_conf{system}->{language});
  61   $::form->{error}         = $::locale->text('The session is invalid or has expired.') if ($error_type eq 'session');
  62   $::form->{error}         = $::locale->text('Incorrect password!.')                   if ($error_type eq 'password');
  63   $::myconfig{countrycode} = $::lx_office_conf{system}->{language};
  64   $::form->{stylesheet}    = 'css/lx-office-erp.css';
  65
  66   $::form->header;
  67   print $::form->parse_html_template($template);
  68   $::lxdebug->leave_sub;
  69
  70   ::end_of_request();
  71 }
  72
  73 sub pre_startup_setup {
  74   SL::LxOfficeConf->read;
  75   _init_environment();
  76
  77   eval {
  78     package main;
  79     require "bin/mozilla/common.pl";
  80     require "bin/mozilla/installationcheck.pl";
  81   } or die $EVAL_ERROR;
  82
  83   # canonial globals. if it's not here, chances are it will get refactored someday.
  84   {
  85     no warnings 'once';
  86     $::lxdebug     = LXDebug->new;
  87     $::auth        = SL::Auth->new;
  88     $::form        = undef;
  89     %::myconfig    = ();
  90     %::called_subs = (); # currently used for recursion detection
  91   }
  92
  93   $SIG{__WARN__} = sub {
  94     $::lxdebug->warn(@_);
  95   }
  96 }
  97
  98 sub pre_startup_checks {
  99   ::verify_installation();
 100 }
 101
 102 sub pre_startup {
 103   pre_startup_setup();
 104   pre_startup_checks();
 105 }
 106
 107 sub require_main_code {
 108   $::lxdebug->enter_sub;
 109   my ($script, $suffix) = @_;
 110
 111   eval {
 112     package main;
 113     require "bin/mozilla/$script$suffix";
 114   } or die $EVAL_ERROR;
 115
 116   if (-f "bin/mozilla/custom_$script$suffix") {
 117     eval {
 118       package main;
 119       require "bin/mozilla/custom_$script$suffix";
 120     };
 121     $::form->error($EVAL_ERROR) if ($EVAL_ERROR);
 122   }
 123   if ($::form->{login} && -f "bin/mozilla/$::form->{login}_$script") {
 124     eval {
 125       package main;
 126       require "bin/mozilla/$::form->{login}_$script";
 127     };
 128     $::form->error($EVAL_ERROR) if ($EVAL_ERROR);
 129   }
 130   $::lxdebug->leave_sub;
 131 }
 132
 133 sub _require_controller {
 134   my $controller =  shift;
 135   $controller    =~ s|[^A-Za-z0-9_]||g;
 136
 137   eval {
 138     package main;
 139     require "SL/Controller/${controller}.pm";
 140   } or die $EVAL_ERROR;
 141 }
 142
 143 sub _run_controller {
 144   "SL::Controller::$_[0]"->new->_run_action($_[1]);
 145 }
 146
 147 sub handle_request {
 148   my $self         = shift;
 149   $self->{request} = shift;
 150
 151   $::lxdebug->enter_sub;
 152   $::lxdebug->begin_request;
 153
 154   my ($script, $path, $suffix, $script_name, $action, $routing_type);
 155
 156   $script_name = $ENV{SCRIPT_NAME};
 157
 158   $self->unrequire_bin_mozilla;
 159
 160   $::cgi         = CGI->new('');
 161   $::locale      = Locale->new($::lx_office_conf{system}->{language});
 162   $::form        = Form->new;
 163   %::called_subs = ();
 164
 165   eval { ($routing_type, $script_name, $action) = _route_request($script_name); 1; } or return;
 166
 167   if ($routing_type eq 'old') {
 168     $::form->{action}  =  lc $::form->{action};
 169     $::form->{action}  =~ s/( |-|,|\#)/_/g;
 170
 171    ($script, $path, $suffix) = fileparse($script_name, ".pl");
 172     require_main_code($script, $suffix);
 173
 174     $::form->{script} = $script . $suffix;
 175
 176   } else {
 177     _require_controller($script_name);
 178     $::form->{script} = "controller.pl";
 179   }
 180
 181   pre_request_checks();
 182
 183   eval {
 184     my $session_result = $::auth->restore_session;
 185     $::auth->create_or_refresh_session;
 186
 187     $::form->error($::locale->text('System currently down for maintenance!')) if -e ($::lx_office_conf{paths}->{userspath} . "/nologin") && $script ne 'admin';
 188
 189     if ($script eq 'login' or $script eq 'admin' or $script eq 'kopf') {
 190       $::form->{titlebar} = "Lx-Office " . $::locale->text('Version') . " $::form->{version}";
 191       ::run($session_result);
 192
 193     } else {
 194       show_error('login/password_error', 'session') if SL::Auth::SESSION_EXPIRED == $session_result;
 195       %::myconfig = $::auth->read_user($::form->{login});
 196
 197       show_error('login/password_error', 'password') unless $::myconfig{login};
 198
 199       $::locale = Locale->new($::myconfig{countrycode});
 200
 201       show_error('login/password_error', 'password') if SL::Auth::OK != $::auth->authenticate($::form->{login}, $::form->{password}, 0);
 202
 203       $::auth->set_session_value('login', $::form->{login}, 'password', $::form->{password});
 204       $::auth->create_or_refresh_session;
 205       $::auth->delete_session_value('FLASH')->save_session();
 206       delete $::form->{password};
 207
 208       if ($action) {
 209         map { $::form->{$_} = $::myconfig{$_} } qw(stylesheet charset)
 210           unless $action eq 'save' && $::form->{type} eq 'preferences';
 211
 212         $::form->set_standard_title;
 213         if ($routing_type eq 'old') {
 214           ::call_sub('::' . $::locale->findsub($action));
 215         } else {
 216           _run_controller($script_name, $action);
 217         }
 218       } else {
 219         $::form->error($::locale->text('action= not defined!'));
 220       }
 221     }
 222
 223     1;
 224   } or do {
 225     if ($EVAL_ERROR ne END_OF_REQUEST) {
 226       $::form->{label_error} = $::cgi->pre($EVAL_ERROR);
 227       eval { show_error('generic/error') };
 228     }
 229   };
 230
 231   # cleanup
 232   $::locale   = undef;
 233   $::form     = undef;
 234   $::myconfig = ();
 235   Form::disconnect_standard_dbh unless $self->_interface_is_fcgi;
 236
 237   $::lxdebug->end_request;
 238   $::lxdebug->leave_sub;
 239 }
 240
 241 sub unrequire_bin_mozilla {
 242   my $self = shift;
 243   return unless $self->_interface_is_fcgi;
 244
 245   for (keys %INC) {
 246     next unless m#^bin/mozilla/#;
 247     next if /\bcommon.pl$/;
 248     next if /\binstallationcheck.pl$/;
 249     delete $INC{$_};
 250   }
 251 }
 252
 253 sub _interface_is_fcgi {
 254   my $self = shift;
 255   return $self->{interface} =~ m/^(?:fastcgi|fcgid|fcgi)$/;
 256 }
 257
 258 sub _route_request {
 259   my $script_name = shift;
 260
 261   return $script_name =~ m/dispatcher\.pl$/ ? ('old',        _route_dispatcher_request())
 262        : $script_name =~ m/controller\.pl/  ? ('controller', _route_controller_request())
 263        :                                      ('old',        $script_name, $::form->{action});
 264 }
 265
 266 sub _route_dispatcher_request {
 267   my $name_re = qr{[a-z]\w*};
 268   my ($script_name, $action);
 269
 270   eval {
 271     die "Unroutable request -- inavlid module name.\n" if !$::form->{M} || ($::form->{M} !~ m/^${name_re}$/);
 272     $script_name = $::form->{M} . '.pl';
 273
 274     if ($::form->{A}) {
 275       $action = $::form->{A};
 276
 277     } else {
 278       $action = first { m/^A_${name_re}$/ } keys %{ $::form };
 279       die "Unroutable request -- inavlid action name.\n" if !$action;
 280
 281       delete $::form->{$action};
 282       $action = substr $action, 2;
 283     }
 284
 285     delete @{$::form}{qw(M A)};
 286
 287     1;
 288   } or do {
 289     $::form->{label_error} = $::cgi->pre($EVAL_ERROR);
 290     show_error('generic/error');
 291   };
 292
 293   return ($script_name, $action);
 294 }
 295
 296 sub _route_controller_request {
 297   my ($controller, $action);
 298
 299   eval {
 300     $::form->{action}      =~ m|^ ( [A-Z] [A-Za-z0-9_]* ) / ( [a-z] [a-z0-9_]* ) $|x || die "Unroutable request -- inavlid controller/action.\n";
 301     ($controller, $action) =  ($1, $2);
 302     delete $::form->{action};
 303
 304     1;
 305   } or do {
 306     $::form->{label_error} = $::cgi->pre($EVAL_ERROR);
 307     show_error('generic/error');
 308   };
 309
 310   return ($controller, $action);
 311 }
 312
 313 sub get_standard_filehandles {
 314   my $self = shift;
 315
 316   return $self->{interface} =~ m/f(?:ast)cgi/i ? $self->{request}->GetHandles() : (\*STDIN, \*STDOUT, \*STDERR);
 317 }
 318
 319 sub _init_environment {
 320   my %key_map = ( lib  => { name => 'PERL5LIB', append_path => 1 },
 321                   path => { name => 'PATH',     append_path => 1 },
 322                 );
 323   my $cfg     = $::lx_office_conf{environment} || {};
 324
 325   while (my ($key, $value) = each %{ $cfg }) {
 326     next unless $value;
 327
 328     my $info = $key_map{$key} || {};
 329     $key     = $info->{name}  || $key;
 330
 331     if ($info->{append_path}) {
 332       $value = ':' . $value unless $value =~ m/^:/ || !$ENV{$key};
 333       $value = $ENV{$key} . $value;
 334     }
 335
 336     $ENV{$key} = $value;
 337   }
 338 }
 339
 340 package main;
 341
 342 use strict;
 343
 344 sub end_of_request {
 345   die SL::Dispatcher->END_OF_REQUEST;
 346 }
 347
 348 1;