FS/FS/part_pkg/agent.pm

   1 package FS::part_pkg::agent;
   2
   3 use strict;
   4 use vars qw(@ISA $DEBUG $me %info);
   5 use Date::Format;
   6 use FS::Record qw( qsearch );
   7 use FS::agent;
   8 use FS::cust_main;
   9
  10 #use FS::part_pkg::recur_Common;;
  11 #@ISA = qw(FS::part_pkg::recur_Common);
  12 use FS::part_pkg::prorate;
  13 @ISA = qw(FS::part_pkg::prorate);
  14
  15 $DEBUG = 0;
  16
  17 $me = '[FS::part_pkg::agent]';
  18
  19 %info = (
  20   'name'      => 'Wholesale bulk billing, for master customers of an agent.',
  21   'shortname' => 'Wholesale bulk billing for agent.',
  22
  23   'fields' => {
  24     'setup_fee'     => { 'name' => 'Setup fee for this package',
  25                          'default' => 0,
  26                        },
  27     'recur_fee'     => { 'name' => 'Base recurring fee for this package',
  28                          'default' => 0,
  29                        },
  30
  31
  32     #'recur_method'  => { 'name' => 'Recurring fee method',
  33     #                     #'type' => 'radio',
  34     #                     #'options' => \%recur_method,
  35     #                     'type' => 'select',
  36     #                     'select_options' => \%recur_Common::recur_method,
  37     #                   },
  38     'cutoff_day'    => { 'name' => 'Billing Day (1 - 28)',
  39                          'default' => '1',
  40                        },
  41     'add_full_period'=> { 'name' => 'When prorating first month, also bill '.
  42                                     'for one full period after that',
  43                           'type' => 'checkbox',
  44                         },
  45
  46     'no_pkg_prorate'   => { 'name' => 'Disable prorating bulk packages (charge full price for packages active only a portion of the month)',
  47                             'type' => 'checkbox',
  48                           },
  49
  50   },
  51
  52   #'fieldorder' => [qw( setup_fee recur_fee recur_method cutoff_day ) ],
  53   'fieldorder' => [qw( setup_fee recur_fee cutoff_day add_full_period no_pkg_prorate ) ],
  54
  55   'weight' => 51,
  56
  57 );
  58
  59 #some false laziness-ish w/bulk.pm...  not a lot
  60 sub calc_recur {
  61   my $self = shift;
  62   my($cust_pkg, $sdate, $details, $param ) = @_;
  63
  64   my $last_bill = $cust_pkg->last_bill;
  65
  66   return sprintf("%.2f", $self->SUPER::calc_recur(@_) )
  67     unless $$sdate > $last_bill;
  68
  69   my $conf = new FS::Conf;
  70   my $money_char = $conf->config('money_char') || '$';
  71
  72   my $total_agent_charge = 0;
  73
  74   warn "$me billing for agent packages from ". time2str('%x', $last_bill).
  75                                        " to ". time2str('%x', $$sdate). "\n"
  76     if $DEBUG;
  77
  78   my $prorate_ratio =   ( $$sdate                     - $last_bill )
  79                       / ( $self->add_freq($last_bill) - $last_bill );
  80
  81   #almost always just one,
  82   #unless you have multiple agents with same master customer0
  83   my @agents = qsearch('agent', { 'agent_custnum' => $cust_pkg->custnum } );
  84
  85   foreach my $agent (@agents) {
  86
  87     warn "$me billing for agent ". $agent->agent. "\n"
  88       if $DEBUG;
  89
  90     #not the most efficient to load them all into memory,
  91     #but good enough for our current needs
  92     my @cust_main = qsearch('cust_main', { 'agentnum' => $agent->agentnum } );
  93
  94     foreach my $cust_main (@cust_main) {
  95
  96       warn "$me billing agent charges for ". $cust_main->name_short. "\n"
  97         if $DEBUG;
  98
  99       #make sure setup dates are filled in
 100       my $error = $cust_main->bill; #options don't propogate from freeside-daily
 101       die "Error pre-billing agent customer: $error" if $error;
 102
 103       my @cust_pkg = grep { my $setup  = $_->get('setup');
 104                             my $cancel = $_->get('cancel');
 105
 106                             $setup < $$sdate  # END
 107                             && ( ! $cancel || $cancel > $last_bill ) #START
 108                           }
 109                      $cust_main->all_pkgs;
 110
 111       foreach my $cust_pkg ( @cust_pkg ) {
 112
 113         warn "$me billing agent charges for pkgnum ". $cust_pkg->pkgnum. "\n"
 114           if $DEBUG;
 115
 116         my $pkg_details = $cust_main->name_short. ': '; #name?
 117         # + something to identify package... primary service probably
 118
 119         my $pkg_charge = 0;
 120
 121         my $part_pkg = $cust_pkg->part_pkg;
 122         #option to not fallback? via options above
 123         my $pkg_setup_fee  =
 124           $part_pkg->setup_cost || $part_pkg->option('setup_fee');
 125         my $pkg_base_recur =
 126           $part_pkg->recur_cost || $part_pkg->base_recur_permonth($cust_pkg);
 127
 128         my $pkg_start = $cust_pkg->get('setup');
 129         if ( $pkg_start < $last_bill ) {
 130           $pkg_start = $last_bill;
 131         } elsif ( $pkg_setup_fee ) {
 132           $pkg_charge += $pkg_setup_fee;
 133           $pkg_details .= $money_char. sprintf('%.2f setup, ', $pkg_setup_fee );
 134         }
 135
 136         my $pkg_end = $cust_pkg->get('cancel');
 137         $pkg_end = ( !$pkg_end || $pkg_end > $$sdate ) ? $$sdate : $pkg_end;
 138
 139
 140         my $pkg_recur_charge = $prorate_ratio * $pkg_base_recur;
 141         $pkg_recur_charge *= ( $pkg_end - $pkg_start )
 142                            / ( $$sdate  - $last_bill )
 143           unless $self->option('no_pkg_prorate');
 144
 145         my $recur_charge += $pkg_recur_charge;
 146
 147         $pkg_details .= $money_char. sprintf('%.2f', $recur_charge ).
 148                         ' ('.  time2str('%x', $pkg_start).
 149                         ' - '. time2str('%x', $pkg_end  ). ')'
 150           if $recur_charge;
 151
 152         $pkg_charge += $recur_charge;
 153
 154         push @$details, $pkg_details
 155           if $pkg_charge;
 156         $total_agent_charge += $pkg_charge;
 157
 158       } #foreach $cust_pkg
 159
 160     } #foreach $cust_main
 161
 162   } #foreach $agent;
 163
 164   my $charges = $total_agent_charge + $self->SUPER::calc_recur(@_); #prorate
 165
 166   sprintf('%.2f', $charges );
 167
 168 }
 169
 170 sub can_discount { 0; }
 171
 172 sub hide_svc_detail {
 173   1;
 174 }
 175
 176 sub is_free {
 177   0;
 178 }
 179
 180 1;
 181