X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg%2Fflat.pm;h=97d4363da910c5b16bf81943db2946ea98c166c9;hp=e69c10ccaccea562793437dce46aa63a1108eb71;hb=44dcd4a1ff335a85a6babf0e007be57e6ec4f525;hpb=314763d9596378c8250718e3414d7ae61273155a

diff --git a/FS/FS/part_pkg/flat.pm b/FS/FS/part_pkg/flat.pm
index e69c10cca..97d4363da 100644
--- a/FS/FS/part_pkg/flat.pm
+++ b/FS/FS/part_pkg/flat.pm
@@ -1,19 +1,26 @@
 package FS::part_pkg::flat;
+use base qw( FS::part_pkg::prorate_Mixin
+             FS::part_pkg::discount_Mixin
+             FS::part_pkg
+           );
 
 use strict;
-use vars qw( @ISA %info
-             %usage_fields %usage_recharge_fields
-             @usage_fieldorder @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); # max);
-#use FS::Record qw(qsearch);
+use List::Util qw( min );
 use FS::UI::bytecount;
 use FS::Conf;
-use FS::part_pkg;
-use FS::cust_bill_pkg_discount;
 
-@ISA = qw(FS::part_pkg FS::part_pkg::prorate_Mixin);
+#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)",
@@ -25,108 +32,17 @@ tie my %contract_years, 'Tie::IxHash', (
   map { $_*12 => $_ } (1..5),
 );
 
-%usage_fields = (
-
-    'seconds'       => { 'name' => 'Time limit for this package',
-                         'default' => '',
-                         'check' => sub { shift =~ /^\d*$/ },
-                       },
-    'upbytes'       => { 'name' => 'Upload limit for this package',
-                         'default' => '',
-                         'check' => sub { shift =~ /^\d*$/ },
-                         'format' => \&FS::UI::bytecount::display_bytecount,
-                         'parse' => \&FS::UI::bytecount::parse_bytecount,
-                       },
-    'downbytes'     => { 'name' => 'Download limit for this package',
-                         'default' => '',
-                         'check' => sub { shift =~ /^\d*$/ },
-                         'format' => \&FS::UI::bytecount::display_bytecount,
-                         'parse' => \&FS::UI::bytecount::parse_bytecount,
-                       },
-    'totalbytes'    => { 'name' => 'Transfer limit for this package',
-                         'default' => '',
-                         'check' => sub { shift =~ /^\d*$/ },
-                         'format' => \&FS::UI::bytecount::display_bytecount,
-                         'parse' => \&FS::UI::bytecount::parse_bytecount,
-                       },
-);
-
-%usage_recharge_fields = (
-
-    'recharge_amount'       => { 'name' => 'Cost of recharge for this package',
-                         'default' => '',
-                         'check' => sub { shift =~ /^\d*(\.\d{2})?$/ },
-                       },
-    'recharge_seconds'      => { 'name' => 'Recharge time for this package',
-                         'default' => '',
-                         'check' => sub { shift =~ /^\d*$/ },
-                       },
-    'recharge_upbytes'      => { 'name' => 'Recharge upload for this package',
-                         'default' => '',
-                         'check' => sub { shift =~ /^\d*$/ },
-                         'format' => \&FS::UI::bytecount::display_bytecount,
-                         'parse' => \&FS::UI::bytecount::parse_bytecount,
-                       },
-    'recharge_downbytes'    => { 'name' => 'Recharge download for this package',
-                         'default' => '',
-                         'check' => sub { shift =~ /^\d*$/ },
-                         'format' => \&FS::UI::bytecount::display_bytecount,
-                         'parse' => \&FS::UI::bytecount::parse_bytecount,
-                       },
-    'recharge_totalbytes'   => { 'name' => 'Recharge transfer for this package',
-                         'default' => '',
-                         'check' => sub { shift =~ /^\d*$/ },
-                         'format' => \&FS::UI::bytecount::display_bytecount,
-                         'parse' => \&FS::UI::bytecount::parse_bytecount,
-                       },
-    'usage_rollover' => { 'name' => 'Allow usage from previous period to roll '.
-                                    ' over into current period',
-                          'type' => 'checkbox',
-                        },
-    'recharge_reset' => { 'name' => 'Reset usage to these values on manual '.
-                                    'package recharge',
-                          'type' => 'checkbox',
-                        },
-);
-
-@usage_fieldorder = qw( seconds upbytes downbytes totalbytes );
-@usage_recharge_fieldorder = qw(
-  recharge_amount recharge_seconds recharge_upbytes
-  recharge_downbytes recharge_totalbytes
-  usage_rollover recharge_reset
-);
-
 %info = (
   'name' => 'Flat rate (anniversary billing)',
   'shortname' => 'Anniversary',
+  'inherit_fields' => [ 'prorate_Mixin', 'usage_Mixin', 'global_Mixin' ],
   'fields' => {
-    'setup_fee'     => { 'name' => 'Setup fee for this package',
-                         'default' => 0,
-                       },
-    'recur_fee'     => { 'name' => 'Recurring fee for this package',
-                         'default' => 0,
-                       },
-
     #false laziness w/voip_cdr.pm
     'recur_temporality' => { 'name' => 'Charge recurring fee for period',
                              'type' => 'select',
                              'select_options' => \%temporalities,
                            },
-    'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
-                                   ' of service at cancellation',
-                         'type' => 'checkbox',
-                       },
 
-    #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',
@@ -135,6 +51,19 @@ 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',
+                        },
+    'prorate_round_day' => {
+                          'name' => 'When synchronizing, round the prorated '.
+                                    '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?
+
     'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
                         'type' => 'checkbox',
                       },
