show available discounts on invoice, #5318

[freeside.git] / FS / FS / part_pkg / discount_Mixin.pm

diff --git a/FS/FS/part_pkg/discount_Mixin.pm b/FS/FS/part_pkg/discount_Mixin.pm
index 8ce5ba8..5d48459 100644 (file)
--- a/FS/FS/part_pkg/discount_Mixin.pm
+++ b/FS/FS/part_pkg/discount_Mixin.pm
@@ -36,16 +36,19 @@ 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.
 
+If the configuration option 'discount-show_available' is enabled, and this 
+package is eligible for a prepayment discount but doesn't have one, an 
+invoice detail will be generated to describe the available discounts.
+
 =cut
 
 sub calc_discount {
   my($self, $cust_pkg, $sdate, $details, $param ) = @_;
+  my $conf = new FS::Conf;
 
-  my $br = $self->base_recur($cust_pkg, $sdate);
+  my $br = $self->base_recur_permonth($cust_pkg, $sdate);
   $br += $param->{'override_charges'} if $param->{'override_charges'};
   
-  return 0 if defined $param->{'setup_charge'} && $param->{'setup_charge'} == 0;
-
   my $tot_discount = 0;
   #UI enforces just 1 for now, will need ordering when they can be stacked
 
@@ -80,11 +83,12 @@ 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 defined $param->{'real_pkgpart'} && $cust_pkg->pkgpart == $param->{'real_pkgpart'};
     $amount += sprintf('%.2f', $discount->percent * $br / 100 );
     my $chg_months = $param->{'months'} || $cust_pkg->part_pkg->freq;
 
@@ -92,7 +96,7 @@ sub calc_discount {
     ? min( $chg_months,
       $discount->months - $cust_pkg_discount->months_used )
     : $chg_months;
-    
+
     if(defined $param->{'setup_charge'}) {
         next unless $discount->setup;
 
@@ -100,18 +104,53 @@ sub calc_discount {
             $amount = sprintf('%.2f', $discount->percent * $param->{'setup_charge'} / 100 );
             $months = 1;
         }
+        elsif ( $discount->amount && $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 ) {
+        next;
     }
 
     my $error = $cust_pkg_discount->increment_months_used($months)
-        if ($cust_pkg->pkgpart == $param->{real_pkgpart} 
+        if (defined $param->{'real_pkgpart'} 
+            && $cust_pkg->pkgpart == $param->{'real_pkgpart'} 
             && ! defined $param->{'setup_charge'});
     die "error discounting: $error" if $error;
 
+    $amount = min($amount, $br);
     $amount *= $months;
     $amount = sprintf('%.2f', $amount);
 
     next unless $amount > 0;
 
+    # transfer remainder of discount, if any, to setup
+    if ( $discount->setup && $discount->amount
+        && (!$discount->months || $discount->months != 1)
+        && !defined $param->{'setup_charge'}) {
+        $discount_left = $br - $amount;
+        $amount = $br if $discount_left < 0;
+        $param->{'discount_left_setup'}{$discount->discountnum} = 
+                                    0 - $discount_left if $discount_left < 0;
+    }
+
     #record details in cust_bill_pkg_discount
     my $cust_bill_pkg_discount = new FS::cust_bill_pkg_discount {
       'pkgdiscountnum' => $cust_pkg_discount->pkgdiscountnum,
@@ -121,7 +160,6 @@ sub calc_discount {
     push @{ $param->{'discounts'} }, $cust_bill_pkg_discount;
 
     #add details on discount to invoice
-    my $conf = new FS::Conf;
     my $money_char = $conf->config('money_char') || '$';
     $months = sprintf('%.2f', $months) if $months =~ /\./;
 
@@ -135,7 +173,46 @@ sub calc_discount {
     $tot_discount += $amount;
   }
 
+  if (!@cust_pkg_discount and $conf->exists('discount-show_available') ) {
+    push @$details, $self->available_discounts;
+  }
+
   sprintf('%.2f', $tot_discount);
 }
 
+=item available_discounts
+
+Returns a list of details decribing the available prepayment discounts 
+for this package.
+
+=cut
+
+sub available_discounts {
+  my $self = shift;
+  return if $self->freq ne '1';
+  my @details;
+  my $money_char = FS::Conf->new->config('money_char') || '$';
+  my @discounts = map { $_->discount } $self->part_pkg_discount;
+  # probably the most logical way to arrange these
+  foreach my $discount (sort { $a->months <=> $b->months } @discounts) {
+    my $months = $discount->months;
+    my $amount;
+    if ( $discount->amount > 0 ) {
+      $amount = $money_char . sprintf('%.2f', $discount->amount);
+    }
+    elsif ( $discount->percent ) {
+      $amount = $discount->percent .'%';
+    }
+    else { #?
+      next;
+    }
+    push @details, "Prepay $months months for $amount discount."
+      # better way to display this?
+      # if it's a problem, we'll add discount.invoice_text or something
+      # for the customer-visible text line.
+    }
+  return @details;
+}
+
+
 1;