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