1 #=====================================================================
4 # Based on SQL-Ledger Version 2.1.9
5 # Web http://www.lx-office.org
7 #=====================================================================
8 # SQL-Ledger Accounting
9 # Copyright (C) 1998-2002
11 # Author: Dieter Simader
12 # Email: dsimader@sql-ledger.org
13 # Web: http://www.sql-ledger.org
15 # Contributors: Thomas Bayen <bayen@gmx.de>
16 # Antti Kaihola <akaihola@siba.fi>
17 # Moritz Bunkus (tex code)
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.
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,
32 #======================================================================
33 # Utilities for parsing forms
34 # and supporting routines for linking account numbers
35 # used in AR, AP and IS, IR modules
37 #======================================================================
53 use POSIX qw(strftime);
65 use SL::DB::PaymentTerm;
68 use SL::Helper::Flash qw();
71 use SL::Layout::Dispatcher;
73 use SL::Locale::String;
76 use SL::MoreCommon qw(uri_encode uri_decode);
78 use SL::PrefixedNumber;
87 use List::Util qw(first max min sum);
88 use List::MoreUtils qw(all any apply);
90 use SL::Helper::File qw(:all);
91 use SL::Helper::CreatePDF qw(merge_pdfs);
96 SL::Version->get_version;
100 $main::lxdebug->enter_sub();
107 if ($LXDebug::watch_form) {
108 require SL::Watchdog;
109 tie %{ $self }, 'SL::Watchdog';
114 $main::lxdebug->leave_sub();
119 sub _flatten_variables_rec {
120 $main::lxdebug->enter_sub(2);
129 if ('' eq ref $curr->{$key}) {
130 @result = ({ 'key' => $prefix . $key, 'value' => $curr->{$key} });
132 } elsif ('HASH' eq ref $curr->{$key}) {
133 foreach my $hash_key (sort keys %{ $curr->{$key} }) {
134 push @result, $self->_flatten_variables_rec($curr->{$key}, $prefix . $key . '.', $hash_key);
138 foreach my $idx (0 .. scalar @{ $curr->{$key} } - 1) {
139 my $first_array_entry = 1;
141 my $element = $curr->{$key}[$idx];
143 if ('HASH' eq ref $element) {
144 foreach my $hash_key (sort keys %{ $element }) {
145 push @result, $self->_flatten_variables_rec($element, $prefix . $key . ($first_array_entry ? '[+].' : '[].'), $hash_key);
146 $first_array_entry = 0;
149 push @result, { 'key' => $prefix . $key . '[]', 'value' => $element };
154 $main::lxdebug->leave_sub(2);
159 sub flatten_variables {
160 $main::lxdebug->enter_sub(2);
168 push @variables, $self->_flatten_variables_rec($self, '', $_);
171 $main::lxdebug->leave_sub(2);
176 sub flatten_standard_variables {
177 $main::lxdebug->enter_sub(2);
180 my %skip_keys = map { $_ => 1 } (qw(login password header stylesheet titlebar), @_);
184 foreach (grep { ! $skip_keys{$_} } keys %{ $self }) {
185 push @variables, $self->_flatten_variables_rec($self, '', $_);
188 $main::lxdebug->leave_sub(2);
194 my ($self, $str) = @_;
196 return uri_encode($str);
200 my ($self, $str) = @_;
202 return uri_decode($str);
206 $main::lxdebug->enter_sub();
207 my ($self, $str) = @_;
209 if ($str && !ref($str)) {
210 $str =~ s/\"/"/g;
213 $main::lxdebug->leave_sub();
219 $main::lxdebug->enter_sub();
220 my ($self, $str) = @_;
222 if ($str && !ref($str)) {
223 $str =~ s/"/\"/g;
226 $main::lxdebug->leave_sub();
232 $main::lxdebug->enter_sub();
236 map({ print($::request->{cgi}->hidden("-name" => $_, "-default" => $self->{$_}) . "\n"); } @_);
238 for (sort keys %$self) {
239 next if (($_ eq "header") || (ref($self->{$_}) ne ""));
240 print($::request->{cgi}->hidden("-name" => $_, "-default" => $self->{$_}) . "\n");
243 $main::lxdebug->leave_sub();
247 my ($self, $code) = @_;
248 local $self->{__ERROR_HANDLER} = sub { SL::X::FormError->throw(error => $_[0]) };
253 $main::lxdebug->enter_sub();
255 $main::lxdebug->show_backtrace();
257 my ($self, $msg) = @_;
259 if ($self->{__ERROR_HANDLER}) {
260 $self->{__ERROR_HANDLER}->($msg);
262 } elsif ($ENV{HTTP_USER_AGENT}) {
264 $self->show_generic_error($msg);
267 confess "Error: $msg\n";
270 $main::lxdebug->leave_sub();
274 $main::lxdebug->enter_sub();
276 my ($self, $msg) = @_;
278 if ($ENV{HTTP_USER_AGENT}) {
280 print $self->parse_html_template('generic/form_info', { message => $msg });
282 } elsif ($self->{info_function}) {
283 &{ $self->{info_function} }($msg);
288 $main::lxdebug->leave_sub();
291 # calculates the number of rows in a textarea based on the content and column number
292 # can be capped with maxrows
294 $main::lxdebug->enter_sub();
295 my ($self, $str, $cols, $maxrows, $minrows) = @_;
299 my $rows = sum map { int((length() - 2) / $cols) + 1 } split /\r/, $str;
302 $main::lxdebug->leave_sub();
304 return max(min($rows, $maxrows), $minrows);
308 my ($self, $msg) = @_;
310 SL::X::DBError->throw(
312 db_error => $DBI::errstr,
317 $main::lxdebug->enter_sub();
319 my ($self, $name, $msg) = @_;
322 foreach my $part (split m/\./, $name) {
323 if (!$curr->{$part} || ($curr->{$part} =~ /^\s*$/)) {
326 $curr = $curr->{$part};
329 $main::lxdebug->leave_sub();
332 sub _get_request_uri {
335 return URI->new($ENV{HTTP_REFERER})->canonical() if $ENV{HTTP_X_FORWARDED_FOR};
336 return URI->new if !$ENV{REQUEST_URI}; # for testing
338 my $scheme = $::request->is_https ? 'https' : 'http';
339 my $port = $ENV{SERVER_PORT};
340 $port = undef if (($scheme eq 'http' ) && ($port == 80))
341 || (($scheme eq 'https') && ($port == 443));
343 my $uri = URI->new("${scheme}://");
344 $uri->scheme($scheme);
346 $uri->host($ENV{HTTP_HOST} || $ENV{SERVER_ADDR});
347 $uri->path_query($ENV{REQUEST_URI});
353 sub _add_to_request_uri {
356 my $relative_new_path = shift;
357 my $request_uri = shift || $self->_get_request_uri;
358 my $relative_new_uri = URI->new($relative_new_path);
359 my @request_segments = $request_uri->path_segments;
361 my $new_uri = $request_uri->clone;
362 $new_uri->path_segments(@request_segments[0..scalar(@request_segments) - 2], $relative_new_uri->path_segments);
367 sub create_http_response {
368 $main::lxdebug->enter_sub();
373 my $cgi = $::request->{cgi};
376 if (defined $main::auth) {
377 my $uri = $self->_get_request_uri;
378 my @segments = $uri->path_segments;
380 $uri->path_segments(@segments);
382 my $session_cookie_value = $main::auth->get_session_id();
384 if ($session_cookie_value) {
385 $session_cookie = $cgi->cookie('-name' => $main::auth->get_session_cookie_name(),
386 '-value' => $session_cookie_value,
387 '-path' => $uri->path,
388 '-secure' => $::request->is_https);
392 my %cgi_params = ('-type' => $params{content_type});
393 $cgi_params{'-charset'} = $params{charset} if ($params{charset});
394 $cgi_params{'-cookie'} = $session_cookie if ($session_cookie);
396 map { $cgi_params{'-' . $_} = $params{$_} if exists $params{$_} } qw(content_disposition content_length status);
398 my $output = $cgi->header(%cgi_params);
400 $main::lxdebug->leave_sub();
406 $::lxdebug->enter_sub;
408 my ($self, %params) = @_;
411 $::lxdebug->leave_sub and return if !$ENV{HTTP_USER_AGENT} || $self->{header}++;
413 if ($params{no_layout}) {
414 $::request->{layout} = SL::Layout::Dispatcher->new(style => 'none');
417 my $layout = $::request->{layout};
419 # standard css for all
420 # this should gradually move to the layouts that need it
421 $layout->use_stylesheet("$_.css") for qw(
422 common main menu list_accounts jquery.autocomplete
423 jquery.multiselect2side
424 ui-lightness/jquery-ui
426 tooltipster themes/tooltipster-light
429 $layout->use_javascript("$_.js") for (qw(
430 jquery jquery-ui jquery.cookie jquery.checkall jquery.download
431 jquery/jquery.form jquery/fixes client_js
432 jquery/jquery.tooltipster.min
433 common part_selection
434 ), "jquery/ui/i18n/jquery.ui.datepicker-$::myconfig{countrycode}");
436 $self->{favicon} ||= "favicon.ico";
437 $self->{titlebar} = join ' - ', grep $_, $self->{title}, $self->{login}, $::myconfig{dbname}, $self->read_version if $self->{title} || !$self->{titlebar};
440 if ($self->{refresh_url} || $self->{refresh_time}) {
441 my $refresh_time = $self->{refresh_time} || 3;
442 my $refresh_url = $self->{refresh_url} || $ENV{REFERER};
443 push @header, "<meta http-equiv='refresh' content='$refresh_time;$refresh_url'>";
446 my $auto_reload_resources_param = $layout->auto_reload_resources_param;
448 push @header, map { qq|<link rel="stylesheet" href="${_}${auto_reload_resources_param}" type="text/css" title="Stylesheet">| } $layout->stylesheets;
449 push @header, "<style type='text/css'>\@page { size:landscape; }</style> " if $self->{landscape};
450 push @header, "<link rel='shortcut icon' href='$self->{favicon}' type='image/x-icon'>" if -f $self->{favicon};
451 push @header, map { qq|<script type="text/javascript" src="${_}${auto_reload_resources_param}"></script>| } $layout->javascripts;
452 push @header, $self->{javascript} if $self->{javascript};
453 push @header, map { $_->show_javascript } @{ $self->{AJAX} || [] };
456 strict => qq|<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">|,
457 transitional => qq|<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">|,
458 frameset => qq|<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">|,
459 html5 => qq|<!DOCTYPE html>|,
463 print $self->create_http_response(content_type => 'text/html', charset => 'UTF-8');
464 print $doctypes{$params{doctype} || 'transitional'}, $/;
468 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
469 <title>$self->{titlebar}</title>
471 print " $_\n" for @header;
473 <meta name="robots" content="noindex,nofollow">
478 print $::request->{layout}->pre_content;
479 print $::request->{layout}->start_content;
481 $layout->header_done;
483 $::lxdebug->leave_sub;
487 return unless $::request->{layout}->need_footer;
489 print $::request->{layout}->end_content;
490 print $::request->{layout}->post_content;
492 if (my @inline_scripts = $::request->{layout}->javascripts_inline) {
493 print "<script type='text/javascript'>" . join("; ", @inline_scripts) . "</script>\n";
502 sub ajax_response_header {
503 $main::lxdebug->enter_sub();
507 my $output = $::request->{cgi}->header('-charset' => 'UTF-8');
509 $main::lxdebug->leave_sub();
514 sub redirect_header {
518 my $base_uri = $self->_get_request_uri;
519 my $new_uri = URI->new_abs($new_url, $base_uri);
521 die "Headers already sent" if $self->{header};
524 return $::request->{cgi}->redirect($new_uri);
527 sub set_standard_title {
528 $::lxdebug->enter_sub;
531 $self->{titlebar} = "kivitendo " . $::locale->text('Version') . " " . $self->read_version;
532 $self->{titlebar} .= "- $::myconfig{name}" if $::myconfig{name};
533 $self->{titlebar} .= "- $::myconfig{dbname}" if $::myconfig{name};
535 $::lxdebug->leave_sub;
538 sub _prepare_html_template {
539 $main::lxdebug->enter_sub();
541 my ($self, $file, $additional_params) = @_;
544 if (!%::myconfig || !$::myconfig{"countrycode"}) {
545 $language = $::lx_office_conf{system}->{language};
547 $language = $main::myconfig{"countrycode"};
549 $language = "de" unless ($language);
551 if (-f "templates/webpages/${file}.html") {
552 $file = "templates/webpages/${file}.html";
554 } elsif (ref $file eq 'SCALAR') {
555 # file is a scalarref, use inline mode
557 my $info = "Web page template '${file}' not found.\n";
559 print qq|<pre>$info</pre>|;
560 $::dispatcher->end_request;
563 $additional_params->{AUTH} = $::auth;
564 $additional_params->{INSTANCE_CONF} = $::instance_conf;
565 $additional_params->{LOCALE} = $::locale;
566 $additional_params->{LXCONFIG} = \%::lx_office_conf;
567 $additional_params->{LXDEBUG} = $::lxdebug;
568 $additional_params->{MYCONFIG} = \%::myconfig;
570 $main::lxdebug->leave_sub();
575 sub parse_html_template {
576 $main::lxdebug->enter_sub();
578 my ($self, $file, $additional_params) = @_;
580 $additional_params ||= { };
582 my $real_file = $self->_prepare_html_template($file, $additional_params);
583 my $template = $self->template;
585 map { $additional_params->{$_} ||= $self->{$_} } keys %{ $self };
588 $template->process($real_file, $additional_params, \$output) || die $template->error;
590 $main::lxdebug->leave_sub();
595 sub template { $::request->presenter->get_template }
597 sub show_generic_error {
598 $main::lxdebug->enter_sub();
600 my ($self, $error, %params) = @_;
602 if ($self->{__ERROR_HANDLER}) {
603 $self->{__ERROR_HANDLER}->($error);
604 $main::lxdebug->leave_sub();
608 if ($::request->is_ajax) {
611 ->render(SL::Controller::Base->new);
612 $::dispatcher->end_request;
616 'title_error' => $params{title},
617 'label_error' => $error,
620 $self->{title} = $params{title} if $params{title};
622 for my $bar ($::request->layout->get('actionbar')) {
626 call => [ 'kivi.history_back' ],
627 accesskey => 'enter',
633 print $self->parse_html_template("generic/error", $add_params);
635 print STDERR "Error: $error\n";
637 $main::lxdebug->leave_sub();
639 $::dispatcher->end_request;
642 sub show_generic_information {
643 $main::lxdebug->enter_sub();
645 my ($self, $text, $title) = @_;
648 'title_information' => $title,
649 'label_information' => $text,
652 $self->{title} = $title if ($title);
655 print $self->parse_html_template("generic/information", $add_params);
657 $main::lxdebug->leave_sub();
659 $::dispatcher->end_request;
662 sub _store_redirect_info_in_session {
665 return unless $self->{callback} =~ m:^ ( [^\?/]+ \.pl ) \? (.+) :x;
667 my ($controller, $params) = ($1, $2);
668 my $form = { map { map { $self->unescape($_) } split /=/, $_, 2 } split m/\&/, $params };
669 $self->{callback} = "${controller}?RESTORE_FORM_FROM_SESSION_ID=" . $::auth->save_form_in_session(form => $form);
673 $main::lxdebug->enter_sub();
675 my ($self, $msg) = @_;
677 if (!$self->{callback}) {
681 SL::Helper::Flash::flash_later('info', $msg) if $msg;
682 $self->_store_redirect_info_in_session;
683 print $::form->redirect_header($self->{callback});
686 $::dispatcher->end_request;
688 $main::lxdebug->leave_sub();
691 # sort of columns removed - empty sub
693 $main::lxdebug->enter_sub();
695 my ($self, @columns) = @_;
697 $main::lxdebug->leave_sub();
703 $main::lxdebug->enter_sub(2);
705 my ($self, $myconfig, $amount, $places, $dash) = @_;
708 my $neg = $amount < 0;
709 my $force_places = defined $places && $places >= 0;
711 $amount = $self->round_amount($amount, abs $places) if $force_places;
712 $neg = 0 if $amount == 0; # don't show negative zero
713 $amount = sprintf "%.*f", ($force_places ? $places : 10), abs $amount; # 6 is default for %fa
715 # before the sprintf amount was a number, afterwards it's a string. because of the dynamic nature of perl
716 # this is easy to confuse, so keep in mind: before this comment no s///, m//, concat or other strong ops on
717 # $amount. after this comment no +,-,*,/,abs. it will only introduce subtle bugs.
719 $amount =~ s/0*$// unless defined $places && $places == 0; # cull trailing 0s
721 my @d = map { s/\d//g; reverse split // } my $tmp = $myconfig->{numberformat}; # get delim chars
722 my @p = split(/\./, $amount); # split amount at decimal point
724 $p[0] =~ s/\B(?=(...)*$)/$d[1]/g if $d[1]; # add 1,000 delimiters
726 if ($places || $p[1]) {
729 . (0 x max(abs($places || 0) - length ($p[1]||''), 0)); # pad the fraction
733 ($dash =~ /-/) ? ($neg ? "($amount)" : "$amount" ) :
734 ($dash =~ /DRCR/) ? ($neg ? "$amount " . $main::locale->text('DR') : "$amount " . $main::locale->text('CR') ) :
735 ($neg ? "-$amount" : "$amount" ) ;
738 $main::lxdebug->leave_sub(2);
742 sub format_amount_units {
743 $main::lxdebug->enter_sub();
748 my $myconfig = \%main::myconfig;
749 my $amount = $params{amount} * 1;
750 my $places = $params{places};
751 my $part_unit_name = $params{part_unit};
752 my $amount_unit_name = $params{amount_unit};
753 my $conv_units = $params{conv_units};
754 my $max_places = $params{max_places};
756 if (!$part_unit_name) {
757 $main::lxdebug->leave_sub();
761 my $all_units = AM->retrieve_all_units;
763 if (('' eq ref $conv_units) && ($conv_units =~ /convertible/)) {
764 $conv_units = AM->convertible_units($all_units, $part_unit_name, $conv_units eq 'convertible_not_smaller');
767 if (!scalar @{ $conv_units }) {
768 my $result = $self->format_amount($myconfig, $amount, $places, undef, $max_places) . " " . $part_unit_name;
769 $main::lxdebug->leave_sub();
773 my $part_unit = $all_units->{$part_unit_name};
774 my $conv_unit = ($amount_unit_name && ($amount_unit_name ne $part_unit_name)) ? $all_units->{$amount_unit_name} : $part_unit;
776 $amount *= $conv_unit->{factor};
781 foreach my $unit (@$conv_units) {
782 my $last = $unit->{name} eq $part_unit->{name};
784 $num = int($amount / $unit->{factor});
785 $amount -= $num * $unit->{factor};
788 if ($last ? $amount : $num) {
789 push @values, { "unit" => $unit->{name},
790 "amount" => $last ? $amount / $unit->{factor} : $num,
791 "places" => $last ? $places : 0 };
798 push @values, { "unit" => $part_unit_name,
803 my $result = join " ", map { $self->format_amount($myconfig, $_->{amount}, $_->{places}, undef, $max_places), $_->{unit} } @values;
805 $main::lxdebug->leave_sub();
811 $main::lxdebug->enter_sub(2);
816 $input =~ s/(^|[^\#]) \# (\d+) /$1$_[$2 - 1]/gx;
817 $input =~ s/(^|[^\#]) \#\{(\d+)\}/$1$_[$2 - 1]/gx;
818 $input =~ s/\#\#/\#/g;
820 $main::lxdebug->leave_sub(2);
828 $main::lxdebug->enter_sub(2);
830 my ($self, $myconfig, $amount) = @_;
832 if (!defined($amount) || ($amount eq '')) {
833 $main::lxdebug->leave_sub(2);
837 if ( ($myconfig->{numberformat} eq '1.000,00')
838 || ($myconfig->{numberformat} eq '1000,00')) {
843 if ($myconfig->{numberformat} eq "1'000.00") {
849 $main::lxdebug->leave_sub(2);
851 # Make sure no code wich is not a math expression ends up in eval().
852 return 0 unless $amount =~ /^ [\s \d \( \) \- \+ \* \/ \. ]* $/x;
854 # Prevent numbers from being parsed as octals;
855 $amount =~ s{ (?<! [\d.] ) 0+ (?= [1-9] ) }{}gx;
857 return scalar(eval($amount)) * 1 ;
861 my ($self, $amount, $places, $adjust) = @_;
863 return 0 if !defined $amount;
868 my $precision = $::instance_conf->get_precision || 0.01;
869 return $self->round_amount( $self->round_amount($amount / $precision, 0) * $precision, $places);
872 # We use Perl's knowledge of string representation for
873 # rounding. First, convert the floating point number to a string
874 # with a high number of places. Then split the string on the decimal
875 # sign and use integer calculation for rounding the decimal places
876 # part. If an overflow occurs then apply that overflow to the part
877 # before the decimal sign as well using integer arithmetic again.
879 my $int_amount = int(abs $amount);
880 my $str_places = max(min(10, 16 - length("$int_amount") - $places), $places);
881 my $amount_str = sprintf '%.*f', $places + $str_places, abs($amount);
883 return $amount unless $amount_str =~ m{^(\d+)\.(\d+)$};
885 my ($pre, $post) = ($1, $2);
886 my $decimals = '1' . substr($post, 0, $places);
888 my $propagation_limit = $Config{i32size} == 4 ? 7 : 18;
889 my $add_for_rounding = substr($post, $places, 1) >= 5 ? 1 : 0;
891 if ($places > $propagation_limit) {
892 $decimals = Math::BigInt->new($decimals)->badd($add_for_rounding);
893 $pre = Math::BigInt->new($decimals)->badd(1) if substr($decimals, 0, 1) eq '2';
896 $decimals += $add_for_rounding;
897 $pre += 1 if substr($decimals, 0, 1) eq '2';
900 $amount = ("${pre}." . substr($decimals, 1)) * ($amount <=> 0);
906 $main::lxdebug->enter_sub();
908 my ($self, $myconfig) = @_;
909 my ($out, $out_mode);
913 my $defaults = SL::DB::Default->get;
915 my $keep_temp_files = $::lx_office_conf{debug} && $::lx_office_conf{debug}->{keep_temp_files};
916 $self->{cwd} = getcwd();
917 my $temp_dir = File::Temp->newdir(
918 "kivitendo-print-XXXXXX",
919 DIR => $self->{cwd} . "/" . $::lx_office_conf{paths}->{userspath},
920 CLEANUP => !$keep_temp_files,
923 my $userspath = File::Spec->abs2rel($temp_dir->dirname);
924 $self->{tmpdir} = $temp_dir->dirname;
929 if ($self->{"format"} =~ /(opendocument|oasis)/i) {
930 $template_type = 'OpenDocument';
931 $ext_for_format = $self->{"format"} =~ m/pdf/ ? 'pdf' : 'odt';
933 } elsif ($self->{"format"} =~ /(postscript|pdf)/i) {
934 $template_type = 'LaTeX';
935 $ext_for_format = 'pdf';
937 } elsif (($self->{"format"} =~ /html/i) || (!$self->{"format"} && ($self->{"IN"} =~ /html$/i))) {
938 $template_type = 'HTML';
939 $ext_for_format = 'html';
941 } elsif ( $self->{"format"} =~ /excel/i ) {
942 $template_type = 'Excel';
943 $ext_for_format = 'xls';
945 } elsif ( defined $self->{'format'}) {
946 $self->error("Outputformat not defined. This may be a future feature: $self->{'format'}");
948 } elsif ( $self->{'format'} eq '' ) {
949 $self->error("No Outputformat given: $self->{'format'}");
951 } else { #Catch the rest
952 $self->error("Outputformat not defined: $self->{'format'}");
955 my $template = SL::Template::create(type => $template_type,
956 file_name => $self->{IN},
958 myconfig => $myconfig,
959 userspath => $userspath,
960 %{ $self->{TEMPLATE_DRIVER_OPTIONS} || {} });
962 # Copy the notes from the invoice/sales order etc. back to the variable "notes" because that is where most templates expect it to be.
963 $self->{"notes"} = $self->{ $self->{"formname"} . "notes" } if exists $self->{ $self->{"formname"} . "notes" };
965 if (!$self->{employee_id}) {
966 $self->{"employee_${_}"} = $myconfig->{$_} for qw(email tel fax name signature);
967 $self->{"employee_${_}"} = $defaults->$_ for qw(address businessnumber co_ustid company duns sepa_creditor_id taxnumber);
970 $self->{"myconfig_${_}"} = $myconfig->{$_} for grep { $_ ne 'dbpasswd' } keys %{ $myconfig };
971 $self->{$_} = $defaults->$_ for qw(co_ustid);
972 $self->{"myconfig_${_}"} = $defaults->$_ for qw(address businessnumber co_ustid company duns sepa_creditor_id taxnumber);
973 $self->{AUTH} = $::auth;
974 $self->{INSTANCE_CONF} = $::instance_conf;
975 $self->{LOCALE} = $::locale;
976 $self->{LXCONFIG} = $::lx_office_conf;
977 $self->{LXDEBUG} = $::lxdebug;
978 $self->{MYCONFIG} = \%::myconfig;
980 $self->{copies} = 1 if (($self->{copies} *= 1) <= 0);
982 # OUT is used for the media, screen, printer, email
983 # for postscript we store a copy in a temporary file
985 my ($temp_fh, $suffix);
986 $suffix = $self->{IN};
988 ($temp_fh, $self->{tmpfile}) = File::Temp::tempfile(
989 strftime('kivitendo-print-%Y%m%d%H%M%S-XXXXXX', localtime()),
990 SUFFIX => '.' . ($suffix || 'tex'),
992 UNLINK => $keep_temp_files ? 0 : 1,
995 chmod 0644, $self->{tmpfile} if $keep_temp_files;
996 (undef, undef, $self->{template_meta}{tmpfile}) = File::Spec->splitpath( $self->{tmpfile} );
999 $out_mode = $self->{OUT_MODE} || '>';
1000 $self->{OUT} = "$self->{tmpfile}";
1001 $self->{OUT_MODE} = '>';
1004 my $command_formatter = sub {
1005 my ($out_mode, $out) = @_;
1006 return $out_mode eq '|-' ? SL::Template::create(type => 'ShellCommand', form => $self)->parse($out) : $out;
1010 $self->{OUT} = $command_formatter->($self->{OUT_MODE}, $self->{OUT});
1011 open(OUT, $self->{OUT_MODE}, $self->{OUT}) or $self->error("error on opening $self->{OUT} with mode $self->{OUT_MODE} : $!");
1013 *OUT = ($::dispatcher->get_standard_filehandles)[1];
1017 if (!$template->parse(*OUT)) {
1019 $self->error("$self->{IN} : " . $template->get_error());
1022 close OUT if $self->{OUT};
1023 # check only one flag (webdav_documents)
1024 # therefore copy to webdav, even if we do not have the webdav feature enabled (just archive)
1025 my $copy_to_webdav = $::instance_conf->get_webdav_documents && !$self->{preview} && $self->{tmpdir} && $self->{tmpfile} && $self->{type}
1026 && $self->{type} ne 'statement';
1027 if ( $ext_for_format eq 'pdf' && $self->doc_storage_enabled ) {
1028 $self->append_general_pdf_attachments(filepath => $self->{tmpdir}."/".$self->{tmpfile},
1029 type => $self->{type});
1031 if ($self->{media} eq 'file') {
1032 copy(join('/', $self->{cwd}, $userspath, $self->{tmpfile}), $out =~ m|^/| ? $out : join('/', $self->{cwd}, $out)) if $template->uses_temp_file;
1034 if ($copy_to_webdav) {
1035 if (my $error = Common::copy_file_to_webdav_folder($self)) {
1036 chdir("$self->{cwd}");
1037 $self->error($error);
1041 if (!$self->{preview} && $self->doc_storage_enabled)
1043 $self->{attachment_filename} ||= $self->generate_attachment_filename;
1044 $self->store_pdf($self);
1047 chdir("$self->{cwd}");
1049 $::lxdebug->leave_sub();
1054 if ($copy_to_webdav) {
1055 if (my $error = Common::copy_file_to_webdav_folder($self)) {
1056 chdir("$self->{cwd}");
1057 $self->error($error);
1061 if ( !$self->{preview} && $ext_for_format eq 'pdf' && $self->doc_storage_enabled) {
1062 $self->{attachment_filename} ||= $self->generate_attachment_filename;
1063 my $file_obj = $self->store_pdf($self);
1064 $self->{print_file_id} = $file_obj->id if $file_obj;
1066 if ($self->{media} eq 'email') {
1067 if ( getcwd() eq $self->{"tmpdir"} ) {
1068 # in the case of generating pdf we are in the tmpdir, but WHY ???
1069 $self->{tmpfile} = $userspath."/".$self->{tmpfile};
1070 chdir("$self->{cwd}");
1072 $self->send_email(\%::myconfig,$ext_for_format);
1075 $self->{OUT} = $out;
1076 $self->{OUT_MODE} = $out_mode;
1077 $self->output_file($template->get_mime_type,$command_formatter);
1079 delete $self->{print_file_id};
1083 chdir("$self->{cwd}");
1084 $main::lxdebug->leave_sub();
1087 sub get_bcc_defaults {
1088 my ($self, $myconfig, $mybcc) = @_;
1089 if (SL::DB::Default->get->bcc_to_login) {
1090 $mybcc .= ", " if $mybcc;
1091 $mybcc .= $myconfig->{email};
1093 my $otherbcc = SL::DB::Default->get->global_bcc;
1095 $mybcc .= ", " if $mybcc;
1096 $mybcc .= $otherbcc;
1102 $main::lxdebug->enter_sub();
1103 my ($self, $myconfig, $ext_for_format) = @_;
1104 my $mail = Mailer->new;
1106 map { $mail->{$_} = $self->{$_} }
1107 qw(cc subject message format);
1109 $mail->{bcc} = $self->get_bcc_defaults($myconfig, $self->{bcc});
1110 $mail->{to} = $self->{EMAIL_RECIPIENT} ? $self->{EMAIL_RECIPIENT} : $self->{email};
1111 $mail->{from} = qq|"$myconfig->{name}" <$myconfig->{email}>|;
1112 $mail->{fileid} = time() . '.' . $$ . '.';
1113 my $full_signature = $self->create_email_signature();
1114 $full_signature =~ s/\r//g;
1116 $mail->{attachments} = [];
1118 # if we send html or plain text inline
1119 if (($self->{format} eq 'html') && ($self->{sendmode} eq 'inline')) {
1120 $mail->{content_type} = "text/html";
1121 $mail->{message} =~ s/\r//g;
1122 $mail->{message} =~ s{\n}{<br>\n}g;
1123 $full_signature =~ s{\n}{<br>\n}g;
1124 $mail->{message} .= $full_signature;
1126 open(IN, "<", $self->{tmpfile})
1127 or $self->error($self->cleanup . "$self->{tmpfile} : $!");
1128 $mail->{message} .= $_ while <IN>;
1131 } elsif (($self->{attachment_policy} // '') ne 'no_file') {
1132 my $attachment_name = $self->{attachment_filename} || $self->{tmpfile};
1133 $attachment_name =~ s{\.(.+?)$}{.${ext_for_format}} if ($ext_for_format);
1135 if (($self->{attachment_policy} // '') eq 'old_file') {
1136 my ( $attfile ) = SL::File->get_all(object_id => $self->{id},
1137 object_type => $self->{formname},
1138 file_type => 'document');
1141 $attfile->{override_file_name} = $attachment_name if $attachment_name;
1142 push @attfiles, $attfile;
1146 push @{ $mail->{attachments} }, { path => $self->{tmpfile},
1147 id => $self->{print_file_id},
1148 type => "application/pdf",
1149 name => $attachment_name };
1155 map { SL::File->get(id => $_) }
1156 @{ $self->{attach_file_ids} // [] };
1158 foreach my $attfile ( @attfiles ) {
1159 push @{ $mail->{attachments} }, {
1160 path => $attfile->get_file,
1162 type => $attfile->mime_type,
1163 name => $attfile->{override_file_name} // $attfile->file_name,
1164 content => $attfile->get_content ? ${ $attfile->get_content } : undef,
1168 $mail->{message} =~ s/\r//g;
1169 $mail->{message} .= $full_signature;
1170 $self->{emailerr} = $mail->send();
1172 if ($self->{emailerr}) {
1174 $self->error($::locale->text('The email was not sent due to the following error: #1.', $self->{emailerr}));
1177 $self->{email_journal_id} = $mail->{journalentry};
1178 $self->{snumbers} = "emailjournal" . "_" . $self->{email_journal_id};
1179 $self->{what_done} = $::form->{type};
1180 $self->{addition} = "MAILED";
1181 $self->save_history;
1183 #write back for message info and mail journal
1184 $self->{cc} = $mail->{cc};
1185 $self->{bcc} = $mail->{bcc};
1186 $self->{email} = $mail->{to};
1188 $main::lxdebug->leave_sub();
1192 $main::lxdebug->enter_sub();
1194 my ($self,$mimeType,$command_formatter) = @_;
1195 my $numbytes = (-s $self->{tmpfile});
1196 open(IN, "<", $self->{tmpfile})
1197 or $self->error($self->cleanup . "$self->{tmpfile} : $!");
1200 $self->{copies} = 1 unless $self->{media} eq 'printer';
1202 chdir("$self->{cwd}");
1203 for my $i (1 .. $self->{copies}) {
1205 $self->{OUT} = $command_formatter->($self->{OUT_MODE}, $self->{OUT});
1207 open OUT, $self->{OUT_MODE}, $self->{OUT} or $self->error($self->cleanup . "$self->{OUT} : $!");
1208 print OUT $_ while <IN>;
1213 my %headers = ('-type' => $mimeType,
1214 '-connection' => 'close',
1215 '-charset' => 'UTF-8');
1217 $self->{attachment_filename} ||= $self->generate_attachment_filename;
1219 if ($self->{attachment_filename}) {
1222 '-attachment' => $self->{attachment_filename},
1223 '-content-length' => $numbytes,
1228 print $::request->cgi->header(%headers);
1230 $::locale->with_raw_io(\*STDOUT, sub { print while <IN> });
1234 $main::lxdebug->leave_sub();
1237 sub get_formname_translation {
1238 $main::lxdebug->enter_sub();
1239 my ($self, $formname) = @_;
1241 $formname ||= $self->{formname};
1243 $self->{recipient_locale} ||= Locale->lang_to_locale($self->{language});
1244 local $::locale = Locale->new($self->{recipient_locale});
1246 my %formname_translations = (
1247 bin_list => $main::locale->text('Bin List'),
1248 credit_note => $main::locale->text('Credit Note'),
1249 invoice => $main::locale->text('Invoice'),
1250 pick_list => $main::locale->text('Pick List'),
1251 proforma => $main::locale->text('Proforma Invoice'),
1252 purchase_order => $main::locale->text('Purchase Order'),
1253 request_quotation => $main::locale->text('RFQ'),
1254 sales_order => $main::locale->text('Confirmation'),
1255 sales_quotation => $main::locale->text('Quotation'),
1256 storno_invoice => $main::locale->text('Storno Invoice'),
1257 sales_delivery_order => $main::locale->text('Delivery Order'),
1258 purchase_delivery_order => $main::locale->text('Delivery Order'),
1259 dunning => $main::locale->text('Dunning'),
1260 dunning1 => $main::locale->text('Payment Reminder'),
1261 dunning2 => $main::locale->text('Dunning'),
1262 dunning3 => $main::locale->text('Last Dunning'),
1263 dunning_invoice => $main::locale->text('Dunning Invoice'),
1264 letter => $main::locale->text('Letter'),
1265 ic_supply => $main::locale->text('Intra-Community supply'),
1266 statement => $main::locale->text('Statement'),
1269 $main::lxdebug->leave_sub();
1270 return $formname_translations{$formname};
1273 sub get_number_prefix_for_type {
1274 $main::lxdebug->enter_sub();
1278 (first { $self->{type} eq $_ } qw(invoice credit_note)) ? 'inv'
1279 : ($self->{type} =~ /_quotation$/) ? 'quo'
1280 : ($self->{type} =~ /_delivery_order$/) ? 'do'
1281 : ($self->{type} =~ /letter/) ? 'letter'
1284 # better default like this?
1285 # : ($self->{type} =~ /(sales|purcharse)_order/ : 'ord';
1286 # : 'prefix_undefined';
1288 $main::lxdebug->leave_sub();
1292 sub get_extension_for_format {
1293 $main::lxdebug->enter_sub();
1296 my $extension = $self->{format} =~ /pdf/i ? ".pdf"
1297 : $self->{format} =~ /postscript/i ? ".ps"
1298 : $self->{format} =~ /opendocument/i ? ".odt"
1299 : $self->{format} =~ /excel/i ? ".xls"
1300 : $self->{format} =~ /html/i ? ".html"
1303 $main::lxdebug->leave_sub();
1307 sub generate_attachment_filename {
1308 $main::lxdebug->enter_sub();
1311 $self->{recipient_locale} ||= Locale->lang_to_locale($self->{language});
1312 my $recipient_locale = Locale->new($self->{recipient_locale});
1314 my $attachment_filename = $main::locale->unquote_special_chars('HTML', $self->get_formname_translation());
1315 my $prefix = $self->get_number_prefix_for_type();
1317 if ($self->{preview} && (first { $self->{type} eq $_ } qw(invoice credit_note))) {
1318 $attachment_filename .= ' (' . $recipient_locale->text('Preview') . ')' . $self->get_extension_for_format();
1320 } elsif ($attachment_filename && $self->{"${prefix}number"}) {
1321 $attachment_filename .= "_" . $self->{"${prefix}number"} . $self->get_extension_for_format();
1323 } elsif ($attachment_filename) {
1324 $attachment_filename .= $self->get_extension_for_format();
1327 $attachment_filename = "";
1330 $attachment_filename = $main::locale->quote_special_chars('filenames', $attachment_filename);
1331 $attachment_filename =~ s|[\s/\\]+|_|g;
1333 $main::lxdebug->leave_sub();
1334 return $attachment_filename;
1337 sub generate_email_subject {
1338 $main::lxdebug->enter_sub();
1341 my $subject = $main::locale->unquote_special_chars('HTML', $self->get_formname_translation());
1342 my $prefix = $self->get_number_prefix_for_type();
1344 if ($subject && $self->{"${prefix}number"}) {
1345 $subject .= " " . $self->{"${prefix}number"}
1348 $main::lxdebug->leave_sub();
1352 sub generate_email_body {
1353 $main::lxdebug->enter_sub();
1354 my ($self, %params) = @_;
1355 # simple german and english will work grammatically (most european languages as well)
1356 # Dear Mr Alan Greenspan:
1357 # Sehr geehrte Frau Meyer,
1358 # A l’attention de Mme Villeroy,
1359 # Gentile Signora Ferrari,
1362 if ($self->{cp_id} && !$params{record_email}) {
1363 my $givenname = SL::DB::Contact->load_cached($self->{cp_id})->cp_givenname; # for qw(gender givename name);
1364 my $name = SL::DB::Contact->load_cached($self->{cp_id})->cp_name; # for qw(gender givename name);
1365 my $gender = SL::DB::Contact->load_cached($self->{cp_id})->cp_gender; # for qw(gender givename name);
1366 my $mf = $gender eq 'f' ? 'female' : 'male';
1367 $body = GenericTranslations->get(translation_type => "salutation_$mf", language_id => $self->{language_id});
1368 $body .= ' ' . $givenname . ' ' . $name if $body;
1370 $body = GenericTranslations->get(translation_type => "salutation_general", language_id => $self->{language_id});
1373 return undef unless $body;
1375 my $translation_type = $params{translation_type} // "preset_text_$self->{formname}";
1376 my $main_body = GenericTranslations->get(translation_type => $translation_type, language_id => $self->{language_id});
1377 $main_body = GenericTranslations->get(translation_type => $params{fallback_translation_type}, language_id => $self->{language_id}) if !$main_body && $params{fallback_translation_type};
1378 $body .= GenericTranslations->get(translation_type => "salutation_punctuation_mark", language_id => $self->{language_id}) . "\n\n";
1379 $body .= $main_body;
1381 $body = $main::locale->unquote_special_chars('HTML', $body);
1383 $main::lxdebug->leave_sub();
1388 $main::lxdebug->enter_sub();
1390 my ($self, $application) = @_;
1392 my $error_code = $?;
1394 chdir("$self->{tmpdir}");
1397 if ((-1 == $error_code) || (127 == (($error_code) >> 8))) {
1398 push @err, $::locale->text('The application "#1" was not found on the system.', $application || 'pdflatex') . ' ' . $::locale->text('Please contact your administrator.');
1400 } elsif (-f "$self->{tmpfile}.err") {
1401 open(FH, "<:encoding(UTF-8)", "$self->{tmpfile}.err");
1406 if ($self->{tmpfile} && !($::lx_office_conf{debug} && $::lx_office_conf{debug}->{keep_temp_files})) {
1407 $self->{tmpfile} =~ s|.*/||g;
1409 $self->{tmpfile} =~ s/\.\w+$//g;
1410 my $tmpfile = $self->{tmpfile};
1411 unlink(<$tmpfile.*>);
1414 chdir("$self->{cwd}");
1416 $main::lxdebug->leave_sub();
1422 $main::lxdebug->enter_sub();
1424 my ($self, $date, $myconfig) = @_;
1427 if ($date && $date =~ /\D/) {
1429 if ($myconfig->{dateformat} =~ /^yy/) {
1430 ($yy, $mm, $dd) = split /\D/, $date;
1432 if ($myconfig->{dateformat} =~ /^mm/) {
1433 ($mm, $dd, $yy) = split /\D/, $date;
1435 if ($myconfig->{dateformat} =~ /^dd/) {
1436 ($dd, $mm, $yy) = split /\D/, $date;
1441 $yy = ($yy < 70) ? $yy + 2000 : $yy;
1442 $yy = ($yy >= 70 && $yy <= 99) ? $yy + 1900 : $yy;
1444 $dd = "0$dd" if ($dd < 10);
1445 $mm = "0$mm" if ($mm < 10);
1447 $date = "$yy$mm$dd";
1450 $main::lxdebug->leave_sub();
1455 # Database routines used throughout
1456 # DB Handling got moved to SL::DB, these are only shims for compatibility
1459 SL::DB->client->dbh;
1462 sub get_standard_dbh {
1463 my $dbh = SL::DB->client->dbh;
1465 if ($dbh && !$dbh->{Active}) {
1466 $main::lxdebug->message(LXDebug->INFO(), "get_standard_dbh: \$dbh is defined but not Active anymore");
1467 SL::DB->client->dbh(undef);
1470 SL::DB->client->dbh;
1473 sub disconnect_standard_dbh {
1474 SL::DB->client->dbh->rollback;
1480 $main::lxdebug->enter_sub();
1482 my ($self, $date, $myconfig) = @_;
1483 my $dbh = $self->get_standard_dbh;
1485 my $query = "SELECT 1 FROM defaults WHERE ? < closedto";
1486 my $sth = prepare_execute_query($self, $dbh, $query, conv_date($date));
1488 # Falls $date = '' - Fehlermeldung aus der Datenbank. Ich denke,
1489 # es ist sicher ein conv_date vorher IMMER auszuführen.
1490 # Testfälle ohne definiertes closedto:
1491 # Leere Datumseingabe i.O.
1492 # SELECT 1 FROM defaults WHERE '' < closedto
1493 # normale Zahlungsbuchung über Rechnungsmaske i.O.
1494 # SELECT 1 FROM defaults WHERE '10.05.2011' < closedto
1495 # Testfälle mit definiertem closedto (30.04.2011):
1496 # Leere Datumseingabe i.O.
1497 # SELECT 1 FROM defaults WHERE '' < closedto
1498 # normale Buchung im geschloßenem Zeitraum i.O.
1499 # SELECT 1 FROM defaults WHERE '21.04.2011' < closedto
1500 # Fehlermeldung: Es können keine Zahlungen für abgeschlossene Bücher gebucht werden!
1501 # normale Buchung in aktiver Buchungsperiode i.O.
1502 # SELECT 1 FROM defaults WHERE '01.05.2011' < closedto
1504 my ($closed) = $sth->fetchrow_array;
1506 $main::lxdebug->leave_sub();
1511 # prevents bookings to the to far away future
1512 sub date_max_future {
1513 $main::lxdebug->enter_sub();
1515 my ($self, $date, $myconfig) = @_;
1516 my $dbh = $self->get_standard_dbh;
1518 my $query = "SELECT 1 FROM defaults WHERE ? - current_date > max_future_booking_interval";
1519 my $sth = prepare_execute_query($self, $dbh, $query, conv_date($date));
1521 my ($max_future_booking_interval) = $sth->fetchrow_array;
1523 $main::lxdebug->leave_sub();
1525 return $max_future_booking_interval;
1529 sub update_balance {
1530 $main::lxdebug->enter_sub();
1532 my ($self, $dbh, $table, $field, $where, $value, @values) = @_;
1534 # if we have a value, go do it
1537 # retrieve balance from table
1538 my $query = "SELECT $field FROM $table WHERE $where FOR UPDATE";
1539 my $sth = prepare_execute_query($self, $dbh, $query, @values);
1540 my ($balance) = $sth->fetchrow_array;
1546 $query = "UPDATE $table SET $field = $balance WHERE $where";
1547 do_query($self, $dbh, $query, @values);
1549 $main::lxdebug->leave_sub();
1552 sub update_exchangerate {
1553 $main::lxdebug->enter_sub();
1555 my ($self, $dbh, $curr, $transdate, $buy, $sell) = @_;
1557 # some sanity check for currency
1559 $main::lxdebug->leave_sub();
1562 $query = qq|SELECT name AS curr FROM currencies WHERE id=(SELECT currency_id FROM defaults)|;
1564 my ($defaultcurrency) = selectrow_query($self, $dbh, $query);
1566 if ($curr eq $defaultcurrency) {
1567 $main::lxdebug->leave_sub();
1571 $query = qq|SELECT e.currency_id FROM exchangerate e
1572 WHERE e.currency_id = (SELECT cu.id FROM currencies cu WHERE cu.name=?) AND e.transdate = ?
1574 my $sth = prepare_execute_query($self, $dbh, $query, $curr, $transdate);
1583 $buy = conv_i($buy, "NULL");
1584 $sell = conv_i($sell, "NULL");
1587 if ($buy != 0 && $sell != 0) {
1588 $set = "buy = $buy, sell = $sell";
1589 } elsif ($buy != 0) {
1590 $set = "buy = $buy";
1591 } elsif ($sell != 0) {
1592 $set = "sell = $sell";
1595 if ($sth->fetchrow_array) {
1596 $query = qq|UPDATE exchangerate
1598 WHERE currency_id = (SELECT id FROM currencies WHERE name = ?)
1602 $query = qq|INSERT INTO exchangerate (currency_id, buy, sell, transdate)
1603 VALUES ((SELECT id FROM currencies WHERE name = ?), $buy, $sell, ?)|;
1606 do_query($self, $dbh, $query, $curr, $transdate);
1608 $main::lxdebug->leave_sub();
1611 sub save_exchangerate {
1612 $main::lxdebug->enter_sub();
1614 my ($self, $myconfig, $currency, $transdate, $rate, $fld) = @_;
1616 SL::DB->client->with_transaction(sub {
1617 my $dbh = SL::DB->client->dbh;
1621 $buy = $rate if $fld eq 'buy';
1622 $sell = $rate if $fld eq 'sell';
1625 $self->update_exchangerate($dbh, $currency, $transdate, $buy, $sell);
1627 }) or do { die SL::DB->client->error };
1629 $main::lxdebug->leave_sub();
1632 sub get_exchangerate {
1633 $main::lxdebug->enter_sub();
1635 my ($self, $dbh, $curr, $transdate, $fld) = @_;
1638 unless ($transdate && $curr) {
1639 $main::lxdebug->leave_sub();
1643 $query = qq|SELECT name AS curr FROM currencies WHERE id = (SELECT currency_id FROM defaults)|;
1645 my ($defaultcurrency) = selectrow_query($self, $dbh, $query);
1647 if ($curr eq $defaultcurrency) {
1648 $main::lxdebug->leave_sub();
1652 $query = qq|SELECT e.$fld FROM exchangerate e
1653 WHERE e.currency_id = (SELECT id FROM currencies WHERE name = ?) AND e.transdate = ?|;
1654 my ($exchangerate) = selectrow_query($self, $dbh, $query, $curr, $transdate);
1658 $main::lxdebug->leave_sub();
1660 return $exchangerate;
1663 sub check_exchangerate {
1664 $main::lxdebug->enter_sub();
1666 my ($self, $myconfig, $currency, $transdate, $fld) = @_;
1668 if ($fld !~/^buy|sell$/) {
1669 $self->error('Fatal: check_exchangerate called with invalid buy/sell argument');
1672 unless ($transdate) {
1673 $main::lxdebug->leave_sub();
1677 my ($defaultcurrency) = $self->get_default_currency($myconfig);
1679 if ($currency eq $defaultcurrency) {
1680 $main::lxdebug->leave_sub();
1684 my $dbh = $self->get_standard_dbh($myconfig);
1685 my $query = qq|SELECT e.$fld FROM exchangerate e
1686 WHERE e.currency_id = (SELECT id FROM currencies WHERE name = ?) AND e.transdate = ?|;
1688 my ($exchangerate) = selectrow_query($self, $dbh, $query, $currency, $transdate);
1690 $main::lxdebug->leave_sub();
1692 return $exchangerate;
1695 sub get_all_currencies {
1696 $main::lxdebug->enter_sub();
1699 my $myconfig = shift || \%::myconfig;
1700 my $dbh = $self->get_standard_dbh($myconfig);
1702 my $query = qq|SELECT name FROM currencies|;
1703 my @currencies = map { $_->{name} } selectall_hashref_query($self, $dbh, $query);
1705 $main::lxdebug->leave_sub();
1710 sub get_default_currency {
1711 $main::lxdebug->enter_sub();
1713 my ($self, $myconfig) = @_;
1714 my $dbh = $self->get_standard_dbh($myconfig);
1715 my $query = qq|SELECT name AS curr FROM currencies WHERE id = (SELECT currency_id FROM defaults)|;
1717 my ($defaultcurrency) = selectrow_query($self, $dbh, $query);
1719 $main::lxdebug->leave_sub();
1721 return $defaultcurrency;
1724 sub set_payment_options {
1725 my ($self, $myconfig, $transdate, $type) = @_;
1727 my $terms = $self->{payment_id} ? SL::DB::PaymentTerm->new(id => $self->{payment_id})->load : undef;
1730 my $is_invoice = $type =~ m{invoice}i;
1732 $transdate ||= $self->{invdate} || $self->{transdate};
1733 my $due_date = $self->{duedate} || $self->{reqdate};
1735 $self->{$_} = $terms->$_ for qw(terms_netto terms_skonto percent_skonto);
1736 $self->{payment_description} = $terms->description;
1737 $self->{netto_date} = $terms->calc_date(reference_date => $transdate, due_date => $due_date, terms => 'net')->to_kivitendo;
1738 $self->{skonto_date} = $terms->calc_date(reference_date => $transdate, due_date => $due_date, terms => 'discount')->to_kivitendo;
1740 my ($invtotal, $total);
1741 my (%amounts, %formatted_amounts);
1743 if ($self->{type} =~ /_order$/) {
1744 $amounts{invtotal} = $self->{ordtotal};
1745 $amounts{total} = $self->{ordtotal};
1747 } elsif ($self->{type} =~ /_quotation$/) {
1748 $amounts{invtotal} = $self->{quototal};
1749 $amounts{total} = $self->{quototal};
1752 $amounts{invtotal} = $self->{invtotal};
1753 $amounts{total} = $self->{total};
1755 map { $amounts{$_} = $self->parse_amount($myconfig, $amounts{$_}) } keys %amounts;
1757 $amounts{skonto_in_percent} = 100.0 * $self->{percent_skonto};
1758 $amounts{skonto_amount} = $amounts{invtotal} * $self->{percent_skonto};
1759 $amounts{invtotal_wo_skonto} = $amounts{invtotal} * (1 - $self->{percent_skonto});
1760 $amounts{total_wo_skonto} = $amounts{total} * (1 - $self->{percent_skonto});
1762 foreach (keys %amounts) {
1763 $amounts{$_} = $self->round_amount($amounts{$_}, 2);
1764 $formatted_amounts{$_} = $self->format_amount($myconfig, $amounts{$_}, 2);
1767 if ($self->{"language_id"}) {
1768 my $language = SL::DB::Language->new(id => $self->{language_id})->load;
1770 $self->{payment_terms} = $type =~ m{invoice}i ? $terms->translated_attribute('description_long_invoice', $language->id) : undef;
1771 $self->{payment_terms} ||= $terms->translated_attribute('description_long', $language->id);
1773 if ($language->output_dateformat) {
1774 foreach my $key (qw(netto_date skonto_date)) {
1775 $self->{$key} = $::locale->reformat_date($myconfig, $self->{$key}, $language->output_dateformat, $language->output_longdates);
1779 if ($language->output_numberformat && ($language->output_numberformat ne $myconfig->{numberformat})) {
1780 local $myconfig->{numberformat};
1781 $myconfig->{"numberformat"} = $language->output_numberformat;
1782 $formatted_amounts{$_} = $self->format_amount($myconfig, $amounts{$_}) for keys %amounts;
1786 $self->{payment_terms} = $self->{payment_terms} || ($is_invoice ? $terms->description_long_invoice : undef) || $terms->description_long;
1788 $self->{payment_terms} =~ s/<%netto_date%>/$self->{netto_date}/g;
1789 $self->{payment_terms} =~ s/<%skonto_date%>/$self->{skonto_date}/g;
1790 $self->{payment_terms} =~ s/<%currency%>/$self->{currency}/g;
1791 $self->{payment_terms} =~ s/<%terms_netto%>/$self->{terms_netto}/g;
1792 $self->{payment_terms} =~ s/<%account_number%>/$self->{account_number}/g;
1793 $self->{payment_terms} =~ s/<%bank%>/$self->{bank}/g;
1794 $self->{payment_terms} =~ s/<%bank_code%>/$self->{bank_code}/g;
1795 $self->{payment_terms} =~ s/<\%bic\%>/$self->{bic}/g;
1796 $self->{payment_terms} =~ s/<\%iban\%>/$self->{iban}/g;
1797 $self->{payment_terms} =~ s/<\%mandate_date_of_signature\%>/$self->{mandate_date_of_signature}/g;
1798 $self->{payment_terms} =~ s/<\%mandator_id\%>/$self->{mandator_id}/g;
1800 map { $self->{payment_terms} =~ s/<%${_}%>/$formatted_amounts{$_}/g; } keys %formatted_amounts;
1802 $self->{skonto_in_percent} = $formatted_amounts{skonto_in_percent};
1806 sub get_template_language {
1807 $main::lxdebug->enter_sub();
1809 my ($self, $myconfig) = @_;
1811 my $template_code = "";
1813 if ($self->{language_id}) {
1814 my $dbh = $self->get_standard_dbh($myconfig);
1815 my $query = qq|SELECT template_code FROM language WHERE id = ?|;
1816 ($template_code) = selectrow_query($self, $dbh, $query, $self->{language_id});
1819 $main::lxdebug->leave_sub();
1821 return $template_code;
1824 sub get_printer_code {
1825 $main::lxdebug->enter_sub();
1827 my ($self, $myconfig) = @_;
1829 my $template_code = "";
1831 if ($self->{printer_id}) {
1832 my $dbh = $self->get_standard_dbh($myconfig);
1833 my $query = qq|SELECT template_code, printer_command FROM printers WHERE id = ?|;
1834 ($template_code, $self->{printer_command}) = selectrow_query($self, $dbh, $query, $self->{printer_id});
1837 $main::lxdebug->leave_sub();
1839 return $template_code;
1843 $main::lxdebug->enter_sub();
1845 my ($self, $myconfig) = @_;
1847 my $template_code = "";
1849 if ($self->{shipto_id}) {
1850 my $dbh = $self->get_standard_dbh($myconfig);
1851 my $query = qq|SELECT * FROM shipto WHERE shipto_id = ?|;
1852 my $ref = selectfirst_hashref_query($self, $dbh, $query, $self->{shipto_id});
1853 map({ $self->{$_} = $ref->{$_} } keys(%$ref));
1855 my $cvars = CVar->get_custom_variables(
1858 trans_id => $self->{shipto_id},
1860 $self->{"shiptocvar_$_->{name}"} = $_->{value} for @{ $cvars };
1863 $main::lxdebug->leave_sub();
1867 my ($self, $dbh, $id, $module) = @_;
1872 foreach my $item (qw(name department_1 department_2 street zipcode city country gln
1873 contact phone fax email)) {
1874 if ($self->{"shipto$item"}) {
1875 $shipto = 1 if ($self->{$item} ne $self->{"shipto$item"});
1877 push(@values, $self->{"shipto${item}"});
1882 # shiptocp_gender only makes sense, if any other shipto attribute is set.
1883 # Because shiptocp_gender is set to 'm' by default in forms
1884 # it must not be considered above to decide if shiptos has to be added or
1885 # updated, but must be inserted or updated as well in case.
1886 push(@values, $self->{shiptocp_gender});
1888 my $shipto_id = $self->{shipto_id};
1890 if ($self->{shipto_id}) {
1891 my $query = qq|UPDATE shipto set
1893 shiptodepartment_1 = ?,
1894 shiptodepartment_2 = ?,
1904 shiptocp_gender = ?,
1905 WHERE shipto_id = ?|;
1906 do_query($self, $dbh, $query, @values, $self->{shipto_id});
1908 my $query = qq|SELECT * FROM shipto
1909 WHERE shiptoname = ? AND
1910 shiptodepartment_1 = ? AND
1911 shiptodepartment_2 = ? AND
1912 shiptostreet = ? AND
1913 shiptozipcode = ? AND
1915 shiptocountry = ? AND
1917 shiptocontact = ? AND
1921 shiptocp_gender = ? AND
1924 my $insert_check = selectfirst_hashref_query($self, $dbh, $query, @values, $module, $id);
1927 qq|INSERT INTO shipto (trans_id, shiptoname, shiptodepartment_1, shiptodepartment_2,
1928 shiptostreet, shiptozipcode, shiptocity, shiptocountry, shiptogln,
1929 shiptocontact, shiptophone, shiptofax, shiptoemail, shiptocp_gender, module)
1930 VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)|;
1931 do_query($self, $dbh, $insert_query, $id, @values, $module);
1933 $insert_check = selectfirst_hashref_query($self, $dbh, $query, @values, $module, $id);
1936 $shipto_id = $insert_check->{shipto_id};
1939 return unless $shipto_id;
1941 CVar->save_custom_variables(
1944 trans_id => $shipto_id,
1946 name_prefix => 'shipto',
1951 $main::lxdebug->enter_sub();
1953 my ($self, $dbh) = @_;
1955 $dbh ||= $self->get_standard_dbh(\%main::myconfig);
1957 my $query = qq|SELECT id, name FROM employee WHERE login = ?|;
1958 ($self->{"employee_id"}, $self->{"employee"}) = selectrow_query($self, $dbh, $query, $self->{login});
1959 $self->{"employee_id"} *= 1;
1961 $main::lxdebug->leave_sub();
1964 sub get_employee_data {
1965 $main::lxdebug->enter_sub();
1969 my $defaults = SL::DB::Default->get;
1971 Common::check_params(\%params, qw(prefix));
1972 Common::check_params_x(\%params, qw(id));
1975 $main::lxdebug->leave_sub();
1979 my $myconfig = \%main::myconfig;
1980 my $dbh = $params{dbh} || $self->get_standard_dbh($myconfig);
1982 my ($login, $deleted) = selectrow_query($self, $dbh, qq|SELECT login,deleted FROM employee WHERE id = ?|, conv_i($params{id}));
1985 # login already fetched and still the same client (mandant) | same for both cases (delete|!delete)
1986 $self->{$params{prefix} . '_login'} = $login;
1987 $self->{$params{prefix} . "_${_}"} = $defaults->$_ for qw(address businessnumber co_ustid company duns taxnumber);
1990 # get employee data from auth.user_config
1991 my $user = User->new(login => $login);
1992 $self->{$params{prefix} . "_${_}"} = $user->{$_} for qw(email fax name signature tel);
1994 # get saved employee data from employee
1995 my $employee = SL::DB::Manager::Employee->find_by(id => conv_i($params{id}));
1996 $self->{$params{prefix} . "_${_}"} = $employee->{"deleted_$_"} for qw(email fax signature tel);
1997 $self->{$params{prefix} . "_name"} = $employee->name;
2000 $main::lxdebug->leave_sub();
2004 $main::lxdebug->enter_sub();
2006 my ($self, $dbh, $id, $key) = @_;
2008 $key = "all_contacts" unless ($key);
2012 $main::lxdebug->leave_sub();
2017 qq|SELECT cp_id, cp_cv_id, cp_name, cp_givenname, cp_abteilung | .
2018 qq|FROM contacts | .
2019 qq|WHERE cp_cv_id = ? | .
2020 qq|ORDER BY lower(cp_name)|;
2022 $self->{$key} = selectall_hashref_query($self, $dbh, $query, $id);
2024 $main::lxdebug->leave_sub();
2028 $main::lxdebug->enter_sub();
2030 my ($self, $dbh, $key) = @_;
2032 my ($all, $old_id, $where, @values);
2034 if (ref($key) eq "HASH") {
2037 $key = "ALL_PROJECTS";
2039 foreach my $p (keys(%{$params})) {
2041 $all = $params->{$p};
2042 } elsif ($p eq "old_id") {
2043 $old_id = $params->{$p};
2044 } elsif ($p eq "key") {
2045 $key = $params->{$p};
2051 $where = "WHERE active ";
2053 if (ref($old_id) eq "ARRAY") {
2054 my @ids = grep({ $_ } @{$old_id});
2056 $where .= " OR id IN (" . join(",", map({ "?" } @ids)) . ") ";
2057 push(@values, @ids);
2060 $where .= " OR (id = ?) ";
2061 push(@values, $old_id);
2067 qq|SELECT id, projectnumber, description, active | .
2070 qq|ORDER BY lower(projectnumber)|;
2072 $self->{$key} = selectall_hashref_query($self, $dbh, $query, @values);
2074 $main::lxdebug->leave_sub();
2078 $main::lxdebug->enter_sub();
2080 my ($self, $dbh, $key) = @_;
2082 $key = "all_printers" unless ($key);
2084 my $query = qq|SELECT id, printer_description, printer_command, template_code FROM printers|;
2086 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2088 $main::lxdebug->leave_sub();
2092 $main::lxdebug->enter_sub();
2094 my ($self, $dbh, $params) = @_;
2097 $key = $params->{key};
2098 $key = "all_charts" unless ($key);
2100 my $transdate = quote_db_date($params->{transdate});
2103 qq|SELECT c.id, c.accno, c.description, c.link, c.charttype, tk.taxkey_id, tk.tax_id | .
2105 qq|LEFT JOIN taxkeys tk ON | .
2106 qq|(tk.id = (SELECT id FROM taxkeys | .
2107 qq| WHERE taxkeys.chart_id = c.id AND startdate <= $transdate | .
2108 qq| ORDER BY startdate DESC LIMIT 1)) | .
2109 qq|ORDER BY c.accno|;
2111 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2113 $main::lxdebug->leave_sub();
2117 $main::lxdebug->enter_sub();
2119 my ($self, $dbh, $key) = @_;
2121 $key = "all_taxzones" unless ($key);
2123 $tzfilter = "WHERE obsolete is FALSE" if $key eq 'ALL_ACTIVE_TAXZONES';
2125 my $query = qq|SELECT * FROM tax_zones $tzfilter ORDER BY sortkey|;
2127 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2129 $main::lxdebug->leave_sub();
2132 sub _get_employees {
2133 $main::lxdebug->enter_sub();
2135 my ($self, $dbh, $params) = @_;
2140 if (ref $params eq 'HASH') {
2141 $key = $params->{key};
2142 $deleted = $params->{deleted};
2148 $key ||= "all_employees";
2149 my $filter = $deleted ? '' : 'WHERE NOT COALESCE(deleted, FALSE)';
2150 $self->{$key} = selectall_hashref_query($self, $dbh, qq|SELECT * FROM employee $filter ORDER BY lower(name)|);
2152 $main::lxdebug->leave_sub();
2155 sub _get_business_types {
2156 $main::lxdebug->enter_sub();
2158 my ($self, $dbh, $key) = @_;
2160 my $options = ref $key eq 'HASH' ? $key : { key => $key };
2161 $options->{key} ||= "all_business_types";
2164 if (exists $options->{salesman}) {
2165 $where = 'WHERE ' . ($options->{salesman} ? '' : 'NOT ') . 'COALESCE(salesman)';
2168 $self->{ $options->{key} } = selectall_hashref_query($self, $dbh, qq|SELECT * FROM business $where ORDER BY lower(description)|);
2170 $main::lxdebug->leave_sub();
2173 sub _get_languages {
2174 $main::lxdebug->enter_sub();
2176 my ($self, $dbh, $key) = @_;
2178 $key = "all_languages" unless ($key);
2180 my $query = qq|SELECT * FROM language ORDER BY id|;
2182 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2184 $main::lxdebug->leave_sub();
2187 sub _get_dunning_configs {
2188 $main::lxdebug->enter_sub();
2190 my ($self, $dbh, $key) = @_;
2192 $key = "all_dunning_configs" unless ($key);
2194 my $query = qq|SELECT * FROM dunning_config ORDER BY dunning_level|;
2196 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2198 $main::lxdebug->leave_sub();
2201 sub _get_currencies {
2202 $main::lxdebug->enter_sub();
2204 my ($self, $dbh, $key) = @_;
2206 $key = "all_currencies" unless ($key);
2208 $self->{$key} = [$self->get_all_currencies()];
2210 $main::lxdebug->leave_sub();
2214 $main::lxdebug->enter_sub();
2216 my ($self, $dbh, $key) = @_;
2218 $key = "all_payments" unless ($key);
2220 my $query = qq|SELECT * FROM payment_terms ORDER BY sortkey|;
2222 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2224 $main::lxdebug->leave_sub();
2227 sub _get_customers {
2228 $main::lxdebug->enter_sub();
2230 my ($self, $dbh, $key) = @_;
2232 my $options = ref $key eq 'HASH' ? $key : { key => $key };
2233 $options->{key} ||= "all_customers";
2234 my $limit_clause = $options->{limit} ? "LIMIT $options->{limit}" : '';
2237 push @where, qq|business_id IN (SELECT id FROM business WHERE salesman)| if $options->{business_is_salesman};
2238 push @where, qq|NOT obsolete| if !$options->{with_obsolete};
2239 my $where_str = @where ? "WHERE " . join(" AND ", map { "($_)" } @where) : '';
2241 my $query = qq|SELECT * FROM customer $where_str ORDER BY name $limit_clause|;
2242 $self->{ $options->{key} } = selectall_hashref_query($self, $dbh, $query);
2244 $main::lxdebug->leave_sub();
2248 $main::lxdebug->enter_sub();
2250 my ($self, $dbh, $key) = @_;
2252 $key = "all_vendors" unless ($key);
2254 my $query = qq|SELECT * FROM vendor WHERE NOT obsolete ORDER BY name|;
2256 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2258 $main::lxdebug->leave_sub();
2261 sub _get_departments {
2262 $main::lxdebug->enter_sub();
2264 my ($self, $dbh, $key) = @_;
2266 $key = "all_departments" unless ($key);
2268 my $query = qq|SELECT * FROM department ORDER BY description|;
2270 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2272 $main::lxdebug->leave_sub();
2275 sub _get_warehouses {
2276 $main::lxdebug->enter_sub();
2278 my ($self, $dbh, $param) = @_;
2280 my ($key, $bins_key);
2282 if ('' eq ref $param) {
2286 $key = $param->{key};
2287 $bins_key = $param->{bins};
2290 my $query = qq|SELECT w.* FROM warehouse w
2291 WHERE (NOT w.invalid) AND
2292 ((SELECT COUNT(b.*) FROM bin b WHERE b.warehouse_id = w.id) > 0)
2293 ORDER BY w.sortkey|;
2295 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2298 $query = qq|SELECT id, description FROM bin WHERE warehouse_id = ?
2299 ORDER BY description|;
2300 my $sth = prepare_query($self, $dbh, $query);
2302 foreach my $warehouse (@{ $self->{$key} }) {
2303 do_statement($self, $sth, $query, $warehouse->{id});
2304 $warehouse->{$bins_key} = [];
2306 while (my $ref = $sth->fetchrow_hashref()) {
2307 push @{ $warehouse->{$bins_key} }, $ref;
2313 $main::lxdebug->leave_sub();
2317 $main::lxdebug->enter_sub();
2319 my ($self, $dbh, $table, $key, $sortkey) = @_;
2321 my $query = qq|SELECT * FROM $table|;
2322 $query .= qq| ORDER BY $sortkey| if ($sortkey);
2324 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2326 $main::lxdebug->leave_sub();
2330 $main::lxdebug->enter_sub();
2335 croak "get_lists: shipto is no longer supported" if $params{shipto};
2337 my $dbh = $self->get_standard_dbh(\%main::myconfig);
2338 my ($sth, $query, $ref);
2341 if ($params{contacts}) {
2342 $vc = 'customer' if $self->{"vc"} eq "customer";
2343 $vc = 'vendor' if $self->{"vc"} eq "vendor";
2344 die "invalid use of get_lists, need 'vc'" unless $vc;
2345 $vc_id = $self->{"${vc}_id"};
2348 if ($params{"contacts"}) {
2349 $self->_get_contacts($dbh, $vc_id, $params{"contacts"});
2352 if ($params{"projects"} || $params{"all_projects"}) {
2353 $self->_get_projects($dbh, $params{"all_projects"} ?
2354 $params{"all_projects"} : $params{"projects"},
2355 $params{"all_projects"} ? 1 : 0);
2358 if ($params{"printers"}) {
2359 $self->_get_printers($dbh, $params{"printers"});
2362 if ($params{"languages"}) {
2363 $self->_get_languages($dbh, $params{"languages"});
2366 if ($params{"charts"}) {
2367 $self->_get_charts($dbh, $params{"charts"});
2370 if ($params{"taxzones"}) {
2371 $self->_get_taxzones($dbh, $params{"taxzones"});
2374 if ($params{"employees"}) {
2375 $self->_get_employees($dbh, $params{"employees"});
2378 if ($params{"salesmen"}) {
2379 $self->_get_employees($dbh, $params{"salesmen"});
2382 if ($params{"business_types"}) {
2383 $self->_get_business_types($dbh, $params{"business_types"});
2386 if ($params{"dunning_configs"}) {
2387 $self->_get_dunning_configs($dbh, $params{"dunning_configs"});
2390 if($params{"currencies"}) {
2391 $self->_get_currencies($dbh, $params{"currencies"});
2394 if($params{"customers"}) {
2395 $self->_get_customers($dbh, $params{"customers"});
2398 if($params{"vendors"}) {
2399 if (ref $params{"vendors"} eq 'HASH') {
2400 $self->_get_vendors($dbh, $params{"vendors"}{key}, $params{"vendors"}{limit});
2402 $self->_get_vendors($dbh, $params{"vendors"});
2406 if($params{"payments"}) {
2407 $self->_get_payments($dbh, $params{"payments"});
2410 if($params{"departments"}) {
2411 $self->_get_departments($dbh, $params{"departments"});
2414 if ($params{price_factors}) {
2415 $self->_get_simple($dbh, 'price_factors', $params{price_factors}, 'sortkey');
2418 if ($params{warehouses}) {
2419 $self->_get_warehouses($dbh, $params{warehouses});
2422 if ($params{partsgroup}) {
2423 $self->get_partsgroup(\%main::myconfig, { all => 1, target => $params{partsgroup} });
2426 $main::lxdebug->leave_sub();
2429 # this sub gets the id and name from $table
2431 $main::lxdebug->enter_sub();
2433 my ($self, $myconfig, $table) = @_;
2435 # connect to database
2436 my $dbh = $self->get_standard_dbh($myconfig);
2438 $table = $table eq "customer" ? "customer" : "vendor";
2439 my $arap = $self->{arap} eq "ar" ? "ar" : "ap";
2441 my ($query, @values);
2443 if (!$self->{openinvoices}) {
2445 if ($self->{customernumber} ne "") {
2446 $where = qq|(vc.customernumber ILIKE ?)|;
2447 push(@values, like($self->{customernumber}));
2449 $where = qq|(vc.name ILIKE ?)|;
2450 push(@values, like($self->{$table}));
2454 qq~SELECT vc.id, vc.name,
2455 vc.street || ' ' || vc.zipcode || ' ' || vc.city || ' ' || vc.country AS address
2457 WHERE $where AND (NOT vc.obsolete)
2461 qq~SELECT DISTINCT vc.id, vc.name,
2462 vc.street || ' ' || vc.zipcode || ' ' || vc.city || ' ' || vc.country AS address
2464 JOIN $table vc ON (a.${table}_id = vc.id)
2465 WHERE NOT (a.amount = a.paid) AND (vc.name ILIKE ?)
2467 push(@values, like($self->{$table}));
2470 $self->{name_list} = selectall_hashref_query($self, $dbh, $query, @values);
2472 $main::lxdebug->leave_sub();
2474 return scalar(@{ $self->{name_list} });
2479 my ($self, $table, $provided_dbh) = @_;
2481 my $dbh = $provided_dbh ? $provided_dbh : $self->get_standard_dbh;
2482 return unless $self->{id};
2483 croak ("wrong call, no valid table defined") unless $table =~ /^(oe|ar|ap|delivery_orders|parts)$/;
2485 my $query = "SELECT mtime, itime FROM " . $table . " WHERE id = ?";
2486 my $ref = selectfirst_hashref_query($self, $dbh, $query, $self->{id});
2487 $ref->{mtime} ||= $ref->{itime};
2488 $self->{lastmtime} = $ref->{mtime};
2492 sub mtime_ischanged {
2493 my ($self, $table, $option) = @_;
2495 return unless $self->{id};
2496 croak ("wrong call, no valid table defined") unless $table =~ /^(oe|ar|ap|delivery_orders|parts)$/;
2498 my $query = "SELECT mtime, itime FROM " . $table . " WHERE id = ?";
2499 my $ref = selectfirst_hashref_query($self, $self->get_standard_dbh, $query, $self->{id});
2500 $ref->{mtime} ||= $ref->{itime};
2502 if ($self->{lastmtime} && $self->{lastmtime} ne $ref->{mtime} ) {
2503 $self->error(($option eq 'mail') ?
2504 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") :
2505 t8("The document has been changed by another user. Please reopen it in another window and copy the changes to the new window")
2507 $::dispatcher->end_request;
2511 # language_payment duplicates some of the functionality of all_vc (language,
2512 # printer, payment_terms), and at least in the case of sales invoices both
2513 # all_vc and language_payment are called when adding new invoices
2514 sub language_payment {
2515 $main::lxdebug->enter_sub();
2517 my ($self, $myconfig) = @_;
2519 my $dbh = $self->get_standard_dbh($myconfig);
2521 my $query = qq|SELECT id, description
2525 $self->{languages} = selectall_hashref_query($self, $dbh, $query);
2528 $query = qq|SELECT printer_description, id
2530 ORDER BY printer_description|;
2532 $self->{printers} = selectall_hashref_query($self, $dbh, $query);
2535 $query = qq|SELECT id, description
2537 WHERE ( obsolete IS FALSE OR id = ? )
2539 $self->{payment_terms} = selectall_hashref_query($self, $dbh, $query, $self->{payment_id} || undef);
2541 # get buchungsgruppen
2542 $query = qq|SELECT id, description
2543 FROM buchungsgruppen|;
2545 $self->{BUCHUNGSGRUPPEN} = selectall_hashref_query($self, $dbh, $query);
2547 $main::lxdebug->leave_sub();
2550 # this is only used for reports
2551 sub all_departments {
2552 $main::lxdebug->enter_sub();
2554 my ($self, $myconfig, $table) = @_;
2556 my $dbh = $self->get_standard_dbh($myconfig);
2558 my $query = qq|SELECT id, description
2560 ORDER BY description|;
2561 $self->{all_departments} = selectall_hashref_query($self, $dbh, $query);
2563 delete($self->{all_departments}) unless (@{ $self->{all_departments} || [] });
2565 $main::lxdebug->leave_sub();
2569 $main::lxdebug->enter_sub();
2571 my ($self, $module, $myconfig, $table, $provided_dbh) = @_;
2574 if ($table eq "customer") {
2583 # get last customers or vendors
2584 my ($query, $sth, $ref);
2586 my $dbh = $provided_dbh ? $provided_dbh : $self->get_standard_dbh($myconfig);
2591 my $transdate = "current_date";
2592 if ($self->{transdate}) {
2593 $transdate = $dbh->quote($self->{transdate});
2596 # now get the account numbers
2598 SELECT c.accno, c.description, c.link, c.taxkey_id, c.id AS chart_id, tk2.tax_id
2600 -- find newest entries in taxkeys
2602 SELECT chart_id, MAX(startdate) AS startdate
2604 WHERE (startdate <= $transdate)
2606 ) tk ON (c.id = tk.chart_id)
2607 -- and load all of those entries
2608 INNER JOIN taxkeys tk2
2609 ON (tk.chart_id = tk2.chart_id AND tk.startdate = tk2.startdate)
2610 WHERE (c.link LIKE ?)
2613 $sth = $dbh->prepare($query);
2615 do_statement($self, $sth, $query, like($module));
2617 $self->{accounts} = "";
2618 while ($ref = $sth->fetchrow_hashref("NAME_lc")) {
2620 foreach my $key (split(/:/, $ref->{link})) {
2621 if ($key =~ /\Q$module\E/) {
2623 # cross reference for keys
2624 $xkeyref{ $ref->{accno} } = $key;
2626 push @{ $self->{"${module}_links"}{$key} },
2627 { accno => $ref->{accno},
2628 chart_id => $ref->{chart_id},
2629 description => $ref->{description},
2630 taxkey => $ref->{taxkey_id},
2631 tax_id => $ref->{tax_id} };
2633 $self->{accounts} .= "$ref->{accno} " unless $key =~ /tax/;
2639 # get taxkeys and description
2640 $query = qq|SELECT id, taxkey, taxdescription FROM tax|;
2641 $self->{TAXKEY} = selectall_hashref_query($self, $dbh, $query);
2643 if (($module eq "AP") || ($module eq "AR")) {
2644 # get tax rates and description
2645 $query = qq|SELECT * FROM tax|;
2646 $self->{TAX} = selectall_hashref_query($self, $dbh, $query);
2649 my $extra_columns = '';
2650 $extra_columns .= 'a.direct_debit, ' if ($module eq 'AR') || ($module eq 'AP');
2655 a.cp_id, a.invnumber, a.transdate, a.${table}_id, a.datepaid, a.deliverydate,
2656 a.duedate, a.ordnumber, a.taxincluded, (SELECT cu.name FROM currencies cu WHERE cu.id=a.currency_id) AS currency, a.notes,
2658 a.intnotes, a.department_id, a.amount AS oldinvtotal,
2659 a.paid AS oldtotalpaid, a.employee_id, a.gldate, a.type,
2660 a.globalproject_id, ${extra_columns}
2662 d.description AS department,
2665 JOIN $table c ON (a.${table}_id = c.id)
2666 LEFT JOIN employee e ON (e.id = a.employee_id)
2667 LEFT JOIN department d ON (d.id = a.department_id)
2669 $ref = selectfirst_hashref_query($self, $dbh, $query, $self->{id});
2671 foreach my $key (keys %$ref) {
2672 $self->{$key} = $ref->{$key};
2674 $self->{mtime} ||= $self->{itime};
2675 $self->{lastmtime} = $self->{mtime};
2676 my $transdate = "current_date";
2677 if ($self->{transdate}) {
2678 $transdate = $dbh->quote($self->{transdate});
2681 # now get the account numbers
2682 $query = qq|SELECT c.accno, c.description, c.link, c.taxkey_id, c.id AS chart_id, tk.tax_id
2684 LEFT JOIN taxkeys tk ON (tk.chart_id = c.id)
2686 AND (tk.id = (SELECT id FROM taxkeys WHERE taxkeys.chart_id = c.id AND startdate <= $transdate ORDER BY startdate DESC LIMIT 1)
2687 OR c.link LIKE '%_tax%' OR c.taxkey_id IS NULL)
2690 $sth = $dbh->prepare($query);
2691 do_statement($self, $sth, $query, like($module));
2693 $self->{accounts} = "";
2694 while ($ref = $sth->fetchrow_hashref("NAME_lc")) {
2696 foreach my $key (split(/:/, $ref->{link})) {
2697 if ($key =~ /\Q$module\E/) {
2699 # cross reference for keys
2700 $xkeyref{ $ref->{accno} } = $key;
2702 push @{ $self->{"${module}_links"}{$key} },
2703 { accno => $ref->{accno},
2704 chart_id => $ref->{chart_id},
2705 description => $ref->{description},
2706 taxkey => $ref->{taxkey_id},
2707 tax_id => $ref->{tax_id} };
2709 $self->{accounts} .= "$ref->{accno} " unless $key =~ /tax/;
2715 # get amounts from individual entries
2718 c.accno, c.description,
2719 a.acc_trans_id, a.source, a.amount, a.memo, a.transdate, a.gldate, a.cleared, a.project_id, a.taxkey, a.chart_id,
2723 LEFT JOIN chart c ON (c.id = a.chart_id)
2724 LEFT JOIN project p ON (p.id = a.project_id)
2725 LEFT JOIN tax t ON (t.id= a.tax_id)
2726 WHERE a.trans_id = ?
2727 AND a.fx_transaction = '0'
2728 ORDER BY a.acc_trans_id, a.transdate|;
2729 $sth = $dbh->prepare($query);
2730 do_statement($self, $sth, $query, $self->{id});
2732 # get exchangerate for currency
2733 $self->{exchangerate} =
2734 $self->get_exchangerate($dbh, $self->{currency}, $self->{transdate}, $fld);
2737 # store amounts in {acc_trans}{$key} for multiple accounts
2738 while (my $ref = $sth->fetchrow_hashref("NAME_lc")) {
2739 $ref->{exchangerate} =
2740 $self->get_exchangerate($dbh, $self->{currency}, $ref->{transdate}, $fld);
2741 if (!($xkeyref{ $ref->{accno} } =~ /tax/)) {
2744 if (($xkeyref{ $ref->{accno} } =~ /paid/) && ($self->{type} eq "credit_note")) {
2745 $ref->{amount} *= -1;
2747 $ref->{index} = $index;
2749 push @{ $self->{acc_trans}{ $xkeyref{ $ref->{accno} } } }, $ref;
2756 d.closedto, d.revtrans,
2757 (SELECT cu.name FROM currencies cu WHERE cu.id=d.currency_id) AS defaultcurrency,
2758 (SELECT c.accno FROM chart c WHERE d.fxgain_accno_id = c.id) AS fxgain_accno,
2759 (SELECT c.accno FROM chart c WHERE d.fxloss_accno_id = c.id) AS fxloss_accno,
2760 (SELECT c.accno FROM chart c WHERE d.rndgain_accno_id = c.id) AS rndgain_accno,
2761 (SELECT c.accno FROM chart c WHERE d.rndloss_accno_id = c.id) AS rndloss_accno
2763 $ref = selectfirst_hashref_query($self, $dbh, $query);
2764 map { $self->{$_} = $ref->{$_} } keys %$ref;
2771 current_date AS transdate, d.closedto, d.revtrans,
2772 (SELECT cu.name FROM currencies cu WHERE cu.id=d.currency_id) AS defaultcurrency,
2773 (SELECT c.accno FROM chart c WHERE d.fxgain_accno_id = c.id) AS fxgain_accno,
2774 (SELECT c.accno FROM chart c WHERE d.fxloss_accno_id = c.id) AS fxloss_accno,
2775 (SELECT c.accno FROM chart c WHERE d.rndgain_accno_id = c.id) AS rndgain_accno,
2776 (SELECT c.accno FROM chart c WHERE d.rndloss_accno_id = c.id) AS rndloss_accno
2778 $ref = selectfirst_hashref_query($self, $dbh, $query);
2779 map { $self->{$_} = $ref->{$_} } keys %$ref;
2781 if ($self->{"$self->{vc}_id"}) {
2783 # only setup currency
2784 ($self->{currency}) = $self->{defaultcurrency} if !$self->{currency};
2788 $self->lastname_used($dbh, $myconfig, $table, $module);
2790 # get exchangerate for currency
2791 $self->{exchangerate} =
2792 $self->get_exchangerate($dbh, $self->{currency}, $self->{transdate}, $fld);
2798 $main::lxdebug->leave_sub();
2802 $main::lxdebug->enter_sub();
2804 my ($self, $dbh, $myconfig, $table, $module) = @_;
2808 $table = $table eq "customer" ? "customer" : "vendor";
2809 my %column_map = ("a.${table}_id" => "${table}_id",
2810 "a.department_id" => "department_id",
2811 "d.description" => "department",
2812 "ct.name" => $table,
2813 "cu.name" => "currency",
2816 if ($self->{type} =~ /delivery_order/) {
2817 $arap = 'delivery_orders';
2818 delete $column_map{"cu.currency"};
2820 } elsif ($self->{type} =~ /_order/) {
2822 $where = "quotation = '0'";
2824 } elsif ($self->{type} =~ /_quotation/) {
2826 $where = "quotation = '1'";
2828 } elsif ($table eq 'customer') {
2836 $where = "($where) AND" if ($where);
2837 my $query = qq|SELECT MAX(id) FROM $arap
2838 WHERE $where ${table}_id > 0|;
2839 my ($trans_id) = selectrow_query($self, $dbh, $query);
2842 my $column_spec = join(', ', map { "${_} AS $column_map{$_}" } keys %column_map);
2843 $query = qq|SELECT $column_spec
2845 LEFT JOIN $table ct ON (a.${table}_id = ct.id)
2846 LEFT JOIN department d ON (a.department_id = d.id)
2847 LEFT JOIN currencies cu ON (cu.id=ct.currency_id)
2849 my $ref = selectfirst_hashref_query($self, $dbh, $query, $trans_id);
2851 map { $self->{$_} = $ref->{$_} } values %column_map;
2853 $main::lxdebug->leave_sub();
2856 sub get_variable_content_types {
2857 my %html_variables = (
2858 longdescription => 'html',
2859 partnotes => 'html',
2861 orignotes => 'html',
2866 header_text => 'html',
2867 footer_text => 'html',
2869 return \%html_variables;
2873 $main::lxdebug->enter_sub();
2876 my $myconfig = shift || \%::myconfig;
2877 my ($thisdate, $days) = @_;
2879 my $dbh = $self->get_standard_dbh($myconfig);
2884 my $dateformat = $myconfig->{dateformat};
2885 $dateformat .= "yy" if $myconfig->{dateformat} !~ /^y/;
2886 $thisdate = $dbh->quote($thisdate);
2887 $query = qq|SELECT to_date($thisdate, '$dateformat') + $days AS thisdate|;
2889 $query = qq|SELECT current_date AS thisdate|;
2892 ($thisdate) = selectrow_query($self, $dbh, $query);
2894 $main::lxdebug->leave_sub();
2900 $main::lxdebug->enter_sub();
2902 my ($self, $flds, $new, $count, $numrows) = @_;
2906 map { push @ndx, { num => $new->[$_ - 1]->{runningnumber}, ndx => $_ } } 1 .. $count;
2911 foreach my $item (sort { $a->{num} <=> $b->{num} } @ndx) {
2913 my $j = $item->{ndx} - 1;
2914 map { $self->{"${_}_$i"} = $new->[$j]->{$_} } @{$flds};
2918 for $i ($count + 1 .. $numrows) {
2919 map { delete $self->{"${_}_$i"} } @{$flds};
2922 $main::lxdebug->leave_sub();
2926 $main::lxdebug->enter_sub();
2928 my ($self, $myconfig) = @_;
2932 SL::DB->client->with_transaction(sub {
2933 my $dbh = SL::DB->client->dbh;
2935 my $query = qq|DELETE FROM status
2936 WHERE (formname = ?) AND (trans_id = ?)|;
2937 my $sth = prepare_query($self, $dbh, $query);
2939 if ($self->{formname} =~ /(check|receipt)/) {
2940 for $i (1 .. $self->{rowcount}) {
2941 do_statement($self, $sth, $query, $self->{formname}, $self->{"id_$i"} * 1);
2944 do_statement($self, $sth, $query, $self->{formname}, $self->{id});
2948 my $printed = ($self->{printed} =~ /\Q$self->{formname}\E/) ? "1" : "0";
2949 my $emailed = ($self->{emailed} =~ /\Q$self->{formname}\E/) ? "1" : "0";
2951 my %queued = split / /, $self->{queued};
2954 if ($self->{formname} =~ /(check|receipt)/) {
2956 # this is a check or receipt, add one entry for each lineitem
2957 my ($accno) = split /--/, $self->{account};
2958 $query = qq|INSERT INTO status (trans_id, printed, spoolfile, formname, chart_id)
2959 VALUES (?, ?, ?, ?, (SELECT c.id FROM chart c WHERE c.accno = ?))|;
2960 @values = ($printed, $queued{$self->{formname}}, $self->{prinform}, $accno);
2961 $sth = prepare_query($self, $dbh, $query);
2963 for $i (1 .. $self->{rowcount}) {
2964 if ($self->{"checked_$i"}) {
2965 do_statement($self, $sth, $query, $self->{"id_$i"}, @values);
2971 $query = qq|INSERT INTO status (trans_id, printed, emailed, spoolfile, formname)
2972 VALUES (?, ?, ?, ?, ?)|;
2973 do_query($self, $dbh, $query, $self->{id}, $printed, $emailed,
2974 $queued{$self->{formname}}, $self->{formname});
2977 }) or do { die SL::DB->client->error };
2979 $main::lxdebug->leave_sub();
2983 $main::lxdebug->enter_sub();
2985 my ($self, $dbh) = @_;
2987 my ($query, $printed, $emailed);
2989 my $formnames = $self->{printed};
2990 my $emailforms = $self->{emailed};
2992 $query = qq|DELETE FROM status
2993 WHERE (formname = ?) AND (trans_id = ?)|;
2994 do_query($self, $dbh, $query, $self->{formname}, $self->{id});
2996 # this only applies to the forms
2997 # checks and receipts are posted when printed or queued
2999 if ($self->{queued}) {
3000 my %queued = split / /, $self->{queued};
3002 foreach my $formname (keys %queued) {
3003 $printed = ($self->{printed} =~ /\Q$self->{formname}\E/) ? "1" : "0";
3004 $emailed = ($self->{emailed} =~ /\Q$self->{formname}\E/) ? "1" : "0";
3006 $query = qq|INSERT INTO status (trans_id, printed, emailed, spoolfile, formname)
3007 VALUES (?, ?, ?, ?, ?)|;
3008 do_query($self, $dbh, $query, $self->{id}, $printed, $emailed, $queued{$formname}, $formname);
3010 $formnames =~ s/\Q$self->{formname}\E//;
3011 $emailforms =~ s/\Q$self->{formname}\E//;
3016 # save printed, emailed info
3017 $formnames =~ s/^ +//g;
3018 $emailforms =~ s/^ +//g;
3021 map { $status{$_}{printed} = 1 } split / +/, $formnames;
3022 map { $status{$_}{emailed} = 1 } split / +/, $emailforms;
3024 foreach my $formname (keys %status) {
3025 $printed = ($formnames =~ /\Q$self->{formname}\E/) ? "1" : "0";
3026 $emailed = ($emailforms =~ /\Q$self->{formname}\E/) ? "1" : "0";
3028 $query = qq|INSERT INTO status (trans_id, printed, emailed, formname)
3029 VALUES (?, ?, ?, ?)|;
3030 do_query($self, $dbh, $query, $self->{id}, $printed, $emailed, $formname);
3033 $main::lxdebug->leave_sub();
3037 # $main::locale->text('SAVED')
3038 # $main::locale->text('SCREENED')
3039 # $main::locale->text('DELETED')
3040 # $main::locale->text('ADDED')
3041 # $main::locale->text('PAYMENT POSTED')
3042 # $main::locale->text('POSTED')
3043 # $main::locale->text('POSTED AS NEW')
3044 # $main::locale->text('ELSE')
3045 # $main::locale->text('SAVED FOR DUNNING')
3046 # $main::locale->text('DUNNING STARTED')
3047 # $main::locale->text('PRINTED')
3048 # $main::locale->text('MAILED')
3049 # $main::locale->text('SCREENED')
3050 # $main::locale->text('CANCELED')
3051 # $main::locale->text('IMPORT')
3052 # $main::locale->text('UNIMPORT')
3053 # $main::locale->text('invoice')
3054 # $main::locale->text('proforma')
3055 # $main::locale->text('sales_order')
3056 # $main::locale->text('pick_list')
3057 # $main::locale->text('purchase_order')
3058 # $main::locale->text('bin_list')
3059 # $main::locale->text('sales_quotation')
3060 # $main::locale->text('request_quotation')
3063 $main::lxdebug->enter_sub();
3066 my $dbh = shift || SL::DB->client->dbh;
3067 SL::DB->client->with_transaction(sub {
3069 if(!exists $self->{employee_id}) {
3070 &get_employee($self, $dbh);
3074 qq|INSERT INTO history_erp (trans_id, employee_id, addition, what_done, snumbers) | .
3075 qq|VALUES (?, (SELECT id FROM employee WHERE login = ?), ?, ?, ?)|;
3076 my @values = (conv_i($self->{id}), $self->{login},
3077 $self->{addition}, $self->{what_done}, "$self->{snumbers}");
3078 do_query($self, $dbh, $query, @values);
3080 }) or do { die SL::DB->client->error };
3082 $main::lxdebug->leave_sub();
3086 $main::lxdebug->enter_sub();
3088 my ($self, $dbh, $trans_id, $restriction, $order) = @_;
3089 my ($orderBy, $desc) = split(/\-\-/, $order);
3090 $order = " ORDER BY " . ($order eq "" ? " h.itime " : ($desc == 1 ? $orderBy . " DESC " : $orderBy . " "));
3093 if ($trans_id ne "") {
3095 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 | .
3096 qq|FROM history_erp h | .
3097 qq|LEFT JOIN employee emp ON (emp.id = h.employee_id) | .
3098 qq|WHERE (trans_id = | . $trans_id . qq|) $restriction | .
3101 my $sth = $dbh->prepare($query) || $self->dberror($query);
3103 $sth->execute() || $self->dberror("$query");
3105 while(my $hash_ref = $sth->fetchrow_hashref()) {
3106 $hash_ref->{addition} = $main::locale->text($hash_ref->{addition});
3107 $hash_ref->{what_done} = $main::locale->text($hash_ref->{what_done});
3108 my ( $what, $number ) = split /_/, $hash_ref->{snumbers};
3109 $hash_ref->{snumbers} = $number;
3110 $hash_ref->{haslink} = 'controller.pl?action=EmailJournal/show&id='.$number if $what eq 'emailjournal';
3111 $hash_ref->{snumbers} = $main::locale->text("E-Mail").' '.$number if $what eq 'emailjournal';
3112 $tempArray[$i++] = $hash_ref;
3114 $main::lxdebug->leave_sub() and return \@tempArray
3115 if ($i > 0 && $tempArray[0] ne "");
3117 $main::lxdebug->leave_sub();
3121 sub get_partsgroup {
3122 $main::lxdebug->enter_sub();
3124 my ($self, $myconfig, $p) = @_;
3125 my $target = $p->{target} || 'all_partsgroup';
3127 my $dbh = $self->get_standard_dbh($myconfig);
3129 my $query = qq|SELECT DISTINCT pg.id, pg.partsgroup
3131 JOIN parts p ON (p.partsgroup_id = pg.id) |;
3134 if ($p->{searchitems} eq 'part') {
3135 $query .= qq|WHERE p.part_type = 'part'|;
3137 if ($p->{searchitems} eq 'service') {
3138 $query .= qq|WHERE p.part_type = 'service'|;
3140 if ($p->{searchitems} eq 'assembly') {
3141 $query .= qq|WHERE p.part_type = 'assembly'|;
3144 $query .= qq|ORDER BY partsgroup|;
3147 $query = qq|SELECT id, partsgroup FROM partsgroup
3148 ORDER BY partsgroup|;
3151 if ($p->{language_code}) {
3152 $query = qq|SELECT DISTINCT pg.id, pg.partsgroup,
3153 t.description AS translation
3155 JOIN parts p ON (p.partsgroup_id = pg.id)
3156 LEFT JOIN translation t ON ((t.trans_id = pg.id) AND (t.language_code = ?))
3157 ORDER BY translation|;
3158 @values = ($p->{language_code});
3161 $self->{$target} = selectall_hashref_query($self, $dbh, $query, @values);
3163 $main::lxdebug->leave_sub();
3166 sub get_pricegroup {
3167 $main::lxdebug->enter_sub();
3169 my ($self, $myconfig, $p) = @_;
3171 my $dbh = $self->get_standard_dbh($myconfig);
3173 my $query = qq|SELECT p.id, p.pricegroup
3176 $query .= qq| ORDER BY pricegroup|;
3179 $query = qq|SELECT id, pricegroup FROM pricegroup
3180 ORDER BY pricegroup|;
3183 $self->{all_pricegroup} = selectall_hashref_query($self, $dbh, $query);
3185 $main::lxdebug->leave_sub();
3189 # usage $form->all_years($myconfig, [$dbh])
3190 # return list of all years where bookings found
3193 $main::lxdebug->enter_sub();
3195 my ($self, $myconfig, $dbh) = @_;
3197 $dbh ||= $self->get_standard_dbh($myconfig);
3200 my $query = qq|SELECT (SELECT MIN(transdate) FROM acc_trans),
3201 (SELECT MAX(transdate) FROM acc_trans)|;
3202 my ($startdate, $enddate) = selectrow_query($self, $dbh, $query);
3204 if ($myconfig->{dateformat} =~ /^yy/) {
3205 ($startdate) = split /\W/, $startdate;
3206 ($enddate) = split /\W/, $enddate;
3208 (@_) = split /\W/, $startdate;
3210 (@_) = split /\W/, $enddate;
3215 $startdate = substr($startdate,0,4);
3216 $enddate = substr($enddate,0,4);
3218 while ($enddate >= $startdate) {
3219 push @all_years, $enddate--;
3224 $main::lxdebug->leave_sub();
3228 $main::lxdebug->enter_sub();
3232 map { $self->{_VAR_BACKUP}->{$_} = $self->{$_} if exists $self->{$_} } @vars;
3234 $main::lxdebug->leave_sub();
3238 $main::lxdebug->enter_sub();
3243 map { $self->{$_} = $self->{_VAR_BACKUP}->{$_} if exists $self->{_VAR_BACKUP}->{$_} } @vars;
3245 $main::lxdebug->leave_sub();
3248 sub prepare_for_printing {
3251 my $defaults = SL::DB::Default->get;
3253 $self->{templates} ||= $defaults->templates;
3254 $self->{formname} ||= $self->{type};
3255 $self->{media} ||= 'email';
3257 die "'media' other than 'email', 'file', 'printer' is not supported yet" unless $self->{media} =~ m/^(?:email|file|printer)$/;
3259 # Several fields that used to reside in %::myconfig (stored in
3260 # auth.user_config) are now stored in defaults. Copy them over for
3262 $self->{$_} = $defaults->$_ for qw(company address taxnumber co_ustid duns sepa_creditor_id);
3264 $self->{"myconfig_${_}"} = $::myconfig{$_} for grep { $_ ne 'dbpasswd' } keys %::myconfig;
3266 if (!$self->{employee_id}) {
3267 $self->{"employee_${_}"} = $::myconfig{$_} for qw(email tel fax name signature);
3268 $self->{"employee_${_}"} = $defaults->$_ for qw(address businessnumber co_ustid company duns sepa_creditor_id taxnumber);
3271 my $language = $self->{language} ? '_' . $self->{language} : '';
3273 my ($language_tc, $output_numberformat, $output_dateformat, $output_longdates);
3274 if ($self->{language_id}) {
3275 ($language_tc, $output_numberformat, $output_dateformat, $output_longdates) = AM->get_language_details(\%::myconfig, $self, $self->{language_id});
3278 $output_dateformat ||= $::myconfig{dateformat};
3279 $output_numberformat ||= $::myconfig{numberformat};
3280 $output_longdates //= 1;
3282 $self->{myconfig_output_dateformat} = $output_dateformat // $::myconfig{dateformat};
3283 $self->{myconfig_output_longdates} = $output_longdates // 1;
3284 $self->{myconfig_output_numberformat} = $output_numberformat // $::myconfig{numberformat};
3286 # Retrieve accounts for tax calculation.
3287 IC->retrieve_accounts(\%::myconfig, $self, map { $_ => $self->{"id_$_"} } 1 .. $self->{rowcount});
3289 if ($self->{type} =~ /_delivery_order$/) {
3290 DO->order_details(\%::myconfig, $self);
3291 } elsif ($self->{type} =~ /sales_order|sales_quotation|request_quotation|purchase_order/) {
3292 OE->order_details(\%::myconfig, $self);
3294 IS->invoice_details(\%::myconfig, $self, $::locale);
3297 # Chose extension & set source file name
3298 my $extension = 'html';
3299 if ($self->{format} eq 'postscript') {
3300 $self->{postscript} = 1;
3302 } elsif ($self->{"format"} =~ /pdf/) {
3304 $extension = $self->{'format'} =~ m/opendocument/i ? 'odt' : 'tex';
3305 } elsif ($self->{"format"} =~ /opendocument/) {
3306 $self->{opendocument} = 1;
3308 } elsif ($self->{"format"} =~ /excel/) {
3313 my $printer_code = $self->{printer_code} ? '_' . $self->{printer_code} : '';
3314 my $email_extension = $self->{media} eq 'email' && -f ($defaults->templates . "/$self->{formname}_email${language}.${extension}") ? '_email' : '';
3315 $self->{IN} = "$self->{formname}${email_extension}${language}${printer_code}.${extension}";
3318 $self->format_dates($output_dateformat, $output_longdates,
3319 qw(invdate orddate quodate pldate duedate reqdate transdate shippingdate deliverydate validitydate paymentdate datepaid
3320 transdate_oe deliverydate_oe employee_startdate employee_enddate),
3321 grep({ /^(?:datepaid|transdate_oe|reqdate|deliverydate|deliverydate_oe|transdate)_\d+$/ } keys(%{$self})));
3323 $self->reformat_numbers($output_numberformat, 2,
3324 qw(invtotal ordtotal quototal subtotal linetotal listprice sellprice netprice discount tax taxbase total paid),
3325 grep({ /^(?:linetotal|listprice|sellprice|netprice|taxbase|discount|paid|subtotal|total|tax)_\d+$/ } keys(%{$self})));
3327 $self->reformat_numbers($output_numberformat, undef, qw(qty price_factor), grep({ /^qty_\d+$/} keys(%{$self})));
3329 my ($cvar_date_fields, $cvar_number_fields) = CVar->get_field_format_list('module' => 'CT', 'prefix' => 'vc_');
3331 if (scalar @{ $cvar_date_fields }) {
3332 $self->format_dates($output_dateformat, $output_longdates, @{ $cvar_date_fields });
3335 while (my ($precision, $field_list) = each %{ $cvar_number_fields }) {
3336 $self->reformat_numbers($output_numberformat, $precision, @{ $field_list });
3340 if (($self->{language} // '') ne '') {
3341 my $template_arrays = $self->{TEMPLATE_ARRAYS} || $self;
3342 for my $idx (0..scalar(@{ $template_arrays->{unit} }) - 1) {
3343 $template_arrays->{unit}->[$idx] = AM->translate_units($self, $self->{language}, $template_arrays->{unit}->[$idx], $template_arrays->{qty}->[$idx])
3347 $self->{template_meta} = {
3348 formname => $self->{formname},
3349 language => SL::DB::Manager::Language->find_by_or_create(id => $self->{language_id} || undef),
3350 format => $self->{format},
3351 media => $self->{media},
3352 extension => $extension,
3353 printer => SL::DB::Manager::Printer->find_by_or_create(id => $self->{printer_id} || undef),
3354 today => DateTime->today,
3360 sub calculate_arap {
3361 my ($self,$buysell,$taxincluded,$exchangerate,$roundplaces) = @_;
3363 # this function is used to calculate netamount, total_tax and amount for AP and
3364 # AR transactions (Kreditoren-/Debitorenbuchungen) by going over all lines
3366 # Thus it needs a fully prepared $form to work on.
3367 # calculate_arap assumes $form->{amount_$i} entries still need to be parsed
3369 # The calculated total values are all rounded (default is to 2 places) and
3370 # returned as parameters rather than directly modifying form. The aim is to
3371 # make the calculation of AP and AR behave identically. There is a test-case
3372 # for this function in t/form/arap.t
3374 # While calculating the totals $form->{amount_$i} and $form->{tax_$i} are
3375 # modified and formatted and receive the correct sign for writing straight to
3376 # acc_trans, depending on whether they are ar or ap.
3379 die "taxincluded needed in Form->calculate_arap" unless defined $taxincluded;
3380 die "exchangerate needed in Form->calculate_arap" unless defined $exchangerate;
3381 die 'illegal buysell parameter, has to be \"buy\" or \"sell\" in Form->calculate_arap\n' unless $buysell =~ /^(buy|sell)$/;
3382 $roundplaces = 2 unless $roundplaces;
3384 my $sign = 1; # adjust final results for writing amount to acc_trans
3385 $sign = -1 if $buysell eq 'buy';
3387 my ($netamount,$total_tax,$amount);
3391 # parse and round amounts, setting correct sign for writing to acc_trans
3392 for my $i (1 .. $self->{rowcount}) {
3393 $self->{"amount_$i"} = $self->round_amount($self->parse_amount(\%::myconfig, $self->{"amount_$i"}) * $exchangerate * $sign, $roundplaces);
3395 $amount += $self->{"amount_$i"} * $sign;
3398 for my $i (1 .. $self->{rowcount}) {
3399 next unless $self->{"amount_$i"};
3400 ($self->{"tax_id_$i"}) = split /--/, $self->{"taxchart_$i"};
3401 my $tax_id = $self->{"tax_id_$i"};
3403 my $selected_tax = SL::DB::Manager::Tax->find_by(id => "$tax_id");
3405 if ( $selected_tax ) {
3407 if ( $buysell eq 'sell' ) {
3408 $self->{AR_amounts}{"tax_$i"} = $selected_tax->chart->accno if defined $selected_tax->chart;
3410 $self->{AP_amounts}{"tax_$i"} = $selected_tax->chart->accno if defined $selected_tax->chart;
3413 $self->{"taxkey_$i"} = $selected_tax->taxkey;
3414 $self->{"taxrate_$i"} = $selected_tax->rate;
3417 ($self->{"amount_$i"}, $self->{"tax_$i"}) = $self->calculate_tax($self->{"amount_$i"},$self->{"taxrate_$i"},$taxincluded,$roundplaces);
3419 $netamount += $self->{"amount_$i"};
3420 $total_tax += $self->{"tax_$i"};
3423 $amount = $netamount + $total_tax;
3425 # due to $sign amount_$i und tax_$i already have the right sign for acc_trans
3426 # but reverse sign of totals for writing amounts to ar
3427 if ( $buysell eq 'buy' ) {
3433 return($netamount,$total_tax,$amount);
3437 my ($self, $dateformat, $longformat, @indices) = @_;
3439 $dateformat ||= $::myconfig{dateformat};
3441 foreach my $idx (@indices) {
3442 if ($self->{TEMPLATE_ARRAYS} && (ref($self->{TEMPLATE_ARRAYS}->{$idx}) eq "ARRAY")) {
3443 for (my $i = 0; $i < scalar(@{ $self->{TEMPLATE_ARRAYS}->{$idx} }); $i++) {
3444 $self->{TEMPLATE_ARRAYS}->{$idx}->[$i] = $::locale->reformat_date(\%::myconfig, $self->{TEMPLATE_ARRAYS}->{$idx}->[$i], $dateformat, $longformat);
3448 next unless defined $self->{$idx};
3450 if (!ref($self->{$idx})) {
3451 $self->{$idx} = $::locale->reformat_date(\%::myconfig, $self->{$idx}, $dateformat, $longformat);
3453 } elsif (ref($self->{$idx}) eq "ARRAY") {
3454 for (my $i = 0; $i < scalar(@{ $self->{$idx} }); $i++) {
3455 $self->{$idx}->[$i] = $::locale->reformat_date(\%::myconfig, $self->{$idx}->[$i], $dateformat, $longformat);
3461 sub reformat_numbers {
3462 my ($self, $numberformat, $places, @indices) = @_;
3464 return if !$numberformat || ($numberformat eq $::myconfig{numberformat});
3466 foreach my $idx (@indices) {
3467 if ($self->{TEMPLATE_ARRAYS} && (ref($self->{TEMPLATE_ARRAYS}->{$idx}) eq "ARRAY")) {
3468 for (my $i = 0; $i < scalar(@{ $self->{TEMPLATE_ARRAYS}->{$idx} }); $i++) {
3469 $self->{TEMPLATE_ARRAYS}->{$idx}->[$i] = $self->parse_amount(\%::myconfig, $self->{TEMPLATE_ARRAYS}->{$idx}->[$i]);
3473 next unless defined $self->{$idx};
3475 if (!ref($self->{$idx})) {
3476 $self->{$idx} = $self->parse_amount(\%::myconfig, $self->{$idx});
3478 } elsif (ref($self->{$idx}) eq "ARRAY") {
3479 for (my $i = 0; $i < scalar(@{ $self->{$idx} }); $i++) {
3480 $self->{$idx}->[$i] = $self->parse_amount(\%::myconfig, $self->{$idx}->[$i]);
3485 my $saved_numberformat = $::myconfig{numberformat};
3486 $::myconfig{numberformat} = $numberformat;
3488 foreach my $idx (@indices) {
3489 if ($self->{TEMPLATE_ARRAYS} && (ref($self->{TEMPLATE_ARRAYS}->{$idx}) eq "ARRAY")) {
3490 for (my $i = 0; $i < scalar(@{ $self->{TEMPLATE_ARRAYS}->{$idx} }); $i++) {
3491 $self->{TEMPLATE_ARRAYS}->{$idx}->[$i] = $self->format_amount(\%::myconfig, $self->{TEMPLATE_ARRAYS}->{$idx}->[$i], $places);
3495 next unless defined $self->{$idx};
3497 if (!ref($self->{$idx})) {
3498 $self->{$idx} = $self->format_amount(\%::myconfig, $self->{$idx}, $places);
3500 } elsif (ref($self->{$idx}) eq "ARRAY") {
3501 for (my $i = 0; $i < scalar(@{ $self->{$idx} }); $i++) {
3502 $self->{$idx}->[$i] = $self->format_amount(\%::myconfig, $self->{$idx}->[$i], $places);
3507 $::myconfig{numberformat} = $saved_numberformat;
3510 sub create_email_signature {
3512 my $client_signature = $::instance_conf->get_signature;
3513 my $user_signature = $::myconfig{signature};
3516 if ( $client_signature or $user_signature ) {
3517 $signature = "\n\n-- \n";
3518 $signature .= $user_signature . "\n" if $user_signature;
3519 $signature .= $client_signature . "\n" if $client_signature;
3526 # this function calculates the net amount and tax for the lines in ar, ap and
3527 # gl and is used for update as well as post. When used with update the return
3528 # value of amount isn't needed
3530 # calculate_tax should always work with positive values, or rather as the user inputs them
3531 # calculate_tax uses db/perl numberformat, i.e. parsed numbers
3532 # convert to negative numbers (when necessary) only when writing to acc_trans
3533 # the amount from $form for ap/ar/gl is currently always rounded to 2 decimals before it reaches here
3534 # for post_transaction amount already contains exchangerate and correct sign and is rounded
3535 # calculate_tax doesn't (need to) know anything about exchangerate
3537 my ($self,$amount,$taxrate,$taxincluded,$roundplaces) = @_;
3545 # calculate tax (unrounded), subtract from amount, round amount and round tax
3546 $tax = $amount - ($amount / ($taxrate + 1)); # equivalent to: taxrate * amount / (taxrate + 1)
3547 $amount = $self->round_amount($amount - $tax, $roundplaces);
3548 $tax = $self->round_amount($tax, $roundplaces);
3550 $tax = $amount * $taxrate;
3551 $tax = $self->round_amount($tax, $roundplaces);
3554 $tax = 0 unless $tax;
3556 return ($amount,$tax);
3565 SL::Form.pm - main data object.
3569 This is the main data object of kivitendo.
3570 Unfortunately it also acts as a god object for certain data retrieval procedures used in the entry points.
3571 Points of interest for a beginner are:
3573 - $form->error - renders a generic error in html. accepts an error message
3574 - $form->get_standard_dbh - returns a database connection for the
3576 =head1 SPECIAL FUNCTIONS
3578 =head2 C<redirect_header> $url
3580 Generates a HTTP redirection header for the new C<$url>. Constructs an
3581 absolute URL including scheme, host name and port. If C<$url> is a
3582 relative URL then it is considered relative to kivitendo base URL.
3584 This function C<die>s if headers have already been created with
3585 C<$::form-E<gt>header>.
3589 print $::form->redirect_header('oe.pl?action=edit&id=1234');
3590 print $::form->redirect_header('http://www.lx-office.org/');
3594 Generates a general purpose http/html header and includes most of the scripts
3595 and stylesheets needed. Stylesheets can be added with L<use_stylesheet>.
3597 Only one header will be generated. If the method was already called in this
3598 request it will not output anything and return undef. Also if no
3599 HTTP_USER_AGENT is found, no header is generated.
3601 Although header does not accept parameters itself, it will honor special
3602 hashkeys of its Form instance:
3610 If one of these is set, a http-equiv refresh is generated. Missing parameters
3611 default to 3 seconds and the refering url.
3615 Either a scalar or an array ref. Will be inlined into the header. Add
3616 stylesheets with the L<use_stylesheet> function.
3620 If true, a css snippet will be generated that sets the page in landscape mode.
3624 Used to override the default favicon.
3628 A html page title will be generated from this
3630 =item mtime_ischanged
3632 Tries to avoid concurrent write operations to records by checking the database mtime with a fetched one.
3634 Can be used / called with any table, that has itime and mtime attributes.
3635 Valid C<table> names are: oe, ar, ap, delivery_orders, parts.
3636 Can be called wit C<option> mail to generate a different error message.
3638 Returns undef if no save operation has been done yet ($self->{id} not present).
3639 Returns undef if no concurrent write process is detected otherwise a error message.