RT# 77964 - Placed waive setup fee check back to billing.pm, and added check for...
[freeside.git] / FS / FS / part_pkg / flat.pm
index 930966a..cfee584 100644 (file)
@@ -5,13 +5,23 @@ use base qw( FS::part_pkg::prorate_Mixin
            );
 
 use strict;
-use vars qw( %info %usage_recharge_fields @usage_recharge_fieldorder );
+use vars qw( $conf $money_char %info
+             %usage_recharge_fields @usage_recharge_fieldorder
+           );
+use FS::UID;
 use FS::Record qw( qsearch );
 use FS::cust_credit_source_bill_pkg;
 use Tie::IxHash;
 use List::Util qw( min );
 use FS::UI::bytecount;
 use FS::Conf;
+use Time::Local 'timelocal';
+
+#ask FS::UID to run this stuff for us later
+FS::UID->install_callback( sub {
+  $conf = new FS::Conf;
+  $money_char = $conf->config('money_char') || '$';
+});
 
 tie my %temporalities, 'Tie::IxHash',
   'upcoming'  => "Upcoming (future)",
@@ -34,16 +44,6 @@ tie my %contract_years, 'Tie::IxHash', (
                              'select_options' => \%temporalities,
                            },
 
-    #used in cust_pkg.pm so could add to any price plan
-    'expire_months' => { 'name' => 'Auto-add an expiration date this number of months out',
-                       },
-    'adjourn_months'=> { 'name' => 'Auto-add a suspension date this number of months out',
-                       },
-    'contract_end_months'=> { 
-                        'name' => 'Auto-add a contract end date this number of years out',
-                        'type' => 'select',
-                        'select_options' => \%contract_years,
-                      },
     #used in cust_pkg.pm so could add to any price plan where it made sense
     'start_1st'     => { 'name' => 'Auto-add a start date to the 1st, ignoring the current month.',
                          'type' => 'checkbox',
@@ -59,8 +59,9 @@ tie my %contract_years, 'Tie::IxHash', (
                         },
     'prorate_round_day' => {
                           'name' => 'When synchronizing, round the prorated '.
-                                    'period to the nearest full day',
-                          'type' => 'checkbox',
+                                    'period',
+                          'type' => 'select',
+                          'select_options' => \%FS::part_pkg::prorate_Mixin::prorate_round_day_opts,
                         },
     'add_full_period' => { 'disabled' => 1 }, # doesn't make sense with sync?
 
@@ -85,8 +86,6 @@ tie my %contract_years, 'Tie::IxHash', (
                     },
   },
   'fieldorder' => [ qw( recur_temporality 
-                        expire_months adjourn_months
-                        contract_end_months
                         start_1st
                         sync_bill_date prorate_defer_bill prorate_round_day
                         suspend_bill unsuspend_adjust_bill
@@ -98,20 +97,20 @@ tie my %contract_years, 'Tie::IxHash', (
 );
 
 sub price_info {
-    my $self = shift;
-    my %opt = @_;
-    my $conf = new FS::Conf;
-    my $money_char = $conf->config('money_char') || '$';
-    my $setup = $opt{cust_pkg} ? $self->base_setup( $opt{cust_pkg} )
-                               : ($self->option('setup_fee') || 0);
-    my $recur = $opt{cust_pkg} ? $self->base_recur( $opt{cust_pkg} )
-                               : ($self->option('recur_fee', 1) || 0);
-    $recur += $self->usageprice_recur( $opt{cust_pkg} ) if $opt{cust_pkg};
-    my $str = '';
-    $str = $money_char . $setup . ($recur ? ' setup' : ' one-time') if $setup;
-    $str .= ', ' if ($setup && $recur);
-    $str .= $money_char. $recur. '/'. $self->freq_pretty if $recur;
-    $str;
+  my $self = shift;
+  my %opt = @_;
+
+  my $setup = $opt{cust_pkg} ? $self->base_setup( $opt{cust_pkg} )
+                             : ($self->option('setup_fee') || 0);
+  my $recur = $opt{cust_pkg} ? $self->base_recur( $opt{cust_pkg} )
+                             : ($self->option('recur_fee', 1) || 0);
+  $recur += $self->usageprice_recur( $opt{cust_pkg} ) if $opt{cust_pkg};
+
+  my $str = '';
+  $str = $money_char . $setup . ($recur ? ' setup' : ' one-time') if $setup;
+  $str .= ', ' if ($setup && $recur);
+  $str .= $money_char. $recur. '/'. $self->freq_pretty if $recur;
+  $str;
 }
 
 sub calc_setup {
@@ -129,18 +128,18 @@ sub calc_setup {
 
   my $discount = 0;
   if ( $charge > 0 ) {
-      $param->{'setup_charge'} = $charge;
-      $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
-      delete $param->{'setup_charge'};
+    $param->{'setup_charge'} = $charge;
+    $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
+    delete $param->{'setup_charge'};
   }
 
   sprintf( '%.2f', ($cust_pkg->quantity || 1) * ($charge - $discount) );
+
 }
 
 sub base_setup {
   my($self, $cust_pkg, $sdate, $details ) = @_;
-
-  $self->option('setup_fee') || 0;
+  $self->option('setup_fee', 1) || 0;
 }
 
 sub calc_recur {
@@ -176,16 +175,36 @@ sub calc_recur {
 sub cutoff_day {
   my $self = shift;
   my $cust_pkg = shift;
+  my $cust_main = $cust_pkg->cust_main;
+  # force it to act like a prorate package, is what this means
+  # because we made a distinction once between prorate and flat packages
+  if ( $cust_main->force_prorate_day  and $cust_main->prorate_day ) {
+     return ( $cust_main->prorate_day );
+  }
   if ( $self->option('sync_bill_date',1) ) {
     my $next_bill = $cust_pkg->cust_main->next_bill_date;
-    if ( defined($next_bill) ) {
-      # careful here. if the prorate calculation is going to round to 
-      # the nearest day, this needs to always return the same result
-      if ( $self->option('prorate_round_day', 1) ) {
-        my $hour = (localtime($next_bill))[2];
-        $next_bill += 64800 if $hour >= 12;
-      }
+    if ( $next_bill ) {
       return (localtime($next_bill))[3];
+    } else {
+      # This is the customer's only active package and hasn't been billed
+      # yet, so set the cutoff day to either today or tomorrow, whichever
+      # would result in a full period after rounding.
+      my $setup = $cust_pkg->setup; # because it's "now"
+      my $rounding_mode = $self->option('prorate_round_day',1);
+      return () if !$setup or !$rounding_mode;
+      my ($sec, $min, $hour, $mday, $mon, $year) = localtime($setup);
+
+      if (   ( $rounding_mode == 1 and $hour >= 12 )
+          or ( $rounding_mode == 3 and ( $sec > 0 or $min > 0 or $hour > 0 ))
+      ) {
+        # then the prorate period will be rounded down to start from
+        # midnight tomorrow, so the cutoff day should be the current day +
+        # 1.
+        $setup = timelocal(59,59,23,$mday,$mon,$year) + 1;
+        $mday = (localtime($setup))[3];
+      }
+      # otherwise, it will be rounded up, so leave the cutoff day at today.
+      return $mday;
     }
   }
   return ();
@@ -215,20 +234,21 @@ sub usageprice_recur {
 
 sub calc_cancel {
   my $self = shift;
-  my $conf = new FS::Conf;
   if ( $self->recur_temporality eq 'preceding'
        and $self->option('bill_recur_on_cancel', 1) ) {
     # run another recurring cycle
     return $self->calc_recur(@_);
-  }
-  elsif ( $conf->exists('bill_usage_on_cancel') # should be a package option?
+  } elsif ( $conf->exists('bill_usage_on_cancel') # should be a package option?
           and $self->can('calc_usage') ) {
     # bill for outstanding usage
     return $self->calc_usage(@_);
+  } else {
+    return 'NOTHING'; # numerically zero, but has special meaning
   }
-  0;
 }
 
+# no longer used; see credit_remaining in FS::cust_pkg
+
 sub calc_remain {
   my ($self, $cust_pkg, %options) = @_;
 
@@ -252,7 +272,6 @@ sub calc_remain {
   foreach my $cust_bill_pkg ( 
     qsearch('cust_bill_pkg', { 
       pkgnum => $cust_pkg->pkgnum,
-      sdate => {op => '<' , value => $time},
       edate => {op => '>=', value => $time},
       recur => {op => '>' , value => 0},
     })
@@ -264,8 +283,17 @@ sub calc_remain {
       $edate = $self->add_freq($cust_bill_pkg->sdate);
     }
 
-    my $amount = ($cust_bill_pkg->recur - $cust_bill_pkg->usage) * 
-                 ($edate - $time) / ($edate - $cust_bill_pkg->sdate);
+    # this will also get any package charges that are _entirely_ after the
+    # cancellation date (can happen with advance billing). in that case,
+    # use the entire recurring charge:
+    my $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
+
+    # but if the cancellation happens during the interval, prorate it:
+    # (XXX obey prorate_round_day here?)
+    if ( $cust_bill_pkg->sdate < $time ) {
+      $amount = $amount * ($edate - $time) / ($edate - $cust_bill_pkg->sdate);
+    }
+
     $credit += $amount;
 
     push @{ $options{'cust_credit_source_bill_pkg'} },