X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg%2Fprorate_Mixin.pm;h=153ed56cd7bf9205efb04923a304310f21c2c96f;hb=1b523e698fce6720d6b9389ef636e7fe9e8b9f98;hp=75dbe5cf8fa9db6e08e8018bbe3ba70cbf8d5638;hpb=90dfd05877a331fb13ba50389e3d8a3105465bc7;p=freeside.git

diff --git a/FS/FS/part_pkg/prorate_Mixin.pm b/FS/FS/part_pkg/prorate_Mixin.pm
index 75dbe5cf8..153ed56cd 100644
--- a/FS/FS/part_pkg/prorate_Mixin.pm
+++ b/FS/FS/part_pkg/prorate_Mixin.pm
@@ -1,10 +1,11 @@
 package FS::part_pkg::prorate_Mixin;
 
 use strict;
-use vars qw(@ISA %info);
-use Time::Local qw(timelocal);
+use vars qw( %info );
+use Time::Local qw( timelocal timelocal_nocheck );
+use Date::Format qw( time2str );
+use List::Util qw( min );
 
-@ISA = qw(FS::part_pkg);
 %info = ( 
   'disabled'  => 1,
   # define all fields that are referenced in this code
@@ -23,8 +24,13 @@ use Time::Local qw(timelocal);
                           'billing day',
                 'type' => 'checkbox',
     },
+    'prorate_verbose' => {
+                'name' => 'Show prorate details on the invoice',
+                'type' => 'checkbox',
+    },
   },
