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   if ( $ext_for_format eq 'pdf' && $self->doc_storage_enabled ) {
 861     $self->append_general_pdf_attachments(filepath =>  $self->{tmpdir}."/".$self->{tmpfile},
 862                                           type     =>  $self->{type});
 863   }
 864   if ($self->{media} eq 'file') {
 865     copy(join('/', $self->{cwd}, $userspath, $self->{tmpfile}), $out =~ m|^/| ? $out : join('/', $self->{cwd}, $out)) if $template->uses_temp_file;
 866
 867     if ($copy_to_webdav) {
 868       if (my $error = Common::copy_file_to_webdav_folder($self)) {
 869         chdir("$self->{cwd}");
 870         $self->error($error);
 871       }
 872     }
 873
 874     if (!$self->{preview} && $self->{attachment_type} !~ m{^dunning} && $self->doc_storage_enabled)
 875     {
 876       $self->{attachment_filename} ||= $self->generate_attachment_filename;
 877       $self->store_pdf($self);
 878     }
 879     $self->cleanup;
 880     chdir("$self->{cwd}");
 881
 882     $::lxdebug->leave_sub();
 883
 884     return;
 885   }
 886
 887   if ($copy_to_webdav) {
 888     if (my $error = Common::copy_file_to_webdav_folder($self)) {
 889       chdir("$self->{cwd}");
 890       $self->error($error);
 891     }
 892   }
 893
 894   if ( !$self->{preview} && $ext_for_format eq 'pdf' && $self->{attachment_type} !~ m{^dunning} && $self->doc_storage_enabled) {
 895     $self->{attachment_filename} ||= $self->generate_attachment_filename;
 896     my $file_obj = $self->store_pdf($self);
 897     $self->{print_file_id} = $file_obj->id if $file_obj;
 898   }
 899   if ($self->{media} eq 'email') {
 900     if ( getcwd() eq $self->{"tmpdir"} ) {
 901       # in the case of generating pdf we are in the tmpdir, but WHY ???
 902       $self->{tmpfile} = $userspath."/".$self->{tmpfile};
 903       chdir("$self->{cwd}");
 904     }
 905     $self->send_email(\%::myconfig,$ext_for_format);
 906   }
 907   else {
 908     $self->{OUT}      = $out;
 909     $self->{OUT_MODE} = $out_mode;
 910     $self->output_file($template->get_mime_type,$command_formatter);
 911   }
 912   delete $self->{print_file_id};
 913
 914   $self->cleanup;
 915
 916   chdir("$self->{cwd}");
 917   $main::lxdebug->leave_sub();
 918 }
 919
 920 sub get_bcc_defaults {
 921   my ($self, $myconfig, $mybcc) = @_;
 922   if (SL::DB::Default->get->bcc_to_login) {
 923     $mybcc .= ", " if $mybcc;
 924     $mybcc .= $myconfig->{email};
 925   }
 926   my $otherbcc = SL::DB::Default->get->global_bcc;
 927   if ($otherbcc) {
 928     $mybcc .= ", " if $mybcc;
 929     $mybcc .= $otherbcc;
 930   }
 931   return $mybcc;
 932 }
 933
 934 sub send_email {
 935   $main::lxdebug->enter_sub();
 936   my ($self, $myconfig, $ext_for_format) = @_;
 937   my $mail = Mailer->new;
 938
 939   map { $mail->{$_} = $self->{$_} }
 940     qw(cc subject message format);
 941
 942   if ($self->{cc_employee}) {
 943     my ($user, $my_emp_cc);
 944     $user        = SL::DB::Manager::AuthUser->find_by(login => $self->{cc_employee});
 945     $my_emp_cc   = $user->get_config_value('email') if ref $user eq 'SL::DB::AuthUser';
 946     $mail->{cc} .= ", "       if $mail->{cc};
 947     $mail->{cc} .= $my_emp_cc if $my_emp_cc;
 948   }
 949
 950   $mail->{bcc}    = $self->get_bcc_defaults($myconfig, $self->{bcc});
 951   $mail->{to}     = $self->{EMAIL_RECIPIENT} ? $self->{EMAIL_RECIPIENT} : $self->{email};
 952   $mail->{from}   = qq|"$myconfig->{name}" <$myconfig->{email}>|;
 953   $mail->{fileid} = time() . '.' . $$ . '.';
 954   my $full_signature     =  $self->create_email_signature();
 955   $full_signature        =~ s/\r//g;
 956
 957   $mail->{attachments} =  [];
 958   my @attfiles;
 959   # if we send html or plain text inline
 960   if (($self->{format} eq 'html') && ($self->{sendmode} eq 'inline')) {
 961     $mail->{content_type}   =  "text/html";
 962     $mail->{message}        =~ s/\r//g;
 963     $mail->{message}        =~ s{\n}{<br>\n}g;
 964     $full_signature         =~ s{\n}{<br>\n}g;
 965     $mail->{message}       .=  $full_signature;
 966
 967     open(IN, "<", $self->{tmpfile})
 968       or $self->error($self->cleanup . "$self->{tmpfile} : $!");
 969     $mail->{message} .= $_ while <IN>;
 970     close(IN);
 971
 972   } elsif (($self->{attachment_policy} // '') ne 'no_file') {
 973     my $attachment_name  =  $self->{attachment_filename}  || $self->{tmpfile};
 974     $attachment_name     =~ s{\.(.+?)$}{.${ext_for_format}} if ($ext_for_format);
 975
 976     if (($self->{attachment_policy} // '') eq 'old_file') {
 977       my ( $attfile ) = SL::File->get_all(object_id   => $self->{id},
 978                                           object_type => $self->{formname},
 979                                           file_type   => 'document');
 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   my $translation_type = $params{translation_type} // "preset_text_$self->{formname}";
1236   my $main_body        = GenericTranslations->get(translation_type => $translation_type,                  language_id => $self->{language_id});
1237   $main_body           = GenericTranslations->get(translation_type => $params{fallback_translation_type}, language_id => $self->{language_id}) if !$main_body && $params{fallback_translation_type};
1238   $body               .= GenericTranslations->get(translation_type => "salutation_punctuation_mark",      language_id => $self->{language_id}) . "\n\n";
1239   $body               .= $main_body;
1240
1241   $body = $main::locale->unquote_special_chars('HTML', $body);
1242
1243   $main::lxdebug->leave_sub();
1244   return $body;
1245 }
1246
1247 sub cleanup {
1248   $main::lxdebug->enter_sub();
1249
1250   my ($self, $application) = @_;
1251
1252   my $error_code = $?;
1253
1254   chdir("$self->{tmpdir}");
1255
1256   my @err = ();
1257   if ((-1 == $error_code) || (127 == (($error_code) >> 8))) {
1258     push @err, $::locale->text('The application "#1" was not found on the system.', $application || 'pdflatex') . ' ' . $::locale->text('Please contact your administrator.');
1259
1260   } elsif (-f "$self->{tmpfile}.err") {
1261     open(FH, "<:encoding(UTF-8)", "$self->{tmpfile}.err");
1262     @err = <FH>;
1263     close(FH);
1264   }
1265
1266   if ($self->{tmpfile} && !($::lx_office_conf{debug} && $::lx_office_conf{debug}->{keep_temp_files})) {
1267     $self->{tmpfile} =~ s|.*/||g;
1268     # strip extension
1269     $self->{tmpfile} =~ s/\.\w+$//g;
1270     my $tmpfile = $self->{tmpfile};
1271     unlink(<$tmpfile.*>);
1272   }
1273
1274   chdir("$self->{cwd}");
1275
1276   $main::lxdebug->leave_sub();
1277
1278   return "@err";
1279 }
1280
1281 sub datetonum {
1282   $main::lxdebug->enter_sub();
1283
1284   my ($self, $date, $myconfig) = @_;
1285   my ($yy, $mm, $dd);
1286
1287   if ($date && $date =~ /\D/) {
1288
1289     if ($myconfig->{dateformat} =~ /^yy/) {
1290       ($yy, $mm, $dd) = split /\D/, $date;
1291     }
1292     if ($myconfig->{dateformat} =~ /^mm/) {
1293       ($mm, $dd, $yy) = split /\D/, $date;
1294     }
1295     if ($myconfig->{dateformat} =~ /^dd/) {
1296       ($dd, $mm, $yy) = split /\D/, $date;
1297     }
1298
1299     $dd *= 1;
1300     $mm *= 1;
1301     $yy = ($yy < 70) ? $yy + 2000 : $yy;
1302     $yy = ($yy >= 70 && $yy <= 99) ? $yy + 1900 : $yy;
1303
1304     $dd = "0$dd" if ($dd < 10);
1305     $mm = "0$mm" if ($mm < 10);
1306
1307     $date = "$yy$mm$dd";
1308   }
1309
1310   $main::lxdebug->leave_sub();
1311
1312   return $date;
1313 }
1314
1315 # Database routines used throughout
1316 # DB Handling got moved to SL::DB, these are only shims for compatibility
1317
1318 sub dbconnect {
1319   SL::DB->client->dbh;
1320 }
1321
1322 sub get_standard_dbh {
1323   my $dbh = SL::DB->client->dbh;
1324
1325   if ($dbh && !$dbh->{Active}) {
1326     $main::lxdebug->message(LXDebug->INFO(), "get_standard_dbh: \$dbh is defined but not Active anymore");
1327     SL::DB->client->dbh(undef);
1328   }
1329
1330   SL::DB->client->dbh;
1331 }
1332
1333 sub disconnect_standard_dbh {
1334   SL::DB->client->dbh->rollback;
1335 }
1336
1337 # /database
1338
1339 sub date_closed {
1340   $main::lxdebug->enter_sub();
1341
1342   my ($self, $date, $myconfig) = @_;
1343   my $dbh = $self->get_standard_dbh;
1344
1345   my $query = "SELECT 1 FROM defaults WHERE ? < closedto";
1346   my $sth = prepare_execute_query($self, $dbh, $query, conv_date($date));
1347
1348   # Falls $date = '' - Fehlermeldung aus der Datenbank. Ich denke,
1349   # es ist sicher ein conv_date vorher IMMER auszuführen.
1350   # Testfälle ohne definiertes closedto:
1351   #   Leere Datumseingabe i.O.
1352   #     SELECT 1 FROM defaults WHERE '' < closedto
1353   #   normale Zahlungsbuchung über Rechnungsmaske i.O.
1354   #     SELECT 1 FROM defaults WHERE '10.05.2011' < closedto
1355   # Testfälle mit definiertem closedto (30.04.2011):
1356   #  Leere Datumseingabe i.O.
1357   #   SELECT 1 FROM defaults WHERE '' < closedto
1358   # normale Buchung im geschloßenem Zeitraum i.O.
1359   #   SELECT 1 FROM defaults WHERE '21.04.2011' < closedto
1360   #     Fehlermeldung: Es können keine Zahlungen für abgeschlossene Bücher gebucht werden!
1361   # normale Buchung in aktiver Buchungsperiode i.O.
1362   #   SELECT 1 FROM defaults WHERE '01.05.2011' < closedto
1363
1364   my ($closed) = $sth->fetchrow_array;
1365
1366   $main::lxdebug->leave_sub();
1367
1368   return $closed;
1369 }
1370
1371 # prevents bookings to the to far away future
1372 sub date_max_future {
1373   $main::lxdebug->enter_sub();
1374
1375   my ($self, $date, $myconfig) = @_;
1376   my $dbh = $self->get_standard_dbh;
1377
1378   my $query = "SELECT 1 FROM defaults WHERE ? - current_date > max_future_booking_interval";
1379   my $sth = prepare_execute_query($self, $dbh, $query, conv_date($date));
1380
1381   my ($max_future_booking_interval) = $sth->fetchrow_array;
1382
1383   $main::lxdebug->leave_sub();
1384
1385   return $max_future_booking_interval;
1386 }
1387
1388
1389 sub update_balance {
1390   $main::lxdebug->enter_sub();
1391
1392   my ($self, $dbh, $table, $field, $where, $value, @values) = @_;
1393
1394   # if we have a value, go do it
1395   if ($value != 0) {
1396
1397     # retrieve balance from table
1398     my $query = "SELECT $field FROM $table WHERE $where FOR UPDATE";
1399     my $sth = prepare_execute_query($self, $dbh, $query, @values);
1400     my ($balance) = $sth->fetchrow_array;
1401     $sth->finish;
1402
1403     $balance += $value;
1404
1405     # update balance
1406     $query = "UPDATE $table SET $field = $balance WHERE $where";
1407     do_query($self, $dbh, $query, @values);
1408   }
1409   $main::lxdebug->leave_sub();
1410 }
1411
1412 sub update_exchangerate {
1413   $main::lxdebug->enter_sub();
1414
1415   my ($self, $dbh, $curr, $transdate, $buy, $sell) = @_;
1416   my ($query);
1417   # some sanity check for currency
1418   if ($curr eq '') {
1419     $main::lxdebug->leave_sub();
1420     return;
1421   }
1422   $query = qq|SELECT name AS curr FROM currencies WHERE id=(SELECT currency_id FROM defaults)|;
1423
1424   my ($defaultcurrency) = selectrow_query($self, $dbh, $query);
1425
1426   if ($curr eq $defaultcurrency) {
1427     $main::lxdebug->leave_sub();
1428     return;
1429   }
1430
1431   $query = qq|SELECT e.currency_id FROM exchangerate e
1432                  WHERE e.currency_id = (SELECT cu.id FROM currencies cu WHERE cu.name=?) AND e.transdate = ?
1433                  FOR UPDATE|;
1434   my $sth = prepare_execute_query($self, $dbh, $query, $curr, $transdate);
1435
1436   if ($buy == 0) {
1437     $buy = "";
1438   }
1439   if ($sell == 0) {
1440     $sell = "";
1441   }
1442
1443   $buy = conv_i($buy, "NULL");
1444   $sell = conv_i($sell, "NULL");
1445
1446   my $set;
1447   if ($buy != 0 && $sell != 0) {
1448     $set = "buy = $buy, sell = $sell";
1449   } elsif ($buy != 0) {
1450     $set = "buy = $buy";
1451   } elsif ($sell != 0) {
1452     $set = "sell = $sell";
1453   }
1454
1455   if ($sth->fetchrow_array) {
1456     $query = qq|UPDATE exchangerate
1457                 SET $set
1458                 WHERE currency_id = (SELECT id FROM currencies WHERE name = ?)
1459                 AND transdate = ?|;
1460
1461   } else {
1462     $query = qq|INSERT INTO exchangerate (currency_id, buy, sell, transdate)
1463                 VALUES ((SELECT id FROM currencies WHERE name = ?), $buy, $sell, ?)|;
1464   }
1465   $sth->finish;
1466   do_query($self, $dbh, $query, $curr, $transdate);
1467
1468   $main::lxdebug->leave_sub();
1469 }
1470
1471 sub save_exchangerate {
1472   $main::lxdebug->enter_sub();
1473
1474   my ($self, $myconfig, $currency, $transdate, $rate, $fld) = @_;
1475
1476   SL::DB->client->with_transaction(sub {
1477     my $dbh = SL::DB->client->dbh;
1478
1479     my ($buy, $sell);
1480
1481     $buy  = $rate if $fld eq 'buy';
1482     $sell = $rate if $fld eq 'sell';
1483
1484
1485     $self->update_exchangerate($dbh, $currency, $transdate, $buy, $sell);
1486     1;
1487   }) or do { die SL::DB->client->error };
1488
1489   $main::lxdebug->leave_sub();
1490 }
1491
1492 sub get_exchangerate {
1493   $main::lxdebug->enter_sub();
1494
1495   my ($self, $dbh, $curr, $transdate, $fld) = @_;
1496   my ($query);
1497
1498   unless ($transdate && $curr) {
1499     $main::lxdebug->leave_sub();
1500     return 1;
1501   }
1502
1503   $query = qq|SELECT name AS curr FROM currencies WHERE id = (SELECT currency_id FROM defaults)|;
1504
1505   my ($defaultcurrency) = selectrow_query($self, $dbh, $query);
1506
1507   if ($curr eq $defaultcurrency) {
1508     $main::lxdebug->leave_sub();
1509     return 1;
1510   }
1511
1512   $query = qq|SELECT e.$fld FROM exchangerate e
1513                  WHERE e.currency_id = (SELECT id FROM currencies WHERE name = ?) AND e.transdate = ?|;
1514   my ($exchangerate) = selectrow_query($self, $dbh, $query, $curr, $transdate);
1515
1516
1517
1518   $main::lxdebug->leave_sub();
1519
1520   return $exchangerate;
1521 }
1522
1523 sub check_exchangerate {
1524   $main::lxdebug->enter_sub();
1525
1526   my ($self, $myconfig, $currency, $transdate, $fld) = @_;
1527
1528   if ($fld !~/^buy|sell$/) {
1529     $self->error('Fatal: check_exchangerate called with invalid buy/sell argument');
1530   }
1531
1532   unless ($transdate) {
1533     $main::lxdebug->leave_sub();
1534     return "";
1535   }
1536
1537   my ($defaultcurrency) = $self->get_default_currency($myconfig);
1538
1539   if ($currency eq $defaultcurrency) {
1540     $main::lxdebug->leave_sub();
1541     return 1;
1542   }
1543
1544   my $dbh   = $self->get_standard_dbh($myconfig);
1545   my $query = qq|SELECT e.$fld FROM exchangerate e
1546                  WHERE e.currency_id = (SELECT id FROM currencies WHERE name = ?) AND e.transdate = ?|;
1547
1548   my ($exchangerate) = selectrow_query($self, $dbh, $query, $currency, $transdate);
1549
1550   $main::lxdebug->leave_sub();
1551
1552   return $exchangerate;
1553 }
1554
1555 sub get_all_currencies {
1556   $main::lxdebug->enter_sub();
1557
1558   my $self     = shift;
1559   my $myconfig = shift || \%::myconfig;
1560   my $dbh      = $self->get_standard_dbh($myconfig);
1561
1562   my $query = qq|SELECT name FROM currencies|;
1563   my @currencies = map { $_->{name} } selectall_hashref_query($self, $dbh, $query);
1564
1565   $main::lxdebug->leave_sub();
1566
1567   return @currencies;
1568 }
1569
1570 sub get_default_currency {
1571   $main::lxdebug->enter_sub();
1572
1573   my ($self, $myconfig) = @_;
1574   my $dbh      = $self->get_standard_dbh($myconfig);
1575   my $query = qq|SELECT name AS curr FROM currencies WHERE id = (SELECT currency_id FROM defaults)|;
1576
1577   my ($defaultcurrency) = selectrow_query($self, $dbh, $query);
1578
1579   $main::lxdebug->leave_sub();
1580
1581   return $defaultcurrency;
1582 }
1583
1584 sub set_payment_options {
1585   my ($self, $myconfig, $transdate, $type) = @_;
1586
1587   my $terms = $self->{payment_id} ? SL::DB::PaymentTerm->new(id => $self->{payment_id})->load : undef;
1588   return if !$terms;
1589
1590   my $is_invoice                = $type =~ m{invoice}i;
1591
1592   $transdate                  ||= $self->{invdate} || $self->{transdate};
1593   my $due_date                  = $self->{duedate} || $self->{reqdate};
1594
1595   $self->{$_}                   = $terms->$_ for qw(terms_netto terms_skonto percent_skonto);
1596   $self->{payment_description}  = $terms->description;
1597   $self->{netto_date}           = $terms->calc_date(reference_date => $transdate, due_date => $due_date, terms => 'net')->to_kivitendo;
1598   $self->{skonto_date}          = $terms->calc_date(reference_date => $transdate, due_date => $due_date, terms => 'discount')->to_kivitendo;
1599
1600   my ($invtotal, $total);
1601   my (%amounts, %formatted_amounts);
1602
1603   if ($self->{type} =~ /_order$/) {
1604     $amounts{invtotal} = $self->{ordtotal};
1605     $amounts{total}    = $self->{ordtotal};
1606
1607   } elsif ($self->{type} =~ /_quotation$/) {
1608     $amounts{invtotal} = $self->{quototal};
1609     $amounts{total}    = $self->{quototal};
1610
1611   } else {
1612     $amounts{invtotal} = $self->{invtotal};
1613     $amounts{total}    = $self->{total};
1614   }
1615   map { $amounts{$_} = $self->parse_amount($myconfig, $amounts{$_}) } keys %amounts;
1616
1617   $amounts{skonto_in_percent}  = 100.0 * $self->{percent_skonto};
1618   $amounts{skonto_amount}      = $amounts{invtotal} * $self->{percent_skonto};
1619   $amounts{invtotal_wo_skonto} = $amounts{invtotal} * (1 - $self->{percent_skonto});
1620   $amounts{total_wo_skonto}    = $amounts{total}    * (1 - $self->{percent_skonto});
1621
1622   foreach (keys %amounts) {
1623     $amounts{$_}           = $self->round_amount($amounts{$_}, 2);
1624     $formatted_amounts{$_} = $self->format_amount($myconfig, $amounts{$_}, 2);
1625   }
1626
1627   if ($self->{"language_id"}) {
1628     my $language             = SL::DB::Language->new(id => $self->{language_id})->load;
1629
1630     $self->{payment_terms}   = $type =~ m{invoice}i ? $terms->translated_attribute('description_long_invoice', $language->id) : undef;
1631     $self->{payment_terms} ||= $terms->translated_attribute('description_long', $language->id);
1632
1633     if ($language->output_dateformat) {
1634       foreach my $key (qw(netto_date skonto_date)) {
1635         $self->{$key} = $::locale->reformat_date($myconfig, $self->{$key}, $language->output_dateformat, $language->output_longdates);
1636       }
1637     }
1638
1639     if ($language->output_numberformat && ($language->output_numberformat ne $myconfig->{numberformat})) {
1640       local $myconfig->{numberformat};
1641       $myconfig->{"numberformat"} = $language->output_numberformat;
1642       $formatted_amounts{$_} = $self->format_amount($myconfig, $amounts{$_}) for keys %amounts;
1643     }
1644   }
1645
1646   $self->{payment_terms} =  $self->{payment_terms} || ($is_invoice ? $terms->description_long_invoice : undef) || $terms->description_long;
1647
1648   $self->{payment_terms} =~ s/<%netto_date%>/$self->{netto_date}/g;
1649   $self->{payment_terms} =~ s/<%skonto_date%>/$self->{skonto_date}/g;
1650   $self->{payment_terms} =~ s/<%currency%>/$self->{currency}/g;
1651   $self->{payment_terms} =~ s/<%terms_netto%>/$self->{terms_netto}/g;
1652   $self->{payment_terms} =~ s/<%account_number%>/$self->{account_number}/g;
1653   $self->{payment_terms} =~ s/<%bank%>/$self->{bank}/g;
1654   $self->{payment_terms} =~ s/<%bank_code%>/$self->{bank_code}/g;
1655   $self->{payment_terms} =~ s/<\%bic\%>/$self->{bic}/g;
1656   $self->{payment_terms} =~ s/<\%iban\%>/$self->{iban}/g;
1657   $self->{payment_terms} =~ s/<\%mandate_date_of_signature\%>/$self->{mandate_date_of_signature}/g;
1658   $self->{payment_terms} =~ s/<\%mandator_id\%>/$self->{mandator_id}/g;
1659
1660   map { $self->{payment_terms} =~ s/<%${_}%>/$formatted_amounts{$_}/g; } keys %formatted_amounts;
1661
1662   $self->{skonto_in_percent} = $formatted_amounts{skonto_in_percent};
1663
1664 }
1665
1666 sub get_template_language {
1667   $main::lxdebug->enter_sub();
1668
1669   my ($self, $myconfig) = @_;
1670
1671   my $template_code = "";
1672
1673   if ($self->{language_id}) {
1674     my $dbh = $self->get_standard_dbh($myconfig);
1675     my $query = qq|SELECT template_code FROM language WHERE id = ?|;
1676     ($template_code) = selectrow_query($self, $dbh, $query, $self->{language_id});
1677   }
1678
1679   $main::lxdebug->leave_sub();
1680
1681   return $template_code;
1682 }
1683
1684 sub get_printer_code {
1685   $main::lxdebug->enter_sub();
1686
1687   my ($self, $myconfig) = @_;
1688
1689   my $template_code = "";
1690
1691   if ($self->{printer_id}) {
1692     my $dbh = $self->get_standard_dbh($myconfig);
1693     my $query = qq|SELECT template_code, printer_command FROM printers WHERE id = ?|;
1694     ($template_code, $self->{printer_command}) = selectrow_query($self, $dbh, $query, $self->{printer_id});
1695   }
1696
1697   $main::lxdebug->leave_sub();
1698
1699   return $template_code;
1700 }
1701
1702 sub get_shipto {
1703   $main::lxdebug->enter_sub();
1704
1705   my ($self, $myconfig) = @_;
1706
1707   my $template_code = "";
1708
1709   if ($self->{shipto_id}) {
1710     my $dbh = $self->get_standard_dbh($myconfig);
1711     my $query = qq|SELECT * FROM shipto WHERE shipto_id = ?|;
1712     my $ref = selectfirst_hashref_query($self, $dbh, $query, $self->{shipto_id});
1713     map({ $self->{$_} = $ref->{$_} } keys(%$ref));
1714
1715     my $cvars = CVar->get_custom_variables(
1716       dbh      => $dbh,
1717       module   => 'ShipTo',
1718       trans_id => $self->{shipto_id},
1719     );
1720     $self->{"shiptocvar_$_->{name}"} = $_->{value} for @{ $cvars };
1721   }
1722
1723   $main::lxdebug->leave_sub();
1724 }
1725
1726 sub add_shipto {
1727   my ($self, $dbh, $id, $module) = @_;
1728
1729   my $shipto;
1730   my @values;
1731
1732   foreach my $item (qw(name department_1 department_2 street zipcode city country gln
1733                        contact phone fax email)) {
1734     if ($self->{"shipto$item"}) {
1735       $shipto = 1 if ($self->{$item} ne $self->{"shipto$item"});
1736     }
1737     push(@values, $self->{"shipto${item}"});
1738   }
1739
1740   return if !$shipto;
1741
1742   # shiptocp_gender only makes sense, if any other shipto attribute is set.
1743   # Because shiptocp_gender is set to 'm' by default in forms
1744   # it must not be considered above to decide if shiptos has to be added or
1745   # updated, but must be inserted or updated as well in case.
1746   push(@values, $self->{shiptocp_gender});
1747
1748   my $shipto_id = $self->{shipto_id};
1749
1750   if ($self->{shipto_id}) {
1751     my $query = qq|UPDATE shipto set
1752                      shiptoname = ?,
1753                      shiptodepartment_1 = ?,
1754                      shiptodepartment_2 = ?,
1755                      shiptostreet = ?,
1756                      shiptozipcode = ?,
1757                      shiptocity = ?,
1758                      shiptocountry = ?,
1759                      shiptogln = ?,
1760                      shiptocontact = ?,
1761                      shiptophone = ?,
1762                      shiptofax = ?,
1763                      shiptoemail = ?
1764                      shiptocp_gender = ?,
1765                    WHERE shipto_id = ?|;
1766     do_query($self, $dbh, $query, @values, $self->{shipto_id});
1767   } else {
1768     my $query = qq|SELECT * FROM shipto
1769                    WHERE shiptoname = ? AND
1770                      shiptodepartment_1 = ? AND
1771                      shiptodepartment_2 = ? AND
1772                      shiptostreet = ? AND
1773                      shiptozipcode = ? AND
1774                      shiptocity = ? AND
1775                      shiptocountry = ? AND
1776                      shiptogln = ? AND
1777                      shiptocontact = ? AND
1778                      shiptophone = ? AND
1779                      shiptofax = ? AND
1780                      shiptoemail = ? AND
1781                      shiptocp_gender = ? AND
1782                      module = ? AND
1783                      trans_id = ?|;
1784     my $insert_check = selectfirst_hashref_query($self, $dbh, $query, @values, $module, $id);
1785     if(!$insert_check){
1786       my $insert_query =
1787         qq|INSERT INTO shipto (trans_id, shiptoname, shiptodepartment_1, shiptodepartment_2,
1788                                shiptostreet, shiptozipcode, shiptocity, shiptocountry, shiptogln,
1789                                shiptocontact, shiptophone, shiptofax, shiptoemail, shiptocp_gender, module)
1790            VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)|;
1791       do_query($self, $dbh, $insert_query, $id, @values, $module);
1792
1793       $insert_check = selectfirst_hashref_query($self, $dbh, $query, @values, $module, $id);
1794     }
1795
1796     $shipto_id = $insert_check->{shipto_id};
1797   }
1798
1799   return unless $shipto_id;
1800
1801   CVar->save_custom_variables(
1802     dbh         => $dbh,
1803     module      => 'ShipTo',
1804     trans_id    => $shipto_id,
1805     variables   => $self,
1806     name_prefix => 'shipto',
1807   );
1808 }
1809
1810 sub get_employee {
1811   $main::lxdebug->enter_sub();
1812
1813   my ($self, $dbh) = @_;
1814
1815   $dbh ||= $self->get_standard_dbh(\%main::myconfig);
1816
1817   my $query = qq|SELECT id, name FROM employee WHERE login = ?|;
1818   ($self->{"employee_id"}, $self->{"employee"}) = selectrow_query($self, $dbh, $query, $self->{login});
1819   $self->{"employee_id"} *= 1;
1820
1821   $main::lxdebug->leave_sub();
1822 }
1823
1824 sub get_employee_data {
1825   $main::lxdebug->enter_sub();
1826
1827   my $self     = shift;
1828   my %params   = @_;
1829   my $defaults = SL::DB::Default->get;
1830
1831   Common::check_params(\%params, qw(prefix));
1832   Common::check_params_x(\%params, qw(id));
1833
1834   if (!$params{id}) {
1835     $main::lxdebug->leave_sub();
1836     return;
1837   }
1838
1839   my $myconfig = \%main::myconfig;
1840   my $dbh      = $params{dbh} || $self->get_standard_dbh($myconfig);
1841
1842   my ($login, $deleted)  = selectrow_query($self, $dbh, qq|SELECT login,deleted FROM employee WHERE id = ?|, conv_i($params{id}));
1843
1844   if ($login) {
1845     # login already fetched and still the same client (mandant) | same for both cases (delete|!delete)
1846     $self->{$params{prefix} . '_login'}   = $login;
1847     $self->{$params{prefix} . "_${_}"}    = $defaults->$_ for qw(address businessnumber co_ustid company duns taxnumber);
1848
1849     if (!$deleted) {
1850       # get employee data from auth.user_config
1851       my $user = User->new(login => $login);
1852       $self->{$params{prefix} . "_${_}"} = $user->{$_} for qw(email fax name signature tel);
1853     } else {
1854       # get saved employee data from employee
1855       my $employee = SL::DB::Manager::Employee->find_by(id => conv_i($params{id}));
1856       $self->{$params{prefix} . "_${_}"} = $employee->{"deleted_$_"} for qw(email fax signature tel);
1857       $self->{$params{prefix} . "_name"} = $employee->name;
1858     }
1859  }
1860   $main::lxdebug->leave_sub();
1861 }
1862
1863 sub _get_contacts {
1864   $main::lxdebug->enter_sub();
1865
1866   my ($self, $dbh, $id, $key) = @_;
1867
1868   $key = "all_contacts" unless ($key);
1869
1870   if (!$id) {
1871     $self->{$key} = [];
1872     $main::lxdebug->leave_sub();
1873     return;
1874   }
1875
1876   my $query =
1877     qq|SELECT cp_id, cp_cv_id, cp_name, cp_givenname, cp_abteilung | .
1878     qq|FROM contacts | .
1879     qq|WHERE cp_cv_id = ? | .
1880     qq|ORDER BY lower(cp_name)|;
1881
1882   $self->{$key} = selectall_hashref_query($self, $dbh, $query, $id);
1883
1884   $main::lxdebug->leave_sub();
1885 }
1886
1887 sub _get_projects {
1888   $main::lxdebug->enter_sub();
1889
1890   my ($self, $dbh, $key) = @_;
1891
1892   my ($all, $old_id, $where, @values);
1893
1894   if (ref($key) eq "HASH") {
1895     my $params = $key;
1896
1897     $key = "ALL_PROJECTS";
1898
1899     foreach my $p (keys(%{$params})) {
1900       if ($p eq "all") {
1901         $all = $params->{$p};
1902       } elsif ($p eq "old_id") {
1903         $old_id = $params->{$p};
1904       } elsif ($p eq "key") {
1905         $key = $params->{$p};
1906       }
1907     }
1908   }
1909
1910   if (!$all) {
1911     $where = "WHERE active ";
1912     if ($old_id) {
1913       if (ref($old_id) eq "ARRAY") {
1914         my @ids = grep({ $_ } @{$old_id});
1915         if (@ids) {
1916           $where .= " OR id IN (" . join(",", map({ "?" } @ids)) . ") ";
1917           push(@values, @ids);
1918         }
1919       } else {
1920         $where .= " OR (id = ?) ";
1921         push(@values, $old_id);
1922       }
1923     }
1924   }
1925
1926   my $query =
1927     qq|SELECT id, projectnumber, description, active | .
1928     qq|FROM project | .
1929     $where .
1930     qq|ORDER BY lower(projectnumber)|;
1931
1932   $self->{$key} = selectall_hashref_query($self, $dbh, $query, @values);
1933
1934   $main::lxdebug->leave_sub();
1935 }
1936
1937 sub _get_printers {
1938   $main::lxdebug->enter_sub();
1939
1940   my ($self, $dbh, $key) = @_;
1941
1942   $key = "all_printers" unless ($key);
1943
1944   my $query = qq|SELECT id, printer_description, printer_command, template_code FROM printers|;
1945
1946   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
1947
1948   $main::lxdebug->leave_sub();
1949 }
1950
1951 sub _get_charts {
1952   $main::lxdebug->enter_sub();
1953
1954   my ($self, $dbh, $params) = @_;
1955   my ($key);
1956
1957   $key = $params->{key};
1958   $key = "all_charts" unless ($key);
1959
1960   my $transdate = quote_db_date($params->{transdate});
1961
1962   my $query =
1963     qq|SELECT c.id, c.accno, c.description, c.link, c.charttype, tk.taxkey_id, tk.tax_id | .
1964     qq|FROM chart c | .
1965     qq|LEFT JOIN taxkeys tk ON | .
1966     qq|(tk.id = (SELECT id FROM taxkeys | .
1967     qq|          WHERE taxkeys.chart_id = c.id AND startdate <= $transdate | .
1968     qq|          ORDER BY startdate DESC LIMIT 1)) | .
1969     qq|ORDER BY c.accno|;
1970
1971   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
1972
1973   $main::lxdebug->leave_sub();
1974 }
1975
1976 sub _get_taxzones {
1977   $main::lxdebug->enter_sub();
1978
1979   my ($self, $dbh, $key) = @_;
1980
1981   $key = "all_taxzones" unless ($key);
1982   my $tzfilter = "";
1983   $tzfilter = "WHERE obsolete is FALSE" if $key eq 'ALL_ACTIVE_TAXZONES';
1984
1985   my $query = qq|SELECT * FROM tax_zones $tzfilter ORDER BY sortkey|;
1986
1987   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
1988
1989   $main::lxdebug->leave_sub();
1990 }
1991
1992 sub _get_employees {
1993   $main::lxdebug->enter_sub();
1994
1995   my ($self, $dbh, $params) = @_;
1996
1997   my $deleted = 0;
1998
1999   my $key;
2000   if (ref $params eq 'HASH') {
2001     $key     = $params->{key};
2002     $deleted = $params->{deleted};
2003
2004   } else {
2005     $key = $params;
2006   }
2007
2008   $key     ||= "all_employees";
2009   my $filter = $deleted ? '' : 'WHERE NOT COALESCE(deleted, FALSE)';
2010   $self->{$key} = selectall_hashref_query($self, $dbh, qq|SELECT * FROM employee $filter ORDER BY lower(name)|);
2011
2012   $main::lxdebug->leave_sub();
2013 }
2014
2015 sub _get_business_types {
2016   $main::lxdebug->enter_sub();
2017
2018   my ($self, $dbh, $key) = @_;
2019
2020   my $options       = ref $key eq 'HASH' ? $key : { key => $key };
2021   $options->{key} ||= "all_business_types";
2022   my $where         = '';
2023
2024   if (exists $options->{salesman}) {
2025     $where = 'WHERE ' . ($options->{salesman} ? '' : 'NOT ') . 'COALESCE(salesman)';
2026   }
2027
2028   $self->{ $options->{key} } = selectall_hashref_query($self, $dbh, qq|SELECT * FROM business $where ORDER BY lower(description)|);
2029
2030   $main::lxdebug->leave_sub();
2031 }
2032
2033 sub _get_languages {
2034   $main::lxdebug->enter_sub();
2035
2036   my ($self, $dbh, $key) = @_;
2037
2038   $key = "all_languages" unless ($key);
2039
2040   my $query = qq|SELECT * FROM language ORDER BY id|;
2041
2042   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2043
2044   $main::lxdebug->leave_sub();
2045 }
2046
2047 sub _get_dunning_configs {
2048   $main::lxdebug->enter_sub();
2049
2050   my ($self, $dbh, $key) = @_;
2051
2052   $key = "all_dunning_configs" unless ($key);
2053
2054   my $query = qq|SELECT * FROM dunning_config ORDER BY dunning_level|;
2055
2056   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2057
2058   $main::lxdebug->leave_sub();
2059 }
2060
2061 sub _get_currencies {
2062 $main::lxdebug->enter_sub();
2063
2064   my ($self, $dbh, $key) = @_;
2065
2066   $key = "all_currencies" unless ($key);
2067
2068   $self->{$key} = [$self->get_all_currencies()];
2069
2070   $main::lxdebug->leave_sub();
2071 }
2072
2073 sub _get_payments {
2074 $main::lxdebug->enter_sub();
2075
2076   my ($self, $dbh, $key) = @_;
2077
2078   $key = "all_payments" unless ($key);
2079
2080   my $query = qq|SELECT * FROM payment_terms ORDER BY sortkey|;
2081
2082   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2083
2084   $main::lxdebug->leave_sub();
2085 }
2086
2087 sub _get_customers {
2088   $main::lxdebug->enter_sub();
2089
2090   my ($self, $dbh, $key) = @_;
2091
2092   my $options        = ref $key eq 'HASH' ? $key : { key => $key };
2093   $options->{key}  ||= "all_customers";
2094   my $limit_clause   = $options->{limit} ? "LIMIT $options->{limit}" : '';
2095
2096   my @where;
2097   push @where, qq|business_id IN (SELECT id FROM business WHERE salesman)| if  $options->{business_is_salesman};
2098   push @where, qq|NOT obsolete|                                            if !$options->{with_obsolete};
2099   my $where_str = @where ? "WHERE " . join(" AND ", map { "($_)" } @where) : '';
2100
2101   my $query = qq|SELECT * FROM customer $where_str ORDER BY name $limit_clause|;
2102   $self->{ $options->{key} } = selectall_hashref_query($self, $dbh, $query);
2103
2104   $main::lxdebug->leave_sub();
2105 }
2106
2107 sub _get_vendors {
2108   $main::lxdebug->enter_sub();
2109
2110   my ($self, $dbh, $key) = @_;
2111
2112   $key = "all_vendors" unless ($key);
2113
2114   my $query = qq|SELECT * FROM vendor WHERE NOT obsolete ORDER BY name|;
2115
2116   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2117
2118   $main::lxdebug->leave_sub();
2119 }
2120
2121 sub _get_departments {
2122   $main::lxdebug->enter_sub();
2123
2124   my ($self, $dbh, $key) = @_;
2125
2126   $key = "all_departments" unless ($key);
2127
2128   my $query = qq|SELECT * FROM department ORDER BY description|;
2129
2130   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2131
2132   $main::lxdebug->leave_sub();
2133 }
2134
2135 sub _get_warehouses {
2136   $main::lxdebug->enter_sub();
2137
2138   my ($self, $dbh, $param) = @_;
2139
2140   my ($key, $bins_key);
2141
2142   if ('' eq ref $param) {
2143     $key = $param;
2144
2145   } else {
2146     $key      = $param->{key};
2147     $bins_key = $param->{bins};
2148   }
2149
2150   my $query = qq|SELECT w.* FROM warehouse w
2151                  WHERE (NOT w.invalid) AND
2152                    ((SELECT COUNT(b.*) FROM bin b WHERE b.warehouse_id = w.id) > 0)
2153                  ORDER BY w.sortkey|;
2154
2155   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2156
2157   if ($bins_key) {
2158     $query = qq|SELECT id, description FROM bin WHERE warehouse_id = ?
2159                 ORDER BY description|;
2160     my $sth = prepare_query($self, $dbh, $query);
2161
2162     foreach my $warehouse (@{ $self->{$key} }) {
2163       do_statement($self, $sth, $query, $warehouse->{id});
2164       $warehouse->{$bins_key} = [];
2165
2166       while (my $ref = $sth->fetchrow_hashref()) {
2167         push @{ $warehouse->{$bins_key} }, $ref;
2168       }
2169     }
2170     $sth->finish();
2171   }
2172
2173   $main::lxdebug->leave_sub();
2174 }
2175
2176 sub _get_simple {
2177   $main::lxdebug->enter_sub();
2178
2179   my ($self, $dbh, $table, $key, $sortkey) = @_;
2180
2181   my $query  = qq|SELECT * FROM $table|;
2182   $query    .= qq| ORDER BY $sortkey| if ($sortkey);
2183
2184   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2185
2186   $main::lxdebug->leave_sub();
2187 }
2188
2189 sub get_lists {
2190   $main::lxdebug->enter_sub();
2191
2192   my $self = shift;
2193   my %params = @_;
2194
2195   croak "get_lists: shipto is no longer supported" if $params{shipto};
2196
2197   my $dbh = $self->get_standard_dbh(\%main::myconfig);
2198   my ($sth, $query, $ref);
2199
2200   my ($vc, $vc_id);
2201   if ($params{contacts}) {
2202     $vc = 'customer' if $self->{"vc"} eq "customer";
2203     $vc = 'vendor'   if $self->{"vc"} eq "vendor";
2204     die "invalid use of get_lists, need 'vc'" unless $vc;
2205     $vc_id = $self->{"${vc}_id"};
2206   }
2207
2208   if ($params{"contacts"}) {
2209     $self->_get_contacts($dbh, $vc_id, $params{"contacts"});
2210   }
2211
2212   if ($params{"projects"} || $params{"all_projects"}) {
2213     $self->_get_projects($dbh, $params{"all_projects"} ?
2214                          $params{"all_projects"} : $params{"projects"},
2215                          $params{"all_projects"} ? 1 : 0);
2216   }
2217
2218   if ($params{"printers"}) {
2219     $self->_get_printers($dbh, $params{"printers"});
2220   }
2221
2222   if ($params{"languages"}) {
2223     $self->_get_languages($dbh, $params{"languages"});
2224   }
2225
2226   if ($params{"charts"}) {
2227     $self->_get_charts($dbh, $params{"charts"});
2228   }
2229
2230   if ($params{"taxzones"}) {
2231     $self->_get_taxzones($dbh, $params{"taxzones"});
2232   }
2233
2234   if ($params{"employees"}) {
2235     $self->_get_employees($dbh, $params{"employees"});
2236   }
2237
2238   if ($params{"salesmen"}) {
2239     $self->_get_employees($dbh, $params{"salesmen"});
2240   }
2241
2242   if ($params{"business_types"}) {
2243     $self->_get_business_types($dbh, $params{"business_types"});
2244   }
2245
2246   if ($params{"dunning_configs"}) {
2247     $self->_get_dunning_configs($dbh, $params{"dunning_configs"});
2248   }
2249
2250   if($params{"currencies"}) {
2251     $self->_get_currencies($dbh, $params{"currencies"});
2252   }
2253
2254   if($params{"customers"}) {
2255     $self->_get_customers($dbh, $params{"customers"});
2256   }
2257
2258   if($params{"vendors"}) {
2259     if (ref $params{"vendors"} eq 'HASH') {
2260       $self->_get_vendors($dbh, $params{"vendors"}{key}, $params{"vendors"}{limit});
2261     } else {
2262       $self->_get_vendors($dbh, $params{"vendors"});
2263     }
2264   }
2265
2266   if($params{"payments"}) {
2267     $self->_get_payments($dbh, $params{"payments"});
2268   }
2269
2270   if($params{"departments"}) {
2271     $self->_get_departments($dbh, $params{"departments"});
2272   }
2273
2274   if ($params{price_factors}) {
2275     $self->_get_simple($dbh, 'price_factors', $params{price_factors}, 'sortkey');
2276   }
2277
2278   if ($params{warehouses}) {
2279     $self->_get_warehouses($dbh, $params{warehouses});
2280   }
2281
2282   if ($params{partsgroup}) {
2283     $self->get_partsgroup(\%main::myconfig, { all => 1, target => $params{partsgroup} });
2284   }
2285
2286   $main::lxdebug->leave_sub();
2287 }
2288
2289 # this sub gets the id and name from $table
2290 sub get_name {
2291   $main::lxdebug->enter_sub();
2292
2293   my ($self, $myconfig, $table) = @_;
2294
2295   # connect to database
2296   my $dbh = $self->get_standard_dbh($myconfig);
2297
2298   $table = $table eq "customer" ? "customer" : "vendor";
2299   my $arap = $self->{arap} eq "ar" ? "ar" : "ap";
2300
2301   my ($query, @values);
2302
2303   if (!$self->{openinvoices}) {
2304     my $where;
2305     if ($self->{customernumber} ne "") {
2306       $where = qq|(vc.customernumber ILIKE ?)|;
2307       push(@values, like($self->{customernumber}));
2308     } else {
2309       $where = qq|(vc.name ILIKE ?)|;
2310       push(@values, like($self->{$table}));
2311     }
2312
2313     $query =
2314       qq~SELECT vc.id, vc.name,
2315            vc.street || ' ' || vc.zipcode || ' ' || vc.city || ' ' || vc.country AS address
2316          FROM $table vc
2317          WHERE $where AND (NOT vc.obsolete)
2318          ORDER BY vc.name~;
2319   } else {
2320     $query =
2321       qq~SELECT DISTINCT vc.id, vc.name,
2322            vc.street || ' ' || vc.zipcode || ' ' || vc.city || ' ' || vc.country AS address
2323          FROM $arap a
2324          JOIN $table vc ON (a.${table}_id = vc.id)
2325          WHERE NOT (a.amount = a.paid) AND (vc.name ILIKE ?)
2326          ORDER BY vc.name~;
2327     push(@values, like($self->{$table}));
2328   }
2329
2330   $self->{name_list} = selectall_hashref_query($self, $dbh, $query, @values);
2331
2332   $main::lxdebug->leave_sub();
2333
2334   return scalar(@{ $self->{name_list} });
2335 }
2336
2337 sub new_lastmtime {
2338
2339   my ($self, $table, $provided_dbh) = @_;
2340
2341   my $dbh = $provided_dbh ? $provided_dbh : $self->get_standard_dbh;
2342   return                                       unless $self->{id};
2343   croak ("wrong call, no valid table defined") unless $table =~ /^(oe|ar|ap|delivery_orders|parts)$/;
2344
2345   my $query       = "SELECT mtime, itime FROM " . $table . " WHERE id = ?";
2346   my $ref         = selectfirst_hashref_query($self, $dbh, $query, $self->{id});
2347   $ref->{mtime} ||= $ref->{itime};
2348   $self->{lastmtime} = $ref->{mtime};
2349
2350 }
2351
2352 sub mtime_ischanged {
2353   my ($self, $table, $option) = @_;
2354
2355   return                                       unless $self->{id};
2356   croak ("wrong call, no valid table defined") unless $table =~ /^(oe|ar|ap|delivery_orders|parts)$/;
2357
2358   my $query       = "SELECT mtime, itime FROM " . $table . " WHERE id = ?";
2359   my $ref         = selectfirst_hashref_query($self, $self->get_standard_dbh, $query, $self->{id});
2360   $ref->{mtime} ||= $ref->{itime};
2361
2362   if ($self->{lastmtime} && $self->{lastmtime} ne $ref->{mtime} ) {
2363       $self->error(($option eq 'mail') ?
2364         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") :
2365         t8("The document has been changed by another user. Please reopen it in another window and copy the changes to the new window")
2366       );
2367     $::dispatcher->end_request;
2368   }
2369 }
2370
2371 # language_payment duplicates some of the functionality of all_vc (language,
2372 # printer, payment_terms), and at least in the case of sales invoices both
2373 # all_vc and language_payment are called when adding new invoices
2374 sub language_payment {
2375   $main::lxdebug->enter_sub();
2376
2377   my ($self, $myconfig) = @_;
2378
2379   my $dbh = $self->get_standard_dbh($myconfig);
2380   # get languages
2381   my $query = qq|SELECT id, description
2382                  FROM language
2383                  ORDER BY id|;
2384
2385   $self->{languages} = selectall_hashref_query($self, $dbh, $query);
2386
2387   # get printer
2388   $query = qq|SELECT printer_description, id
2389               FROM printers
2390               ORDER BY printer_description|;
2391
2392   $self->{printers} = selectall_hashref_query($self, $dbh, $query);
2393
2394   # get payment terms
2395   $query = qq|SELECT id, description
2396               FROM payment_terms
2397               WHERE ( obsolete IS FALSE OR id = ? )
2398               ORDER BY sortkey |;
2399   $self->{payment_terms} = selectall_hashref_query($self, $dbh, $query, $self->{payment_id} || undef);
2400
2401   # get buchungsgruppen
2402   $query = qq|SELECT id, description
2403               FROM buchungsgruppen|;
2404
2405   $self->{BUCHUNGSGRUPPEN} = selectall_hashref_query($self, $dbh, $query);
2406
2407   $main::lxdebug->leave_sub();
2408 }
2409
2410 # this is only used for reports
2411 sub all_departments {
2412   $main::lxdebug->enter_sub();
2413
2414   my ($self, $myconfig, $table) = @_;
2415
2416   my $dbh = $self->get_standard_dbh($myconfig);
2417
2418   my $query = qq|SELECT id, description
2419                  FROM department
2420                  ORDER BY description|;
2421   $self->{all_departments} = selectall_hashref_query($self, $dbh, $query);
2422
2423   delete($self->{all_departments}) unless (@{ $self->{all_departments} || [] });
2424
2425   $main::lxdebug->leave_sub();
2426 }
2427
2428 sub create_links {
2429   $main::lxdebug->enter_sub();
2430
2431   my ($self, $module, $myconfig, $table, $provided_dbh) = @_;
2432
2433   my ($fld, $arap);
2434   if ($table eq "customer") {
2435     $fld = "buy";
2436     $arap = "ar";
2437   } else {
2438     $table = "vendor";
2439     $fld = "sell";
2440     $arap = "ap";
2441   }
2442
2443   # get last customers or vendors
2444   my ($query, $sth, $ref);
2445
2446   my $dbh = $provided_dbh ? $provided_dbh : $self->get_standard_dbh($myconfig);
2447   my %xkeyref = ();
2448
2449   if (!$self->{id}) {
2450
2451     my $transdate = "current_date";
2452     if ($self->{transdate}) {
2453       $transdate = $dbh->quote($self->{transdate});
2454     }
2455
2456     # now get the account numbers
2457     $query = qq|
2458       SELECT c.accno, c.description, c.link, c.taxkey_id, c.id AS chart_id, tk2.tax_id
2459         FROM chart c
2460         -- find newest entries in taxkeys
2461         INNER JOIN (
2462           SELECT chart_id, MAX(startdate) AS startdate
2463           FROM taxkeys
2464           WHERE (startdate <= $transdate)
2465           GROUP BY chart_id
2466         ) tk ON (c.id = tk.chart_id)
2467         -- and load all of those entries
2468         INNER JOIN taxkeys tk2
2469            ON (tk.chart_id = tk2.chart_id AND tk.startdate = tk2.startdate)
2470        WHERE (c.link LIKE ?)
2471       ORDER BY c.accno|;
2472
2473     $sth = $dbh->prepare($query);
2474
2475     do_statement($self, $sth, $query, like($module));
2476
2477     $self->{accounts} = "";
2478     while ($ref = $sth->fetchrow_hashref("NAME_lc")) {
2479
2480       foreach my $key (split(/:/, $ref->{link})) {
2481         if ($key =~ /\Q$module\E/) {
2482
2483           # cross reference for keys
2484           $xkeyref{ $ref->{accno} } = $key;
2485
2486           push @{ $self->{"${module}_links"}{$key} },
2487             { accno       => $ref->{accno},
2488               chart_id    => $ref->{chart_id},
2489               description => $ref->{description},
2490               taxkey      => $ref->{taxkey_id},
2491               tax_id      => $ref->{tax_id} };
2492
2493           $self->{accounts} .= "$ref->{accno} " unless $key =~ /tax/;
2494         }
2495       }
2496     }
2497   }
2498
2499   # get taxkeys and description
2500   $query = qq|SELECT id, taxkey, taxdescription FROM tax|;
2501   $self->{TAXKEY} = selectall_hashref_query($self, $dbh, $query);
2502
2503   if (($module eq "AP") || ($module eq "AR")) {
2504     # get tax rates and description
2505     $query = qq|SELECT * FROM tax|;
2506     $self->{TAX} = selectall_hashref_query($self, $dbh, $query);
2507   }
2508
2509   my $extra_columns = '';
2510   $extra_columns   .= 'a.direct_debit, ' if ($module eq 'AR') || ($module eq 'AP');
2511
2512   if ($self->{id}) {
2513     $query =
2514       qq|SELECT
2515            a.cp_id, a.invnumber, a.transdate, a.${table}_id, a.datepaid, a.deliverydate,
2516            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,
2517            a.mtime, a.itime,
2518            a.intnotes, a.department_id, a.amount AS oldinvtotal,
2519            a.paid AS oldtotalpaid, a.employee_id, a.gldate, a.type,
2520            a.globalproject_id, ${extra_columns}
2521            c.name AS $table,
2522            d.description AS department,
2523            e.name AS employee
2524          FROM $arap a
2525          JOIN $table c ON (a.${table}_id = c.id)
2526          LEFT JOIN employee e ON (e.id = a.employee_id)
2527          LEFT JOIN department d ON (d.id = a.department_id)
2528          WHERE a.id = ?|;
2529     $ref = selectfirst_hashref_query($self, $dbh, $query, $self->{id});
2530
2531     foreach my $key (keys %$ref) {
2532       $self->{$key} = $ref->{$key};
2533     }
2534     $self->{mtime}   ||= $self->{itime};
2535     $self->{lastmtime} = $self->{mtime};
2536     my $transdate = "current_date";
2537     if ($self->{transdate}) {
2538       $transdate = $dbh->quote($self->{transdate});
2539     }
2540
2541     # now get the account numbers
2542     $query = qq|SELECT c.accno, c.description, c.link, c.taxkey_id, c.id AS chart_id, tk.tax_id
2543                 FROM chart c
2544                 LEFT JOIN taxkeys tk ON (tk.chart_id = c.id)
2545                 WHERE c.link LIKE ?
2546                   AND (tk.id = (SELECT id FROM taxkeys WHERE taxkeys.chart_id = c.id AND startdate <= $transdate ORDER BY startdate DESC LIMIT 1)
2547                     OR c.link LIKE '%_tax%' OR c.taxkey_id IS NULL)
2548                 ORDER BY c.accno|;
2549
2550     $sth = $dbh->prepare($query);
2551     do_statement($self, $sth, $query, like($module));
2552
2553     $self->{accounts} = "";
2554     while ($ref = $sth->fetchrow_hashref("NAME_lc")) {
2555
2556       foreach my $key (split(/:/, $ref->{link})) {
2557         if ($key =~ /\Q$module\E/) {
2558
2559           # cross reference for keys
2560           $xkeyref{ $ref->{accno} } = $key;
2561
2562           push @{ $self->{"${module}_links"}{$key} },
2563             { accno       => $ref->{accno},
2564               chart_id    => $ref->{chart_id},
2565               description => $ref->{description},
2566               taxkey      => $ref->{taxkey_id},
2567               tax_id      => $ref->{tax_id} };
2568
2569           $self->{accounts} .= "$ref->{accno} " unless $key =~ /tax/;
2570         }
2571       }
2572     }
2573
2574
2575     # get amounts from individual entries
2576     $query =
2577       qq|SELECT
2578            c.accno, c.description,
2579            a.acc_trans_id, a.source, a.amount, a.memo, a.transdate, a.gldate, a.cleared, a.project_id, a.taxkey, a.chart_id,
2580            p.projectnumber,
2581            t.rate, t.id
2582          FROM acc_trans a
2583          LEFT JOIN chart c ON (c.id = a.chart_id)
2584          LEFT JOIN project p ON (p.id = a.project_id)
2585          LEFT JOIN tax t ON (t.id= a.tax_id)
2586          WHERE a.trans_id = ?
2587          AND a.fx_transaction = '0'
2588          ORDER BY a.acc_trans_id, a.transdate|;
2589     $sth = $dbh->prepare($query);
2590     do_statement($self, $sth, $query, $self->{id});
2591
2592     # get exchangerate for currency
2593     $self->{exchangerate} =
2594       $self->get_exchangerate($dbh, $self->{currency}, $self->{transdate}, $fld);
2595     my $index = 0;
2596
2597     # store amounts in {acc_trans}{$key} for multiple accounts
2598     while (my $ref = $sth->fetchrow_hashref("NAME_lc")) {
2599       $ref->{exchangerate} =
2600         $self->get_exchangerate($dbh, $self->{currency}, $ref->{transdate}, $fld);
2601       if (!($xkeyref{ $ref->{accno} } =~ /tax/)) {
2602         $index++;
2603       }
2604       if (($xkeyref{ $ref->{accno} } =~ /paid/) && ($self->{type} eq "credit_note")) {
2605         $ref->{amount} *= -1;
2606       }
2607       $ref->{index} = $index;
2608
2609       push @{ $self->{acc_trans}{ $xkeyref{ $ref->{accno} } } }, $ref;
2610     }
2611
2612     $sth->finish;
2613     #check das:
2614     $query =
2615       qq|SELECT
2616            d.closedto, d.revtrans,
2617            (SELECT cu.name FROM currencies cu WHERE cu.id=d.currency_id) AS defaultcurrency,
2618            (SELECT c.accno FROM chart c WHERE d.fxgain_accno_id = c.id) AS fxgain_accno,
2619            (SELECT c.accno FROM chart c WHERE d.fxloss_accno_id = c.id) AS fxloss_accno,
2620            (SELECT c.accno FROM chart c WHERE d.rndgain_accno_id = c.id) AS rndgain_accno,
2621            (SELECT c.accno FROM chart c WHERE d.rndloss_accno_id = c.id) AS rndloss_accno
2622          FROM defaults d|;
2623     $ref = selectfirst_hashref_query($self, $dbh, $query);
2624     map { $self->{$_} = $ref->{$_} } keys %$ref;
2625
2626   } else {
2627
2628     # get date
2629     $query =
2630        qq|SELECT
2631             current_date AS transdate, d.closedto, d.revtrans,
2632             (SELECT cu.name FROM currencies cu WHERE cu.id=d.currency_id) AS defaultcurrency,
2633             (SELECT c.accno FROM chart c WHERE d.fxgain_accno_id = c.id) AS fxgain_accno,
2634             (SELECT c.accno FROM chart c WHERE d.fxloss_accno_id = c.id) AS fxloss_accno,
2635             (SELECT c.accno FROM chart c WHERE d.rndgain_accno_id = c.id) AS rndgain_accno,
2636             (SELECT c.accno FROM chart c WHERE d.rndloss_accno_id = c.id) AS rndloss_accno
2637           FROM defaults d|;
2638     $ref = selectfirst_hashref_query($self, $dbh, $query);
2639     map { $self->{$_} = $ref->{$_} } keys %$ref;
2640
2641     if ($self->{"$self->{vc}_id"}) {
2642
2643       # only setup currency
2644       ($self->{currency}) = $self->{defaultcurrency} if !$self->{currency};
2645
2646     } else {
2647
2648       $self->lastname_used($dbh, $myconfig, $table, $module);
2649
2650       # get exchangerate for currency
2651       $self->{exchangerate} =
2652         $self->get_exchangerate($dbh, $self->{currency}, $self->{transdate}, $fld);
2653
2654     }
2655
2656   }
2657
2658   $main::lxdebug->leave_sub();
2659 }
2660
2661 sub lastname_used {
2662   $main::lxdebug->enter_sub();
2663
2664   my ($self, $dbh, $myconfig, $table, $module) = @_;
2665
2666   my ($arap, $where);
2667
2668   $table         = $table eq "customer" ? "customer" : "vendor";
2669   my %column_map = ("a.${table}_id"           => "${table}_id",
2670                     "a.department_id"         => "department_id",
2671                     "d.description"           => "department",
2672                     "ct.name"                 => $table,
2673                     "cu.name"                 => "currency",
2674     );
2675
2676   if ($self->{type} =~ /delivery_order/) {
2677     $arap  = 'delivery_orders';
2678     delete $column_map{"cu.currency"};
2679
2680   } elsif ($self->{type} =~ /_order/) {
2681     $arap  = 'oe';
2682     $where = "quotation = '0'";
2683
2684   } elsif ($self->{type} =~ /_quotation/) {
2685     $arap  = 'oe';
2686     $where = "quotation = '1'";
2687
2688   } elsif ($table eq 'customer') {
2689     $arap  = 'ar';
2690
2691   } else {
2692     $arap  = 'ap';
2693
2694   }
2695
2696   $where           = "($where) AND" if ($where);
2697   my $query        = qq|SELECT MAX(id) FROM $arap
2698                         WHERE $where ${table}_id > 0|;
2699   my ($trans_id)   = selectrow_query($self, $dbh, $query);
2700   $trans_id       *= 1;
2701
2702   my $column_spec  = join(', ', map { "${_} AS $column_map{$_}" } keys %column_map);
2703   $query           = qq|SELECT $column_spec
2704                         FROM $arap a
2705                         LEFT JOIN $table     ct ON (a.${table}_id = ct.id)
2706                         LEFT JOIN department d  ON (a.department_id = d.id)
2707                         LEFT JOIN currencies cu ON (cu.id=ct.currency_id)
2708                         WHERE a.id = ?|;
2709   my $ref          = selectfirst_hashref_query($self, $dbh, $query, $trans_id);
2710
2711   map { $self->{$_} = $ref->{$_} } values %column_map;
2712
2713   $main::lxdebug->leave_sub();
2714 }
2715
2716 sub get_variable_content_types {
2717   my ($self) = @_;
2718
2719   my %html_variables = (
2720     longdescription  => 'html',
2721     partnotes        => 'html',
2722     notes            => 'html',
2723     orignotes        => 'html',
2724     notes1           => 'html',
2725     notes2           => 'html',
2726     notes3           => 'html',
2727     notes4           => 'html',
2728     header_text      => 'html',
2729     footer_text      => 'html',
2730   );
2731
2732   return {
2733     %html_variables,
2734     $self->get_variable_content_types_for_cvars,
2735   };
2736 }
2737
2738 sub get_variable_content_types_for_cvars {
2739   my ($self)       = @_;
2740   my $html_configs = SL::DB::Manager::CustomVariableConfig->get_all(where => [ type => 'htmlfield' ]);
2741   my %types;
2742
2743   if (@{ $html_configs }) {
2744     my %prefix_by_module = (
2745       Contacts => 'cp_cvar_',
2746       CT       => 'vc_cvar_',
2747       IC       => 'ic_cvar_',
2748       Projects => 'project_cvar_',
2749       ShipTo   => 'shiptocvar_',
2750     );
2751
2752     foreach my $cfg (@{ $html_configs }) {
2753       my $prefix = $prefix_by_module{$cfg->module};
2754       $types{$prefix . $cfg->name} = 'html' if $prefix;
2755     }
2756   }
2757
2758   return %types;
2759 }
2760
2761 sub current_date {
2762   $main::lxdebug->enter_sub();
2763
2764   my $self     = shift;
2765   my $myconfig = shift || \%::myconfig;
2766   my ($thisdate, $days) = @_;
2767
2768   my $dbh = $self->get_standard_dbh($myconfig);
2769   my $query;
2770
2771   $days *= 1;
2772   if ($thisdate) {
2773     my $dateformat = $myconfig->{dateformat};
2774     $dateformat .= "yy" if $myconfig->{dateformat} !~ /^y/;
2775     $thisdate = $dbh->quote($thisdate);
2776     $query = qq|SELECT to_date($thisdate, '$dateformat') + $days AS thisdate|;
2777   } else {
2778     $query = qq|SELECT current_date AS thisdate|;
2779   }
2780
2781   ($thisdate) = selectrow_query($self, $dbh, $query);
2782
2783   $main::lxdebug->leave_sub();
2784
2785   return $thisdate;
2786 }
2787
2788 sub redo_rows {
2789   $main::lxdebug->enter_sub();
2790
2791   my ($self, $flds, $new, $count, $numrows) = @_;
2792
2793   my @ndx = ();
2794
2795   map { push @ndx, { num => $new->[$_ - 1]->{runningnumber}, ndx => $_ } } 1 .. $count;
2796
2797   my $i = 0;
2798
2799   # fill rows
2800   foreach my $item (sort { $a->{num} <=> $b->{num} } @ndx) {
2801     $i++;
2802     my $j = $item->{ndx} - 1;
2803     map { $self->{"${_}_$i"} = $new->[$j]->{$_} } @{$flds};
2804   }
2805
2806   # delete empty rows
2807   for $i ($count + 1 .. $numrows) {
2808     map { delete $self->{"${_}_$i"} } @{$flds};
2809   }
2810
2811   $main::lxdebug->leave_sub();
2812 }
2813
2814 sub update_status {
2815   $main::lxdebug->enter_sub();
2816
2817   my ($self, $myconfig) = @_;
2818
2819   my ($i, $id);
2820
2821   SL::DB->client->with_transaction(sub {
2822     my $dbh = SL::DB->client->dbh;
2823
2824     my $query = qq|DELETE FROM status
2825                    WHERE (formname = ?) AND (trans_id = ?)|;
2826     my $sth = prepare_query($self, $dbh, $query);
2827
2828     if ($self->{formname} =~ /(check|receipt)/) {
2829       for $i (1 .. $self->{rowcount}) {
2830         do_statement($self, $sth, $query, $self->{formname}, $self->{"id_$i"} * 1);
2831       }
2832     } else {
2833       do_statement($self, $sth, $query, $self->{formname}, $self->{id});
2834     }
2835     $sth->finish();
2836
2837     my $printed = ($self->{printed} =~ /\Q$self->{formname}\E/) ? "1" : "0";
2838     my $emailed = ($self->{emailed} =~ /\Q$self->{formname}\E/) ? "1" : "0";
2839
2840     my %queued = split / /, $self->{queued};
2841     my @values;
2842
2843     if ($self->{formname} =~ /(check|receipt)/) {
2844
2845       # this is a check or receipt, add one entry for each lineitem
2846       my ($accno) = split /--/, $self->{account};
2847       $query = qq|INSERT INTO status (trans_id, printed, spoolfile, formname, chart_id)
2848                   VALUES (?, ?, ?, ?, (SELECT c.id FROM chart c WHERE c.accno = ?))|;
2849       @values = ($printed, $queued{$self->{formname}}, $self->{prinform}, $accno);
2850       $sth = prepare_query($self, $dbh, $query);
2851
2852       for $i (1 .. $self->{rowcount}) {
2853         if ($self->{"checked_$i"}) {
2854           do_statement($self, $sth, $query, $self->{"id_$i"}, @values);
2855         }
2856       }
2857       $sth->finish();
2858
2859     } else {
2860       $query = qq|INSERT INTO status (trans_id, printed, emailed, spoolfile, formname)
2861                   VALUES (?, ?, ?, ?, ?)|;
2862       do_query($self, $dbh, $query, $self->{id}, $printed, $emailed,
2863                $queued{$self->{formname}}, $self->{formname});
2864     }
2865     1;
2866   }) or do { die SL::DB->client->error };
2867
2868   $main::lxdebug->leave_sub();
2869 }
2870
2871 sub save_status {
2872   $main::lxdebug->enter_sub();
2873
2874   my ($self, $dbh) = @_;
2875
2876   my ($query, $printed, $emailed);
2877
2878   my $formnames  = $self->{printed};
2879   my $emailforms = $self->{emailed};
2880
2881   $query = qq|DELETE FROM status
2882                  WHERE (formname = ?) AND (trans_id = ?)|;
2883   do_query($self, $dbh, $query, $self->{formname}, $self->{id});
2884
2885   # this only applies to the forms
2886   # checks and receipts are posted when printed or queued
2887
2888   if ($self->{queued}) {
2889     my %queued = split / /, $self->{queued};
2890
2891     foreach my $formname (keys %queued) {
2892       $printed = ($self->{printed} =~ /\Q$self->{formname}\E/) ? "1" : "0";
2893       $emailed = ($self->{emailed} =~ /\Q$self->{formname}\E/) ? "1" : "0";
2894
2895       $query = qq|INSERT INTO status (trans_id, printed, emailed, spoolfile, formname)
2896                   VALUES (?, ?, ?, ?, ?)|;
2897       do_query($self, $dbh, $query, $self->{id}, $printed, $emailed, $queued{$formname}, $formname);
2898
2899       $formnames  =~ s/\Q$self->{formname}\E//;
2900       $emailforms =~ s/\Q$self->{formname}\E//;
2901
2902     }
2903   }
2904
2905   # save printed, emailed info
2906   $formnames  =~ s/^ +//g;
2907   $emailforms =~ s/^ +//g;
2908
2909   my %status = ();
2910   map { $status{$_}{printed} = 1 } split / +/, $formnames;
2911   map { $status{$_}{emailed} = 1 } split / +/, $emailforms;
2912
2913   foreach my $formname (keys %status) {
2914     $printed = ($formnames  =~ /\Q$self->{formname}\E/) ? "1" : "0";
2915     $emailed = ($emailforms =~ /\Q$self->{formname}\E/) ? "1" : "0";
2916
2917     $query = qq|INSERT INTO status (trans_id, printed, emailed, formname)
2918                 VALUES (?, ?, ?, ?)|;
2919     do_query($self, $dbh, $query, $self->{id}, $printed, $emailed, $formname);
2920   }
2921
2922   $main::lxdebug->leave_sub();
2923 }
2924
2925 #--- 4 locale ---#
2926 # $main::locale->text('SAVED')
2927 # $main::locale->text('SCREENED')
2928 # $main::locale->text('DELETED')
2929 # $main::locale->text('ADDED')
2930 # $main::locale->text('PAYMENT POSTED')
2931 # $main::locale->text('POSTED')
2932 # $main::locale->text('POSTED AS NEW')
2933 # $main::locale->text('ELSE')
2934 # $main::locale->text('SAVED FOR DUNNING')
2935 # $main::locale->text('DUNNING STARTED')
2936 # $main::locale->text('PREVIEWED')
2937 # $main::locale->text('PRINTED')
2938 # $main::locale->text('MAILED')
2939 # $main::locale->text('SCREENED')
2940 # $main::locale->text('CANCELED')
2941 # $main::locale->text('IMPORT')
2942 # $main::locale->text('UNDO TRANSFER')
2943 # $main::locale->text('UNIMPORT')
2944 # $main::locale->text('invoice')
2945 # $main::locale->text('proforma')
2946 # $main::locale->text('sales_order')
2947 # $main::locale->text('pick_list')
2948 # $main::locale->text('purchase_order')
2949 # $main::locale->text('bin_list')
2950 # $main::locale->text('sales_quotation')
2951 # $main::locale->text('request_quotation')
2952
2953 sub save_history {
2954   $main::lxdebug->enter_sub();
2955
2956   my $self = shift;
2957   my $dbh  = shift || SL::DB->client->dbh;
2958   SL::DB->client->with_transaction(sub {
2959
2960     if(!exists $self->{employee_id}) {
2961       &get_employee($self, $dbh);
2962     }
2963
2964     my $query =
2965      qq|INSERT INTO history_erp (trans_id, employee_id, addition, what_done, snumbers) | .
2966      qq|VALUES (?, (SELECT id FROM employee WHERE login = ?), ?, ?, ?)|;
2967     my @values = (conv_i($self->{id}), $self->{login},
2968                   $self->{addition}, $self->{what_done}, "$self->{snumbers}");
2969     do_query($self, $dbh, $query, @values);
2970     1;
2971   }) or do { die SL::DB->client->error };
2972
2973   $main::lxdebug->leave_sub();
2974 }
2975
2976 sub get_history {
2977   $main::lxdebug->enter_sub();
2978
2979   my ($self, $dbh, $trans_id, $restriction, $order) = @_;
2980   my ($orderBy, $desc) = split(/\-\-/, $order);
2981   $order = " ORDER BY " . ($order eq "" ? " h.itime " : ($desc == 1 ? $orderBy . " DESC " : $orderBy . " "));
2982   my @tempArray;
2983   my $i = 0;
2984   if ($trans_id ne "") {
2985     my $query =
2986       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 | .
2987       qq|FROM history_erp h | .
2988       qq|LEFT JOIN employee emp ON (emp.id = h.employee_id) | .
2989       qq|WHERE (trans_id = | . $dbh->quote($trans_id) . qq|) $restriction | .
2990       $order;
2991
2992     my $sth = $dbh->prepare($query) || $self->dberror($query);
2993
2994     $sth->execute() || $self->dberror("$query");
2995
2996     while(my $hash_ref = $sth->fetchrow_hashref()) {
2997       $hash_ref->{addition} = $main::locale->text($hash_ref->{addition});
2998       $hash_ref->{what_done} = $main::locale->text($hash_ref->{what_done});
2999       my ( $what, $number ) = split /_/, $hash_ref->{snumbers};
3000       $hash_ref->{snumbers} = $number;
3001       $hash_ref->{haslink}  = 'controller.pl?action=EmailJournal/show&id='.$number if $what eq 'emailjournal';
3002       $hash_ref->{snumbers} = $main::locale->text("E-Mail").' '.$number if $what eq 'emailjournal';
3003       $tempArray[$i++] = $hash_ref;
3004     }
3005     $main::lxdebug->leave_sub() and return \@tempArray
3006       if ($i > 0 && $tempArray[0] ne "");
3007   }
3008   $main::lxdebug->leave_sub();
3009   return 0;
3010 }
3011
3012 sub get_partsgroup {
3013   $main::lxdebug->enter_sub();
3014
3015   my ($self, $myconfig, $p) = @_;
3016   my $target = $p->{target} || 'all_partsgroup';
3017
3018   my $dbh = $self->get_standard_dbh($myconfig);
3019
3020   my $query = qq|SELECT DISTINCT pg.id, pg.partsgroup
3021                  FROM partsgroup pg
3022                  JOIN parts p ON (p.partsgroup_id = pg.id) |;
3023   my @values;
3024
3025   if ($p->{searchitems} eq 'part') {
3026     $query .= qq|WHERE p.part_type = 'part'|;
3027   }
3028   if ($p->{searchitems} eq 'service') {
3029     $query .= qq|WHERE p.part_type = 'service'|;
3030   }
3031   if ($p->{searchitems} eq 'assembly') {
3032     $query .= qq|WHERE p.part_type = 'assembly'|;
3033   }
3034
3035   $query .= qq|ORDER BY partsgroup|;
3036
3037   if ($p->{all}) {
3038     $query = qq|SELECT id, partsgroup FROM partsgroup
3039                 ORDER BY partsgroup|;
3040   }
3041
3042   if ($p->{language_code}) {
3043     $query = qq|SELECT DISTINCT pg.id, pg.partsgroup,
3044                   t.description AS translation
3045                 FROM partsgroup pg
3046                 JOIN parts p ON (p.partsgroup_id = pg.id)
3047                 LEFT JOIN translation t ON ((t.trans_id = pg.id) AND (t.language_code = ?))
3048                 ORDER BY translation|;
3049     @values = ($p->{language_code});
3050   }
3051
3052   $self->{$target} = selectall_hashref_query($self, $dbh, $query, @values);
3053
3054   $main::lxdebug->leave_sub();
3055 }
3056
3057 sub get_pricegroup {
3058   $main::lxdebug->enter_sub();
3059
3060   my ($self, $myconfig, $p) = @_;
3061
3062   my $dbh = $self->get_standard_dbh($myconfig);
3063
3064   my $query = qq|SELECT p.id, p.pricegroup
3065                  FROM pricegroup p|;
3066
3067   $query .= qq| ORDER BY pricegroup|;
3068
3069   if ($p->{all}) {
3070     $query = qq|SELECT id, pricegroup FROM pricegroup
3071                 ORDER BY pricegroup|;
3072   }
3073
3074   $self->{all_pricegroup} = selectall_hashref_query($self, $dbh, $query);
3075
3076   $main::lxdebug->leave_sub();
3077 }
3078
3079 sub all_years {
3080 # usage $form->all_years($myconfig, [$dbh])
3081 # return list of all years where bookings found
3082 # (@all_years)
3083
3084   $main::lxdebug->enter_sub();
3085
3086   my ($self, $myconfig, $dbh) = @_;
3087
3088   $dbh ||= $self->get_standard_dbh($myconfig);
3089
3090   # get years
3091   my $query = qq|SELECT (SELECT MIN(transdate) FROM acc_trans),
3092                    (SELECT MAX(transdate) FROM acc_trans)|;
3093   my ($startdate, $enddate) = selectrow_query($self, $dbh, $query);
3094
3095   if ($myconfig->{dateformat} =~ /^yy/) {
3096     ($startdate) = split /\W/, $startdate;
3097     ($enddate) = split /\W/, $enddate;
3098   } else {
3099     (@_) = split /\W/, $startdate;
3100     $startdate = $_[2];
3101     (@_) = split /\W/, $enddate;
3102     $enddate = $_[2];
3103   }
3104
3105   my @all_years;
3106   $startdate = substr($startdate,0,4);
3107   $enddate = substr($enddate,0,4);
3108
3109   while ($enddate >= $startdate) {
3110     push @all_years, $enddate--;
3111   }
3112
3113   return @all_years;
3114
3115   $main::lxdebug->leave_sub();
3116 }
3117
3118 sub backup_vars {
3119   $main::lxdebug->enter_sub();
3120   my $self = shift;
3121   my @vars = @_;
3122
3123   map { $self->{_VAR_BACKUP}->{$_} = $self->{$_} if exists $self->{$_} } @vars;
3124
3125   $main::lxdebug->leave_sub();
3126 }
3127
3128 sub restore_vars {
3129   $main::lxdebug->enter_sub();
3130
3131   my $self = shift;
3132   my @vars = @_;
3133
3134   map { $self->{$_} = $self->{_VAR_BACKUP}->{$_} if exists $self->{_VAR_BACKUP}->{$_} } @vars;
3135
3136   $main::lxdebug->leave_sub();
3137 }
3138
3139 sub prepare_for_printing {
3140   my ($self) = @_;
3141
3142   my $defaults         = SL::DB::Default->get;
3143
3144   $self->{templates} ||= $defaults->templates;
3145   $self->{formname}  ||= $self->{type};
3146   $self->{media}     ||= 'email';
3147
3148   die "'media' other than 'email', 'file', 'printer' is not supported yet" unless $self->{media} =~ m/^(?:email|file|printer)$/;
3149
3150   # Several fields that used to reside in %::myconfig (stored in
3151   # auth.user_config) are now stored in defaults. Copy them over for
3152   # compatibility.
3153   $self->{$_} = $defaults->$_ for qw(company address taxnumber co_ustid duns sepa_creditor_id);
3154
3155   $self->{"myconfig_${_}"} = $::myconfig{$_} for grep { $_ ne 'dbpasswd' } keys %::myconfig;
3156
3157   if (!$self->{employee_id}) {
3158     $self->{"employee_${_}"} = $::myconfig{$_} for qw(email tel fax name signature);
3159     $self->{"employee_${_}"} = $defaults->$_   for qw(address businessnumber co_ustid company duns sepa_creditor_id taxnumber);
3160   }
3161
3162   my $language = $self->{language} ? '_' . $self->{language} : '';
3163
3164   my ($language_tc, $output_numberformat, $output_dateformat, $output_longdates);
3165   if ($self->{language_id}) {
3166     ($language_tc, $output_numberformat, $output_dateformat, $output_longdates) = AM->get_language_details(\%::myconfig, $self, $self->{language_id});
3167   }
3168
3169   $output_dateformat   ||= $::myconfig{dateformat};
3170   $output_numberformat ||= $::myconfig{numberformat};
3171   $output_longdates    //= 1;
3172
3173   $self->{myconfig_output_dateformat}   = $output_dateformat   // $::myconfig{dateformat};
3174   $self->{myconfig_output_longdates}    = $output_longdates    // 1;
3175   $self->{myconfig_output_numberformat} = $output_numberformat // $::myconfig{numberformat};
3176
3177   # Retrieve accounts for tax calculation.
3178   IC->retrieve_accounts(\%::myconfig, $self, map { $_ => $self->{"id_$_"} } 1 .. $self->{rowcount});
3179
3180   if ($self->{type} =~ /_delivery_order$/) {
3181     DO->order_details(\%::myconfig, $self);
3182   } elsif ($self->{type} =~ /sales_order|sales_quotation|request_quotation|purchase_order/) {
3183     OE->order_details(\%::myconfig, $self);
3184   } else {
3185     IS->invoice_details(\%::myconfig, $self, $::locale);
3186   }
3187
3188   $self->set_addition_billing_address_print_variables;
3189
3190   # Chose extension & set source file name
3191   my $extension = 'html';
3192   if ($self->{format} eq 'postscript') {
3193     $self->{postscript}   = 1;
3194     $extension            = 'tex';
3195   } elsif ($self->{"format"} =~ /pdf/) {
3196     $self->{pdf}          = 1;
3197     $extension            = $self->{'format'} =~ m/opendocument/i ? 'odt' : 'tex';
3198   } elsif ($self->{"format"} =~ /opendocument/) {
3199     $self->{opendocument} = 1;
3200     $extension            = 'odt';
3201   } elsif ($self->{"format"} =~ /excel/) {
3202     $self->{excel}        = 1;
3203     $extension            = 'xls';
3204   }
3205
3206   my $printer_code    = $self->{printer_code} ? '_' . $self->{printer_code} : '';
3207   my $email_extension = $self->{media} eq 'email' && -f ($defaults->templates . "/$self->{formname}_email${language}.${extension}") ? '_email' : '';
3208   $self->{IN}         = "$self->{formname}${email_extension}${language}${printer_code}.${extension}";
3209
3210   # Format dates.
3211   $self->format_dates($output_dateformat, $output_longdates,
3212                       qw(invdate orddate quodate pldate duedate reqdate transdate tax_point shippingdate deliverydate validitydate paymentdate datepaid
3213                          transdate_oe deliverydate_oe employee_startdate employee_enddate),
3214                       grep({ /^(?:datepaid|transdate_oe|reqdate|deliverydate|deliverydate_oe|transdate)_\d+$/ } keys(%{$self})));
3215
3216   $self->reformat_numbers($output_numberformat, 2,
3217                           qw(invtotal ordtotal quototal subtotal linetotal listprice sellprice netprice discount tax taxbase total paid),
3218                           grep({ /^(?:linetotal|listprice|sellprice|netprice|taxbase|discount|paid|subtotal|total|tax)_\d+$/ } keys(%{$self})));
3219
3220   $self->reformat_numbers($output_numberformat, undef, qw(qty price_factor), grep({ /^qty_\d+$/} keys(%{$self})));
3221
3222   my ($cvar_date_fields, $cvar_number_fields) = CVar->get_field_format_list('module' => 'CT', 'prefix' => 'vc_');
3223
3224   if (scalar @{ $cvar_date_fields }) {
3225     $self->format_dates($output_dateformat, $output_longdates, @{ $cvar_date_fields });
3226   }
3227
3228   while (my ($precision, $field_list) = each %{ $cvar_number_fields }) {
3229     $self->reformat_numbers($output_numberformat, $precision, @{ $field_list });
3230   }
3231
3232   # Translate units
3233   if (($self->{language} // '') ne '') {
3234     my $template_arrays = $self->{TEMPLATE_ARRAYS} || $self;
3235     for my $idx (0..scalar(@{ $template_arrays->{unit} }) - 1) {
3236       $template_arrays->{unit}->[$idx] = AM->translate_units($self, $self->{language}, $template_arrays->{unit}->[$idx], $template_arrays->{qty}->[$idx])
3237     }
3238   }
3239
3240   $self->{template_meta} = {
3241     formname  => $self->{formname},
3242     language  => SL::DB::Manager::Language->find_by_or_create(id => $self->{language_id} || undef),
3243     format    => $self->{format},
3244     media     => $self->{media},
3245     extension => $extension,
3246     printer   => SL::DB::Manager::Printer->find_by_or_create(id => $self->{printer_id} || undef),
3247     today     => DateTime->today,
3248   };
3249
3250   if ($defaults->print_interpolate_variables_in_positions) {
3251     $self->substitute_placeholders_in_template_arrays({ field => 'description', type => 'text' }, { field => 'longdescription', type => 'html' });
3252   }
3253
3254   return $self;
3255 }
3256
3257 sub set_addition_billing_address_print_variables {
3258   my ($self) = @_;
3259
3260   return if !$self->{billing_address_id};
3261
3262   my $address = SL::DB::Manager::AdditionalBillingAddress->find_by(id => $self->{billing_address_id});
3263   return if !$address;
3264
3265   $self->{"billing_address_${_}"} = $address->$_ for map { $_->name } @{ $address->meta->columns };
3266 }
3267
3268 sub substitute_placeholders_in_template_arrays {
3269   my ($self, @fields) = @_;
3270
3271   foreach my $spec (@fields) {
3272     $spec     = { field => $spec, type => 'text' } if !ref($spec);
3273     my $field = $spec->{field};
3274
3275     next unless exists $self->{TEMPLATE_ARRAYS} && exists $self->{TEMPLATE_ARRAYS}->{$field};
3276
3277     my $tag_start = $spec->{type} eq 'html' ? '&lt;%' : '<%';
3278     my $tag_end   = $spec->{type} eq 'html' ? '%&gt;' : '%>';
3279     my $formatter = $spec->{type} eq 'html' ? sub { $::locale->quote_special_chars('html', $_[0] // '') } : sub { $_[0] };
3280
3281     $self->{TEMPLATE_ARRAYS}->{$field} = [
3282       apply { s{${tag_start}(.+?)${tag_end}}{ $formatter->($self->{$1}) }eg }
3283         @{ $self->{TEMPLATE_ARRAYS}->{$field} }
3284     ];
3285   }
3286
3287   return $self;
3288 }
3289
3290 sub calculate_arap {
3291   my ($self,$buysell,$taxincluded,$exchangerate,$roundplaces) = @_;
3292
3293   # this function is used to calculate netamount, total_tax and amount for AP and
3294   # AR transactions (Kreditoren-/Debitorenbuchungen) by going over all lines
3295   # (1..$rowcount)
3296   # Thus it needs a fully prepared $form to work on.
3297   # calculate_arap assumes $form->{amount_$i} entries still need to be parsed
3298
3299   # The calculated total values are all rounded (default is to 2 places) and
3300   # returned as parameters rather than directly modifying form.  The aim is to
3301   # make the calculation of AP and AR behave identically.  There is a test-case
3302   # for this function in t/form/arap.t
3303
3304   # While calculating the totals $form->{amount_$i} and $form->{tax_$i} are
3305   # modified and formatted and receive the correct sign for writing straight to
3306   # acc_trans, depending on whether they are ar or ap.
3307
3308   # check parameters
3309   die "taxincluded needed in Form->calculate_arap" unless defined $taxincluded;
3310   die "exchangerate needed in Form->calculate_arap" unless defined $exchangerate;
3311   die 'illegal buysell parameter, has to be \"buy\" or \"sell\" in Form->calculate_arap\n' unless $buysell =~ /^(buy|sell)$/;
3312   $roundplaces = 2 unless $roundplaces;
3313
3314   my $sign = 1;  # adjust final results for writing amount to acc_trans
3315   $sign = -1 if $buysell eq 'buy';
3316
3317   my ($netamount,$total_tax,$amount);
3318
3319   my $tax;
3320
3321   # parse and round amounts, setting correct sign for writing to acc_trans
3322   for my $i (1 .. $self->{rowcount}) {
3323     $self->{"amount_$i"} = $self->round_amount($self->parse_amount(\%::myconfig, $self->{"amount_$i"}) * $exchangerate * $sign, $roundplaces);
3324
3325     $amount += $self->{"amount_$i"} * $sign;
3326   }
3327
3328   for my $i (1 .. $self->{rowcount}) {
3329     next unless $self->{"amount_$i"};
3330     ($self->{"tax_id_$i"}) = split /--/, $self->{"taxchart_$i"};
3331     my $tax_id = $self->{"tax_id_$i"};
3332
3333     my $selected_tax = SL::DB::Manager::Tax->find_by(id => "$tax_id");
3334
3335     if ( $selected_tax ) {
3336
3337       if ( $buysell eq 'sell' ) {
3338         $self->{AR_amounts}{"tax_$i"} = $selected_tax->chart->accno if defined $selected_tax->chart;
3339       } else {
3340         $self->{AP_amounts}{"tax_$i"} = $selected_tax->chart->accno if defined $selected_tax->chart;
3341       };
3342
3343       $self->{"taxkey_$i"} = $selected_tax->taxkey;
3344       $self->{"taxrate_$i"} = $selected_tax->rate;
3345     };
3346
3347     ($self->{"amount_$i"}, $self->{"tax_$i"}) = $self->calculate_tax($self->{"amount_$i"},$self->{"taxrate_$i"},$taxincluded,$roundplaces);
3348
3349     $netamount  += $self->{"amount_$i"};
3350     $total_tax  += $self->{"tax_$i"};
3351
3352   }
3353   $amount = $netamount + $total_tax;
3354
3355   # due to $sign amount_$i und tax_$i already have the right sign for acc_trans
3356   # but reverse sign of totals for writing amounts to ar
3357   if ( $buysell eq 'buy' ) {
3358     $netamount *= -1;
3359     $amount    *= -1;
3360     $total_tax *= -1;
3361   };
3362
3363   return($netamount,$total_tax,$amount);
3364 }
3365
3366 sub format_dates {
3367   my ($self, $dateformat, $longformat, @indices) = @_;
3368
3369   $dateformat ||= $::myconfig{dateformat};
3370
3371   foreach my $idx (@indices) {
3372     if ($self->{TEMPLATE_ARRAYS} && (ref($self->{TEMPLATE_ARRAYS}->{$idx}) eq "ARRAY")) {
3373       for (my $i = 0; $i < scalar(@{ $self->{TEMPLATE_ARRAYS}->{$idx} }); $i++) {
3374         $self->{TEMPLATE_ARRAYS}->{$idx}->[$i] = $::locale->reformat_date(\%::myconfig, $self->{TEMPLATE_ARRAYS}->{$idx}->[$i], $dateformat, $longformat);
3375       }
3376     }
3377
3378     next unless defined $self->{$idx};
3379
3380     if (!ref($self->{$idx})) {
3381       $self->{$idx} = $::locale->reformat_date(\%::myconfig, $self->{$idx}, $dateformat, $longformat);
3382
3383     } elsif (ref($self->{$idx}) eq "ARRAY") {
3384       for (my $i = 0; $i < scalar(@{ $self->{$idx} }); $i++) {
3385         $self->{$idx}->[$i] = $::locale->reformat_date(\%::myconfig, $self->{$idx}->[$i], $dateformat, $longformat);
3386       }
3387     }
3388   }
3389 }
3390
3391 sub reformat_numbers {
3392   my ($self, $numberformat, $places, @indices) = @_;
3393
3394   return if !$numberformat || ($numberformat eq $::myconfig{numberformat});
3395
3396   foreach my $idx (@indices) {
3397     if ($self->{TEMPLATE_ARRAYS} && (ref($self->{TEMPLATE_ARRAYS}->{$idx}) eq "ARRAY")) {
3398       for (my $i = 0; $i < scalar(@{ $self->{TEMPLATE_ARRAYS}->{$idx} }); $i++) {
3399         $self->{TEMPLATE_ARRAYS}->{$idx}->[$i] = $self->parse_amount(\%::myconfig, $self->{TEMPLATE_ARRAYS}->{$idx}->[$i]);
3400       }
3401     }
3402
3403     next unless defined $self->{$idx};
3404
3405     if (!ref($self->{$idx})) {
3406       $self->{$idx} = $self->parse_amount(\%::myconfig, $self->{$idx});
3407
3408     } elsif (ref($self->{$idx}) eq "ARRAY") {
3409       for (my $i = 0; $i < scalar(@{ $self->{$idx} }); $i++) {
3410         $self->{$idx}->[$i] = $self->parse_amount(\%::myconfig, $self->{$idx}->[$i]);
3411       }
3412     }
3413   }
3414
3415   my $saved_numberformat    = $::myconfig{numberformat};
3416   $::myconfig{numberformat} = $numberformat;
3417
3418   foreach my $idx (@indices) {
3419     if ($self->{TEMPLATE_ARRAYS} && (ref($self->{TEMPLATE_ARRAYS}->{$idx}) eq "ARRAY")) {
3420       for (my $i = 0; $i < scalar(@{ $self->{TEMPLATE_ARRAYS}->{$idx} }); $i++) {
3421         $self->{TEMPLATE_ARRAYS}->{$idx}->[$i] = $self->format_amount(\%::myconfig, $self->{TEMPLATE_ARRAYS}->{$idx}->[$i], $places);
3422       }
3423     }
3424
3425     next unless defined $self->{$idx};
3426
3427     if (!ref($self->{$idx})) {
3428       $self->{$idx} = $self->format_amount(\%::myconfig, $self->{$idx}, $places);
3429
3430     } elsif (ref($self->{$idx}) eq "ARRAY") {
3431       for (my $i = 0; $i < scalar(@{ $self->{$idx} }); $i++) {
3432         $self->{$idx}->[$i] = $self->format_amount(\%::myconfig, $self->{$idx}->[$i], $places);
3433       }
3434     }
3435   }
3436
3437   $::myconfig{numberformat} = $saved_numberformat;
3438 }
3439
3440 sub create_email_signature {
3441
3442   my $client_signature = $::instance_conf->get_signature;
3443   my $user_signature   = $::myconfig{signature};
3444
3445   my $signature = '';
3446   if ( $client_signature or $user_signature ) {
3447     $signature  = "\n\n-- \n";
3448     $signature .= $user_signature   . "\n" if $user_signature;
3449     $signature .= $client_signature . "\n" if $client_signature;
3450   };
3451   return $signature;
3452
3453 };
3454
3455 sub calculate_tax {
3456   # this function calculates the net amount and tax for the lines in ar, ap and
3457   # gl and is used for update as well as post. When used with update the return
3458   # value of amount isn't needed
3459
3460   # calculate_tax should always work with positive values, or rather as the user inputs them
3461   # calculate_tax uses db/perl numberformat, i.e. parsed numbers
3462   # convert to negative numbers (when necessary) only when writing to acc_trans
3463   # the amount from $form for ap/ar/gl is currently always rounded to 2 decimals before it reaches here
3464   # for post_transaction amount already contains exchangerate and correct sign and is rounded
3465   # calculate_tax doesn't (need to) know anything about exchangerate
3466
3467   my ($self,$amount,$taxrate,$taxincluded,$roundplaces) = @_;
3468
3469   $roundplaces //= 2;
3470   $taxincluded //= 0;
3471
3472   my $tax;
3473
3474   if ($taxincluded) {
3475     # calculate tax (unrounded), subtract from amount, round amount and round tax
3476     $tax       = $amount - ($amount / ($taxrate + 1)); # equivalent to: taxrate * amount / (taxrate + 1)
3477     $amount    = $self->round_amount($amount - $tax, $roundplaces);
3478     $tax       = $self->round_amount($tax, $roundplaces);
3479   } else {
3480     $tax       = $amount * $taxrate;
3481     $tax       = $self->round_amount($tax, $roundplaces);
3482   }
3483
3484   $tax = 0 unless $tax;
3485
3486   return ($amount,$tax);
3487 };
3488
3489 1;
3490
3491 __END__
3492
3493 =head1 NAME
3494
3495 SL::Form.pm - main data object.
3496
3497 =head1 SYNOPSIS
3498
3499 This is the main data object of kivitendo.
3500 Unfortunately it also acts as a god object for certain data retrieval procedures used in the entry points.
3501 Points of interest for a beginner are:
3502
3503  - $form->error            - renders a generic error in html. accepts an error message
3504  - $form->get_standard_dbh - returns a database connection for the
3505
3506 =head1 SPECIAL FUNCTIONS
3507
3508 =head2 C<redirect_header> $url
3509
3510 Generates a HTTP redirection header for the new C<$url>. Constructs an
3511 absolute URL including scheme, host name and port. If C<$url> is a
3512 relative URL then it is considered relative to kivitendo base URL.
3513
3514 This function C<die>s if headers have already been created with
3515 C<$::form-E<gt>header>.
3516
3517 Examples:
3518
3519   print $::form->redirect_header('oe.pl?action=edit&id=1234');
3520   print $::form->redirect_header('http://www.lx-office.org/');
3521
3522 =head2 C<header>
3523
3524 Generates a general purpose http/html header and includes most of the scripts
3525 and stylesheets needed. Stylesheets can be added with L<use_stylesheet>.
3526
3527 Only one header will be generated. If the method was already called in this
3528 request it will not output anything and return undef. Also if no
3529 HTTP_USER_AGENT is found, no header is generated.
3530
3531 Although header does not accept parameters itself, it will honor special
3532 hashkeys of its Form instance:
3533
3534 =over 4
3535
3536 =item refresh_time
3537
3538 =item refresh_url
3539
3540 If one of these is set, a http-equiv refresh is generated. Missing parameters
3541 default to 3 seconds and the refering url.
3542
3543 =item stylesheet
3544
3545 Either a scalar or an array ref. Will be inlined into the header. Add
3546 stylesheets with the L<use_stylesheet> function.
3547
3548 =item landscape
3549
3550 If true, a css snippet will be generated that sets the page in landscape mode.
3551
3552 =item favicon
3553
3554 Used to override the default favicon.
3555
3556 =item title
3557
3558 A html page title will be generated from this
3559
3560 =item mtime_ischanged
3561
3562 Tries to avoid concurrent write operations to records by checking the database mtime with a fetched one.
3563
3564 Can be used / called with any table, that has itime and mtime attributes.
3565 Valid C<table> names are: oe, ar, ap, delivery_orders, parts.
3566 Can be called wit C<option> mail to generate a different error message.
3567
3568 Returns undef if no save operation has been done yet ($self->{id} not present).
3569 Returns undef if no concurrent write process is detected otherwise a error message.
3570
3571 =back
3572
3573 =cut