SL/Form.pm

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