SL/Form.pm

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