FS/FS/part_pkg/flat.pm

   1 package FS::part_pkg::flat;
   2
   3 use strict;
   4 use vars qw(@ISA %info);
   5 #use FS::Record qw(qsearch);
   6 use FS::UI::bytecount;
   7 use FS::part_pkg;
   8
   9 @ISA = qw(FS::part_pkg);
  10
  11 %info = (
  12   'name' => 'Flat rate (anniversary billing)',
  13   'fields' => {
  14     'setup_fee'     => { 'name' => 'Setup fee for this package',
  15                          'default' => 0,
  16                        },
  17     'recur_fee'     => { 'name' => 'Recurring fee for this package',
  18                          'default' => 0,
  19                        },
  20     'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
  21                                    ' of service at cancellation',
  22                          'type' => 'checkbox',
  23                        },
  24     'externalid' => { 'name'   => 'Optional External ID',
  25                       'default' => '',
  26                     },
  27     'seconds'       => { 'name' => 'Time limit for this package',
  28                          'default' => '',
  29                        },
  30     'upbytes'       => { 'name' => 'Upload limit for this package',
  31                          'default' => '',
  32                          'format' => \&FS::UI::bytecount::display_bytecount,
  33                          'parse' => \&FS::UI::bytecount::parse_bytecount,
  34                        },
  35     'downbytes'     => { 'name' => 'Download limit for this package',
  36                          'default' => '',
  37                          'format' => \&FS::UI::bytecount::display_bytecount,
  38                          'parse' => \&FS::UI::bytecount::parse_bytecount,
  39                        },
  40     'totalbytes'    => { 'name' => 'Transfer limit for this package',
  41                          'default' => '',
  42                          'format' => \&FS::UI::bytecount::display_bytecount,
  43                          'parse' => \&FS::UI::bytecount::parse_bytecount,
  44                        },
  45     'recharge_amount'       => { 'name' => 'Cost of recharge for this package',
  46                          'default' => '',
  47                        },
  48     'recharge_seconds'      => { 'name' => 'Recharge time for this package',
  49                          'default' => '',
  50                        },
  51     'recharge_upbytes'      => { 'name' => 'Recharge upload for this package',
  52                          'default' => '',
  53                          'format' => \&FS::UI::bytecount::display_bytecount,
  54                          'parse' => \&FS::UI::bytecount::parse_bytecount,
  55                        },
  56     'recharge_downbytes'    => { 'name' => 'Recharge download for this package',
  57                          'default' => '',
  58                          'format' => \&FS::UI::bytecount::display_bytecount,
  59                          'parse' => \&FS::UI::bytecount::parse_bytecount,
  60                        },
  61     'recharge_totalbytes'   => { 'name' => 'Recharge transfer for this package',
  62                          'default' => '',
  63                          'format' => \&FS::UI::bytecount::display_bytecount,
  64                          'parse' => \&FS::UI::bytecount::parse_bytecount,
  65                        },
  66   },
  67   'fieldorder' => [ 'setup_fee', 'recur_fee', 'unused_credit',
  68                     'seconds', 'upbytes', 'downbytes', 'totalbytes',
  69                     'recharge_amount', 'recharge_seconds', 'recharge_upbytes',
  70                     'recharge_downbytes', 'recharge_totalbytes',
  71                     'externalid' ],
  72   'weight' => 10,
  73 );
  74
  75 sub calc_setup {
  76   my($self, $cust_pkg, $sdate, $details ) = @_;
  77
  78   my $i = 0;
  79   my $count = $self->option( 'additional_count', 'quiet' ) || 0;
  80   while ($i < $count) {
  81     push @$details, $self->option( 'additional_info' . $i++ );
  82   }
  83
  84   $self->option('setup_fee');
  85 }
  86
  87 sub calc_recur {
  88   my($self, $cust_pkg) = @_;
  89   $self->reset_usage($cust_pkg);
  90   $self->base_recur($cust_pkg);
  91 }
  92
  93 sub base_recur {
  94   my($self, $cust_pkg) = @_;
  95   $self->option('recur_fee');
  96 }
  97
  98 sub calc_remain {
  99   my ($self, $cust_pkg) = @_;
 100   my $time = time;  #should be able to pass this in for credit calculation
 101   my $next_bill = $cust_pkg->getfield('bill') || 0;
 102   my $last_bill = $cust_pkg->last_bill || 0;
 103   return 0 if    ! $self->base_recur
 104               || ! $self->option('unused_credit', 1)
 105               || ! $last_bill
 106               || ! $next_bill
 107               || $next_bill < $time;
 108
 109   my %sec = (
 110     'h' =>    3600, # 60 * 60
 111     'd' =>   86400, # 60 * 60 * 24
 112     'w' =>  604800, # 60 * 60 * 24 * 7
 113     'm' => 2629744, # 60 * 60 * 24 * 365.2422 / 12
 114   );
 115
 116   $self->freq =~ /^(\d+)([hdwm]?)$/
 117     or die 'unparsable frequency: '. $self->freq;
 118   my $freq_sec = $1 * $sec{$2||'m'};
 119   return 0 unless $freq_sec;
 120
 121   sprintf("%.2f", $self->base_recur * ( $next_bill - $time ) / $freq_sec );
 122
 123 }
 124
 125 sub is_free_options {
 126   qw( setup_fee recur_fee );
 127 }
 128
 129 sub is_prepaid {
 130   0; #no, we're postpaid
 131 }
 132
 133 sub reset_usage {
 134   my($self, $cust_pkg) = @_;
 135   my %values = map { $_, $self->option($_) }
 136     grep { $self->option($_, 'hush') }
 137     qw(seconds upbytes downbytes totalbytes);
 138   $cust_pkg->set_usage(\%values);
 139 }
 140
 141 1;