SL/Form.pm

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