time/data/etc. unit pricing add-ons, RT#24392
[freeside.git] / FS / FS / part_pkg / bulk_Common.pm
1 package FS::part_pkg::bulk_Common;
2 use base qw( FS::part_pkg::flat );
3
4 use strict;
5 use vars qw($DEBUG $me %info);
6 use Date::Format;
7 use FS::Conf;
8
9 $DEBUG = 0;
10 $me = '[FS::part_pkg::bulk_Common]';
11
12 %info = (
13   'disabled' => 1,
14   'inherit_fields' => [ 'global_Mixin' ],
15   'fields' => {
16     'svc_setup_fee' => { 'name'    => 'Setup fee for each new service',
17                          'default' => 0,
18                        },
19     'svc_recur_fee' => { 'name'    => 'Recurring fee for each service',
20                          'default' => 0,
21                        },
22     'summarize_svcs'=> { 'name' => 'Show a count of services on the invoice, '.
23                                    'instead of a detailed list',
24                          'type' => 'checkbox',
25                        },
26   },
27   'fieldorder' => [ 'svc_setup_fee', 'svc_recur_fee',
28                     'summarize_svcs', 'no_prorate' ],
29   'weight' => 51,
30 );
31
32 sub price_info {
33     my $self = shift;
34     my $str = $self->SUPER::price_info(@_);
35     my $svc_setup_fee = $self->option('svc_setup_fee');
36     my $svc_recur_fee = $self->option('svc_recur_fee');
37     my $conf = new FS::Conf;
38     my $money_char = $conf->config('money_char') || '$';
39     $str .= ", bulk " if $str;
40     $str .= ": $money_char" . $svc_setup_fee . " one-time per service" 
41         if $svc_setup_fee;
42     $str .= ", " if ($svc_setup_fee && $svc_recur_fee);
43     $str .= $money_char . $svc_recur_fee . " recurring per service"
44         if $svc_recur_fee;
45     $str;
46 }
47
48 #some false laziness-ish w/agent.pm...  not a lot
49 sub calc_recur {
50   my($self, $cust_pkg, $sdate, $details, $param ) = @_;
51
52   my $conf = new FS::Conf;
53   my $money_char = $conf->config('money_char') || '$';
54   
55   my $last_bill = $cust_pkg->last_bill;
56
57   my $total_svc_charge = 0;
58   my %n_setup = ();
59   my %n_recur = ();
60   my %part_svc_label = ();
61   my %pkg_svc = ();
62
63   my $summarize = $self->option('summarize_svcs',1);
64
65   foreach my $cust_svc ( $self->_bulk_cust_svc( $cust_pkg, $sdate ) ) {
66
67     my $pkg_svc = $pkg_svc{ $cust_pkg->pkgpart. '_'. $cust_svc->svcpart }
68                     ||= qsearchs('pkg_svc', { 'pkgpart' => $cust_pkg->pkgpart,
69                                               'svcpart' => $cust_svc->svcpart});
70     next if $pkg_svc->bulk_skip;
71
72     my @label = $cust_svc->label_long( $$sdate, $last_bill );
73     die "fatal: no label found, wtf?" unless scalar(@label); #?
74     my $svc_details = $label[0]. ': '. $label[1]. ': ';
75     $part_svc_label{$cust_svc->svcpart} ||= $label[0];
76
77     my $svc_charge = 0;
78
79     my $setup = $self->_bulk_setup($cust_pkg, $cust_svc);
80     if ( $setup ) {
81       $svc_charge += $setup;
82       $svc_details .= $money_char. sprintf('%.2f setup, ', $setup);
83       $n_setup{$cust_svc->svcpart}++;
84     }
85
86     my( $recur, $r_details ) = $self->_bulk_recur($cust_pkg, $cust_svc, $sdate);
87     if ( $recur ) {
88       $svc_charge += $recur;
89       $svc_details .= $money_char. sprintf('%.2f', $recur). $r_details;
90       $n_recur{$cust_svc->svcpart}++;
91       push @$details, $svc_details if !$summarize;
92     }
93
94     $total_svc_charge += $svc_charge;
95
96   }
97
98   if ( $summarize ) {
99     foreach my $svcpart (keys %part_svc_label) {
100       push @$details, sprintf('Setup fee: %d @ '.$money_char.'%.2f',
101         $n_setup{$svcpart}, $self->option('svc_setup_fee') )
102         if $self->option('svc_setup_fee') and $n_setup{$svcpart};
103       push @$details, sprintf('%d services @ '.$money_char.'%.2f',
104         $n_recur{$svcpart}, $self->option('svc_recur_fee') )
105         if $n_recur{$svcpart};
106     }
107   }
108
109   my $charge = $self->base_recur($cust_pkg, $sdate) + $total_svc_charge;
110
111   $param->{'override_charges'} = $total_svc_charge / $self->freq;
112   my $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
113
114   sprintf('%.2f', $charge - $discount );
115 }
116
117 sub hide_svc_detail { 1; }
118
119 sub is_free_options {
120   qw( setup_fee recur_fee svc_setup_fee svc_recur_fee );
121 }
122
123 sub can_usageprice { 0; }
124
125 1;
126