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                          'check' => sub { shift =~ /^\d*$/ },
  30                        },
  31     'upbytes'       => { 'name' => 'Upload limit for this package',
  32                          'default' => '',
  33                          'check' => sub { shift =~ /^\d*$/ },
  34                          'format' => \&FS::UI::bytecount::display_bytecount,
  35                          'parse' => \&FS::UI::bytecount::parse_bytecount,
  36                        },
  37     'downbytes'     => { 'name' => 'Download limit for this package',
  38                          'default' => '',
  39                          'check' => sub { shift =~ /^\d*$/ },
  40                          'format' => \&FS::UI::bytecount::display_bytecount,
  41                          'parse' => \&FS::UI::bytecount::parse_bytecount,
  42                        },
  43     'totalbytes'    => { 'name' => 'Transfer limit for this package',
  44                          'default' => '',
  45                          'check' => sub { shift =~ /^\d*$/ },
  46                          'format' => \&FS::UI::bytecount::display_bytecount,
  47                          'parse' => \&FS::UI::bytecount::parse_bytecount,
  48                        },
  49     'recharge_amount'       => { 'name' => 'Cost of recharge for this package',
  50                          'default' => '',
  51                          'check' => sub { shift =~ /^\d*(\.\d{2})?$/ },
  52                        },
  53     'recharge_seconds'      => { 'name' => 'Recharge time for this package',
  54                          'default' => '',
  55                          'check' => sub { shift =~ /^\d*$/ },
  56                        },
  57     'recharge_upbytes'      => { 'name' => 'Recharge upload for this package',
  58                          'default' => '',
  59                          'check' => sub { shift =~ /^\d*$/ },
  60                          'format' => \&FS::UI::bytecount::display_bytecount,
  61                          'parse' => \&FS::UI::bytecount::parse_bytecount,
  62                        },
  63     'recharge_downbytes'    => { 'name' => 'Recharge download for this package',
  64                          'default' => '',
  65                          'check' => sub { shift =~ /^\d*$/ },
  66                          'format' => \&FS::UI::bytecount::display_bytecount,
  67                          'parse' => \&FS::UI::bytecount::parse_bytecount,
  68                        },
  69     'recharge_totalbytes'   => { 'name' => 'Recharge transfer for this package',
  70                          'default' => '',
  71                          'check' => sub { shift =~ /^\d*$/ },
  72                          'format' => \&FS::UI::bytecount::display_bytecount,
  73                          'parse' => \&FS::UI::bytecount::parse_bytecount,
  74                        },
  75     'usage_rollover' => { 'name' => 'Allow usage from previous period to roll '.
  76                                     ' over into current period',
  77                           'type' => 'checkbox',
  78                         },
  79   },
  80   'fieldorder' => [ 'setup_fee', 'recur_fee', 'unused_credit',
  81                     'seconds', 'upbytes', 'downbytes', 'totalbytes',
  82                     'recharge_amount', 'recharge_seconds', 'recharge_upbytes',
  83                     'recharge_downbytes', 'recharge_totalbytes',
  84                     'usage_rollover', 'externalid' ],
  85   'weight' => 10,
  86 );
  87
  88 sub calc_setup {
  89   my($self, $cust_pkg, $sdate, $details ) = @_;
  90
  91   my $i = 0;
  92   my $count = $self->option( 'additional_count', 'quiet' ) || 0;
  93   while ($i < $count) {
  94     push @$details, $self->option( 'additional_info' . $i++ );
  95   }
  96
  97   $self->option('setup_fee');
  98 }
  99
 100 sub calc_recur {
 101   my($self, $cust_pkg) = @_;
 102   $self->base_recur($cust_pkg);
 103 }
 104
 105 sub base_recur {
 106   my($self, $cust_pkg) = @_;
 107   $self->option('recur_fee', 1) || 0;
 108 }
 109
 110 sub calc_remain {
 111   my ($self, $cust_pkg, %options) = @_;
 112
 113   my $time;
 114   if ($options{'time'}) {
 115     $time = $options{'time'};
 116   } else {
 117     $time = time;
 118   }
 119
 120   my $next_bill = $cust_pkg->getfield('bill') || 0;
 121   my $last_bill = $cust_pkg->last_bill || 0;
 122   return 0 if    ! $self->base_recur
 123               || ! $self->option('unused_credit', 1)
 124               || ! $last_bill
 125               || ! $next_bill
 126               || $next_bill < $time;
 127
 128   my %sec = (
 129     'h' =>    3600, # 60 * 60
 130     'd' =>   86400, # 60 * 60 * 24
 131     'w' =>  604800, # 60 * 60 * 24 * 7
 132     'm' => 2629744, # 60 * 60 * 24 * 365.2422 / 12
 133   );
 134
 135   $self->freq =~ /^(\d+)([hdwm]?)$/
 136     or die 'unparsable frequency: '. $self->freq;
 137   my $freq_sec = $1 * $sec{$2||'m'};
 138   return 0 unless $freq_sec;
 139
 140   sprintf("%.2f", $self->base_recur * ( $next_bill - $time ) / $freq_sec );
 141
 142 }
 143
 144 sub is_free_options {
 145   qw( setup_fee recur_fee );
 146 }
 147
 148 sub is_prepaid {
 149   0; #no, we're postpaid
 150 }
 151
 152 sub reset_usage {
 153   my($self, $cust_pkg) = @_;
 154   my %values = map { $_, $self->option($_) }
 155     grep { $self->option($_, 'hush') }
 156     qw(seconds upbytes downbytes totalbytes);
 157   if ($self->option('usage_rollover', 1)) {
 158     $cust_pkg->recharge(\%values);
 159   }else{
 160     $cust_pkg->set_usage(\%values);
 161   }
 162 }
 163
 164 1;