Dispatcher: Client DB Handles cachen.
[kivitendo-erp.git] / SL / Form.pm
index ace85e7..b0709de 100644 (file)
@@ -41,11 +41,13 @@ use Carp;
 use Data::Dumper;
 
 use Carp;
+use Config;
 use CGI;
 use Cwd;
 use Encode;
 use File::Copy;
 use IO::File;
+use Math::BigInt;
 use SL::Auth;
 use SL::Auth::DB;
 use SL::Auth::LDAP;
@@ -77,6 +79,7 @@ use Template;
 use URI;
 use List::Util qw(first max min sum);
 use List::MoreUtils qw(all any apply);
+use SL::DB::Tax;
 
 use strict;
 
@@ -88,7 +91,8 @@ END {
 
 sub disconnect_standard_dbh {
   return unless $standard_dbh;
-  $standard_dbh->disconnect();
+
+  $standard_dbh->rollback();
   undef $standard_dbh;
 }
 
@@ -464,7 +468,7 @@ sub header {
   # standard css for all
   # this should gradually move to the layouts that need it
   $layout->use_stylesheet("$_.css") for qw(
-    main menu list_accounts jquery.autocomplete
+    main menu common list_accounts jquery.autocomplete
     jquery.multiselect2side
     ui-lightness/jquery-ui
     jquery-ui.custom
@@ -473,7 +477,7 @@ sub header {
   $layout->use_javascript("$_.js") for (qw(
     jquery jquery-ui jquery.cookie jquery.checkall jquery.download
     jquery/jquery.form jquery/fixes client_js
-    common part_selection switchmenuframe autocomplete_part
+    common part_selection switchmenuframe
   ), "jquery/ui/i18n/jquery.ui.datepicker-$::myconfig{countrycode}");
 
   $self->{favicon} ||= "favicon.ico";
@@ -944,34 +948,45 @@ sub parse_amount {
 
   # Make sure no code wich is not a math expression ends up in eval().
   return 0 unless $amount =~ /^ [\s \d \( \) \- \+ \* \/ \. ]* $/x;
+
+  # Prevent numbers from being parsed as octals;
+  $amount =~ s{ (?<! [\d.] ) 0+ (?= [1-9] ) }{}gx;
+
   return scalar(eval($amount)) * 1 ;
 }
 
 sub round_amount {
   my ($self, $amount, $places) = @_;
 
-  # Rounding like "Kaufmannsrunden" (see http://de.wikipedia.org/wiki/Rundung )
+  return 0 if !defined $amount;
+
+  # We use Perl's knowledge of string representation for
+  # rounding. First, convert the floating point number to a string
+  # with a high number of places. Then split the string on the decimal
+  # sign and use integer calculation for rounding the decimal places
+  # part. If an overflow occurs then apply that overflow to the part
+  # before the decimal sign as well using integer arithmetic again.
+
+  my $amount_str = sprintf '%.*f', $places + 10, abs($amount);
+
+  return $amount unless $amount_str =~ m{^(\d+)\.(\d+)$};
 
-  # Round amounts to eight places before rounding to the requested
-  # number of places. This gets rid of errors due to internal floating
-  # point representation.
-  $amount   = $self->round_amount($amount, 8) if $places < 8;
+  my ($pre, $post)      = ($1, $2);
+  my $decimals          = '1' . substr($post, 0, $places);
 
-  # Remember the amount's sign but calculate in positive values only.
-  my $sign  = $amount <=> 0;
-  $amount   = abs $amount;
+  my $propagation_limit = $Config{i32size} == 4 ? 7 : 18;
+  my $add_for_rounding  = substr($post, $places, 1) >= 5 ? 1 : 0;
 
-  # Shift the amount left by $places+1 decimal places and truncate it
-  # to integer. Then to the integer equivalent of rounding to the next
-  # multiple of 10: first add half of it (5). Then truncate it back to
-  # the lower multiple of 10 by subtracting $amount modulo 10.
-  my $shift = 10 ** ($places + 1);
-  $amount   = int($amount * $shift) + 5;
-  $amount  -= $amount % 10;
+  if ($places > $propagation_limit) {
+    $decimals = Math::BigInt->new($decimals)->badd($add_for_rounding);
+    $pre      = Math::BigInt->new($decimals)->badd(1) if substr($decimals, 0, 1) eq '2';
 
-  # Lastly shift the amount back right by $places+1 decimal places and
-  # restore its sign. Then we're done.
-  $amount   = ($amount / $shift) * $sign;
+  } else {
+    $decimals += $add_for_rounding;
+    $pre      += 1 if substr($decimals, 0, 1) eq '2';
+  }
+
+  $amount  = ("${pre}." . substr($decimals, 1)) * ($amount <=> 0);
 
   return $amount;
 }
@@ -1034,7 +1049,7 @@ sub parse_template {
                                       %{ $self->{TEMPLATE_DRIVER_OPTIONS} || {} });
 
   # Copy the notes from the invoice/sales order etc. back to the variable "notes" because that is where most templates expect it to be.
-  $self->{"notes"} = $self->{ $self->{"formname"} . "notes" };
+  $self->{"notes"} = $self->{ $self->{"formname"} . "notes" } if exists $self->{ $self->{"formname"} . "notes" };
 
   if (!$self->{employee_id}) {
     $self->{"employee_${_}"} = $myconfig->{$_} for qw(email tel fax name signature);
@@ -1111,7 +1126,7 @@ sub parse_template {
 
   if ($self->{media} eq 'email') {
 
-    my $mail = new Mailer;
+    my $mail = Mailer->new;
 
     map { $mail->{$_} = $self->{$_} }
       qw(cc bcc subject message version format);
@@ -1129,7 +1144,7 @@ sub parse_template {
       $full_signature         =~ s/\n/<br>\n/g;
       $mail->{message}       .=  $full_signature;
 
-      open(IN, "<", $self->{tmpfile})
+      open(IN, "<:encoding(UTF-8)", $self->{tmpfile})
         or $self->error($self->cleanup . "$self->{tmpfile} : $!");
       $mail->{message} .= $_ while <IN>;
       close(IN);
@@ -1227,6 +1242,7 @@ sub get_formname_translation {
     sales_delivery_order    => $main::locale->text('Delivery Order'),
     purchase_delivery_order => $main::locale->text('Delivery Order'),
     dunning                 => $main::locale->text('Dunning'),
+    letter                  => $main::locale->text('Letter')
   );
 
   $main::lxdebug->leave_sub();
@@ -1241,8 +1257,13 @@ sub get_number_prefix_for_type {
       (first { $self->{type} eq $_ } qw(invoice credit_note)) ? 'inv'
     : ($self->{type} =~ /_quotation$/)                        ? 'quo'
     : ($self->{type} =~ /_delivery_order$/)                   ? 'do'
+    : ($self->{type} =~ /letter/)                             ? 'letter'
     :                                                           'ord';
 
+  # better default like this?
+  # : ($self->{type} =~ /(sales|purcharse)_order/           :  'ord';
+  # :                                                           'prefix_undefined';
+
   $main::lxdebug->leave_sub();
   return $prefix;
 }
@@ -1318,7 +1339,7 @@ sub cleanup {
     push @err, $::locale->text('The application "#1" was not found on the system.', $application || 'pdflatex') . ' ' . $::locale->text('Please contact your administrator.');
 
   } elsif (-f "$self->{tmpfile}.err") {
-    open(FH, "$self->{tmpfile}.err");
+    open(FH, "<:encoding(UTF-8)", "$self->{tmpfile}.err");
     @err = <FH>;
     close(FH);
   }
@@ -2145,8 +2166,10 @@ sub _get_taxzones {
   my ($self, $dbh, $key) = @_;
 
   $key = "all_taxzones" unless ($key);
+  my $tzfilter = "";
+  $tzfilter = "WHERE obsolete is FALSE" if $key eq 'ALL_ACTIVE_TAXZONES';
 
-  my $query = qq|SELECT * FROM tax_zones ORDER BY id|;
+  my $query = qq|SELECT * FROM tax_zones $tzfilter ORDER BY sortkey|;
 
   $self->{$key} = selectall_hashref_query($self, $dbh, $query);
 
@@ -2377,7 +2400,7 @@ sub get_lists {
   if ($params{contacts} || $params{shipto}) {
     $vc = 'customer' if $self->{"vc"} eq "customer";
     $vc = 'vendor'   if $self->{"vc"} eq "vendor";
-    die "invalid use of get_lists, need 'vc'";
+    die "invalid use of get_lists, need 'vc'" unless $vc;
     $vc_id = $self->{"${vc}_id"};
   }
 
@@ -2420,7 +2443,7 @@ sub get_lists {
   }
 
   if ($params{"salesmen"}) {
-    $self->_get_employees($dbh, "all_salesmen", $params{"salesmen"});
+    $self->_get_employees($dbh, $params{"salesmen"});
   }
 
   if ($params{"business_types"}) {
@@ -3361,15 +3384,15 @@ sub prepare_for_printing {
   my ($language_tc, $output_numberformat, $output_dateformat, $output_longdates);
   if ($self->{language_id}) {
     ($language_tc, $output_numberformat, $output_dateformat, $output_longdates) = AM->get_language_details(\%::myconfig, $self, $self->{language_id});
-  } else {
-    $output_dateformat   = $::myconfig{dateformat};
-    $output_numberformat = $::myconfig{numberformat};
-    $output_longdates    = 1;
   }
 
-  $self->{myconfig_output_dateformat}   = $output_dateformat;
-  $self->{myconfig_output_longdates}    = $output_longdates;
-  $self->{myconfig_output_numberformat} = $output_numberformat;
+  $output_dateformat   ||= $::myconfig{dateformat};
+  $output_numberformat ||= $::myconfig{numberformat};
+  $output_longdates    //= 1;
+
+  $self->{myconfig_output_dateformat}   = $output_dateformat   // $::myconfig{dateformat};
+  $self->{myconfig_output_longdates}    = $output_longdates    // 1;
+  $self->{myconfig_output_numberformat} = $output_numberformat // $::myconfig{numberformat};
 
   # Retrieve accounts for tax calculation.
   IC->retrieve_accounts(\%::myconfig, $self, map { $_ => $self->{"id_$_"} } 1 .. $self->{rowcount});
@@ -3437,6 +3460,82 @@ sub prepare_for_printing {
   return $self;
 }
 
+sub calculate_arap {
+  my ($self,$buysell,$taxincluded,$exchangerate,$roundplaces) = @_;
+
+  # this function is used to calculate netamount, total_tax and amount for AP and
+  # AR transactions (Kreditoren-/Debitorenbuchungen) by going over all lines
+  # (1..$rowcount)
+  # Thus it needs a fully prepared $form to work on.
+  # calculate_arap assumes $form->{amount_$i} entries still need to be parsed
+
+  # The calculated total values are all rounded (default is to 2 places) and
+  # returned as parameters rather than directly modifying form.  The aim is to
+  # make the calculation of AP and AR behave identically.  There is a test-case
+  # for this function in t/form/arap.t
+
+  # While calculating the totals $form->{amount_$i} and $form->{tax_$i} are
+  # modified and formatted and receive the correct sign for writing straight to
+  # acc_trans, depending on whether they are ar or ap.
+
+  # check parameters
+  die "taxincluded needed in Form->calculate_arap" unless defined $taxincluded;
+  die "exchangerate needed in Form->calculate_arap" unless defined $exchangerate;
+  die 'illegal buysell parameter, has to be \"buy\" or \"sell\" in Form->calculate_arap\n' unless $buysell =~ /^(buy|sell)$/;
+  $roundplaces = 2 unless $roundplaces;
+
+  my $sign = 1;  # adjust final results for writing amount to acc_trans
+  $sign = -1 if $buysell eq 'buy';
+
+  my ($netamount,$total_tax,$amount);
+
+  my $tax;
+
+  # parse and round amounts, setting correct sign for writing to acc_trans
+  for my $i (1 .. $self->{rowcount}) {
+    $self->{"amount_$i"} = $self->round_amount($self->parse_amount(\%::myconfig, $self->{"amount_$i"}) * $exchangerate * $sign, $roundplaces);
+
+    $amount += $self->{"amount_$i"} * $sign;
+  }
+
+  for my $i (1 .. $self->{rowcount}) {
+    next unless $self->{"amount_$i"};
+    ($self->{"tax_id_$i"}) = split /--/, $self->{"taxchart_$i"};
+    my $tax_id = $self->{"tax_id_$i"};
+
+    my $selected_tax = SL::DB::Manager::Tax->find_by(id => "$tax_id");
+
+    if ( $selected_tax ) {
+
+      if ( $buysell eq 'sell' ) {
+        $self->{AR_amounts}{"tax_$i"} = $selected_tax->chart->accno unless $selected_tax->taxkey == 0;
+      } else {
+        $self->{AP_amounts}{"tax_$i"} = $selected_tax->chart->accno unless $selected_tax->taxkey == 0;
+      };
+
+      $self->{"taxkey_$i"} = $selected_tax->taxkey;
+      $self->{"taxrate_$i"} = $selected_tax->rate;
+    };
+
+    ($self->{"amount_$i"}, $self->{"tax_$i"}) = $self->calculate_tax($self->{"amount_$i"},$self->{"taxrate_$i"},$taxincluded,$roundplaces);
+
+    $netamount  += $self->{"amount_$i"};
+    $total_tax  += $self->{"tax_$i"};
+
+  }
+  $amount = $netamount + $total_tax;
+
+  # due to $sign amount_$i und tax_$i already have the right sign for acc_trans
+  # but reverse sign of totals for writing amounts to ar
+  if ( $buysell eq 'buy' ) {
+    $netamount *= -1;
+    $amount    *= -1;
+    $total_tax *= -1;
+  };
+
+  return($netamount,$total_tax,$amount);
+}
+
 sub format_dates {
   my ($self, $dateformat, $longformat, @indices) = @_;
 
@@ -3549,6 +3648,39 @@ sub layout {
   return $layout;
 }
 
+sub calculate_tax {
+  # this function calculates the net amount and tax for the lines in ar, ap and
+  # gl and is used for update as well as post. When used with update the return
+  # value of amount isn't needed
+
+  # calculate_tax should always work with positive values, or rather as the user inputs them
+  # calculate_tax uses db/perl numberformat, i.e. parsed numbers
+  # convert to negative numbers (when necessary) only when writing to acc_trans
+  # the amount from $form for ap/ar/gl is currently always rounded to 2 decimals before it reaches here
+  # for post_transaction amount already contains exchangerate and correct sign and is rounded
+  # calculate_tax doesn't (need to) know anything about exchangerate
+
+  my ($self,$amount,$taxrate,$taxincluded,$roundplaces) = @_;
+
+  $roundplaces = 2 unless defined $roundplaces;
+
+  my $tax;
+
+  if ($taxincluded *= 1) {
+    # calculate tax (unrounded), subtract from amount, round amount and round tax
+    $tax       = $amount - ($amount / ($taxrate + 1)); # equivalent to: taxrate * amount / (taxrate + 1)
+    $amount    = $self->round_amount($amount - $tax, $roundplaces);
+    $tax       = $self->round_amount($tax, $roundplaces);
+  } else {
+    $tax       = $amount * $taxrate;
+    $tax       = $self->round_amount($tax, $roundplaces);
+  }
+
+  $tax = 0 unless $tax;
+
+  return ($amount,$tax);
+};
+
 1;
 
 __END__