FS/FS/cust_main/Billing.pm

   1 package FS::cust_main::Billing;
   2
   3 use strict;
   4 use vars qw( $conf $DEBUG $me );
   5 use Carp;
   6 use Data::Dumper;
   7 use List::Util qw( min );
   8 use FS::UID qw( dbh );
   9 use FS::Record qw( qsearch qsearchs dbdef );
  10 use FS::cust_bill;
  11 use FS::cust_bill_pkg;
  12 use FS::cust_bill_pkg_display;
  13 use FS::cust_bill_pay;
  14 use FS::cust_credit_bill;
  15 use FS::cust_pkg;
  16 use FS::cust_tax_adjustment;
  17 use FS::tax_rate;
  18 use FS::tax_rate_location;
  19 use FS::cust_bill_pkg_tax_location;
  20 use FS::cust_bill_pkg_tax_rate_location;
  21 use FS::part_event;
  22 use FS::part_event_condition;
  23
  24 # 1 is mostly method/subroutine entry and options
  25 # 2 traces progress of some operations
  26 # 3 is even more information including possibly sensitive data
  27 $DEBUG = 0;
  28 $me = '[FS::cust_main::Billing]';
  29
  30 install_callback FS::UID sub {
  31   $conf = new FS::Conf;
  32   #yes, need it for stuff below (prolly should be cached)
  33 };
  34
  35 =head1 NAME
  36
  37 FS::cust_main::Billing - Billing mixin for cust_main
  38
  39 =head1 SYNOPSIS
  40
  41 =head1 DESCRIPTION
  42
  43 These methods are available on FS::cust_main objects.
  44
  45 =head1 METHODS
  46
  47 =over 4
  48
  49 =item bill_and_collect
  50
  51 Cancels and suspends any packages due, generates bills, applies payments and
  52 credits, and applies collection events to run cards, send bills and notices,
  53 etc.
  54
  55 By default, warns on errors and continues with the next operation (but see the
  56 "fatal" flag below).
  57
  58 Options are passed as name-value pairs.  Currently available options are:
  59
  60 =over 4
  61
  62 =item time
  63
  64 Bills the customer as if it were that time.  Specified as a UNIX timestamp; see L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion functions.  For example:
  65
  66  use Date::Parse;
  67  ...
  68  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
  69
  70 =item invoice_time
  71
  72 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices.  Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
  73
  74 =item check_freq
  75
  76 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
  77
  78 =item resetup
  79
  80 If set true, re-charges setup fees.
  81
  82 =item fatal
  83
  84 If set any errors prevent subsequent operations from continusing.  If set
  85 specifically to "return", returns the error (or false, if there is no error).
  86 Any other true value causes errors to die.
  87
  88 =item debug
  89
  90 Debugging level.  Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
  91
  92 =item job
  93
  94 Optional FS::queue entry to receive status updates.
  95
  96 =back
  97
  98 Options are passed to the B<bill> and B<collect> methods verbatim, so all
  99 options of those methods are also available.
 100
 101 =cut
 102
 103 sub bill_and_collect {
 104   my( $self, %options ) = @_;
 105
 106   my $error;
 107
 108   #$options{actual_time} not $options{time} because freeside-daily -d is for
 109   #pre-printing invoices
 110
 111   $options{'actual_time'} ||= time;
 112   my $job = $options{'job'};
 113
 114   $job->update_statustext('0,cleaning expired packages') if $job;
 115   $error = $self->cancel_expired_pkgs( $options{actual_time} );
 116   if ( $error ) {
 117     $error = "Error expiring custnum ". $self->custnum. ": $error";
 118     if    ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
 119     elsif ( $options{fatal}                                ) { die    $error; }
 120     else                                                     { warn   $error; }
 121   }
 122
 123   $error = $self->suspend_adjourned_pkgs( $options{actual_time} );
 124   if ( $error ) {
 125     $error = "Error adjourning custnum ". $self->custnum. ": $error";
 126     if    ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
 127     elsif ( $options{fatal}                                ) { die    $error; }
 128     else                                                     { warn   $error; }
 129   }
 130
 131   $job->update_statustext('20,billing packages') if $job;
 132   $error = $self->bill( %options );
 133   if ( $error ) {
 134     $error = "Error billing custnum ". $self->custnum. ": $error";
 135     if    ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
 136     elsif ( $options{fatal}                                ) { die    $error; }
 137     else                                                     { warn   $error; }
 138   }
 139
 140   $job->update_statustext('50,applying payments and credits') if $job;
 141   $error = $self->apply_payments_and_credits;
 142   if ( $error ) {
 143     $error = "Error applying custnum ". $self->custnum. ": $error";
 144     if    ( $options{fatal} && $options{fatal} eq 'return' ) { return $error; }
 145     elsif ( $options{fatal}                                ) { die    $error; }
 146     else                                                     { warn   $error; }
 147   }
 148
 149   $job->update_statustext('70,running collection events') if $job;
 150   unless ( $conf->exists('cancelled_cust-noevents')
 151            && ! $self->num_ncancelled_pkgs
 152   ) {
 153     $error = $self->collect( %options );
 154     if ( $error ) {
 155       $error = "Error collecting custnum ". $self->custnum. ": $error";
 156       if    ($options{fatal} && $options{fatal} eq 'return') { return $error; }
 157       elsif ($options{fatal}                               ) { die    $error; }
 158       else                                                   { warn   $error; }
 159     }
 160   }
 161   $job->update_statustext('100,finished') if $job;
 162
 163   '';
 164
 165 }
 166
 167 sub cancel_expired_pkgs {
 168   my ( $self, $time, %options ) = @_;
 169
 170   my @cancel_pkgs = $self->ncancelled_pkgs( {
 171     'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
 172   } );
 173
 174   my @errors = ();
 175
 176   foreach my $cust_pkg ( @cancel_pkgs ) {
 177     my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
 178     my $error = $cust_pkg->cancel($cpr ? ( 'reason'        => $cpr->reasonnum,
 179                                            'reason_otaker' => $cpr->otaker
 180                                          )
 181                                        : ()
 182                                  );
 183     push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
 184   }
 185
 186   scalar(@errors) ? join(' / ', @errors) : '';
 187
 188 }
 189
 190 sub suspend_adjourned_pkgs {
 191   my ( $self, $time, %options ) = @_;
 192
 193   my @susp_pkgs = $self->ncancelled_pkgs( {
 194     'extra_sql' =>
 195       " AND ( susp IS NULL OR susp = 0 )
 196         AND (    ( bill    IS NOT NULL AND bill    != 0 AND bill    <  $time )
 197               OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
 198             )
 199       ",
 200   } );
 201
 202   #only because there's no SQL test for is_prepaid :/
 203   @susp_pkgs =
 204     grep {     (    $_->part_pkg->is_prepaid
 205                  && $_->bill
 206                  && $_->bill < $time
 207                )
 208             || (    $_->adjourn
 209                  && $_->adjourn <= $time
 210                )
 211
 212          }
 213          @susp_pkgs;
 214
 215   my @errors = ();
 216
 217   foreach my $cust_pkg ( @susp_pkgs ) {
 218     my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
 219       if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
 220     my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
 221                                             'reason_otaker' => $cpr->otaker
 222                                           )
 223                                         : ()
 224                                   );
 225     push @errors, 'pkgnum '.$cust_pkg->pkgnum.": $error" if $error;
 226   }
 227
 228   scalar(@errors) ? join(' / ', @errors) : '';
 229
 230 }
 231
 232 =item bill OPTIONS
 233
 234 Generates invoices (see L<FS::cust_bill>) for this customer.  Usually used in
 235 conjunction with the collect method by calling B<bill_and_collect>.
 236
 237 If there is an error, returns the error, otherwise returns false.
 238
 239 Options are passed as name-value pairs.  Currently available options are:
 240
 241 =over 4
 242
 243 =item resetup
 244
 245 If set true, re-charges setup fees.
 246
 247 =item recurring_only
 248
 249 If set true then only bill recurring charges, not setup, usage, one time
 250 charges, etc.
 251
 252 =item freq_override
 253
 254 If set, then override the normal frequency and look for a part_pkg_discount
 255 to take at that frequency.
 256
 257 =item time
 258
 259 Bills the customer as if it were that time.  Specified as a UNIX timestamp; see L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion functions.  For example:
 260
 261  use Date::Parse;
 262  ...
 263  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
 264
 265 =item pkg_list
 266
 267 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
 268
 269  $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
 270
 271 =item not_pkgpart
 272
 273 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
 274
 275 =item invoice_time
 276
 277 Used in conjunction with the I<time> option, this option specifies the date of for the generated invoices.  Other calculations, such as whether or not to generate the invoice in the first place, are not affected.
 278
 279 =item cancel
 280
 281 This boolean value informs the us that the package is being cancelled.  This
 282 typically might mean not charging the normal recurring fee but only usage
 283 fees since the last billing. Setup charges may be charged.  Not all package
 284 plans support this feature (they tend to charge 0).
 285
 286 =item no_usage_reset
 287
 288 Prevent the resetting of usage limits during this call.
 289
 290 =item no_commit
 291
 292 Do not save the generated bill in the database.  Useful with return_bill
 293
 294 =item return_bill
 295
 296 A list reference on which the generated bill(s) will be returned.
 297
 298 =item invoice_terms
 299
 300 Optional terms to be printed on this invoice.  Otherwise, customer-specific
 301 terms or the default terms are used.
 302
 303 =back
 304
 305 =cut
 306
 307 sub bill {
 308   my( $self, %options ) = @_;
 309
 310   return '' if $self->payby eq 'COMP';
 311
 312   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
 313
 314   warn "$me bill customer ". $self->custnum. "\n"
 315     if $DEBUG;
 316
 317   my $time = $options{'time'} || time;
 318   my $invoice_time = $options{'invoice_time'} || $time;
 319
 320   $options{'not_pkgpart'} ||= {};
 321   $options{'not_pkgpart'} = { map { $_ => 1 }
 322                                   split(/\s*,\s*/, $options{'not_pkgpart'})
 323                             }
 324     unless ref($options{'not_pkgpart'});
 325
 326   local $SIG{HUP} = 'IGNORE';
 327   local $SIG{INT} = 'IGNORE';
 328   local $SIG{QUIT} = 'IGNORE';
 329   local $SIG{TERM} = 'IGNORE';
 330   local $SIG{TSTP} = 'IGNORE';
 331   local $SIG{PIPE} = 'IGNORE';
 332
 333   my $oldAutoCommit = $FS::UID::AutoCommit;
 334   local $FS::UID::AutoCommit = 0;
 335   my $dbh = dbh;
 336
 337   warn "$me acquiring lock on customer ". $self->custnum. "\n"
 338     if $DEBUG;
 339
 340   $self->select_for_update; #mutex
 341
 342   warn "$me running pre-bill events for customer ". $self->custnum. "\n"
 343     if $DEBUG;
 344
 345   my $error = $self->do_cust_event(
 346     'debug'      => ( $options{'debug'} || 0 ),
 347     'time'       => $invoice_time,
 348     'check_freq' => $options{'check_freq'},
 349     'stage'      => 'pre-bill',
 350   )
 351     unless $options{no_commit};
 352   if ( $error ) {
 353     $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 354     return $error;
 355   }
 356
 357   warn "$me done running pre-bill events for customer ". $self->custnum. "\n"
 358     if $DEBUG;
 359
 360   #keep auto-charge and non-auto-charge line items separate
 361   my @passes = ( '', 'no_auto' );
 362
 363   my %cust_bill_pkg = map { $_ => [] } @passes;
 364
 365   ###
 366   # find the packages which are due for billing, find out how much they are
 367   # & generate invoice database.
 368   ###
 369
 370   my %total_setup   = map { my $z = 0; $_ => \$z; } @passes;
 371   my %total_recur   = map { my $z = 0; $_ => \$z; } @passes;
 372
 373   my %taxlisthash = map { $_ => {} } @passes;
 374
 375   my @precommit_hooks = ();
 376
 377   $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ];  #param checks?
 378   foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
 379
 380     next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
 381
 382     warn "  bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
 383
 384     #? to avoid use of uninitialized value errors... ?
 385     $cust_pkg->setfield('bill', '')
 386       unless defined($cust_pkg->bill);
 387
 388     #my $part_pkg = $cust_pkg->part_pkg;
 389
 390     my $real_pkgpart = $cust_pkg->pkgpart;
 391     my %hash = $cust_pkg->hash;
 392
 393     # we could implement this bit as FS::part_pkg::has_hidden, but we already
 394     # suffer from performance issues
 395     $options{has_hidden} = 0;
 396     my @part_pkg = $cust_pkg->part_pkg->self_and_bill_linked;
 397     $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
 398
 399     foreach my $part_pkg ( @part_pkg ) {
 400
 401       $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
 402
 403       my $pass = ($cust_pkg->no_auto || $part_pkg->no_auto) ? 'no_auto' : '';
 404
 405       my $error =
 406         $self->_make_lines( 'part_pkg'            => $part_pkg,
 407                             'cust_pkg'            => $cust_pkg,
 408                             'precommit_hooks'     => \@precommit_hooks,
 409                             'line_items'          => $cust_bill_pkg{$pass},
 410                             'setup'               => $total_setup{$pass},
 411                             'recur'               => $total_recur{$pass},
 412                             'tax_matrix'          => $taxlisthash{$pass},
 413                             'time'                => $time,
 414                             'real_pkgpart'        => $real_pkgpart,
 415                             'options'             => \%options,
 416                           );
 417       if ($error) {
 418         $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 419         return $error;
 420       }
 421
 422     } #foreach my $part_pkg
 423
 424   } #foreach my $cust_pkg
 425
 426   #if the customer isn't on an automatic payby, everything can go on a single
 427   #invoice anyway?
 428   #if ( $cust_main->payby !~ /^(CARD|CHEK)$/ ) {
 429     #merge everything into one list
 430   #}
 431
 432   foreach my $pass (@passes) { # keys %cust_bill_pkg ) {
 433
 434     my @cust_bill_pkg = _omit_zero_value_bundles(@{ $cust_bill_pkg{$pass} });
 435
 436     next unless @cust_bill_pkg; #don't create an invoice w/o line items
 437
 438     warn "$me billing pass $pass\n".
 439            Dumper(\@cust_bill_pkg)."\n"
 440       if $DEBUG > 2;
 441
 442     if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
 443            !$conf->exists('postal_invoice-recurring_only')
 444        )
 445     {
 446
 447       my $postal_pkg = $self->charge_postal_fee();
 448       if ( $postal_pkg && !ref( $postal_pkg ) ) {
 449
 450         $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 451         return "can't charge postal invoice fee for customer ".
 452           $self->custnum. ": $postal_pkg";
 453
 454       } elsif ( $postal_pkg ) {
 455
 456         my $real_pkgpart = $postal_pkg->pkgpart;
 457         # we could implement this bit as FS::part_pkg::has_hidden, but we already
 458         # suffer from performance issues
 459         $options{has_hidden} = 0;
 460         my @part_pkg = $postal_pkg->part_pkg->self_and_bill_linked;
 461         $options{has_hidden} = 1 if ($part_pkg[1] && $part_pkg[1]->hidden);
 462
 463         foreach my $part_pkg ( @part_pkg ) {
 464           my %postal_options = %options;
 465           delete $postal_options{cancel};
 466           my $error =
 467             $self->_make_lines( 'part_pkg'            => $part_pkg,
 468                                 'cust_pkg'            => $postal_pkg,
 469                                 'precommit_hooks'     => \@precommit_hooks,
 470                                 'line_items'          => \@cust_bill_pkg,
 471                                 'setup'               => $total_setup{$pass},
 472                                 'recur'               => $total_recur{$pass},
 473                                 'tax_matrix'          => $taxlisthash{$pass},
 474                                 'time'                => $time,
 475                                 'real_pkgpart'        => $real_pkgpart,
 476                                 'options'             => \%postal_options,
 477                               );
 478           if ($error) {
 479             $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 480             return $error;
 481           }
 482         }
 483
 484         # it's silly to have a zero value postal_pkg, but....
 485         @cust_bill_pkg = _omit_zero_value_bundles(@cust_bill_pkg);
 486
 487       }
 488
 489     }
 490
 491     my $listref_or_error =
 492       $self->calculate_taxes( \@cust_bill_pkg, $taxlisthash{$pass}, $invoice_time);
 493
 494     unless ( ref( $listref_or_error ) ) {
 495       $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 496       return $listref_or_error;
 497     }
 498
 499     foreach my $taxline ( @$listref_or_error ) {
 500       ${ $total_setup{$pass} } =
 501         sprintf('%.2f', ${ $total_setup{$pass} } + $taxline->setup );
 502       push @cust_bill_pkg, $taxline;
 503     }
 504
 505     #add tax adjustments
 506     warn "adding tax adjustments...\n" if $DEBUG > 2;
 507     foreach my $cust_tax_adjustment (
 508       qsearch('cust_tax_adjustment', { 'custnum'    => $self->custnum,
 509                                        'billpkgnum' => '',
 510                                      }
 511              )
 512     ) {
 513
 514       my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
 515
 516       my $itemdesc = $cust_tax_adjustment->taxname;
 517       $itemdesc = '' if $itemdesc eq 'Tax';
 518
 519       push @cust_bill_pkg, new FS::cust_bill_pkg {
 520         'pkgnum'      => 0,
 521         'setup'       => $tax,
 522         'recur'       => 0,
 523         'sdate'       => '',
 524         'edate'       => '',
 525         'itemdesc'    => $itemdesc,
 526         'itemcomment' => $cust_tax_adjustment->comment,
 527         'cust_tax_adjustment' => $cust_tax_adjustment,
 528         #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
 529       };
 530
 531     }
 532
 533     my $charged = sprintf('%.2f', ${ $total_setup{$pass} } + ${ $total_recur{$pass} } );
 534
 535     my @cust_bill = $self->cust_bill;
 536     my $balance = $self->balance;
 537     my $previous_balance = scalar(@cust_bill)
 538                              ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
 539                              : 0;
 540
 541     $previous_balance += $cust_bill[$#cust_bill]->charged
 542       if scalar(@cust_bill);
 543     #my $balance_adjustments =
 544     #  sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
 545
 546     warn "creating the new invoice\n" if $DEBUG;
 547     #create the new invoice
 548     my $cust_bill = new FS::cust_bill ( {
 549       'custnum'             => $self->custnum,
 550       '_date'               => ( $invoice_time ),
 551       'charged'             => $charged,
 552       'billing_balance'     => $balance,
 553       'previous_balance'    => $previous_balance,
 554       'invoice_terms'       => $options{'invoice_terms'},
 555       'cust_bill_pkg'       => \@cust_bill_pkg,
 556     } );
 557     $error = $cust_bill->insert unless $options{no_commit};
 558     if ( $error ) {
 559       $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 560       return "can't create invoice for customer #". $self->custnum. ": $error";
 561     }
 562     push @{$options{return_bill}}, $cust_bill if $options{return_bill};
 563
 564   } #foreach my $pass ( keys %cust_bill_pkg )
 565
 566   foreach my $hook ( @precommit_hooks ) {
 567     eval {
 568       &{$hook}; #($self) ?
 569     } unless $options{no_commit};
 570     if ( $@ ) {
 571       $dbh->rollback if $oldAutoCommit && !$options{no_commit};
 572       return "$@ running precommit hook $hook\n";
 573     }
 574   }
 575
 576   $dbh->commit or die $dbh->errstr if $oldAutoCommit && !$options{no_commit};
 577
 578   ''; #no error
 579 }
 580
 581 #discard bundled packages of 0 value
 582 sub _omit_zero_value_bundles {
 583
 584   my @cust_bill_pkg = ();
 585   my @cust_bill_pkg_bundle = ();
 586   my $sum = 0;
 587
 588   foreach my $cust_bill_pkg ( @_ ) {
 589     if (scalar(@cust_bill_pkg_bundle) && !$cust_bill_pkg->pkgpart_override) {
 590       push @cust_bill_pkg, @cust_bill_pkg_bundle if $sum > 0;
 591       @cust_bill_pkg_bundle = ();
 592       $sum = 0;
 593     }
 594     $sum += $cust_bill_pkg->setup + $cust_bill_pkg->recur;
 595     push @cust_bill_pkg_bundle, $cust_bill_pkg;
 596   }
 597   push @cust_bill_pkg, @cust_bill_pkg_bundle if $sum > 0;
 598
 599   (@cust_bill_pkg);
 600
 601 }
 602
 603 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
 604
 605 This is a weird one.  Perhaps it should not even be exposed.
 606
 607 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
 608 Usually used internally by bill method B<bill>.
 609
 610 If there is an error, returns the error, otherwise returns reference to a
 611 list of line items suitable for insertion.
 612
 613 =over 4
 614
 615 =item LINEITEMREF
 616
 617 An array ref of the line items being billed.
 618
 619 =item TAXHASHREF
 620
 621 A strange beast.  The keys to this hash are internal identifiers consisting
 622 of the name of the tax object type, a space, and its unique identifier ( e.g.
 623  'cust_main_county 23' ).  The values of the hash are listrefs.  The first
 624 item in the list is the tax object.  The remaining items are either line
 625 items or floating point values (currency amounts).
 626
 627 The taxes are calculated on this entity.  Calculated exemption records are
 628 transferred to the LINEITEMREF items on the assumption that they are related.
 629
 630 Read the source.
 631
 632 =item INVOICE_TIME
 633
 634 This specifies the date appearing on the associated invoice.  Some
 635 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
 636
 637 =back
 638
 639 =cut
 640
 641 sub calculate_taxes {
 642   my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
 643
 644   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
 645
 646   warn "$me calculate_taxes\n".
 647        Dumper($self, $cust_bill_pkg, $taxlisthash, $invoice_time). "\n"
 648     if $DEBUG > 2;
 649
 650   my @tax_line_items = ();
 651
 652   # keys are tax names (as printed on invoices / itemdesc )
 653   # values are listrefs of taxlisthash keys (internal identifiers)
 654   my %taxname = ();
 655
 656   # keys are taxlisthash keys (internal identifiers)
 657   # values are (cumulative) amounts
 658   my %tax = ();
 659
 660   # keys are taxlisthash keys (internal identifiers)
 661   # values are listrefs of cust_bill_pkg_tax_location hashrefs
 662   my %tax_location = ();
 663
 664   # keys are taxlisthash keys (internal identifiers)
 665   # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
 666   my %tax_rate_location = ();
 667
 668   foreach my $tax ( keys %$taxlisthash ) {
 669     my $tax_object = shift @{ $taxlisthash->{$tax} };
 670     warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
 671     warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
 672     my $hashref_or_error =
 673       $tax_object->taxline( $taxlisthash->{$tax},
 674                             'custnum'      => $self->custnum,
 675                             'invoice_time' => $invoice_time
 676                           );
 677     return $hashref_or_error unless ref($hashref_or_error);
 678
 679     unshift @{ $taxlisthash->{$tax} }, $tax_object;
 680
 681     my $name   = $hashref_or_error->{'name'};
 682     my $amount = $hashref_or_error->{'amount'};
 683
 684     #warn "adding $amount as $name\n";
 685     $taxname{ $name } ||= [];
 686     push @{ $taxname{ $name } }, $tax;
 687
 688     $tax{ $tax } += $amount;
 689
 690     $tax_location{ $tax } ||= [];
 691     if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
 692       push @{ $tax_location{ $tax }  },
 693         {
 694           'taxnum'      => $tax_object->taxnum,
 695           'taxtype'     => ref($tax_object),
 696           'pkgnum'      => $tax_object->get('pkgnum'),
 697           'locationnum' => $tax_object->get('locationnum'),
 698           'amount'      => sprintf('%.2f', $amount ),
 699         };
 700     }
 701
 702     $tax_rate_location{ $tax } ||= [];
 703     if ( ref($tax_object) eq 'FS::tax_rate' ) {
 704       my $taxratelocationnum =
 705         $tax_object->tax_rate_location->taxratelocationnum;
 706       push @{ $tax_rate_location{ $tax }  },
 707         {
 708           'taxnum'             => $tax_object->taxnum,
 709           'taxtype'            => ref($tax_object),
 710           'amount'             => sprintf('%.2f', $amount ),
 711           'locationtaxid'      => $tax_object->location,
 712           'taxratelocationnum' => $taxratelocationnum,
 713         };
 714     }
 715
 716   }
 717
 718   #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
 719   my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
 720   warn Dumper(\%packagemap) if $DEBUG > 2;
 721   foreach my $tax ( keys %$taxlisthash ) {
 722     foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
 723       next unless ref($_) eq 'FS::cust_bill_pkg';
 724
 725       warn $_->pkgnum."\n" if $DEBUG > 2;
 726       push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
 727         splice( @{ $_->_cust_tax_exempt_pkg } );
 728     }
 729   }
 730
 731   #consolidate and create tax line items
 732   warn "consolidating and generating...\n" if $DEBUG > 2;
 733   foreach my $taxname ( keys %taxname ) {
 734     my $tax = 0;
 735     my %seen = ();
 736     my @cust_bill_pkg_tax_location = ();
 737     my @cust_bill_pkg_tax_rate_location = ();
 738     warn "adding $taxname\n" if $DEBUG > 1;
 739     foreach my $taxitem ( @{ $taxname{$taxname} } ) {
 740       next if $seen{$taxitem}++;
 741       warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
 742       $tax += $tax{$taxitem};
 743       push @cust_bill_pkg_tax_location,
 744         map { new FS::cust_bill_pkg_tax_location $_ }
 745             @{ $tax_location{ $taxitem } };
 746       push @cust_bill_pkg_tax_rate_location,
 747         map { new FS::cust_bill_pkg_tax_rate_location $_ }
 748             @{ $tax_rate_location{ $taxitem } };
 749     }
 750     next unless $tax;
 751
 752     $tax = sprintf('%.2f', $tax );
 753
 754     my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
 755                                                    'disabled'     => '',
 756                                                  },
 757                                );
 758
 759     my @display = ();
 760     if ( $pkg_category and
 761          $conf->config('invoice_latexsummary') ||
 762          $conf->config('invoice_htmlsummary')
 763        )
 764     {
 765
 766       my %hash = (  'section' => $pkg_category->categoryname );
 767       push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
 768
 769     }
 770
 771     push @tax_line_items, new FS::cust_bill_pkg {
 772       'pkgnum'   => 0,
 773       'setup'    => $tax,
 774       'recur'    => 0,
 775       'sdate'    => '',
 776       'edate'    => '',
 777       'itemdesc' => $taxname,
 778       'display'  => \@display,
 779       'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
 780       'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
 781     };
 782
 783   }
 784
 785   \@tax_line_items;
 786 }
 787
 788 sub _make_lines {
 789   my ($self, %params) = @_;
 790
 791   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
 792
 793   my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
 794   my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
 795   my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
 796   my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
 797   my $total_setup = $params{setup} or die "no setup accumulator specified";
 798   my $total_recur = $params{recur} or die "no recur accumulator specified";
 799   my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
 800   my $time = $params{'time'} or die "no time specified";
 801   my (%options) = %{$params{options}};
 802
 803   my $dbh = dbh;
 804   my $real_pkgpart = $params{real_pkgpart};
 805   my %hash = $cust_pkg->hash;
 806   my $old_cust_pkg = new FS::cust_pkg \%hash;
 807
 808   my @details = ();
 809   my @discounts = ();
 810   my $lineitems = 0;
 811
 812   $cust_pkg->pkgpart($part_pkg->pkgpart);
 813
 814   ###
 815   # bill setup
 816   ###
 817
 818   my $setup = 0;
 819   my $unitsetup = 0;
 820   if ( $options{'resetup'}
 821        || ( ! $cust_pkg->setup
 822             && ( ! $cust_pkg->start_date
 823                  || $cust_pkg->start_date <= $time
 824                )
 825             && ( ! $conf->exists('disable_setup_suspended_pkgs')
 826                  || ( $conf->exists('disable_setup_suspended_pkgs') &&
 827                       ! $cust_pkg->getfield('susp')
 828                     )
 829                )
 830           )
 831         and !$options{recurring_only}
 832     )
 833   {
 834
 835     warn "    bill setup\n" if $DEBUG > 1;
 836     $lineitems++;
 837
 838     $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
 839     return "$@ running calc_setup for $cust_pkg\n"
 840       if $@;
 841
 842     $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
 843
 844     $cust_pkg->setfield('setup', $time)
 845       unless $cust_pkg->setup;
 846           #do need it, but it won't get written to the db
 847           #|| $cust_pkg->pkgpart != $real_pkgpart;
 848
 849     $cust_pkg->setfield('start_date', '')
 850       if $cust_pkg->start_date;
 851
 852   }
 853
 854   ###
 855   # bill recurring fee
 856   ###
 857
 858   #XXX unit stuff here too
 859   my $recur = 0;
 860   my $unitrecur = 0;
 861   my $sdate;
 862   if (     ! $cust_pkg->get('susp')
 863        and ! $cust_pkg->get('start_date')
 864        and ( $part_pkg->getfield('freq') ne '0'
 865              && ( $cust_pkg->getfield('bill') || 0 ) <= $time
 866            )
 867         || ( $part_pkg->plan eq 'voip_cdr'
 868               && $part_pkg->option('bill_every_call')
 869            )
 870         || ( $options{cancel} )
 871   ) {
 872
 873     # XXX should this be a package event?  probably.  events are called
 874     # at collection time at the moment, though...
 875     $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
 876       if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
 877       #don't want to reset usage just cause we want a line item??
 878       #&& $part_pkg->pkgpart == $real_pkgpart;
 879
 880     warn "    bill recur\n" if $DEBUG > 1;
 881     $lineitems++;
 882
 883     # XXX shared with $recur_prog
 884     $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
 885              || $cust_pkg->setup
 886              || $time;
 887
 888     #over two params!  lets at least switch to a hashref for the rest...
 889     my $increment_next_bill = ( $part_pkg->freq ne '0'
 890                                 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
 891                                 && !$options{cancel}
 892                               );
 893     my %param = ( 'precommit_hooks'     => $precommit_hooks,
 894                   'increment_next_bill' => $increment_next_bill,
 895                   'discounts'           => \@discounts,
 896                   'real_pkgpart'        => $real_pkgpart,
 897                   'freq_override'       => $options{freq_override} || '',
 898                 );
 899
 900     my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
 901
 902     # There may be some part_pkg for which this is wrong.  Only those
 903     # which can_discount are supported.
 904
 905     $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
 906     return "$@ running $method for $cust_pkg\n"
 907       if ( $@ );
 908
 909     if ( $increment_next_bill ) {
 910
 911       my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
 912       return "unparsable frequency: ". $part_pkg->freq
 913         if $next_bill == -1;
 914
 915       #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
 916       # only for figuring next bill date, nothing else, so, reset $sdate again
 917       # here
 918       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
 919       #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
 920       $cust_pkg->last_bill($sdate);
 921
 922       $cust_pkg->setfield('bill', $next_bill );
 923
 924     }
 925
 926   }
 927
 928   warn "\$setup is undefined" unless defined($setup);
 929   warn "\$recur is undefined" unless defined($recur);
 930   warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
 931
 932   ###
 933   # If there's line items, create em cust_bill_pkg records
 934   # If $cust_pkg has been modified, update it (if we're a real pkgpart)
 935   ###
 936
 937   if ( $lineitems || $options{has_hidden} ) {
 938
 939     if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
 940       # hmm.. and if just the options are modified in some weird price plan?
 941
 942       warn "  package ". $cust_pkg->pkgnum. " modified; updating\n"
 943         if $DEBUG >1;
 944
 945       my $error = $cust_pkg->replace( $old_cust_pkg,
 946                                       'options' => { $cust_pkg->options },
 947                                     )
 948         unless $options{no_commit};
 949       return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
 950         if $error; #just in case
 951     }
 952
 953     $setup = sprintf( "%.2f", $setup );
 954     $recur = sprintf( "%.2f", $recur );
 955     if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
 956       return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
 957     }
 958     if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
 959       return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
 960     }
 961
 962     if ( $setup != 0 ||
 963          $recur != 0 ||
 964          !$part_pkg->hidden && $options{has_hidden} ) #include some $0 lines
 965     {
 966
 967       warn "    charges (setup=$setup, recur=$recur); adding line items\n"
 968         if $DEBUG > 1;
 969
 970       my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
 971       if ( $DEBUG > 1 ) {
 972         warn "      adding customer package invoice detail: $_\n"
 973           foreach @cust_pkg_detail;
 974       }
 975       push @details, @cust_pkg_detail;
 976
 977       my $cust_bill_pkg = new FS::cust_bill_pkg {
 978         'pkgnum'    => $cust_pkg->pkgnum,
 979         'setup'     => $setup,
 980         'unitsetup' => $unitsetup,
 981         'recur'     => $recur,
 982         'unitrecur' => $unitrecur,
 983         'quantity'  => $cust_pkg->quantity,
 984         'details'   => \@details,
 985         'discounts' => \@discounts,
 986         'hidden'    => $part_pkg->hidden,
 987         'freq'      => $part_pkg->freq,
 988       };
 989
 990       if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
 991         $cust_bill_pkg->sdate( $hash{last_bill} );
 992         $cust_bill_pkg->edate( $sdate - 86399   ); #60s*60m*24h-1
 993         $cust_bill_pkg->edate( $time ) if $options{cancel};
 994       } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
 995         $cust_bill_pkg->sdate( $sdate );
 996         $cust_bill_pkg->edate( $cust_pkg->bill );
 997         #$cust_bill_pkg->edate( $time ) if $options{cancel};
 998       }
 999
