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