1 package FS::part_pkg::flat;
4 use vars qw( @ISA %info
5 %usage_fields %usage_recharge_fields
6 @usage_fieldorder @usage_recharge_fieldorder
9 use List::Util qw(min); # max);
10 #use FS::Record qw(qsearch);
11 use FS::UI::bytecount;
14 use FS::cust_bill_pkg_discount;
16 @ISA = qw(FS::part_pkg);
18 tie my %temporalities, 'Tie::IxHash',
19 'upcoming' => "Upcoming (future)",
20 'preceding' => "Preceding (past)",
25 'seconds' => { 'name' => 'Time limit for this package',
27 'check' => sub { shift =~ /^\d*$/ },
29 'upbytes' => { 'name' => 'Upload limit for this package',
31 'check' => sub { shift =~ /^\d*$/ },
32 'format' => \&FS::UI::bytecount::display_bytecount,
33 'parse' => \&FS::UI::bytecount::parse_bytecount,
35 'downbytes' => { 'name' => 'Download limit for this package',
37 'check' => sub { shift =~ /^\d*$/ },
38 'format' => \&FS::UI::bytecount::display_bytecount,
39 'parse' => \&FS::UI::bytecount::parse_bytecount,
41 'totalbytes' => { 'name' => 'Transfer limit for this package',
43 'check' => sub { shift =~ /^\d*$/ },
44 'format' => \&FS::UI::bytecount::display_bytecount,
45 'parse' => \&FS::UI::bytecount::parse_bytecount,
49 %usage_recharge_fields = (
51 'recharge_amount' => { 'name' => 'Cost of recharge for this package',
53 'check' => sub { shift =~ /^\d*(\.\d{2})?$/ },
55 'recharge_seconds' => { 'name' => 'Recharge time for this package',
57 'check' => sub { shift =~ /^\d*$/ },
59 'recharge_upbytes' => { 'name' => 'Recharge upload for this package',
61 'check' => sub { shift =~ /^\d*$/ },
62 'format' => \&FS::UI::bytecount::display_bytecount,
63 'parse' => \&FS::UI::bytecount::parse_bytecount,
65 'recharge_downbytes' => { 'name' => 'Recharge download for this package',
67 'check' => sub { shift =~ /^\d*$/ },
68 'format' => \&FS::UI::bytecount::display_bytecount,
69 'parse' => \&FS::UI::bytecount::parse_bytecount,
71 'recharge_totalbytes' => { 'name' => 'Recharge transfer for this package',
73 'check' => sub { shift =~ /^\d*$/ },
74 'format' => \&FS::UI::bytecount::display_bytecount,
75 'parse' => \&FS::UI::bytecount::parse_bytecount,
77 'usage_rollover' => { 'name' => 'Allow usage from previous period to roll '.
78 ' over into current period',
81 'recharge_reset' => { 'name' => 'Reset usage to these values on manual '.
87 @usage_fieldorder = qw( seconds upbytes downbytes totalbytes );
88 @usage_recharge_fieldorder = qw(
89 recharge_amount recharge_seconds recharge_upbytes
90 recharge_downbytes recharge_totalbytes
91 usage_rollover recharge_reset
95 'name' => 'Flat rate (anniversary billing)',
96 'shortname' => 'Anniversary',
98 'setup_fee' => { 'name' => 'Setup fee for this package',
101 'recur_fee' => { 'name' => 'Recurring fee for this package',
105 #false laziness w/voip_cdr.pm
106 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
108 'select_options' => \%temporalities,
110 'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
111 ' of service at cancellation',
112 'type' => 'checkbox',
115 #used in cust_pkg.pm so could add to any price plan
116 'expire_months' => { 'name' => 'Auto-add an expiration date this number of months out',
118 #used in cust_pkg.pm so could add to any price plan where it made sense
119 'start_1st' => { 'name' => 'Auto-add a start date to the 1st, ignoring the current month.',
120 'type' => 'checkbox',
124 %usage_recharge_fields,
126 'externalid' => { 'name' => 'Optional External ID',
130 'fieldorder' => [ qw( setup_fee recur_fee
131 recur_temporality unused_credit
132 expire_months start_1st
134 @usage_fieldorder, @usage_recharge_fieldorder,
141 my($self, $cust_pkg, $sdate, $details ) = @_;
144 my $count = $self->option( 'additional_count', 'quiet' ) || 0;
145 while ($i < $count) {
146 push @$details, $self->option( 'additional_info' . $i++ );
149 my $quantity = $cust_pkg->quantity || 1;
151 sprintf("%.2f", $quantity * $self->unit_setup($cust_pkg, $sdate, $details) );
155 my($self, $cust_pkg, $sdate, $details ) = @_;
157 $self->option('setup_fee');
164 #my $last_bill = $cust_pkg->last_bill;
165 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
168 if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0;
170 my $br = $self->base_recur(@_);
172 my $discount = $self->calc_discount(@_);
174 sprintf('%.2f', $br - $discount);
179 my($cust_pkg, $sdate, $details, $param ) = @_;
181 my $br = $self->base_recur(@_);
183 my $tot_discount = 0;
184 #UI enforces just 1 for now, will need ordering when they can be stacked
185 foreach my $cust_pkg_discount ( $cust_pkg->cust_pkg_discount_active ) {
186 my $discount = $cust_pkg_discount->discount;
187 #UI enforces one or the other (for now? probably for good)
189 $amount += $discount->amount;
190 $amount += sprintf('%.2f', $discount->percent * $br / 100 );
192 my $chg_months = $param->{'months'} || $cust_pkg->part_pkg->freq;
194 my $months = $discount->months
196 $discount->months - $cust_pkg->months_used )
199 my $error = $cust_pkg_discount->increment_months_used($months);
200 die "error discounting: $error" if $error;
203 $amount = sprintf('%.2f', $amount);
205 next unless $amount > 0;
207 #record details in cust_bill_pkg_discount
208 my $cust_bill_pkg_discount = new FS::cust_bill_pkg_discount {
209 'pkgdiscountnum' => $cust_pkg_discount->pkgdiscountnum,
213 push @{ $param->{'discounts'} }, $cust_bill_pkg_discount;
215 #add details on discount to invoice
216 my $conf = new FS::Conf;
217 my $money_char = $conf->config('money_char') || '$';
218 $months = sprintf('%.2f', $months) if $months =~ /\./;
221 $d .= $discount->name. ' ' if $discount->name;
222 $d .= 'discount of '. $discount->description_short;
223 $d .= " for $months month". ( $months!=1 ? 's' : '' );
224 $d .= ": $money_char$amount" if $months != 1 || $discount->percent;
227 $tot_discount += $amount;
230 sprintf('%.2f', $tot_discount);
234 my($self, $cust_pkg) = @_;
235 $self->option('recur_fee', 1) || 0;
238 sub base_recur_permonth {
239 my($self, $cust_pkg) = @_;
241 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
243 sprintf('%.2f', $self->base_recur($cust_pkg) / $self->freq );
247 my ($self, $cust_pkg, %options) = @_;
250 if ($options{'time'}) {
251 $time = $options{'time'};
256 my $next_bill = $cust_pkg->getfield('bill') || 0;
258 #my $last_bill = $cust_pkg->last_bill || 0;
259 my $last_bill = $cust_pkg->get('last_bill') || 0; #->last_bill falls back to setup
261 return 0 if ! $self->base_recur($cust_pkg)
262 || ! $self->option('unused_credit', 1)
265 || $next_bill < $time;
268 'h' => 3600, # 60 * 60
269 'd' => 86400, # 60 * 60 * 24
270 'w' => 604800, # 60 * 60 * 24 * 7
271 'm' => 2629744, # 60 * 60 * 24 * 365.2422 / 12
274 $self->freq =~ /^(\d+)([hdwm]?)$/
275 or die 'unparsable frequency: '. $self->freq;
276 my $freq_sec = $1 * $sec{$2||'m'};
277 return 0 unless $freq_sec;
279 sprintf("%.2f", $self->base_recur($cust_pkg) * ( $next_bill - $time ) / $freq_sec );
283 sub is_free_options {
284 qw( setup_fee recur_fee );
287 sub is_prepaid { 0; } #no, we're postpaid
289 #XXX discounts only on recurring fees for now (no setup/one-time or usage)
292 $self->freq =~ /^\d+$/ && $self->freq > 0;
295 sub usage_valuehash {
297 map { $_, $self->option($_) }
298 grep { $self->option($_, 'hush') }
299 qw(seconds upbytes downbytes totalbytes);
303 my($self, $cust_pkg, %opt) = @_;
304 warn " resetting usage counters" if defined($opt{debug}) && $opt{debug} > 1;
305 my %values = $self->usage_valuehash;
306 if ($self->option('usage_rollover', 1)) {
307 $cust_pkg->recharge(\%values);
309 $cust_pkg->set_usage(\%values, %opt);