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