fix prorates & recurring fees with recur_Common-using packages, RT#11993

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

diff --git a/FS/FS/part_pkg/flat.pm b/FS/FS/part_pkg/flat.pm
index f9d1b4e..89de551 100644 (file)
--- a/FS/FS/part_pkg/flat.pm
+++ b/FS/FS/part_pkg/flat.pm
@@ -1,19 +1,16 @@
 package FS::part_pkg::flat;
 
 use strict;
-use vars qw( @ISA %info
-             %usage_recharge_fields @usage_recharge_fieldorder
+use base qw( FS::part_pkg 
+             FS::part_pkg::prorate_Mixin
+             FS::part_pkg::discount_Mixin
            );
+use vars qw( %info %usage_recharge_fields @usage_recharge_fieldorder );
 use Tie::IxHash;
 use List::Util qw(min); # max);
 #use FS::Record qw(qsearch);
 use FS::UI::bytecount;
 use FS::Conf;
-use FS::part_pkg;
-
-@ISA = qw(FS::part_pkg 
-          FS::part_pkg::prorate_Mixin
-          FS::part_pkg::discount_Mixin);
 
 tie my %temporalities, 'Tie::IxHash',
   'upcoming'  => "Upcoming (future)",
@@ -54,6 +51,11 @@ tie my %contract_years, 'Tie::IxHash', (
                                     'with the customer\'s other packages',
                           'type' => 'checkbox',
                         },
+    'prorate_defer_bill' => { 
+                          'name' => 'When synchronizing, defer the bill until '.
+                                    'the customer\'s next bill date',
+                          'type' => 'checkbox',
+                        },
     'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
                         'type' => 'checkbox',
                       },
@@ -70,16 +72,31 @@ tie my %contract_years, 'Tie::IxHash', (
   'fieldorder' => [ qw( recur_temporality 
                         expire_months adjourn_months
                         contract_end_months
-                        start_1st sync_bill_date
+                        start_1st sync_bill_date prorate_defer_bill
                         suspend_bill unsuspend_adjust_bill
                         externalid ),
                   ],
   'weight' => 10,
 );
 
+sub price_info {
+    my $self = shift;
+    my $conf = new FS::Conf;
+    my $money_char = $conf->config('money_char') || '$';
+    my $setup = $self->option('setup_fee') || 0;
+    my $recur = $self->option('recur_fee', 1) || 0;
+    my $str = '';
+    $str = $money_char . $setup . ' one-time' if $setup;
+    $str .= ', ' if ($setup && $recur);
+    $str .= $money_char . $recur . ' recurring ' if $recur;
+    $str;
+}
+
 sub calc_setup {
   my($self, $cust_pkg, $sdate, $details ) = @_;
 
+  return 0 if $self->prorate_setup($cust_pkg, $sdate);
+
   my $i = 0;
   my $count = $self->option( 'additional_count', 'quiet' ) || 0;
   while ($i < $count) {
@@ -88,7 +105,8 @@ sub calc_setup {
 
   my $quantity = $cust_pkg->quantity || 1;
 
-  sprintf("%.2f", $quantity * $self->unit_setup($cust_pkg, $sdate, $details) );
+  my $charge = $quantity * $self->unit_setup($cust_pkg, $sdate, $details);
+  sprintf('%.2f', $charge);
 }
 
 sub unit_setup {
@@ -108,12 +126,8 @@ sub calc_recur {
     if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0;
 
   my $charge = $self->base_recur($cust_pkg, $sdate);
-  if ( $self->option('sync_bill_date',1) ) {
-    my $next_bill = $cust_pkg->cust_main->next_bill_date;
-    if ( defined($next_bill) ) {
-      my $cutoff_day = (localtime($next_bill))[3];
-      $charge = $self->calc_prorate(@_, $cutoff_day);
-    }
+  if ( my $cutoff_day = $self->cutoff_day($cust_pkg) ) {
+    $charge = $self->calc_prorate(@_, $cutoff_day);
   }
   elsif ( $param->{freq_override} ) {
     # XXX not sure if this should be mutually exclusive with sync_bill_date.
@@ -126,6 +140,18 @@ sub calc_recur {
   return sprintf('%.2f', $charge - $discount);
 }
 
+sub cutoff_day {
+  my $self = shift;
+  my $cust_pkg = shift;
+  if ( $self->option('sync_bill_date',1) ) {
+    my $next_bill = $cust_pkg->cust_main->next_bill_date;
+    if ( defined($next_bill) ) {
+      return (localtime($next_bill))[3];
+    }
+  }
+  return 0;
+}
+
 sub base_recur {
   my($self, $cust_pkg, $sdate) = @_;
   $self->option('recur_fee', 1) || 0;
@@ -167,7 +193,7 @@ sub calc_remain {
   my $freq_sec = $1 * $sec{$2||'m'};
   return 0 unless $freq_sec;
 
-  sprintf("%.2f", $self->base_recur($cust_pkg) * ( $next_bill - $time ) / $freq_sec );
+  sprintf("%.2f", $self->base_recur($cust_pkg, \$time) * ( $next_bill - $time ) / $freq_sec );
 
 }