suspend_bill package option to continue recurring billing while suspended and part_pk...
[freeside.git] / FS / FS / part_pkg / flat.pm
index 648a83d..ee54c09 100644 (file)
@@ -13,13 +13,18 @@ use FS::Conf;
 use FS::part_pkg;
 use FS::cust_bill_pkg_discount;
 
-@ISA = qw(FS::part_pkg);
+@ISA = qw(FS::part_pkg FS::part_pkg::prorate_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',
@@ -115,10 +120,29 @@ tie my %temporalities, 'Tie::IxHash',
     #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,
@@ -129,7 +153,10 @@ tie my %temporalities, 'Tie::IxHash',
   },
   'fieldorder' => [ qw( setup_fee recur_fee
                         recur_temporality unused_credit
-                        expire_months start_1st
+                        expire_months adjourn_months
+                        contract_end_months
+                        start_1st sync_bill_date
+                        suspend_bill unsuspend_adjust_bill
                       ),
                     @usage_fieldorder, @usage_recharge_fieldorder,
                     qw( externalid ),
@@ -158,7 +185,8 @@ sub unit_setup {
 }
 
 sub calc_recur {
-  my($self, $cust_pkg, $sdate, $details, $param ) = @_;
+  my $self = shift;
+  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
@@ -166,11 +194,16 @@ sub calc_recur {
   return 0
     if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0;
 
-  my $br = $self->base_recur($cust_pkg);
-
-  my $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
+  if( $self->option('sync_bill_date',1) ) {
+    return $self->calc_prorate(@_);
+  }
+  else {
+    my $charge = $self->base_recur($cust_pkg);
+    $charge *= $param->{freq_override} if $param->{freq_override};
+    my $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
 
-  sprintf('%.2f', $br - $discount);
+    return sprintf('%.2f', $charge - $discount);
+  }
 }
 
 sub calc_discount {
@@ -180,6 +213,32 @@ sub calc_discount {
 
   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;
+      }
+      die "error discounting using part_pkg_discount: $error" if $error;
+    }
+  }
+
   my @cust_pkg_discount = $cust_pkg->cust_pkg_discount_active;
   foreach my $cust_pkg_discount ( @cust_pkg_discount ) {
      my $discount = $cust_pkg_discount->discount;
@@ -196,7 +255,8 @@ sub calc_discount {
                            $discount->months - $cust_pkg_discount->months_used )
                     : $chg_months;
 
-     my $error = $cust_pkg_discount->increment_months_used($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;