-  'fieldorder' => [ qw(prorate_defer_bill prorate_round_day add_full_period) ],
+  'fieldorder' => [ qw(prorate_defer_bill prorate_round_day 
+                       add_full_period prorate_verbose) ],
 );
 
 sub fieldorder {
@@ -66,50 +72,92 @@ billing period after that.
 instead of using the exact time.
 - prorate_defer_bill: Don't bill the prorate interval until the prorate 
 day arrives.
+- prorate_verbose: Generate details to explain the prorate calculations.
 
 =cut
 
 sub calc_prorate {
-  my ($self, $cust_pkg, $sdate, $details, $param, $cutoff_day) = @_;
-  die "no cutoff_day" unless $cutoff_day;
+  my ($self, $cust_pkg, $sdate, $details, $param, @cutoff_days) = @_;
+  die "no cutoff_day" unless @cutoff_days;
   die "can't prorate non-monthly package\n" if $self->freq =~ /\D/;
 
+  my $money_char = FS::Conf->new->config('money_char') || '$';
+
   my $charge = $self->base_recur($cust_pkg, $sdate) || 0;
 
-    my $mnow = $$sdate;
-
-    # if this is the first bill but the bill date has been set
-    # (by prorate_defer_bill), calculate from the setup date,
-    # and append the setup fee to @$details.
-    if ( $self->option('prorate_defer_bill',1)
-        and ! $cust_pkg->getfield('last_bill') 
-        and $cust_pkg->setup ) {
-      #warn "[calc_prorate] #".$cust_pkg->pkgnum.": running deferred setup\n";
-      $param->{'setup_fee'} = $self->calc_setup($cust_pkg, $$sdate, $details);
-      $mnow = $cust_pkg->setup;
+  my $add_period = $self->option('add_full_period',1);
+
+  my $mnow = $$sdate;
+
+  # if this is the first bill but the bill date has been set
+  # (by prorate_defer_bill), calculate from the setup date,
+  # append the setup fee to @$details, and make sure to bill for 
+  # a full period after the bill date.
+  if ( $self->option('prorate_defer_bill',1)
+         && ! $cust_pkg->getfield('last_bill') 
+         && $cust_pkg->setup
+     )
+  {
+    #warn "[calc_prorate] #".$cust_pkg->pkgnum.": running deferred setup\n";
+    $param->{'setup_fee'} = $self->calc_setup($cust_pkg, $$sdate, $details);
+    $mnow = $cust_pkg->setup;
+    $add_period = 1;
+  }
+
+  # if the customer alreqady has a billing day-of-month established,
+  # and it's a valid cutoff day, try to respect it
+  my $next_bill_day;
+  if ( my $next_bill = $cust_pkg->cust_main->next_bill_date ) {
+    $next_bill_day = (localtime($next_bill))[3];
+    if ( grep {$_ == $next_bill_day} @cutoff_days ) {
+      # by removing all other cutoff days from the list
+      @cutoff_days = ($next_bill_day);
     }
+  }
+
+  my ($mend, $mstart);
+  ($mnow, $mend, $mstart) = $self->_endpoints($mnow, @cutoff_days);
 
-    my ($mend, $mstart);
-    ($mnow, $mend, $mstart) = $self->_endpoints($mnow, $cutoff_day);
+  # next bill date will be figured as $$sdate + one period
+  $$sdate = $mstart;
 
-    # next bill date will be figured as $$sdate + one period
-    $$sdate = $mstart;
+  my $permonth = $charge / $self->freq;
+  my $months = ( ( $self->freq - 1 ) + ($mend-$mnow) / ($mend-$mstart) );
 
-    my $permonth = $charge / $self->freq;
-    my $months = ( ( $self->freq - 1 ) + ($mend-$mnow) / ($mend-$mstart) );
+  if ( $self->option('prorate_verbose',1) 
+      and $months > 0 and $months < $self->freq ) {
+    push @$details, 
+          'Prorated (' . time2str('%b %d', $mnow) .
+            ' - ' . time2str('%b %d', $mend) . '): ' . $money_char . 
+            sprintf('%.2f', $permonth * $months + 0.00000001 );
+  }
 
-    # add a full period if currently billing for a partial period
-    if ( ( $self->option('add_full_period',1) 
-        or $self->option('prorate_defer_bill',1) ) # necessary
-        and $months < $self->freq ) {
-      $months += $self->freq;
-      $$sdate = $self->add_freq($mstart);
+  # add a full period if currently billing for a partial period
+  # or periods up to freq_override if billing for an override interval
+  if ( ($param->{'freq_override'} || 0) > 1 ) {
+    $months += $param->{'freq_override'} - 1;
+  } 
+  elsif ( $add_period && $months < $self->freq) {
+
+    if ( $self->option('prorate_verbose',1) ) {
+      # calculate the prorated and add'l period charges
+      push @$details,
+        'First full month: ' . $money_char . 
+          sprintf('%.2f', $permonth);
     }
 
-    $param->{'months'} = $months;
-    $charge = sprintf('%.2f', $permonth * $months);
+    $months += $self->freq;
+    $$sdate = $self->add_freq($mstart);
+  }
+
+  $param->{'months'} = $months;
+                                                  #so 1.005 rounds to 1.01
+  $charge = sprintf('%.2f', $permonth * $months + 0.00000001 );
+
+  my $quantity = $cust_pkg->quantity || 1;
+  $charge *= $quantity;
 
-  return $charge;
+  return sprintf('%.2f', $charge);
 }
 
 =item prorate_setup CUST_PKG SDATE
@@ -122,16 +170,18 @@ set, in which case it postpones the next bill to the cutoff day.
 sub prorate_setup {
   my $self = shift;
   my ($cust_pkg, $sdate) = @_;
-  my $cutoff_day = $self->cutoff_day($cust_pkg);
+  my @cutoff_days = $self->cutoff_day($cust_pkg);
   if ( ! $cust_pkg->bill
       and $self->option('prorate_defer_bill',1)
-      and $cutoff_day
+      and @cutoff_days
   ) {
-    my ($mnow, $mend, $mstart) = $self->_endpoints($sdate, $cutoff_day);
-    # if today is the cutoff day, set the next bill to right now instead 
-    # of waiting a month.
+    my ($mnow, $mend, $mstart) = $self->_endpoints($sdate, @cutoff_days);
+    # If today is the cutoff day, set the next bill and setup both to 
+    # midnight today, so that the customer will be billed normally for a 
+    # month starting today.
     if ( $mnow - $mstart < 86400 ) {
-      $cust_pkg->bill($mnow);
+      $cust_pkg->setup($mstart);
+      $cust_pkg->bill($mstart);
     }
     else {
       $cust_pkg->bill($mend);
@@ -151,7 +201,9 @@ before the end of the prorate interval.
 =cut
 
 sub _endpoints {
-  my ($self, $mnow, $cutoff_day) = @_;
+  my $self = shift;
+  my $mnow = shift;
+  my @cutoff_days = sort {$a <=> $b} @_;
 
   # only works for freq >= 1 month; probably can't be fixed
   my ($sec, $min, $hour, $mday, $mon, $year) = (localtime($mnow))[0..5];
@@ -167,28 +219,25 @@ sub _endpoints {
   }
   my $mend;
   my $mstart;
-  # if cutoff day > 28, force it to the 1st of next month
-  if ( $cutoff_day > 28 ) {
-    $cutoff_day = 1;
-    # and if we are currently after the 28th, roll the current day 
-    # forward to that day
-    if ( $mday > 28 ) {
-      $mday = 1;
-      #set $mnow = $mend so the amount billed will be zero
-      $mnow = timelocal(0,0,0,1,$mon == 11 ? 0 : $mon + 1,$year+($mon==11));
-    }
-  }
+  # select the first cutoff day that's on or after the current day
+  my $cutoff_day = min( grep { $_ >= $mday } @cutoff_days );
+  # if today is after the last cutoff, choose the first one
+  $cutoff_day ||= $cutoff_days[0];
+
+  # then, if today is on or after the selected day, set period to
+  # (cutoff day this month) - (cutoff day next month)
   if ( $mday >= $cutoff_day ) {
     $mend = 
-      timelocal(0,0,0,$cutoff_day,$mon == 11 ? 0 : $mon + 1,$year+($mon==11));
+      timelocal_nocheck(0,0,0,$cutoff_day,$mon == 11 ? 0 : $mon + 1,$year+($mon==11));
     $mstart =
-      timelocal(0,0,0,$cutoff_day,$mon,$year);
+      timelocal_nocheck(0,0,0,$cutoff_day,$mon,$year);
   }
+  # otherwise, set period to (cutoff day last month) - (cutoff day this month)
   else {
     $mend = 
-      timelocal(0,0,0,$cutoff_day,$mon,$year);
+      timelocal_nocheck(0,0,0,$cutoff_day,$mon,$year);
     $mstart = 
-      timelocal(0,0,0,$cutoff_day,$mon == 0 ? 11 : $mon - 1,$year-($mon==0));
+      timelocal_nocheck(0,0,0,$cutoff_day,$mon == 0 ? 11 : $mon - 1,$year-($mon==0));
   }
   return ($mnow, $mend, $mstart);
 }