discount_Mixin

[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 9bb45e6..a17813b 100644 (file)
--- a/FS/FS/part_pkg/flat.pm
+++ b/FS/FS/part_pkg/flat.pm
@@ -6,17 +6,26 @@ use vars qw( @ISA %info
              @usage_fieldorder @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);
+@ISA = qw(FS::part_pkg 
+          FS::part_pkg::prorate_Mixin
+          FS::part_pkg::discount_Mixin);
 
 tie my %temporalities, 'Tie::IxHash',
   'upcoming'  => "Upcoming (future)",
   'preceding' => "Preceding (past)",
 ;
 
+tie my %contract_years, 'Tie::IxHash', (
+  '' => '(none)',
+  map { $_*12 => $_ } (1..5),
+);
+
 %usage_fields = (
 
     'seconds'       => { 'name' => 'Time limit for this package',
@@ -104,19 +113,52 @@ tie my %temporalities, 'Tie::IxHash',
                              'type' => 'select',
                              'select_options' => \%temporalities,
                            },
-
-    %usage_fields,
-    %usage_recharge_fields,
-
     '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',
+                       },
+    'sync_bill_date' => { 'name' => 'Prorate first month to synchronize '.
+                                    'with the customer\'s other packages',
+                          'type' => 'checkbox',
+                        },
+    'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
+                        'type' => 'checkbox',
+                      },
+    'unsuspend_adjust_bill' => 
+                        { 'name' => 'Adjust next bill date forward when '.
+                                    'unsuspending',
+                          'type' => 'checkbox',
+                        },
+
+    %usage_fields,
+    %usage_recharge_fields,
+
     'externalid' => { 'name'   => 'Optional External ID',
                       'default' => '',
                     },
   },
-  'fieldorder' => [ qw( setup_fee recur_fee recur_temporality unused_credit ),
+  'fieldorder' => [ qw( setup_fee recur_fee
+                        recur_temporality unused_credit
+                        expire_months adjourn_months
+                        contract_end_months
+                        start_1st sync_bill_date
+                        suspend_bill unsuspend_adjust_bill
+                      ),
                     @usage_fieldorder, @usage_recharge_fieldorder,
                     qw( externalid ),
                   ],
@@ -140,12 +182,12 @@ sub calc_setup {
 sub unit_setup {
   my($self, $cust_pkg, $sdate, $details ) = @_;
 
-  $self->option('setup_fee');
+  $self->option('setup_fee') || 0;
 }
 
 sub calc_recur {
   my $self = shift;
-  my($cust_pkg) = @_;
+  my($cust_pkg, $sdate, $details, $param ) = @_;
 
   #my $last_bill = $cust_pkg->last_bill;
   my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
@@ -153,7 +195,23 @@ sub calc_recur {
   return 0
     if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0;
 
-  $self->base_recur(@_);
+  my $charge = $self->base_recur($cust_pkg);
+  if ( $self->option('sync_bill_date',1) ) {
+    my $next_bill = $cust_pkg->cust_main->next_bill_date;
+    if ( defined($next_bill) and $next_bill != $$sdate ) {
+      my $cutoff_day = (localtime($next_bill))[3];
+      $charge = $self->calc_prorate(@_, $cutoff_day);
+    }
+  }
+  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 base_recur {
@@ -212,7 +270,11 @@ sub is_free_options {
 
 sub is_prepaid { 0; } #no, we're postpaid
 
-sub can_discount { 1; } #and anything that inherits from us
+#XXX discounts only on recurring fees for now (no setup/one-time or usage)
+sub can_discount {
+  my $self = shift;
+  $self->freq =~ /^\d+$/ && $self->freq > 0;
+}
 
 sub usage_valuehash {
   my $self = shift;