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