1 package FS::cust_bill_ApplicationCommon;
4 use vars qw( @ISA $DEBUG $me $skip_apply_to_lineitems_hack );
5 use List::Util qw(min);
6 use FS::Schema qw( dbdef );
7 use FS::Record qw( qsearch qsearchs dbh );
9 @ISA = qw( FS::Record );
12 $me = '[FS::cust_bill_ApplicationCommon]';
14 $skip_apply_to_lineitems_hack = 0;
18 FS::cust_bill_ApplicationCommon - Base class for bill application classes
22 use FS::cust_bill_ApplicationCommon;
24 @ISA = qw( FS::cust_bill_ApplicationCommon );
26 sub _app_source_name { 'payment'; }
27 sub _app_source_table { 'cust_pay'; }
28 sub _app_lineitem_breakdown_table { 'cust_bill_pay_pkg'; }
32 FS::cust_bill_ApplicationCommon is intended as a base class for classes which
33 represent application of things to invoices, currently payments
34 (see L<FS::cust_bill_pay>) or credits (see L<FS::cust_credit_bill>).
47 local $SIG{HUP} = 'IGNORE';
48 local $SIG{INT} = 'IGNORE';
49 local $SIG{QUIT} = 'IGNORE';
50 local $SIG{TERM} = 'IGNORE';
51 local $SIG{TSTP} = 'IGNORE';
52 local $SIG{PIPE} = 'IGNORE';
54 my $oldAutoCommit = $FS::UID::AutoCommit;
55 local $FS::UID::AutoCommit = 0;
58 my $error = $self->SUPER::insert(@_)
59 || $self->apply_to_lineitems(@_);
61 $dbh->rollback if $oldAutoCommit;
65 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
78 local $SIG{HUP} = 'IGNORE';
79 local $SIG{INT} = 'IGNORE';
80 local $SIG{QUIT} = 'IGNORE';
81 local $SIG{TERM} = 'IGNORE';
82 local $SIG{TSTP} = 'IGNORE';
83 local $SIG{PIPE} = 'IGNORE';
85 my $oldAutoCommit = $FS::UID::AutoCommit;
86 local $FS::UID::AutoCommit = 0;
89 foreach my $app ( $self->lineitem_applications ) {
90 my $error = $app->delete;
92 $dbh->rollback if $oldAutoCommit;
97 my $error = $self->SUPER::delete(@_);
99 $dbh->rollback if $oldAutoCommit;
103 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
109 =item apply_to_lineitems
111 Auto-applies this invoice application to specific line items, if possible.
115 sub apply_to_lineitems {
117 my( $self, %options ) = @_;
119 return '' if $skip_apply_to_lineitems_hack;
123 my $conf = new FS::Conf;
125 local $SIG{HUP} = 'IGNORE';
126 local $SIG{INT} = 'IGNORE';
127 local $SIG{QUIT} = 'IGNORE';
128 local $SIG{TERM} = 'IGNORE';
129 local $SIG{TSTP} = 'IGNORE';
130 local $SIG{PIPE} = 'IGNORE';
132 my $oldAutoCommit = $FS::UID::AutoCommit;
133 local $FS::UID::AutoCommit = 0;
136 my @open = $self->cust_bill->open_cust_bill_pkg; #FOR UPDATE...?
137 @open = grep { $_->pkgnum == $self->pkgnum } @open
138 if $conf->exists('pkg-balances') && $self->pkgnum;
139 warn "$me ". scalar(@open). " open line items for invoice ".
140 $self->cust_bill->invnum. ": ". join(', ', @open). "\n"
143 $total += $_->setup + $_->recur foreach @open;
144 $total = sprintf('%.2f', $total);
146 if ( $self->amount > $total ) {
147 $dbh->rollback if $oldAutoCommit;
148 return "Can't apply a ". $self->_app_source_name. ' of $'. $self->amount.
149 " greater than the remaining owed on line items (\$$total)";
153 # - one lineitem (a simple special case of:)
154 # - amount is for whole invoice (well, all of remaining lineitem links)
155 if ( $self->amount == $total ) {
157 warn "$me application amount covers remaining balance of invoice in full;".
158 "applying to those lineitems\n"
161 #@apply = map { [ $_, $_->amount ]; } @open;
162 @apply = map { [ $_, $_->setup || $_->recur ]; } @open;
166 #slightly magic case:
167 # - amount exactly and uniquely matches a single open lineitem
168 # (you must be trying to pay or credit that item, then)
170 my @same = grep { $_->setup == $self->amount
171 || $_->recur == $self->amount
174 if ( scalar(@same) == 1 ) {
175 warn "$me application amount exactly and uniquely matches one lineitem;".
176 " applying to that lineitem\n"
178 @apply = map { [ $_, $self->amount ]; } @same
185 warn "$me applying amount based on package weights\n"
189 # - apply based on weights...
191 my $weight_col = $self->_app_part_pkg_weight_column;
192 my @openweight = map {
194 my $cust_pkg = $open->cust_pkg;
197 ? ( $cust_pkg->part_pkg->$weight_col() || 0 )
198 : 0; #default or per-tax weight?
204 my @weights = sort { $b <=> $a } # highest weight first
205 grep { ! $saw{$_}++ } # want a list of unique weights
209 my $remaining_amount = $self->amount;
210 foreach my $weight ( @weights ) {
212 #i hate it when my schwartz gets tangled
213 my @items = map { $_->[0] } grep { $weight == $_->[1] } @openweight;
216 foreach my $item (@items) { $itemtotal += $item->setup || $item->recur; }
217 my $applytotal = min( $itemtotal, $remaining_amount );
218 $remaining_amount -= $applytotal;
220 warn "$me applying $applytotal ($remaining_amount remaining)".
221 " to ". scalar(@items). " lineitems with weight $weight\n"
224 #if some items are less than applytotal/num_items, then apply then in full
229 #no, not sprintf("%.2f",
230 # we want this rounded DOWN for purposes of checking for line items
231 # less than it, we don't want .66666 becoming .67 and causing this
232 # to trigger when it shouldn't
233 my $applyeach = int( 100 * $applytotal / scalar(@items) ) / 100;
236 foreach my $item ( @items ) {
237 my $itemamount = $item->setup || $item->recur;
238 if ( $itemamount < $applyeach ) {
239 warn "$me applying full $itemamount".
240 " to small line item (cust_bill_pkg ". $item->billpkgnum. ")\n"
242 push @apply, [ $item, $itemamount ];
243 $applytotal -= $itemamount;
246 push @newitems, $item;
251 } while ( $lessflag );
253 #and now that we've fallen out of the loop, distribute the rest equally...
255 # should cust_bill_pay_pkg and cust_credit_bill_pkg amount columns
256 # become real instead of numeric(10,2) ??? no..
257 my $applyeach = sprintf("%.2f", $applytotal / scalar(@items) );
259 my @equi_apply = map { [ $_, $applyeach ] } @items;
261 # or should we futz with pennies instead? yes, bah!
263 sprintf('%.0f', 100 * ( $applytotal - $applyeach * scalar(@items) ) );
264 $diff = 0 if $diff eq '-0'; #yay ieee fp
265 if ( abs($diff) > scalar(@items) ) {
266 #we must have done something really wrong, the difference is more than
268 $dbh->rollback if $oldAutoCommit;
269 return 'Error distributing pennies applying '. $self->_app_source_name.
270 " - can't distribute difference of $diff pennies".
271 ' among '. scalar(@items). ' line items';
274 warn "$me futzing with $diff pennies difference\n"
278 while ( $diff != 0 && $futz < scalar(@equi_apply) ) {
280 $equi_apply[$futz++]->[1] += .01;
282 } elsif ( $diff < 0 ) {
283 $equi_apply[$futz++]->[1] -= .01;
286 die "guru exception #5 (in fortran tongue the answer)";
290 if ( sprintf('%.0f', $diff ) ) {
291 $dbh->rollback if $oldAutoCommit;
292 return "couldn't futz with pennies enough: still $diff left";
296 warn "$me applying ". $_->[1].
297 " to line item (cust_bill_pkg ". $_->[0]->billpkgnum. ")\n"
302 push @apply, @equi_apply;
304 #$remaining_amount -= $applytotal;
305 last unless $remaining_amount;
311 # do the applicaiton(s)
312 my $table = $self->lineitem_breakdown_table;
313 my $source_key = dbdef->table($self->table)->primary_key;
315 foreach my $apply ( @apply ) {
316 my ( $cust_bill_pkg, $amount ) = @$apply;
318 my $application = "FS::$table"->new( {
319 $source_key => $self->$source_key(),
320 'billpkgnum' => $cust_bill_pkg->billpkgnum,
321 'amount' => sprintf('%.2f', $amount),
322 'setuprecur' => ( $cust_bill_pkg->setup > 0 ? 'setup' : 'recur' ),
323 'sdate' => $cust_bill_pkg->sdate,
324 'edate' => $cust_bill_pkg->edate,
326 my $error = $application->insert(%options);
328 $dbh->rollback if $oldAutoCommit;
333 #everything should always be applied to line items in full now... sanity check
334 $applied = sprintf('%.2f', $applied);
335 unless ( $applied == $self->amount ) {
336 $dbh->rollback if $oldAutoCommit;
337 return 'Error applying '. $self->_app_source_name. ' of $'. $self->amount.
338 ' to line items - only $'. $applied. ' was applied.';
341 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
346 =item lineitem_applications
348 Returns all the specific line item applications for this invoice application.
352 sub lineitem_applications {
354 my $primary_key = dbdef->table($self->table)->primary_key;
356 'table' => $self->lineitem_breakdown_table,
357 'hashref' => { $primary_key => $self->$primary_key() },
364 Returns the invoice (see L<FS::cust_bill>)
370 qsearchs( 'cust_bill', { 'invnum' => $self->invnum } );
373 =item applied_to_invoice
375 Returns a string representing the invoice (see L<FS::cust_bill>), for example:
376 "applied to Invoice #54 (3/20/2008)"
380 sub applied_to_invoice {
382 'applied to '. $self->cust_bill->invnum_date_pretty;
385 =item lineitem_breakdown_table
389 sub lineitem_breakdown_table {
391 $self->_load_table($self->_app_lineitem_breakdown_table);
395 my( $self, $table ) = @_;
396 eval "use FS::$table";
407 L<FS::cust_bill_pay> and L<FS::cust_bill_pay_pkg>,
408 L<FS::cust_credit_bill> and L<FS::cust_credit_bill_pkg>