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