@@ -143,29 +72,50 @@ tie my %contract_years, 'Tie::IxHash', (
                                     'unsuspending',
                           'type' => 'checkbox',
                         },
-
-    %usage_fields,
-    %usage_recharge_fields,
-
+    'bill_recur_on_cancel' => {
+                        'name' => 'Bill the last period on cancellation',
+                        'type' => 'checkbox',
+                        },
+    'bill_suspend_as_cancel' => {
+                        'name' => 'Bill immediately upon suspension', #desc?
+                        'type' => 'checkbox',
+                        },
     'externalid' => { 'name'   => 'Optional External ID',
                       'default' => '',
                     },
   },
-  'fieldorder' => [ qw( setup_fee recur_fee
-                        recur_temporality unused_credit
-                        expire_months adjourn_months
-                        contract_end_months
-                        start_1st sync_bill_date
+  'fieldorder' => [ qw( recur_temporality 
+                        start_1st
+                        sync_bill_date prorate_defer_bill prorate_round_day
                         suspend_bill unsuspend_adjust_bill
-                      ),
-                    @usage_fieldorder, @usage_recharge_fieldorder,
-                    qw( externalid ),
+                        bill_recur_on_cancel
+                        bill_suspend_as_cancel
+                        externalid ),
                   ],
   'weight' => 10,
 );
 
