SL/Form.pm

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