7a9c54e41761fded429183fa5a1ed2f97c2553b2
[kivitendo-erp.git] / SL / Form.pm
1 #========= ===========================================================
2 # LX-Office ERP
3 # Copyright (C) 2004
4 # Based on SQL-Ledger Version 2.1.9
5 # Web http://www.lx-office.org
6 #
7 #=====================================================================
8 # SQL-Ledger Accounting
9 # Copyright (C) 1998-2002
10 #
11 #  Author: Dieter Simader
12 #   Email: dsimader@sql-ledger.org
13 #     Web: http://www.sql-ledger.org
14 #
15 # Contributors: Thomas Bayen <bayen@gmx.de>
16 #               Antti Kaihola <akaihola@siba.fi>
17 #               Moritz Bunkus (tex code)
18 #
19 # This program is free software; you can redistribute it and/or modify
20 # it under the terms of the GNU General Public License as published by
21 # the Free Software Foundation; either version 2 of the License, or
22 # (at your option) any later version.
23 #
24 # This program is distributed in the hope that it will be useful,
25 # but WITHOUT ANY WARRANTY; without even the implied warranty of
26 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
27 # GNU General Public License for more details.
28 # You should have received a copy of the GNU General Public License
29 # along with this program; if not, write to the Free Software
30 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
31 # MA 02110-1335, USA.
32 #======================================================================
33 # Utilities for parsing forms
34 # and supporting routines for linking account numbers
35 # used in AR, AP and IS, IR modules
36 #
37 #======================================================================
38
39 package Form;
40
41 use Carp;
42 use Data::Dumper;
43
44 use Carp;
45 use Config;
46 use CGI;
47 use Cwd;
48 use Encode;
49 use File::Copy;
50 use IO::File;
51 use Math::BigInt;
52 use SL::Auth;
53 use SL::Auth::DB;
54 use SL::Auth::LDAP;
55 use SL::AM;
56 use SL::Common;
57 use SL::CVar;
58 use SL::DB;
59 use SL::DBConnect;
60 use SL::DBUtils;
61 use SL::DB::Customer;
62 use SL::DB::Default;
63 use SL::DB::PaymentTerm;
64 use SL::DB::Vendor;
65 use SL::DO;
66 use SL::IC;
67 use SL::IS;
68 use SL::Layout::Dispatcher;
69 use SL::Locale;
70 use SL::Locale::String;
71 use SL::Mailer;
72 use SL::Menu;
73 use SL::MoreCommon qw(uri_encode uri_decode);
74 use SL::OE;
75 use SL::PrefixedNumber;
76 use SL::Request;
77 use SL::Template;
78 use SL::User;
79 use SL::Util;
80 use SL::X;
81 use Template;
82 use URI;
83 use List::Util qw(first max min sum);
84 use List::MoreUtils qw(all any apply);
85 use SL::DB::Tax;
86
87 use strict;
88
89 sub read_version {
90   my ($self) = @_;
91
92   open VERSION_FILE, "VERSION";                 # New but flexible code reads version from VERSION-file
93   my $version =  <VERSION_FILE>;
94   $version    =~ s/[^0-9A-Za-z\.\_\-]//g; # only allow numbers, letters, points, underscores and dashes. Prevents injecting of malicious code.
95   close VERSION_FILE;
96
97   return $version;
98 }
99
100 sub new {
101   $main::lxdebug->enter_sub();
102
103   my $type = shift;
104
105   my $self = {};
106
107   no warnings 'once';
108   if ($LXDebug::watch_form) {
109     require SL::Watchdog;
110     tie %{ $self }, 'SL::Watchdog';
111   }
112
113   bless $self, $type;
114
115   $self->{version} = $self->read_version;
116
117   $main::lxdebug->leave_sub();
118
119   return $self;
120 }
121
122 sub read_cgi_input {
123   my ($self) = @_;
124   SL::Request::read_cgi_input($self);
125 }
126
127 sub _flatten_variables_rec {
128   $main::lxdebug->enter_sub(2);
129
130   my $self   = shift;
131   my $curr   = shift;
132   my $prefix = shift;
133   my $key    = shift;
134
135   my @result;
136
137   if ('' eq ref $curr->{$key}) {
138     @result = ({ 'key' => $prefix . $key, 'value' => $curr->{$key} });
139
140   } elsif ('HASH' eq ref $curr->{$key}) {
141     foreach my $hash_key (sort keys %{ $curr->{$key} }) {
142       push @result, $self->_flatten_variables_rec($curr->{$key}, $prefix . $key . '.', $hash_key);
143     }
144
145   } else {
146     foreach my $idx (0 .. scalar @{ $curr->{$key} } - 1) {
147       my $first_array_entry = 1;
148
149       my $element = $curr->{$key}[$idx];
150
151       if ('HASH' eq ref $element) {
152         foreach my $hash_key (sort keys %{ $element }) {
153           push @result, $self->_flatten_variables_rec($element, $prefix . $key . ($first_array_entry ? '[+].' : '[].'), $hash_key);
154           $first_array_entry = 0;
155         }
156       } else {
157         @result = ({ 'key' => $prefix . $key . ($first_array_entry ? '[+]' : '[]'), 'value' => $element });
158       }
159     }
160   }
161
162   $main::lxdebug->leave_sub(2);
163
164   return @result;
165 }
166
167 sub flatten_variables {
168   $main::lxdebug->enter_sub(2);
169
170   my $self = shift;
171   my @keys = @_;
172
173   my @variables;
174
175   foreach (@keys) {
176     push @variables, $self->_flatten_variables_rec($self, '', $_);
177   }
178
179   $main::lxdebug->leave_sub(2);
180
181   return @variables;
182 }
183
184 sub flatten_standard_variables {
185   $main::lxdebug->enter_sub(2);
186
187   my $self      = shift;
188   my %skip_keys = map { $_ => 1 } (qw(login password header stylesheet titlebar version), @_);
189
190   my @variables;
191
192   foreach (grep { ! $skip_keys{$_} } keys %{ $self }) {
193     push @variables, $self->_flatten_variables_rec($self, '', $_);
194   }
195
196   $main::lxdebug->leave_sub(2);
197
198   return @variables;
199 }
200
201 sub debug {
202   $main::lxdebug->enter_sub();
203
204   my ($self) = @_;
205
206   print "\n";
207
208   map { print "$_ = $self->{$_}\n" } (sort keys %{$self});
209
210   $main::lxdebug->leave_sub();
211 }
212
213 sub dumper {
214   $main::lxdebug->enter_sub(2);
215
216   my $self          = shift;
217   my $password      = $self->{password};
218
219   $self->{password} = 'X' x 8;
220
221   local $Data::Dumper::Sortkeys = 1;
222   my $output                    = Dumper($self);
223
224   $self->{password} = $password;
225
226   $main::lxdebug->leave_sub(2);
227
228   return $output;
229 }
230
231 sub escape {
232   my ($self, $str) = @_;
233
234   return uri_encode($str);
235 }
236
237 sub unescape {
238   my ($self, $str) = @_;
239
240   return uri_decode($str);
241 }
242
243 sub quote {
244   $main::lxdebug->enter_sub();
245   my ($self, $str) = @_;
246
247   if ($str && !ref($str)) {
248     $str =~ s/\"/&quot;/g;
249   }
250
251   $main::lxdebug->leave_sub();
252
253   return $str;
254 }
255
256 sub unquote {
257   $main::lxdebug->enter_sub();
258   my ($self, $str) = @_;
259
260   if ($str && !ref($str)) {
261     $str =~ s/&quot;/\"/g;
262   }
263
264   $main::lxdebug->leave_sub();
265
266   return $str;
267 }
268
269 sub hide_form {
270   $main::lxdebug->enter_sub();
271   my $self = shift;
272
273   if (@_) {
274     map({ print($::request->{cgi}->hidden("-name" => $_, "-default" => $self->{$_}) . "\n"); } @_);
275   } else {
276     for (sort keys %$self) {
277       next if (($_ eq "header") || (ref($self->{$_}) ne ""));
278       print($::request->{cgi}->hidden("-name" => $_, "-default" => $self->{$_}) . "\n");
279     }
280   }
281   $main::lxdebug->leave_sub();
282 }
283
284 sub throw_on_error {
285   my ($self, $code) = @_;
286   local $self->{__ERROR_HANDLER} = sub { die SL::X::FormError->new($_[0]) };
287   $code->();
288 }
289
290 sub error {
291   $main::lxdebug->enter_sub();
292
293   $main::lxdebug->show_backtrace();
294
295   my ($self, $msg) = @_;
296
297   if ($self->{__ERROR_HANDLER}) {
298     $self->{__ERROR_HANDLER}->($msg);
299
300   } elsif ($ENV{HTTP_USER_AGENT}) {
301     $msg =~ s/\n/<br>/g;
302     $self->show_generic_error($msg);
303
304   } else {
305     confess "Error: $msg\n";
306   }
307
308   $main::lxdebug->leave_sub();
309 }
310
311 sub info {
312   $main::lxdebug->enter_sub();
313
314   my ($self, $msg) = @_;
315
316   if ($ENV{HTTP_USER_AGENT}) {
317     $self->header;
318     print $self->parse_html_template('generic/form_info', { message => $msg });
319
320   } elsif ($self->{info_function}) {
321     &{ $self->{info_function} }($msg);
322   } else {
323     print "$msg\n";
324   }
325
326   $main::lxdebug->leave_sub();
327 }
328
329 # calculates the number of rows in a textarea based on the content and column number
330 # can be capped with maxrows
331 sub numtextrows {
332   $main::lxdebug->enter_sub();
333   my ($self, $str, $cols, $maxrows, $minrows) = @_;
334
335   $minrows ||= 1;
336
337   my $rows   = sum map { int((length() - 2) / $cols) + 1 } split /\r/, $str;
338   $maxrows ||= $rows;
339
340   $main::lxdebug->leave_sub();
341
342   return max(min($rows, $maxrows), $minrows);
343 }
344
345 sub dberror {
346   $main::lxdebug->enter_sub();
347
348   my ($self, $msg) = @_;
349
350   $self->error("$msg\n" . $DBI::errstr);
351
352   $main::lxdebug->leave_sub();
353 }
354
355 sub isblank {
356   $main::lxdebug->enter_sub();
357
358   my ($self, $name, $msg) = @_;
359
360   my $curr = $self;
361   foreach my $part (split m/\./, $name) {
362     if (!$curr->{$part} || ($curr->{$part} =~ /^\s*$/)) {
363       $self->error($msg);
364     }
365     $curr = $curr->{$part};
366   }
367
368   $main::lxdebug->leave_sub();
369 }
370
371 sub _get_request_uri {
372   my $self = shift;
373
374   return URI->new($ENV{HTTP_REFERER})->canonical() if $ENV{HTTP_X_FORWARDED_FOR};
375   return URI->new                                  if !$ENV{REQUEST_URI}; # for testing
376
377   my $scheme =  $ENV{HTTPS} && (lc $ENV{HTTPS} eq 'on') ? 'https' : 'http';
378   my $port   =  $ENV{SERVER_PORT};
379   $port      =  undef if (($scheme eq 'http' ) && ($port == 80))
380                       || (($scheme eq 'https') && ($port == 443));
381
382   my $uri    =  URI->new("${scheme}://");
383   $uri->scheme($scheme);
384   $uri->port($port);
385   $uri->host($ENV{HTTP_HOST} || $ENV{SERVER_ADDR});
386   $uri->path_query($ENV{REQUEST_URI});
387   $uri->query('');
388
389   return $uri;
390 }
391
392 sub _add_to_request_uri {
393   my $self              = shift;
394
395   my $relative_new_path = shift;
396   my $request_uri       = shift || $self->_get_request_uri;
397   my $relative_new_uri  = URI->new($relative_new_path);
398   my @request_segments  = $request_uri->path_segments;
399
400   my $new_uri           = $request_uri->clone;
401   $new_uri->path_segments(@request_segments[0..scalar(@request_segments) - 2], $relative_new_uri->path_segments);
402
403   return $new_uri;
404 }
405
406 sub create_http_response {
407   $main::lxdebug->enter_sub();
408
409   my $self     = shift;
410   my %params   = @_;
411
412   my $cgi      = $::request->{cgi};
413
414   my $session_cookie;
415   if (defined $main::auth) {
416     my $uri      = $self->_get_request_uri;
417     my @segments = $uri->path_segments;
418     pop @segments;
419     $uri->path_segments(@segments);
420
421     my $session_cookie_value = $main::auth->get_session_id();
422
423     if ($session_cookie_value) {
424       $session_cookie = $cgi->cookie('-name'   => $main::auth->get_session_cookie_name(),
425                                      '-value'  => $session_cookie_value,
426                                      '-path'   => $uri->path,
427                                      '-secure' => $ENV{HTTPS});
428     }
429   }
430
431   my %cgi_params = ('-type' => $params{content_type});
432   $cgi_params{'-charset'} = $params{charset} if ($params{charset});
433   $cgi_params{'-cookie'}  = $session_cookie  if ($session_cookie);
434
435   map { $cgi_params{'-' . $_} = $params{$_} if exists $params{$_} } qw(content_disposition content_length);
436
437   my $output = $cgi->header(%cgi_params);
438
439   $main::lxdebug->leave_sub();
440
441   return $output;
442 }
443
444 sub header {
445   $::lxdebug->enter_sub;
446
447   my ($self, %params) = @_;
448   my @header;
449
450   $::lxdebug->leave_sub and return if !$ENV{HTTP_USER_AGENT} || $self->{header}++;
451
452   if ($params{no_layout}) {
453     $::request->{layout} = SL::Layout::Dispatcher->new(style => 'none');
454   }
455
456   my $layout = $::request->{layout};
457
458   # standard css for all
459   # this should gradually move to the layouts that need it
460   $layout->use_stylesheet("$_.css") for qw(
461     common main menu list_accounts jquery.autocomplete
462     jquery.multiselect2side
463     ui-lightness/jquery-ui
464     jquery-ui.custom
465     tooltipster themes/tooltipster-light
466   );
467
468   $layout->use_javascript("$_.js") for (qw(
469     jquery jquery-ui jquery.cookie jquery.checkall jquery.download
470     jquery/jquery.form jquery/fixes client_js
471     jquery/jquery.tooltipster.min
472     common part_selection
473   ), "jquery/ui/i18n/jquery.ui.datepicker-$::myconfig{countrycode}");
474
475   $self->{favicon} ||= "favicon.ico";
476   $self->{titlebar} = join ' - ', grep $_, $self->{title}, $self->{login}, $::myconfig{dbname}, $self->{version} if $self->{title} || !$self->{titlebar};
477
478   # build includes
479   if ($self->{refresh_url} || $self->{refresh_time}) {
480     my $refresh_time = $self->{refresh_time} || 3;
481     my $refresh_url  = $self->{refresh_url}  || $ENV{REFERER};
482     push @header, "<meta http-equiv='refresh' content='$refresh_time;$refresh_url'>";
483   }
484
485   my $auto_reload_resources_param = $layout->auto_reload_resources_param;
486
487   push @header, map { qq|<link rel="stylesheet" href="${_}${auto_reload_resources_param}" type="text/css" title="Stylesheet">| } $layout->stylesheets;
488   push @header, "<style type='text/css'>\@page { size:landscape; }</style> "                     if $self->{landscape};
489   push @header, "<link rel='shortcut icon' href='$self->{favicon}' type='image/x-icon'>"         if -f $self->{favicon};
490   push @header, map { qq|<script type="text/javascript" src="${_}${auto_reload_resources_param}"></script>| }                    $layout->javascripts;
491   push @header, $self->{javascript} if $self->{javascript};
492   push @header, map { $_->show_javascript } @{ $self->{AJAX} || [] };
493
494   my  %doctypes = (
495     strict       => qq|<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">|,
496     transitional => qq|<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">|,
497     frameset     => qq|<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">|,
498     html5        => qq|<!DOCTYPE html>|,
499   );
500
501   # output
502   print $self->create_http_response(content_type => 'text/html', charset => 'UTF-8');
503   print $doctypes{$params{doctype} || 'transitional'}, $/;
504   print <<EOT;
505 <html>
506  <head>
507   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
508   <title>$self->{titlebar}</title>
509 EOT
510   print "  $_\n" for @header;
511   print <<EOT;
512   <meta name="robots" content="noindex,nofollow">
513  </head>
514  <body>
515
516 EOT
517   print $::request->{layout}->pre_content;
518   print $::request->{layout}->start_content;
519
520   $layout->header_done;
521
522   $::lxdebug->leave_sub;
523 }
524
525 sub footer {
526   return unless $::request->{layout}->need_footer;
527
528   print $::request->{layout}->end_content;
529   print $::request->{layout}->post_content;
530
531   if (my @inline_scripts = $::request->{layout}->javascripts_inline) {
532     print "<script type='text/javascript'>" . join("; ", @inline_scripts) . "</script>\n";
533   }
534
535   print <<EOL
536  </body>
537 </html>
538 EOL
539 }
540
541 sub ajax_response_header {
542   $main::lxdebug->enter_sub();
543
544   my ($self) = @_;
545
546   my $output = $::request->{cgi}->header('-charset' => 'UTF-8');
547
548   $main::lxdebug->leave_sub();
549
550   return $output;
551 }
552
553 sub redirect_header {
554   my $self     = shift;
555   my $new_url  = shift;
556
557   my $base_uri = $self->_get_request_uri;
558   my $new_uri  = URI->new_abs($new_url, $base_uri);
559
560   die "Headers already sent" if $self->{header};
561   $self->{header} = 1;
562
563   return $::request->{cgi}->redirect($new_uri);
564 }
565
566 sub set_standard_title {
567   $::lxdebug->enter_sub;
568   my $self = shift;
569
570   $self->{titlebar}  = "kivitendo " . $::locale->text('Version') . " $self->{version}";
571   $self->{titlebar} .= "- $::myconfig{name}"   if $::myconfig{name};
572   $self->{titlebar} .= "- $::myconfig{dbname}" if $::myconfig{name};
573
574   $::lxdebug->leave_sub;
575 }
576
577 sub _prepare_html_template {
578   $main::lxdebug->enter_sub();
579
580   my ($self, $file, $additional_params) = @_;
581   my $language;
582
583   if (!%::myconfig || !$::myconfig{"countrycode"}) {
584     $language = $::lx_office_conf{system}->{language};
585   } else {
586     $language = $main::myconfig{"countrycode"};
587   }
588   $language = "de" unless ($language);
589
590   if (-f "templates/webpages/${file}.html") {
591     $file = "templates/webpages/${file}.html";
592
593   } elsif (ref $file eq 'SCALAR') {
594     # file is a scalarref, use inline mode
595   } else {
596     my $info = "Web page template '${file}' not found.\n";
597     $::form->header;
598     print qq|<pre>$info</pre>|;
599     $::dispatcher->end_request;
600   }
601
602   $additional_params->{AUTH}          = $::auth;
603   $additional_params->{INSTANCE_CONF} = $::instance_conf;
604   $additional_params->{LOCALE}        = $::locale;
605   $additional_params->{LXCONFIG}      = \%::lx_office_conf;
606   $additional_params->{LXDEBUG}       = $::lxdebug;
607   $additional_params->{MYCONFIG}      = \%::myconfig;
608
609   $main::lxdebug->leave_sub();
610
611   return $file;
612 }
613
614 sub parse_html_template {
615   $main::lxdebug->enter_sub();
616
617   my ($self, $file, $additional_params) = @_;
618
619   $additional_params ||= { };
620
621   my $real_file = $self->_prepare_html_template($file, $additional_params);
622   my $template  = $self->template || $self->init_template;
623
624   map { $additional_params->{$_} ||= $self->{$_} } keys %{ $self };
625
626   my $output;
627   $template->process($real_file, $additional_params, \$output) || die $template->error;
628
629   $main::lxdebug->leave_sub();
630
631   return $output;
632 }
633
634 sub init_template {
635   my $self = shift;
636
637   return $self->template if $self->template;
638
639   # Force scripts/locales.pl to pick up the exception handling template.
640   # parse_html_template('generic/exception')
641   return $self->template(Template->new({
642      'INTERPOLATE'  => 0,
643      'EVAL_PERL'    => 0,
644      'ABSOLUTE'     => 1,
645      'CACHE_SIZE'   => 0,
646      'PLUGIN_BASE'  => 'SL::Template::Plugin',
647      'INCLUDE_PATH' => '.:templates/webpages',
648      'COMPILE_EXT'  => '.tcc',
649      'COMPILE_DIR'  => $::lx_office_conf{paths}->{userspath} . '/templates-cache',
650      'ERROR'        => 'templates/webpages/generic/exception.html',
651      'ENCODING'     => 'utf8',
652   })) || die;
653 }
654
655 sub template {
656   my $self = shift;
657   $self->{template_object} = shift if @_;
658   return $self->{template_object};
659 }
660
661 sub show_generic_error {
662   $main::lxdebug->enter_sub();
663
664   my ($self, $error, %params) = @_;
665
666   if ($self->{__ERROR_HANDLER}) {
667     $self->{__ERROR_HANDLER}->($error);
668     $main::lxdebug->leave_sub();
669     return;
670   }
671
672   if ($::request->is_ajax) {
673     SL::ClientJS->new
674       ->error($error)
675       ->render(SL::Controller::Base->new);
676     $::dispatcher->end_request;
677   }
678
679   my $add_params = {
680     'title_error' => $params{title},
681     'label_error' => $error,
682   };
683
684   if ($params{action}) {
685     my @vars;
686
687     map { delete($self->{$_}); } qw(action);
688     map { push @vars, { "name" => $_, "value" => $self->{$_} } if (!ref($self->{$_})); } keys %{ $self };
689
690     $add_params->{SHOW_BUTTON}  = 1;
691     $add_params->{BUTTON_LABEL} = $params{label} || $params{action};
692     $add_params->{VARIABLES}    = \@vars;
693
694   } elsif ($params{back_button}) {
695     $add_params->{SHOW_BACK_BUTTON} = 1;
696   }
697
698   $self->{title} = $params{title} if $params{title};
699
700   $self->header();
701   print $self->parse_html_template("generic/error", $add_params);
702
703   print STDERR "Error: $error\n";
704
705   $main::lxdebug->leave_sub();
706
707   $::dispatcher->end_request;
708 }
709
710 sub show_generic_information {
711   $main::lxdebug->enter_sub();
712
713   my ($self, $text, $title) = @_;
714
715   my $add_params = {
716     'title_information' => $title,
717     'label_information' => $text,
718   };
719
720   $self->{title} = $title if ($title);
721
722   $self->header();
723   print $self->parse_html_template("generic/information", $add_params);
724
725   $main::lxdebug->leave_sub();
726
727   $::dispatcher->end_request;
728 }
729
730 sub _store_redirect_info_in_session {
731   my ($self) = @_;
732
733   return unless $self->{callback} =~ m:^ ( [^\?/]+ \.pl ) \? (.+) :x;
734
735   my ($controller, $params) = ($1, $2);
736   my $form                  = { map { map { $self->unescape($_) } split /=/, $_, 2 } split m/\&/, $params };
737   $self->{callback}         = "${controller}?RESTORE_FORM_FROM_SESSION_ID=" . $::auth->save_form_in_session(form => $form);
738 }
739
740 sub redirect {
741   $main::lxdebug->enter_sub();
742
743   my ($self, $msg) = @_;
744
745   if (!$self->{callback}) {
746     $self->info($msg);
747
748   } else {
749     $self->_store_redirect_info_in_session;
750     print $::form->redirect_header($self->{callback});
751   }
752
753   $::dispatcher->end_request;
754
755   $main::lxdebug->leave_sub();
756 }
757
758 # sort of columns removed - empty sub
759 sub sort_columns {
760   $main::lxdebug->enter_sub();
761
762   my ($self, @columns) = @_;
763
764   $main::lxdebug->leave_sub();
765
766   return @columns;
767 }
768 #
769 sub format_amount {
770   $main::lxdebug->enter_sub(2);
771
772   my ($self, $myconfig, $amount, $places, $dash) = @_;
773   $amount ||= 0;
774   $dash   ||= '';
775   my $neg = $amount < 0;
776   my $force_places = defined $places && $places >= 0;
777
778   $amount = $self->round_amount($amount, abs $places) if $force_places;
779   $neg    = 0 if $amount == 0; # don't show negative zero
780   $amount = sprintf "%.*f", ($force_places ? $places : 10), abs $amount; # 6 is default for %fa
781
782   # before the sprintf amount was a number, afterwards it's a string. because of the dynamic nature of perl
783   # this is easy to confuse, so keep in mind: before this comment no s///, m//, concat or other strong ops on
784   # $amount. after this comment no +,-,*,/,abs. it will only introduce subtle bugs.
785
786   $amount =~ s/0*$// unless defined $places && $places == 0;             # cull trailing 0s
787
788   my @d = map { s/\d//g; reverse split // } my $tmp = $myconfig->{numberformat}; # get delim chars
789   my @p = split(/\./, $amount);                                          # split amount at decimal point
790
791   $p[0] =~ s/\B(?=(...)*$)/$d[1]/g if $d[1];                             # add 1,000 delimiters
792   $amount = $p[0];
793   if ($places || $p[1]) {
794     $amount .= $d[0]
795             .  ( $p[1] || '' )
796             .  (0 x max(abs($places || 0) - length ($p[1]||''), 0));     # pad the fraction
797   }
798
799   $amount = do {
800     ($dash =~ /-/)    ? ($neg ? "($amount)"                            : "$amount" )                              :
801     ($dash =~ /DRCR/) ? ($neg ? "$amount " . $main::locale->text('DR') : "$amount " . $main::locale->text('CR') ) :
802                         ($neg ? "-$amount"                             : "$amount" )                              ;
803   };
804
805   $main::lxdebug->leave_sub(2);
806   return $amount;
807 }
808
809 sub format_amount_units {
810   $main::lxdebug->enter_sub();
811
812   my $self             = shift;
813   my %params           = @_;
814
815   my $myconfig         = \%main::myconfig;
816   my $amount           = $params{amount} * 1;
817   my $places           = $params{places};
818   my $part_unit_name   = $params{part_unit};
819   my $amount_unit_name = $params{amount_unit};
820   my $conv_units       = $params{conv_units};
821   my $max_places       = $params{max_places};
822
823   if (!$part_unit_name) {
824     $main::lxdebug->leave_sub();
825     return '';
826   }
827
828   my $all_units        = AM->retrieve_all_units;
829
830   if (('' eq ref $conv_units) && ($conv_units =~ /convertible/)) {
831     $conv_units = AM->convertible_units($all_units, $part_unit_name, $conv_units eq 'convertible_not_smaller');
832   }
833
834   if (!scalar @{ $conv_units }) {
835     my $result = $self->format_amount($myconfig, $amount, $places, undef, $max_places) . " " . $part_unit_name;
836     $main::lxdebug->leave_sub();
837     return $result;
838   }
839
840   my $part_unit  = $all_units->{$part_unit_name};
841   my $conv_unit  = ($amount_unit_name && ($amount_unit_name ne $part_unit_name)) ? $all_units->{$amount_unit_name} : $part_unit;
842
843   $amount       *= $conv_unit->{factor};
844
845   my @values;
846   my $num;
847
848   foreach my $unit (@$conv_units) {
849     my $last = $unit->{name} eq $part_unit->{name};
850     if (!$last) {
851       $num     = int($amount / $unit->{factor});
852       $amount -= $num * $unit->{factor};
853     }
854
855     if ($last ? $amount : $num) {
856       push @values, { "unit"   => $unit->{name},
857                       "amount" => $last ? $amount / $unit->{factor} : $num,
858                       "places" => $last ? $places : 0 };
859     }
860
861     last if $last;
862   }
863
864   if (!@values) {
865     push @values, { "unit"   => $part_unit_name,
866                     "amount" => 0,
867                     "places" => 0 };
868   }
869
870   my $result = join " ", map { $self->format_amount($myconfig, $_->{amount}, $_->{places}, undef, $max_places), $_->{unit} } @values;
871
872   $main::lxdebug->leave_sub();
873
874   return $result;
875 }
876
877 sub format_string {
878   $main::lxdebug->enter_sub(2);
879
880   my $self  = shift;
881   my $input = shift;
882
883   $input =~ s/(^|[^\#]) \#  (\d+)  /$1$_[$2 - 1]/gx;
884   $input =~ s/(^|[^\#]) \#\{(\d+)\}/$1$_[$2 - 1]/gx;
885   $input =~ s/\#\#/\#/g;
886
887   $main::lxdebug->leave_sub(2);
888
889   return $input;
890 }
891
892 #
893
894 sub parse_amount {
895   $main::lxdebug->enter_sub(2);
896
897   my ($self, $myconfig, $amount) = @_;
898
899   if (!defined($amount) || ($amount eq '')) {
900     $main::lxdebug->leave_sub(2);
901     return 0;
902   }
903
904   if (   ($myconfig->{numberformat} eq '1.000,00')
905       || ($myconfig->{numberformat} eq '1000,00')) {
906     $amount =~ s/\.//g;
907     $amount =~ s/,/\./g;
908   }
909
910   if ($myconfig->{numberformat} eq "1'000.00") {
911     $amount =~ s/\'//g;
912   }
913
914   $amount =~ s/,//g;
915
916   $main::lxdebug->leave_sub(2);
917
918   # Make sure no code wich is not a math expression ends up in eval().
919   return 0 unless $amount =~ /^ [\s \d \( \) \- \+ \* \/ \. ]* $/x;
920
921   # Prevent numbers from being parsed as octals;
922   $amount =~ s{ (?<! [\d.] ) 0+ (?= [1-9] ) }{}gx;
923
924   return scalar(eval($amount)) * 1 ;
925 }
926
927 sub round_amount {
928   my ($self, $amount, $places, $adjust) = @_;
929
930   return 0 if !defined $amount;
931
932   $places //= 0;
933
934   if ($adjust) {
935     my $precision = $::instance_conf->get_precision || 0.01;
936     return $self->round_amount( $self->round_amount($amount / $precision, 0) * $precision, $places);
937   }
938
939   # We use Perl's knowledge of string representation for
940   # rounding. First, convert the floating point number to a string
941   # with a high number of places. Then split the string on the decimal
942   # sign and use integer calculation for rounding the decimal places
943   # part. If an overflow occurs then apply that overflow to the part
944   # before the decimal sign as well using integer arithmetic again.
945
946   my $int_amount = int(abs $amount);
947   my $str_places = max(min(10, 16 - length("$int_amount") - $places), $places);
948   my $amount_str = sprintf '%.*f', $places + $str_places, abs($amount);
949
950   return $amount unless $amount_str =~ m{^(\d+)\.(\d+)$};
951
952   my ($pre, $post)      = ($1, $2);
953   my $decimals          = '1' . substr($post, 0, $places);
954
955   my $propagation_limit = $Config{i32size} == 4 ? 7 : 18;
956   my $add_for_rounding  = substr($post, $places, 1) >= 5 ? 1 : 0;
957
958   if ($places > $propagation_limit) {
959     $decimals = Math::BigInt->new($decimals)->badd($add_for_rounding);
960     $pre      = Math::BigInt->new($decimals)->badd(1) if substr($decimals, 0, 1) eq '2';
961
962   } else {
963     $decimals += $add_for_rounding;
964     $pre      += 1 if substr($decimals, 0, 1) eq '2';
965   }
966
967   $amount  = ("${pre}." . substr($decimals, 1)) * ($amount <=> 0);
968
969   return $amount;
970 }
971
972 sub parse_template {
973   $main::lxdebug->enter_sub();
974
975   my ($self, $myconfig) = @_;
976   my ($out, $out_mode);
977
978   local (*IN, *OUT);
979
980   my $defaults  = SL::DB::Default->get;
981   my $userspath = $::lx_office_conf{paths}->{userspath};
982
983   $self->{"cwd"} = getcwd();
984   $self->{"tmpdir"} = $self->{cwd} . "/${userspath}";
985
986   my $ext_for_format;
987
988   my $template_type;
989   if ($self->{"format"} =~ /(opendocument|oasis)/i) {
990     $template_type  = 'OpenDocument';
991     $ext_for_format = $self->{"format"} =~ m/pdf/ ? 'pdf' : 'odt';
992
993   } elsif ($self->{"format"} =~ /(postscript|pdf)/i) {
994     $template_type    = 'LaTeX';
995     $ext_for_format   = 'pdf';
996
997   } elsif (($self->{"format"} =~ /html/i) || (!$self->{"format"} && ($self->{"IN"} =~ /html$/i))) {
998     $template_type  = 'HTML';
999     $ext_for_format = 'html';
1000
1001   } elsif (($self->{"format"} =~ /xml/i) || (!$self->{"format"} && ($self->{"IN"} =~ /xml$/i))) {
1002     $template_type  = 'XML';
1003     $ext_for_format = 'xml';
1004
1005   } elsif ( $self->{"format"} =~ /elster(?:winston|taxbird)/i ) {
1006     $template_type = 'XML';
1007
1008   } elsif ( $self->{"format"} =~ /excel/i ) {
1009     $template_type  = 'Excel';
1010     $ext_for_format = 'xls';
1011
1012   } elsif ( defined $self->{'format'}) {
1013     $self->error("Outputformat not defined. This may be a future feature: $self->{'format'}");
1014
1015   } elsif ( $self->{'format'} eq '' ) {
1016     $self->error("No Outputformat given: $self->{'format'}");
1017
1018   } else { #Catch the rest
1019     $self->error("Outputformat not defined: $self->{'format'}");
1020   }
1021
1022   my $template = SL::Template::create(type      => $template_type,
1023                                       file_name => $self->{IN},
1024                                       form      => $self,
1025                                       myconfig  => $myconfig,
1026                                       userspath => $userspath,
1027                                       %{ $self->{TEMPLATE_DRIVER_OPTIONS} || {} });
1028
1029   # Copy the notes from the invoice/sales order etc. back to the variable "notes" because that is where most templates expect it to be.
1030   $self->{"notes"} = $self->{ $self->{"formname"} . "notes" } if exists $self->{ $self->{"formname"} . "notes" };
1031
1032   if (!$self->{employee_id}) {
1033     $self->{"employee_${_}"} = $myconfig->{$_} for qw(email tel fax name signature);
1034     $self->{"employee_${_}"} = $defaults->$_   for qw(address businessnumber co_ustid company duns sepa_creditor_id taxnumber);
1035   }
1036
1037   $self->{"myconfig_${_}"} = $myconfig->{$_} for grep { $_ ne 'dbpasswd' } keys %{ $myconfig };
1038   $self->{$_}              = $defaults->$_   for qw(co_ustid);
1039   $self->{"myconfig_${_}"} = $defaults->$_   for qw(address businessnumber co_ustid company duns sepa_creditor_id taxnumber);
1040   $self->{AUTH}            = $::auth;
1041   $self->{INSTANCE_CONF}   = $::instance_conf;
1042   $self->{LOCALE}          = $::locale;
1043   $self->{LXCONFIG}        = $::lx_office_conf;
1044   $self->{LXDEBUG}         = $::lxdebug;
1045   $self->{MYCONFIG}        = \%::myconfig;
1046
1047   $self->{copies} = 1 if (($self->{copies} *= 1) <= 0);
1048
1049   # OUT is used for the media, screen, printer, email
1050   # for postscript we store a copy in a temporary file
1051   my ($temp_fh, $suffix);
1052   $suffix =  $self->{IN};
1053   $suffix =~ s/.*\.//;
1054   ($temp_fh, $self->{tmpfile}) = File::Temp::tempfile(
1055     'kivitendo-printXXXXXX',
1056     SUFFIX => '.' . ($suffix || 'tex'),
1057     DIR    => $userspath,
1058     UNLINK => ($::lx_office_conf{debug} && $::lx_office_conf{debug}->{keep_temp_files})? 0 : 1,
1059   );
1060   close $temp_fh;
1061   (undef, undef, $self->{template_meta}{tmpfile}) = File::Spec->splitpath( $self->{tmpfile} );
1062
1063   $out              = $self->{OUT};
1064   $out_mode         = $self->{OUT_MODE} || '>';
1065   $self->{OUT}      = "$self->{tmpfile}";
1066   $self->{OUT_MODE} = '>';
1067
1068   my $result;
1069   my $command_formatter = sub {
1070     my ($out_mode, $out) = @_;
1071     return $out_mode eq '|-' ? SL::Template::create(type => 'ShellCommand', form => $self)->parse($out) : $out;
1072   };
1073
1074   if ($self->{OUT}) {
1075     $self->{OUT} = $command_formatter->($self->{OUT_MODE}, $self->{OUT});
1076     open(OUT, $self->{OUT_MODE}, $self->{OUT}) or $self->error("error on opening $self->{OUT} with mode $self->{OUT_MODE} : $!");
1077   } else {
1078     *OUT = ($::dispatcher->get_standard_filehandles)[1];
1079     $self->header;
1080   }
1081
1082   if (!$template->parse(*OUT)) {
1083     $self->cleanup();
1084     $self->error("$self->{IN} : " . $template->get_error());
1085   }
1086
1087   close OUT if $self->{OUT};
1088   # check only one flag (webdav_documents)
1089   # therefore copy to webdav, even if we do not have the webdav feature enabled (just archive)
1090   my $copy_to_webdav =  $::instance_conf->get_webdav_documents && !$self->{preview} && $self->{tmpdir} && $self->{tmpfile} && $self->{type};
1091
1092   if ($self->{media} eq 'file') {
1093     copy(join('/', $self->{cwd}, $userspath, $self->{tmpfile}), $out =~ m|^/| ? $out : join('/', $self->{cwd}, $out)) if $template->uses_temp_file;
1094     Common::copy_file_to_webdav_folder($self)                                                                         if $copy_to_webdav;
1095     $self->cleanup;
1096     chdir("$self->{cwd}");
1097
1098     $::lxdebug->leave_sub();
1099
1100     return;
1101   }
1102
1103   Common::copy_file_to_webdav_folder($self) if $copy_to_webdav;
1104
1105   if ($self->{media} eq 'email') {
1106
1107     my $mail = Mailer->new;
1108
1109     map { $mail->{$_} = $self->{$_} }
1110       qw(cc bcc subject message version format);
1111     $mail->{to} = $self->{EMAIL_RECIPIENT} ? $self->{EMAIL_RECIPIENT} : $self->{email};
1112     $mail->{from}   = qq|"$myconfig->{name}" <$myconfig->{email}>|;
1113     $mail->{fileid} = time() . '.' . $$ . '.';
1114     my $full_signature     =  $self->create_email_signature();
1115     $full_signature        =~ s/\r//g;
1116
1117     # if we send html or plain text inline
1118     if (($self->{format} eq 'html') && ($self->{sendmode} eq 'inline')) {
1119       $mail->{contenttype}    =  "text/html";
1120       $mail->{message}        =~ s/\r//g;
1121       $mail->{message}        =~ s/\n/<br>\n/g;
1122       $full_signature         =~ s/\n/<br>\n/g;
1123       $mail->{message}       .=  $full_signature;
1124
1125       open(IN, "<:encoding(UTF-8)", $self->{tmpfile})
1126         or $self->error($self->cleanup . "$self->{tmpfile} : $!");
1127       $mail->{message} .= $_ while <IN>;
1128       close(IN);
1129
1130     } else {
1131
1132       if (!$self->{"do_not_attach"}) {
1133         my $attachment_name  =  $self->{attachment_filename} || $self->{tmpfile};
1134         $attachment_name     =~ s/\.(.+?)$/.${ext_for_format}/ if ($ext_for_format);
1135         $mail->{attachments} =  [{ "filename" => $self->{tmpfile},
1136                                    "name"     => $attachment_name }];
1137       }
1138
1139       $mail->{message} .= $full_signature;
1140     }
1141
1142     my $err = $mail->send();
1143     $self->error($self->cleanup . "$err") if ($err);
1144
1145   } else {
1146
1147     $self->{OUT}      = $out;
1148     $self->{OUT_MODE} = $out_mode;
1149
1150     my $numbytes = (-s $self->{tmpfile});
1151     open(IN, "<", $self->{tmpfile})
1152       or $self->error($self->cleanup . "$self->{tmpfile} : $!");
1153     binmode IN;
1154
1155     $self->{copies} = 1 unless $self->{media} eq 'printer';
1156
1157     chdir("$self->{cwd}");
1158     #print(STDERR "Kopien $self->{copies}\n");
1159     #print(STDERR "OUT $self->{OUT}\n");
1160     for my $i (1 .. $self->{copies}) {
1161       if ($self->{OUT}) {
1162         $self->{OUT} = $command_formatter->($self->{OUT_MODE}, $self->{OUT});
1163
1164         open  OUT, $self->{OUT_MODE}, $self->{OUT} or $self->error($self->cleanup . "$self->{OUT} : $!");
1165         print OUT $_ while <IN>;
1166         close OUT;
1167         seek  IN, 0, 0;
1168
1169       } else {
1170         my %headers = ('-type'       => $template->get_mime_type,
1171                        '-connection' => 'close',
1172                        '-charset'    => 'UTF-8');
1173
1174         $self->{attachment_filename} ||= $self->generate_attachment_filename;
1175
1176         if ($self->{attachment_filename}) {
1177           %headers = (
1178             %headers,
1179             '-attachment'     => $self->{attachment_filename},
1180             '-content-length' => $numbytes,
1181             '-charset'        => '',
1182           );
1183         }
1184
1185         print $::request->cgi->header(%headers);
1186
1187         $::locale->with_raw_io(\*STDOUT, sub { print while <IN> });
1188       }
1189     }
1190
1191     close(IN);
1192   }
1193
1194   $self->cleanup;
1195
1196   chdir("$self->{cwd}");
1197   $main::lxdebug->leave_sub();
1198 }
1199
1200 sub get_formname_translation {
1201   $main::lxdebug->enter_sub();
1202   my ($self, $formname) = @_;
1203
1204   $formname ||= $self->{formname};
1205
1206   $self->{recipient_locale} ||=  Locale->lang_to_locale($self->{language});
1207   local $::locale = Locale->new($self->{recipient_locale});
1208
1209   my %formname_translations = (
1210     bin_list                => $main::locale->text('Bin List'),
1211     credit_note             => $main::locale->text('Credit Note'),
1212     invoice                 => $main::locale->text('Invoice'),
1213     pick_list               => $main::locale->text('Pick List'),
1214     proforma                => $main::locale->text('Proforma Invoice'),
1215     purchase_order          => $main::locale->text('Purchase Order'),
1216     request_quotation       => $main::locale->text('RFQ'),
1217     sales_order             => $main::locale->text('Confirmation'),
1218     sales_quotation         => $main::locale->text('Quotation'),
1219     storno_invoice          => $main::locale->text('Storno Invoice'),
1220     sales_delivery_order    => $main::locale->text('Delivery Order'),
1221     purchase_delivery_order => $main::locale->text('Delivery Order'),
1222     dunning                 => $main::locale->text('Dunning'),
1223     letter                  => $main::locale->text('Letter'),
1224     ic_supply               => $main::locale->text('Intra-Community supply'),
1225   );
1226
1227   $main::lxdebug->leave_sub();
1228   return $formname_translations{$formname};
1229 }
1230
1231 sub get_number_prefix_for_type {
1232   $main::lxdebug->enter_sub();
1233   my ($self) = @_;
1234
1235   my $prefix =
1236       (first { $self->{type} eq $_ } qw(invoice credit_note)) ? 'inv'
1237     : ($self->{type} =~ /_quotation$/)                        ? 'quo'
1238     : ($self->{type} =~ /_delivery_order$/)                   ? 'do'
1239     : ($self->{type} =~ /letter/)                             ? 'letter'
1240     :                                                           'ord';
1241
1242   # better default like this?
1243   # : ($self->{type} =~ /(sales|purcharse)_order/           :  'ord';
1244   # :                                                           'prefix_undefined';
1245
1246   $main::lxdebug->leave_sub();
1247   return $prefix;
1248 }
1249
1250 sub get_extension_for_format {
1251   $main::lxdebug->enter_sub();
1252   my ($self)    = @_;
1253
1254   my $extension = $self->{format} =~ /pdf/i          ? ".pdf"
1255                 : $self->{format} =~ /postscript/i   ? ".ps"
1256                 : $self->{format} =~ /opendocument/i ? ".odt"
1257                 : $self->{format} =~ /excel/i        ? ".xls"
1258                 : $self->{format} =~ /html/i         ? ".html"
1259                 :                                      "";
1260
1261   $main::lxdebug->leave_sub();
1262   return $extension;
1263 }
1264
1265 sub generate_attachment_filename {
1266   $main::lxdebug->enter_sub();
1267   my ($self) = @_;
1268
1269   $self->{recipient_locale} ||=  Locale->lang_to_locale($self->{language});
1270   my $recipient_locale = Locale->new($self->{recipient_locale});
1271
1272   my $attachment_filename = $main::locale->unquote_special_chars('HTML', $self->get_formname_translation());
1273   my $prefix              = $self->get_number_prefix_for_type();
1274
1275   if ($self->{preview} && (first { $self->{type} eq $_ } qw(invoice credit_note))) {
1276     $attachment_filename .= ' (' . $recipient_locale->text('Preview') . ')' . $self->get_extension_for_format();
1277
1278   } elsif ($attachment_filename && $self->{"${prefix}number"}) {
1279     $attachment_filename .=  "_" . $self->{"${prefix}number"} . $self->get_extension_for_format();
1280
1281   } elsif ($attachment_filename) {
1282     $attachment_filename .=  $self->get_extension_for_format();
1283
1284   } else {
1285     $attachment_filename = "";
1286   }
1287
1288   $attachment_filename =  $main::locale->quote_special_chars('filenames', $attachment_filename);
1289   $attachment_filename =~ s|[\s/\\]+|_|g;
1290
1291   $main::lxdebug->leave_sub();
1292   return $attachment_filename;
1293 }
1294
1295 sub generate_email_subject {
1296   $main::lxdebug->enter_sub();
1297   my ($self) = @_;
1298
1299   my $subject = $main::locale->unquote_special_chars('HTML', $self->get_formname_translation());
1300   my $prefix  = $self->get_number_prefix_for_type();
1301
1302   if ($subject && $self->{"${prefix}number"}) {
1303     $subject .= " " . $self->{"${prefix}number"}
1304   }
1305
1306   $main::lxdebug->leave_sub();
1307   return $subject;
1308 }
1309
1310 sub cleanup {
1311   $main::lxdebug->enter_sub();
1312
1313   my ($self, $application) = @_;
1314
1315   my $error_code = $?;
1316
1317   chdir("$self->{tmpdir}");
1318
1319   my @err = ();
1320   if ((-1 == $error_code) || (127 == (($error_code) >> 8))) {
1321     push @err, $::locale->text('The application "#1" was not found on the system.', $application || 'pdflatex') . ' ' . $::locale->text('Please contact your administrator.');
1322
1323   } elsif (-f "$self->{tmpfile}.err") {
1324     open(FH, "<:encoding(UTF-8)", "$self->{tmpfile}.err");
1325     @err = <FH>;
1326     close(FH);
1327   }
1328
1329   if ($self->{tmpfile} && !($::lx_office_conf{debug} && $::lx_office_conf{debug}->{keep_temp_files})) {
1330     $self->{tmpfile} =~ s|.*/||g;
1331     # strip extension
1332     $self->{tmpfile} =~ s/\.\w+$//g;
1333     my $tmpfile = $self->{tmpfile};
1334     unlink(<$tmpfile.*>);
1335   }
1336
1337   chdir("$self->{cwd}");
1338
1339   $main::lxdebug->leave_sub();
1340
1341   return "@err";
1342 }
1343
1344 sub datetonum {
1345   $main::lxdebug->enter_sub();
1346
1347   my ($self, $date, $myconfig) = @_;
1348   my ($yy, $mm, $dd);
1349
1350   if ($date && $date =~ /\D/) {
1351
1352     if ($myconfig->{dateformat} =~ /^yy/) {
1353       ($yy, $mm, $dd) = split /\D/, $date;
1354     }
1355     if ($myconfig->{dateformat} =~ /^mm/) {
1356       ($mm, $dd, $yy) = split /\D/, $date;
1357     }
1358     if ($myconfig->{dateformat} =~ /^dd/) {
1359       ($dd, $mm, $yy) = split /\D/, $date;
1360     }
1361
1362     $dd *= 1;
1363     $mm *= 1;
1364     $yy = ($yy < 70) ? $yy + 2000 : $yy;
1365     $yy = ($yy >= 70 && $yy <= 99) ? $yy + 1900 : $yy;
1366
1367     $dd = "0$dd" if ($dd < 10);
1368     $mm = "0$mm" if ($mm < 10);
1369
1370     $date = "$yy$mm$dd";
1371   }
1372
1373   $main::lxdebug->leave_sub();
1374
1375   return $date;
1376 }
1377
1378 # Database routines used throughout
1379 # DB Handling got moved to SL::DB, these are only shims for compatibility
1380
1381 sub dbconnect {
1382   SL::DB->client->dbh;
1383 }
1384
1385 sub get_standard_dbh {
1386   my $dbh = SL::DB->client->dbh;
1387
1388   if ($dbh && !$dbh->{Active}) {
1389     $main::lxdebug->message(LXDebug->INFO(), "get_standard_dbh: \$dbh is defined but not Active anymore");
1390     SL::DB->client->dbh(undef);
1391   }
1392
1393   SL::DB->client->dbh;
1394 }
1395
1396 sub disconnect_standard_dbh {
1397   SL::DB->client->dbh->rollback;
1398 }
1399
1400 # /database
1401
1402 sub date_closed {
1403   $main::lxdebug->enter_sub();
1404
1405   my ($self, $date, $myconfig) = @_;
1406   my $dbh = $self->get_standard_dbh;
1407
1408   my $query = "SELECT 1 FROM defaults WHERE ? < closedto";
1409   my $sth = prepare_execute_query($self, $dbh, $query, conv_date($date));
1410
1411   # Falls $date = '' - Fehlermeldung aus der Datenbank. Ich denke,
1412   # es ist sicher ein conv_date vorher IMMER auszuführen.
1413   # Testfälle ohne definiertes closedto:
1414   #   Leere Datumseingabe i.O.
1415   #     SELECT 1 FROM defaults WHERE '' < closedto
1416   #   normale Zahlungsbuchung Ã¼ber Rechnungsmaske i.O.
1417   #     SELECT 1 FROM defaults WHERE '10.05.2011' < closedto
1418   # Testfälle mit definiertem closedto (30.04.2011):
1419   #  Leere Datumseingabe i.O.
1420   #   SELECT 1 FROM defaults WHERE '' < closedto
1421   # normale Buchung im geschloßenem Zeitraum i.O.
1422   #   SELECT 1 FROM defaults WHERE '21.04.2011' < closedto
1423   #     Fehlermeldung: Es können keine Zahlungen für abgeschlossene Bücher gebucht werden!
1424   # normale Buchung in aktiver Buchungsperiode i.O.
1425   #   SELECT 1 FROM defaults WHERE '01.05.2011' < closedto
1426
1427   my ($closed) = $sth->fetchrow_array;
1428
1429   $main::lxdebug->leave_sub();
1430
1431   return $closed;
1432 }
1433
1434 # prevents bookings to the to far away future
1435 sub date_max_future {
1436   $main::lxdebug->enter_sub();
1437
1438   my ($self, $date, $myconfig) = @_;
1439   my $dbh = $self->get_standard_dbh;
1440
1441   my $query = "SELECT 1 FROM defaults WHERE ? - current_date > max_future_booking_interval";
1442   my $sth = prepare_execute_query($self, $dbh, $query, conv_date($date));
1443
1444   my ($max_future_booking_interval) = $sth->fetchrow_array;
1445
1446   $main::lxdebug->leave_sub();
1447
1448   return $max_future_booking_interval;
1449 }
1450
1451
1452 sub update_balance {
1453   $main::lxdebug->enter_sub();
1454
1455   my ($self, $dbh, $table, $field, $where, $value, @values) = @_;
1456
1457   # if we have a value, go do it
1458   if ($value != 0) {
1459
1460     # retrieve balance from table
1461     my $query = "SELECT $field FROM $table WHERE $where FOR UPDATE";
1462     my $sth = prepare_execute_query($self, $dbh, $query, @values);
1463     my ($balance) = $sth->fetchrow_array;
1464     $sth->finish;
1465
1466     $balance += $value;
1467
1468     # update balance
1469     $query = "UPDATE $table SET $field = $balance WHERE $where";
1470     do_query($self, $dbh, $query, @values);
1471   }
1472   $main::lxdebug->leave_sub();
1473 }
1474
1475 sub update_exchangerate {
1476   $main::lxdebug->enter_sub();
1477
1478   my ($self, $dbh, $curr, $transdate, $buy, $sell) = @_;
1479   my ($query);
1480   # some sanity check for currency
1481   if ($curr eq '') {
1482     $main::lxdebug->leave_sub();
1483     return;
1484   }
1485   $query = qq|SELECT name AS curr FROM currencies WHERE id=(SELECT currency_id FROM defaults)|;
1486
1487   my ($defaultcurrency) = selectrow_query($self, $dbh, $query);
1488
1489   if ($curr eq $defaultcurrency) {
1490     $main::lxdebug->leave_sub();
1491     return;
1492   }
1493
1494   $query = qq|SELECT e.currency_id FROM exchangerate e
1495                  WHERE e.currency_id = (SELECT cu.id FROM currencies cu WHERE cu.name=?) AND e.transdate = ?
1496                  FOR UPDATE|;
1497   my $sth = prepare_execute_query($self, $dbh, $query, $curr, $transdate);
1498
1499   if ($buy == 0) {
1500     $buy = "";
1501   }
1502   if ($sell == 0) {
1503     $sell = "";
1504   }
1505
1506   $buy = conv_i($buy, "NULL");
1507   $sell = conv_i($sell, "NULL");
1508
1509   my $set;
1510   if ($buy != 0 && $sell != 0) {
1511     $set = "buy = $buy, sell = $sell";
1512   } elsif ($buy != 0) {
1513     $set = "buy = $buy";
1514   } elsif ($sell != 0) {
1515     $set = "sell = $sell";
1516   }
1517
1518   if ($sth->fetchrow_array) {
1519     $query = qq|UPDATE exchangerate
1520                 SET $set
1521                 WHERE currency_id = (SELECT id FROM currencies WHERE name = ?)
1522                 AND transdate = ?|;
1523
1524   } else {
1525     $query = qq|INSERT INTO exchangerate (currency_id, buy, sell, transdate)
1526                 VALUES ((SELECT id FROM currencies WHERE name = ?), $buy, $sell, ?)|;
1527   }
1528   $sth->finish;
1529   do_query($self, $dbh, $query, $curr, $transdate);
1530
1531   $main::lxdebug->leave_sub();
1532 }
1533
1534 sub save_exchangerate {
1535   $main::lxdebug->enter_sub();
1536
1537   my ($self, $myconfig, $currency, $transdate, $rate, $fld) = @_;
1538
1539   SL::DB->client->with_transaction(sub {
1540     my $dbh = SL::DB->client->dbh;
1541
1542     my ($buy, $sell);
1543
1544     $buy  = $rate if $fld eq 'buy';
1545     $sell = $rate if $fld eq 'sell';
1546
1547
1548     $self->update_exchangerate($dbh, $currency, $transdate, $buy, $sell);
1549     1;
1550   }) or do { die SL::DB->client->error };
1551
1552   $main::lxdebug->leave_sub();
1553 }
1554
1555 sub get_exchangerate {
1556   $main::lxdebug->enter_sub();
1557
1558   my ($self, $dbh, $curr, $transdate, $fld) = @_;
1559   my ($query);
1560
1561   unless ($transdate && $curr) {
1562     $main::lxdebug->leave_sub();
1563     return 1;
1564   }
1565
1566   $query = qq|SELECT name AS curr FROM currencies WHERE id = (SELECT currency_id FROM defaults)|;
1567
1568   my ($defaultcurrency) = selectrow_query($self, $dbh, $query);
1569
1570   if ($curr eq $defaultcurrency) {
1571     $main::lxdebug->leave_sub();
1572     return 1;
1573   }
1574
1575   $query = qq|SELECT e.$fld FROM exchangerate e
1576                  WHERE e.currency_id = (SELECT id FROM currencies WHERE name = ?) AND e.transdate = ?|;
1577   my ($exchangerate) = selectrow_query($self, $dbh, $query, $curr, $transdate);
1578
1579
1580
1581   $main::lxdebug->leave_sub();
1582
1583   return $exchangerate;
1584 }
1585
1586 sub check_exchangerate {
1587   $main::lxdebug->enter_sub();
1588
1589   my ($self, $myconfig, $currency, $transdate, $fld) = @_;
1590
1591   if ($fld !~/^buy|sell$/) {
1592     $self->error('Fatal: check_exchangerate called with invalid buy/sell argument');
1593   }
1594
1595   unless ($transdate) {
1596     $main::lxdebug->leave_sub();
1597     return "";
1598   }
1599
1600   my ($defaultcurrency) = $self->get_default_currency($myconfig);
1601
1602   if ($currency eq $defaultcurrency) {
1603     $main::lxdebug->leave_sub();
1604     return 1;
1605   }
1606
1607   my $dbh   = $self->get_standard_dbh($myconfig);
1608   my $query = qq|SELECT e.$fld FROM exchangerate e
1609                  WHERE e.currency_id = (SELECT id FROM currencies WHERE name = ?) AND e.transdate = ?|;
1610
1611   my ($exchangerate) = selectrow_query($self, $dbh, $query, $currency, $transdate);
1612
1613   $main::lxdebug->leave_sub();
1614
1615   return $exchangerate;
1616 }
1617
1618 sub get_all_currencies {
1619   $main::lxdebug->enter_sub();
1620
1621   my $self     = shift;
1622   my $myconfig = shift || \%::myconfig;
1623   my $dbh      = $self->get_standard_dbh($myconfig);
1624
1625   my $query = qq|SELECT name FROM currencies|;
1626   my @currencies = map { $_->{name} } selectall_hashref_query($self, $dbh, $query);
1627
1628   $main::lxdebug->leave_sub();
1629
1630   return @currencies;
1631 }
1632
1633 sub get_default_currency {
1634   $main::lxdebug->enter_sub();
1635
1636   my ($self, $myconfig) = @_;
1637   my $dbh      = $self->get_standard_dbh($myconfig);
1638   my $query = qq|SELECT name AS curr FROM currencies WHERE id = (SELECT currency_id FROM defaults)|;
1639
1640   my ($defaultcurrency) = selectrow_query($self, $dbh, $query);
1641
1642   $main::lxdebug->leave_sub();
1643
1644   return $defaultcurrency;
1645 }
1646
1647 sub set_payment_options {
1648   my ($self, $myconfig, $transdate, $type) = @_;
1649
1650   my $terms = $self->{payment_id} ? SL::DB::PaymentTerm->new(id => $self->{payment_id})->load : undef;
1651   return if !$terms;
1652
1653   my $is_invoice                = $type =~ m{invoice}i;
1654
1655   $transdate                  ||= $self->{invdate} || $self->{transdate};
1656   my $due_date                  = $self->{duedate} || $self->{reqdate};
1657
1658   $self->{$_}                   = $terms->$_ for qw(terms_netto terms_skonto percent_skonto);
1659   $self->{payment_description}  = $terms->description;
1660   $self->{netto_date}           = $terms->calc_date(reference_date => $transdate, due_date => $due_date, terms => 'net')->to_kivitendo;
1661   $self->{skonto_date}          = $terms->calc_date(reference_date => $transdate, due_date => $due_date, terms => 'discount')->to_kivitendo;
1662
1663   my ($invtotal, $total);
1664   my (%amounts, %formatted_amounts);
1665
1666   if ($self->{type} =~ /_order$/) {
1667     $amounts{invtotal} = $self->{ordtotal};
1668     $amounts{total}    = $self->{ordtotal};
1669
1670   } elsif ($self->{type} =~ /_quotation$/) {
1671     $amounts{invtotal} = $self->{quototal};
1672     $amounts{total}    = $self->{quototal};
1673
1674   } else {
1675     $amounts{invtotal} = $self->{invtotal};
1676     $amounts{total}    = $self->{total};
1677   }
1678   map { $amounts{$_} = $self->parse_amount($myconfig, $amounts{$_}) } keys %amounts;
1679
1680   $amounts{skonto_in_percent}  = 100.0 * $self->{percent_skonto};
1681   $amounts{skonto_amount}      = $amounts{invtotal} * $self->{percent_skonto};
1682   $amounts{invtotal_wo_skonto} = $amounts{invtotal} * (1 - $self->{percent_skonto});
1683   $amounts{total_wo_skonto}    = $amounts{total}    * (1 - $self->{percent_skonto});
1684
1685   foreach (keys %amounts) {
1686     $amounts{$_}           = $self->round_amount($amounts{$_}, 2);
1687     $formatted_amounts{$_} = $self->format_amount($myconfig, $amounts{$_}, 2);
1688   }
1689
1690   if ($self->{"language_id"}) {
1691     my $language             = SL::DB::Language->new(id => $self->{language_id})->load;
1692
1693     $self->{payment_terms}   = $type =~ m{invoice}i ? $terms->translated_attribute('description_long_invoice', $language->id) : undef;
1694     $self->{payment_terms} ||= $terms->translated_attribute('description_long', $language->id);
1695
1696     if ($language->output_dateformat) {
1697       foreach my $key (qw(netto_date skonto_date)) {
1698         $self->{$key} = $::locale->reformat_date($myconfig, $self->{$key}, $language->output_dateformat, $language->output_longdates);
1699       }
1700     }
1701
1702     if ($language->output_numberformat && ($language->output_numberformat ne $myconfig->{numberformat})) {
1703       local $myconfig->{numberformat};
1704       $myconfig->{"numberformat"} = $language->output_numberformat;
1705       $formatted_amounts{$_} = $self->format_amount($myconfig, $amounts{$_}) for keys %amounts;
1706     }
1707   }
1708
1709   $self->{payment_terms} =  $self->{payment_terms} || ($is_invoice ? $terms->description_long_invoice : undef) || $terms->description_long;
1710
1711   $self->{payment_terms} =~ s/<%netto_date%>/$self->{netto_date}/g;
1712   $self->{payment_terms} =~ s/<%skonto_date%>/$self->{skonto_date}/g;
1713   $self->{payment_terms} =~ s/<%currency%>/$self->{currency}/g;
1714   $self->{payment_terms} =~ s/<%terms_netto%>/$self->{terms_netto}/g;
1715   $self->{payment_terms} =~ s/<%account_number%>/$self->{account_number}/g;
1716   $self->{payment_terms} =~ s/<%bank%>/$self->{bank}/g;
1717   $self->{payment_terms} =~ s/<%bank_code%>/$self->{bank_code}/g;
1718   $self->{payment_terms} =~ s/<\%bic\%>/$self->{bic}/g;
1719   $self->{payment_terms} =~ s/<\%iban\%>/$self->{iban}/g;
1720   $self->{payment_terms} =~ s/<\%mandate_date_of_signature\%>/$self->{mandate_date_of_signature}/g;
1721   $self->{payment_terms} =~ s/<\%mandator_id\%>/$self->{mandator_id}/g;
1722
1723   map { $self->{payment_terms} =~ s/<%${_}%>/$formatted_amounts{$_}/g; } keys %formatted_amounts;
1724
1725   $self->{skonto_in_percent} = $formatted_amounts{skonto_in_percent};
1726
1727 }
1728
1729 sub get_template_language {
1730   $main::lxdebug->enter_sub();
1731
1732   my ($self, $myconfig) = @_;
1733
1734   my $template_code = "";
1735
1736   if ($self->{language_id}) {
1737     my $dbh = $self->get_standard_dbh($myconfig);
1738     my $query = qq|SELECT template_code FROM language WHERE id = ?|;
1739     ($template_code) = selectrow_query($self, $dbh, $query, $self->{language_id});
1740   }
1741
1742   $main::lxdebug->leave_sub();
1743
1744   return $template_code;
1745 }
1746
1747 sub get_printer_code {
1748   $main::lxdebug->enter_sub();
1749
1750   my ($self, $myconfig) = @_;
1751
1752   my $template_code = "";
1753
1754   if ($self->{printer_id}) {
1755     my $dbh = $self->get_standard_dbh($myconfig);
1756     my $query = qq|SELECT template_code, printer_command FROM printers WHERE id = ?|;
1757     ($template_code, $self->{printer_command}) = selectrow_query($self, $dbh, $query, $self->{printer_id});
1758   }
1759
1760   $main::lxdebug->leave_sub();
1761
1762   return $template_code;
1763 }
1764
1765 sub get_shipto {
1766   $main::lxdebug->enter_sub();
1767
1768   my ($self, $myconfig) = @_;
1769
1770   my $template_code = "";
1771
1772   if ($self->{shipto_id}) {
1773     my $dbh = $self->get_standard_dbh($myconfig);
1774     my $query = qq|SELECT * FROM shipto WHERE shipto_id = ?|;
1775     my $ref = selectfirst_hashref_query($self, $dbh, $query, $self->{shipto_id});
1776     map({ $self->{$_} = $ref->{$_} } keys(%$ref));
1777
1778     my $cvars = CVar->get_custom_variables(
1779       dbh      => $dbh,
1780       module   => 'ShipTo',
1781       trans_id => $self->{shipto_id},
1782     );
1783     $self->{"shiptocvar_$_->{name}"} = $_->{value} for @{ $cvars };
1784   }
1785
1786   $main::lxdebug->leave_sub();
1787 }
1788
1789 sub add_shipto {
1790   my ($self, $dbh, $id, $module) = @_;
1791
1792   my $shipto;
1793   my @values;
1794
1795   foreach my $item (qw(name department_1 department_2 street zipcode city country gln
1796                        contact cp_gender phone fax email)) {
1797     if ($self->{"shipto$item"}) {
1798       $shipto = 1 if ($self->{$item} ne $self->{"shipto$item"});
1799     }
1800     push(@values, $self->{"shipto${item}"});
1801   }
1802
1803   return if !$shipto;
1804
1805   my $shipto_id = $self->{shipto_id};
1806
1807   if ($self->{shipto_id}) {
1808     my $query = qq|UPDATE shipto set
1809                      shiptoname = ?,
1810                      shiptodepartment_1 = ?,
1811                      shiptodepartment_2 = ?,
1812                      shiptostreet = ?,
1813                      shiptozipcode = ?,
1814                      shiptocity = ?,
1815                      shiptocountry = ?,
1816                      shiptogln = ?,
1817                      shiptocontact = ?,
1818                      shiptocp_gender = ?,
1819                      shiptophone = ?,
1820                      shiptofax = ?,
1821                      shiptoemail = ?
1822                    WHERE shipto_id = ?|;
1823     do_query($self, $dbh, $query, @values, $self->{shipto_id});
1824   } else {
1825     my $query = qq|SELECT * FROM shipto
1826                    WHERE shiptoname = ? AND
1827                      shiptodepartment_1 = ? AND
1828                      shiptodepartment_2 = ? AND
1829                      shiptostreet = ? AND
1830                      shiptozipcode = ? AND
1831                      shiptocity = ? AND
1832                      shiptocountry = ? AND
1833                      shiptogln = ? AND
1834                      shiptocontact = ? AND
1835                      shiptocp_gender = ? AND
1836                      shiptophone = ? AND
1837                      shiptofax = ? AND
1838                      shiptoemail = ? AND
1839                      module = ? AND
1840                      trans_id = ?|;
1841     my $insert_check = selectfirst_hashref_query($self, $dbh, $query, @values, $module, $id);
1842     if(!$insert_check){
1843       my $insert_query =
1844         qq|INSERT INTO shipto (trans_id, shiptoname, shiptodepartment_1, shiptodepartment_2,
1845                                shiptostreet, shiptozipcode, shiptocity, shiptocountry, shiptogln,
1846                                shiptocontact, shiptocp_gender, shiptophone, shiptofax, shiptoemail, module)
1847            VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)|;
1848       do_query($self, $dbh, $insert_query, $id, @values, $module);
1849
1850       $insert_check = selectfirst_hashref_query($self, $dbh, $query, @values, $module, $id);
1851     }
1852
1853     $shipto_id = $insert_check->{shipto_id};
1854   }
1855
1856   return unless $shipto_id;
1857
1858   CVar->save_custom_variables(
1859     dbh         => $dbh,
1860     module      => 'ShipTo',
1861     trans_id    => $shipto_id,
1862     variables   => $self,
1863     name_prefix => 'shipto',
1864   );
1865 }
1866
1867 sub get_employee {
1868   $main::lxdebug->enter_sub();
1869
1870   my ($self, $dbh) = @_;
1871
1872   $dbh ||= $self->get_standard_dbh(\%main::myconfig);
1873
1874   my $query = qq|SELECT id, name FROM employee WHERE login = ?|;
1875   ($self->{"employee_id"}, $self->{"employee"}) = selectrow_query($self, $dbh, $query, $self->{login});
1876   $self->{"employee_id"} *= 1;
1877
1878   $main::lxdebug->leave_sub();
1879 }
1880
1881 sub get_employee_data {
1882   $main::lxdebug->enter_sub();
1883
1884   my $self     = shift;
1885   my %params   = @_;
1886   my $defaults = SL::DB::Default->get;
1887
1888   Common::check_params(\%params, qw(prefix));
1889   Common::check_params_x(\%params, qw(id));
1890
1891   if (!$params{id}) {
1892     $main::lxdebug->leave_sub();
1893     return;
1894   }
1895
1896   my $myconfig = \%main::myconfig;
1897   my $dbh      = $params{dbh} || $self->get_standard_dbh($myconfig);
1898
1899   my ($login, $deleted)  = selectrow_query($self, $dbh, qq|SELECT login,deleted FROM employee WHERE id = ?|, conv_i($params{id}));
1900
1901   if ($login) {
1902     # login already fetched and still the same client (mandant) | same for both cases (delete|!delete)
1903     $self->{$params{prefix} . '_login'}   = $login;
1904     $self->{$params{prefix} . "_${_}"}    = $defaults->$_ for qw(address businessnumber co_ustid company duns taxnumber);
1905
1906     if (!$deleted) {
1907       # get employee data from auth.user_config
1908       my $user = User->new(login => $login);
1909       $self->{$params{prefix} . "_${_}"} = $user->{$_} for qw(email fax name signature tel);
1910     } else {
1911       # get saved employee data from employee
1912       my $employee = SL::DB::Manager::Employee->find_by(id => conv_i($params{id}));
1913       $self->{$params{prefix} . "_${_}"} = $employee->{"deleted_$_"} for qw(email fax signature tel);
1914       $self->{$params{prefix} . "_name"} = $employee->name;
1915     }
1916  }
1917   $main::lxdebug->leave_sub();
1918 }
1919
1920 sub _get_contacts {
1921   $main::lxdebug->enter_sub();
1922
1923   my ($self, $dbh, $id, $key) = @_;
1924
1925   $key = "all_contacts" unless ($key);
1926
1927   if (!$id) {
1928     $self->{$key} = [];
1929     $main::lxdebug->leave_sub();
1930     return;
1931   }
1932
1933   my $query =
1934     qq|SELECT cp_id, cp_cv_id, cp_name, cp_givenname, cp_abteilung | .
1935     qq|FROM contacts | .
1936     qq|WHERE cp_cv_id = ? | .
1937     qq|ORDER BY lower(cp_name)|;
1938
1939   $self->{$key} = selectall_hashref_query($self, $dbh, $query, $id);
1940
1941   $main::lxdebug->leave_sub();
1942 }
1943
1944 sub _get_projects {
1945   $main::lxdebug->enter_sub();
1946
1947   my ($self, $dbh, $key) = @_;
1948
1949   my ($all, $old_id, $where, @values);
1950
1951   if (ref($key) eq "HASH") {
1952     my $params = $key;
1953
1954     $key = "ALL_PROJECTS";
1955
1956     foreach my $p (keys(%{$params})) {
1957       if ($p eq "all") {
1958         $all = $params->{$p};
1959       } elsif ($p eq "old_id") {
1960         $old_id = $params->{$p};
1961       } elsif ($p eq "key") {
1962         $key = $params->{$p};
1963       }
1964     }
1965   }
1966
1967   if (!$all) {
1968     $where = "WHERE active ";
1969     if ($old_id) {
1970       if (ref($old_id) eq "ARRAY") {
1971         my @ids = grep({ $_ } @{$old_id});
1972         if (@ids) {
1973           $where .= " OR id IN (" . join(",", map({ "?" } @ids)) . ") ";
1974           push(@values, @ids);
1975         }
1976       } else {
1977         $where .= " OR (id = ?) ";
1978         push(@values, $old_id);
1979       }
1980     }
1981   }
1982
1983   my $query =
1984     qq|SELECT id, projectnumber, description, active | .
1985     qq|FROM project | .
1986     $where .
1987     qq|ORDER BY lower(projectnumber)|;
1988
1989   $self->{$key} = selectall_hashref_query($self, $dbh, $query, @values);
1990
1991   $main::lxdebug->leave_sub();
1992 }
1993
1994 sub _get_shipto {
1995   $main::lxdebug->enter_sub();
1996
1997   my ($self, $dbh, $vc_id, $key) = @_;
1998
1999   $key = "all_shipto" unless ($key);
2000
2001   if ($vc_id) {
2002     # get shipping addresses
2003     my $query = qq|SELECT * FROM shipto WHERE trans_id = ?|;
2004
2005     $self->{$key} = selectall_hashref_query($self, $dbh, $query, $vc_id);
2006
2007   } else {
2008     $self->{$key} = [];
2009   }
2010
2011   $main::lxdebug->leave_sub();
2012 }
2013
2014 sub _get_printers {
2015   $main::lxdebug->enter_sub();
2016
2017   my ($self, $dbh, $key) = @_;
2018
2019   $key = "all_printers" unless ($key);
2020
2021   my $query = qq|SELECT id, printer_description, printer_command, template_code FROM printers|;
2022
2023   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2024
2025   $main::lxdebug->leave_sub();
2026 }
2027
2028 sub _get_charts {
2029   $main::lxdebug->enter_sub();
2030
2031   my ($self, $dbh, $params) = @_;
2032   my ($key);
2033
2034   $key = $params->{key};
2035   $key = "all_charts" unless ($key);
2036
2037   my $transdate = quote_db_date($params->{transdate});
2038
2039   my $query =
2040     qq|SELECT c.id, c.accno, c.description, c.link, c.charttype, tk.taxkey_id, tk.tax_id | .
2041     qq|FROM chart c | .
2042     qq|LEFT JOIN taxkeys tk ON | .
2043     qq|(tk.id = (SELECT id FROM taxkeys | .
2044     qq|          WHERE taxkeys.chart_id = c.id AND startdate <= $transdate | .
2045     qq|          ORDER BY startdate DESC LIMIT 1)) | .
2046     qq|ORDER BY c.accno|;
2047
2048   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2049
2050   $main::lxdebug->leave_sub();
2051 }
2052
2053 sub _get_taxcharts {
2054   $main::lxdebug->enter_sub();
2055
2056   my ($self, $dbh, $params) = @_;
2057
2058   my $key = "all_taxcharts";
2059   my @where;
2060
2061   if (ref $params eq 'HASH') {
2062     $key = $params->{key} if ($params->{key});
2063     if ($params->{module} eq 'AR') {
2064       push @where, 'chart_categories ~ \'[ACILQ]\'';
2065
2066     } elsif ($params->{module} eq 'AP') {
2067       push @where, 'chart_categories ~ \'[ACELQ]\'';
2068     }
2069
2070   } elsif ($params) {
2071     $key = $params;
2072   }
2073
2074   my $where = @where ? ' WHERE ' . join(' AND ', map { "($_)" } @where) : '';
2075
2076   my $query = qq|SELECT * FROM tax $where ORDER BY taxkey, rate|;
2077
2078   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2079
2080   $main::lxdebug->leave_sub();
2081 }
2082
2083 sub _get_taxzones {
2084   $main::lxdebug->enter_sub();
2085
2086   my ($self, $dbh, $key) = @_;
2087
2088   $key = "all_taxzones" unless ($key);
2089   my $tzfilter = "";
2090   $tzfilter = "WHERE obsolete is FALSE" if $key eq 'ALL_ACTIVE_TAXZONES';
2091
2092   my $query = qq|SELECT * FROM tax_zones $tzfilter ORDER BY sortkey|;
2093
2094   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2095
2096   $main::lxdebug->leave_sub();
2097 }
2098
2099 sub _get_employees {
2100   $main::lxdebug->enter_sub();
2101
2102   my ($self, $dbh, $params) = @_;
2103
2104   my $deleted = 0;
2105
2106   my $key;
2107   if (ref $params eq 'HASH') {
2108     $key     = $params->{key};
2109     $deleted = $params->{deleted};
2110
2111   } else {
2112     $key = $params;
2113   }
2114
2115   $key     ||= "all_employees";
2116   my $filter = $deleted ? '' : 'WHERE NOT COALESCE(deleted, FALSE)';
2117   $self->{$key} = selectall_hashref_query($self, $dbh, qq|SELECT * FROM employee $filter ORDER BY lower(name)|);
2118
2119   $main::lxdebug->leave_sub();
2120 }
2121
2122 sub _get_business_types {
2123   $main::lxdebug->enter_sub();
2124
2125   my ($self, $dbh, $key) = @_;
2126
2127   my $options       = ref $key eq 'HASH' ? $key : { key => $key };
2128   $options->{key} ||= "all_business_types";
2129   my $where         = '';
2130
2131   if (exists $options->{salesman}) {
2132     $where = 'WHERE ' . ($options->{salesman} ? '' : 'NOT ') . 'COALESCE(salesman)';
2133   }
2134
2135   $self->{ $options->{key} } = selectall_hashref_query($self, $dbh, qq|SELECT * FROM business $where ORDER BY lower(description)|);
2136
2137   $main::lxdebug->leave_sub();
2138 }
2139
2140 sub _get_languages {
2141   $main::lxdebug->enter_sub();
2142
2143   my ($self, $dbh, $key) = @_;
2144
2145   $key = "all_languages" unless ($key);
2146
2147   my $query = qq|SELECT * FROM language ORDER BY id|;
2148
2149   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2150
2151   $main::lxdebug->leave_sub();
2152 }
2153
2154 sub _get_dunning_configs {
2155   $main::lxdebug->enter_sub();
2156
2157   my ($self, $dbh, $key) = @_;
2158
2159   $key = "all_dunning_configs" unless ($key);
2160
2161   my $query = qq|SELECT * FROM dunning_config ORDER BY dunning_level|;
2162
2163   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2164
2165   $main::lxdebug->leave_sub();
2166 }
2167
2168 sub _get_currencies {
2169 $main::lxdebug->enter_sub();
2170
2171   my ($self, $dbh, $key) = @_;
2172
2173   $key = "all_currencies" unless ($key);
2174
2175   $self->{$key} = [$self->get_all_currencies()];
2176
2177   $main::lxdebug->leave_sub();
2178 }
2179
2180 sub _get_payments {
2181 $main::lxdebug->enter_sub();
2182
2183   my ($self, $dbh, $key) = @_;
2184
2185   $key = "all_payments" unless ($key);
2186
2187   my $query = qq|SELECT * FROM payment_terms ORDER BY sortkey|;
2188
2189   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2190
2191   $main::lxdebug->leave_sub();
2192 }
2193
2194 sub _get_customers {
2195   $main::lxdebug->enter_sub();
2196
2197   my ($self, $dbh, $key) = @_;
2198
2199   my $options        = ref $key eq 'HASH' ? $key : { key => $key };
2200   $options->{key}  ||= "all_customers";
2201   my $limit_clause   = $options->{limit} ? "LIMIT $options->{limit}" : '';
2202
2203   my @where;
2204   push @where, qq|business_id IN (SELECT id FROM business WHERE salesman)| if  $options->{business_is_salesman};
2205   push @where, qq|NOT obsolete|                                            if !$options->{with_obsolete};
2206   my $where_str = @where ? "WHERE " . join(" AND ", map { "($_)" } @where) : '';
2207
2208   my $query = qq|SELECT * FROM customer $where_str ORDER BY name $limit_clause|;
2209   $self->{ $options->{key} } = selectall_hashref_query($self, $dbh, $query);
2210
2211   $main::lxdebug->leave_sub();
2212 }
2213
2214 sub _get_vendors {
2215   $main::lxdebug->enter_sub();
2216
2217   my ($self, $dbh, $key) = @_;
2218
2219   $key = "all_vendors" unless ($key);
2220
2221   my $query = qq|SELECT * FROM vendor WHERE NOT obsolete ORDER BY name|;
2222
2223   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2224
2225   $main::lxdebug->leave_sub();
2226 }
2227
2228 sub _get_departments {
2229   $main::lxdebug->enter_sub();
2230
2231   my ($self, $dbh, $key) = @_;
2232
2233   $key = "all_departments" unless ($key);
2234
2235   my $query = qq|SELECT * FROM department ORDER BY description|;
2236
2237   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2238
2239   $main::lxdebug->leave_sub();
2240 }
2241
2242 sub _get_warehouses {
2243   $main::lxdebug->enter_sub();
2244
2245   my ($self, $dbh, $param) = @_;
2246
2247   my ($key, $bins_key);
2248
2249   if ('' eq ref $param) {
2250     $key = $param;
2251
2252   } else {
2253     $key      = $param->{key};
2254     $bins_key = $param->{bins};
2255   }
2256
2257   my $query = qq|SELECT w.* FROM warehouse w
2258                  WHERE (NOT w.invalid) AND
2259                    ((SELECT COUNT(b.*) FROM bin b WHERE b.warehouse_id = w.id) > 0)
2260                  ORDER BY w.sortkey|;
2261
2262   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2263
2264   if ($bins_key) {
2265     $query = qq|SELECT id, description FROM bin WHERE warehouse_id = ?
2266                 ORDER BY description|;
2267     my $sth = prepare_query($self, $dbh, $query);
2268
2269     foreach my $warehouse (@{ $self->{$key} }) {
2270       do_statement($self, $sth, $query, $warehouse->{id});
2271       $warehouse->{$bins_key} = [];
2272
2273       while (my $ref = $sth->fetchrow_hashref()) {
2274         push @{ $warehouse->{$bins_key} }, $ref;
2275       }
2276     }
2277     $sth->finish();
2278   }
2279
2280   $main::lxdebug->leave_sub();
2281 }
2282
2283 sub _get_simple {
2284   $main::lxdebug->enter_sub();
2285
2286   my ($self, $dbh, $table, $key, $sortkey) = @_;
2287
2288   my $query  = qq|SELECT * FROM $table|;
2289   $query    .= qq| ORDER BY $sortkey| if ($sortkey);
2290
2291   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2292
2293   $main::lxdebug->leave_sub();
2294 }
2295
2296 #sub _get_groups {
2297 #  $main::lxdebug->enter_sub();
2298 #
2299 #  my ($self, $dbh, $key) = @_;
2300 #
2301 #  $key ||= "all_groups";
2302 #
2303 #  my $groups = $main::auth->read_groups();
2304 #
2305 #  $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2306 #
2307 #  $main::lxdebug->leave_sub();
2308 #}
2309
2310 sub get_lists {
2311   $main::lxdebug->enter_sub();
2312
2313   my $self = shift;
2314   my %params = @_;
2315
2316   my $dbh = $self->get_standard_dbh(\%main::myconfig);
2317   my ($sth, $query, $ref);
2318
2319   my ($vc, $vc_id);
2320   if ($params{contacts} || $params{shipto}) {
2321     $vc = 'customer' if $self->{"vc"} eq "customer";
2322     $vc = 'vendor'   if $self->{"vc"} eq "vendor";
2323     die "invalid use of get_lists, need 'vc'" unless $vc;
2324     $vc_id = $self->{"${vc}_id"};
2325   }
2326
2327   if ($params{"contacts"}) {
2328     $self->_get_contacts($dbh, $vc_id, $params{"contacts"});
2329   }
2330
2331   if ($params{"shipto"}) {
2332     $self->_get_shipto($dbh, $vc_id, $params{"shipto"});
2333   }
2334
2335   if ($params{"projects"} || $params{"all_projects"}) {
2336     $self->_get_projects($dbh, $params{"all_projects"} ?
2337                          $params{"all_projects"} : $params{"projects"},
2338                          $params{"all_projects"} ? 1 : 0);
2339   }
2340
2341   if ($params{"printers"}) {
2342     $self->_get_printers($dbh, $params{"printers"});
2343   }
2344
2345   if ($params{"languages"}) {
2346     $self->_get_languages($dbh, $params{"languages"});
2347   }
2348
2349   if ($params{"charts"}) {
2350     $self->_get_charts($dbh, $params{"charts"});
2351   }
2352
2353   if ($params{"taxcharts"}) {
2354     $self->_get_taxcharts($dbh, $params{"taxcharts"});
2355   }
2356
2357   if ($params{"taxzones"}) {
2358     $self->_get_taxzones($dbh, $params{"taxzones"});
2359   }
2360
2361   if ($params{"employees"}) {
2362     $self->_get_employees($dbh, $params{"employees"});
2363   }
2364
2365   if ($params{"salesmen"}) {
2366     $self->_get_employees($dbh, $params{"salesmen"});
2367   }
2368
2369   if ($params{"business_types"}) {
2370     $self->_get_business_types($dbh, $params{"business_types"});
2371   }
2372
2373   if ($params{"dunning_configs"}) {
2374     $self->_get_dunning_configs($dbh, $params{"dunning_configs"});
2375   }
2376
2377   if($params{"currencies"}) {
2378     $self->_get_currencies($dbh, $params{"currencies"});
2379   }
2380
2381   if($params{"customers"}) {
2382     $self->_get_customers($dbh, $params{"customers"});
2383   }
2384
2385   if($params{"vendors"}) {
2386     if (ref $params{"vendors"} eq 'HASH') {
2387       $self->_get_vendors($dbh, $params{"vendors"}{key}, $params{"vendors"}{limit});
2388     } else {
2389       $self->_get_vendors($dbh, $params{"vendors"});
2390     }
2391   }
2392
2393   if($params{"payments"}) {
2394     $self->_get_payments($dbh, $params{"payments"});
2395   }
2396
2397   if($params{"departments"}) {
2398     $self->_get_departments($dbh, $params{"departments"});
2399   }
2400
2401   if ($params{price_factors}) {
2402     $self->_get_simple($dbh, 'price_factors', $params{price_factors}, 'sortkey');
2403   }
2404
2405   if ($params{warehouses}) {
2406     $self->_get_warehouses($dbh, $params{warehouses});
2407   }
2408
2409 #  if ($params{groups}) {
2410 #    $self->_get_groups($dbh, $params{groups});
2411 #  }
2412
2413   if ($params{partsgroup}) {
2414     $self->get_partsgroup(\%main::myconfig, { all => 1, target => $params{partsgroup} });
2415   }
2416
2417   $main::lxdebug->leave_sub();
2418 }
2419
2420 # this sub gets the id and name from $table
2421 sub get_name {
2422   $main::lxdebug->enter_sub();
2423
2424   my ($self, $myconfig, $table) = @_;
2425
2426   # connect to database
2427   my $dbh = $self->get_standard_dbh($myconfig);
2428
2429   $table = $table eq "customer" ? "customer" : "vendor";
2430   my $arap = $self->{arap} eq "ar" ? "ar" : "ap";
2431
2432   my ($query, @values);
2433
2434   if (!$self->{openinvoices}) {
2435     my $where;
2436     if ($self->{customernumber} ne "") {
2437       $where = qq|(vc.customernumber ILIKE ?)|;
2438       push(@values, like($self->{customernumber}));
2439     } else {
2440       $where = qq|(vc.name ILIKE ?)|;
2441       push(@values, like($self->{$table}));
2442     }
2443
2444     $query =
2445       qq~SELECT vc.id, vc.name,
2446            vc.street || ' ' || vc.zipcode || ' ' || vc.city || ' ' || vc.country AS address
2447          FROM $table vc
2448          WHERE $where AND (NOT vc.obsolete)
2449          ORDER BY vc.name~;
2450   } else {
2451     $query =
2452       qq~SELECT DISTINCT vc.id, vc.name,
2453            vc.street || ' ' || vc.zipcode || ' ' || vc.city || ' ' || vc.country AS address
2454          FROM $arap a
2455          JOIN $table vc ON (a.${table}_id = vc.id)
2456          WHERE NOT (a.amount = a.paid) AND (vc.name ILIKE ?)
2457          ORDER BY vc.name~;
2458     push(@values, like($self->{$table}));
2459   }
2460
2461   $self->{name_list} = selectall_hashref_query($self, $dbh, $query, @values);
2462
2463   $main::lxdebug->leave_sub();
2464
2465   return scalar(@{ $self->{name_list} });
2466 }
2467
2468 # the selection sub is used in the AR, AP, IS, IR, DO and OE module
2469 #
2470 sub all_vc {
2471   $main::lxdebug->enter_sub();
2472
2473   my ($self, $myconfig, $table, $module) = @_;
2474
2475   my $ref;
2476   my $dbh = $self->get_standard_dbh;
2477
2478   $table = $table eq "customer" ? "customer" : "vendor";
2479
2480   # build selection list
2481   # Hotfix für Bug 1837 - Besser wäre es alte Buchungsbelege
2482   # OHNE Auswahlliste (reines Textfeld) zu laden. Hilft aber auch
2483   # nicht für veränderbare Belege (oe, do, ...)
2484   my $obsolete = $self->{id} ? '' : "WHERE NOT obsolete";
2485   my $query = qq|SELECT count(*) FROM $table $obsolete|;
2486   my ($count) = selectrow_query($self, $dbh, $query);
2487
2488   if ($count <= $myconfig->{vclimit}) {
2489     $query = qq|SELECT id, name, salesman_id
2490                 FROM $table $obsolete
2491                 ORDER BY name|;
2492     $self->{"all_$table"} = selectall_hashref_query($self, $dbh, $query);
2493   }
2494
2495   # get self
2496   $self->get_employee($dbh);
2497
2498   # setup sales contacts
2499   $query = qq|SELECT e.id, e.name
2500               FROM employee e
2501               WHERE (e.sales = '1') AND (NOT e.id = ?)
2502               ORDER BY name|;
2503   $self->{all_employees} = selectall_hashref_query($self, $dbh, $query, $self->{employee_id});
2504
2505   # this is for self
2506   push(@{ $self->{all_employees} },
2507        { id   => $self->{employee_id},
2508          name => $self->{employee} });
2509
2510     # prepare query for departments
2511     $query = qq|SELECT id, description
2512                 FROM department
2513                 ORDER BY description|;
2514
2515   $self->{all_departments} = selectall_hashref_query($self, $dbh, $query);
2516
2517   # get languages
2518   $query = qq|SELECT id, description
2519               FROM language
2520               ORDER BY id|;
2521
2522   $self->{languages} = selectall_hashref_query($self, $dbh, $query);
2523
2524   # get printer
2525   $query = qq|SELECT printer_description, id
2526               FROM printers
2527               ORDER BY printer_description|;
2528
2529   $self->{printers} = selectall_hashref_query($self, $dbh, $query);
2530
2531   # get payment terms
2532   $query = qq|SELECT id, description
2533               FROM payment_terms
2534               ORDER BY sortkey|;
2535
2536   $self->{payment_terms} = selectall_hashref_query($self, $dbh, $query);
2537
2538   $main::lxdebug->leave_sub();
2539 }
2540
2541 sub new_lastmtime {
2542   $main::lxdebug->enter_sub();
2543
2544   my ($self, $table, $provided_dbh) = @_;
2545
2546   my $dbh = $provided_dbh ? $provided_dbh : $self->get_standard_dbh;
2547   return                                       unless $self->{id};
2548   croak ("wrong call, no valid table defined") unless $table =~ /^(oe|ar|ap|delivery_orders|parts)$/;
2549
2550   my $query       = "SELECT mtime, itime FROM " . $table . " WHERE id = ?";
2551   my $ref         = selectfirst_hashref_query($self, $dbh, $query, $self->{id});
2552   $ref->{mtime} ||= $ref->{itime};
2553   $self->{lastmtime} = $ref->{mtime};
2554   $main::lxdebug->message(LXDebug->DEBUG2(),"new lastmtime=".$self->{lastmtime});
2555
2556   $main::lxdebug->leave_sub();
2557 }
2558
2559 sub mtime_ischanged {
2560   my ($self, $table, $option) = @_;
2561
2562   return                                       unless $self->{id};
2563   croak ("wrong call, no valid table defined") unless $table =~ /^(oe|ar|ap|delivery_orders|parts)$/;
2564
2565   my $query       = "SELECT mtime, itime FROM " . $table . " WHERE id = ?";
2566   my $ref         = selectfirst_hashref_query($self, $self->get_standard_dbh, $query, $self->{id});
2567   $ref->{mtime} ||= $ref->{itime};
2568
2569   if ($self->{lastmtime} && $self->{lastmtime} ne $ref->{mtime} ) {
2570       $self->error(($option eq 'mail') ?
2571         t8("The document has been changed by another user. No mail was sent. Please reopen it in another window and copy the changes to the new window") :
2572         t8("The document has been changed by another user. Please reopen it in another window and copy the changes to the new window")
2573       );
2574     $::dispatcher->end_request;
2575   }
2576 }
2577
2578 sub language_payment {
2579   $main::lxdebug->enter_sub();
2580
2581   my ($self, $myconfig) = @_;
2582
2583   my $dbh = $self->get_standard_dbh($myconfig);
2584   # get languages
2585   my $query = qq|SELECT id, description
2586                  FROM language
2587                  ORDER BY id|;
2588
2589   $self->{languages} = selectall_hashref_query($self, $dbh, $query);
2590
2591   # get printer
2592   $query = qq|SELECT printer_description, id
2593               FROM printers
2594               ORDER BY printer_description|;
2595
2596   $self->{printers} = selectall_hashref_query($self, $dbh, $query);
2597
2598   # get payment terms
2599   $query = qq|SELECT id, description
2600               FROM payment_terms
2601               ORDER BY sortkey|;
2602
2603   $self->{payment_terms} = selectall_hashref_query($self, $dbh, $query);
2604
2605   # get buchungsgruppen
2606   $query = qq|SELECT id, description
2607               FROM buchungsgruppen|;
2608
2609   $self->{BUCHUNGSGRUPPEN} = selectall_hashref_query($self, $dbh, $query);
2610
2611   $main::lxdebug->leave_sub();
2612 }
2613
2614 # this is only used for reports
2615 sub all_departments {
2616   $main::lxdebug->enter_sub();
2617
2618   my ($self, $myconfig, $table) = @_;
2619
2620   my $dbh = $self->get_standard_dbh($myconfig);
2621
2622   my $query = qq|SELECT id, description
2623                  FROM department
2624                  ORDER BY description|;
2625   $self->{all_departments} = selectall_hashref_query($self, $dbh, $query);
2626
2627   delete($self->{all_departments}) unless (@{ $self->{all_departments} || [] });
2628
2629   $main::lxdebug->leave_sub();
2630 }
2631
2632 sub create_links {
2633   $main::lxdebug->enter_sub();
2634
2635   my ($self, $module, $myconfig, $table, $provided_dbh) = @_;
2636
2637   my ($fld, $arap);
2638   if ($table eq "customer") {
2639     $fld = "buy";
2640     $arap = "ar";
2641   } else {
2642     $table = "vendor";
2643     $fld = "sell";
2644     $arap = "ap";
2645   }
2646
2647   $self->all_vc($myconfig, $table, $module);
2648
2649   # get last customers or vendors
2650   my ($query, $sth, $ref);
2651
2652   my $dbh = $provided_dbh ? $provided_dbh : $self->get_standard_dbh($myconfig);
2653   my %xkeyref = ();
2654
2655   if (!$self->{id}) {
2656
2657     my $transdate = "current_date";
2658     if ($self->{transdate}) {
2659       $transdate = $dbh->quote($self->{transdate});
2660     }
2661
2662     # now get the account numbers
2663 #    $query = qq|SELECT c.accno, c.description, c.link, c.taxkey_id, tk.tax_id
2664 #                FROM chart c, taxkeys tk
2665 #                WHERE (c.link LIKE ?) AND (c.id = tk.chart_id) AND tk.id =
2666 #                  (SELECT id FROM taxkeys WHERE (taxkeys.chart_id = c.id) AND (startdate <= $transdate) ORDER BY startdate DESC LIMIT 1)
2667 #                ORDER BY c.accno|;
2668
2669 #  same query as above, but without expensive subquery for each row. about 80% faster
2670     $query = qq|
2671       SELECT c.accno, c.description, c.link, c.taxkey_id, tk2.tax_id
2672         FROM chart c
2673         -- find newest entries in taxkeys
2674         INNER JOIN (
2675           SELECT chart_id, MAX(startdate) AS startdate
2676           FROM taxkeys
2677           WHERE (startdate <= $transdate)
2678           GROUP BY chart_id
2679         ) tk ON (c.id = tk.chart_id)
2680         -- and load all of those entries
2681         INNER JOIN taxkeys tk2
2682            ON (tk.chart_id = tk2.chart_id AND tk.startdate = tk2.startdate)
2683        WHERE (c.link LIKE ?)
2684       ORDER BY c.accno|;
2685
2686     $sth = $dbh->prepare($query);
2687
2688     do_statement($self, $sth, $query, like($module));
2689
2690     $self->{accounts} = "";
2691     while ($ref = $sth->fetchrow_hashref("NAME_lc")) {
2692
2693       foreach my $key (split(/:/, $ref->{link})) {
2694         if ($key =~ /\Q$module\E/) {
2695
2696           # cross reference for keys
2697           $xkeyref{ $ref->{accno} } = $key;
2698
2699           push @{ $self->{"${module}_links"}{$key} },
2700             { accno       => $ref->{accno},
2701               description => $ref->{description},
2702               taxkey      => $ref->{taxkey_id},
2703               tax_id      => $ref->{tax_id} };
2704
2705           $self->{accounts} .= "$ref->{accno} " unless $key =~ /tax/;
2706         }
2707       }
2708     }
2709   }
2710
2711   # get taxkeys and description
2712   $query = qq|SELECT id, taxkey, taxdescription FROM tax|;
2713   $self->{TAXKEY} = selectall_hashref_query($self, $dbh, $query);
2714
2715   if (($module eq "AP") || ($module eq "AR")) {
2716     # get tax rates and description
2717     $query = qq|SELECT * FROM tax|;
2718     $self->{TAX} = selectall_hashref_query($self, $dbh, $query);
2719   }
2720
2721   my $extra_columns = '';
2722   $extra_columns   .= 'a.direct_debit, ' if ($module eq 'AR') || ($module eq 'AP');
2723
2724   if ($self->{id}) {
2725     $query =
2726       qq|SELECT
2727            a.cp_id, a.invnumber, a.transdate, a.${table}_id, a.datepaid,
2728            a.duedate, a.ordnumber, a.taxincluded, (SELECT cu.name FROM currencies cu WHERE cu.id=a.currency_id) AS currency, a.notes,
2729            a.mtime, a.itime,
2730            a.intnotes, a.department_id, a.amount AS oldinvtotal,
2731            a.paid AS oldtotalpaid, a.employee_id, a.gldate, a.type,
2732            a.globalproject_id, ${extra_columns}
2733            c.name AS $table,
2734            d.description AS department,
2735            e.name AS employee
2736          FROM $arap a
2737          JOIN $table c ON (a.${table}_id = c.id)
2738          LEFT JOIN employee e ON (e.id = a.employee_id)
2739          LEFT JOIN department d ON (d.id = a.department_id)
2740          WHERE a.id = ?|;
2741     $ref = selectfirst_hashref_query($self, $dbh, $query, $self->{id});
2742
2743     foreach my $key (keys %$ref) {
2744       $self->{$key} = $ref->{$key};
2745     }
2746     $self->{mtime}   ||= $self->{itime};
2747     $self->{lastmtime} = $self->{mtime};
2748     my $transdate = "current_date";
2749     if ($self->{transdate}) {
2750       $transdate = $dbh->quote($self->{transdate});
2751     }
2752
2753     # now get the account numbers
2754     $query = qq|SELECT c.accno, c.description, c.link, c.taxkey_id, tk.tax_id
2755                 FROM chart c
2756                 LEFT JOIN taxkeys tk ON (tk.chart_id = c.id)
2757                 WHERE c.link LIKE ?
2758                   AND (tk.id = (SELECT id FROM taxkeys WHERE taxkeys.chart_id = c.id AND startdate <= $transdate ORDER BY startdate DESC LIMIT 1)
2759                     OR c.link LIKE '%_tax%' OR c.taxkey_id IS NULL)
2760                 ORDER BY c.accno|;
2761
2762     $sth = $dbh->prepare($query);
2763     do_statement($self, $sth, $query, like($module));
2764
2765     $self->{accounts} = "";
2766     while ($ref = $sth->fetchrow_hashref("NAME_lc")) {
2767
2768       foreach my $key (split(/:/, $ref->{link})) {
2769         if ($key =~ /\Q$module\E/) {
2770
2771           # cross reference for keys
2772           $xkeyref{ $ref->{accno} } = $key;
2773
2774           push @{ $self->{"${module}_links"}{$key} },
2775             { accno       => $ref->{accno},
2776               description => $ref->{description},
2777               taxkey      => $ref->{taxkey_id},
2778               tax_id      => $ref->{tax_id} };
2779
2780           $self->{accounts} .= "$ref->{accno} " unless $key =~ /tax/;
2781         }
2782       }
2783     }
2784
2785
2786     # get amounts from individual entries
2787     $query =
2788       qq|SELECT
2789            c.accno, c.description,
2790            a.acc_trans_id, a.source, a.amount, a.memo, a.transdate, a.gldate, a.cleared, a.project_id, a.taxkey,
2791            p.projectnumber,
2792            t.rate, t.id
2793          FROM acc_trans a
2794          LEFT JOIN chart c ON (c.id = a.chart_id)
2795          LEFT JOIN project p ON (p.id = a.project_id)
2796          LEFT JOIN tax t ON (t.id= a.tax_id)
2797          WHERE a.trans_id = ?
2798          AND a.fx_transaction = '0'
2799          ORDER BY a.acc_trans_id, a.transdate|;
2800     $sth = $dbh->prepare($query);
2801     do_statement($self, $sth, $query, $self->{id});
2802
2803     # get exchangerate for currency
2804     $self->{exchangerate} =
2805       $self->get_exchangerate($dbh, $self->{currency}, $self->{transdate}, $fld);
2806     my $index = 0;
2807
2808     # store amounts in {acc_trans}{$key} for multiple accounts
2809     while (my $ref = $sth->fetchrow_hashref("NAME_lc")) {
2810       $ref->{exchangerate} =
2811         $self->get_exchangerate($dbh, $self->{currency}, $ref->{transdate}, $fld);
2812       if (!($xkeyref{ $ref->{accno} } =~ /tax/)) {
2813         $index++;
2814       }
2815       if (($xkeyref{ $ref->{accno} } =~ /paid/) && ($self->{type} eq "credit_note")) {
2816         $ref->{amount} *= -1;
2817       }
2818       $ref->{index} = $index;
2819
2820       push @{ $self->{acc_trans}{ $xkeyref{ $ref->{accno} } } }, $ref;
2821     }
2822
2823     $sth->finish;
2824     #check das:
2825     $query =
2826       qq|SELECT
2827            d.closedto, d.revtrans,
2828            (SELECT cu.name FROM currencies cu WHERE cu.id=d.currency_id) AS defaultcurrency,
2829            (SELECT c.accno FROM chart c WHERE d.fxgain_accno_id = c.id) AS fxgain_accno,
2830            (SELECT c.accno FROM chart c WHERE d.fxloss_accno_id = c.id) AS fxloss_accno,
2831            (SELECT c.accno FROM chart c WHERE d.rndgain_accno_id = c.id) AS rndgain_accno,
2832            (SELECT c.accno FROM chart c WHERE d.rndloss_accno_id = c.id) AS rndloss_accno
2833          FROM defaults d|;
2834     $ref = selectfirst_hashref_query($self, $dbh, $query);
2835     map { $self->{$_} = $ref->{$_} } keys %$ref;
2836
2837   } else {
2838
2839     # get date
2840     $query =
2841        qq|SELECT
2842             current_date AS transdate, d.closedto, d.revtrans,
2843             (SELECT cu.name FROM currencies cu WHERE cu.id=d.currency_id) AS defaultcurrency,
2844             (SELECT c.accno FROM chart c WHERE d.fxgain_accno_id = c.id) AS fxgain_accno,
2845             (SELECT c.accno FROM chart c WHERE d.fxloss_accno_id = c.id) AS fxloss_accno,
2846             (SELECT c.accno FROM chart c WHERE d.rndgain_accno_id = c.id) AS rndgain_accno,
2847             (SELECT c.accno FROM chart c WHERE d.rndloss_accno_id = c.id) AS rndloss_accno
2848           FROM defaults d|;
2849     $ref = selectfirst_hashref_query($self, $dbh, $query);
2850     map { $self->{$_} = $ref->{$_} } keys %$ref;
2851
2852     if ($self->{"$self->{vc}_id"}) {
2853
2854       # only setup currency
2855       ($self->{currency}) = $self->{defaultcurrency} if !$self->{currency};
2856
2857     } else {
2858
2859       $self->lastname_used($dbh, $myconfig, $table, $module);
2860
2861       # get exchangerate for currency
2862       $self->{exchangerate} =
2863         $self->get_exchangerate($dbh, $self->{currency}, $self->{transdate}, $fld);
2864
2865     }
2866
2867   }
2868
2869   $main::lxdebug->leave_sub();
2870 }
2871
2872 sub lastname_used {
2873   $main::lxdebug->enter_sub();
2874
2875   my ($self, $dbh, $myconfig, $table, $module) = @_;
2876
2877   my ($arap, $where);
2878
2879   $table         = $table eq "customer" ? "customer" : "vendor";
2880   my %column_map = ("a.${table}_id"           => "${table}_id",
2881                     "a.department_id"         => "department_id",
2882                     "d.description"           => "department",
2883                     "ct.name"                 => $table,
2884                     "cu.name"                 => "currency",
2885     );
2886
2887   if ($self->{type} =~ /delivery_order/) {
2888     $arap  = 'delivery_orders';
2889     delete $column_map{"cu.currency"};
2890
2891   } elsif ($self->{type} =~ /_order/) {
2892     $arap  = 'oe';
2893     $where = "quotation = '0'";
2894
2895   } elsif ($self->{type} =~ /_quotation/) {
2896     $arap  = 'oe';
2897     $where = "quotation = '1'";
2898
2899   } elsif ($table eq 'customer') {
2900     $arap  = 'ar';
2901
2902   } else {
2903     $arap  = 'ap';
2904
2905   }
2906
2907   $where           = "($where) AND" if ($where);
2908   my $query        = qq|SELECT MAX(id) FROM $arap
2909                         WHERE $where ${table}_id > 0|;
2910   my ($trans_id)   = selectrow_query($self, $dbh, $query);
2911   $trans_id       *= 1;
2912
2913   my $column_spec  = join(', ', map { "${_} AS $column_map{$_}" } keys %column_map);
2914   $query           = qq|SELECT $column_spec
2915                         FROM $arap a
2916                         LEFT JOIN $table     ct ON (a.${table}_id = ct.id)
2917                         LEFT JOIN department d  ON (a.department_id = d.id)
2918                         LEFT JOIN currencies cu ON (cu.id=ct.currency_id)
2919                         WHERE a.id = ?|;
2920   my $ref          = selectfirst_hashref_query($self, $dbh, $query, $trans_id);
2921
2922   map { $self->{$_} = $ref->{$_} } values %column_map;
2923
2924   $main::lxdebug->leave_sub();
2925 }
2926
2927 sub current_date {
2928   $main::lxdebug->enter_sub();
2929
2930   my $self     = shift;
2931   my $myconfig = shift || \%::myconfig;
2932   my ($thisdate, $days) = @_;
2933
2934   my $dbh = $self->get_standard_dbh($myconfig);
2935   my $query;
2936
2937   $days *= 1;
2938   if ($thisdate) {
2939     my $dateformat = $myconfig->{dateformat};
2940     $dateformat .= "yy" if $myconfig->{dateformat} !~ /^y/;
2941     $thisdate = $dbh->quote($thisdate);
2942     $query = qq|SELECT to_date($thisdate, '$dateformat') + $days AS thisdate|;
2943   } else {
2944     $query = qq|SELECT current_date AS thisdate|;
2945   }
2946
2947   ($thisdate) = selectrow_query($self, $dbh, $query);
2948
2949   $main::lxdebug->leave_sub();
2950
2951   return $thisdate;
2952 }
2953
2954 sub redo_rows {
2955   $main::lxdebug->enter_sub();
2956
2957   my ($self, $flds, $new, $count, $numrows) = @_;
2958
2959   my @ndx = ();
2960
2961   map { push @ndx, { num => $new->[$_ - 1]->{runningnumber}, ndx => $_ } } 1 .. $count;
2962
2963   my $i = 0;
2964
2965   # fill rows
2966   foreach my $item (sort { $a->{num} <=> $b->{num} } @ndx) {
2967     $i++;
2968     my $j = $item->{ndx} - 1;
2969     map { $self->{"${_}_$i"} = $new->[$j]->{$_} } @{$flds};
2970   }
2971
2972   # delete empty rows
2973   for $i ($count + 1 .. $numrows) {
2974     map { delete $self->{"${_}_$i"} } @{$flds};
2975   }
2976
2977   $main::lxdebug->leave_sub();
2978 }
2979
2980 sub update_status {
2981   $main::lxdebug->enter_sub();
2982
2983   my ($self, $myconfig) = @_;
2984
2985   my ($i, $id);
2986
2987   SL::DB->client->with_transaction(sub {
2988     my $dbh = SL::DB->client->dbh;
2989
2990     my $query = qq|DELETE FROM status
2991                    WHERE (formname = ?) AND (trans_id = ?)|;
2992     my $sth = prepare_query($self, $dbh, $query);
2993
2994     if ($self->{formname} =~ /(check|receipt)/) {
2995       for $i (1 .. $self->{rowcount}) {
2996         do_statement($self, $sth, $query, $self->{formname}, $self->{"id_$i"} * 1);
2997       }
2998     } else {
2999       do_statement($self, $sth, $query, $self->{formname}, $self->{id});
3000     }
3001     $sth->finish();
3002
3003     my $printed = ($self->{printed} =~ /\Q$self->{formname}\E/) ? "1" : "0";
3004     my $emailed = ($self->{emailed} =~ /\Q$self->{formname}\E/) ? "1" : "0";
3005
3006     my %queued = split / /, $self->{queued};
3007     my @values;
3008
3009     if ($self->{formname} =~ /(check|receipt)/) {
3010
3011       # this is a check or receipt, add one entry for each lineitem
3012       my ($accno) = split /--/, $self->{account};
3013       $query = qq|INSERT INTO status (trans_id, printed, spoolfile, formname, chart_id)
3014                   VALUES (?, ?, ?, ?, (SELECT c.id FROM chart c WHERE c.accno = ?))|;
3015       @values = ($printed, $queued{$self->{formname}}, $self->{prinform}, $accno);
3016       $sth = prepare_query($self, $dbh, $query);
3017
3018       for $i (1 .. $self->{rowcount}) {
3019         if ($self->{"checked_$i"}) {
3020           do_statement($self, $sth, $query, $self->{"id_$i"}, @values);
3021         }
3022       }
3023       $sth->finish();
3024
3025     } else {
3026       $query = qq|INSERT INTO status (trans_id, printed, emailed, spoolfile, formname)
3027                   VALUES (?, ?, ?, ?, ?)|;
3028       do_query($self, $dbh, $query, $self->{id}, $printed, $emailed,
3029                $queued{$self->{formname}}, $self->{formname});
3030     }
3031     1;
3032   }) or do { die SL::DB->client->error };
3033
3034   $main::lxdebug->leave_sub();
3035 }
3036
3037 sub save_status {
3038   $main::lxdebug->enter_sub();
3039
3040   my ($self, $dbh) = @_;
3041
3042   my ($query, $printed, $emailed);
3043
3044   my $formnames  = $self->{printed};
3045   my $emailforms = $self->{emailed};
3046
3047   $query = qq|DELETE FROM status
3048                  WHERE (formname = ?) AND (trans_id = ?)|;
3049   do_query($self, $dbh, $query, $self->{formname}, $self->{id});
3050
3051   # this only applies to the forms
3052   # checks and receipts are posted when printed or queued
3053
3054   if ($self->{queued}) {
3055     my %queued = split / /, $self->{queued};
3056
3057     foreach my $formname (keys %queued) {
3058       $printed = ($self->{printed} =~ /\Q$self->{formname}\E/) ? "1" : "0";
3059       $emailed = ($self->{emailed} =~ /\Q$self->{formname}\E/) ? "1" : "0";
3060
3061       $query = qq|INSERT INTO status (trans_id, printed, emailed, spoolfile, formname)
3062                   VALUES (?, ?, ?, ?, ?)|;
3063       do_query($self, $dbh, $query, $self->{id}, $printed, $emailed, $queued{$formname}, $formname);
3064
3065       $formnames  =~ s/\Q$self->{formname}\E//;
3066       $emailforms =~ s/\Q$self->{formname}\E//;
3067
3068     }
3069   }
3070
3071   # save printed, emailed info
3072   $formnames  =~ s/^ +//g;
3073   $emailforms =~ s/^ +//g;
3074
3075   my %status = ();
3076   map { $status{$_}{printed} = 1 } split / +/, $formnames;
3077   map { $status{$_}{emailed} = 1 } split / +/, $emailforms;
3078
3079   foreach my $formname (keys %status) {
3080     $printed = ($formnames  =~ /\Q$self->{formname}\E/) ? "1" : "0";
3081     $emailed = ($emailforms =~ /\Q$self->{formname}\E/) ? "1" : "0";
3082
3083     $query = qq|INSERT INTO status (trans_id, printed, emailed, formname)
3084                 VALUES (?, ?, ?, ?)|;
3085     do_query($self, $dbh, $query, $self->{id}, $printed, $emailed, $formname);
3086   }
3087
3088   $main::lxdebug->leave_sub();
3089 }
3090
3091 #--- 4 locale ---#
3092 # $main::locale->text('SAVED')
3093 # $main::locale->text('DELETED')
3094 # $main::locale->text('ADDED')
3095 # $main::locale->text('PAYMENT POSTED')
3096 # $main::locale->text('POSTED')
3097 # $main::locale->text('POSTED AS NEW')
3098 # $main::locale->text('ELSE')
3099 # $main::locale->text('SAVED FOR DUNNING')
3100 # $main::locale->text('DUNNING STARTED')
3101 # $main::locale->text('PRINTED')
3102 # $main::locale->text('MAILED')
3103 # $main::locale->text('SCREENED')
3104 # $main::locale->text('CANCELED')
3105 # $main::locale->text('invoice')
3106 # $main::locale->text('proforma')
3107 # $main::locale->text('sales_order')
3108 # $main::locale->text('pick_list')
3109 # $main::locale->text('purchase_order')
3110 # $main::locale->text('bin_list')
3111 # $main::locale->text('sales_quotation')
3112 # $main::locale->text('request_quotation')
3113
3114 sub save_history {
3115   $main::lxdebug->enter_sub();
3116
3117   my $self = shift;
3118   my $dbh  = shift || SL::DB->client->dbh;
3119   SL::DB->client->with_transaction(sub {
3120
3121     if(!exists $self->{employee_id}) {
3122       &get_employee($self, $dbh);
3123     }
3124
3125     my $query =
3126      qq|INSERT INTO history_erp (trans_id, employee_id, addition, what_done, snumbers) | .
3127      qq|VALUES (?, (SELECT id FROM employee WHERE login = ?), ?, ?, ?)|;
3128     my @values = (conv_i($self->{id}), $self->{login},
3129                   $self->{addition}, $self->{what_done}, "$self->{snumbers}");
3130     do_query($self, $dbh, $query, @values);
3131     1;
3132   }) or do { die SL::DB->client->error };
3133
3134   $main::lxdebug->leave_sub();
3135 }
3136
3137 sub get_history {
3138   $main::lxdebug->enter_sub();
3139
3140   my ($self, $dbh, $trans_id, $restriction, $order) = @_;
3141   my ($orderBy, $desc) = split(/\-\-/, $order);
3142   $order = " ORDER BY " . ($order eq "" ? " h.itime " : ($desc == 1 ? $orderBy . " DESC " : $orderBy . " "));
3143   my @tempArray;
3144   my $i = 0;
3145   if ($trans_id ne "") {
3146     my $query =
3147       qq|SELECT h.employee_id, h.itime::timestamp(0) AS itime, h.addition, h.what_done, emp.name, h.snumbers, h.trans_id AS id | .
3148       qq|FROM history_erp h | .
3149       qq|LEFT JOIN employee emp ON (emp.id = h.employee_id) | .
3150       qq|WHERE (trans_id = | . $trans_id . qq|) $restriction | .
3151       $order;
3152
3153     my $sth = $dbh->prepare($query) || $self->dberror($query);
3154
3155     $sth->execute() || $self->dberror("$query");
3156
3157     while(my $hash_ref = $sth->fetchrow_hashref()) {
3158       $hash_ref->{addition} = $main::locale->text($hash_ref->{addition});
3159       $hash_ref->{what_done} = $main::locale->text($hash_ref->{what_done});
3160       $hash_ref->{snumbers} =~ s/^.+_(.*)$/$1/g;
3161       $tempArray[$i++] = $hash_ref;
3162     }
3163     $main::lxdebug->leave_sub() and return \@tempArray
3164       if ($i > 0 && $tempArray[0] ne "");
3165   }
3166   $main::lxdebug->leave_sub();
3167   return 0;
3168 }
3169
3170 sub get_partsgroup {
3171   $main::lxdebug->enter_sub();
3172
3173   my ($self, $myconfig, $p) = @_;
3174   my $target = $p->{target} || 'all_partsgroup';
3175
3176   my $dbh = $self->get_standard_dbh($myconfig);
3177
3178   my $query = qq|SELECT DISTINCT pg.id, pg.partsgroup
3179                  FROM partsgroup pg
3180                  JOIN parts p ON (p.partsgroup_id = pg.id) |;
3181   my @values;
3182
3183   if ($p->{searchitems} eq 'part') {
3184     $query .= qq|WHERE p.part_type = 'part'|;
3185   }
3186   if ($p->{searchitems} eq 'service') {
3187     $query .= qq|WHERE p.part_type = 'service'|;
3188   }
3189   if ($p->{searchitems} eq 'assembly') {
3190     $query .= qq|WHERE p.part_type = 'assembly'|;
3191   }
3192
3193   $query .= qq|ORDER BY partsgroup|;
3194
3195   if ($p->{all}) {
3196     $query = qq|SELECT id, partsgroup FROM partsgroup
3197                 ORDER BY partsgroup|;
3198   }
3199
3200   if ($p->{language_code}) {
3201     $query = qq|SELECT DISTINCT pg.id, pg.partsgroup,
3202                   t.description AS translation
3203                 FROM partsgroup pg
3204                 JOIN parts p ON (p.partsgroup_id = pg.id)
3205                 LEFT JOIN translation t ON ((t.trans_id = pg.id) AND (t.language_code = ?))
3206                 ORDER BY translation|;
3207     @values = ($p->{language_code});
3208   }
3209
3210   $self->{$target} = selectall_hashref_query($self, $dbh, $query, @values);
3211
3212   $main::lxdebug->leave_sub();
3213 }
3214
3215 sub get_pricegroup {
3216   $main::lxdebug->enter_sub();
3217
3218   my ($self, $myconfig, $p) = @_;
3219
3220   my $dbh = $self->get_standard_dbh($myconfig);
3221
3222   my $query = qq|SELECT p.id, p.pricegroup
3223                  FROM pricegroup p|;
3224
3225   $query .= qq| ORDER BY pricegroup|;
3226
3227   if ($p->{all}) {
3228     $query = qq|SELECT id, pricegroup FROM pricegroup
3229                 ORDER BY pricegroup|;
3230   }
3231
3232   $self->{all_pricegroup} = selectall_hashref_query($self, $dbh, $query);
3233
3234   $main::lxdebug->leave_sub();
3235 }
3236
3237 sub all_years {
3238 # usage $form->all_years($myconfig, [$dbh])
3239 # return list of all years where bookings found
3240 # (@all_years)
3241
3242   $main::lxdebug->enter_sub();
3243
3244   my ($self, $myconfig, $dbh) = @_;
3245
3246   $dbh ||= $self->get_standard_dbh($myconfig);
3247
3248   # get years
3249   my $query = qq|SELECT (SELECT MIN(transdate) FROM acc_trans),
3250                    (SELECT MAX(transdate) FROM acc_trans)|;
3251   my ($startdate, $enddate) = selectrow_query($self, $dbh, $query);
3252
3253   if ($myconfig->{dateformat} =~ /^yy/) {
3254     ($startdate) = split /\W/, $startdate;
3255     ($enddate) = split /\W/, $enddate;
3256   } else {
3257     (@_) = split /\W/, $startdate;
3258     $startdate = $_[2];
3259     (@_) = split /\W/, $enddate;
3260     $enddate = $_[2];
3261   }
3262
3263   my @all_years;
3264   $startdate = substr($startdate,0,4);
3265   $enddate = substr($enddate,0,4);
3266
3267   while ($enddate >= $startdate) {
3268     push @all_years, $enddate--;
3269   }
3270
3271   return @all_years;
3272
3273   $main::lxdebug->leave_sub();
3274 }
3275
3276 sub backup_vars {
3277   $main::lxdebug->enter_sub();
3278   my $self = shift;
3279   my @vars = @_;
3280
3281   map { $self->{_VAR_BACKUP}->{$_} = $self->{$_} if exists $self->{$_} } @vars;
3282
3283   $main::lxdebug->leave_sub();
3284 }
3285
3286 sub restore_vars {
3287   $main::lxdebug->enter_sub();
3288
3289   my $self = shift;
3290   my @vars = @_;
3291
3292   map { $self->{$_} = $self->{_VAR_BACKUP}->{$_} if exists $self->{_VAR_BACKUP}->{$_} } @vars;
3293
3294   $main::lxdebug->leave_sub();
3295 }
3296
3297 sub prepare_for_printing {
3298   my ($self) = @_;
3299
3300   my $defaults         = SL::DB::Default->get;
3301
3302   $self->{templates} ||= $defaults->templates;
3303   $self->{formname}  ||= $self->{type};
3304   $self->{media}     ||= 'email';
3305
3306   die "'media' other than 'email', 'file', 'printer' is not supported yet" unless $self->{media} =~ m/^(?:email|file|printer)$/;
3307
3308   # Several fields that used to reside in %::myconfig (stored in
3309   # auth.user_config) are now stored in defaults. Copy them over for
3310   # compatibility.
3311   $self->{$_} = $defaults->$_ for qw(company address taxnumber co_ustid duns sepa_creditor_id);
3312
3313   $self->{"myconfig_${_}"} = $::myconfig{$_} for grep { $_ ne 'dbpasswd' } keys %::myconfig;
3314
3315   if (!$self->{employee_id}) {
3316     $self->{"employee_${_}"} = $::myconfig{$_} for qw(email tel fax name signature);
3317     $self->{"employee_${_}"} = $defaults->$_   for qw(address businessnumber co_ustid company duns sepa_creditor_id taxnumber);
3318   }
3319
3320   # Load shipping address from database. If shipto_id is set then it's
3321   # one from the customer's/vendor's master data. Otherwise look an a
3322   # customized address linking back to the current record.
3323   my $shipto_module = $self->{type} =~ /_delivery_order$/                                             ? 'DO'
3324                     : $self->{type} =~ /sales_order|sales_quotation|request_quotation|purchase_order/ ? 'OE'
3325                     :                                                                                   'AR';
3326   my $shipto        = $self->{shipto_id} ? SL::DB::Shipto->new(shipto_id => $self->{shipto_id})->load
3327                     :                      SL::DB::Manager::Shipto->get_first(where => [ module => $shipto_module, trans_id => $self->{id} ]);
3328   if ($shipto) {
3329     $self->{$_} = $shipto->$_ for grep { m{^shipto} } map { $_->name } @{ $shipto->meta->columns };
3330     $self->{"shiptocvar_" . $_->config->name} = $_->value_as_text for @{ $shipto->cvars_by_config };
3331   }
3332
3333   my $language = $self->{language} ? '_' . $self->{language} : '';
3334
3335   my ($language_tc, $output_numberformat, $output_dateformat, $output_longdates);
3336   if ($self->{language_id}) {
3337     ($language_tc, $output_numberformat, $output_dateformat, $output_longdates) = AM->get_language_details(\%::myconfig, $self, $self->{language_id});
3338   }
3339
3340   $output_dateformat   ||= $::myconfig{dateformat};
3341   $output_numberformat ||= $::myconfig{numberformat};
3342   $output_longdates    //= 1;
3343
3344   $self->{myconfig_output_dateformat}   = $output_dateformat   // $::myconfig{dateformat};
3345   $self->{myconfig_output_longdates}    = $output_longdates    // 1;
3346   $self->{myconfig_output_numberformat} = $output_numberformat // $::myconfig{numberformat};
3347
3348   # Retrieve accounts for tax calculation.
3349   IC->retrieve_accounts(\%::myconfig, $self, map { $_ => $self->{"id_$_"} } 1 .. $self->{rowcount});
3350
3351   if ($self->{type} =~ /_delivery_order$/) {
3352     DO->order_details(\%::myconfig, $self);
3353   } elsif ($self->{type} =~ /sales_order|sales_quotation|request_quotation|purchase_order/) {
3354     OE->order_details(\%::myconfig, $self);
3355   } else {
3356     IS->invoice_details(\%::myconfig, $self, $::locale);
3357   }
3358
3359   # Chose extension & set source file name
3360   my $extension = 'html';
3361   if ($self->{format} eq 'postscript') {
3362     $self->{postscript}   = 1;
3363     $extension            = 'tex';
3364   } elsif ($self->{"format"} =~ /pdf/) {
3365     $self->{pdf}          = 1;
3366     $extension            = $self->{'format'} =~ m/opendocument/i ? 'odt' : 'tex';
3367   } elsif ($self->{"format"} =~ /opendocument/) {
3368     $self->{opendocument} = 1;
3369     $extension            = 'odt';
3370   } elsif ($self->{"format"} =~ /excel/) {
3371     $self->{excel}        = 1;
3372     $extension            = 'xls';
3373   }
3374
3375   my $printer_code    = $self->{printer_code} ? '_' . $self->{printer_code} : '';
3376   my $email_extension = $self->{media} eq 'email' && -f ($defaults->templates . "/$self->{formname}_email${language}.${extension}") ? '_email' : '';
3377   $self->{IN}         = "$self->{formname}${email_extension}${language}${printer_code}.${extension}";
3378
3379   # Format dates.
3380   $self->format_dates($output_dateformat, $output_longdates,
3381                       qw(invdate orddate quodate pldate duedate reqdate transdate shippingdate deliverydate validitydate paymentdate datepaid
3382                          transdate_oe deliverydate_oe employee_startdate employee_enddate),
3383                       grep({ /^(?:datepaid|transdate_oe|reqdate|deliverydate|deliverydate_oe|transdate)_\d+$/ } keys(%{$self})));
3384
3385   $self->reformat_numbers($output_numberformat, 2,
3386                           qw(invtotal ordtotal quototal subtotal linetotal listprice sellprice netprice discount tax taxbase total paid),
3387                           grep({ /^(?:linetotal|listprice|sellprice|netprice|taxbase|discount|paid|subtotal|total|tax)_\d+$/ } keys(%{$self})));
3388
3389   $self->reformat_numbers($output_numberformat, undef, qw(qty price_factor), grep({ /^qty_\d+$/} keys(%{$self})));
3390
3391   my ($cvar_date_fields, $cvar_number_fields) = CVar->get_field_format_list('module' => 'CT', 'prefix' => 'vc_');
3392
3393   if (scalar @{ $cvar_date_fields }) {
3394     $self->format_dates($output_dateformat, $output_longdates, @{ $cvar_date_fields });
3395   }
3396
3397   while (my ($precision, $field_list) = each %{ $cvar_number_fields }) {
3398     $self->reformat_numbers($output_numberformat, $precision, @{ $field_list });
3399   }
3400
3401   $self->{template_meta} = {
3402     formname  => $self->{formname},
3403     language  => SL::DB::Manager::Language->find_by_or_create(id => $self->{language_id} || undef),
3404     format    => $self->{format},
3405     media     => $self->{media},
3406     extension => $extension,
3407     printer   => SL::DB::Manager::Printer->find_by_or_create(id => $self->{printer_id} || undef),
3408     today     => DateTime->today,
3409   };
3410
3411   return $self;
3412 }
3413
3414 sub calculate_arap {
3415   my ($self,$buysell,$taxincluded,$exchangerate,$roundplaces) = @_;
3416
3417   # this function is used to calculate netamount, total_tax and amount for AP and
3418   # AR transactions (Kreditoren-/Debitorenbuchungen) by going over all lines
3419   # (1..$rowcount)
3420   # Thus it needs a fully prepared $form to work on.
3421   # calculate_arap assumes $form->{amount_$i} entries still need to be parsed
3422
3423   # The calculated total values are all rounded (default is to 2 places) and
3424   # returned as parameters rather than directly modifying form.  The aim is to
3425   # make the calculation of AP and AR behave identically.  There is a test-case
3426   # for this function in t/form/arap.t
3427
3428   # While calculating the totals $form->{amount_$i} and $form->{tax_$i} are
3429   # modified and formatted and receive the correct sign for writing straight to
3430   # acc_trans, depending on whether they are ar or ap.
3431
3432   # check parameters
3433   die "taxincluded needed in Form->calculate_arap" unless defined $taxincluded;
3434   die "exchangerate needed in Form->calculate_arap" unless defined $exchangerate;
3435   die 'illegal buysell parameter, has to be \"buy\" or \"sell\" in Form->calculate_arap\n' unless $buysell =~ /^(buy|sell)$/;
3436   $roundplaces = 2 unless $roundplaces;
3437
3438   my $sign = 1;  # adjust final results for writing amount to acc_trans
3439   $sign = -1 if $buysell eq 'buy';
3440
3441   my ($netamount,$total_tax,$amount);
3442
3443   my $tax;
3444
3445   # parse and round amounts, setting correct sign for writing to acc_trans
3446   for my $i (1 .. $self->{rowcount}) {
3447     $self->{"amount_$i"} = $self->round_amount($self->parse_amount(\%::myconfig, $self->{"amount_$i"}) * $exchangerate * $sign, $roundplaces);
3448
3449     $amount += $self->{"amount_$i"} * $sign;
3450   }
3451
3452   for my $i (1 .. $self->{rowcount}) {
3453     next unless $self->{"amount_$i"};
3454     ($self->{"tax_id_$i"}) = split /--/, $self->{"taxchart_$i"};
3455     my $tax_id = $self->{"tax_id_$i"};
3456
3457     my $selected_tax = SL::DB::Manager::Tax->find_by(id => "$tax_id");
3458
3459     if ( $selected_tax ) {
3460
3461       if ( $buysell eq 'sell' ) {
3462         $self->{AR_amounts}{"tax_$i"} = $selected_tax->chart->accno if defined $selected_tax->chart;
3463       } else {
3464         $self->{AP_amounts}{"tax_$i"} = $selected_tax->chart->accno if defined $selected_tax->chart;
3465       };
3466
3467       $self->{"taxkey_$i"} = $selected_tax->taxkey;
3468       $self->{"taxrate_$i"} = $selected_tax->rate;
3469     };
3470
3471     ($self->{"amount_$i"}, $self->{"tax_$i"}) = $self->calculate_tax($self->{"amount_$i"},$self->{"taxrate_$i"},$taxincluded,$roundplaces);
3472
3473     $netamount  += $self->{"amount_$i"};
3474     $total_tax  += $self->{"tax_$i"};
3475
3476   }
3477   $amount = $netamount + $total_tax;
3478
3479   # due to $sign amount_$i und tax_$i already have the right sign for acc_trans
3480   # but reverse sign of totals for writing amounts to ar
3481   if ( $buysell eq 'buy' ) {
3482     $netamount *= -1;
3483     $amount    *= -1;
3484     $total_tax *= -1;
3485   };
3486
3487   return($netamount,$total_tax,$amount);
3488 }
3489
3490 sub format_dates {
3491   my ($self, $dateformat, $longformat, @indices) = @_;
3492
3493   $dateformat ||= $::myconfig{dateformat};
3494
3495   foreach my $idx (@indices) {
3496     if ($self->{TEMPLATE_ARRAYS} && (ref($self->{TEMPLATE_ARRAYS}->{$idx}) eq "ARRAY")) {
3497       for (my $i = 0; $i < scalar(@{ $self->{TEMPLATE_ARRAYS}->{$idx} }); $i++) {
3498         $self->{TEMPLATE_ARRAYS}->{$idx}->[$i] = $::locale->reformat_date(\%::myconfig, $self->{TEMPLATE_ARRAYS}->{$idx}->[$i], $dateformat, $longformat);
3499       }
3500     }
3501
3502     next unless defined $self->{$idx};
3503
3504     if (!ref($self->{$idx})) {
3505       $self->{$idx} = $::locale->reformat_date(\%::myconfig, $self->{$idx}, $dateformat, $longformat);
3506
3507     } elsif (ref($self->{$idx}) eq "ARRAY") {
3508       for (my $i = 0; $i < scalar(@{ $self->{$idx} }); $i++) {
3509         $self->{$idx}->[$i] = $::locale->reformat_date(\%::myconfig, $self->{$idx}->[$i], $dateformat, $longformat);
3510       }
3511     }
3512   }
3513 }
3514
3515 sub reformat_numbers {
3516   my ($self, $numberformat, $places, @indices) = @_;
3517
3518   return if !$numberformat || ($numberformat eq $::myconfig{numberformat});
3519
3520   foreach my $idx (@indices) {
3521     if ($self->{TEMPLATE_ARRAYS} && (ref($self->{TEMPLATE_ARRAYS}->{$idx}) eq "ARRAY")) {
3522       for (my $i = 0; $i < scalar(@{ $self->{TEMPLATE_ARRAYS}->{$idx} }); $i++) {
3523         $self->{TEMPLATE_ARRAYS}->{$idx}->[$i] = $self->parse_amount(\%::myconfig, $self->{TEMPLATE_ARRAYS}->{$idx}->[$i]);
3524       }
3525     }
3526
3527     next unless defined $self->{$idx};
3528
3529     if (!ref($self->{$idx})) {
3530       $self->{$idx} = $self->parse_amount(\%::myconfig, $self->{$idx});
3531
3532     } elsif (ref($self->{$idx}) eq "ARRAY") {
3533       for (my $i = 0; $i < scalar(@{ $self->{$idx} }); $i++) {
3534         $self->{$idx}->[$i] = $self->parse_amount(\%::myconfig, $self->{$idx}->[$i]);
3535       }
3536     }
3537   }
3538
3539   my $saved_numberformat    = $::myconfig{numberformat};
3540   $::myconfig{numberformat} = $numberformat;
3541
3542   foreach my $idx (@indices) {
3543     if ($self->{TEMPLATE_ARRAYS} && (ref($self->{TEMPLATE_ARRAYS}->{$idx}) eq "ARRAY")) {
3544       for (my $i = 0; $i < scalar(@{ $self->{TEMPLATE_ARRAYS}->{$idx} }); $i++) {
3545         $self->{TEMPLATE_ARRAYS}->{$idx}->[$i] = $self->format_amount(\%::myconfig, $self->{TEMPLATE_ARRAYS}->{$idx}->[$i], $places);
3546       }
3547     }
3548
3549     next unless defined $self->{$idx};
3550
3551     if (!ref($self->{$idx})) {
3552       $self->{$idx} = $self->format_amount(\%::myconfig, $self->{$idx}, $places);
3553
3554     } elsif (ref($self->{$idx}) eq "ARRAY") {
3555       for (my $i = 0; $i < scalar(@{ $self->{$idx} }); $i++) {
3556         $self->{$idx}->[$i] = $self->format_amount(\%::myconfig, $self->{$idx}->[$i], $places);
3557       }
3558     }
3559   }
3560
3561   $::myconfig{numberformat} = $saved_numberformat;
3562 }
3563
3564 sub create_email_signature {
3565
3566   my $client_signature = $::instance_conf->get_signature;
3567   my $user_signature   = $::myconfig{signature};
3568
3569   my $signature = '';
3570   if ( $client_signature or $user_signature ) {
3571     $signature  = "\n\n-- \n";
3572     $signature .= $user_signature   . "\n" if $user_signature;
3573     $signature .= $client_signature . "\n" if $client_signature;
3574   };
3575   return $signature;
3576
3577 };
3578
3579 sub layout {
3580   my ($self) = @_;
3581   $::lxdebug->enter_sub;
3582
3583   my %style_to_script_map = (
3584     v3  => 'v3',
3585     neu => 'new',
3586   );
3587
3588   my $menu_script = $style_to_script_map{$::myconfig{menustyle}} || '';
3589
3590   package main;
3591   require "bin/mozilla/menu$menu_script.pl";
3592   package Form;
3593   require SL::Controller::FrameHeader;
3594
3595
3596   my $layout = SL::Controller::FrameHeader->new->action_header . ::render();
3597
3598   $::lxdebug->leave_sub;
3599   return $layout;
3600 }
3601
3602 sub calculate_tax {
3603   # this function calculates the net amount and tax for the lines in ar, ap and
3604   # gl and is used for update as well as post. When used with update the return
3605   # value of amount isn't needed
3606
3607   # calculate_tax should always work with positive values, or rather as the user inputs them
3608   # calculate_tax uses db/perl numberformat, i.e. parsed numbers
3609   # convert to negative numbers (when necessary) only when writing to acc_trans
3610   # the amount from $form for ap/ar/gl is currently always rounded to 2 decimals before it reaches here
3611   # for post_transaction amount already contains exchangerate and correct sign and is rounded
3612   # calculate_tax doesn't (need to) know anything about exchangerate
3613
3614   my ($self,$amount,$taxrate,$taxincluded,$roundplaces) = @_;
3615
3616   $roundplaces //= 2;
3617   $taxincluded //= 0;
3618
3619   my $tax;
3620
3621   if ($taxincluded) {
3622     # calculate tax (unrounded), subtract from amount, round amount and round tax
3623     $tax       = $amount - ($amount / ($taxrate + 1)); # equivalent to: taxrate * amount / (taxrate + 1)
3624     $amount    = $self->round_amount($amount - $tax, $roundplaces);
3625     $tax       = $self->round_amount($tax, $roundplaces);
3626   } else {
3627     $tax       = $amount * $taxrate;
3628     $tax       = $self->round_amount($tax, $roundplaces);
3629   }
3630
3631   $tax = 0 unless $tax;
3632
3633   return ($amount,$tax);
3634 };
3635
3636 1;
3637
3638 __END__
3639
3640 =head1 NAME
3641
3642 SL::Form.pm - main data object.
3643
3644 =head1 SYNOPSIS
3645
3646 This is the main data object of kivitendo.
3647 Unfortunately it also acts as a god object for certain data retrieval procedures used in the entry points.
3648 Points of interest for a beginner are:
3649
3650  - $form->error            - renders a generic error in html. accepts an error message
3651  - $form->get_standard_dbh - returns a database connection for the
3652
3653 =head1 SPECIAL FUNCTIONS
3654
3655 =head2 C<redirect_header> $url
3656
3657 Generates a HTTP redirection header for the new C<$url>. Constructs an
3658 absolute URL including scheme, host name and port. If C<$url> is a
3659 relative URL then it is considered relative to kivitendo base URL.
3660
3661 This function C<die>s if headers have already been created with
3662 C<$::form-E<gt>header>.
3663
3664 Examples:
3665
3666   print $::form->redirect_header('oe.pl?action=edit&id=1234');
3667   print $::form->redirect_header('http://www.lx-office.org/');
3668
3669 =head2 C<header>
3670
3671 Generates a general purpose http/html header and includes most of the scripts
3672 and stylesheets needed. Stylesheets can be added with L<use_stylesheet>.
3673
3674 Only one header will be generated. If the method was already called in this
3675 request it will not output anything and return undef. Also if no
3676 HTTP_USER_AGENT is found, no header is generated.
3677
3678 Although header does not accept parameters itself, it will honor special
3679 hashkeys of its Form instance:
3680
3681 =over 4
3682
3683 =item refresh_time
3684
3685 =item refresh_url
3686
3687 If one of these is set, a http-equiv refresh is generated. Missing parameters
3688 default to 3 seconds and the refering url.
3689
3690 =item stylesheet
3691
3692 Either a scalar or an array ref. Will be inlined into the header. Add
3693 stylesheets with the L<use_stylesheet> function.
3694
3695 =item landscape
3696
3697 If true, a css snippet will be generated that sets the page in landscape mode.
3698
3699 =item favicon
3700
3701 Used to override the default favicon.
3702
3703 =item title
3704
3705 A html page title will be generated from this
3706
3707 =item mtime_ischanged
3708
3709 Tries to avoid concurrent write operations to records by checking the database mtime with a fetched one.
3710
3711 Can be used / called with any table, that has itime and mtime attributes.
3712 Valid C<table> names are: oe, ar, ap, delivery_orders, parts.
3713 Can be called wit C<option> mail to generate a different error message.
3714
3715 Returns undef if no save operation has been done yet ($self->{id} not present).
3716 Returns undef if no concurrent write process is detected otherwise a error message.
3717
3718 =back
3719
3720 =cut