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