1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
package FS::cust_main::Billing_Discount;
use strict;
use vars qw( $DEBUG $me );
use FS::Record qw( qsearch ); #qsearchs );
use FS::cust_pkg;
# 1 is mostly method/subroutine entry and options
# 2 traces progress of some operations
# 3 is even more information including possibly sensitive data
$DEBUG = 0;
$me = '[FS::cust_main::Billing_Discount]';
=head1 NAME
FS::cust_main::Billing_Discount - Billing discount mixin for cust_main
=head1 SYNOPSIS
=head1 DESCRIPTION
These methods are available on FS::cust_main objects.
=head1 METHODS
=over 4
=item _discount_pkg_and_bill
=cut
sub _discount_pkgs_and_bill {
my $self = shift;
my @cust_bill = $self->cust_bill;
my $cust_bill = pop @cust_bill;
return () unless $cust_bill && $cust_bill->owed;
my @where = ();
push @where, "cust_bill_pkg.invnum = ". $cust_bill->invnum;
push @where, "cust_bill_pkg.pkgpart_override IS NULL";
push @where, "part_pkg.freq = '1'";
push @where, "(cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0)";
push @where, "(cust_pkg.susp IS NULL OR cust_pkg.susp = 0)";
push @where, "EXISTS( SELECT 1 FROM part_pkg_discount
WHERE part_pkg.pkgpart = part_pkg_discount.pkgpart )";
push @where,
"NOT EXISTS (
SELECT 1 FROM cust_bill_pkg_discount
WHERE cust_bill_pkg.billpkgnum = cust_bill_pkg_discount.billpkgnum
)";
my $extra_sql = 'WHERE '. join(' AND ', @where);
my @cust_pkg =
qsearch({
'table' => 'cust_pkg',
'select' => "DISTINCT cust_pkg.*",
'addl_from' => 'JOIN cust_bill_pkg USING(pkgnum) '.
'JOIN part_pkg USING(pkgpart)',
'hashref' => {},
'extra_sql' => $extra_sql,
});
($cust_bill, @cust_pkg);
}
=item _discountable_pkgs_at_term
=cut
#this isn't even a method
sub _discountable_pkgs_at_term {
my ($term, @pkgs) = @_;
my $part_pkg = new FS::part_pkg { freq => $term - 1 };
grep { ( !$_->adjourn || $_->adjourn > $part_pkg->add_freq($_->bill) ) &&
( !$_->expire || $_->expire > $part_pkg->add_freq($_->bill) )
}
@pkgs;
}
=item discount_terms
Returns a list of lengths for term discounts
=cut
sub discount_terms {
my $self = shift;
my %terms = ();
my @discount_pkgs = $self->_discount_pkgs_and_bill;
shift @discount_pkgs; #discard bill;
# convert @discount_pkgs (the list of packages that have available discounts)
# to a list of distinct term lengths in months, and strip any decimal places
# from the number of months, not that it should have any
map { $terms{sprintf('%.0f', $_->months)} = 1 }
grep { $_->months && $_->months > 1 }
map { $_->discount }
map { $_->part_pkg->part_pkg_discount }
@discount_pkgs;
return sort { $a <=> $b } keys %terms;
}
=item discount_term_values MONTHS
Returns a list with credit, dollar amount saved, and total bill acheived
by prepaying the most recent invoice for MONTHS.
=cut
# XXX this should work by creating a quotation; then we can finally retire
# the "no_commit" option, which doesn't work with modern tax calculation
sub discount_term_values {
my $self = shift;
my $term = shift;
local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
warn "$me discount_term_values called with $term\n" if $DEBUG;
my %result = ();
my @packages = $self->_discount_pkgs_and_bill;
my $cust_bill = shift(@packages);
@packages = _discountable_pkgs_at_term( $term, @packages );
return () unless scalar(@packages);
$_->bill($_->last_bill) foreach @packages;
my @final = map { new FS::cust_pkg { $_->hash } } @packages;
my %options = (
'recurring_only' => 1,
'no_usage_reset' => 1,
'no_commit' => 1,
);
my %params = (
'return_bill' => [],
'pkg_list' => \@packages,
'time' => $cust_bill->_date,
);
my $error = $self->bill(%options, %params);
die $error if $error; # XXX think about this a bit more
my $credit = 0;
$credit += $_->charged foreach @{$params{return_bill}};
$credit = sprintf('%.2f', $credit);
warn "$me discount_term_values $term credit: $credit\n" if $DEBUG;
%params = (
'return_bill' => [],
'pkg_list' => \@packages,
'time' => $packages[0]->part_pkg->add_freq($cust_bill->_date)
);
$error = $self->bill(%options, %params);
die $error if $error; # XXX think about this a bit more
my $next = 0;
$next += $_->charged foreach @{$params{return_bill}};
warn "$me discount_term_values $term next: $next\n" if $DEBUG;
%params = (
'return_bill' => [],
'pkg_list' => \@final,
'time' => $cust_bill->_date,
'freq_override' => $term,
);
$error = $self->bill(%options, %params);
die $error if $error; # XXX think about this a bit more
my $final = $self->balance - $credit;
$final += $_->charged foreach @{$params{return_bill}};
$final = sprintf('%.2f', $final);
warn "$me discount_term_values $term final: $final\n" if $DEBUG;
my $savings = sprintf('%.2f', $self->balance + ($term - 1) * $next - $final);
( $credit, $savings, $final );
}
sub discount_terms_hash {
my $self = shift;
my %result = ();
my @terms = $self->discount_terms;
foreach my $term (@terms) {
my @result = $self->discount_term_values($term);
$result{$term} = [ @result ] if scalar(@result);
}
return %result;
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::cust_main>, L<FS::cust_main::Billing>
=cut
1;
|
