prorate_round_day options to round up / down only, #42108
[freeside.git] / FS / FS / part_pkg / prorate.pm
index 37cb37f..4cdc3f1 100644 (file)
@@ -1,46 +1,66 @@
 package FS::part_pkg::prorate;
+use base qw( FS::part_pkg::flat );
 
 use strict;
-use vars qw(@ISA %info);
+use vars qw(%info);
 use Time::Local qw(timelocal);
 #use FS::Record qw(qsearch qsearchs);
-use FS::part_pkg;
-
-@ISA = qw(FS::part_pkg);
 
 %info = (
-    'name' => 'First partial month pro-rated, then flat-rate (1st of month billing)',
-    'fields' =>  {
-      'setup_fee' => { 'name' => 'Setup fee for this package',
-                       'default' => 0,
-                     },
-      'recur_fee' => { 'name' => 'Recurring fee for this package',
-                       'default' => 0,
-                      },
-    },
-    'fieldorder' => [ 'setup_fee', 'recur_fee' ],
-    #'setup' => 'what.setup_fee.value',
-    #'recur' => '\'my $mnow = $sdate; my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($sdate) )[0,1,2,3,4,5]; my $mstart = timelocal(0,0,0,1,$mon,$year); my $mend = timelocal(0,0,0,1, $mon == 11 ? 0 : $mon+1, $year+($mon==11)); $sdate = $mstart; ( $part_pkg->freq - 1 ) * \' + what.recur_fee.value + \' / $part_pkg->freq + \' + what.recur_fee.value + \' / $part_pkg->freq * ($mend-$mnow) / ($mend-$mstart) ; \'',
-    'freq' => 'm',
-    'weight' => 20,
-);
+  'name' => 'First partial month pro-rated, then flat-rate (selectable billing day)',
+  'shortname' => 'Prorate (Nth of month billing)',
+  'inherit_fields' => [ 'flat', 'usage_Mixin', 'global_Mixin' ],
+  'fields' => {
+    'recur_temporality' => {'disabled' => 1},
+    'sync_bill_date' => {'disabled' => 1},
+    'cutoff_day' => { 'name' => 'Billing Day (1 - 28)',
+                      'default' => 1,
+                    },
 
-sub calc_setup {
-  my($self, $cust_pkg ) = @_;
-  $self->option('setup_fee');
-}
+    'add_full_period'=> { 'name' => 'When prorating first month, also bill '.
+                                    'for one full period after that',
+                          'type' => 'checkbox',
+                        },
+    'prorate_round_day'=> {
+                          'name' => 'Round the prorated period',
+                          'type' => 'select',
+                          'select_options' => \%FS::part_pkg::prorate_Mixin::prorate_round_day_opts,
+                        },
+    'prorate_defer_bill'=> {
+                        'name' => 'Defer the first bill until the billing day',
+                        'type' => 'checkbox',
+                        },
+    'prorate_verbose' => {
+                        'name' => 'Show prorate details on the invoice',
+                        'type' => 'checkbox',
+                        },
+  },
+  'fieldorder' => [ 'cutoff_day', 'prorate_defer_bill', 'add_full_period', 'prorate_round_day', 'prorate_verbose' ],
+  'freq' => 'm',
+  'weight' => 20,
+);
 
 sub calc_recur {
-  my($self, $cust_pkg, $sdate ) = @_;
-  my $mnow = $$sdate;
-  my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($mnow) )[0,1,2,3,4,5];
-  my $mstart = timelocal(0,0,0,1,$mon,$year);
-  my $mend = timelocal(0,0,0,1, $mon == 11 ? 0 : $mon+1, $year+($mon==11));
-  $$sdate = $mstart;
+  my $self = shift;
+  #my($cust_pkg, $sdate, $details, $param ) = @_;
+  my $cust_pkg = $_[0];
+
+  my $charge = $self->calc_prorate(@_, $self->cutoff_day($cust_pkg));
 
-  my $permonth = $self->option('recur_fee') / $self->freq;
+  $charge += $self->usageprice_recur(@_);
+  $cust_pkg->apply_usageprice(); #$sdate for prorating?
+
+  my $discount = $self->calc_discount(@_);
+
+  sprintf( '%.2f', ($cust_pkg->quantity || 1) * ($charge - $discount) );
+
+}
 
-  $permonth * ( ( $self->freq - 1 ) + ($mend-$mnow) / ($mend-$mstart) );
+sub cutoff_day {
+  my( $self, $cust_pkg ) = @_;
+  my $prorate_day = $cust_pkg->cust_main->prorate_day;
+  $prorate_day ? ( $prorate_day )
+               : split(/\s*,\s*/, $self->option('cutoff_day', 1) || '1');
 }
 
 1;