+sub price_info {
+  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 {
-  my($self, $cust_pkg, $sdate, $details ) = @_;
+  my($self, $cust_pkg, $sdate, $details, $param ) = @_;
+
+  return 0 if $self->prorate_setup($cust_pkg, $sdate);
 
   my $i = 0;
   my $count = $self->option( 'additional_count', 'quiet' ) || 0;
@@ -173,15 +123,21 @@ sub calc_setup {
     push @$details, $self->option( 'additional_info' . $i++ );
   }
 
-  my $quantity = $cust_pkg->quantity || 1;
+  my $charge = $self->base_setup($cust_pkg, $sdate, $details);
+
+  my $discount = 0;
+  if ( $charge > 0 ) {
+      $param->{'setup_charge'} = $charge;
+      $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
+      delete $param->{'setup_charge'};
+  }
 
-  sprintf("%.2f", $quantity * $self->unit_setup($cust_pkg, $sdate, $details) );
+  sprintf( '%.2f', ($cust_pkg->quantity || 1) * ($charge - $discount) );
 }
 
-sub unit_setup {
+sub base_setup {
   my($self, $cust_pkg, $sdate, $details ) = @_;
-
-  $self->option('setup_fee') || 0;
+  $self->option('setup_fee', 1) || 0;
 }
 
 sub calc_recur {
@@ -192,106 +148,48 @@ sub calc_recur {
   my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
 
   return 0
-    if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0;
+    if $self->recur_temporality eq 'preceding' && !$last_bill;
 
-  if( $self->option('sync_bill_date',1) ) {
-    return $self->calc_prorate(@_);
+  my $charge = $self->base_recur($cust_pkg, $sdate);
+  # always treat cutoff_day as a list
+  if ( my @cutoff_day = $self->cutoff_day($cust_pkg) ) {
+    $charge = $self->calc_prorate(@_, @cutoff_day);
   }
-  else {
-    my $charge = $self->base_recur($cust_pkg);
+  elsif ( $param->{freq_override} ) {
+    # XXX not sure if this should be mutually exclusive with sync_bill_date.
+    # Given the very specific problem that freq_override is meant to 'solve',
+    # it probably should.
     $charge *= $param->{freq_override} if $param->{freq_override};
-    my $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
-
-    return sprintf('%.2f', $charge - $discount);
   }
-}
 
-sub calc_discount {
-  my($self, $cust_pkg, $sdate, $details, $param ) = @_;
+  $charge += $self->usageprice_recur($cust_pkg, $sdate);
+  $cust_pkg->apply_usageprice(); #$sdate for prorating?
+
+  my $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
 
-  my $br = $self->base_recur($cust_pkg);
-
-  my $tot_discount = 0;
-  #UI enforces just 1 for now, will need ordering when they can be stacked
-
-  if ( $param->{freq_override} ) {
-    my $real_part_pkg = new FS::part_pkg { $self->hash };
-    $real_part_pkg->pkgpart($param->{real_pkgpart} || $self->pkgpart);
-    my @discount = grep { $_->months == $param->{freq_override} }
-                   map { $_->discount }
-                   $real_part_pkg->part_pkg_discount;
-    my $discount = shift @discount;
-    $param->{months} = $param->{freq_override} unless $param->{months};
-    my $error;
-    if ($discount) {
-      if ($discount->months == $param->{months}) {
-        $cust_pkg->discountnum($discount->discountnum);
-        $error = $cust_pkg->insert_discount;
-      } else {
-        $cust_pkg->discountnum(-1);
-        foreach ( qw( amount percent months ) ) {
-          my $method = "discountnum_$_";
-          $cust_pkg->$method($discount->$_);
-        }
-        $error = $cust_pkg->insert_discount;
+  sprintf( '%.2f', ($cust_pkg->quantity || 1) * ($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 ( $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;
       }
-      die "error discounting using part_pkg_discount: $error" if $error;
+      return (localtime($next_bill))[3];
     }
   }
-
-  my @cust_pkg_discount = $cust_pkg->cust_pkg_discount_active;
-  foreach my $cust_pkg_discount ( @cust_pkg_discount ) {
-     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};
-     $amount += sprintf('%.2f', $discount->percent * $br / 100 );
-
-     my $chg_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;
-
-     $amount *= $months;
-     $amount = sprintf('%.2f', $amount);
-
-     next unless $amount > 0;
-
-     #record details in cust_bill_pkg_discount
-     my $cust_bill_pkg_discount = new FS::cust_bill_pkg_discount {
-       'pkgdiscountnum' => $cust_pkg_discount->pkgdiscountnum,
-       'amount'         => $amount,
-       'months'         => $months,
-     };
-     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 =~ /\./;
-
-     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;
-
-     $tot_discount += $amount;
-  }
-
-  sprintf('%.2f', $tot_discount);
+  return ();
 }
 
 sub base_recur {
-  my($self, $cust_pkg) = @_;
+  my($self, $cust_pkg, $sdate) = @_;
   $self->option('recur_fee', 1) || 0;
 }
 
@@ -303,6 +201,32 @@ sub base_recur_permonth {
   sprintf('%.2f', $self->base_recur($cust_pkg) / $self->freq );
 }
 
+sub usageprice_recur {
+  my($self, $cust_pkg, $sdate) = @_;
+
+  my $recur = 0;
+  $recur += $_->price foreach $cust_pkg->cust_pkg_usageprice;
+
+  sprintf('%.2f', $recur);
+}
+
+sub calc_cancel {
+  my $self = shift;
+  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?
+          and $self->can('calc_usage') ) {
+    # bill for outstanding usage
+    return $self->calc_usage(@_);
+  } else {
+    return 'NOTHING'; # numerically zero, but has special meaning
+  }
+}
+
+# no longer used; see credit_remaining in FS::cust_pkg
+
 sub calc_remain {
   my ($self, $cust_pkg, %options) = @_;
 
@@ -315,28 +239,52 @@ sub calc_remain {
 
   my $next_bill = $cust_pkg->getfield('bill') || 0;
 
-  #my $last_bill = $cust_pkg->last_bill || 0;
-  my $last_bill = $cust_pkg->get('last_bill') || 0; #->last_bill falls back to setup
-
-  return 0 if    ! $self->base_recur($cust_pkg)
-              || ! $self->option('unused_credit', 1)
-              || ! $last_bill
+  return 0 if    ! $self->base_recur($cust_pkg, \$time)
               || ! $next_bill
               || $next_bill < $time;
 
-  my %sec = (
-    'h' =>    3600, # 60 * 60
-    'd' =>   86400, # 60 * 60 * 24
-    'w' =>  604800, # 60 * 60 * 24 * 7
-    'm' => 2629744, # 60 * 60 * 24 * 365.2422 / 12 
-  );
+  # Use actual charge for this period, not base_recur (for discounts).
+  # Use sdate < $time and edate >= $time because when billing on 
+  # cancellation, edate = $time.
+  my $credit = 0;
+  foreach my $cust_bill_pkg ( 
+    qsearch('cust_bill_pkg', { 
+      pkgnum => $cust_pkg->pkgnum,
+      edate => {op => '>=', value => $time},
+      recur => {op => '>' , value => 0},
+    })
+  ) {
+
+    # hack to deal with the weird behavior of edate on package cancellation
+    my $edate = $cust_bill_pkg->edate;
+    if ( $self->recur_temporality eq 'preceding' ) {
+      $edate = $self->add_freq($cust_bill_pkg->sdate);
+    }
 
-  $self->freq =~ /^(\d+)([hdwm]?)$/
-    or die 'unparsable frequency: '. $self->freq;
-  my $freq_sec = $1 * $sec{$2||'m'};
-  return 0 unless $freq_sec;
+    # 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);
+    }
 
-  sprintf("%.2f", $self->base_recur($cust_pkg) * ( $next_bill - $time ) / $freq_sec );
+    $credit += $amount;
+
+    push @{ $options{'cust_credit_source_bill_pkg'} },
+      new FS::cust_credit_source_bill_pkg {
+        'billpkgnum' => $cust_bill_pkg->billpkgnum,
+        'amount'     => sprintf('%.2f', $amount),
+        'currency'   => $cust_bill_pkg->cust_bill->currency,
+      }
+        if $options{'cust_credit_source_bill_pkg'};
+
+  } 
+
+  sprintf('%.2f', $credit);
 
 }
 
@@ -346,10 +294,24 @@ sub is_free_options {
 
 sub is_prepaid { 0; } #no, we're postpaid
 
-#XXX discounts only on recurring fees for now (no setup/one-time or usage)
-sub can_discount {
+sub can_start_date {
+  my $self = shift;
+  my %opt = @_;
+  return 0 if $self->start_on_hold;
+
+  ! $self->option('start_1st', 1) && (   ! $self->option('sync_bill_date',1)
+                                      || ! $self->option('prorate_defer_bill',1)
+                                      || ! $opt{'num_ncancelled_pkgs'}
+                                     ); 
+}
+
+sub can_discount { 1; }
+
+sub can_usageprice { 1; }
+
+sub recur_temporality {
   my $self = shift;
-  $self->freq =~ /^\d+$/ && $self->freq > 0;
+  $self->option('recur_temporality', 1);
 }
 
 sub usage_valuehash {