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