Merge branch 'master' of git.freeside.biz:/home/git/freeside
[freeside.git] / FS / FS / part_pkg / discount_Mixin.pm
index a0bdcee..3180275 100644 (file)
@@ -1,14 +1,12 @@
 package FS::part_pkg::discount_Mixin;
 
 use strict;
-use vars qw(@ISA %info);
-use FS::part_pkg;
+use vars qw( %info );
+use Time::Local qw( timelocal );
+use List::Util  qw( min );
 use FS::cust_pkg;
 use FS::cust_bill_pkg_discount;
-use Time::Local qw(timelocal);
-use List::Util 'min';
 
-@ISA = qw(FS::part_pkg);
 %info = ( 'disabled' => 1 );
 
 =head1 NAME
@@ -34,16 +32,17 @@ sub calc_recur {
 
 Takes all the arguments of calc_recur.  Calculates and returns  the amount 
 by which to reduce the recurring fee; also increments months used on the 
-discount and generates an invoice detail describing it.
+discount.
 
 =cut
 
 sub calc_discount {
   my($self, $cust_pkg, $sdate, $details, $param ) = @_;
+  my $conf = new FS::Conf;
 
-  my $br = $self->base_recur($cust_pkg);
+  my $br = $self->base_recur_permonth($cust_pkg, $sdate);
   $br += $param->{'override_charges'} if $param->{'override_charges'};
-
   my $tot_discount = 0;
   #UI enforces just 1 for now, will need ordering when they can be stacked
 
@@ -78,28 +77,84 @@ sub calc_discount {
 
   my @cust_pkg_discount = $cust_pkg->cust_pkg_discount_active;
   foreach my $cust_pkg_discount ( @cust_pkg_discount ) {
+    my $discount_left;
     my $discount = $cust_pkg_discount->discount;
     #UI enforces one or the other (for now?  probably for good)
     my $amount = 0;
     $amount += $discount->amount
-    if $cust_pkg->pkgpart == $param->{real_pkgpart};
+        if $cust_pkg->pkgpart == $param->{'real_pkgpart'};
     $amount += sprintf('%.2f', $discount->percent * $br / 100 );
-    my $chg_months = $param->{'months'} || $cust_pkg->part_pkg->freq;
+    my $chg_months = defined($param->{'months'}) ?
+                      $param->{'months'} :
+                      $cust_pkg->part_pkg->freq;
 
     my $months = $discount->months
     ? min( $chg_months,
       $discount->months - $cust_pkg_discount->months_used )
     : $chg_months;
 
-    my $error = $cust_pkg_discount->increment_months_used($months)
-    if $cust_pkg->pkgpart == $param->{real_pkgpart};
-    die "error discounting: $error" if $error;
+    if (defined $param->{'setup_charge'}) {
+        next unless $discount->setup;
+
+        if ( $discount->percent > 0 ) {
+            $amount = sprintf('%.2f', $discount->percent * $param->{'setup_charge'} / 100 );
+            $months = 1;
+        } elsif ( $discount->amount > 0 && $discount->months == 1) {
+            $discount_left = $param->{'setup_charge'} - $discount->amount;
+            $amount = $param->{'setup_charge'} if $discount_left < 0;
+            $amount = $discount->amount if $discount_left >= 0;
+            $months = 1;
+                
+            # transfer remainder of discount, if any, to recur
+            $param->{'discount_left_recur'}{$discount->discountnum} = 
+                0 - $discount_left if $discount_left < 0;
+        } else {
+            next; 
+        }
+    } elsif ( defined $param->{'discount_left_recur'}{$discount->discountnum}
+              && $param->{'discount_left_recur'}{$discount->discountnum} > 0
+            ) {
+        # use up transferred remainder of discount from setup
+        $amount = $param->{'discount_left_recur'}{$discount->discountnum};
+        $param->{'discount_left_recur'}{$discount->discountnum} = 0;
+        $months = 1;
+    } elsif (    $discount->setup
+              && $discount->months == 1
+              && $discount->amount > 0
+            ) {
+        next;
+    }
+
+    if ( ! defined $param->{'setup_charge'} ) {
+      if ( $cust_pkg->pkgpart == $param->{'real_pkgpart'} ) {
+        push @{ $param->{precommit_hooks} }, sub {
+          my $error = $cust_pkg_discount->increment_months_used($months);
+          die "error discounting: $error" if $error;
+        };
+      }
+
+      $amount = min($amount, $br);
+      $amount *= $months;
+    }
 
-    $amount *= $months;
-    $amount = sprintf('%.2f', $amount);
+    $amount = sprintf('%.2f', $amount + 0.00000001 ); #so 1.005 rounds to 1.01
 
     next unless $amount > 0;
 
+    # transfer remainder of discount, if any, to setup
+    if ( $discount->setup && $discount->amount > 0
+        && (!$discount->months || $discount->months != 1)
+        && !defined $param->{'setup_charge'}
+       )
+    {
+      $discount_left = $br - $amount;
+      if ( $discount_left < 0 ) {
+        $amount = $br;
+        $param->{'discount_left_setup'}{$discount->discountnum} = 
+          0 - $discount_left;
+      }
+    }
+
     #record details in cust_bill_pkg_discount
     my $cust_bill_pkg_discount = new FS::cust_bill_pkg_discount {
       'pkgdiscountnum' => $cust_pkg_discount->pkgdiscountnum,
@@ -107,20 +162,34 @@ sub calc_discount {
       'months'         => $months,
     };
     push @{ $param->{'discounts'} }, $cust_bill_pkg_discount;
+    $tot_discount += $amount;
 
     #add details on discount to invoice
-    my $conf = new FS::Conf;
-    my $money_char = $conf->config('money_char') || '$';
-    $months = sprintf('%.2f', $months) if $months =~ /\./;
-
-    my $d = 'Includes ';
-    $d .= $discount->name. ' ' if $discount->name;
-    $d .= 'discount of '. $discount->description_short;
-    $d .= " for $months month". ( $months!=1 ? 's' : '' );
-    $d .= ": $money_char$amount" if $months != 1 || $discount->percent;
-    push @$details, $d;
+    # no longer! this is now done during rendering based on the existence
+    # of the cust_bill_pkg_discount record
+    #
+    #my $money_char = $conf->config('money_char') || '$';
+    #$months = sprintf('%.2f', $months) if $months =~ /\./;
+
+    #my $d = 'Includes ';
+    #my $format;
+
+    #if ( $months eq '1' ) {
+    #  $d .= "discount of $money_char$amount";
+    #  $d .= " each" if $cust_pkg->quantity > 1;
+    #  $format = 'Undiscounted amount: %s%.2f';
+    #} else {
+    #  $d .= 'setup ' if defined $param->{'setup_charge'};
+    #  $d .= 'discount of '. $discount->description_short;
+    #  $d .= " for $months months"
+    #    unless defined $param->{'setup_charge'};
+    #  $d .= ": $money_char$amount" if $discount->percent;
+    #  $format = 'Undiscounted monthly amount: %s%.2f';
+    #}
+
+    #push @$details, $d;
+    #push @$details, sprintf( $format, $money_char, $br );
 
-    $tot_discount += $amount;
   }
 
   sprintf('%.2f', $tot_discount);