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 #======================================================================
63 use SL::DB::PaymentTerm;
66 use SL::Helper::Flash qw();
69 use SL::Layout::Dispatcher;
71 use SL::Locale::String;
74 use SL::MoreCommon qw(uri_encode uri_decode);
76 use SL::PrefixedNumber;
84 use List::Util qw(first max min sum);
85 use List::MoreUtils qw(all any apply);
87 use SL::Helper::File qw(:all);
88 use SL::Helper::CreatePDF qw(merge_pdfs);
95 open VERSION_FILE, "VERSION"; # New but flexible code reads version from VERSION-file
96 my $version = <VERSION_FILE>;
97 $version =~ s/[^0-9A-Za-z\.\_\-]//g; # only allow numbers, letters, points, underscores and dashes. Prevents injecting of malicious code.
104 $main::lxdebug->enter_sub();
111 if ($LXDebug::watch_form) {
112 require SL::Watchdog;
113 tie %{ $self }, 'SL::Watchdog';
118 $self->{version} = $self->read_version;
120 $main::lxdebug->leave_sub();
127 SL::Request::read_cgi_input($self);
130 sub _flatten_variables_rec {
131 $main::lxdebug->enter_sub(2);
140 if ('' eq ref $curr->{$key}) {
141 @result = ({ 'key' => $prefix . $key, 'value' => $curr->{$key} });
143 } elsif ('HASH' eq ref $curr->{$key}) {
144 foreach my $hash_key (sort keys %{ $curr->{$key} }) {
145 push @result, $self->_flatten_variables_rec($curr->{$key}, $prefix . $key . '.', $hash_key);
149 foreach my $idx (0 .. scalar @{ $curr->{$key} } - 1) {
150 my $first_array_entry = 1;
152 my $element = $curr->{$key}[$idx];
154 if ('HASH' eq ref $element) {
155 foreach my $hash_key (sort keys %{ $element }) {
156 push @result, $self->_flatten_variables_rec($element, $prefix . $key . ($first_array_entry ? '[+].' : '[].'), $hash_key);
157 $first_array_entry = 0;
160 @result = ({ 'key' => $prefix . $key . ($first_array_entry ? '[+]' : '[]'), 'value' => $element });
165 $main::lxdebug->leave_sub(2);
170 sub flatten_variables {
171 $main::lxdebug->enter_sub(2);
179 push @variables, $self->_flatten_variables_rec($self, '', $_);
182 $main::lxdebug->leave_sub(2);
187 sub flatten_standard_variables {
188 $main::lxdebug->enter_sub(2);
191 my %skip_keys = map { $_ => 1 } (qw(login password header stylesheet titlebar version), @_);
195 foreach (grep { ! $skip_keys{$_} } keys %{ $self }) {
196 push @variables, $self->_flatten_variables_rec($self, '', $_);
199 $main::lxdebug->leave_sub(2);
205 $main::lxdebug->enter_sub();
211 map { print "$_ = $self->{$_}\n" } (sort keys %{$self});
213 $main::lxdebug->leave_sub();
217 $main::lxdebug->enter_sub(2);
220 my $password = $self->{password};
222 $self->{password} = 'X' x 8;
224 local $Data::Dumper::Sortkeys = 1;
225 my $output = Dumper($self);
227 $self->{password} = $password;
229 $main::lxdebug->leave_sub(2);
235 my ($self, $str) = @_;
237 return uri_encode($str);
241 my ($self, $str) = @_;
243 return uri_decode($str);
247 $main::lxdebug->enter_sub();
248 my ($self, $str) = @_;
250 if ($str && !ref($str)) {
251 $str =~ s/\"/"/g;
254 $main::lxdebug->leave_sub();
260 $main::lxdebug->enter_sub();
261 my ($self, $str) = @_;
263 if ($str && !ref($str)) {
264 $str =~ s/"/\"/g;
267 $main::lxdebug->leave_sub();
273 $main::lxdebug->enter_sub();
277 map({ print($::request->{cgi}->hidden("-name" => $_, "-default" => $self->{$_}) . "\n"); } @_);
279 for (sort keys %$self) {
280 next if (($_ eq "header") || (ref($self->{$_}) ne ""));
281 print($::request->{cgi}->hidden("-name" => $_, "-default" => $self->{$_}) . "\n");
284 $main::lxdebug->leave_sub();
288 my ($self, $code) = @_;
289 local $self->{__ERROR_HANDLER} = sub { die SL::X::FormError->new($_[0]) };
294 $main::lxdebug->enter_sub();
296 $main::lxdebug->show_backtrace();
298 my ($self, $msg) = @_;
300 if ($self->{__ERROR_HANDLER}) {
301 $self->{__ERROR_HANDLER}->($msg);
303 } elsif ($ENV{HTTP_USER_AGENT}) {
305 $self->show_generic_error($msg);
308 confess "Error: $msg\n";
311 $main::lxdebug->leave_sub();
315 $main::lxdebug->enter_sub();
317 my ($self, $msg) = @_;
319 if ($ENV{HTTP_USER_AGENT}) {
321 print $self->parse_html_template('generic/form_info', { message => $msg });
323 } elsif ($self->{info_function}) {
324 &{ $self->{info_function} }($msg);
329 $main::lxdebug->leave_sub();
332 # calculates the number of rows in a textarea based on the content and column number
333 # can be capped with maxrows
335 $main::lxdebug->enter_sub();
336 my ($self, $str, $cols, $maxrows, $minrows) = @_;
340 my $rows = sum map { int((length() - 2) / $cols) + 1 } split /\r/, $str;
343 $main::lxdebug->leave_sub();
345 return max(min($rows, $maxrows), $minrows);
349 my ($self, $msg) = @_;
351 die SL::X::DBError->new(
353 error => $DBI::errstr,
358 $main::lxdebug->enter_sub();
360 my ($self, $name, $msg) = @_;
363 foreach my $part (split m/\./, $name) {
364 if (!$curr->{$part} || ($curr->{$part} =~ /^\s*$/)) {
367 $curr = $curr->{$part};
370 $main::lxdebug->leave_sub();
373 sub _get_request_uri {
376 return URI->new($ENV{HTTP_REFERER})->canonical() if $ENV{HTTP_X_FORWARDED_FOR};
377 return URI->new if !$ENV{REQUEST_URI}; # for testing
379 my $scheme = $ENV{HTTPS} && (lc $ENV{HTTPS} eq 'on') ? 'https' : 'http';
380 my $port = $ENV{SERVER_PORT};
381 $port = undef if (($scheme eq 'http' ) && ($port == 80))
382 || (($scheme eq 'https') && ($port == 443));
384 my $uri = URI->new("${scheme}://");
385 $uri->scheme($scheme);
387 $uri->host($ENV{HTTP_HOST} || $ENV{SERVER_ADDR});
388 $uri->path_query($ENV{REQUEST_URI});
394 sub _add_to_request_uri {
397 my $relative_new_path = shift;
398 my $request_uri = shift || $self->_get_request_uri;
399 my $relative_new_uri = URI->new($relative_new_path);
400 my @request_segments = $request_uri->path_segments;
402 my $new_uri = $request_uri->clone;
403 $new_uri->path_segments(@request_segments[0..scalar(@request_segments) - 2], $relative_new_uri->path_segments);
408 sub create_http_response {
409 $main::lxdebug->enter_sub();
414 my $cgi = $::request->{cgi};
417 if (defined $main::auth) {
418 my $uri = $self->_get_request_uri;
419 my @segments = $uri->path_segments;
421 $uri->path_segments(@segments);
423 my $session_cookie_value = $main::auth->get_session_id();
425 if ($session_cookie_value) {
426 $session_cookie = $cgi->cookie('-name' => $main::auth->get_session_cookie_name(),
427 '-value' => $session_cookie_value,
428 '-path' => $uri->path,
429 '-secure' => $ENV{HTTPS});
433 my %cgi_params = ('-type' => $params{content_type});
434 $cgi_params{'-charset'} = $params{charset} if ($params{charset});
435 $cgi_params{'-cookie'} = $session_cookie if ($session_cookie);
437 map { $cgi_params{'-' . $_} = $params{$_} if exists $params{$_} } qw(content_disposition content_length);
439 my $output = $cgi->header(%cgi_params);
441 $main::lxdebug->leave_sub();
447 $::lxdebug->enter_sub;
449 my ($self, %params) = @_;
452 $::lxdebug->leave_sub and return if !$ENV{HTTP_USER_AGENT} || $self->{header}++;
454 if ($params{no_layout}) {
455 $::request->{layout} = SL::Layout::Dispatcher->new(style => 'none');
458 my $layout = $::request->{layout};
460 # standard css for all
461 # this should gradually move to the layouts that need it
462 $layout->use_stylesheet("$_.css") for qw(
463 common main menu list_accounts jquery.autocomplete
464 jquery.multiselect2side
465 ui-lightness/jquery-ui
467 tooltipster themes/tooltipster-light
470 $layout->use_javascript("$_.js") for (qw(
471 jquery jquery-ui jquery.cookie jquery.checkall jquery.download
472 jquery/jquery.form jquery/fixes client_js
473 jquery/jquery.tooltipster.min
474 common part_selection
475 ), "jquery/ui/i18n/jquery.ui.datepicker-$::myconfig{countrycode}");
477 $self->{favicon} ||= "favicon.ico";
478 $self->{titlebar} = join ' - ', grep $_, $self->{title}, $self->{login}, $::myconfig{dbname}, $self->{version} if $self->{title} || !$self->{titlebar};
481 if ($self->{refresh_url} || $self->{refresh_time}) {
482 my $refresh_time = $self->{refresh_time} || 3;
483 my $refresh_url = $self->{refresh_url} || $ENV{REFERER};
484 push @header, "<meta http-equiv='refresh' content='$refresh_time;$refresh_url'>";
487 my $auto_reload_resources_param = $layout->auto_reload_resources_param;
489 push @header, map { qq|<link rel="stylesheet" href="${_}${auto_reload_resources_param}" type="text/css" title="Stylesheet">| } $layout->stylesheets;
490 push @header, "<style type='text/css'>\@page { size:landscape; }</style> " if $self->{landscape};
491 push @header, "<link rel='shortcut icon' href='$self->{favicon}' type='image/x-icon'>" if -f $self->{favicon};
492 push @header, map { qq|<script type="text/javascript" src="${_}${auto_reload_resources_param}"></script>| } $layout->javascripts;
493 push @header, $self->{javascript} if $self->{javascript};
494 push @header, map { $_->show_javascript } @{ $self->{AJAX} || [] };
497 strict => qq|<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">|,
498 transitional => qq|<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">|,
499 frameset => qq|<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">|,
500 html5 => qq|<!DOCTYPE html>|,
504 print $self->create_http_response(content_type => 'text/html', charset => 'UTF-8');
505 print $doctypes{$params{doctype} || 'transitional'}, $/;
509 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
510 <title>$self->{titlebar}</title>
512 print " $_\n" for @header;
514 <meta name="robots" content="noindex,nofollow">
519 print $::request->{layout}->pre_content;
520 print $::request->{layout}->start_content;
522 $layout->header_done;
524 $::lxdebug->leave_sub;
528 return unless $::request->{layout}->need_footer;
530 print $::request->{layout}->end_content;
531 print $::request->{layout}->post_content;
533 if (my @inline_scripts = $::request->{layout}->javascripts_inline) {
534 print "<script type='text/javascript'>" . join("; ", @inline_scripts) . "</script>\n";
543 sub ajax_response_header {
544 $main::lxdebug->enter_sub();
548 my $output = $::request->{cgi}->header('-charset' => 'UTF-8');
550 $main::lxdebug->leave_sub();
555 sub redirect_header {
559 my $base_uri = $self->_get_request_uri;
560 my $new_uri = URI->new_abs($new_url, $base_uri);
562 die "Headers already sent" if $self->{header};
565 return $::request->{cgi}->redirect($new_uri);
568 sub set_standard_title {
569 $::lxdebug->enter_sub;
572 $self->{titlebar} = "kivitendo " . $::locale->text('Version') . " $self->{version}";
573 $self->{titlebar} .= "- $::myconfig{name}" if $::myconfig{name};
574 $self->{titlebar} .= "- $::myconfig{dbname}" if $::myconfig{name};
576 $::lxdebug->leave_sub;
579 sub _prepare_html_template {
580 $main::lxdebug->enter_sub();
582 my ($self, $file, $additional_params) = @_;
585 if (!%::myconfig || !$::myconfig{"countrycode"}) {
586 $language = $::lx_office_conf{system}->{language};
588 $language = $main::myconfig{"countrycode"};
590 $language = "de" unless ($language);
592 if (-f "templates/webpages/${file}.html") {
593 $file = "templates/webpages/${file}.html";
595 } elsif (ref $file eq 'SCALAR') {
596 # file is a scalarref, use inline mode
598 my $info = "Web page template '${file}' not found.\n";
600 print qq|<pre>$info</pre>|;
601 $::dispatcher->end_request;
604 $additional_params->{AUTH} = $::auth;
605 $additional_params->{INSTANCE_CONF} = $::instance_conf;
606 $additional_params->{LOCALE} = $::locale;
607 $additional_params->{LXCONFIG} = \%::lx_office_conf;
608 $additional_params->{LXDEBUG} = $::lxdebug;
609 $additional_params->{MYCONFIG} = \%::myconfig;
611 $main::lxdebug->leave_sub();
616 sub parse_html_template {
617 $main::lxdebug->enter_sub();
619 my ($self, $file, $additional_params) = @_;
621 $additional_params ||= { };
623 my $real_file = $self->_prepare_html_template($file, $additional_params);
624 my $template = $self->template || $self->init_template;
626 map { $additional_params->{$_} ||= $self->{$_} } keys %{ $self };
629 $template->process($real_file, $additional_params, \$output) || die $template->error;
631 $main::lxdebug->leave_sub();
639 return $self->template if $self->template;
641 # Force scripts/locales.pl to pick up the exception handling template.
642 # parse_html_template('generic/exception')
643 return $self->template(Template->new({
648 'PLUGIN_BASE' => 'SL::Template::Plugin',
649 'INCLUDE_PATH' => '.:templates/webpages',
650 'COMPILE_EXT' => '.tcc',
651 'COMPILE_DIR' => $::lx_office_conf{paths}->{userspath} . '/templates-cache',
652 'ERROR' => 'templates/webpages/generic/exception.html',
653 'ENCODING' => 'utf8',
659 $self->{template_object} = shift if @_;
660 return $self->{template_object};
663 sub show_generic_error {
664 $main::lxdebug->enter_sub();
666 my ($self, $error, %params) = @_;
668 if ($self->{__ERROR_HANDLER}) {
669 $self->{__ERROR_HANDLER}->($error);
670 $main::lxdebug->leave_sub();
674 if ($::request->is_ajax) {
677 ->render(SL::Controller::Base->new);
678 $::dispatcher->end_request;
682 'title_error' => $params{title},
683 'label_error' => $error,
686 $self->{title} = $params{title} if $params{title};
689 print $self->parse_html_template("generic/error", $add_params);
691 print STDERR "Error: $error\n";
693 $main::lxdebug->leave_sub();
695 $::dispatcher->end_request;
698 sub show_generic_information {
699 $main::lxdebug->enter_sub();
701 my ($self, $text, $title) = @_;
704 'title_information' => $title,
705 'label_information' => $text,
708 $self->{title} = $title if ($title);
711 print $self->parse_html_template("generic/information", $add_params);
713 $main::lxdebug->leave_sub();
715 $::dispatcher->end_request;
718 sub _store_redirect_info_in_session {
721 return unless $self->{callback} =~ m:^ ( [^\?/]+ \.pl ) \? (.+) :x;
723 my ($controller, $params) = ($1, $2);
724 my $form = { map { map { $self->unescape($_) } split /=/, $_, 2 } split m/\&/, $params };
725 $self->{callback} = "${controller}?RESTORE_FORM_FROM_SESSION_ID=" . $::auth->save_form_in_session(form => $form);
729 $main::lxdebug->enter_sub();
731 my ($self, $msg) = @_;
733 if (!$self->{callback}) {
737 SL::Helper::Flash::flash_later('info', $msg) if $msg;
738 $self->_store_redirect_info_in_session;
739 print $::form->redirect_header($self->{callback});
742 $::dispatcher->end_request;
744 $main::lxdebug->leave_sub();
747 # sort of columns removed - empty sub
749 $main::lxdebug->enter_sub();
751 my ($self, @columns) = @_;
753 $main::lxdebug->leave_sub();
759 $main::lxdebug->enter_sub(2);
761 my ($self, $myconfig, $amount, $places, $dash) = @_;
764 my $neg = $amount < 0;
765 my $force_places = defined $places && $places >= 0;
767 $amount = $self->round_amount($amount, abs $places) if $force_places;
768 $neg = 0 if $amount == 0; # don't show negative zero
769 $amount = sprintf "%.*f", ($force_places ? $places : 10), abs $amount; # 6 is default for %fa
771 # before the sprintf amount was a number, afterwards it's a string. because of the dynamic nature of perl
772 # this is easy to confuse, so keep in mind: before this comment no s///, m//, concat or other strong ops on
773 # $amount. after this comment no +,-,*,/,abs. it will only introduce subtle bugs.
775 $amount =~ s/0*$// unless defined $places && $places == 0; # cull trailing 0s
777 my @d = map { s/\d//g; reverse split // } my $tmp = $myconfig->{numberformat}; # get delim chars
778 my @p = split(/\./, $amount); # split amount at decimal point
780 $p[0] =~ s/\B(?=(...)*$)/$d[1]/g if $d[1]; # add 1,000 delimiters
782 if ($places || $p[1]) {
785 . (0 x max(abs($places || 0) - length ($p[1]||''), 0)); # pad the fraction
789 ($dash =~ /-/) ? ($neg ? "($amount)" : "$amount" ) :
790 ($dash =~ /DRCR/) ? ($neg ? "$amount " . $main::locale->text('DR') : "$amount " . $main::locale->text('CR') ) :
791 ($neg ? "-$amount" : "$amount" ) ;
794 $main::lxdebug->leave_sub(2);
798 sub format_amount_units {
799 $main::lxdebug->enter_sub();
804 my $myconfig = \%main::myconfig;
805 my $amount = $params{amount} * 1;
806 my $places = $params{places};
807 my $part_unit_name = $params{part_unit};
808 my $amount_unit_name = $params{amount_unit};
809 my $conv_units = $params{conv_units};
810 my $max_places = $params{max_places};
812 if (!$part_unit_name) {
813 $main::lxdebug->leave_sub();
817 my $all_units = AM->retrieve_all_units;
819 if (('' eq ref $conv_units) && ($conv_units =~ /convertible/)) {
820 $conv_units = AM->convertible_units($all_units, $part_unit_name, $conv_units eq 'convertible_not_smaller');
823 if (!scalar @{ $conv_units }) {
824 my $result = $self->format_amount($myconfig, $amount, $places, undef, $max_places) . " " . $part_unit_name;
825 $main::lxdebug->leave_sub();
829 my $part_unit = $all_units->{$part_unit_name};
830 my $conv_unit = ($amount_unit_name && ($amount_unit_name ne $part_unit_name)) ? $all_units->{$amount_unit_name} : $part_unit;
832 $amount *= $conv_unit->{factor};
837 foreach my $unit (@$conv_units) {
838 my $last = $unit->{name} eq $part_unit->{name};
840 $num = int($amount / $unit->{factor});
841 $amount -= $num * $unit->{factor};
844 if ($last ? $amount : $num) {
845 push @values, { "unit" => $unit->{name},
846 "amount" => $last ? $amount / $unit->{factor} : $num,
847 "places" => $last ? $places : 0 };
854 push @values, { "unit" => $part_unit_name,
859 my $result = join " ", map { $self->format_amount($myconfig, $_->{amount}, $_->{places}, undef, $max_places), $_->{unit} } @values;
861 $main::lxdebug->leave_sub();
867 $main::lxdebug->enter_sub(2);
872 $input =~ s/(^|[^\#]) \# (\d+) /$1$_[$2 - 1]/gx;
873 $input =~ s/(^|[^\#]) \#\{(\d+)\}/$1$_[$2 - 1]/gx;
874 $input =~ s/\#\#/\#/g;
876 $main::lxdebug->leave_sub(2);
884 $main::lxdebug->enter_sub(2);
886 my ($self, $myconfig, $amount) = @_;
888 if (!defined($amount) || ($amount eq '')) {
889 $main::lxdebug->leave_sub(2);
893 if ( ($myconfig->{numberformat} eq '1.000,00')
894 || ($myconfig->{numberformat} eq '1000,00')) {
899 if ($myconfig->{numberformat} eq "1'000.00") {
905 $main::lxdebug->leave_sub(2);
907 # Make sure no code wich is not a math expression ends up in eval().
908 return 0 unless $amount =~ /^ [\s \d \( \) \- \+ \* \/ \. ]* $/x;
910 # Prevent numbers from being parsed as octals;
911 $amount =~ s{ (?<! [\d.] ) 0+ (?= [1-9] ) }{}gx;
913 return scalar(eval($amount)) * 1 ;
917 my ($self, $amount, $places, $adjust) = @_;
919 return 0 if !defined $amount;
924 my $precision = $::instance_conf->get_precision || 0.01;
925 return $self->round_amount( $self->round_amount($amount / $precision, 0) * $precision, $places);
928 # We use Perl's knowledge of string representation for
929 # rounding. First, convert the floating point number to a string
930 # with a high number of places. Then split the string on the decimal
931 # sign and use integer calculation for rounding the decimal places
932 # part. If an overflow occurs then apply that overflow to the part
933 # before the decimal sign as well using integer arithmetic again.
935 my $int_amount = int(abs $amount);
936 my $str_places = max(min(10, 16 - length("$int_amount") - $places), $places);
937 my $amount_str = sprintf '%.*f', $places + $str_places, abs($amount);
939 return $amount unless $amount_str =~ m{^(\d+)\.(\d+)$};
941 my ($pre, $post) = ($1, $2);
942 my $decimals = '1' . substr($post, 0, $places);
944 my $propagation_limit = $Config{i32size} == 4 ? 7 : 18;
945 my $add_for_rounding = substr($post, $places, 1) >= 5 ? 1 : 0;
947 if ($places > $propagation_limit) {
948 $decimals = Math::BigInt->new($decimals)->badd($add_for_rounding);
949 $pre = Math::BigInt->new($decimals)->badd(1) if substr($decimals, 0, 1) eq '2';
952 $decimals += $add_for_rounding;
953 $pre += 1 if substr($decimals, 0, 1) eq '2';
956 $amount = ("${pre}." . substr($decimals, 1)) * ($amount <=> 0);
962 $main::lxdebug->enter_sub();
964 my ($self, $myconfig) = @_;
965 my ($out, $out_mode);
969 my $defaults = SL::DB::Default->get;
970 my $userspath = $::lx_office_conf{paths}->{userspath};
972 $self->{"cwd"} = getcwd();
973 $self->{"tmpdir"} = $self->{cwd} . "/${userspath}";
978 if ($self->{"format"} =~ /(opendocument|oasis)/i) {
979 $template_type = 'OpenDocument';
980 $ext_for_format = $self->{"format"} =~ m/pdf/ ? 'pdf' : 'odt';
982 } elsif ($self->{"format"} =~ /(postscript|pdf)/i) {
983 $template_type = 'LaTeX';
984 $ext_for_format = 'pdf';
986 } elsif (($self->{"format"} =~ /html/i) || (!$self->{"format"} && ($self->{"IN"} =~ /html$/i))) {
987 $template_type = 'HTML';
988 $ext_for_format = 'html';
990 } elsif (($self->{"format"} =~ /xml/i) || (!$self->{"format"} && ($self->{"IN"} =~ /xml$/i))) {
991 $template_type = 'XML';
992 $ext_for_format = 'xml';
994 } elsif ( $self->{"format"} =~ /elster(?:winston|taxbird)/i ) {
995 $template_type = 'XML';
997 } elsif ( $self->{"format"} =~ /excel/i ) {
998 $template_type = 'Excel';
999 $ext_for_format = 'xls';
1001 } elsif ( defined $self->{'format'}) {
1002 $self->error("Outputformat not defined. This may be a future feature: $self->{'format'}");
1004 } elsif ( $self->{'format'} eq '' ) {
1005 $self->error("No Outputformat given: $self->{'format'}");
1007 } else { #Catch the rest
1008 $self->error("Outputformat not defined: $self->{'format'}");
1011 my $template = SL::Template::create(type => $template_type,
1012 file_name => $self->{IN},
1014 myconfig => $myconfig,
1015 userspath => $userspath,
1016 %{ $self->{TEMPLATE_DRIVER_OPTIONS} || {} });
1018 # Copy the notes from the invoice/sales order etc. back to the variable "notes" because that is where most templates expect it to be.
1019 $self->{"notes"} = $self->{ $self->{"formname"} . "notes" } if exists $self->{ $self->{"formname"} . "notes" };
1021 if (!$self->{employee_id}) {
1022 $self->{"employee_${_}"} = $myconfig->{$_} for qw(email tel fax name signature);
1023 $self->{"employee_${_}"} = $defaults->$_ for qw(address businessnumber co_ustid company duns sepa_creditor_id taxnumber);
1026 $self->{"myconfig_${_}"} = $myconfig->{$_} for grep { $_ ne 'dbpasswd' } keys %{ $myconfig };
1027 $self->{$_} = $defaults->$_ for qw(co_ustid);
1028 $self->{"myconfig_${_}"} = $defaults->$_ for qw(address businessnumber co_ustid company duns sepa_creditor_id taxnumber);
1029 $self->{AUTH} = $::auth;
1030 $self->{INSTANCE_CONF} = $::instance_conf;
1031 $self->{LOCALE} = $::locale;
1032 $self->{LXCONFIG} = $::lx_office_conf;
1033 $self->{LXDEBUG} = $::lxdebug;
1034 $self->{MYCONFIG} = \%::myconfig;
1036 $self->{copies} = 1 if (($self->{copies} *= 1) <= 0);
1038 # OUT is used for the media, screen, printer, email
1039 # for postscript we store a copy in a temporary file
1040 my ($temp_fh, $suffix);
1041 $suffix = $self->{IN};
1042 $suffix =~ s/.*\.//;
1043 ($temp_fh, $self->{tmpfile}) = File::Temp::tempfile(
1044 'kivitendo-printXXXXXX',
1045 SUFFIX => '.' . ($suffix || 'tex'),
1047 UNLINK => ($::lx_office_conf{debug} && $::lx_office_conf{debug}->{keep_temp_files})? 0 : 1,
1050 (undef, undef, $self->{template_meta}{tmpfile}) = File::Spec->splitpath( $self->{tmpfile} );
1052 $out = $self->{OUT};
1053 $out_mode = $self->{OUT_MODE} || '>';
1054 $self->{OUT} = "$self->{tmpfile}";
1055 $self->{OUT_MODE} = '>';
1058 my $command_formatter = sub {
1059 my ($out_mode, $out) = @_;
1060 return $out_mode eq '|-' ? SL::Template::create(type => 'ShellCommand', form => $self)->parse($out) : $out;
1064 $self->{OUT} = $command_formatter->($self->{OUT_MODE}, $self->{OUT});
1065 open(OUT, $self->{OUT_MODE}, $self->{OUT}) or $self->error("error on opening $self->{OUT} with mode $self->{OUT_MODE} : $!");
1067 *OUT = ($::dispatcher->get_standard_filehandles)[1];
1071 if (!$template->parse(*OUT)) {
1073 $self->error("$self->{IN} : " . $template->get_error());
1076 close OUT if $self->{OUT};
1077 # check only one flag (webdav_documents)
1078 # therefore copy to webdav, even if we do not have the webdav feature enabled (just archive)
1079 my $copy_to_webdav = $::instance_conf->get_webdav_documents && !$self->{preview} && $self->{tmpdir} && $self->{tmpfile} && $self->{type};
1081 if ( $ext_for_format eq 'pdf' && $::instance_conf->get_doc_storage ) {
1082 $self->append_general_pdf_attachments(filepath => $self->{tmpdir}."/".$self->{tmpfile},
1083 type => $self->{type});
1085 if ($self->{media} eq 'file') {
1086 copy(join('/', $self->{cwd}, $userspath, $self->{tmpfile}), $out =~ m|^/| ? $out : join('/', $self->{cwd}, $out)) if $template->uses_temp_file;
1087 Common::copy_file_to_webdav_folder($self) if $copy_to_webdav;
1088 if (!$self->{preview} && $::instance_conf->get_doc_storage)
1090 $self->{attachment_filename} ||= $self->generate_attachment_filename;
1091 $self->store_pdf($self);
1094 chdir("$self->{cwd}");
1096 $::lxdebug->leave_sub();
1101 Common::copy_file_to_webdav_folder($self) if $copy_to_webdav;
1103 if ( !$self->{preview} && $ext_for_format eq 'pdf' && $::instance_conf->get_doc_storage) {
1104 $self->{attachment_filename} ||= $self->generate_attachment_filename;
1105 $self->{print_file_id} = $self->store_pdf($self)->id;
1107 if ($self->{media} eq 'email') {
1108 if ( getcwd() eq $self->{"tmpdir"} ) {
1109 # in the case of generating pdf we are in the tmpdir, but WHY ???
1110 $self->{tmpfile} = $userspath."/".$self->{tmpfile};
1111 chdir("$self->{cwd}");
1113 $self->send_email(\%::myconfig,$ext_for_format);
1116 $self->{OUT} = $out;
1117 $self->{OUT_MODE} = $out_mode;
1118 $self->output_file($template->get_mime_type,$command_formatter);
1120 delete $self->{print_file_id};
1124 chdir("$self->{cwd}");
1125 $main::lxdebug->leave_sub();
1128 sub get_bcc_defaults {
1129 my ($self, $myconfig, $mybcc) = @_;
1130 if (SL::DB::Default->get->bcc_to_login) {
1131 $mybcc .= ", " if $mybcc;
1132 $mybcc .= $myconfig->{email};
1134 my $otherbcc = SL::DB::Default->get->global_bcc;
1136 $mybcc .= ", " if $mybcc;
1137 $mybcc .= $otherbcc;
1143 $main::lxdebug->enter_sub();
1144 my ($self, $myconfig, $ext_for_format) = @_;
1145 my $mail = Mailer->new;
1147 map { $mail->{$_} = $self->{$_} }
1148 qw(cc subject message version format);
1150 $mail->{bcc} = $self->get_bcc_defaults($myconfig, $self->{bcc});
1151 $mail->{to} = $self->{EMAIL_RECIPIENT} ? $self->{EMAIL_RECIPIENT} : $self->{email};
1152 $mail->{from} = qq|"$myconfig->{name}" <$myconfig->{email}>|;
1153 $mail->{fileid} = time() . '.' . $$ . '.';
1154 my $full_signature = $self->create_email_signature();
1155 $full_signature =~ s/\r//g;
1157 $mail->{attachments} = [];
1159 # if we send html or plain text inline
1160 if (($self->{format} eq 'html') && ($self->{sendmode} eq 'inline')) {
1161 $mail->{contenttype} = "text/html";
1162 $mail->{message} =~ s/\r//g;
1163 $mail->{message} =~ s/\n/<br>\n/g;
1164 $full_signature =~ s/\n/<br>\n/g;
1165 $mail->{message} .= $full_signature;
1167 open(IN, "<", $self->{tmpfile})
1168 or $self->error($self->cleanup . "$self->{tmpfile} : $!");
1169 $mail->{message} .= $_ while <IN>;
1173 $main::lxdebug->message(LXDebug->DEBUG2(),"action_oldfile=" . $self->{action_oldfile}." action_nofile=".$self->{action_nofile});
1174 if (!$self->{"do_not_attach"} && !$self->{action_nofile}) {
1175 my $attachment_name = $self->{attachment_filename} || $self->{tmpfile};
1176 $attachment_name =~ s/\.(.+?)$/.${ext_for_format}/ if ($ext_for_format);
1177 if ( $self->{action_oldfile} ) {
1178 $main::lxdebug->message(LXDebug->DEBUG2(),"object_id =>". $self->{id}." object_type =>". $self->{formname});
1179 my ( $attfile ) = SL::File->get_all(object_id => $self->{id},
1180 object_type => $self->{formname},
1181 file_type => 'document');
1182 $main::lxdebug->message(LXDebug->DEBUG2(), "old file obj=".$attfile);
1183 push @attfiles, $attfile if $attfile;
1185 push @{ $mail->{attachments} }, { path => $self->{tmpfile},
1186 id => $self->{print_file_id},
1187 type => "application/pdf",
1188 name => $attachment_name };
1192 if (!$self->{"do_not_attach"}) {
1193 for my $i (1 .. $self->{attfile_count}) {
1194 if ( $self->{"attsel_$i"} ) {
1195 my $attfile = SL::File->get(id => $self->{"attfile_$i"});
1196 $main::lxdebug->message(LXDebug->DEBUG2(), "att file=".$self->{"attfile_$i"}." obj=".$attfile);
1197 push @attfiles, $attfile if $attfile;
1200 for my $i (1 .. $self->{attfile_cv_count}) {
1201 if ( $self->{"attsel_cv_$i"} ) {
1202 my $attfile = SL::File->get(id => $self->{"attfile_cv_$i"});
1203 $main::lxdebug->message(LXDebug->DEBUG2(), "att file=".$self->{"attfile_$i"}." obj=".$attfile);
1204 push @attfiles, $attfile if $attfile;
1207 for my $i (1 .. $self->{attfile_part_count}) {
1208 if ( $self->{"attsel_part_$i"} ) {
1209 my $attfile = SL::File->get(id => $self->{"attfile_part_$i"});
1210 $main::lxdebug->message(LXDebug->DEBUG2(), "att file=".$self->{"attfile_$i"}." obj=".$attfile);
1211 push @attfiles, $attfile if $attfile;
1214 foreach my $attfile ( @attfiles ) {
1215 push @{ $mail->{attachments} }, { path => $attfile->get_file,
1217 type => $attfile->mime_type,
1218 name => $attfile->file_name,
1219 content => $attfile->get_content };
1222 $mail->{message} =~ s/\r//g;
1223 $mail->{message} .= $full_signature;
1224 $self->{emailerr} = $mail->send();
1225 # $self->error($self->cleanup . "$err") if $self->{emailerr};
1226 $self->{email_journal_id} = $mail->{journalentry};
1227 $self->{snumbers} = "emailjournal" . "_" . $self->{email_journal_id};
1228 $self->{what_done} = $::form->{type};
1229 $self->{addition} = "MAILED";
1230 $self->save_history;
1232 #write back for message info and mail journal
1233 $self->{cc} = $mail->{cc};
1234 $self->{bcc} = $mail->{bcc};
1235 $self->{email} = $mail->{to};
1237 $main::lxdebug->leave_sub();
1241 $main::lxdebug->enter_sub();
1243 my ($self,$mimeType,$command_formatter) = @_;
1244 my $numbytes = (-s $self->{tmpfile});
1245 open(IN, "<", $self->{tmpfile})
1246 or $self->error($self->cleanup . "$self->{tmpfile} : $!");
1249 $self->{copies} = 1 unless $self->{media} eq 'printer';
1251 chdir("$self->{cwd}");
1252 for my $i (1 .. $self->{copies}) {
1254 $self->{OUT} = $command_formatter->($self->{OUT_MODE}, $self->{OUT});
1256 open OUT, $self->{OUT_MODE}, $self->{OUT} or $self->error($self->cleanup . "$self->{OUT} : $!");
1257 print OUT $_ while <IN>;
1262 my %headers = ('-type' => $mimeType,
1263 '-connection' => 'close',
1264 '-charset' => 'UTF-8');
1266 $self->{attachment_filename} ||= $self->generate_attachment_filename;
1268 if ($self->{attachment_filename}) {
1271 '-attachment' => $self->{attachment_filename},
1272 '-content-length' => $numbytes,
1277 print $::request->cgi->header(%headers);
1279 $::locale->with_raw_io(\*STDOUT, sub { print while <IN> });
1283 $main::lxdebug->leave_sub();
1286 sub get_formname_translation {
1287 $main::lxdebug->enter_sub();
1288 my ($self, $formname) = @_;
1290 $formname ||= $self->{formname};
1292 $self->{recipient_locale} ||= Locale->lang_to_locale($self->{language});
1293 local $::locale = Locale->new($self->{recipient_locale});
1295 my %formname_translations = (
1296 bin_list => $main::locale->text('Bin List'),
1297 credit_note => $main::locale->text('Credit Note'),
1298 invoice => $main::locale->text('Invoice'),
1299 pick_list => $main::locale->text('Pick List'),
1300 proforma => $main::locale->text('Proforma Invoice'),
1301 purchase_order => $main::locale->text('Purchase Order'),
1302 request_quotation => $main::locale->text('RFQ'),
1303 sales_order => $main::locale->text('Confirmation'),
1304 sales_quotation => $main::locale->text('Quotation'),
1305 storno_invoice => $main::locale->text('Storno Invoice'),
1306 sales_delivery_order => $main::locale->text('Delivery Order'),
1307 purchase_delivery_order => $main::locale->text('Delivery Order'),
1308 dunning => $main::locale->text('Dunning'),
1309 letter => $main::locale->text('Letter'),
1310 ic_supply => $main::locale->text('Intra-Community supply'),
1313 $main::lxdebug->leave_sub();
1314 return $formname_translations{$formname};
1317 sub get_number_prefix_for_type {
1318 $main::lxdebug->enter_sub();
1322 (first { $self->{type} eq $_ } qw(invoice credit_note)) ? 'inv'
1323 : ($self->{type} =~ /_quotation$/) ? 'quo'
1324 : ($self->{type} =~ /_delivery_order$/) ? 'do'
1325 : ($self->{type} =~ /letter/) ? 'letter'
1328 # better default like this?
1329 # : ($self->{type} =~ /(sales|purcharse)_order/ : 'ord';
1330 # : 'prefix_undefined';
1332 $main::lxdebug->leave_sub();
1336 sub get_extension_for_format {
1337 $main::lxdebug->enter_sub();
1340 my $extension = $self->{format} =~ /pdf/i ? ".pdf"
1341 : $self->{format} =~ /postscript/i ? ".ps"
1342 : $self->{format} =~ /opendocument/i ? ".odt"
1343 : $self->{format} =~ /excel/i ? ".xls"
1344 : $self->{format} =~ /html/i ? ".html"
1347 $main::lxdebug->leave_sub();
1351 sub generate_attachment_filename {
1352 $main::lxdebug->enter_sub();
1355 $self->{recipient_locale} ||= Locale->lang_to_locale($self->{language});
1356 my $recipient_locale = Locale->new($self->{recipient_locale});
1358 my $attachment_filename = $main::locale->unquote_special_chars('HTML', $self->get_formname_translation());
1359 my $prefix = $self->get_number_prefix_for_type();
1361 if ($self->{preview} && (first { $self->{type} eq $_ } qw(invoice credit_note))) {
1362 $attachment_filename .= ' (' . $recipient_locale->text('Preview') . ')' . $self->get_extension_for_format();
1364 } elsif ($attachment_filename && $self->{"${prefix}number"}) {
1365 $attachment_filename .= "_" . $self->{"${prefix}number"} . $self->get_extension_for_format();
1367 } elsif ($attachment_filename) {
1368 $attachment_filename .= $self->get_extension_for_format();
1371 $attachment_filename = "";
1374 $attachment_filename = $main::locale->quote_special_chars('filenames', $attachment_filename);
1375 $attachment_filename =~ s|[\s/\\]+|_|g;
1377 $main::lxdebug->leave_sub();
1378 return $attachment_filename;
1381 sub generate_email_subject {
1382 $main::lxdebug->enter_sub();
1385 my $subject = $main::locale->unquote_special_chars('HTML', $self->get_formname_translation());
1386 my $prefix = $self->get_number_prefix_for_type();
1388 if ($subject && $self->{"${prefix}number"}) {
1389 $subject .= " " . $self->{"${prefix}number"}
1392 $main::lxdebug->leave_sub();
1397 $main::lxdebug->enter_sub();
1399 my ($self, $application) = @_;
1401 my $error_code = $?;
1403 chdir("$self->{tmpdir}");
1406 if ((-1 == $error_code) || (127 == (($error_code) >> 8))) {
1407 push @err, $::locale->text('The application "#1" was not found on the system.', $application || 'pdflatex') . ' ' . $::locale->text('Please contact your administrator.');
1409 } elsif (-f "$self->{tmpfile}.err") {
1410 open(FH, "<:encoding(UTF-8)", "$self->{tmpfile}.err");
1415 if ($self->{tmpfile} && !($::lx_office_conf{debug} && $::lx_office_conf{debug}->{keep_temp_files})) {
1416 $self->{tmpfile} =~ s|.*/||g;
1418 $self->{tmpfile} =~ s/\.\w+$//g;
1419 my $tmpfile = $self->{tmpfile};
1420 unlink(<$tmpfile.*>);
1423 chdir("$self->{cwd}");
1425 $main::lxdebug->leave_sub();
1431 $main::lxdebug->enter_sub();
1433 my ($self, $date, $myconfig) = @_;
1436 if ($date && $date =~ /\D/) {
1438 if ($myconfig->{dateformat} =~ /^yy/) {
1439 ($yy, $mm, $dd) = split /\D/, $date;
1441 if ($myconfig->{dateformat} =~ /^mm/) {
1442 ($mm, $dd, $yy) = split /\D/, $date;
1444 if ($myconfig->{dateformat} =~ /^dd/) {
1445 ($dd, $mm, $yy) = split /\D/, $date;
1450 $yy = ($yy < 70) ? $yy + 2000 : $yy;
1451 $yy = ($yy >= 70 && $yy <= 99) ? $yy + 1900 : $yy;
1453 $dd = "0$dd" if ($dd < 10);
1454 $mm = "0$mm" if ($mm < 10);
1456 $date = "$yy$mm$dd";
1459 $main::lxdebug->leave_sub();
1464 # Database routines used throughout
1465 # DB Handling got moved to SL::DB, these are only shims for compatibility
1468 SL::DB->client->dbh;
1471 sub get_standard_dbh {
1472 my $dbh = SL::DB->client->dbh;
1474 if ($dbh && !$dbh->{Active}) {
1475 $main::lxdebug->message(LXDebug->INFO(), "get_standard_dbh: \$dbh is defined but not Active anymore");
1476 SL::DB->client->dbh(undef);
1479 SL::DB->client->dbh;
1482 sub disconnect_standard_dbh {
1483 SL::DB->client->dbh->rollback;
1489 $main::lxdebug->enter_sub();
1491 my ($self, $date, $myconfig) = @_;
1492 my $dbh = $self->get_standard_dbh;
1494 my $query = "SELECT 1 FROM defaults WHERE ? < closedto";
1495 my $sth = prepare_execute_query($self, $dbh, $query, conv_date($date));
1497 # Falls $date = '' - Fehlermeldung aus der Datenbank. Ich denke,
1498 # es ist sicher ein conv_date vorher IMMER auszuführen.
1499 # Testfälle ohne definiertes closedto:
1500 # Leere Datumseingabe i.O.
1501 # SELECT 1 FROM defaults WHERE '' < closedto
1502 # normale Zahlungsbuchung über Rechnungsmaske i.O.
1503 # SELECT 1 FROM defaults WHERE '10.05.2011' < closedto
1504 # Testfälle mit definiertem closedto (30.04.2011):
1505 # Leere Datumseingabe i.O.
1506 # SELECT 1 FROM defaults WHERE '' < closedto
1507 # normale Buchung im geschloßenem Zeitraum i.O.
1508 # SELECT 1 FROM defaults WHERE '21.04.2011' < closedto
1509 # Fehlermeldung: Es können keine Zahlungen für abgeschlossene Bücher gebucht werden!
1510 # normale Buchung in aktiver Buchungsperiode i.O.
1511 # SELECT 1 FROM defaults WHERE '01.05.2011' < closedto
1513 my ($closed) = $sth->fetchrow_array;
1515 $main::lxdebug->leave_sub();
1520 # prevents bookings to the to far away future
1521 sub date_max_future {
1522 $main::lxdebug->enter_sub();
1524 my ($self, $date, $myconfig) = @_;
1525 my $dbh = $self->get_standard_dbh;
1527 my $query = "SELECT 1 FROM defaults WHERE ? - current_date > max_future_booking_interval";
1528 my $sth = prepare_execute_query($self, $dbh, $query, conv_date($date));
1530 my ($max_future_booking_interval) = $sth->fetchrow_array;
1532 $main::lxdebug->leave_sub();
1534 return $max_future_booking_interval;
1538 sub update_balance {
1539 $main::lxdebug->enter_sub();
1541 my ($self, $dbh, $table, $field, $where, $value, @values) = @_;
1543 # if we have a value, go do it
1546 # retrieve balance from table
1547 my $query = "SELECT $field FROM $table WHERE $where FOR UPDATE";
1548 my $sth = prepare_execute_query($self, $dbh, $query, @values);
1549 my ($balance) = $sth->fetchrow_array;
1555 $query = "UPDATE $table SET $field = $balance WHERE $where";
1556 do_query($self, $dbh, $query, @values);
1558 $main::lxdebug->leave_sub();
1561 sub update_exchangerate {
1562 $main::lxdebug->enter_sub();
1564 my ($self, $dbh, $curr, $transdate, $buy, $sell) = @_;
1566 # some sanity check for currency
1568 $main::lxdebug->leave_sub();
1571 $query = qq|SELECT name AS curr FROM currencies WHERE id=(SELECT currency_id FROM defaults)|;
1573 my ($defaultcurrency) = selectrow_query($self, $dbh, $query);
1575 if ($curr eq $defaultcurrency) {
1576 $main::lxdebug->leave_sub();
1580 $query = qq|SELECT e.currency_id FROM exchangerate e
1581 WHERE e.currency_id = (SELECT cu.id FROM currencies cu WHERE cu.name=?) AND e.transdate = ?
1583 my $sth = prepare_execute_query($self, $dbh, $query, $curr, $transdate);
1592 $buy = conv_i($buy, "NULL");
1593 $sell = conv_i($sell, "NULL");
1596 if ($buy != 0 && $sell != 0) {
1597 $set = "buy = $buy, sell = $sell";
1598 } elsif ($buy != 0) {
1599 $set = "buy = $buy";
1600 } elsif ($sell != 0) {
1601 $set = "sell = $sell";
1604 if ($sth->fetchrow_array) {
1605 $query = qq|UPDATE exchangerate
1607 WHERE currency_id = (SELECT id FROM currencies WHERE name = ?)
1611 $query = qq|INSERT INTO exchangerate (currency_id, buy, sell, transdate)
1612 VALUES ((SELECT id FROM currencies WHERE name = ?), $buy, $sell, ?)|;
1615 do_query($self, $dbh, $query, $curr, $transdate);
1617 $main::lxdebug->leave_sub();
1620 sub save_exchangerate {
1621 $main::lxdebug->enter_sub();
1623 my ($self, $myconfig, $currency, $transdate, $rate, $fld) = @_;
1625 SL::DB->client->with_transaction(sub {
1626 my $dbh = SL::DB->client->dbh;
1630 $buy = $rate if $fld eq 'buy';
1631 $sell = $rate if $fld eq 'sell';
1634 $self->update_exchangerate($dbh, $currency, $transdate, $buy, $sell);
1636 }) or do { die SL::DB->client->error };
1638 $main::lxdebug->leave_sub();
1641 sub get_exchangerate {
1642 $main::lxdebug->enter_sub();
1644 my ($self, $dbh, $curr, $transdate, $fld) = @_;
1647 unless ($transdate && $curr) {
1648 $main::lxdebug->leave_sub();
1652 $query = qq|SELECT name AS curr FROM currencies WHERE id = (SELECT currency_id FROM defaults)|;
1654 my ($defaultcurrency) = selectrow_query($self, $dbh, $query);
1656 if ($curr eq $defaultcurrency) {
1657 $main::lxdebug->leave_sub();
1661 $query = qq|SELECT e.$fld FROM exchangerate e
1662 WHERE e.currency_id = (SELECT id FROM currencies WHERE name = ?) AND e.transdate = ?|;
1663 my ($exchangerate) = selectrow_query($self, $dbh, $query, $curr, $transdate);
1667 $main::lxdebug->leave_sub();
1669 return $exchangerate;
1672 sub check_exchangerate {
1673 $main::lxdebug->enter_sub();
1675 my ($self, $myconfig, $currency, $transdate, $fld) = @_;
1677 if ($fld !~/^buy|sell$/) {
1678 $self->error('Fatal: check_exchangerate called with invalid buy/sell argument');
1681 unless ($transdate) {
1682 $main::lxdebug->leave_sub();
1686 my ($defaultcurrency) = $self->get_default_currency($myconfig);
1688 if ($currency eq $defaultcurrency) {
1689 $main::lxdebug->leave_sub();
1693 my $dbh = $self->get_standard_dbh($myconfig);
1694 my $query = qq|SELECT e.$fld FROM exchangerate e
1695 WHERE e.currency_id = (SELECT id FROM currencies WHERE name = ?) AND e.transdate = ?|;
1697 my ($exchangerate) = selectrow_query($self, $dbh, $query, $currency, $transdate);
1699 $main::lxdebug->leave_sub();
1701 return $exchangerate;
1704 sub get_all_currencies {
1705 $main::lxdebug->enter_sub();
1708 my $myconfig = shift || \%::myconfig;
1709 my $dbh = $self->get_standard_dbh($myconfig);
1711 my $query = qq|SELECT name FROM currencies|;
1712 my @currencies = map { $_->{name} } selectall_hashref_query($self, $dbh, $query);
1714 $main::lxdebug->leave_sub();
1719 sub get_default_currency {
1720 $main::lxdebug->enter_sub();
1722 my ($self, $myconfig) = @_;
1723 my $dbh = $self->get_standard_dbh($myconfig);
1724 my $query = qq|SELECT name AS curr FROM currencies WHERE id = (SELECT currency_id FROM defaults)|;
1726 my ($defaultcurrency) = selectrow_query($self, $dbh, $query);
1728 $main::lxdebug->leave_sub();
1730 return $defaultcurrency;
1733 sub set_payment_options {
1734 my ($self, $myconfig, $transdate, $type) = @_;
1736 my $terms = $self->{payment_id} ? SL::DB::PaymentTerm->new(id => $self->{payment_id})->load : undef;
1739 my $is_invoice = $type =~ m{invoice}i;
1741 $transdate ||= $self->{invdate} || $self->{transdate};
1742 my $due_date = $self->{duedate} || $self->{reqdate};
1744 $self->{$_} = $terms->$_ for qw(terms_netto terms_skonto percent_skonto);
1745 $self->{payment_description} = $terms->description;
1746 $self->{netto_date} = $terms->calc_date(reference_date => $transdate, due_date => $due_date, terms => 'net')->to_kivitendo;
1747 $self->{skonto_date} = $terms->calc_date(reference_date => $transdate, due_date => $due_date, terms => 'discount')->to_kivitendo;
1749 my ($invtotal, $total);
1750 my (%amounts, %formatted_amounts);
1752 if ($self->{type} =~ /_order$/) {
1753 $amounts{invtotal} = $self->{ordtotal};
1754 $amounts{total} = $self->{ordtotal};
1756 } elsif ($self->{type} =~ /_quotation$/) {
1757 $amounts{invtotal} = $self->{quototal};
1758 $amounts{total} = $self->{quototal};
1761 $amounts{invtotal} = $self->{invtotal};
1762 $amounts{total} = $self->{total};
1764 map { $amounts{$_} = $self->parse_amount($myconfig, $amounts{$_}) } keys %amounts;
1766 $amounts{skonto_in_percent} = 100.0 * $self->{percent_skonto};
1767 $amounts{skonto_amount} = $amounts{invtotal} * $self->{percent_skonto};
1768 $amounts{invtotal_wo_skonto} = $amounts{invtotal} * (1 - $self->{percent_skonto});
1769 $amounts{total_wo_skonto} = $amounts{total} * (1 - $self->{percent_skonto});
1771 foreach (keys %amounts) {
1772 $amounts{$_} = $self->round_amount($amounts{$_}, 2);
1773 $formatted_amounts{$_} = $self->format_amount($myconfig, $amounts{$_}, 2);
1776 if ($self->{"language_id"}) {
1777 my $language = SL::DB::Language->new(id => $self->{language_id})->load;
1779 $self->{payment_terms} = $type =~ m{invoice}i ? $terms->translated_attribute('description_long_invoice', $language->id) : undef;
1780 $self->{payment_terms} ||= $terms->translated_attribute('description_long', $language->id);
1782 if ($language->output_dateformat) {
1783 foreach my $key (qw(netto_date skonto_date)) {
1784 $self->{$key} = $::locale->reformat_date($myconfig, $self->{$key}, $language->output_dateformat, $language->output_longdates);
1788 if ($language->output_numberformat && ($language->output_numberformat ne $myconfig->{numberformat})) {
1789 local $myconfig->{numberformat};
1790 $myconfig->{"numberformat"} = $language->output_numberformat;
1791 $formatted_amounts{$_} = $self->format_amount($myconfig, $amounts{$_}) for keys %amounts;
1795 $self->{payment_terms} = $self->{payment_terms} || ($is_invoice ? $terms->description_long_invoice : undef) || $terms->description_long;
1797 $self->{payment_terms} =~ s/<%netto_date%>/$self->{netto_date}/g;
1798 $self->{payment_terms} =~ s/<%skonto_date%>/$self->{skonto_date}/g;
1799 $self->{payment_terms} =~ s/<%currency%>/$self->{currency}/g;
1800 $self->{payment_terms} =~ s/<%terms_netto%>/$self->{terms_netto}/g;
1801 $self->{payment_terms} =~ s/<%account_number%>/$self->{account_number}/g;
1802 $self->{payment_terms} =~ s/<%bank%>/$self->{bank}/g;
1803 $self->{payment_terms} =~ s/<%bank_code%>/$self->{bank_code}/g;
1804 $self->{payment_terms} =~ s/<\%bic\%>/$self->{bic}/g;
1805 $self->{payment_terms} =~ s/<\%iban\%>/$self->{iban}/g;
1806 $self->{payment_terms} =~ s/<\%mandate_date_of_signature\%>/$self->{mandate_date_of_signature}/g;
1807 $self->{payment_terms} =~ s/<\%mandator_id\%>/$self->{mandator_id}/g;
1809 map { $self->{payment_terms} =~ s/<%${_}%>/$formatted_amounts{$_}/g; } keys %formatted_amounts;
1811 $self->{skonto_in_percent} = $formatted_amounts{skonto_in_percent};
1815 sub get_template_language {
1816 $main::lxdebug->enter_sub();
1818 my ($self, $myconfig) = @_;
1820 my $template_code = "";
1822 if ($self->{language_id}) {
1823 my $dbh = $self->get_standard_dbh($myconfig);
1824 my $query = qq|SELECT template_code FROM language WHERE id = ?|;
1825 ($template_code) = selectrow_query($self, $dbh, $query, $self->{language_id});
1828 $main::lxdebug->leave_sub();
1830 return $template_code;
1833 sub get_printer_code {
1834 $main::lxdebug->enter_sub();
1836 my ($self, $myconfig) = @_;
1838 my $template_code = "";
1840 if ($self->{printer_id}) {
1841 my $dbh = $self->get_standard_dbh($myconfig);
1842 my $query = qq|SELECT template_code, printer_command FROM printers WHERE id = ?|;
1843 ($template_code, $self->{printer_command}) = selectrow_query($self, $dbh, $query, $self->{printer_id});
1846 $main::lxdebug->leave_sub();
1848 return $template_code;
1852 $main::lxdebug->enter_sub();
1854 my ($self, $myconfig) = @_;
1856 my $template_code = "";
1858 if ($self->{shipto_id}) {
1859 my $dbh = $self->get_standard_dbh($myconfig);
1860 my $query = qq|SELECT * FROM shipto WHERE shipto_id = ?|;
1861 my $ref = selectfirst_hashref_query($self, $dbh, $query, $self->{shipto_id});
1862 map({ $self->{$_} = $ref->{$_} } keys(%$ref));
1864 my $cvars = CVar->get_custom_variables(
1867 trans_id => $self->{shipto_id},
1869 $self->{"shiptocvar_$_->{name}"} = $_->{value} for @{ $cvars };
1872 $main::lxdebug->leave_sub();
1876 my ($self, $dbh, $id, $module) = @_;
1881 foreach my $item (qw(name department_1 department_2 street zipcode city country gln
1882 contact cp_gender phone fax email)) {
1883 if ($self->{"shipto$item"}) {
1884 $shipto = 1 if ($self->{$item} ne $self->{"shipto$item"});
1886 push(@values, $self->{"shipto${item}"});
1891 my $shipto_id = $self->{shipto_id};
1893 if ($self->{shipto_id}) {
1894 my $query = qq|UPDATE shipto set
1896 shiptodepartment_1 = ?,
1897 shiptodepartment_2 = ?,
1904 shiptocp_gender = ?,
1908 WHERE shipto_id = ?|;
1909 do_query($self, $dbh, $query, @values, $self->{shipto_id});
1911 my $query = qq|SELECT * FROM shipto
1912 WHERE shiptoname = ? AND
1913 shiptodepartment_1 = ? AND
1914 shiptodepartment_2 = ? AND
1915 shiptostreet = ? AND
1916 shiptozipcode = ? AND
1918 shiptocountry = ? AND
1920 shiptocontact = ? AND
1921 shiptocp_gender = ? AND
1927 my $insert_check = selectfirst_hashref_query($self, $dbh, $query, @values, $module, $id);
1930 qq|INSERT INTO shipto (trans_id, shiptoname, shiptodepartment_1, shiptodepartment_2,
1931 shiptostreet, shiptozipcode, shiptocity, shiptocountry, shiptogln,
1932 shiptocontact, shiptocp_gender, shiptophone, shiptofax, shiptoemail, module)
1933 VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)|;
1934 do_query($self, $dbh, $insert_query, $id, @values, $module);
1936 $insert_check = selectfirst_hashref_query($self, $dbh, $query, @values, $module, $id);
1939 $shipto_id = $insert_check->{shipto_id};
1942 return unless $shipto_id;
1944 CVar->save_custom_variables(
1947 trans_id => $shipto_id,
1949 name_prefix => 'shipto',
1954 $main::lxdebug->enter_sub();
1956 my ($self, $dbh) = @_;
1958 $dbh ||= $self->get_standard_dbh(\%main::myconfig);
1960 my $query = qq|SELECT id, name FROM employee WHERE login = ?|;
1961 ($self->{"employee_id"}, $self->{"employee"}) = selectrow_query($self, $dbh, $query, $self->{login});
1962 $self->{"employee_id"} *= 1;
1964 $main::lxdebug->leave_sub();
1967 sub get_employee_data {
1968 $main::lxdebug->enter_sub();
1972 my $defaults = SL::DB::Default->get;
1974 Common::check_params(\%params, qw(prefix));
1975 Common::check_params_x(\%params, qw(id));
1978 $main::lxdebug->leave_sub();
1982 my $myconfig = \%main::myconfig;
1983 my $dbh = $params{dbh} || $self->get_standard_dbh($myconfig);
1985 my ($login, $deleted) = selectrow_query($self, $dbh, qq|SELECT login,deleted FROM employee WHERE id = ?|, conv_i($params{id}));
1988 # login already fetched and still the same client (mandant) | same for both cases (delete|!delete)
1989 $self->{$params{prefix} . '_login'} = $login;
1990 $self->{$params{prefix} . "_${_}"} = $defaults->$_ for qw(address businessnumber co_ustid company duns taxnumber);
1993 # get employee data from auth.user_config
1994 my $user = User->new(login => $login);
1995 $self->{$params{prefix} . "_${_}"} = $user->{$_} for qw(email fax name signature tel);
1997 # get saved employee data from employee
1998 my $employee = SL::DB::Manager::Employee->find_by(id => conv_i($params{id}));
1999 $self->{$params{prefix} . "_${_}"} = $employee->{"deleted_$_"} for qw(email fax signature tel);
2000 $self->{$params{prefix} . "_name"} = $employee->name;
2003 $main::lxdebug->leave_sub();
2007 $main::lxdebug->enter_sub();
2009 my ($self, $dbh, $id, $key) = @_;
2011 $key = "all_contacts" unless ($key);
2015 $main::lxdebug->leave_sub();
2020 qq|SELECT cp_id, cp_cv_id, cp_name, cp_givenname, cp_abteilung | .
2021 qq|FROM contacts | .
2022 qq|WHERE cp_cv_id = ? | .
2023 qq|ORDER BY lower(cp_name)|;
2025 $self->{$key} = selectall_hashref_query($self, $dbh, $query, $id);
2027 $main::lxdebug->leave_sub();
2031 $main::lxdebug->enter_sub();
2033 my ($self, $dbh, $key) = @_;
2035 my ($all, $old_id, $where, @values);
2037 if (ref($key) eq "HASH") {
2040 $key = "ALL_PROJECTS";
2042 foreach my $p (keys(%{$params})) {
2044 $all = $params->{$p};
2045 } elsif ($p eq "old_id") {
2046 $old_id = $params->{$p};
2047 } elsif ($p eq "key") {
2048 $key = $params->{$p};
2054 $where = "WHERE active ";
2056 if (ref($old_id) eq "ARRAY") {
2057 my @ids = grep({ $_ } @{$old_id});
2059 $where .= " OR id IN (" . join(",", map({ "?" } @ids)) . ") ";
2060 push(@values, @ids);
2063 $where .= " OR (id = ?) ";
2064 push(@values, $old_id);
2070 qq|SELECT id, projectnumber, description, active | .
2073 qq|ORDER BY lower(projectnumber)|;
2075 $self->{$key} = selectall_hashref_query($self, $dbh, $query, @values);
2077 $main::lxdebug->leave_sub();
2081 $main::lxdebug->enter_sub();
2083 my ($self, $dbh, $vc_id, $key) = @_;
2085 $key = "all_shipto" unless ($key);
2088 # get shipping addresses
2089 my $query = qq|SELECT * FROM shipto WHERE trans_id = ?|;
2091 $self->{$key} = selectall_hashref_query($self, $dbh, $query, $vc_id);
2097 $main::lxdebug->leave_sub();
2101 $main::lxdebug->enter_sub();
2103 my ($self, $dbh, $key) = @_;
2105 $key = "all_printers" unless ($key);
2107 my $query = qq|SELECT id, printer_description, printer_command, template_code FROM printers|;
2109 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2111 $main::lxdebug->leave_sub();
2115 $main::lxdebug->enter_sub();
2117 my ($self, $dbh, $params) = @_;
2120 $key = $params->{key};
2121 $key = "all_charts" unless ($key);
2123 my $transdate = quote_db_date($params->{transdate});
2126 qq|SELECT c.id, c.accno, c.description, c.link, c.charttype, tk.taxkey_id, tk.tax_id | .
2128 qq|LEFT JOIN taxkeys tk ON | .
2129 qq|(tk.id = (SELECT id FROM taxkeys | .
2130 qq| WHERE taxkeys.chart_id = c.id AND startdate <= $transdate | .
2131 qq| ORDER BY startdate DESC LIMIT 1)) | .
2132 qq|ORDER BY c.accno|;
2134 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2136 $main::lxdebug->leave_sub();
2139 sub _get_taxcharts {
2140 $main::lxdebug->enter_sub();
2142 my ($self, $dbh, $params) = @_;
2144 my $key = "all_taxcharts";
2147 if (ref $params eq 'HASH') {
2148 $key = $params->{key} if ($params->{key});
2149 if ($params->{module} eq 'AR') {
2150 push @where, 'chart_categories ~ \'[ACILQ]\'';
2152 } elsif ($params->{module} eq 'AP') {
2153 push @where, 'chart_categories ~ \'[ACELQ]\'';
2160 my $where = @where ? ' WHERE ' . join(' AND ', map { "($_)" } @where) : '';
2162 my $query = qq|SELECT * FROM tax $where ORDER BY taxkey, rate|;
2164 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2166 $main::lxdebug->leave_sub();
2170 $main::lxdebug->enter_sub();
2172 my ($self, $dbh, $key) = @_;
2174 $key = "all_taxzones" unless ($key);
2176 $tzfilter = "WHERE obsolete is FALSE" if $key eq 'ALL_ACTIVE_TAXZONES';
2178 my $query = qq|SELECT * FROM tax_zones $tzfilter ORDER BY sortkey|;
2180 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2182 $main::lxdebug->leave_sub();
2185 sub _get_employees {
2186 $main::lxdebug->enter_sub();
2188 my ($self, $dbh, $params) = @_;
2193 if (ref $params eq 'HASH') {
2194 $key = $params->{key};
2195 $deleted = $params->{deleted};
2201 $key ||= "all_employees";
2202 my $filter = $deleted ? '' : 'WHERE NOT COALESCE(deleted, FALSE)';
2203 $self->{$key} = selectall_hashref_query($self, $dbh, qq|SELECT * FROM employee $filter ORDER BY lower(name)|);
2205 $main::lxdebug->leave_sub();
2208 sub _get_business_types {
2209 $main::lxdebug->enter_sub();
2211 my ($self, $dbh, $key) = @_;
2213 my $options = ref $key eq 'HASH' ? $key : { key => $key };
2214 $options->{key} ||= "all_business_types";
2217 if (exists $options->{salesman}) {
2218 $where = 'WHERE ' . ($options->{salesman} ? '' : 'NOT ') . 'COALESCE(salesman)';
2221 $self->{ $options->{key} } = selectall_hashref_query($self, $dbh, qq|SELECT * FROM business $where ORDER BY lower(description)|);
2223 $main::lxdebug->leave_sub();
2226 sub _get_languages {
2227 $main::lxdebug->enter_sub();
2229 my ($self, $dbh, $key) = @_;
2231 $key = "all_languages" unless ($key);
2233 my $query = qq|SELECT * FROM language ORDER BY id|;
2235 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2237 $main::lxdebug->leave_sub();
2240 sub _get_dunning_configs {
2241 $main::lxdebug->enter_sub();
2243 my ($self, $dbh, $key) = @_;
2245 $key = "all_dunning_configs" unless ($key);
2247 my $query = qq|SELECT * FROM dunning_config ORDER BY dunning_level|;
2249 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2251 $main::lxdebug->leave_sub();
2254 sub _get_currencies {
2255 $main::lxdebug->enter_sub();
2257 my ($self, $dbh, $key) = @_;
2259 $key = "all_currencies" unless ($key);
2261 $self->{$key} = [$self->get_all_currencies()];
2263 $main::lxdebug->leave_sub();
2267 $main::lxdebug->enter_sub();
2269 my ($self, $dbh, $key) = @_;
2271 $key = "all_payments" unless ($key);
2273 my $query = qq|SELECT * FROM payment_terms ORDER BY sortkey|;
2275 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2277 $main::lxdebug->leave_sub();
2280 sub _get_customers {
2281 $main::lxdebug->enter_sub();
2283 my ($self, $dbh, $key) = @_;
2285 my $options = ref $key eq 'HASH' ? $key : { key => $key };
2286 $options->{key} ||= "all_customers";
2287 my $limit_clause = $options->{limit} ? "LIMIT $options->{limit}" : '';
2290 push @where, qq|business_id IN (SELECT id FROM business WHERE salesman)| if $options->{business_is_salesman};
2291 push @where, qq|NOT obsolete| if !$options->{with_obsolete};
2292 my $where_str = @where ? "WHERE " . join(" AND ", map { "($_)" } @where) : '';
2294 my $query = qq|SELECT * FROM customer $where_str ORDER BY name $limit_clause|;
2295 $self->{ $options->{key} } = selectall_hashref_query($self, $dbh, $query);
2297 $main::lxdebug->leave_sub();
2301 $main::lxdebug->enter_sub();
2303 my ($self, $dbh, $key) = @_;
2305 $key = "all_vendors" unless ($key);
2307 my $query = qq|SELECT * FROM vendor WHERE NOT obsolete ORDER BY name|;
2309 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2311 $main::lxdebug->leave_sub();
2314 sub _get_departments {
2315 $main::lxdebug->enter_sub();
2317 my ($self, $dbh, $key) = @_;
2319 $key = "all_departments" unless ($key);
2321 my $query = qq|SELECT * FROM department ORDER BY description|;
2323 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2325 $main::lxdebug->leave_sub();
2328 sub _get_warehouses {
2329 $main::lxdebug->enter_sub();
2331 my ($self, $dbh, $param) = @_;
2333 my ($key, $bins_key);
2335 if ('' eq ref $param) {
2339 $key = $param->{key};
2340 $bins_key = $param->{bins};
2343 my $query = qq|SELECT w.* FROM warehouse w
2344 WHERE (NOT w.invalid) AND
2345 ((SELECT COUNT(b.*) FROM bin b WHERE b.warehouse_id = w.id) > 0)
2346 ORDER BY w.sortkey|;
2348 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2351 $query = qq|SELECT id, description FROM bin WHERE warehouse_id = ?
2352 ORDER BY description|;
2353 my $sth = prepare_query($self, $dbh, $query);
2355 foreach my $warehouse (@{ $self->{$key} }) {
2356 do_statement($self, $sth, $query, $warehouse->{id});
2357 $warehouse->{$bins_key} = [];
2359 while (my $ref = $sth->fetchrow_hashref()) {
2360 push @{ $warehouse->{$bins_key} }, $ref;
2366 $main::lxdebug->leave_sub();
2370 $main::lxdebug->enter_sub();
2372 my ($self, $dbh, $table, $key, $sortkey) = @_;
2374 my $query = qq|SELECT * FROM $table|;
2375 $query .= qq| ORDER BY $sortkey| if ($sortkey);
2377 $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2379 $main::lxdebug->leave_sub();
2383 # $main::lxdebug->enter_sub();
2385 # my ($self, $dbh, $key) = @_;
2387 # $key ||= "all_groups";
2389 # my $groups = $main::auth->read_groups();
2391 # $self->{$key} = selectall_hashref_query($self, $dbh, $query);
2393 # $main::lxdebug->leave_sub();
2397 $main::lxdebug->enter_sub();
2402 my $dbh = $self->get_standard_dbh(\%main::myconfig);
2403 my ($sth, $query, $ref);
2406 if ($params{contacts} || $params{shipto}) {
2407 $vc = 'customer' if $self->{"vc"} eq "customer";
2408 $vc = 'vendor' if $self->{"vc"} eq "vendor";
2409 die "invalid use of get_lists, need 'vc'" unless $vc;
2410 $vc_id = $self->{"${vc}_id"};
2413 if ($params{"contacts"}) {
2414 $self->_get_contacts($dbh, $vc_id, $params{"contacts"});
2417 if ($params{"shipto"}) {
2418 $self->_get_shipto($dbh, $vc_id, $params{"shipto"});
2421 if ($params{"projects"} || $params{"all_projects"}) {
2422 $self->_get_projects($dbh, $params{"all_projects"} ?
2423 $params{"all_projects"} : $params{"projects"},
2424 $params{"all_projects"} ? 1 : 0);
2427 if ($params{"printers"}) {
2428 $self->_get_printers($dbh, $params{"printers"});
2431 if ($params{"languages"}) {
2432 $self->_get_languages($dbh, $params{"languages"});
2435 if ($params{"charts"}) {
2436 $self->_get_charts($dbh, $params{"charts"});
2439 if ($params{"taxcharts"}) {
2440 $self->_get_taxcharts($dbh, $params{"taxcharts"});
2443 if ($params{"taxzones"}) {
2444 $self->_get_taxzones($dbh, $params{"taxzones"});
2447 if ($params{"employees"}) {
2448 $self->_get_employees($dbh, $params{"employees"});
2451 if ($params{"salesmen"}) {
2452 $self->_get_employees($dbh, $params{"salesmen"});
2455 if ($params{"business_types"}) {
2456 $self->_get_business_types($dbh, $params{"business_types"});
2459 if ($params{"dunning_configs"}) {
2460 $self->_get_dunning_configs($dbh, $params{"dunning_configs"});
2463 if($params{"currencies"}) {
2464 $self->_get_currencies($dbh, $params{"currencies"});
2467 if($params{"customers"}) {
2468 $self->_get_customers($dbh, $params{"customers"});
2471 if($params{"vendors"}) {
2472 if (ref $params{"vendors"} eq 'HASH') {
2473 $self->_get_vendors($dbh, $params{"vendors"}{key}, $params{"vendors"}{limit});
2475 $self->_get_vendors($dbh, $params{"vendors"});
2479 if($params{"payments"}) {
2480 $self->_get_payments($dbh, $params{"payments"});
2483 if($params{"departments"}) {
2484 $self->_get_departments($dbh, $params{"departments"});
2487 if ($params{price_factors}) {
2488 $self->_get_simple($dbh, 'price_factors', $params{price_factors}, 'sortkey');
2491 if ($params{warehouses}) {
2492 $self->_get_warehouses($dbh, $params{warehouses});
2495 # if ($params{groups}) {
2496 # $self->_get_groups($dbh, $params{groups});
2499 if ($params{partsgroup}) {
2500 $self->get_partsgroup(\%main::myconfig, { all => 1, target => $params{partsgroup} });
2503 $main::lxdebug->leave_sub();
2506 # this sub gets the id and name from $table
2508 $main::lxdebug->enter_sub();
2510 my ($self, $myconfig, $table) = @_;
2512 # connect to database
2513 my $dbh = $self->get_standard_dbh($myconfig);
2515 $table = $table eq "customer" ? "customer" : "vendor";
2516 my $arap = $self->{arap} eq "ar" ? "ar" : "ap";
2518 my ($query, @values);
2520 if (!$self->{openinvoices}) {
2522 if ($self->{customernumber} ne "") {
2523 $where = qq|(vc.customernumber ILIKE ?)|;
2524 push(@values, like($self->{customernumber}));
2526 $where = qq|(vc.name ILIKE ?)|;
2527 push(@values, like($self->{$table}));
2531 qq~SELECT vc.id, vc.name,
2532 vc.street || ' ' || vc.zipcode || ' ' || vc.city || ' ' || vc.country AS address
2534 WHERE $where AND (NOT vc.obsolete)
2538 qq~SELECT DISTINCT vc.id, vc.name,
2539 vc.street || ' ' || vc.zipcode || ' ' || vc.city || ' ' || vc.country AS address
2541 JOIN $table vc ON (a.${table}_id = vc.id)
2542 WHERE NOT (a.amount = a.paid) AND (vc.name ILIKE ?)
2544 push(@values, like($self->{$table}));
2547 $self->{name_list} = selectall_hashref_query($self, $dbh, $query, @values);
2549 $main::lxdebug->leave_sub();
2551 return scalar(@{ $self->{name_list} });
2556 my ($self, $table, $provided_dbh) = @_;
2558 my $dbh = $provided_dbh ? $provided_dbh : $self->get_standard_dbh;
2559 return unless $self->{id};
2560 croak ("wrong call, no valid table defined") unless $table =~ /^(oe|ar|ap|delivery_orders|parts)$/;
2562 my $query = "SELECT mtime, itime FROM " . $table . " WHERE id = ?";
2563 my $ref = selectfirst_hashref_query($self, $dbh, $query, $self->{id});
2564 $ref->{mtime} ||= $ref->{itime};
2565 $self->{lastmtime} = $ref->{mtime};
2569 sub mtime_ischanged {
2570 my ($self, $table, $option) = @_;
2572 return unless $self->{id};
2573 croak ("wrong call, no valid table defined") unless $table =~ /^(oe|ar|ap|delivery_orders|parts)$/;
2575 my $query = "SELECT mtime, itime FROM " . $table . " WHERE id = ?";
2576 my $ref = selectfirst_hashref_query($self, $self->get_standard_dbh, $query, $self->{id});
2577 $ref->{mtime} ||= $ref->{itime};
2579 if ($self->{lastmtime} && $self->{lastmtime} ne $ref->{mtime} ) {
2580 $self->error(($option eq 'mail') ?
2581 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") :
2582 t8("The document has been changed by another user. Please reopen it in another window and copy the changes to the new window")
2584 $::dispatcher->end_request;
2588 # language_payment duplicates some of the functionality of all_vc (language,
2589 # printer, payment_terms), and at least in the case of sales invoices both
2590 # all_vc and language_payment are called when adding new invoices
2591 sub language_payment {
2592 $main::lxdebug->enter_sub();
2594 my ($self, $myconfig) = @_;
2596 my $dbh = $self->get_standard_dbh($myconfig);
2598 my $query = qq|SELECT id, description
2602 $self->{languages} = selectall_hashref_query($self, $dbh, $query);
2605 $query = qq|SELECT printer_description, id
2607 ORDER BY printer_description|;
2609 $self->{printers} = selectall_hashref_query($self, $dbh, $query);
2612 $query = qq|SELECT id, description
2614 WHERE ( obsolete IS FALSE OR id = ? )
2616 $self->{payment_terms} = selectall_hashref_query($self, $dbh, $query, $self->{payment_id} || undef);
2618 # get buchungsgruppen
2619 $query = qq|SELECT id, description
2620 FROM buchungsgruppen|;
2622 $self->{BUCHUNGSGRUPPEN} = selectall_hashref_query($self, $dbh, $query);
2624 $main::lxdebug->leave_sub();
2627 # this is only used for reports
2628 sub all_departments {
2629 $main::lxdebug->enter_sub();
2631 my ($self, $myconfig, $table) = @_;
2633 my $dbh = $self->get_standard_dbh($myconfig);
2635 my $query = qq|SELECT id, description
2637 ORDER BY description|;
2638 $self->{all_departments} = selectall_hashref_query($self, $dbh, $query);
2640 delete($self->{all_departments}) unless (@{ $self->{all_departments} || [] });
2642 $main::lxdebug->leave_sub();
2646 $main::lxdebug->enter_sub();
2648 my ($self, $module, $myconfig, $table, $provided_dbh) = @_;
2651 if ($table eq "customer") {
2660 # get last customers or vendors
2661 my ($query, $sth, $ref);
2663 my $dbh = $provided_dbh ? $provided_dbh : $self->get_standard_dbh($myconfig);
2668 my $transdate = "current_date";
2669 if ($self->{transdate}) {
2670 $transdate = $dbh->quote($self->{transdate});
2673 # now get the account numbers
2675 SELECT c.accno, c.description, c.link, c.taxkey_id, c.id AS chart_id, tk2.tax_id
2677 -- find newest entries in taxkeys
2679 SELECT chart_id, MAX(startdate) AS startdate
2681 WHERE (startdate <= $transdate)
2683 ) tk ON (c.id = tk.chart_id)
2684 -- and load all of those entries
2685 INNER JOIN taxkeys tk2
2686 ON (tk.chart_id = tk2.chart_id AND tk.startdate = tk2.startdate)
2687 WHERE (c.link LIKE ?)
2690 $sth = $dbh->prepare($query);
2692 do_statement($self, $sth, $query, like($module));
2694 $self->{accounts} = "";
2695 while ($ref = $sth->fetchrow_hashref("NAME_lc")) {
2697 foreach my $key (split(/:/, $ref->{link})) {
2698 if ($key =~ /\Q$module\E/) {
2700 # cross reference for keys
2701 $xkeyref{ $ref->{accno} } = $key;
2703 push @{ $self->{"${module}_links"}{$key} },
2704 { accno => $ref->{accno},
2705 chart_id => $ref->{chart_id},
2706 description => $ref->{description},
2707 taxkey => $ref->{taxkey_id},
2708 tax_id => $ref->{tax_id} };
2710 $self->{accounts} .= "$ref->{accno} " unless $key =~ /tax/;
2716 # get taxkeys and description
2717 $query = qq|SELECT id, taxkey, taxdescription FROM tax|;
2718 $self->{TAXKEY} = selectall_hashref_query($self, $dbh, $query);
2720 if (($module eq "AP") || ($module eq "AR")) {
2721 # get tax rates and description
2722 $query = qq|SELECT * FROM tax|;
2723 $self->{TAX} = selectall_hashref_query($self, $dbh, $query);
2726 my $extra_columns = '';
2727 $extra_columns .= 'a.direct_debit, ' if ($module eq 'AR') || ($module eq 'AP');
2732 a.cp_id, a.invnumber, a.transdate, a.${table}_id, a.datepaid,
2733 a.duedate, a.ordnumber, a.taxincluded, (SELECT cu.name FROM currencies cu WHERE cu.id=a.currency_id) AS currency, a.notes,
2735 a.intnotes, a.department_id, a.amount AS oldinvtotal,
2736 a.paid AS oldtotalpaid, a.employee_id, a.gldate, a.type,
2737 a.globalproject_id, ${extra_columns}
2739 d.description AS department,
2742 JOIN $table c ON (a.${table}_id = c.id)
2743 LEFT JOIN employee e ON (e.id = a.employee_id)
2744 LEFT JOIN department d ON (d.id = a.department_id)
2746 $ref = selectfirst_hashref_query($self, $dbh, $query, $self->{id});
2748 foreach my $key (keys %$ref) {
2749 $self->{$key} = $ref->{$key};
2751 $self->{mtime} ||= $self->{itime};
2752 $self->{lastmtime} = $self->{mtime};
2753 my $transdate = "current_date";
2754 if ($self->{transdate}) {
2755 $transdate = $dbh->quote($self->{transdate});
2758 # now get the account numbers
2759 $query = qq|SELECT c.accno, c.description, c.link, c.taxkey_id, c.id AS chart_id, tk.tax_id
2761 LEFT JOIN taxkeys tk ON (tk.chart_id = c.id)
2763 AND (tk.id = (SELECT id FROM taxkeys WHERE taxkeys.chart_id = c.id AND startdate <= $transdate ORDER BY startdate DESC LIMIT 1)
2764 OR c.link LIKE '%_tax%' OR c.taxkey_id IS NULL)
2767 $sth = $dbh->prepare($query);
2768 do_statement($self, $sth, $query, like($module));
2770 $self->{accounts} = "";
2771 while ($ref = $sth->fetchrow_hashref("NAME_lc")) {
2773 foreach my $key (split(/:/, $ref->{link})) {
2774 if ($key =~ /\Q$module\E/) {
2776 # cross reference for keys
2777 $xkeyref{ $ref->{accno} } = $key;
2779 push @{ $self->{"${module}_links"}{$key} },
2780 { accno => $ref->{accno},
2781 chart_id => $ref->{chart_id},
2782 description => $ref->{description},
2783 taxkey => $ref->{taxkey_id},
2784 tax_id => $ref->{tax_id} };
2786 $self->{accounts} .= "$ref->{accno} " unless $key =~ /tax/;
2792 # get amounts from individual entries
2795 c.accno, c.description,
2796 a.acc_trans_id, a.source, a.amount, a.memo, a.transdate, a.gldate, a.cleared, a.project_id, a.taxkey, a.chart_id,
2800 LEFT JOIN chart c ON (c.id = a.chart_id)
2801 LEFT JOIN project p ON (p.id = a.project_id)
2802 LEFT JOIN tax t ON (t.id= a.tax_id)
2803 WHERE a.trans_id = ?
2804 AND a.fx_transaction = '0'
2805 ORDER BY a.acc_trans_id, a.transdate|;
2806 $sth = $dbh->prepare($query);
2807 do_statement($self, $sth, $query, $self->{id});
2809 # get exchangerate for currency
2810 $self->{exchangerate} =
2811 $self->get_exchangerate($dbh, $self->{currency}, $self->{transdate}, $fld);
2814 # store amounts in {acc_trans}{$key} for multiple accounts
2815 while (my $ref = $sth->fetchrow_hashref("NAME_lc")) {
2816 $ref->{exchangerate} =
2817 $self->get_exchangerate($dbh, $self->{currency}, $ref->{transdate}, $fld);
2818 if (!($xkeyref{ $ref->{accno} } =~ /tax/)) {
2821 if (($xkeyref{ $ref->{accno} } =~ /paid/) && ($self->{type} eq "credit_note")) {
2822 $ref->{amount} *= -1;
2824 $ref->{index} = $index;
2826 push @{ $self->{acc_trans}{ $xkeyref{ $ref->{accno} } } }, $ref;
2833 d.closedto, d.revtrans,
2834 (SELECT cu.name FROM currencies cu WHERE cu.id=d.currency_id) AS defaultcurrency,
2835 (SELECT c.accno FROM chart c WHERE d.fxgain_accno_id = c.id) AS fxgain_accno,
2836 (SELECT c.accno FROM chart c WHERE d.fxloss_accno_id = c.id) AS fxloss_accno,
2837 (SELECT c.accno FROM chart c WHERE d.rndgain_accno_id = c.id) AS rndgain_accno,
2838 (SELECT c.accno FROM chart c WHERE d.rndloss_accno_id = c.id) AS rndloss_accno
2840 $ref = selectfirst_hashref_query($self, $dbh, $query);
2841 map { $self->{$_} = $ref->{$_} } keys %$ref;
2848 current_date AS transdate, d.closedto, d.revtrans,
2849 (SELECT cu.name FROM currencies cu WHERE cu.id=d.currency_id) AS defaultcurrency,
2850 (SELECT c.accno FROM chart c WHERE d.fxgain_accno_id = c.id) AS fxgain_accno,
2851 (SELECT c.accno FROM chart c WHERE d.fxloss_accno_id = c.id) AS fxloss_accno,
2852 (SELECT c.accno FROM chart c WHERE d.rndgain_accno_id = c.id) AS rndgain_accno,
2853 (SELECT c.accno FROM chart c WHERE d.rndloss_accno_id = c.id) AS rndloss_accno
2855 $ref = selectfirst_hashref_query($self, $dbh, $query);
2856 map { $self->{$_} = $ref->{$_} } keys %$ref;
2858 if ($self->{"$self->{vc}_id"}) {
2860 # only setup currency
2861 ($self->{currency}) = $self->{defaultcurrency} if !$self->{currency};
2865 $self->lastname_used($dbh, $myconfig, $table, $module);
2867 # get exchangerate for currency
2868 $self->{exchangerate} =
2869 $self->get_exchangerate($dbh, $self->{currency}, $self->{transdate}, $fld);
2875 $main::lxdebug->leave_sub();
2879 $main::lxdebug->enter_sub();
2881 my ($self, $dbh, $myconfig, $table, $module) = @_;
2885 $table = $table eq "customer" ? "customer" : "vendor";
2886 my %column_map = ("a.${table}_id" => "${table}_id",
2887 "a.department_id" => "department_id",
2888 "d.description" => "department",
2889 "ct.name" => $table,
2890 "cu.name" => "currency",
2893 if ($self->{type} =~ /delivery_order/) {
2894 $arap = 'delivery_orders';
2895 delete $column_map{"cu.currency"};
2897 } elsif ($self->{type} =~ /_order/) {
2899 $where = "quotation = '0'";
2901 } elsif ($self->{type} =~ /_quotation/) {
2903 $where = "quotation = '1'";
2905 } elsif ($table eq 'customer') {
2913 $where = "($where) AND" if ($where);
2914 my $query = qq|SELECT MAX(id) FROM $arap
2915 WHERE $where ${table}_id > 0|;
2916 my ($trans_id) = selectrow_query($self, $dbh, $query);
2919 my $column_spec = join(', ', map { "${_} AS $column_map{$_}" } keys %column_map);
2920 $query = qq|SELECT $column_spec
2922 LEFT JOIN $table ct ON (a.${table}_id = ct.id)
2923 LEFT JOIN department d ON (a.department_id = d.id)
2924 LEFT JOIN currencies cu ON (cu.id=ct.currency_id)
2926 my $ref = selectfirst_hashref_query($self, $dbh, $query, $trans_id);
2928 map { $self->{$_} = $ref->{$_} } values %column_map;
2930 $main::lxdebug->leave_sub();
2933 sub get_variable_content_types {
2934 my %html_variables = (
2935 longdescription => 'html',
2936 partnotes => 'html',
2938 orignotes => 'html',
2943 header_text => 'html',
2944 footer_text => 'html',
2946 return \%html_variables;
2950 $main::lxdebug->enter_sub();
2953 my $myconfig = shift || \%::myconfig;
2954 my ($thisdate, $days) = @_;
2956 my $dbh = $self->get_standard_dbh($myconfig);
2961 my $dateformat = $myconfig->{dateformat};
2962 $dateformat .= "yy" if $myconfig->{dateformat} !~ /^y/;
2963 $thisdate = $dbh->quote($thisdate);
2964 $query = qq|SELECT to_date($thisdate, '$dateformat') + $days AS thisdate|;
2966 $query = qq|SELECT current_date AS thisdate|;
2969 ($thisdate) = selectrow_query($self, $dbh, $query);
2971 $main::lxdebug->leave_sub();
2977 $main::lxdebug->enter_sub();
2979 my ($self, $flds, $new, $count, $numrows) = @_;
2983 map { push @ndx, { num => $new->[$_ - 1]->{runningnumber}, ndx => $_ } } 1 .. $count;
2988 foreach my $item (sort { $a->{num} <=> $b->{num} } @ndx) {
2990 my $j = $item->{ndx} - 1;
2991 map { $self->{"${_}_$i"} = $new->[$j]->{$_} } @{$flds};
2995 for $i ($count + 1 .. $numrows) {
2996 map { delete $self->{"${_}_$i"} } @{$flds};
2999 $main::lxdebug->leave_sub();
3003 $main::lxdebug->enter_sub();
3005 my ($self, $myconfig) = @_;
3009 SL::DB->client->with_transaction(sub {
3010 my $dbh = SL::DB->client->dbh;
3012 my $query = qq|DELETE FROM status
3013 WHERE (formname = ?) AND (trans_id = ?)|;
3014 my $sth = prepare_query($self, $dbh, $query);
3016 if ($self->{formname} =~ /(check|receipt)/) {
3017 for $i (1 .. $self->{rowcount}) {
3018 do_statement($self, $sth, $query, $self->{formname}, $self->{"id_$i"} * 1);
3021 do_statement($self, $sth, $query, $self->{formname}, $self->{id});
3025 my $printed = ($self->{printed} =~ /\Q$self->{formname}\E/) ? "1" : "0";
3026 my $emailed = ($self->{emailed} =~ /\Q$self->{formname}\E/) ? "1" : "0";
3028 my %queued = split / /, $self->{queued};
3031 if ($self->{formname} =~ /(check|receipt)/) {
3033 # this is a check or receipt, add one entry for each lineitem
3034 my ($accno) = split /--/, $self->{account};
3035 $query = qq|INSERT INTO status (trans_id, printed, spoolfile, formname, chart_id)
3036 VALUES (?, ?, ?, ?, (SELECT c.id FROM chart c WHERE c.accno = ?))|;
3037 @values = ($printed, $queued{$self->{formname}}, $self->{prinform}, $accno);
3038 $sth = prepare_query($self, $dbh, $query);
3040 for $i (1 .. $self->{rowcount}) {
3041 if ($self->{"checked_$i"}) {
3042 do_statement($self, $sth, $query, $self->{"id_$i"}, @values);
3048 $query = qq|INSERT INTO status (trans_id, printed, emailed, spoolfile, formname)
3049 VALUES (?, ?, ?, ?, ?)|;
3050 do_query($self, $dbh, $query, $self->{id}, $printed, $emailed,
3051 $queued{$self->{formname}}, $self->{formname});
3054 }) or do { die SL::DB->client->error };
3056 $main::lxdebug->leave_sub();
3060 $main::lxdebug->enter_sub();
3062 my ($self, $dbh) = @_;
3064 my ($query, $printed, $emailed);
3066 my $formnames = $self->{printed};
3067 my $emailforms = $self->{emailed};
3069 $query = qq|DELETE FROM status
3070 WHERE (formname = ?) AND (trans_id = ?)|;
3071 do_query($self, $dbh, $query, $self->{formname}, $self->{id});
3073 # this only applies to the forms
3074 # checks and receipts are posted when printed or queued
3076 if ($self->{queued}) {
3077 my %queued = split / /, $self->{queued};
3079 foreach my $formname (keys %queued) {
3080 $printed = ($self->{printed} =~ /\Q$self->{formname}\E/) ? "1" : "0";
3081 $emailed = ($self->{emailed} =~ /\Q$self->{formname}\E/) ? "1" : "0";
3083 $query = qq|INSERT INTO status (trans_id, printed, emailed, spoolfile, formname)
3084 VALUES (?, ?, ?, ?, ?)|;
3085 do_query($self, $dbh, $query, $self->{id}, $printed, $emailed, $queued{$formname}, $formname);
3087 $formnames =~ s/\Q$self->{formname}\E//;
3088 $emailforms =~ s/\Q$self->{formname}\E//;
3093 # save printed, emailed info
3094 $formnames =~ s/^ +//g;
3095 $emailforms =~ s/^ +//g;
3098 map { $status{$_}{printed} = 1 } split / +/, $formnames;
3099 map { $status{$_}{emailed} = 1 } split / +/, $emailforms;
3101 foreach my $formname (keys %status) {
3102 $printed = ($formnames =~ /\Q$self->{formname}\E/) ? "1" : "0";
3103 $emailed = ($emailforms =~ /\Q$self->{formname}\E/) ? "1" : "0";
3105 $query = qq|INSERT INTO status (trans_id, printed, emailed, formname)
3106 VALUES (?, ?, ?, ?)|;
3107 do_query($self, $dbh, $query, $self->{id}, $printed, $emailed, $formname);
3110 $main::lxdebug->leave_sub();
3114 # $main::locale->text('SAVED')
3115 # $main::locale->text('SCREENED')
3116 # $main::locale->text('DELETED')
3117 # $main::locale->text('ADDED')
3118 # $main::locale->text('PAYMENT POSTED')
3119 # $main::locale->text('POSTED')
3120 # $main::locale->text('POSTED AS NEW')
3121 # $main::locale->text('ELSE')
3122 # $main::locale->text('SAVED FOR DUNNING')
3123 # $main::locale->text('DUNNING STARTED')
3124 # $main::locale->text('PRINTED')
3125 # $main::locale->text('MAILED')
3126 # $main::locale->text('SCREENED')
3127 # $main::locale->text('CANCELED')
3128 # $main::locale->text('IMPORT')
3129 # $main::locale->text('UNIMPORT')
3130 # $main::locale->text('invoice')
3131 # $main::locale->text('proforma')
3132 # $main::locale->text('sales_order')
3133 # $main::locale->text('pick_list')
3134 # $main::locale->text('purchase_order')
3135 # $main::locale->text('bin_list')
3136 # $main::locale->text('sales_quotation')
3137 # $main::locale->text('request_quotation')
3140 $main::lxdebug->enter_sub();
3143 my $dbh = shift || SL::DB->client->dbh;
3144 SL::DB->client->with_transaction(sub {
3146 if(!exists $self->{employee_id}) {
3147 &get_employee($self, $dbh);
3151 qq|INSERT INTO history_erp (trans_id, employee_id, addition, what_done, snumbers) | .
3152 qq|VALUES (?, (SELECT id FROM employee WHERE login = ?), ?, ?, ?)|;
3153 my @values = (conv_i($self->{id}), $self->{login},
3154 $self->{addition}, $self->{what_done}, "$self->{snumbers}");
3155 do_query($self, $dbh, $query, @values);
3157 }) or do { die SL::DB->client->error };
3159 $main::lxdebug->leave_sub();
3163 $main::lxdebug->enter_sub();
3165 my ($self, $dbh, $trans_id, $restriction, $order) = @_;
3166 my ($orderBy, $desc) = split(/\-\-/, $order);
3167 $order = " ORDER BY " . ($order eq "" ? " h.itime " : ($desc == 1 ? $orderBy . " DESC " : $orderBy . " "));
3170 if ($trans_id ne "") {
3172 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 | .
3173 qq|FROM history_erp h | .
3174 qq|LEFT JOIN employee emp ON (emp.id = h.employee_id) | .
3175 qq|WHERE (trans_id = | . $trans_id . qq|) $restriction | .
3178 my $sth = $dbh->prepare($query) || $self->dberror($query);
3180 $sth->execute() || $self->dberror("$query");
3182 while(my $hash_ref = $sth->fetchrow_hashref()) {
3183 $hash_ref->{addition} = $main::locale->text($hash_ref->{addition});
3184 $hash_ref->{what_done} = $main::locale->text($hash_ref->{what_done});
3185 my ( $what, $number ) = split /_/, $hash_ref->{snumbers};
3186 $hash_ref->{snumbers} = $number;
3187 $hash_ref->{haslink} = 'controller.pl?action=EmailJournal/show&id='.$number if $what eq 'emailjournal';
3188 $hash_ref->{snumbers} = $main::locale->text("E-Mail").' '.$number if $what eq 'emailjournal';
3189 $tempArray[$i++] = $hash_ref;
3191 $main::lxdebug->leave_sub() and return \@tempArray
3192 if ($i > 0 && $tempArray[0] ne "");
3194 $main::lxdebug->leave_sub();
3198 sub get_partsgroup {
3199 $main::lxdebug->enter_sub();
3201 my ($self, $myconfig, $p) = @_;
3202 my $target = $p->{target} || 'all_partsgroup';
3204 my $dbh = $self->get_standard_dbh($myconfig);
3206 my $query = qq|SELECT DISTINCT pg.id, pg.partsgroup
3208 JOIN parts p ON (p.partsgroup_id = pg.id) |;
3211 if ($p->{searchitems} eq 'part') {
3212 $query .= qq|WHERE p.part_type = 'part'|;
3214 if ($p->{searchitems} eq 'service') {
3215 $query .= qq|WHERE p.part_type = 'service'|;
3217 if ($p->{searchitems} eq 'assembly') {
3218 $query .= qq|WHERE p.part_type = 'assembly'|;
3221 $query .= qq|ORDER BY partsgroup|;
3224 $query = qq|SELECT id, partsgroup FROM partsgroup
3225 ORDER BY partsgroup|;
3228 if ($p->{language_code}) {
3229 $query = qq|SELECT DISTINCT pg.id, pg.partsgroup,
3230 t.description AS translation
3232 JOIN parts p ON (p.partsgroup_id = pg.id)
3233 LEFT JOIN translation t ON ((t.trans_id = pg.id) AND (t.language_code = ?))
3234 ORDER BY translation|;
3235 @values = ($p->{language_code});
3238 $self->{$target} = selectall_hashref_query($self, $dbh, $query, @values);
3240 $main::lxdebug->leave_sub();
3243 sub get_pricegroup {
3244 $main::lxdebug->enter_sub();
3246 my ($self, $myconfig, $p) = @_;
3248 my $dbh = $self->get_standard_dbh($myconfig);
3250 my $query = qq|SELECT p.id, p.pricegroup
3253 $query .= qq| ORDER BY pricegroup|;
3256 $query = qq|SELECT id, pricegroup FROM pricegroup
3257 ORDER BY pricegroup|;
3260 $self->{all_pricegroup} = selectall_hashref_query($self, $dbh, $query);
3262 $main::lxdebug->leave_sub();
3266 # usage $form->all_years($myconfig, [$dbh])
3267 # return list of all years where bookings found
3270 $main::lxdebug->enter_sub();
3272 my ($self, $myconfig, $dbh) = @_;
3274 $dbh ||= $self->get_standard_dbh($myconfig);
3277 my $query = qq|SELECT (SELECT MIN(transdate) FROM acc_trans),
3278 (SELECT MAX(transdate) FROM acc_trans)|;
3279 my ($startdate, $enddate) = selectrow_query($self, $dbh, $query);
3281 if ($myconfig->{dateformat} =~ /^yy/) {
3282 ($startdate) = split /\W/, $startdate;
3283 ($enddate) = split /\W/, $enddate;
3285 (@_) = split /\W/, $startdate;
3287 (@_) = split /\W/, $enddate;
3292 $startdate = substr($startdate,0,4);
3293 $enddate = substr($enddate,0,4);
3295 while ($enddate >= $startdate) {
3296 push @all_years, $enddate--;
3301 $main::lxdebug->leave_sub();
3305 $main::lxdebug->enter_sub();
3309 map { $self->{_VAR_BACKUP}->{$_} = $self->{$_} if exists $self->{$_} } @vars;
3311 $main::lxdebug->leave_sub();
3315 $main::lxdebug->enter_sub();
3320 map { $self->{$_} = $self->{_VAR_BACKUP}->{$_} if exists $self->{_VAR_BACKUP}->{$_} } @vars;
3322 $main::lxdebug->leave_sub();
3325 sub prepare_for_printing {
3328 my $defaults = SL::DB::Default->get;
3330 $self->{templates} ||= $defaults->templates;
3331 $self->{formname} ||= $self->{type};
3332 $self->{media} ||= 'email';
3334 die "'media' other than 'email', 'file', 'printer' is not supported yet" unless $self->{media} =~ m/^(?:email|file|printer)$/;
3336 # Several fields that used to reside in %::myconfig (stored in
3337 # auth.user_config) are now stored in defaults. Copy them over for
3339 $self->{$_} = $defaults->$_ for qw(company address taxnumber co_ustid duns sepa_creditor_id);
3341 $self->{"myconfig_${_}"} = $::myconfig{$_} for grep { $_ ne 'dbpasswd' } keys %::myconfig;
3343 if (!$self->{employee_id}) {
3344 $self->{"employee_${_}"} = $::myconfig{$_} for qw(email tel fax name signature);
3345 $self->{"employee_${_}"} = $defaults->$_ for qw(address businessnumber co_ustid company duns sepa_creditor_id taxnumber);
3348 # Load shipping address from database. If shipto_id is set then it's
3349 # one from the customer's/vendor's master data. Otherwise look an a
3350 # customized address linking back to the current record.
3351 my $shipto_module = $self->{type} =~ /_delivery_order$/ ? 'DO'
3352 : $self->{type} =~ /sales_order|sales_quotation|request_quotation|purchase_order/ ? 'OE'
3354 my $shipto = $self->{shipto_id} ? SL::DB::Shipto->new(shipto_id => $self->{shipto_id})->load
3355 : SL::DB::Manager::Shipto->get_first(where => [ module => $shipto_module, trans_id => $self->{id} ]);
3357 $self->{$_} = $shipto->$_ for grep { m{^shipto} } map { $_->name } @{ $shipto->meta->columns };
3358 $self->{"shiptocvar_" . $_->config->name} = $_->value_as_text for @{ $shipto->cvars_by_config };
3361 my $language = $self->{language} ? '_' . $self->{language} : '';
3363 my ($language_tc, $output_numberformat, $output_dateformat, $output_longdates);
3364 if ($self->{language_id}) {
3365 ($language_tc, $output_numberformat, $output_dateformat, $output_longdates) = AM->get_language_details(\%::myconfig, $self, $self->{language_id});
3368 $output_dateformat ||= $::myconfig{dateformat};
3369 $output_numberformat ||= $::myconfig{numberformat};
3370 $output_longdates //= 1;
3372 $self->{myconfig_output_dateformat} = $output_dateformat // $::myconfig{dateformat};
3373 $self->{myconfig_output_longdates} = $output_longdates // 1;
3374 $self->{myconfig_output_numberformat} = $output_numberformat // $::myconfig{numberformat};
3376 # Retrieve accounts for tax calculation.
3377 IC->retrieve_accounts(\%::myconfig, $self, map { $_ => $self->{"id_$_"} } 1 .. $self->{rowcount});
3379 if ($self->{type} =~ /_delivery_order$/) {
3380 DO->order_details(\%::myconfig, $self);
3381 } elsif ($self->{type} =~ /sales_order|sales_quotation|request_quotation|purchase_order/) {
3382 OE->order_details(\%::myconfig, $self);
3384 IS->invoice_details(\%::myconfig, $self, $::locale);
3387 # Chose extension & set source file name
3388 my $extension = 'html';
3389 if ($self->{format} eq 'postscript') {
3390 $self->{postscript} = 1;
3392 } elsif ($self->{"format"} =~ /pdf/) {
3394 $extension = $self->{'format'} =~ m/opendocument/i ? 'odt' : 'tex';
3395 } elsif ($self->{"format"} =~ /opendocument/) {
3396 $self->{opendocument} = 1;
3398 } elsif ($self->{"format"} =~ /excel/) {
3403 my $printer_code = $self->{printer_code} ? '_' . $self->{printer_code} : '';
3404 my $email_extension = $self->{media} eq 'email' && -f ($defaults->templates . "/$self->{formname}_email${language}.${extension}") ? '_email' : '';
3405 $self->{IN} = "$self->{formname}${email_extension}${language}${printer_code}.${extension}";
3408 $self->format_dates($output_dateformat, $output_longdates,
3409 qw(invdate orddate quodate pldate duedate reqdate transdate shippingdate deliverydate validitydate paymentdate datepaid
3410 transdate_oe deliverydate_oe employee_startdate employee_enddate),
3411 grep({ /^(?:datepaid|transdate_oe|reqdate|deliverydate|deliverydate_oe|transdate)_\d+$/ } keys(%{$self})));
3413 $self->reformat_numbers($output_numberformat, 2,
3414 qw(invtotal ordtotal quototal subtotal linetotal listprice sellprice netprice discount tax taxbase total paid),
3415 grep({ /^(?:linetotal|listprice|sellprice|netprice|taxbase|discount|paid|subtotal|total|tax)_\d+$/ } keys(%{$self})));
3417 $self->reformat_numbers($output_numberformat, undef, qw(qty price_factor), grep({ /^qty_\d+$/} keys(%{$self})));
3419 my ($cvar_date_fields, $cvar_number_fields) = CVar->get_field_format_list('module' => 'CT', 'prefix' => 'vc_');
3421 if (scalar @{ $cvar_date_fields }) {
3422 $self->format_dates($output_dateformat, $output_longdates, @{ $cvar_date_fields });
3425 while (my ($precision, $field_list) = each %{ $cvar_number_fields }) {
3426 $self->reformat_numbers($output_numberformat, $precision, @{ $field_list });
3429 $self->{template_meta} = {
3430 formname => $self->{formname},
3431 language => SL::DB::Manager::Language->find_by_or_create(id => $self->{language_id} || undef),
3432 format => $self->{format},
3433 media => $self->{media},
3434 extension => $extension,
3435 printer => SL::DB::Manager::Printer->find_by_or_create(id => $self->{printer_id} || undef),
3436 today => DateTime->today,
3442 sub calculate_arap {
3443 my ($self,$buysell,$taxincluded,$exchangerate,$roundplaces) = @_;
3445 # this function is used to calculate netamount, total_tax and amount for AP and
3446 # AR transactions (Kreditoren-/Debitorenbuchungen) by going over all lines
3448 # Thus it needs a fully prepared $form to work on.
3449 # calculate_arap assumes $form->{amount_$i} entries still need to be parsed
3451 # The calculated total values are all rounded (default is to 2 places) and
3452 # returned as parameters rather than directly modifying form. The aim is to
3453 # make the calculation of AP and AR behave identically. There is a test-case
3454 # for this function in t/form/arap.t
3456 # While calculating the totals $form->{amount_$i} and $form->{tax_$i} are
3457 # modified and formatted and receive the correct sign for writing straight to
3458 # acc_trans, depending on whether they are ar or ap.
3461 die "taxincluded needed in Form->calculate_arap" unless defined $taxincluded;
3462 die "exchangerate needed in Form->calculate_arap" unless defined $exchangerate;
3463 die 'illegal buysell parameter, has to be \"buy\" or \"sell\" in Form->calculate_arap\n' unless $buysell =~ /^(buy|sell)$/;
3464 $roundplaces = 2 unless $roundplaces;
3466 my $sign = 1; # adjust final results for writing amount to acc_trans
3467 $sign = -1 if $buysell eq 'buy';
3469 my ($netamount,$total_tax,$amount);
3473 # parse and round amounts, setting correct sign for writing to acc_trans
3474 for my $i (1 .. $self->{rowcount}) {
3475 $self->{"amount_$i"} = $self->round_amount($self->parse_amount(\%::myconfig, $self->{"amount_$i"}) * $exchangerate * $sign, $roundplaces);
3477 $amount += $self->{"amount_$i"} * $sign;
3480 for my $i (1 .. $self->{rowcount}) {
3481 next unless $self->{"amount_$i"};
3482 ($self->{"tax_id_$i"}) = split /--/, $self->{"taxchart_$i"};
3483 my $tax_id = $self->{"tax_id_$i"};
3485 my $selected_tax = SL::DB::Manager::Tax->find_by(id => "$tax_id");
3487 if ( $selected_tax ) {
3489 if ( $buysell eq 'sell' ) {
3490 $self->{AR_amounts}{"tax_$i"} = $selected_tax->chart->accno if defined $selected_tax->chart;
3492 $self->{AP_amounts}{"tax_$i"} = $selected_tax->chart->accno if defined $selected_tax->chart;
3495 $self->{"taxkey_$i"} = $selected_tax->taxkey;
3496 $self->{"taxrate_$i"} = $selected_tax->rate;
3499 ($self->{"amount_$i"}, $self->{"tax_$i"}) = $self->calculate_tax($self->{"amount_$i"},$self->{"taxrate_$i"},$taxincluded,$roundplaces);
3501 $netamount += $self->{"amount_$i"};
3502 $total_tax += $self->{"tax_$i"};
3505 $amount = $netamount + $total_tax;
3507 # due to $sign amount_$i und tax_$i already have the right sign for acc_trans
3508 # but reverse sign of totals for writing amounts to ar
3509 if ( $buysell eq 'buy' ) {
3515 return($netamount,$total_tax,$amount);
3519 my ($self, $dateformat, $longformat, @indices) = @_;
3521 $dateformat ||= $::myconfig{dateformat};
3523 foreach my $idx (@indices) {
3524 if ($self->{TEMPLATE_ARRAYS} && (ref($self->{TEMPLATE_ARRAYS}->{$idx}) eq "ARRAY")) {
3525 for (my $i = 0; $i < scalar(@{ $self->{TEMPLATE_ARRAYS}->{$idx} }); $i++) {
3526 $self->{TEMPLATE_ARRAYS}->{$idx}->[$i] = $::locale->reformat_date(\%::myconfig, $self->{TEMPLATE_ARRAYS}->{$idx}->[$i], $dateformat, $longformat);
3530 next unless defined $self->{$idx};
3532 if (!ref($self->{$idx})) {
3533 $self->{$idx} = $::locale->reformat_date(\%::myconfig, $self->{$idx}, $dateformat, $longformat);
3535 } elsif (ref($self->{$idx}) eq "ARRAY") {
3536 for (my $i = 0; $i < scalar(@{ $self->{$idx} }); $i++) {
3537 $self->{$idx}->[$i] = $::locale->reformat_date(\%::myconfig, $self->{$idx}->[$i], $dateformat, $longformat);
3543 sub reformat_numbers {
3544 my ($self, $numberformat, $places, @indices) = @_;
3546 return if !$numberformat || ($numberformat eq $::myconfig{numberformat});
3548 foreach my $idx (@indices) {
3549 if ($self->{TEMPLATE_ARRAYS} && (ref($self->{TEMPLATE_ARRAYS}->{$idx}) eq "ARRAY")) {
3550 for (my $i = 0; $i < scalar(@{ $self->{TEMPLATE_ARRAYS}->{$idx} }); $i++) {
3551 $self->{TEMPLATE_ARRAYS}->{$idx}->[$i] = $self->parse_amount(\%::myconfig, $self->{TEMPLATE_ARRAYS}->{$idx}->[$i]);
3555 next unless defined $self->{$idx};
3557 if (!ref($self->{$idx})) {
3558 $self->{$idx} = $self->parse_amount(\%::myconfig, $self->{$idx});
3560 } elsif (ref($self->{$idx}) eq "ARRAY") {
3561 for (my $i = 0; $i < scalar(@{ $self->{$idx} }); $i++) {
3562 $self->{$idx}->[$i] = $self->parse_amount(\%::myconfig, $self->{$idx}->[$i]);
3567 my $saved_numberformat = $::myconfig{numberformat};
3568 $::myconfig{numberformat} = $numberformat;
3570 foreach my $idx (@indices) {
3571 if ($self->{TEMPLATE_ARRAYS} && (ref($self->{TEMPLATE_ARRAYS}->{$idx}) eq "ARRAY")) {
3572 for (my $i = 0; $i < scalar(@{ $self->{TEMPLATE_ARRAYS}->{$idx} }); $i++) {
3573 $self->{TEMPLATE_ARRAYS}->{$idx}->[$i] = $self->format_amount(\%::myconfig, $self->{TEMPLATE_ARRAYS}->{$idx}->[$i], $places);
3577 next unless defined $self->{$idx};
3579 if (!ref($self->{$idx})) {
3580 $self->{$idx} = $self->format_amount(\%::myconfig, $self->{$idx}, $places);
3582 } elsif (ref($self->{$idx}) eq "ARRAY") {
3583 for (my $i = 0; $i < scalar(@{ $self->{$idx} }); $i++) {
3584 $self->{$idx}->[$i] = $self->format_amount(\%::myconfig, $self->{$idx}->[$i], $places);
3589 $::myconfig{numberformat} = $saved_numberformat;
3592 sub create_email_signature {
3594 my $client_signature = $::instance_conf->get_signature;
3595 my $user_signature = $::myconfig{signature};
3598 if ( $client_signature or $user_signature ) {
3599 $signature = "\n\n-- \n";
3600 $signature .= $user_signature . "\n" if $user_signature;
3601 $signature .= $client_signature . "\n" if $client_signature;
3609 $::lxdebug->enter_sub;
3611 my %style_to_script_map = (
3616 my $menu_script = $style_to_script_map{$::myconfig{menustyle}} || '';
3619 require "bin/mozilla/menu$menu_script.pl";
3621 require SL::Controller::FrameHeader;
3624 my $layout = SL::Controller::FrameHeader->new->action_header . ::render();
3626 $::lxdebug->leave_sub;
3631 # this function calculates the net amount and tax for the lines in ar, ap and
3632 # gl and is used for update as well as post. When used with update the return
3633 # value of amount isn't needed
3635 # calculate_tax should always work with positive values, or rather as the user inputs them
3636 # calculate_tax uses db/perl numberformat, i.e. parsed numbers
3637 # convert to negative numbers (when necessary) only when writing to acc_trans
3638 # the amount from $form for ap/ar/gl is currently always rounded to 2 decimals before it reaches here
3639 # for post_transaction amount already contains exchangerate and correct sign and is rounded
3640 # calculate_tax doesn't (need to) know anything about exchangerate
3642 my ($self,$amount,$taxrate,$taxincluded,$roundplaces) = @_;
3650 # calculate tax (unrounded), subtract from amount, round amount and round tax
3651 $tax = $amount - ($amount / ($taxrate + 1)); # equivalent to: taxrate * amount / (taxrate + 1)
3652 $amount = $self->round_amount($amount - $tax, $roundplaces);
3653 $tax = $self->round_amount($tax, $roundplaces);
3655 $tax = $amount * $taxrate;
3656 $tax = $self->round_amount($tax, $roundplaces);
3659 $tax = 0 unless $tax;
3661 return ($amount,$tax);
3670 SL::Form.pm - main data object.
3674 This is the main data object of kivitendo.
3675 Unfortunately it also acts as a god object for certain data retrieval procedures used in the entry points.
3676 Points of interest for a beginner are:
3678 - $form->error - renders a generic error in html. accepts an error message
3679 - $form->get_standard_dbh - returns a database connection for the
3681 =head1 SPECIAL FUNCTIONS
3683 =head2 C<redirect_header> $url
3685 Generates a HTTP redirection header for the new C<$url>. Constructs an
3686 absolute URL including scheme, host name and port. If C<$url> is a
3687 relative URL then it is considered relative to kivitendo base URL.
3689 This function C<die>s if headers have already been created with
3690 C<$::form-E<gt>header>.
3694 print $::form->redirect_header('oe.pl?action=edit&id=1234');
3695 print $::form->redirect_header('http://www.lx-office.org/');
3699 Generates a general purpose http/html header and includes most of the scripts
3700 and stylesheets needed. Stylesheets can be added with L<use_stylesheet>.
3702 Only one header will be generated. If the method was already called in this
3703 request it will not output anything and return undef. Also if no
3704 HTTP_USER_AGENT is found, no header is generated.
3706 Although header does not accept parameters itself, it will honor special
3707 hashkeys of its Form instance:
3715 If one of these is set, a http-equiv refresh is generated. Missing parameters
3716 default to 3 seconds and the refering url.
3720 Either a scalar or an array ref. Will be inlined into the header. Add
3721 stylesheets with the L<use_stylesheet> function.
3725 If true, a css snippet will be generated that sets the page in landscape mode.
3729 Used to override the default favicon.
3733 A html page title will be generated from this
3735 =item mtime_ischanged
3737 Tries to avoid concurrent write operations to records by checking the database mtime with a fetched one.
3739 Can be used / called with any table, that has itime and mtime attributes.
3740 Valid C<table> names are: oe, ar, ap, delivery_orders, parts.
3741 Can be called wit C<option> mail to generate a different error message.
3743 Returns undef if no save operation has been done yet ($self->{id} not present).
3744 Returns undef if no concurrent write process is detected otherwise a error message.