eliminiate noisy but harmless "Use of uninitialized value in numeric gt (>)" warning
[freeside.git] / FS / FS / part_pkg / flat.pm
index 3480964..f9aaebe 100644 (file)
@@ -1,30 +1,24 @@
 package FS::part_pkg::flat;
 
 use strict;
-use vars qw(@ISA %info);
+use vars qw( @ISA %info
+             %usage_fields %usage_recharge_fields
+             @usage_fieldorder @usage_recharge_fieldorder
+           );
+use Tie::IxHash;
 #use FS::Record qw(qsearch);
 use FS::UI::bytecount;
 use FS::part_pkg;
 
 @ISA = qw(FS::part_pkg);
 
-%info = (
-  'name' => 'Flat rate (anniversary billing)',
-  'shortname' => 'Anniversary',
-  'fields' => {
-    'setup_fee'     => { 'name' => 'Setup fee for this package',
-                         'default' => 0,
-                       },
-    'recur_fee'     => { 'name' => 'Recurring fee for this package',
-                         'default' => 0,
-                       },
-    'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
-                                   ' of service at cancellation',
-                         'type' => 'checkbox',
-                       },
-    'externalid' => { 'name'   => 'Optional External ID',
-                      'default' => '',
-                    },
+tie my %temporalities, 'Tie::IxHash',
+  'upcoming'  => "Upcoming (future)",
+  'preceding' => "Preceding (past)",
+;
+
+%usage_fields = (
+
     'seconds'       => { 'name' => 'Time limit for this package',
                          'default' => '',
                          'check' => sub { shift =~ /^\d*$/ },
@@ -47,6 +41,10 @@ use FS::part_pkg;
                          '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})?$/ },
@@ -81,12 +79,47 @@ use FS::part_pkg;
                                     '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',
+  '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,
+                           },
+
+    %usage_fields,
+    %usage_recharge_fields,
+
+    'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
+                                   ' of service at cancellation',
+                         'type' => 'checkbox',
+                       },
+    'externalid' => { 'name'   => 'Optional External ID',
+                      'default' => '',
+                    },
   },
-  'fieldorder' => [ 'setup_fee', 'recur_fee', 'unused_credit', 
-                    'seconds', 'upbytes', 'downbytes', 'totalbytes',
-                    'recharge_amount', 'recharge_seconds', 'recharge_upbytes',
-                    'recharge_downbytes', 'recharge_totalbytes',
-                    'usage_rollover', 'recharge_reset', 'externalid' ],
+  'fieldorder' => [ qw( setup_fee recur_fee recur_temporality unused_credit ),
+                    @usage_fieldorder, @usage_recharge_fieldorder,
+                    qw( externalid ),
+                  ],
   'weight' => 10,
 );
 
@@ -111,8 +144,16 @@ sub unit_setup {
 }
 
 sub calc_recur {
-  my($self, $cust_pkg) = @_;
-  $self->base_recur($cust_pkg);
+  my $self = shift;
+  my($cust_pkg) = @_;
+
+  #my $last_bill = $cust_pkg->last_bill;
+  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;
+
+  $self->base_recur(@_);
 }
 
 sub base_recur {
@@ -120,6 +161,14 @@ sub base_recur {
   $self->option('recur_fee', 1) || 0;
 }
 
+sub base_recur_permonth {
+  my($self, $cust_pkg) = @_;
+
+  return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
+
+  sprintf('%.2f', $self->base_recur($cust_pkg) / $self->freq );
+}
+
 sub calc_remain {
   my ($self, $cust_pkg, %options) = @_;
 
@@ -131,8 +180,11 @@ sub calc_remain {
   }
 
   my $next_bill = $cust_pkg->getfield('bill') || 0;
-  my $last_bill = $cust_pkg->last_bill || 0;
-  return 0 if    ! $self->base_recur
+
+  #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
               || ! $next_bill
@@ -150,7 +202,7 @@ sub calc_remain {
   my $freq_sec = $1 * $sec{$2||'m'};
   return 0 unless $freq_sec;
 
-  sprintf("%.2f", $self->base_recur * ( $next_bill - $time ) / $freq_sec );
+  sprintf("%.2f", $self->base_recur($cust_pkg) * ( $next_bill - $time ) / $freq_sec );
 
 }
 
@@ -162,16 +214,21 @@ sub is_prepaid {
   0; #no, we're postpaid
 }
 
-sub reset_usage {
-  my($self, $cust_pkg, %opt) = @_;
-  warn "    resetting usage counters" if $opt{debug} > 1;
-  my %values = map { $_, $self->option($_) } 
+sub usage_valuehash {
+  my $self = shift;
+  map { $_, $self->option($_) }
     grep { $self->option($_, 'hush') } 
     qw(seconds upbytes downbytes totalbytes);
+}
+
+sub reset_usage {
+  my($self, $cust_pkg, %opt) = @_;
+  warn "   resetting usage counters" if defined($opt{debug}) && $opt{debug} > 1;
+  my %values = $self->usage_valuehash;
   if ($self->option('usage_rollover', 1)) {
     $cust_pkg->recharge(\%values);
   }else{
-    $cust_pkg->set_usage(\%values);
+    $cust_pkg->set_usage(\%values, %opt);
   }
 }