FS/FS/part_pkg/sqlradacct_hour.pm

   1 package FS::part_pkg::sqlradacct_hour;
   2
   3 use strict;
   4 use vars qw(@ISA %info);
   5 #use FS::Record qw(qsearch qsearchs);
   6 use FS::part_pkg::flat;
   7
   8 @ISA = qw(FS::part_pkg::flat);
   9
  10 %info = (
  11   'name' => 'Base charge plus per-hour (and for data) from an SQL RADIUS radacct table',
  12   'shortname' => 'Usage charges from RADIUS',
  13   'inherit_fields' => [ 'global_Mixin' ],
  14   'fields' => {
  15     'recur_included_hours' => { 'name' => 'Hours included',
  16                                 'default' => 0,
  17                               },
  18     'recur_hourly_charge' => { 'name' => 'Additional charge per hour',
  19                                'default' => 0,
  20                              },
  21     'recur_hourly_cap'    => { 'name' => 'Maximum overage charge for hours'.
  22                                          ' (0 means no cap)',
  23
  24                                'default' => 0,
  25                              },
  26
  27     'recur_included_input' => { 'name' => 'Upload megabytes included',
  28                                 'default' => 0,
  29                               },
  30     'recur_input_charge' => { 'name' =>
  31                                       'Additional charge per megabyte upload',
  32                               'default' => 0,
  33                             },
  34     'recur_input_cap'    => { 'name' => 'Maximum overage charge for upload'.
  35                                          ' (0 means no cap)',
  36                                'default' => 0,
  37                              },
  38
  39     'recur_included_output' => { 'name' => 'Download megabytes included',
  40                                  'default' => 0,
  41                               },
  42     'recur_output_charge' => { 'name' =>
  43                                      'Additional charge per megabyte download',
  44                               'default' => 0,
  45                             },
  46     'recur_output_cap'    => { 'name' => 'Maximum overage charge for download'.
  47                                          ' (0 means no cap)',
  48                                'default' => 0,
  49                              },
  50
  51     'recur_included_total' => { 'name' =>
  52                                      'Total megabytes included',
  53                                 'default' => 0,
  54                               },
  55     'recur_total_charge' => { 'name' =>
  56                                'Additional charge per megabyte total',
  57                               'default' => 0,
  58                             },
  59     'recur_total_cap'    => { 'name' => 'Maximum overage charge for total'.
  60                                         ' megabytes (0 means no cap)',
  61                                'default' => 0,
  62                              },
  63
  64     'global_cap'         => { 'name' => 'Global cap on all overage charges'.
  65                                         ' (0 means no cap)',
  66                               'default' => 0,
  67                             },
  68
  69   },
  70   'fieldorder' => [qw( recur_included_hours recur_hourly_charge recur_hourly_cap recur_included_input recur_input_charge recur_input_cap recur_included_output recur_output_charge recur_output_cap recur_included_total recur_total_charge recur_total_cap global_cap )],
  71   'weight' => 40,
  72 );
  73
  74 sub price_info {
  75     my $self = shift;
  76     my $str = $self->SUPER::price_info;
  77     $str .= " plus usage" if $str;
  78     $str;
  79 }
  80
  81 sub calc_recur {
  82   my($self, $cust_pkg, $sdate, $details ) = @_;
  83
  84   my $last_bill = $cust_pkg->last_bill;
  85   my $hours = $cust_pkg->seconds_since_sqlradacct($last_bill, $$sdate ) / 3600;
  86   $hours -= $self->option('recur_included_hours');
  87   $hours = 0 if $hours < 0;
  88
  89   my $input = $cust_pkg->attribute_since_sqlradacct(  $last_bill,
  90                                                       $$sdate,
  91                                                       'AcctInputOctets' )
  92               / 1048576;
  93
  94   my $output = $cust_pkg->attribute_since_sqlradacct( $last_bill,
  95                                                       $$sdate,
  96                                                       'AcctOutputOctets' )
  97                / 1048576;
  98
  99   my $total = $input + $output - $self->option('recur_included_total');
 100   $total = 0 if $total < 0;
 101   $input = $input - $self->option('recur_included_input');
 102   $input = 0 if $input < 0;
 103   $output = $output - $self->option('recur_included_output');
 104   $output = 0 if $output < 0;
 105
 106   my $totalcharge =
 107      sprintf('%.2f', $total * $self->option('recur_total_charge'));
 108   $totalcharge = $self->option('recur_total_cap')
 109     if $self->option('recur_total_cap')
 110     && $totalcharge > $self->option('recur_total_cap');
 111
 112   my $inputcharge =
 113      sprintf('%.2f', $input * $self->option('recur_input_charge'));
 114   $inputcharge = $self->option('recur_input_cap')
 115     if $self->option('recur_input_cap')
 116     && $inputcharge > $self->option('recur_input_cap');
 117
 118   my $outputcharge =
 119     sprintf('%.2f', $output * $self->option('recur_output_charge'));
 120   $outputcharge = $self->option('recur_output_cap')
 121     if $self->option('recur_output_cap')
 122     && $outputcharge > $self->option('recur_output_cap');
 123
 124   my $hourscharge =
 125     sprintf('%.2f', $hours * $self->option('recur_hourly_charge'));
 126   $hourscharge = $self->option('recur_hourly_cap')
 127     if $self->option('recur_hourly_cap')
 128     && $hourscharge > $self->option('recur_hourly_cap');
 129
 130   if ( $self->option('recur_total_charge') > 0 ) {
 131     push @$details, "Last month's data ".
 132                     sprintf('%.1f', $total). " megs: $totalcharge";
 133   }
 134   if ( $self->option('recur_input_charge') > 0 ) {
 135     push @$details, "Last month's download ".
 136                    sprintf('%.1f', $input). " megs: $inputcharge";
 137   }
 138   if ( $self->option('recur_output_charge') > 0 ) {
 139     push @$details, "Last month's upload ".
 140                    sprintf('%.1f', $output). " megs: $outputcharge";
 141   }
 142   if ( $self->option('recur_hourly_charge')  > 0 ) {
 143     push @$details, "Last month\'s time ".
 144                    sprintf('%.1f', $hours). " hours: $hourscharge";
 145   }
 146
 147   my $charges = $hourscharge + $inputcharge + $outputcharge + $totalcharge;
 148   if ( $self->option('global_cap') && $charges > $self->option('global_cap') ) {
 149     $charges = $self->option('global_cap');
 150     push @$details, "Usage charges capped at: $charges";
 151   }
 152
 153   $self->option('recur_fee') + $charges;
 154 }
 155
 156 sub can_discount { 0; }
 157
 158 sub is_free_options {
 159   qw( setup_fee recur_fee recur_hourly_charge
 160       recur_input_charge recur_output_charge recur_total_charge );
 161 }
 162
 163 sub base_recur {
 164   my($self, $cust_pkg) = @_;
 165   $self->option('recur_fee');
 166 }
 167
 168 1;