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