Merge branch 'currency'
[kivitendo-erp.git] / SL / Dispatcher.pm
1 package SL::Dispatcher;
2
3 use strict;
4
5 # Force scripts/locales.pl to parse these templates:
6 #   parse_html_template('login_screen/auth_db_unreachable')
7 #   parse_html_template('login_screen/user_login')
8 #   parse_html_template('generic/error')
9
10 BEGIN {
11   use SL::System::Process;
12   my $exe_dir = SL::System::Process::exe_dir;
13
14   unshift @INC, "${exe_dir}/modules/override"; # Use our own versions of various modules (e.g. YAML).
15   push    @INC, "${exe_dir}/modules/fallback"; # Only use our own versions of modules if there's no system version.
16   unshift @INC, $exe_dir;
17 }
18
19 use CGI qw( -no_xhtml);
20 use Config::Std;
21 use DateTime;
22 use Encode;
23 use English qw(-no_match_vars);
24 use File::Basename;
25 use List::MoreUtils qw(all);
26 use List::Util qw(first);
27 use POSIX;
28 use SL::Auth;
29 use SL::Dispatcher::AuthHandler;
30 use SL::LXDebug;
31 use SL::LxOfficeConf;
32 use SL::Locale;
33 use SL::ClientJS;
34 use SL::Common;
35 use SL::Form;
36 use SL::Helper::DateTime;
37 use SL::InstanceConfiguration;
38 use SL::Template::Plugin::HTMLFixes;
39
40 # Trailing new line is added so that Perl will not add the line
41 # number 'die' was called in.
42 use constant END_OF_REQUEST => "END-OF-REQUEST\n";
43
44 my %fcgi_file_cache;
45
46 sub new {
47   my ($class, $interface) = @_;
48
49   my $self           = bless {}, $class;
50   $self->{interface} = lc($interface || 'cgi');
51   $self->{auth_handler} = SL::Dispatcher::AuthHandler->new;
52
53   return $self;
54 }
55
56 sub interface_type {
57   my ($self) = @_;
58   return $self->{interface} eq 'cgi' ? 'CGI' : 'FastCGI';
59 }
60
61 sub pre_request_checks {
62   _check_for_old_config_files();
63
64   if (!$::auth->session_tables_present) {
65     if ($::form->{script} eq 'admin.pl') {
66       ::run();
67       ::end_of_request();
68     } else {
69       show_error('login_screen/auth_db_unreachable');
70     }
71   }
72
73   if ($::request->type !~ m/^ (?: html | js | json ) $/x) {
74     die $::locale->text("Invalid request type '#1'", $::request->type);
75   }
76 }
77
78 sub render_error_ajax {
79   my ($error) = @_;
80
81   SL::ClientJS->new
82     ->error($error)
83     ->render(SL::Controller::Base->new);
84 }
85
86 sub show_error {
87   $::lxdebug->enter_sub;
88   my $template             = shift;
89   my $error_type           = shift || '';
90   my %params               = @_;
91
92   $::myconfig{countrycode} = delete($params{countrycode}) || $::lx_office_conf{system}->{language};
93   $::locale                = Locale->new($::myconfig{countrycode});
94   $::form->{error}         = $::locale->text('The session is invalid or has expired.') if ($error_type eq 'session');
95   $::form->{error}         = $::locale->text('Incorrect password!')                    if ($error_type eq 'password');
96
97   return render_error_ajax($::form->{error}) if $::request->is_ajax;
98
99   $::form->header;
100   print $::form->parse_html_template($template, \%params);
101   $::lxdebug->leave_sub;
102
103   ::end_of_request();
104 }
105
106 sub pre_startup_setup {
107   my ($self) = @_;
108
109   SL::LxOfficeConf->read;
110
111   eval {
112     package main;
113     require "bin/mozilla/common.pl";
114     require "bin/mozilla/installationcheck.pl";
115   } or die $EVAL_ERROR;
116
117   # canonial globals. if it's not here, chances are it will get refactored someday.
118   {
119     no warnings 'once';
120     $::lxdebug     = LXDebug->new;
121     $::auth        = SL::Auth->new;
122     $::form        = undef;
123     %::myconfig    = ();
124     $::request     = undef;
125   }
126
127   $SIG{__WARN__} = sub {
128     $::lxdebug->warn(@_);
129   };
130
131   $self->_cache_file_modification_times;
132 }
133
134 sub pre_startup_checks {
135   ::verify_installation();
136 }
137
138 sub pre_startup {
139   my ($self) = @_;
140   $self->pre_startup_setup;
141   $self->pre_startup_checks;
142 }
143
144 sub require_main_code {
145   $::lxdebug->enter_sub;
146   my ($script, $suffix) = @_;
147
148   eval {
149     package main;
150     require "bin/mozilla/$script$suffix";
151   } or die $EVAL_ERROR;
152
153   if (-f "bin/mozilla/custom_$script$suffix") {
154     eval {
155       package main;
156       require "bin/mozilla/custom_$script$suffix";
157     };
158     $::form->error($EVAL_ERROR) if ($EVAL_ERROR);
159   }
160   if ($::form->{login} && -f "bin/mozilla/$::form->{login}_$script") {
161     eval {
162       package main;
163       require "bin/mozilla/$::form->{login}_$script";
164     };
165     $::form->error($EVAL_ERROR) if ($EVAL_ERROR);
166   }
167   $::lxdebug->leave_sub;
168 }
169
170 sub _require_controller {
171   my $controller =  shift;
172   $controller    =~ s|[^A-Za-z0-9_]||g;
173   $controller    =  "SL/Controller/${controller}";
174
175   eval {
176     package main;
177     require "${controller}.pm";
178   } or die $EVAL_ERROR;
179 }
180
181 sub _run_controller {
182   "SL::Controller::$_[0]"->new->_run_action($_[1]);
183 }
184
185 sub handle_request {
186   my $self         = shift;
187   $self->{request} = shift;
188
189   $::lxdebug->enter_sub;
190   $::lxdebug->begin_request;
191
192   my ($script, $path, $suffix, $script_name, $action, $routing_type);
193
194   $self->unrequire_bin_mozilla;
195
196   $::locale        = Locale->new($::lx_office_conf{system}->{language});
197   $::form          = Form->new;
198   $::instance_conf = SL::InstanceConfiguration->new;
199   $::request       = SL::Request->new(
200     cgi => CGI->new({}),
201     layout => SL::Layout::None->new,
202   );
203
204   my $session_result = $::auth->restore_session;
205   $::auth->create_or_refresh_session;
206
207   $::form->read_cgi_input;
208
209   my %routing;
210   eval { %routing = _route_request($ENV{SCRIPT_NAME}); 1; } or return;
211   ($routing_type, $script_name, $action) = @routing{qw(type controller action)};
212   $::lxdebug->log_request($routing_type, $script_name, $action);
213
214   $::request->type(lc($routing{request_type} || 'html'));
215
216   if ($routing_type eq 'old') {
217     $::form->{action}  =  lc $::form->{action};
218     $::form->{action}  =~ s/( |-|,|\#)/_/g;
219
220    ($script, $path, $suffix) = fileparse($script_name, ".pl");
221     require_main_code($script, $suffix);
222
223     $::form->{script} = $script . $suffix;
224
225   } else {
226     _require_controller($script_name);
227     $::form->{script} = "controller.pl";
228   }
229
230   eval {
231     pre_request_checks();
232
233     $::form->error($::locale->text('System currently down for maintenance!')) if -e ($::lx_office_conf{paths}->{userspath} . "/nologin") && $script ne 'admin';
234
235     # For compatibility with a lot of database upgrade scripts etc:
236     # Re-write request to old 'login.pl?action=login' to new
237     # 'LoginScreen' controller. Make sure to load its code!
238     if (($script eq 'login') && ($action eq 'login')) {
239       ($routing_type, $script, $script_name, $action) = qw(controller controller LoginScreen login);
240       _require_controller('LoginScreen');
241     }
242
243     if (($script eq 'login') && !$action) {
244       print $::request->{cgi}->redirect('controller.pl?action=LoginScreen/user_login');
245
246     } elsif ($script eq 'admin') {
247       $::form->{titlebar} = "kivitendo " . $::locale->text('Version') . " $::form->{version}";
248       ::run($session_result);
249
250     } else {
251       if (SL::Auth::SESSION_EXPIRED == $session_result) {
252         print $::request->{cgi}->redirect('controller.pl?action=LoginScreen/user_login&error=session');
253         ::end_of_request();
254       }
255
256       my %auth_result = $self->{auth_handler}->handle(
257         routing_type => $routing_type,
258         script       => $script,
259         controller   => $script_name,
260         action       => $action,
261       );
262
263       ::end_of_request() unless $auth_result{auth_ok};
264
265       delete @{ $::form }{ grep { m/^\{AUTH\}/ } keys %{ $::form } } unless $auth_result{keep_auth_vars};
266
267       if ($action) {
268         $::instance_conf->init if $auth_result{auth_level} eq 'user';
269
270         map { $::form->{$_} = $::myconfig{$_} } qw(charset)
271           unless $action eq 'save' && $::form->{type} eq 'preferences';
272
273         $::form->set_standard_title;
274         if ($routing_type eq 'old') {
275           ::call_sub('::' . $::locale->findsub($action));
276         } else {
277           _run_controller($script_name, $action);
278         }
279       } else {
280         $::form->error($::locale->text('action= not defined!'));
281       }
282     }
283
284     1;
285   } or do {
286     if ($EVAL_ERROR ne END_OF_REQUEST) {
287       my $error = $EVAL_ERROR;
288       print STDERR $error;
289
290       if ($::request->is_ajax) {
291         eval { render_error_ajax($error) };
292       } else {
293         $::form->{label_error} = $::request->{cgi}->pre($error);
294         chdir SL::System::Process::exe_dir;
295         eval { show_error('generic/error') };
296       }
297     }
298   };
299
300   $::form->footer;
301
302   # cleanup
303   $::auth->save_session;
304   $::auth->expire_sessions;
305   $::auth->reset;
306
307   $::locale   = undef;
308   $::form     = undef;
309   $::myconfig = ();
310   $::request  = undef;
311   Form::disconnect_standard_dbh;
312
313   $::lxdebug->end_request;
314
315   $self->_watch_for_changed_files;
316
317   $::lxdebug->leave_sub;
318 }
319
320 sub unrequire_bin_mozilla {
321   my $self = shift;
322   return unless $self->_interface_is_fcgi;
323
324   for (keys %INC) {
325     next unless m#^bin/mozilla/#;
326     next if /\bcommon.pl$/;
327     next if /\binstallationcheck.pl$/;
328     delete $INC{$_};
329   }
330 }
331
332 sub _interface_is_fcgi {
333   my $self = shift;
334   return $self->{interface} =~ m/^(?:fastcgi|fcgid|fcgi)$/;
335 }
336
337 sub _route_request {
338   my $script_name = shift;
339
340   return $script_name =~ m/dispatcher\.pl$/ ? (type => 'old',        _route_dispatcher_request())
341        : $script_name =~ m/controller\.pl/  ? (type => 'controller', _route_controller_request())
342        :                                      (type => 'old',        controller => $script_name, action => $::form->{action});
343 }
344
345 sub _route_dispatcher_request {
346   my $name_re = qr{[a-z]\w*};
347   my ($script_name, $action);
348
349   eval {
350     die "Unroutable request -- inavlid module name.\n" if !$::form->{M} || ($::form->{M} !~ m/^${name_re}$/);
351     $script_name = $::form->{M} . '.pl';
352
353     if ($::form->{A}) {
354       $action = $::form->{A};
355
356     } else {
357       $action = first { m/^A_${name_re}$/ } keys %{ $::form };
358       die "Unroutable request -- inavlid action name.\n" if !$action;
359
360       delete $::form->{$action};
361       $action = substr $action, 2;
362     }
363
364     delete @{$::form}{qw(M A)};
365
366     1;
367   } or do {
368     $::form->{label_error} = $::request->{cgi}->pre($EVAL_ERROR);
369     show_error('generic/error');
370   };
371
372   return (controller => $script_name, action => $action);
373 }
374
375 sub _route_controller_request {
376   my ($controller, $action, $request_type);
377
378   eval {
379     $::form->{action}      =~ m|^ ( [A-Z] [A-Za-z0-9_]* ) / ( [a-z] [a-z0-9_]* ) ( \. [a-zA-Z]+ )? $|x || die "Unroutable request -- inavlid controller/action.\n";
380     ($controller, $action) =  ($1, $2);
381     delete $::form->{action};
382
383     $request_type = $3 ? lc(substr($3, 1)) : 'html';
384
385     1;
386   } or do {
387     $::form->{label_error} = $::request->{cgi}->pre($EVAL_ERROR);
388     show_error('generic/error');
389   };
390
391   return (controller => $controller, action => $action, request_type => $request_type);
392 }
393
394 sub _cache_file_modification_times {
395   my ($self) = @_;
396
397   return unless $self->_interface_is_fcgi && $::lx_office_conf{debug}->{restart_fcgi_process_on_changes};
398
399   require File::Find;
400   require POSIX;
401
402   my $wanted = sub {
403     return unless $File::Find::name =~ m/\.(?:pm|f?pl|html|conf|conf\.default)$/;
404     $fcgi_file_cache{ $File::Find::name } = (stat $File::Find::name)[9];
405   };
406
407   my $cwd = POSIX::getcwd();
408   File::Find::find($wanted, map { "${cwd}/${_}" } qw(config bin SL templates/webpages));
409   map { my $name = "${cwd}/${_}"; $fcgi_file_cache{$name} = (stat $name)[9] } qw(admin.pl dispatcher.fpl);
410 }
411
412 sub _watch_for_changed_files {
413   my ($self) = @_;
414
415   return unless $self->_interface_is_fcgi && $::lx_office_conf{debug}->{restart_fcgi_process_on_changes};
416
417   my $ok = all { (stat($_))[9] == $fcgi_file_cache{$_} } keys %fcgi_file_cache;
418   return if $ok;
419   $::lxdebug->message(LXDebug::DEBUG1(), "Program modifications detected. Restarting.");
420   exit;
421 }
422
423 sub get_standard_filehandles {
424   my $self = shift;
425
426   return $self->{interface} =~ m/f(?:ast)cgi/i ? $self->{request}->GetHandles() : (\*STDIN, \*STDOUT, \*STDERR);
427 }
428
429 sub _check_for_old_config_files {
430   my @old_files = grep { -f "config/${_}" } qw(authentication.pl console.conf lx-erp.conf lx-erp-local.conf);
431   return unless @old_files;
432
433   $::form->{title} = $::locale->text('Old configuration files');
434   $::form->header;
435   print $::form->parse_html_template('login_screen/old_configuration_files', { FILES => \@old_files });
436
437   ::end_of_request();
438 }
439
440 package main;
441
442 use strict;
443
444 sub end_of_request {
445   die SL::Dispatcher->END_OF_REQUEST;
446 }
447
448 1;