FS/FS/part_pkg/prorate.pm

   1 package FS::part_pkg::prorate;
   2
   3 use strict;
   4 use vars qw(@ISA %info);
   5 use Time::Local qw(timelocal);
   6 #use FS::Record qw(qsearch qsearchs);
   7 use FS::part_pkg::flat;
   8
   9 @ISA = qw(FS::part_pkg::flat);
  10
  11 %info = (
  12   'name' => 'First partial month pro-rated, then flat-rate (selectable billing day)',
  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     'cutoff_day' => { 'name' => 'billing day',
  25                          'default' => 1,
  26                                             },
  27     'seconds'       => { 'name' => 'Time limit for this package',
  28                          'default' => '',
  29                        },
  30     'upbytes'       => { 'name' => 'Upload limit for this package',
  31                          'default' => '',
  32                        },
  33     'downbytes'     => { 'name' => 'Download limit for this package',
  34                          'default' => '',
  35                        },
  36     'totalbytes'    => { 'name' => 'Transfer limit for this package',
  37                          'default' => '',
  38                        },
  39     'recharge_amount'       => { 'name' => 'Cost of recharge for this package',
  40                          'default' => '',
  41                        },
  42     'recharge_seconds'      => { 'name' => 'Recharge time for this package',
  43                          'default' => '',
  44                        },
  45     'recharge_upbytes'      => { 'name' => 'Recharge upload for this package',
  46                          'default' => '',
  47                        },
  48     'recharge_downbytes'    => { 'name' => 'Recharge download for this package',                         'default' => '',
  49                        },
  50     'recharge_totalbytes'   => { 'name' => 'Recharge transfer for this package',                         'default' => '',
  51                        },
  52     #it would be better if this had to be turned on, its confusing
  53     'externalid' => { 'name'   => 'Optional External ID',
  54                       'default' => '',
  55                     },
  56  },
  57   'fieldorder' => [ 'setup_fee', 'recur_fee', 'unused_credit', 'cutoff_day',
  58                     'seconds', 'upbyte', 'downbytes', 'totalbytes',
  59                     'recharge_amount', 'recharge_seconds', 'recharge_upbytes',
  60                     'recharge_downbytes', 'recharge_totalbytes',
  61                     'externalid', ],
  62   'freq' => 'm',
  63   'weight' => 20,
  64 );
  65
  66 sub calc_recur {
  67   my($self, $cust_pkg, $sdate ) = @_;
  68   my $cutoff_day = $self->option('cutoff_day', 1) || 1;
  69   my $mnow = $$sdate;
  70   my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($mnow) )[0,1,2,3,4,5];
  71   my $mend;
  72   my $mstart;
  73
  74   $self->reset_usage($cust_pkg);
  75
  76   if ( $mday >= $cutoff_day ) {
  77     $mend =
  78       timelocal(0,0,0,$cutoff_day, $mon == 11 ? 0 : $mon+1, $year+($mon==11));
  79     $mstart =
  80       timelocal(0,0,0,$cutoff_day,$mon,$year);
  81
  82   } else {
  83     $mend = timelocal(0,0,0,$cutoff_day, $mon, $year);
  84     if ($mon==0) {$mon=11;$year--;} else {$mon--;}
  85     $mstart=  timelocal(0,0,0,$cutoff_day,$mon,$year);
  86   }
  87
  88   $$sdate = $mstart;
  89   my $permonth = $self->option('recur_fee') / $self->freq;
  90
  91   $permonth * ( ( $self->freq - 1 ) + ($mend-$mnow) / ($mend-$mstart) );
  92 }
  93
  94 1;