This commit was manufactured by cvs2svn to create tag 'freeside_2_1_1'.
[freeside.git] / FS / FS / part_pkg / bulk.pm
1 package FS::part_pkg::bulk;
2
3 use strict;
4 use vars qw(@ISA $DEBUG $me %info);
5 use Date::Format;
6 use FS::part_pkg::flat;
7
8 @ISA = qw(FS::part_pkg::flat);
9
10 $DEBUG = 1;
11 $me = '[FS::part_pkg::bulk]';
12
13 %info = (
14   'name' => 'Bulk billing based on number of active services',
15   'fields' => {
16     'setup_fee' => { 'name'    => 'Setup fee for the entire bulk package',
17                      'default' => 0,
18                    },
19     'recur_fee' => { 'name'    => 'Recurring fee for the entire bulk package',
20                      'default' => 0,
21                    },
22     'svc_setup_fee' => { 'name'    => 'Setup fee for each new service',
23                          'default' => 0,
24                        },
25     'svc_recur_fee' => { 'name'    => 'Recurring fee for each service',
26                          'default' => 0,
27                        },
28     'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
29                                    ' of service at cancellation',
30                          'type' => 'checkbox',
31                        },
32   },
33   'fieldorder' => [ 'setup_fee', 'recur_fee', 'svc_setup_fee', 'svc_recur_fee',
34                     'unused_credit', ],
35   'weight' => 50,
36 );
37
38 #some false laziness-ish w/agent.pm...  not a lot
39 sub calc_recur {
40   my($self, $cust_pkg, $sdate, $details ) = @_;
41
42   my $conf = new FS::Conf;
43   my $money_char = $conf->config('money_char') || '$';
44   
45   my $svc_setup_fee = $self->option('svc_setup_fee');
46
47   my $last_bill = $cust_pkg->last_bill;
48
49   return sprintf("%.2f", $self->base_recur($cust_pkg) )
50     unless $$sdate > $last_bill;
51
52   my $total_svc_charge = 0;
53
54   warn "$me billing for bulk services from ". time2str('%x', $last_bill).
55                                       " to ". time2str('%x', $$sdate). "\n"
56     if $DEBUG;
57
58                                            #   END      START
59   foreach my $h_cust_svc ( $cust_pkg->h_cust_svc( $$sdate, $last_bill ) ) {
60
61     my @label = $h_cust_svc->label_long( $$sdate, $last_bill );
62     die "fatal: no historical label found, wtf?" unless scalar(@label); #?
63     my $svc_details = $label[0]. ': '. $label[1]. ': ';
64
65     my $svc_charge = 0;
66
67     my $svc_start = $h_cust_svc->date_inserted;
68     if ( $svc_start < $last_bill ) {
69       $svc_start = $last_bill;
70     } elsif ( $svc_setup_fee ) {
71       $svc_charge += $svc_setup_fee;
72       $svc_details .= $money_char. sprintf('%.2f setup, ', $svc_setup_fee);
73     }
74
75     my $svc_end = $h_cust_svc->date_deleted;
76     $svc_end = ( !$svc_end || $svc_end > $$sdate ) ? $$sdate : $svc_end;
77
78     my $recur_charge =
79       $self->option('svc_recur_fee') * ( $svc_end - $svc_start )
80                                      / ( $$sdate  - $last_bill );
81
82     $svc_details .= $money_char. sprintf('%.2f', $recur_charge ).
83                     ' ('.  time2str('%x', $svc_start).
84                     ' - '. time2str('%x', $svc_end  ). ')'
85       if $recur_charge;
86
87     $svc_charge += $recur_charge;
88
89     push @$details, $svc_details;
90     $total_svc_charge += $svc_charge;
91
92   }
93
94   sprintf('%.2f', $self->base_recur($cust_pkg) + $total_svc_charge );
95 }
96
97 sub can_discount { 0; }
98
99 sub hide_svc_detail {
100   1;
101 }
102
103 sub is_free_options {
104   qw( setup_fee recur_fee svc_setup_fee svc_recur_fee );
105 }
106
107 1;
108