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 );
10 use FS::cust_bill_pkg;
14 @ISA = qw( FS::Record );
17 $me = '[FS::cust_bill_ApplicationCommon]';
19 $skip_apply_to_lineitems_hack = 0;
23 FS::cust_bill_ApplicationCommon - Base class for bill application classes
27 use FS::cust_bill_ApplicationCommon;
29 @ISA = qw( FS::cust_bill_ApplicationCommon );
31 sub _app_source_name { 'payment'; }
32 sub _app_source_table { 'cust_pay'; }
33 sub _app_lineitem_breakdown_table { 'cust_bill_pay_pkg'; }
37 FS::cust_bill_ApplicationCommon is intended as a base class for classes which
38 represent application of things to invoices, currently payments
39 (see L<FS::cust_bill_pay>) or credits (see L<FS::cust_credit_bill>).
52 local $SIG{HUP} = 'IGNORE';
53 local $SIG{INT} = 'IGNORE';
54 local $SIG{QUIT} = 'IGNORE';
55 local $SIG{TERM} = 'IGNORE';
56 local $SIG{TSTP} = 'IGNORE';
57 local $SIG{PIPE} = 'IGNORE';
59 my $oldAutoCommit = $FS::UID::AutoCommit;
60 local $FS::UID::AutoCommit = 0;
63 my $error = $self->SUPER::insert(@_)
64 || $self->apply_to_lineitems(@_);
66 $dbh->rollback if $oldAutoCommit;
70 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
83 local $SIG{HUP} = 'IGNORE';
84 local $SIG{INT} = 'IGNORE';
85 local $SIG{QUIT} = 'IGNORE';
86 local $SIG{TERM} = 'IGNORE';
87 local $SIG{TSTP} = 'IGNORE';
88 local $SIG{PIPE} = 'IGNORE';
90 my $oldAutoCommit = $FS::UID::AutoCommit;
91 local $FS::UID::AutoCommit = 0;
94 foreach my $app ( $self->lineitem_applications ) {
95 my $error = $app->delete;
97 $dbh->rollback if $oldAutoCommit;
102 my $error = $self->SUPER::delete(@_);
104 $dbh->rollback if $oldAutoCommit;
108 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
114 =item apply_to_lineitems
116 Auto-applies this invoice application to specific line items, if possible.
120 sub apply_to_lineitems {
122 my( $self, %options ) = @_;
124 return '' if $skip_apply_to_lineitems_hack;
128 my $conf = new FS::Conf;
130 local $SIG{HUP} = 'IGNORE';
131 local $SIG{INT} = 'IGNORE';
132 local $SIG{QUIT} = 'IGNORE';
133 local $SIG{TERM} = 'IGNORE';
134 local $SIG{TSTP} = 'IGNORE';
135 local $SIG{PIPE} = 'IGNORE';
137 my $oldAutoCommit = $FS::UID::AutoCommit;
138 local $FS::UID::AutoCommit = 0;
141 my @open = $self->cust_bill->open_cust_bill_pkg; #FOR UPDATE...?
142 @open = grep { $_->pkgnum == $self->pkgnum } @open
143 if $conf->exists('pkg-balances') && $self->pkgnum;
144 warn "$me ". scalar(@open). " open line items for invoice ".
145 $self->cust_bill->invnum. ": ". join(', ', @open). "\n"
148 $total += $_->setup + $_->recur foreach @open;
149 $total = sprintf('%.2f', $total);
151 if ( $self->amount > $total ) {
152 $dbh->rollback if $oldAutoCommit;
153 return "Can't apply a ". $self->_app_source_name. ' of $'. $self->amount.
154 " greater than the remaining owed on line items (\$$total)";
158 # - one lineitem (a simple special case of:)
159 # - amount is for whole invoice (well, all of remaining lineitem links)
160 if ( $self->amount == $total ) {
162 warn "$me application amount covers remaining balance of invoice in full;".
163 "applying to those lineitems\n"
166 #@apply = map { [ $_, $_->amount ]; } @open;
167 @apply = map { [ $_, $_->setup || $_->recur ]; } @open;
171 #slightly magic case:
172 # - amount exactly and uniquely matches a single open lineitem
173 # (you must be trying to pay or credit that item, then)
175 my @same = grep { $_->setup == $self->amount
176 || $_->recur == $self->amount
179 if ( scalar(@same) == 1 ) {
180 warn "$me application amount exactly and uniquely matches one lineitem;".
181 " applying to that lineitem\n"
183 @apply = map { [ $_, $self->amount ]; } @same
190 warn "$me applying amount based on package weights\n"
194 # - apply based on weights...
196 my $weight_col = $self->_app_part_pkg_weight_column;
197 my @openweight = map {
199 my $cust_pkg = $open->cust_pkg;
202 ? ( $cust_pkg->part_pkg->$weight_col() || 0 )
203 : 0; #default or per-tax weight?
209 my @weights = sort { $b <=> $a } # highest weight first
210 grep { ! $saw{$_}++ } # want a list of unique weights
214 my $remaining_amount = $self->amount;
215 foreach my $weight ( @weights ) {
217 #i hate it when my schwartz gets tangled
218 my @items = map { $_->[0] } grep { $weight == $_->[1] } @openweight;
221 foreach my $item (@items) { $itemtotal += $item->setup || $item->recur; }
222 my $applytotal = min( $itemtotal, $remaining_amount );
223 $remaining_amount -= $applytotal;
225 warn "$me applying $applytotal ($remaining_amount remaining)".
226 " to ". scalar(@items). " lineitems with weight $weight\n"
229 #if some items are less than applytotal/num_items, then apply then in full
234 #no, not sprintf("%.2f",
235 # we want this rounded DOWN for purposes of checking for line items
236 # less than it, we don't want .66666 becoming .67 and causing this
237 # to trigger when it shouldn't
238 my $applyeach = int( 100 * $applytotal / scalar(@items) ) / 100;
241 foreach my $item ( @items ) {
242 my $itemamount = $item->setup || $item->recur;
243 if ( $itemamount < $applyeach ) {
244 warn "$me applying full $itemamount".
245 " to small line item (cust_bill_pkg ". $item->billpkgnum. ")\n"
247 push @apply, [ $item, $itemamount ];
248 $applytotal -= $itemamount;
251 push @newitems, $item;
256 } while ( $lessflag && @items );
260 #and now that we've fallen out of the loop, distribute the rest equally
262 # should cust_bill_pay_pkg and cust_credit_bill_pkg amount columns
263 # become real instead of numeric(10,2) ??? no..
264 my $applyeach = sprintf("%.2f", $applytotal / scalar(@items) );
266 my @equi_apply = map { [ $_, $applyeach ] } @items;
268 # or should we futz with pennies instead? yes, bah!
270 sprintf('%.0f', 100 * ( $applytotal - $applyeach * scalar(@items) ) );
271 $diff = 0 if $diff eq '-0'; #yay ieee fp
272 if ( abs($diff) > scalar(@items) ) {
273 #we must have done something really wrong, the difference is more than
275 $dbh->rollback if $oldAutoCommit;
276 return 'Error distributing pennies applying '.$self->_app_source_name.
277 " - can't distribute difference of $diff pennies".
278 ' among '. scalar(@items). ' line items';
281 warn "$me futzing with $diff pennies difference\n"
285 while ( $diff != 0 && $futz < scalar(@equi_apply) ) {
287 $equi_apply[$futz++]->[1] += .01;
289 } elsif ( $diff < 0 ) {
290 $equi_apply[$futz++]->[1] -= .01;
293 die "guru exception #5 (in fortran tongue the answer)";
297 if ( sprintf('%.0f', $diff ) ) {
298 $dbh->rollback if $oldAutoCommit;
299 return "couldn't futz with pennies enough: still $diff left";
303 warn "$me applying ". $_->[1].
304 " to line item (cust_bill_pkg ". $_->[0]->billpkgnum. ")\n"
307 push @apply, @equi_apply;
311 #$remaining_amount -= $applytotal;
312 last unless $remaining_amount;
318 # do the applicaiton(s)
319 my $table = $self->lineitem_breakdown_table;
320 my $source_key = dbdef->table($self->table)->primary_key;
322 foreach my $apply ( @apply ) {
323 my ( $cust_bill_pkg, $amount ) = @$apply;
325 my $application = "FS::$table"->new( {
326 $source_key => $self->$source_key(),
327 'billpkgnum' => $cust_bill_pkg->billpkgnum,
328 'amount' => sprintf('%.2f', $amount),
329 'setuprecur' => ( $cust_bill_pkg->setup > 0 ? 'setup' : 'recur' ),
330 'sdate' => $cust_bill_pkg->sdate,
331 'edate' => $cust_bill_pkg->edate,
333 my $error = $application->insert(%options);
335 $dbh->rollback if $oldAutoCommit;
339 # trigger export_insert_on_payment
340 if ( $conf->exists('trigger_export_insert_on_payment')
341 && $cust_bill_pkg->pkgnum > 0 )
343 if ( my $cust_pkg = $cust_bill_pkg->cust_pkg ) {
345 foreach my $cust_svc ( $cust_pkg->cust_svc ) {
346 my $svc_x = $cust_svc->svc_x;
347 my @part_export = grep { $_->can('_export_insert_on_payment') }
348 $cust_svc->part_svc->part_export;
350 foreach my $part_export ( @part_export ) {
351 $error = $part_export->_export_insert_on_payment($svc_x);
353 $dbh->rollback if $oldAutoCommit;
360 # done trigger export_insert_on_payment
364 #everything should always be applied to line items in full now... sanity check
365 $applied = sprintf('%.2f', $applied);
366 unless ( $applied == $self->amount ) {
367 $dbh->rollback if $oldAutoCommit;
368 return 'Error applying '. $self->_app_source_name. ' of $'. $self->amount.
369 ' to line items - only $'. $applied. ' was applied.';
372 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
377 =item lineitem_applications
379 Returns all the specific line item applications for this invoice application.
383 sub lineitem_applications {
385 my $primary_key = dbdef->table($self->table)->primary_key;
387 'table' => $self->lineitem_breakdown_table,
388 'hashref' => { $primary_key => $self->$primary_key() },
395 Returns the invoice (see L<FS::cust_bill>)
401 qsearchs( 'cust_bill', { 'invnum' => $self->invnum } );
404 =item applied_to_invoice
406 Returns a string representing the invoice (see L<FS::cust_bill>), for example:
407 "applied to Invoice #54 (3/20/2008)"
411 sub applied_to_invoice {
413 'applied to '. $self->cust_bill->invnum_date_pretty;
416 =item lineitem_breakdown_table
420 sub lineitem_breakdown_table {
422 $self->_load_table($self->_app_lineitem_breakdown_table);
426 my( $self, $table ) = @_;
427 eval "use FS::$table";
438 L<FS::cust_bill_pay> and L<FS::cust_bill_pay_pkg>,
439 L<FS::cust_credit_bill> and L<FS::cust_credit_bill_pkg>