1000       $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1001         unless $part_pkg->pkgpart == $real_pkgpart;
1002
1003       $$total_setup += $setup;
1004       $$total_recur += $recur;
1005
1006       ###
1007       # handle taxes
1008       ###
1009
1010       my $error =
1011         $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1012       return $error if $error;
1013
1014       push @$cust_bill_pkgs, $cust_bill_pkg;
1015
1016     } #if $setup != 0 || $recur != 0
1017
1018   } #if $line_items
1019
1020   '';
1021
1022 }
1023
1024 sub _handle_taxes {
1025   my $self = shift;
1026   my $part_pkg = shift;
1027   my $taxlisthash = shift;
1028   my $cust_bill_pkg = shift;
1029   my $cust_pkg = shift;
1030   my $invoice_time = shift;
1031   my $real_pkgpart = shift;
1032   my $options = shift;
1033
1034   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1035
1036   my %cust_bill_pkg = ();
1037   my %taxes = ();
1038
1039   my @classes;
1040   #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1041   push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1042   push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1043   push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1044
1045   if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1046
1047     if ( $conf->exists('enable_taxproducts')
1048          && ( scalar($part_pkg->part_pkg_taxoverride)
1049               || $part_pkg->has_taxproduct
1050             )
1051        )
1052     {
1053
1054       if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1055         return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
1056       }
1057
1058       foreach my $class (@classes) {
1059         my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
1060         return $err_or_ref unless ref($err_or_ref);
1061         $taxes{$class} = $err_or_ref;
1062       }
1063
1064       unless (exists $taxes{''}) {
1065         my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
1066         return $err_or_ref unless ref($err_or_ref);
1067         $taxes{''} = $err_or_ref;
1068       }
1069
1070     } else {
1071
1072       my @loc_keys = qw( city county state country );
1073       my %taxhash;
1074       if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1075         my $cust_location = $cust_pkg->cust_location;
1076         %taxhash = map { $_ => $cust_location->$_()    } @loc_keys;
1077       } else {
1078         my $prefix =
1079           ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1080           ? 'ship_'
1081           : '';
1082         %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1083       }
1084
1085       $taxhash{'taxclass'} = $part_pkg->taxclass;
1086
1087       my @taxes = ();
1088       my %taxhash_elim = %taxhash;
1089       my @elim = qw( city county state );
1090       do {
1091
1092         #first try a match with taxclass
1093         @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1094
1095         if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1096           #then try a match without taxclass
1097           my %no_taxclass = %taxhash_elim;
1098           $no_taxclass{ 'taxclass' } = '';
1099           @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1100         }
1101
1102         $taxhash_elim{ shift(@elim) } = '';
1103
1104       } while ( !scalar(@taxes) && scalar(@elim) );
1105
1106       @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1107                     @taxes
1108         if $self->cust_main_exemption; #just to be safe
1109
1110       if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1111         foreach (@taxes) {
1112           $_->set('pkgnum',      $cust_pkg->pkgnum );
1113           $_->set('locationnum', $cust_pkg->locationnum );
1114         }
1115       }
1116
1117       $taxes{''} = [ @taxes ];
1118       $taxes{'setup'} = [ @taxes ];
1119       $taxes{'recur'} = [ @taxes ];
1120       $taxes{$_} = [ @taxes ] foreach (@classes);
1121
1122       # # maybe eliminate this entirely, along with all the 0% records
1123       # unless ( @taxes ) {
1124       #   return
1125       #     "fatal: can't find tax rate for state/county/country/taxclass ".
1126       #     join('/', map $taxhash{$_}, qw(state county country taxclass) );
1127       # }
1128
1129     } #if $conf->exists('enable_taxproducts') ...
1130
1131   }
1132
1133   my @display = ();
1134   my $separate = $conf->exists('separate_usage');
1135   my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
1136   my $usage_mandate = $temp_pkg->part_pkg->option('usage_mandate', 'Hush!');
1137   my $section = $temp_pkg->part_pkg->categoryname;
1138   if ( $separate || $section || $usage_mandate ) {
1139
1140     my %hash = ( 'section' => $section );
1141
1142     $section = $temp_pkg->part_pkg->option('usage_section', 'Hush!');
1143     my $summary = $temp_pkg->part_pkg->option('summarize_usage', 'Hush!');
1144     if ( $separate ) {
1145       push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1146       push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
1147     } else {
1148       push @display, new FS::cust_bill_pkg_display
1149                        { type => '',
1150                          %hash,
1151                          ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
1152                        };
1153     }
1154
1155     if ($separate && $section && $summary) {
1156       push @display, new FS::cust_bill_pkg_display { type    => 'U',
1157                                                      summary => 'Y',
1158                                                      %hash,
1159                                                    };
1160     }
1161     if ($usage_mandate || $section && $summary) {
1162       $hash{post_total} = 'Y';
1163     }
1164
1165     if ($separate || $usage_mandate) {
1166       $hash{section} = $section if ($separate || $usage_mandate);
1167       push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
1168     }
1169
1170   }
1171   $cust_bill_pkg->set('display', \@display);
1172
1173   my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1174   foreach my $key (keys %tax_cust_bill_pkg) {
1175     my @taxes = @{ $taxes{$key} || [] };
1176     my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1177
1178     my %localtaxlisthash = ();
1179     foreach my $tax ( @taxes ) {
1180
1181       my $taxname = ref( $tax ). ' '. $tax->taxnum;
1182 #      $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1183 #                  ' locationnum'. $cust_pkg->locationnum
1184 #        if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1185
1186       $taxlisthash->{ $taxname } ||= [ $tax ];
1187       push @{ $taxlisthash->{ $taxname  } }, $tax_cust_bill_pkg;
1188
1189       $localtaxlisthash{ $taxname } ||= [ $tax ];
1190       push @{ $localtaxlisthash{ $taxname  } }, $tax_cust_bill_pkg;
1191
1192     }
1193
1194     warn "finding taxed taxes...\n" if $DEBUG > 2;
1195     foreach my $tax ( keys %localtaxlisthash ) {
1196       my $tax_object = shift @{ $localtaxlisthash{$tax} };
1197       warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1198         if $DEBUG > 2;
1199       next unless $tax_object->can('tax_on_tax');
1200
1201       foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1202         my $totname = ref( $tot ). ' '. $tot->taxnum;
1203
1204         warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1205           if $DEBUG > 2;
1206         next unless exists( $localtaxlisthash{ $totname } ); # only increase
1207                                                              # existing taxes
1208         warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1209         my $hashref_or_error =
1210           $tax_object->taxline( $localtaxlisthash{$tax},
1211                                 'custnum'      => $self->custnum,
1212                                 'invoice_time' => $invoice_time,
1213                               );
1214         return $hashref_or_error
1215           unless ref($hashref_or_error);
1216
1217         $taxlisthash->{ $totname } ||= [ $tot ];
1218         push @{ $taxlisthash->{ $totname  } }, $hashref_or_error->{amount};
1219
1220       }
1221     }
1222
1223   }
1224
1225   '';
1226 }
1227
1228 sub _gather_taxes {
1229   my $self = shift;
1230   my $part_pkg = shift;
1231   my $class = shift;
1232
1233   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1234
1235   my @taxes = ();
1236   my $geocode = $self->geocode('cch');
1237
1238   my @taxclassnums = map { $_->taxclassnum }
1239                      $part_pkg->part_pkg_taxoverride($class);
1240
1241   unless (@taxclassnums) {
1242     @taxclassnums = map { $_->taxclassnum }
1243                     grep { $_->taxable eq 'Y' }
1244                     $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1245   }
1246   warn "Found taxclassnum values of ". join(',', @taxclassnums)
1247     if $DEBUG;
1248
1249   my $extra_sql =
1250     "AND (".
1251     join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1252
1253   @taxes = qsearch({ 'table' => 'tax_rate',
1254                      'hashref' => { 'geocode' => $geocode, },
1255                      'extra_sql' => $extra_sql,
1256                   })
1257     if scalar(@taxclassnums);
1258
1259   warn "Found taxes ".
1260        join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1261    if $DEBUG;
1262
1263   [ @taxes ];
1264
1265 }
1266
1267 =item collect [ HASHREF | OPTION => VALUE ... ]
1268
1269 (Attempt to) collect money for this customer's outstanding invoices (see
1270 L<FS::cust_bill>).  Usually used after the bill method.
1271
1272 Actions are now triggered by billing events; see L<FS::part_event> and the
1273 billing events web interface.  Old-style invoice events (see
1274 L<FS::part_bill_event>) have been deprecated.
1275
1276 If there is an error, returns the error, otherwise returns false.
1277
1278 Options are passed as name-value pairs.
1279
1280 Currently available options are:
1281
1282 =over 4
1283
1284 =item invoice_time
1285
1286 Use this time when deciding when to print invoices and late notices on those invoices.  The default is now.  It is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion functions.
1287
1288 =item retry
1289
1290 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1291
1292 =item check_freq
1293
1294 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1295
1296 =item quiet
1297
1298 set true to surpress email card/ACH decline notices.
1299
1300 =item debug
1301
1302 Debugging level.  Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
1303
1304 =back
1305
1306 # =item payby
1307 #
1308 # allows for one time override of normal customer billing method
1309
1310 =cut
1311
1312 sub collect {
1313   my( $self, %options ) = @_;
1314
1315   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1316
1317   my $invoice_time = $options{'invoice_time'} || time;
1318
1319   #put below somehow?
1320   local $SIG{HUP} = 'IGNORE';
1321   local $SIG{INT} = 'IGNORE';
1322   local $SIG{QUIT} = 'IGNORE';
1323   local $SIG{TERM} = 'IGNORE';
1324   local $SIG{TSTP} = 'IGNORE';
1325   local $SIG{PIPE} = 'IGNORE';
1326
1327   my $oldAutoCommit = $FS::UID::AutoCommit;
1328   local $FS::UID::AutoCommit = 0;
1329   my $dbh = dbh;
1330
1331   $self->select_for_update; #mutex
1332
1333   if ( $DEBUG ) {
1334     my $balance = $self->balance;
1335     warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1336   }
1337
1338   if ( exists($options{'retry_card'}) ) {
1339     carp 'retry_card option passed to collect is deprecated; use retry';
1340     $options{'retry'} ||= $options{'retry_card'};
1341   }
1342   if ( exists($options{'retry'}) && $options{'retry'} ) {
1343     my $error = $self->retry_realtime;
1344     if ( $error ) {
1345       $dbh->rollback if $oldAutoCommit;
1346       return $error;
1347     }
1348   }
1349
1350   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1351
1352   #never want to roll back an event just because it returned an error
1353   local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1354
1355   $self->do_cust_event(
1356     'debug'      => ( $options{'debug'} || 0 ),
1357     'time'       => $invoice_time,
1358     'check_freq' => $options{'check_freq'},
1359     'stage'      => 'collect',
1360   );
1361
1362 }
1363
1364 =item retry_realtime
1365
1366 Schedules realtime / batch  credit card / electronic check / LEC billing
1367 events for for retry.  Useful if card information has changed or manual
1368 retry is desired.  The 'collect' method must be called to actually retry
1369 the transaction.
1370
1371 Implementation details: For either this customer, or for each of this
1372 customer's open invoices, changes the status of the first "done" (with
1373 statustext error) realtime processing event to "failed".
1374
1375 =cut
1376
1377 sub retry_realtime {
1378   my $self = shift;
1379
1380   local $SIG{HUP} = 'IGNORE';
1381   local $SIG{INT} = 'IGNORE';
1382   local $SIG{QUIT} = 'IGNORE';
1383   local $SIG{TERM} = 'IGNORE';
1384   local $SIG{TSTP} = 'IGNORE';
1385   local $SIG{PIPE} = 'IGNORE';
1386
1387   my $oldAutoCommit = $FS::UID::AutoCommit;
1388   local $FS::UID::AutoCommit = 0;
1389   my $dbh = dbh;
1390
1391   #a little false laziness w/due_cust_event (not too bad, really)
1392
1393   my $join = FS::part_event_condition->join_conditions_sql;
1394   my $order = FS::part_event_condition->order_conditions_sql;
1395   my $mine =
1396   '( '
1397    . join ( ' OR ' , map {
1398     "( part_event.eventtable = " . dbh->quote($_)
1399     . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
1400    } FS::part_event->eventtables)
1401    . ') ';
1402
1403   #here is the agent virtualization
1404   my $agent_virt = " (    part_event.agentnum IS NULL
1405                        OR part_event.agentnum = ". $self->agentnum. ' )';
1406
1407   #XXX this shouldn't be hardcoded, actions should declare it...
1408   my @realtime_events = qw(
1409     cust_bill_realtime_card
1410     cust_bill_realtime_check
1411     cust_bill_realtime_lec
1412     cust_bill_batch
1413   );
1414
1415   my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
1416                                                   @realtime_events
1417                                      ).
1418                           ' ) ';
1419
1420   my @cust_event = qsearchs({
1421     'table'     => 'cust_event',
1422     'select'    => 'cust_event.*',
1423     'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1424     'hashref'   => { 'status' => 'done' },
1425     'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
1426                    " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1427   });
1428
1429   my %seen_invnum = ();
1430   foreach my $cust_event (@cust_event) {
1431
1432     #max one for the customer, one for each open invoice
1433     my $cust_X = $cust_event->cust_X;
1434     next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1435                           ? $cust_X->invnum
1436                           : 0
1437                         }++
1438          or $cust_event->part_event->eventtable eq 'cust_bill'
1439             && ! $cust_X->owed;
1440
1441     my $error = $cust_event->retry;
1442     if ( $error ) {
1443       $dbh->rollback if $oldAutoCommit;
1444       return "error scheduling event for retry: $error";
1445     }
1446
1447   }
1448
1449   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1450   '';
1451
1452 }
1453
1454 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1455
1456 Runs billing events; see L<FS::part_event> and the billing events web
1457 interface.
1458
1459 If there is an error, returns the error, otherwise returns false.
1460
1461 Options are passed as name-value pairs.
1462
1463 Currently available options are:
1464
1465 =over 4
1466
1467 =item time
1468
1469 Use this time when deciding when to print invoices and late notices on those invoices.  The default is now.  It is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion functions.
1470
1471 =item check_freq
1472
1473 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1474
1475 =item stage
1476
1477 "collect" (the default) or "pre-bill"
1478
1479 =item quiet
1480
1481 set true to surpress email card/ACH decline notices.
1482
1483 =item debug
1484
1485 Debugging level.  Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
1486
1487 =back
1488 =cut
1489
1490 # =item payby
1491 #
1492 # allows for one time override of normal customer billing method
1493
1494 # =item retry
1495 #
1496 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1497
1498 sub do_cust_event {
1499   my( $self, %options ) = @_;
1500
1501   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1502
1503   my $time = $options{'time'} || time;
1504
1505   #put below somehow?
1506   local $SIG{HUP} = 'IGNORE';
1507   local $SIG{INT} = 'IGNORE';
1508   local $SIG{QUIT} = 'IGNORE';
1509   local $SIG{TERM} = 'IGNORE';
1510   local $SIG{TSTP} = 'IGNORE';
1511   local $SIG{PIPE} = 'IGNORE';
1512
1513   my $oldAutoCommit = $FS::UID::AutoCommit;
1514   local $FS::UID::AutoCommit = 0;
1515   my $dbh = dbh;
1516
1517   $self->select_for_update; #mutex
1518
1519   if ( $DEBUG ) {
1520     my $balance = $self->balance;
1521     warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1522   }
1523
1524 #  if ( exists($options{'retry_card'}) ) {
1525 #    carp 'retry_card option passed to collect is deprecated; use retry';
1526 #    $options{'retry'} ||= $options{'retry_card'};
1527 #  }
1528 #  if ( exists($options{'retry'}) && $options{'retry'} ) {
1529 #    my $error = $self->retry_realtime;
1530 #    if ( $error ) {
1531 #      $dbh->rollback if $oldAutoCommit;
1532 #      return $error;
1533 #    }
1534 #  }
1535
1536   # false laziness w/pay_batch::import_results
1537
1538   my $due_cust_event = $self->due_cust_event(
1539     'debug'      => ( $options{'debug'} || 0 ),
1540     'time'       => $time,
1541     'check_freq' => $options{'check_freq'},
1542     'stage'      => ( $options{'stage'} || 'collect' ),
1543   );
1544   unless( ref($due_cust_event) ) {
1545     $dbh->rollback if $oldAutoCommit;
1546     return $due_cust_event;
1547   }
1548
1549   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1550   #never want to roll back an event just because it or a different one
1551   # returned an error
1552   local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1553
1554   foreach my $cust_event ( @$due_cust_event ) {
1555
1556     #XXX lock event
1557
1558     #re-eval event conditions (a previous event could have changed things)
1559     unless ( $cust_event->test_conditions( 'time' => $time ) ) {
1560       #don't leave stray "new/locked" records around
1561       my $error = $cust_event->delete;
1562       return $error if $error;
1563       next;
1564     }
1565
1566     {
1567       local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1568         if $options{'quiet'};
1569       warn "  running cust_event ". $cust_event->eventnum. "\n"
1570         if $DEBUG > 1;
1571
1572       #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1573       if ( my $error = $cust_event->do_event() ) {
1574         #XXX wtf is this?  figure out a proper dealio with return value
1575         #from do_event
1576         return $error;
1577       }
1578     }
1579
1580   }
1581
1582   '';
1583
1584 }
1585
1586 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1587
1588 Inserts database records for and returns an ordered listref of new events due
1589 for this customer, as FS::cust_event objects (see L<FS::cust_event>).  If no
1590 events are due, an empty listref is returned.  If there is an error, returns a
1591 scalar error message.
1592
1593 To actually run the events, call each event's test_condition method, and if
1594 still true, call the event's do_event method.
1595
1596 Options are passed as a hashref or as a list of name-value pairs.  Available
1597 options are:
1598
1599 =over 4
1600
1601 =item check_freq
1602
1603 Search only for events of this check frequency (how often events of this type are checked); currently "1d" (daily, the default) and "1m" (monthly) are recognized.
1604
1605 =item stage
1606
1607 "collect" (the default) or "pre-bill"
1608
1609 =item time
1610
1611 "Current time" for the events.
1612
1613 =item debug
1614
1615 Debugging level.  Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
1616
1617 =item eventtable
1618
1619 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1620
1621 =item objects
1622
1623 Explicitly pass the objects to be tested (typically used with eventtable).
1624
1625 =item testonly
1626
1627 Set to true to return the objects, but not actually insert them into the
1628 database.
1629
1630 =item discount_terms
1631
1632 Returns a list of lengths for term discounts
1633
1634 =cut
1635
1636 sub _discount_pkgs_and_bill {
1637 my $self = shift;
1638
1639   my @cust_bill = $self->cust_bill;
1640   my $cust_bill = pop @cust_bill;
1641   return () unless $cust_bill && $cust_bill->owed;
1642
1643   my @where = ();
1644   push @where, "cust_bill_pkg.invnum = ". $cust_bill->invnum;
1645   push @where, "cust_bill_pkg.pkgpart_override IS NULL";
1646   push @where, "part_pkg.freq = '1'";
1647   push @where, "(cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0)";
1648   push @where, "(cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0)";
1649   push @where, "0<(SELECT count(*) FROM part_pkg_discount
1650                   WHERE part_pkg.pkgpart = part_pkg_discount.pkgpart)";
1651   push @where,
1652     "0=(SELECT count(*) FROM cust_bill_pkg_discount
1653          WHERE cust_bill_pkg.billpkgnum = cust_bill_pkg_discount.billpkgnum)";
1654
1655   my $extra_sql = 'WHERE '. join(' AND ', @where);
1656
1657   my @cust_pkg =
1658     qsearch({
1659       'table' => 'cust_pkg',
1660       'select' => "DISTINCT cust_pkg.*",
1661       'addl_from' => 'JOIN cust_bill_pkg USING(pkgnum) '.
1662                      'JOIN part_pkg USING(pkgpart)',
1663       'hashref' => {},
1664       'extra_sql' => $extra_sql,
1665     });
1666
1667   ($cust_bill, @cust_pkg);
1668 }
1669
1670 sub _discountable_pkgs_at_term {
1671   my ($term, @pkgs) = @_;
1672   my $part_pkg = new FS::part_pkg { freq => $term - 1 };
1673   grep { ( !$_->adjourn || $_->adjourn > $part_pkg->add_freq($_->bill) ) &&
1674          ( !$_->expire  || $_->expire  > $part_pkg->add_freq($_->bill) )
1675        }
1676     @pkgs;
1677 }
1678
1679 =item discount_terms
1680
1681 Returns a list of lengths for term discounts
1682
1683 =cut
1684
1685 sub discount_terms {
1686 my $self = shift;
1687
1688   my %terms = ();
1689
1690   my @discount_pkgs = $self->_discount_pkgs_and_bill;
1691   shift @discount_pkgs; #discard bill;
1692
1693   map { $terms{$_->months} = 1 }
1694     grep { $_->months && $_->months > 1 }
1695     map { $_->discount }
1696     map { $_->part_pkg->part_pkg_discount }
1697     @discount_pkgs;
1698
1699   return sort { $a <=> $b } keys %terms;
1700
1701 }
1702
1703 =back
1704
1705 =item discount_term_values MONTHS
1706
1707 Returns a list with credit, dollar amount saved, and total bill acheived
1708 by prepaying the most recent invoice for MONTHS.
1709
1710 =cut
1711
1712 sub discount_term_values {
1713   my $self = shift;
1714   my $term = shift;
1715
1716   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1717
1718   warn "$me discount_term_values called with $term\n" if $DEBUG;
1719
1720   my %result = ();
1721
1722   my @packages = $self->_discount_pkgs_and_bill;
1723   my $cust_bill = shift(@packages);
1724   @packages = _discountable_pkgs_at_term( $term, @packages );
1725   return () unless scalar(@packages);
1726
1727   $_->bill($_->last_bill) foreach @packages;
1728   my @final = map { new FS::cust_pkg { $_->hash } } @packages;
1729
1730   my %options = (
1731                   'recurring_only' => 1,
1732                   'no_usage_reset' => 1,
1733                   'no_commit'      => 1,
1734                 );
1735
1736   my %params =  (
1737                   'return_bill'    => [],
1738                   'pkg_list'       => \@packages,
1739                   'time'           => $cust_bill->_date,
1740                 );
1741
1742   my $error = $self->bill(%options, %params);
1743   die $error if $error; # XXX think about this a bit more
1744
1745   my $credit = 0;
1746   $credit += $_->charged foreach @{$params{return_bill}};
1747   $credit = sprintf('%.2f', $credit);
1748   warn "$me discount_term_values $term credit: $credit\n" if $DEBUG;
1749
1750   %params =  (
1751                'return_bill'    => [],
1752                'pkg_list'       => \@packages,
1753                'time'           => $packages[0]->part_pkg->add_freq($cust_bill->_date)
1754              );
1755
1756   $error = $self->bill(%options, %params);
1757   die $error if $error; # XXX think about this a bit more
1758
1759   my $next = 0;
1760   $next += $_->charged foreach @{$params{return_bill}};
1761   warn "$me discount_term_values $term next: $next\n" if $DEBUG;
1762
1763   %params =  (
1764                'return_bill'    => [],
1765                'pkg_list'       => \@final,
1766                'time'           => $cust_bill->_date,
1767                'freq_override'  => $term,
1768              );
1769
1770   $error = $self->bill(%options, %params);
1771   die $error if $error; # XXX think about this a bit more
1772
1773   my $final = $self->balance - $credit;
1774   $final += $_->charged foreach @{$params{return_bill}};
1775   $final = sprintf('%.2f', $final);
1776   warn "$me discount_term_values $term final: $final\n" if $DEBUG;
1777
1778   my $savings = sprintf('%.2f', $self->balance + ($term - 1) * $next - $final);
1779
1780   ( $credit, $savings, $final );
1781
1782 }
1783
1784 sub discount_terms_hash {
1785   my $self = shift;
1786
1787   my %result = ();
1788   my @terms = $self->discount_terms;
1789   foreach my $term (@terms) {
1790     my @result = $self->discount_term_values($term);
1791     $result{$term} = [ @result ] if scalar(@result);
1792   }
1793
1794   return %result;
1795
1796 }
1797
1798 =back
1799
1800 =cut
1801
1802 sub due_cust_event {
1803   my $self = shift;
1804   my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1805
1806   #???
1807   #my $DEBUG = $opt{'debug'}
1808   local($DEBUG) = $opt{'debug'}
1809     if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1810   $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1811
1812   warn "$me due_cust_event called with options ".
1813        join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1814     if $DEBUG;
1815
1816   $opt{'time'} ||= time;
1817
1818   local $SIG{HUP} = 'IGNORE';
1819   local $SIG{INT} = 'IGNORE';
1820   local $SIG{QUIT} = 'IGNORE';
1821   local $SIG{TERM} = 'IGNORE';
1822   local $SIG{TSTP} = 'IGNORE';
1823   local $SIG{PIPE} = 'IGNORE';
1824
1825   my $oldAutoCommit = $FS::UID::AutoCommit;
1826   local $FS::UID::AutoCommit = 0;
1827   my $dbh = dbh;
1828
1829   $self->select_for_update #mutex
1830     unless $opt{testonly};
1831
1832   ###
1833   # find possible events (initial search)
1834   ###
1835
1836   my @cust_event = ();
1837
1838   my @eventtable = $opt{'eventtable'}
1839                      ? ( $opt{'eventtable'} )
1840                      : FS::part_event->eventtables_runorder;
1841
1842   my $check_freq = $opt{'check_freq'} || '1d';
1843
1844   foreach my $eventtable ( @eventtable ) {
1845
1846     my @objects;
1847     if ( $opt{'objects'} ) {
1848
1849       @objects = @{ $opt{'objects'} };
1850
1851     } else {
1852
1853       #my @objects = $self->$eventtable(); # sub cust_main { @{ [ $self ] }; }
1854       if ( $eventtable eq 'cust_main' ) {
1855         @objects = ( $self );
1856       } else {
1857
1858         my $cm_join =
1859           "LEFT JOIN cust_main USING ( custnum )";
1860
1861         #some false laziness w/Cron::bill bill_where
1862
1863         my $join  = FS::part_event_condition->join_conditions_sql( $eventtable);
1864         my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1865                                                            'time'=>$opt{'time'},
1866                                                                   );
1867         $where = $where ? "AND $where" : '';
1868
1869         my $are_part_event =
1870           "EXISTS ( SELECT 1 FROM part_event $join
1871                       WHERE check_freq = '$check_freq'
1872                         AND eventtable = '$eventtable'
1873                         AND ( disabled = '' OR disabled IS NULL )
1874                         $where
1875                   )
1876           ";
1877         #eofalse
1878
1879         @objects = $self->$eventtable(
1880                      'addl_from' => $cm_join,
1881                      'extra_sql' => " AND $are_part_event",
1882                    );
1883       }
1884
1885     }
1886
1887     my @e_cust_event = ();
1888
1889     my $cross = "CROSS JOIN $eventtable";
1890     $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1891       unless $eventtable eq 'cust_main';
1892
1893     foreach my $object ( @objects ) {
1894
1895       #this first search uses the condition_sql magic for optimization.
1896       #the more possible events we can eliminate in this step the better
1897
1898       my $cross_where = '';
1899       my $pkey = $object->primary_key;
1900       $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1901
1902       my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1903       my $extra_sql =
1904         FS::part_event_condition->where_conditions_sql( $eventtable,
1905                                                         'time'=>$opt{'time'}
1906                                                       );
1907       my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1908
1909       $extra_sql = "AND $extra_sql" if $extra_sql;
1910
1911       #here is the agent virtualization
1912       $extra_sql .= " AND (    part_event.agentnum IS NULL
1913                             OR part_event.agentnum = ". $self->agentnum. ' )';
1914
1915       $extra_sql .= " $order";
1916
1917       warn "searching for events for $eventtable ". $object->$pkey. "\n"
1918         if $opt{'debug'} > 2;
1919       my @part_event = qsearch( {
1920         'debug'     => ( $opt{'debug'} > 3 ? 1 : 0 ),
1921         'select'    => 'part_event.*',
1922         'table'     => 'part_event',
1923         'addl_from' => "$cross $join",
1924         'hashref'   => { 'check_freq' => $check_freq,
1925                          'eventtable' => $eventtable,
1926                          'disabled'   => '',
1927                        },
1928         'extra_sql' => "AND $cross_where $extra_sql",
1929       } );
1930
1931       if ( $DEBUG > 2 ) {
1932         my $pkey = $object->primary_key;
1933         warn "      ". scalar(@part_event).
1934              " possible events found for $eventtable ". $object->$pkey(). "\n";
1935       }
1936
1937       push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
1938
1939     }
1940
1941     warn "    ". scalar(@e_cust_event).
1942          " subtotal possible cust events found for $eventtable\n"
1943       if $DEBUG > 1;
1944
1945     push @cust_event, @e_cust_event;
1946
1947   }
1948
1949   warn "  ". scalar(@cust_event).
1950        " total possible cust events found in initial search\n"
1951     if $DEBUG; # > 1;
1952
1953
1954   ##
1955   # test stage
1956   ##
1957
1958   $opt{stage} ||= 'collect';
1959   @cust_event =
1960     grep { my $stage = $_->part_event->event_stage;
1961            $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1962          }
1963          @cust_event;
1964
1965   ##
1966   # test conditions
1967   ##
1968
1969   my %unsat = ();
1970
1971   @cust_event = grep $_->test_conditions( 'time'          => $opt{'time'},
1972                                           'stats_hashref' => \%unsat ),
1973                      @cust_event;
1974
1975   warn "  ". scalar(@cust_event). " cust events left satisfying conditions\n"
1976     if $DEBUG; # > 1;
1977
1978   warn "    invalid conditions not eliminated with condition_sql:\n".
1979        join('', map "      $_: ".$unsat{$_}."\n", keys %unsat )
1980     if keys %unsat && $DEBUG; # > 1;
1981
1982   ##
1983   # insert
1984   ##
1985
1986   unless( $opt{testonly} ) {
1987     foreach my $cust_event ( @cust_event ) {
1988
1989       my $error = $cust_event->insert();
1990       if ( $error ) {
1991         $dbh->rollback if $oldAutoCommit;
1992         return $error;
1993       }
1994
1995     }
1996   }
1997
1998   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1999
2000   ##
2001   # return
2002   ##
2003
2004   warn "  returning events: ". Dumper(@cust_event). "\n"
2005     if $DEBUG > 2;
2006
2007   \@cust_event;
2008
2009 }
2010
2011 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2012
2013 Applies unapplied payments and credits.
2014
2015 In most cases, this new method should be used in place of sequential
2016 apply_payments and apply_credits methods.
2017
2018 A hash of optional arguments may be passed.  Currently "manual" is supported.
2019 If true, a payment receipt is sent instead of a statement when
2020 'payment_receipt_email' configuration option is set.
2021
2022 If there is an error, returns the error, otherwise returns false.
2023
2024 =cut
2025
2026 sub apply_payments_and_credits {
2027   my( $self, %options ) = @_;
2028
2029   local $SIG{HUP} = 'IGNORE';
2030   local $SIG{INT} = 'IGNORE';
2031   local $SIG{QUIT} = 'IGNORE';
2032   local $SIG{TERM} = 'IGNORE';
2033   local $SIG{TSTP} = 'IGNORE';
2034   local $SIG{PIPE} = 'IGNORE';
2035
2036   my $oldAutoCommit = $FS::UID::AutoCommit;
2037   local $FS::UID::AutoCommit = 0;
2038   my $dbh = dbh;
2039
2040   $self->select_for_update; #mutex
2041
2042   foreach my $cust_bill ( $self->open_cust_bill ) {
2043     my $error = $cust_bill->apply_payments_and_credits(%options);
2044     if ( $error ) {
2045       $dbh->rollback if $oldAutoCommit;
2046       return "Error applying: $error";
2047     }
2048   }
2049
2050   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2051   ''; #no error
2052
2053 }
2054
2055 =item apply_credits OPTION => VALUE ...
2056
2057 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2058 to outstanding invoice balances in chronological order (or reverse
2059 chronological order if the I<order> option is set to B<newest>) and returns the
2060 value of any remaining unapplied credits available for refund (see
2061 L<FS::cust_refund>).
2062
2063 Dies if there is an error.
2064
2065 =cut
2066
2067 sub apply_credits {
2068   my $self = shift;
2069   my %opt = @_;
2070
2071   local $SIG{HUP} = 'IGNORE';
2072   local $SIG{INT} = 'IGNORE';
2073   local $SIG{QUIT} = 'IGNORE';
2074   local $SIG{TERM} = 'IGNORE';
2075   local $SIG{TSTP} = 'IGNORE';
2076   local $SIG{PIPE} = 'IGNORE';
2077
2078   my $oldAutoCommit = $FS::UID::AutoCommit;
2079   local $FS::UID::AutoCommit = 0;
2080   my $dbh = dbh;
2081
2082   $self->select_for_update; #mutex
2083
2084   unless ( $self->total_unapplied_credits ) {
2085     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2086     return 0;
2087   }
2088
2089   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2090       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2091
2092   my @invoices = $self->open_cust_bill;
2093   @invoices = sort { $b->_date <=> $a->_date } @invoices
2094     if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2095
2096   if ( $conf->exists('pkg-balances') ) {
2097     # limit @credits to those w/ a pkgnum grepped from $self
2098     my %pkgnums = ();
2099     foreach my $i (@invoices) {
2100       foreach my $li ( $i->cust_bill_pkg ) {
2101         $pkgnums{$li->pkgnum} = 1;
2102       }
2103     }
2104     @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2105   }
2106
2107   my $credit;
2108
2109   foreach my $cust_bill ( @invoices ) {
2110
2111     if ( !defined($credit) || $credit->credited == 0) {
2112       $credit = pop @credits or last;
2113     }
2114
2115     my $owed;
2116     if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2117       $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2118     } else {
2119       $owed = $cust_bill->owed;
2120     }
2121     unless ( $owed > 0 ) {
2122       push @credits, $credit;
2123       next;
2124     }
2125
2126     my $amount = min( $credit->credited, $owed );
2127
2128     my $cust_credit_bill = new FS::cust_credit_bill ( {
2129       'crednum' => $credit->crednum,
2130       'invnum'  => $cust_bill->invnum,
2131       'amount'  => $amount,
2132     } );
2133     $cust_credit_bill->pkgnum( $credit->pkgnum )
2134       if $conf->exists('pkg-balances') && $credit->pkgnum;
2135     my $error = $cust_credit_bill->insert;
2136     if ( $error ) {
2137       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2138       die $error;
2139     }
2140
2141     redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2142
2143   }
2144
2145   my $total_unapplied_credits = $self->total_unapplied_credits;
2146
2147   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2148
2149   return $total_unapplied_credits;
2150 }
2151
2152 =item apply_payments  [ OPTION => VALUE ... ]
2153
2154 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2155 to outstanding invoice balances in chronological order.
2156
2157  #and returns the value of any remaining unapplied payments.
2158
2159 A hash of optional arguments may be passed.  Currently "manual" is supported.
2160 If true, a payment receipt is sent instead of a statement when
2161 'payment_receipt_email' configuration option is set.
2162
2163 Dies if there is an error.
2164
2165 =cut
2166
2167 sub apply_payments {
2168   my( $self, %options ) = @_;
2169
2170   local $SIG{HUP} = 'IGNORE';
2171   local $SIG{INT} = 'IGNORE';
2172   local $SIG{QUIT} = 'IGNORE';
2173   local $SIG{TERM} = 'IGNORE';
2174   local $SIG{TSTP} = 'IGNORE';
2175   local $SIG{PIPE} = 'IGNORE';
2176
2177   my $oldAutoCommit = $FS::UID::AutoCommit;
2178   local $FS::UID::AutoCommit = 0;
2179   my $dbh = dbh;
2180
2181   $self->select_for_update; #mutex
2182
2183   #return 0 unless
2184
2185   my @payments = sort { $b->_date <=> $a->_date }
2186                  grep { $_->unapplied > 0 }
2187                  $self->cust_pay;
2188
2189   my @invoices = sort { $a->_date <=> $b->_date}
2190                  grep { $_->owed > 0 }
2191                  $self->cust_bill;
2192
2193   if ( $conf->exists('pkg-balances') ) {
2194     # limit @payments to those w/ a pkgnum grepped from $self
2195     my %pkgnums = ();
2196     foreach my $i (@invoices) {
2197       foreach my $li ( $i->cust_bill_pkg ) {
2198         $pkgnums{$li->pkgnum} = 1;
2199       }
2200     }
2201     @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2202   }
2203
2204   my $payment;
2205
2206   foreach my $cust_bill ( @invoices ) {
2207
2208     if ( !defined($payment) || $payment->unapplied == 0 ) {
2209       $payment = pop @payments or last;
2210     }
2211
2212     my $owed;
2213     if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2214       $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2215     } else {
2216       $owed = $cust_bill->owed;
2217     }
2218     unless ( $owed > 0 ) {
2219       push @payments, $payment;
2220       next;
2221     }
2222
2223     my $amount = min( $payment->unapplied, $owed );
2224
2225     my $cust_bill_pay = new FS::cust_bill_pay ( {
2226       'paynum' => $payment->paynum,
2227       'invnum' => $cust_bill->invnum,
2228       'amount' => $amount,
2229     } );
2230     $cust_bill_pay->pkgnum( $payment->pkgnum )
2231       if $conf->exists('pkg-balances') && $payment->pkgnum;
2232     my $error = $cust_bill_pay->insert(%options);
2233     if ( $error ) {
2234       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2235       die $error;
2236     }
2237
2238     redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2239
2240   }
2241
2242   my $total_unapplied_payments = $self->total_unapplied_payments;
2243
2244   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2245
2246   return $total_unapplied_payments;
2247 }
2248
2249 =head1 BUGS
2250
2251 =head1 SEE ALSO
2252
2253 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>
2254
2255 =cut
2256
2257 1;