SL/Form.pm

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