break _bytecount subroutines out of FS::UI::Web
[freeside.git] / FS / FS / part_pkg / flat.pm
index a3939ba..9f5e784 100644 (file)
@@ -3,6 +3,7 @@ package FS::part_pkg::flat;
 use strict;
 use vars qw(@ISA %info);
 #use FS::Record qw(qsearch);
+use FS::UI::bytecount;
 use FS::part_pkg;
 
 @ISA = qw(FS::part_pkg);
@@ -10,27 +11,135 @@ use FS::part_pkg;
 %info = (
   'name' => 'Flat rate (anniversary billing)',
   'fields' => {
-    'setup_fee' => { 'name' => 'Setup fee for this package',
-                     'default' => 0,
-                   },
-    'recur_fee' => { 'name' => 'Recurring fee for this package',
-                     'default' => 0,
+    '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' => '',
                     },
+    'seconds'       => { 'name' => 'Time limit for this package',
+                         'default' => '',
+                       },
+    'upbytes'       => { 'name' => 'Upload limit for this package',
+                         'default' => '',
+                         'format' => \&FS::UI::bytecount::display_bytecount,
+                         'parse' => \&FS::UI::bytecount::parse_bytecount,
+                       },
+    'downbytes'     => { 'name' => 'Download limit for this package',
+                         'default' => '',
+                         'format' => \&FS::UI::bytecount::display_bytecount,
+                         'parse' => \&FS::UI::bytecount::parse_bytecount,
+                       },
+    'totalbytes'    => { 'name' => 'Transfer limit for this package',
+                         'default' => '',
+                         'format' => \&FS::UI::bytecount::display_bytecount,
+                         'parse' => \&FS::UI::bytecount::parse_bytecount,
+                       },
+    'recharge_amount'       => { 'name' => 'Cost of recharge for this package',
+                         'default' => '',
+                         'format' => \&FS::UI::bytecount::display_bytecount,
+                         'parse' => \&FS::UI::bytecount::parse_bytecount,
+                       },
+    'recharge_seconds'      => { 'name' => 'Recharge time for this package',
+                         'default' => '',
+                         'format' => \&FS::UI::bytecount::display_bytecount,
+                         'parse' => \&FS::UI::bytecount::parse_bytecount,
+                       },
+    'recharge_upbytes'      => { 'name' => 'Recharge upload for this package',
+                         'default' => '',
+                         'format' => \&FS::UI::bytecount::display_bytecount,
+                         'parse' => \&FS::UI::bytecount::parse_bytecount,
+                       },
+    'recharge_downbytes'    => { 'name' => 'Recharge download for this package',
+                         'default' => '',
+                         'format' => \&FS::UI::bytecount::display_bytecount,
+                         'parse' => \&FS::UI::bytecount::parse_bytecount,
+                       },
+    'recharge_totalbytes'   => { 'name' => 'Recharge transfer for this package',
+                         'default' => '',
+                         'format' => \&FS::UI::bytecount::display_bytecount,
+                         'parse' => \&FS::UI::bytecount::parse_bytecount,
+                       },
   },
-  'fieldorder' => [ 'setup_fee', 'recur_fee' ],
-  #'setup' => 'what.setup_fee.value',
-  #'recur' => 'what.recur_fee.value',
+  'fieldorder' => [ 'setup_fee', 'recur_fee', 'unused_credit', 
+                    'seconds', 'upbytes', 'downbytes', 'totalbytes',
+                    'recharge_amount', 'recharge_seconds', 'recharge_upbytes',
+                    'recharge_downbytes', 'recharge_totalbytes',
+                    'externalid' ],
   'weight' => 10,
 );
 
 sub calc_setup {
-  my($self, $cust_pkg ) = @_;
+  my($self, $cust_pkg, $sdate, $details ) = @_;
+
+  my $i = 0;
+  my $count = $self->option( 'additional_count', 'quiet' ) || 0;
+  while ($i < $count) {
+    push @$details, $self->option( 'additional_info' . $i++ );
+  }
+
   $self->option('setup_fee');
 }
 
 sub calc_recur {
-  my($self, $cust_pkg ) = @_;
+  my($self, $cust_pkg) = @_;
+  $self->reset_usage($cust_pkg);
+  $self->base_recur($cust_pkg);
+}
+
+sub base_recur {
+  my($self, $cust_pkg) = @_;
   $self->option('recur_fee');
 }
 
+sub calc_remain {
+  my ($self, $cust_pkg) = @_;
+  my $time = time;  #should be able to pass this in for credit calculation
+  my $next_bill = $cust_pkg->getfield('bill') || 0;
+  my $last_bill = $cust_pkg->last_bill || 0;
+  return 0 if    ! $self->base_recur
+              || ! $self->option('unused_credit', 1)
+              || ! $last_bill
+              || ! $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 
+  );
+
+  $self->freq =~ /^(\d+)([hdwm]?)$/
+    or die 'unparsable frequency: '. $self->freq;
+  my $freq_sec = $1 * $sec{$2||'m'};
+  return 0 unless $freq_sec;
+
+  sprintf("%.2f", $self->base_recur * ( $next_bill - $time ) / $freq_sec );
+
+}
+
+sub is_free_options {
+  qw( setup_fee recur_fee );
+}
+
+sub is_prepaid {
+  0; #no, we're postpaid
+}
+
+sub reset_usage {
+  my($self, $cust_pkg) = @_;
+  my %values = map { $_, $self->option($_) } 
+    grep { $self->option($_, 'hush') } 
+    qw(seconds upbytes downbytes totalbytes);
+  $cust_pkg->set_usage(\%values);
+}
+
 1;