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   foreach my $tax ( keys %$taxlisthash ) {
 721     foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
 722       next unless ref($_) eq 'FS::cust_bill_pkg';
 723
 724       unless ( $packagemap{$_->pkgnum} ) {
 725         warn "WARNING: can't move cust_tax_exempt_pkg records for pkgnum".
 726              $_->pkgnum. " - not in our line item list";
 727         next;
 728       }
 729
 730       push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
 731         splice( @{ $_->_cust_tax_exempt_pkg } );
 732     }
 733   }
 734
 735   #consolidate and create tax line items
 736   warn "consolidating and generating...\n" if $DEBUG > 2;
 737   foreach my $taxname ( keys %taxname ) {
 738     my $tax = 0;
 739     my %seen = ();
 740     my @cust_bill_pkg_tax_location = ();
 741     my @cust_bill_pkg_tax_rate_location = ();
 742     warn "adding $taxname\n" if $DEBUG > 1;
 743     foreach my $taxitem ( @{ $taxname{$taxname} } ) {
 744       next if $seen{$taxitem}++;
 745       warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
 746       $tax += $tax{$taxitem};
 747       push @cust_bill_pkg_tax_location,
 748         map { new FS::cust_bill_pkg_tax_location $_ }
 749             @{ $tax_location{ $taxitem } };
 750       push @cust_bill_pkg_tax_rate_location,
 751         map { new FS::cust_bill_pkg_tax_rate_location $_ }
 752             @{ $tax_rate_location{ $taxitem } };
 753     }
 754     next unless $tax;
 755
 756     $tax = sprintf('%.2f', $tax );
 757
 758     my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
 759                                                    'disabled'     => '',
 760                                                  },
 761                                );
 762
 763     my @display = ();
 764     if ( $pkg_category and
 765          $conf->config('invoice_latexsummary') ||
 766          $conf->config('invoice_htmlsummary')
 767        )
 768     {
 769
 770       my %hash = (  'section' => $pkg_category->categoryname );
 771       push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
 772
 773     }
 774
 775     push @tax_line_items, new FS::cust_bill_pkg {
 776       'pkgnum'   => 0,
 777       'setup'    => $tax,
 778       'recur'    => 0,
 779       'sdate'    => '',
 780       'edate'    => '',
 781       'itemdesc' => $taxname,
 782       'display'  => \@display,
 783       'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
 784       'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
 785     };
 786
 787   }
 788
 789   \@tax_line_items;
 790 }
 791
 792 sub _make_lines {
 793   my ($self, %params) = @_;
 794
 795   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
 796
 797   my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
 798   my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
 799   my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
 800   my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
 801   my $total_setup = $params{setup} or die "no setup accumulator specified";
 802   my $total_recur = $params{recur} or die "no recur accumulator specified";
 803   my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
 804   my $time = $params{'time'} or die "no time specified";
 805   my (%options) = %{$params{options}};
 806
 807   my $dbh = dbh;
 808   my $real_pkgpart = $params{real_pkgpart};
 809   my %hash = $cust_pkg->hash;
 810   my $old_cust_pkg = new FS::cust_pkg \%hash;
 811
 812   my @details = ();
 813   my @discounts = ();
 814   my $lineitems = 0;
 815
 816   $cust_pkg->pkgpart($part_pkg->pkgpart);
 817
 818   ###
 819   # bill setup
 820   ###
 821
 822   my $setup = 0;
 823   my $unitsetup = 0;
 824   if ( $options{'resetup'}
 825        || ( ! $cust_pkg->setup
 826             && ( ! $cust_pkg->start_date
 827                  || $cust_pkg->start_date <= $time
 828                )
 829             && ( ! $conf->exists('disable_setup_suspended_pkgs')
 830                  || ( $conf->exists('disable_setup_suspended_pkgs') &&
 831                       ! $cust_pkg->getfield('susp')
 832                     )
 833                )
 834           )
 835         and !$options{recurring_only}
 836     )
 837   {
 838
 839     warn "    bill setup\n" if $DEBUG > 1;
 840     $lineitems++;
 841
 842     $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
 843     return "$@ running calc_setup for $cust_pkg\n"
 844       if $@;
 845
 846     $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
 847
 848     $cust_pkg->setfield('setup', $time)
 849       unless $cust_pkg->setup;
 850           #do need it, but it won't get written to the db
 851           #|| $cust_pkg->pkgpart != $real_pkgpart;
 852
 853     $cust_pkg->setfield('start_date', '')
 854       if $cust_pkg->start_date;
 855
 856   }
 857
 858   ###
 859   # bill recurring fee
 860   ###
 861
 862   #XXX unit stuff here too
 863   my $recur = 0;
 864   my $unitrecur = 0;
 865   my $sdate;
 866   if (     ! $cust_pkg->get('susp')
 867        and ! $cust_pkg->get('start_date')
 868        and ( $part_pkg->getfield('freq') ne '0'
 869              && ( $cust_pkg->getfield('bill') || 0 ) <= $time
 870            )
 871         || ( $part_pkg->plan eq 'voip_cdr'
 872               && $part_pkg->option('bill_every_call')
 873            )
 874         || ( $options{cancel} )
 875   ) {
 876
 877     # XXX should this be a package event?  probably.  events are called
 878     # at collection time at the moment, though...
 879     $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
 880       if $part_pkg->can('reset_usage') && !$options{'no_usage_reset'};
 881       #don't want to reset usage just cause we want a line item??
 882       #&& $part_pkg->pkgpart == $real_pkgpart;
 883
 884     warn "    bill recur\n" if $DEBUG > 1;
 885     $lineitems++;
 886
 887     # XXX shared with $recur_prog
 888     $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
 889              || $cust_pkg->setup
 890              || $time;
 891
 892     #over two params!  lets at least switch to a hashref for the rest...
 893     my $increment_next_bill = ( $part_pkg->freq ne '0'
 894                                 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
 895                                 && !$options{cancel}
 896                               );
 897     my %param = ( 'precommit_hooks'     => $precommit_hooks,
 898                   'increment_next_bill' => $increment_next_bill,
 899                   'discounts'           => \@discounts,
 900                   'real_pkgpart'        => $real_pkgpart,
 901                   'freq_override'       => $options{freq_override} || '',
 902                 );
 903
 904     my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
 905
 906     # There may be some part_pkg for which this is wrong.  Only those
 907     # which can_discount are supported.
 908
 909     $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
 910     return "$@ running $method for $cust_pkg\n"
 911       if ( $@ );
 912
 913     if ( $increment_next_bill ) {
 914
 915       my $next_bill = $part_pkg->add_freq($sdate, $options{freq_override} || 0);
 916       return "unparsable frequency: ". $part_pkg->freq
 917         if $next_bill == -1;
 918
 919       #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
 920       # only for figuring next bill date, nothing else, so, reset $sdate again
 921       # here
 922       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
 923       #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
 924       $cust_pkg->last_bill($sdate);
 925
 926       $cust_pkg->setfield('bill', $next_bill );
 927
 928     }
 929
 930   }
 931
 932   warn "\$setup is undefined" unless defined($setup);
 933   warn "\$recur is undefined" unless defined($recur);
 934   warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
 935
 936   ###
 937   # If there's line items, create em cust_bill_pkg records
 938   # If $cust_pkg has been modified, update it (if we're a real pkgpart)
 939   ###
 940
 941   if ( $lineitems || $options{has_hidden} ) {
 942
 943     if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
 944       # hmm.. and if just the options are modified in some weird price plan?
 945
 946       warn "  package ". $cust_pkg->pkgnum. " modified; updating\n"
 947         if $DEBUG >1;
 948
 949       my $error = $cust_pkg->replace( $old_cust_pkg,
 950                                       'options' => { $cust_pkg->options },
 951                                     )
 952         unless $options{no_commit};
 953       return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
 954         if $error; #just in case
 955     }
 956
 957     $setup = sprintf( "%.2f", $setup );
 958     $recur = sprintf( "%.2f", $recur );
 959     if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
 960       return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
 961     }
 962     if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
 963       return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
 964     }
 965
 966     if ( $setup != 0 ||
 967          $recur != 0 ||
 968          !$part_pkg->hidden && $options{has_hidden} ) #include some $0 lines
 969     {
 970
 971       warn "    charges (setup=$setup, recur=$recur); adding line items\n"
 972         if $DEBUG > 1;
 973
 974       my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
 975       if ( $DEBUG > 1 ) {
 976         warn "      adding customer package invoice detail: $_\n"
 977           foreach @cust_pkg_detail;
 978       }
 979       push @details, @cust_pkg_detail;
 980
 981       my $cust_bill_pkg = new FS::cust_bill_pkg {
 982         'pkgnum'    => $cust_pkg->pkgnum,
 983         'setup'     => $setup,
 984         'unitsetup' => $unitsetup,
 985         'recur'     => $recur,
 986         'unitrecur' => $unitrecur,
 987         'quantity'  => $cust_pkg->quantity,
 988         'details'   => \@details,
 989         'discounts' => \@discounts,
 990         'hidden'    => $part_pkg->hidden,
 991         'freq'      => $part_pkg->freq,
 992       };
 993
 994       if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
 995         $cust_bill_pkg->sdate( $hash{last_bill} );
 996         $cust_bill_pkg->edate( $sdate - 86399   ); #60s*60m*24h-1
 997         $cust_bill_pkg->edate( $time ) if $options{cancel};
 998       } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
 999         $cust_bill_pkg->sdate( $sdate );
1000         $cust_bill_pkg->edate( $cust_pkg->bill );
1001         #$cust_bill_pkg->edate( $time ) if $options{cancel};
1002       }
1003
1004       $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
1005         unless $part_pkg->pkgpart == $real_pkgpart;
1006
1007       $$total_setup += $setup;
1008       $$total_recur += $recur;
1009
1010       ###
1011       # handle taxes
1012       ###
1013
1014       my $error =
1015         $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
1016       return $error if $error;
1017
1018       push @$cust_bill_pkgs, $cust_bill_pkg;
1019
1020     } #if $setup != 0 || $recur != 0
1021
1022   } #if $line_items
1023
1024   '';
1025
1026 }
1027
1028 sub _handle_taxes {
1029   my $self = shift;
1030   my $part_pkg = shift;
1031   my $taxlisthash = shift;
1032   my $cust_bill_pkg = shift;
1033   my $cust_pkg = shift;
1034   my $invoice_time = shift;
1035   my $real_pkgpart = shift;
1036   my $options = shift;
1037
1038   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1039
1040   my %cust_bill_pkg = ();
1041   my %taxes = ();
1042
1043   my @classes;
1044   #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
1045   push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
1046   push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
1047   push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
1048
1049   if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
1050
1051     if ( $conf->exists('enable_taxproducts')
1052          && ( scalar($part_pkg->part_pkg_taxoverride)
1053               || $part_pkg->has_taxproduct
1054             )
1055        )
1056     {
1057
1058       if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1059         return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
1060       }
1061
1062       foreach my $class (@classes) {
1063         my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
1064         return $err_or_ref unless ref($err_or_ref);
1065         $taxes{$class} = $err_or_ref;
1066       }
1067
1068       unless (exists $taxes{''}) {
1069         my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
1070         return $err_or_ref unless ref($err_or_ref);
1071         $taxes{''} = $err_or_ref;
1072       }
1073
1074     } else {
1075
1076       my @loc_keys = qw( city county state country );
1077       my %taxhash;
1078       if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1079         my $cust_location = $cust_pkg->cust_location;
1080         %taxhash = map { $_ => $cust_location->$_()    } @loc_keys;
1081       } else {
1082         my $prefix =
1083           ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1084           ? 'ship_'
1085           : '';
1086         %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
1087       }
1088
1089       $taxhash{'taxclass'} = $part_pkg->taxclass;
1090
1091       my @taxes = ();
1092       my %taxhash_elim = %taxhash;
1093       my @elim = qw( city county state );
1094       do {
1095
1096         #first try a match with taxclass
1097         @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
1098
1099         if ( !scalar(@taxes) && $taxhash_elim{'taxclass'} ) {
1100           #then try a match without taxclass
1101           my %no_taxclass = %taxhash_elim;
1102           $no_taxclass{ 'taxclass' } = '';
1103           @taxes = qsearch( 'cust_main_county', \%no_taxclass );
1104         }
1105
1106         $taxhash_elim{ shift(@elim) } = '';
1107
1108       } while ( !scalar(@taxes) && scalar(@elim) );
1109
1110       @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
1111                     @taxes
1112         if $self->cust_main_exemption; #just to be safe
1113
1114       if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
1115         foreach (@taxes) {
1116           $_->set('pkgnum',      $cust_pkg->pkgnum );
1117           $_->set('locationnum', $cust_pkg->locationnum );
1118         }
1119       }
1120
1121       $taxes{''} = [ @taxes ];
1122       $taxes{'setup'} = [ @taxes ];
1123       $taxes{'recur'} = [ @taxes ];
1124       $taxes{$_} = [ @taxes ] foreach (@classes);
1125
1126       # # maybe eliminate this entirely, along with all the 0% records
1127       # unless ( @taxes ) {
1128       #   return
1129       #     "fatal: can't find tax rate for state/county/country/taxclass ".
1130       #     join('/', map $taxhash{$_}, qw(state county country taxclass) );
1131       # }
1132
1133     } #if $conf->exists('enable_taxproducts') ...
1134
1135   }
1136
1137   my @display = ();
1138   my $separate = $conf->exists('separate_usage');
1139   my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
1140   my $usage_mandate = $temp_pkg->part_pkg->option('usage_mandate', 'Hush!');
1141   my $section = $temp_pkg->part_pkg->categoryname;
1142   if ( $separate || $section || $usage_mandate ) {
1143
1144     my %hash = ( 'section' => $section );
1145
1146     $section = $temp_pkg->part_pkg->option('usage_section', 'Hush!');
1147     my $summary = $temp_pkg->part_pkg->option('summarize_usage', 'Hush!');
1148     if ( $separate ) {
1149       push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
1150       push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
1151     } else {
1152       push @display, new FS::cust_bill_pkg_display
1153                        { type => '',
1154                          %hash,
1155                          ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
1156                        };
1157     }
1158
1159     if ($separate && $section && $summary) {
1160       push @display, new FS::cust_bill_pkg_display { type    => 'U',
1161                                                      summary => 'Y',
1162                                                      %hash,
1163                                                    };
1164     }
1165     if ($usage_mandate || $section && $summary) {
1166       $hash{post_total} = 'Y';
1167     }
1168
1169     if ($separate || $usage_mandate) {
1170       $hash{section} = $section if ($separate || $usage_mandate);
1171       push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
1172     }
1173
1174   }
1175   $cust_bill_pkg->set('display', \@display);
1176
1177   my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
1178   foreach my $key (keys %tax_cust_bill_pkg) {
1179     my @taxes = @{ $taxes{$key} || [] };
1180     my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
1181
1182     my %localtaxlisthash = ();
1183     foreach my $tax ( @taxes ) {
1184
1185       my $taxname = ref( $tax ). ' '. $tax->taxnum;
1186 #      $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
1187 #                  ' locationnum'. $cust_pkg->locationnum
1188 #        if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
1189
1190       $taxlisthash->{ $taxname } ||= [ $tax ];
1191       push @{ $taxlisthash->{ $taxname  } }, $tax_cust_bill_pkg;
1192
1193       $localtaxlisthash{ $taxname } ||= [ $tax ];
1194       push @{ $localtaxlisthash{ $taxname  } }, $tax_cust_bill_pkg;
1195
1196     }
1197
1198     warn "finding taxed taxes...\n" if $DEBUG > 2;
1199     foreach my $tax ( keys %localtaxlisthash ) {
1200       my $tax_object = shift @{ $localtaxlisthash{$tax} };
1201       warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
1202         if $DEBUG > 2;
1203       next unless $tax_object->can('tax_on_tax');
1204
1205       foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
1206         my $totname = ref( $tot ). ' '. $tot->taxnum;
1207
1208         warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
1209           if $DEBUG > 2;
1210         next unless exists( $localtaxlisthash{ $totname } ); # only increase
1211                                                              # existing taxes
1212         warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
1213         my $hashref_or_error =
1214           $tax_object->taxline( $localtaxlisthash{$tax},
1215                                 'custnum'      => $self->custnum,
1216                                 'invoice_time' => $invoice_time,
1217                               );
1218         return $hashref_or_error
1219           unless ref($hashref_or_error);
1220
1221         $taxlisthash->{ $totname } ||= [ $tot ];
1222         push @{ $taxlisthash->{ $totname  } }, $hashref_or_error->{amount};
1223
1224       }
1225     }
1226
1227   }
1228
1229   '';
1230 }
1231
1232 sub _gather_taxes {
1233   my $self = shift;
1234   my $part_pkg = shift;
1235   my $class = shift;
1236
1237   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1238
1239   my @taxes = ();
1240   my $geocode = $self->geocode('cch');
1241
1242   my @taxclassnums = map { $_->taxclassnum }
1243                      $part_pkg->part_pkg_taxoverride($class);
1244
1245   unless (@taxclassnums) {
1246     @taxclassnums = map { $_->taxclassnum }
1247                     grep { $_->taxable eq 'Y' }
1248                     $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
1249   }
1250   warn "Found taxclassnum values of ". join(',', @taxclassnums)
1251     if $DEBUG;
1252
1253   my $extra_sql =
1254     "AND (".
1255     join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
1256
1257   @taxes = qsearch({ 'table' => 'tax_rate',
1258                      'hashref' => { 'geocode' => $geocode, },
1259                      'extra_sql' => $extra_sql,
1260                   })
1261     if scalar(@taxclassnums);
1262
1263   warn "Found taxes ".
1264        join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
1265    if $DEBUG;
1266
1267   [ @taxes ];
1268
1269 }
1270
1271 =item collect [ HASHREF | OPTION => VALUE ... ]
1272
1273 (Attempt to) collect money for this customer's outstanding invoices (see
1274 L<FS::cust_bill>).  Usually used after the bill method.
1275
1276 Actions are now triggered by billing events; see L<FS::part_event> and the
1277 billing events web interface.  Old-style invoice events (see
1278 L<FS::part_bill_event>) have been deprecated.
1279
1280 If there is an error, returns the error, otherwise returns false.
1281
1282 Options are passed as name-value pairs.
1283
1284 Currently available options are:
1285
1286 =over 4
1287
1288 =item invoice_time
1289
1290 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.
1291
1292 =item retry
1293
1294 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1295
1296 =item check_freq
1297
1298 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1299
1300 =item quiet
1301
1302 set true to surpress email card/ACH decline notices.
1303
1304 =item debug
1305
1306 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)
1307
1308 =back
1309
1310 # =item payby
1311 #
1312 # allows for one time override of normal customer billing method
1313
1314 =cut
1315
1316 sub collect {
1317   my( $self, %options ) = @_;
1318
1319   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1320
1321   my $invoice_time = $options{'invoice_time'} || time;
1322
1323   #put below somehow?
1324   local $SIG{HUP} = 'IGNORE';
1325   local $SIG{INT} = 'IGNORE';
1326   local $SIG{QUIT} = 'IGNORE';
1327   local $SIG{TERM} = 'IGNORE';
1328   local $SIG{TSTP} = 'IGNORE';
1329   local $SIG{PIPE} = 'IGNORE';
1330
1331   my $oldAutoCommit = $FS::UID::AutoCommit;
1332   local $FS::UID::AutoCommit = 0;
1333   my $dbh = dbh;
1334
1335   $self->select_for_update; #mutex
1336
1337   if ( $DEBUG ) {
1338     my $balance = $self->balance;
1339     warn "$me collect customer ". $self->custnum. ": balance $balance\n"
1340   }
1341
1342   if ( exists($options{'retry_card'}) ) {
1343     carp 'retry_card option passed to collect is deprecated; use retry';
1344     $options{'retry'} ||= $options{'retry_card'};
1345   }
1346   if ( exists($options{'retry'}) && $options{'retry'} ) {
1347     my $error = $self->retry_realtime;
1348     if ( $error ) {
1349       $dbh->rollback if $oldAutoCommit;
1350       return $error;
1351     }
1352   }
1353
1354   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1355
1356   #never want to roll back an event just because it returned an error
1357   local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1358
1359   $self->do_cust_event(
1360     'debug'      => ( $options{'debug'} || 0 ),
1361     'time'       => $invoice_time,
1362     'check_freq' => $options{'check_freq'},
1363     'stage'      => 'collect',
1364   );
1365
1366 }
1367
1368 =item retry_realtime
1369
1370 Schedules realtime / batch  credit card / electronic check / LEC billing
1371 events for for retry.  Useful if card information has changed or manual
1372 retry is desired.  The 'collect' method must be called to actually retry
1373 the transaction.
1374
1375 Implementation details: For either this customer, or for each of this
1376 customer's open invoices, changes the status of the first "done" (with
1377 statustext error) realtime processing event to "failed".
1378
1379 =cut
1380
1381 sub retry_realtime {
1382   my $self = shift;
1383
1384   local $SIG{HUP} = 'IGNORE';
1385   local $SIG{INT} = 'IGNORE';
1386   local $SIG{QUIT} = 'IGNORE';
1387   local $SIG{TERM} = 'IGNORE';
1388   local $SIG{TSTP} = 'IGNORE';
1389   local $SIG{PIPE} = 'IGNORE';
1390
1391   my $oldAutoCommit = $FS::UID::AutoCommit;
1392   local $FS::UID::AutoCommit = 0;
1393   my $dbh = dbh;
1394
1395   #a little false laziness w/due_cust_event (not too bad, really)
1396
1397   my $join = FS::part_event_condition->join_conditions_sql;
1398   my $order = FS::part_event_condition->order_conditions_sql;
1399   my $mine =
1400   '( '
1401    . join ( ' OR ' , map {
1402     "( part_event.eventtable = " . dbh->quote($_)
1403     . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
1404    } FS::part_event->eventtables)
1405    . ') ';
1406
1407   #here is the agent virtualization
1408   my $agent_virt = " (    part_event.agentnum IS NULL
1409                        OR part_event.agentnum = ". $self->agentnum. ' )';
1410
1411   #XXX this shouldn't be hardcoded, actions should declare it...
1412   my @realtime_events = qw(
1413     cust_bill_realtime_card
1414     cust_bill_realtime_check
1415     cust_bill_realtime_lec
1416     cust_bill_batch
1417   );
1418
1419   my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
1420                                                   @realtime_events
1421                                      ).
1422                           ' ) ';
1423
1424   my @cust_event = qsearchs({
1425     'table'     => 'cust_event',
1426     'select'    => 'cust_event.*',
1427     'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
1428     'hashref'   => { 'status' => 'done' },
1429     'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
1430                    " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
1431   });
1432
1433   my %seen_invnum = ();
1434   foreach my $cust_event (@cust_event) {
1435
1436     #max one for the customer, one for each open invoice
1437     my $cust_X = $cust_event->cust_X;
1438     next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
1439                           ? $cust_X->invnum
1440                           : 0
1441                         }++
1442          or $cust_event->part_event->eventtable eq 'cust_bill'
1443             && ! $cust_X->owed;
1444
1445     my $error = $cust_event->retry;
1446     if ( $error ) {
1447       $dbh->rollback if $oldAutoCommit;
1448       return "error scheduling event for retry: $error";
1449     }
1450
1451   }
1452
1453   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1454   '';
1455
1456 }
1457
1458 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
1459
1460 Runs billing events; see L<FS::part_event> and the billing events web
1461 interface.
1462
1463 If there is an error, returns the error, otherwise returns false.
1464
1465 Options are passed as name-value pairs.
1466
1467 Currently available options are:
1468
1469 =over 4
1470
1471 =item time
1472
1473 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.
1474
1475 =item check_freq
1476
1477 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1478
1479 =item stage
1480
1481 "collect" (the default) or "pre-bill"
1482
1483 =item quiet
1484
1485 set true to surpress email card/ACH decline notices.
1486
1487 =item debug
1488
1489 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)
1490
1491 =back
1492 =cut
1493
1494 # =item payby
1495 #
1496 # allows for one time override of normal customer billing method
1497
1498 # =item retry
1499 #
1500 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
1501
1502 sub do_cust_event {
1503   my( $self, %options ) = @_;
1504
1505   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1506
1507   my $time = $options{'time'} || time;
1508
1509   #put below somehow?
1510   local $SIG{HUP} = 'IGNORE';
1511   local $SIG{INT} = 'IGNORE';
1512   local $SIG{QUIT} = 'IGNORE';
1513   local $SIG{TERM} = 'IGNORE';
1514   local $SIG{TSTP} = 'IGNORE';
1515   local $SIG{PIPE} = 'IGNORE';
1516
1517   my $oldAutoCommit = $FS::UID::AutoCommit;
1518   local $FS::UID::AutoCommit = 0;
1519   my $dbh = dbh;
1520
1521   $self->select_for_update; #mutex
1522
1523   if ( $DEBUG ) {
1524     my $balance = $self->balance;
1525     warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
1526   }
1527
1528 #  if ( exists($options{'retry_card'}) ) {
1529 #    carp 'retry_card option passed to collect is deprecated; use retry';
1530 #    $options{'retry'} ||= $options{'retry_card'};
1531 #  }
1532 #  if ( exists($options{'retry'}) && $options{'retry'} ) {
1533 #    my $error = $self->retry_realtime;
1534 #    if ( $error ) {
1535 #      $dbh->rollback if $oldAutoCommit;
1536 #      return $error;
1537 #    }
1538 #  }
1539
1540   # false laziness w/pay_batch::import_results
1541
1542   my $due_cust_event = $self->due_cust_event(
1543     'debug'      => ( $options{'debug'} || 0 ),
1544     'time'       => $time,
1545     'check_freq' => $options{'check_freq'},
1546     'stage'      => ( $options{'stage'} || 'collect' ),
1547   );
1548   unless( ref($due_cust_event) ) {
1549     $dbh->rollback if $oldAutoCommit;
1550     return $due_cust_event;
1551   }
1552
1553   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1554   #never want to roll back an event just because it or a different one
1555   # returned an error
1556   local $FS::UID::AutoCommit = 1; #$oldAutoCommit;
1557
1558   foreach my $cust_event ( @$due_cust_event ) {
1559
1560     #XXX lock event
1561
1562     #re-eval event conditions (a previous event could have changed things)
1563     unless ( $cust_event->test_conditions( 'time' => $time ) ) {
1564       #don't leave stray "new/locked" records around
1565       my $error = $cust_event->delete;
1566       return $error if $error;
1567       next;
1568     }
1569
1570     {
1571       local $FS::cust_main::Billing_Realtime::realtime_bop_decline_quiet = 1
1572         if $options{'quiet'};
1573       warn "  running cust_event ". $cust_event->eventnum. "\n"
1574         if $DEBUG > 1;
1575
1576       #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
1577       if ( my $error = $cust_event->do_event() ) {
1578         #XXX wtf is this?  figure out a proper dealio with return value
1579         #from do_event
1580         return $error;
1581       }
1582     }
1583
1584   }
1585
1586   '';
1587
1588 }
1589
1590 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
1591
1592 Inserts database records for and returns an ordered listref of new events due
1593 for this customer, as FS::cust_event objects (see L<FS::cust_event>).  If no
1594 events are due, an empty listref is returned.  If there is an error, returns a
1595 scalar error message.
1596
1597 To actually run the events, call each event's test_condition method, and if
1598 still true, call the event's do_event method.
1599
1600 Options are passed as a hashref or as a list of name-value pairs.  Available
1601 options are:
1602
1603 =over 4
1604
1605 =item check_freq
1606
1607 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.
1608
1609 =item stage
1610
1611 "collect" (the default) or "pre-bill"
1612
1613 =item time
1614
1615 "Current time" for the events.
1616
1617 =item debug
1618
1619 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)
1620
1621 =item eventtable
1622
1623 Only return events for the specified eventtable (by default, events of all eventtables are returned)
1624
1625 =item objects
1626
1627 Explicitly pass the objects to be tested (typically used with eventtable).
1628
1629 =item testonly
1630
1631 Set to true to return the objects, but not actually insert them into the
1632 database.
1633
1634 =item discount_terms
1635
1636 Returns a list of lengths for term discounts
1637
1638 =cut
1639
1640 sub _discount_pkgs_and_bill {
1641 my $self = shift;
1642
1643   my @cust_bill = $self->cust_bill;
1644   my $cust_bill = pop @cust_bill;
1645   return () unless $cust_bill && $cust_bill->owed;
1646
1647   my @where = ();
1648   push @where, "cust_bill_pkg.invnum = ". $cust_bill->invnum;
1649   push @where, "cust_bill_pkg.pkgpart_override IS NULL";
1650   push @where, "part_pkg.freq = '1'";
1651   push @where, "(cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0)";
1652   push @where, "(cust_pkg.susp   IS NULL OR cust_pkg.susp   = 0)";
1653   push @where, "0<(SELECT count(*) FROM part_pkg_discount
1654                   WHERE part_pkg.pkgpart = part_pkg_discount.pkgpart)";
1655   push @where,
1656     "0=(SELECT count(*) FROM cust_bill_pkg_discount
1657          WHERE cust_bill_pkg.billpkgnum = cust_bill_pkg_discount.billpkgnum)";
1658
1659   my $extra_sql = 'WHERE '. join(' AND ', @where);
1660
1661   my @cust_pkg =
1662     qsearch({
1663       'table' => 'cust_pkg',
1664       'select' => "DISTINCT cust_pkg.*",
1665       'addl_from' => 'JOIN cust_bill_pkg USING(pkgnum) '.
1666                      'JOIN part_pkg USING(pkgpart)',
1667       'hashref' => {},
1668       'extra_sql' => $extra_sql,
1669     });
1670
1671   ($cust_bill, @cust_pkg);
1672 }
1673
1674 sub _discountable_pkgs_at_term {
1675   my ($term, @pkgs) = @_;
1676   my $part_pkg = new FS::part_pkg { freq => $term - 1 };
1677   grep { ( !$_->adjourn || $_->adjourn > $part_pkg->add_freq($_->bill) ) &&
1678          ( !$_->expire  || $_->expire  > $part_pkg->add_freq($_->bill) )
1679        }
1680     @pkgs;
1681 }
1682
1683 =item discount_terms
1684
1685 Returns a list of lengths for term discounts
1686
1687 =cut
1688
1689 sub discount_terms {
1690 my $self = shift;
1691
1692   my %terms = ();
1693
1694   my @discount_pkgs = $self->_discount_pkgs_and_bill;
1695   shift @discount_pkgs; #discard bill;
1696
1697   map { $terms{$_->months} = 1 }
1698     grep { $_->months && $_->months > 1 }
1699     map { $_->discount }
1700     map { $_->part_pkg->part_pkg_discount }
1701     @discount_pkgs;
1702
1703   return sort { $a <=> $b } keys %terms;
1704
1705 }
1706
1707 =back
1708
1709 =item discount_term_values MONTHS
1710
1711 Returns a list with credit, dollar amount saved, and total bill acheived
1712 by prepaying the most recent invoice for MONTHS.
1713
1714 =cut
1715
1716 sub discount_term_values {
1717   my $self = shift;
1718   my $term = shift;
1719
1720   local($DEBUG) = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1721
1722   warn "$me discount_term_values called with $term\n" if $DEBUG;
1723
1724   my %result = ();
1725
1726   my @packages = $self->_discount_pkgs_and_bill;
1727   my $cust_bill = shift(@packages);
1728   @packages = _discountable_pkgs_at_term( $term, @packages );
1729   return () unless scalar(@packages);
1730
1731   $_->bill($_->last_bill) foreach @packages;
1732   my @final = map { new FS::cust_pkg { $_->hash } } @packages;
1733
1734   my %options = (
1735                   'recurring_only' => 1,
1736                   'no_usage_reset' => 1,
1737                   'no_commit'      => 1,
1738                 );
1739
1740   my %params =  (
1741                   'return_bill'    => [],
1742                   'pkg_list'       => \@packages,
1743                   'time'           => $cust_bill->_date,
1744                 );
1745
1746   my $error = $self->bill(%options, %params);
1747   die $error if $error; # XXX think about this a bit more
1748
1749   my $credit = 0;
1750   $credit += $_->charged foreach @{$params{return_bill}};
1751   $credit = sprintf('%.2f', $credit);
1752   warn "$me discount_term_values $term credit: $credit\n" if $DEBUG;
1753
1754   %params =  (
1755                'return_bill'    => [],
1756                'pkg_list'       => \@packages,
1757                'time'           => $packages[0]->part_pkg->add_freq($cust_bill->_date)
1758              );
1759
1760   $error = $self->bill(%options, %params);
1761   die $error if $error; # XXX think about this a bit more
1762
1763   my $next = 0;
1764   $next += $_->charged foreach @{$params{return_bill}};
1765   warn "$me discount_term_values $term next: $next\n" if $DEBUG;
1766
1767   %params =  (
1768                'return_bill'    => [],
1769                'pkg_list'       => \@final,
1770                'time'           => $cust_bill->_date,
1771                'freq_override'  => $term,
1772              );
1773
1774   $error = $self->bill(%options, %params);
1775   die $error if $error; # XXX think about this a bit more
1776
1777   my $final = $self->balance - $credit;
1778   $final += $_->charged foreach @{$params{return_bill}};
1779   $final = sprintf('%.2f', $final);
1780   warn "$me discount_term_values $term final: $final\n" if $DEBUG;
1781
1782   my $savings = sprintf('%.2f', $self->balance + ($term - 1) * $next - $final);
1783
1784   ( $credit, $savings, $final );
1785
1786 }
1787
1788 sub discount_terms_hash {
1789   my $self = shift;
1790
1791   my %result = ();
1792   my @terms = $self->discount_terms;
1793   foreach my $term (@terms) {
1794     my @result = $self->discount_term_values($term);
1795     $result{$term} = [ @result ] if scalar(@result);
1796   }
1797
1798   return %result;
1799
1800 }
1801
1802 =back
1803
1804 =cut
1805
1806 sub due_cust_event {
1807   my $self = shift;
1808   my %opt = ref($_[0]) ? %{ $_[0] } : @_;
1809
1810   #???
1811   #my $DEBUG = $opt{'debug'}
1812   local($DEBUG) = $opt{'debug'}
1813     if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
1814   $DEBUG = $FS::cust_main::DEBUG if $FS::cust_main::DEBUG > $DEBUG;
1815
1816   warn "$me due_cust_event called with options ".
1817        join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
1818     if $DEBUG;
1819
1820   $opt{'time'} ||= time;
1821
1822   local $SIG{HUP} = 'IGNORE';
1823   local $SIG{INT} = 'IGNORE';
1824   local $SIG{QUIT} = 'IGNORE';
1825   local $SIG{TERM} = 'IGNORE';
1826   local $SIG{TSTP} = 'IGNORE';
1827   local $SIG{PIPE} = 'IGNORE';
1828
1829   my $oldAutoCommit = $FS::UID::AutoCommit;
1830   local $FS::UID::AutoCommit = 0;
1831   my $dbh = dbh;
1832
1833   $self->select_for_update #mutex
1834     unless $opt{testonly};
1835
1836   ###
1837   # find possible events (initial search)
1838   ###
1839
1840   my @cust_event = ();
1841
1842   my @eventtable = $opt{'eventtable'}
1843                      ? ( $opt{'eventtable'} )
1844                      : FS::part_event->eventtables_runorder;
1845
1846   my $check_freq = $opt{'check_freq'} || '1d';
1847
1848   foreach my $eventtable ( @eventtable ) {
1849
1850     my @objects;
1851     if ( $opt{'objects'} ) {
1852
1853       @objects = @{ $opt{'objects'} };
1854
1855     } else {
1856
1857       #my @objects = $self->$eventtable(); # sub cust_main { @{ [ $self ] }; }
1858       if ( $eventtable eq 'cust_main' ) {
1859         @objects = ( $self );
1860       } else {
1861
1862         my $cm_join =
1863           "LEFT JOIN cust_main USING ( custnum )";
1864
1865         #some false laziness w/Cron::bill bill_where
1866
1867         my $join  = FS::part_event_condition->join_conditions_sql( $eventtable);
1868         my $where = FS::part_event_condition->where_conditions_sql($eventtable,
1869                                                            'time'=>$opt{'time'},
1870                                                                   );
1871         $where = $where ? "AND $where" : '';
1872
1873         my $are_part_event =
1874           "EXISTS ( SELECT 1 FROM part_event $join
1875                       WHERE check_freq = '$check_freq'
1876                         AND eventtable = '$eventtable'
1877                         AND ( disabled = '' OR disabled IS NULL )
1878                         $where
1879                   )
1880           ";
1881         #eofalse
1882
1883         @objects = $self->$eventtable(
1884                      'addl_from' => $cm_join,
1885                      'extra_sql' => " AND $are_part_event",
1886                    );
1887       }
1888
1889     }
1890
1891     my @e_cust_event = ();
1892
1893     my $cross = "CROSS JOIN $eventtable";
1894     $cross .= ' LEFT JOIN cust_main USING ( custnum )'
1895       unless $eventtable eq 'cust_main';
1896
1897     foreach my $object ( @objects ) {
1898
1899       #this first search uses the condition_sql magic for optimization.
1900       #the more possible events we can eliminate in this step the better
1901
1902       my $cross_where = '';
1903       my $pkey = $object->primary_key;
1904       $cross_where = "$eventtable.$pkey = ". $object->$pkey();
1905
1906       my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
1907       my $extra_sql =
1908         FS::part_event_condition->where_conditions_sql( $eventtable,
1909                                                         'time'=>$opt{'time'}
1910                                                       );
1911       my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
1912
1913       $extra_sql = "AND $extra_sql" if $extra_sql;
1914
1915       #here is the agent virtualization
1916       $extra_sql .= " AND (    part_event.agentnum IS NULL
1917                             OR part_event.agentnum = ". $self->agentnum. ' )';
1918
1919       $extra_sql .= " $order";
1920
1921       warn "searching for events for $eventtable ". $object->$pkey. "\n"
1922         if $opt{'debug'} > 2;
1923       my @part_event = qsearch( {
1924         'debug'     => ( $opt{'debug'} > 3 ? 1 : 0 ),
1925         'select'    => 'part_event.*',
1926         'table'     => 'part_event',
1927         'addl_from' => "$cross $join",
1928         'hashref'   => { 'check_freq' => $check_freq,
1929                          'eventtable' => $eventtable,
1930                          'disabled'   => '',
1931                        },
1932         'extra_sql' => "AND $cross_where $extra_sql",
1933       } );
1934
1935       if ( $DEBUG > 2 ) {
1936         my $pkey = $object->primary_key;
1937         warn "      ". scalar(@part_event).
1938              " possible events found for $eventtable ". $object->$pkey(). "\n";
1939       }
1940
1941       push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
1942
1943     }
1944
1945     warn "    ". scalar(@e_cust_event).
1946          " subtotal possible cust events found for $eventtable\n"
1947       if $DEBUG > 1;
1948
1949     push @cust_event, @e_cust_event;
1950
1951   }
1952
1953   warn "  ". scalar(@cust_event).
1954        " total possible cust events found in initial search\n"
1955     if $DEBUG; # > 1;
1956
1957
1958   ##
1959   # test stage
1960   ##
1961
1962   $opt{stage} ||= 'collect';
1963   @cust_event =
1964     grep { my $stage = $_->part_event->event_stage;
1965            $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
1966          }
1967          @cust_event;
1968
1969   ##
1970   # test conditions
1971   ##
1972
1973   my %unsat = ();
1974
1975   @cust_event = grep $_->test_conditions( 'time'          => $opt{'time'},
1976                                           'stats_hashref' => \%unsat ),
1977                      @cust_event;
1978
1979   warn "  ". scalar(@cust_event). " cust events left satisfying conditions\n"
1980     if $DEBUG; # > 1;
1981
1982   warn "    invalid conditions not eliminated with condition_sql:\n".
1983        join('', map "      $_: ".$unsat{$_}."\n", keys %unsat )
1984     if keys %unsat && $DEBUG; # > 1;
1985
1986   ##
1987   # insert
1988   ##
1989
1990   unless( $opt{testonly} ) {
1991     foreach my $cust_event ( @cust_event ) {
1992
1993       my $error = $cust_event->insert();
1994       if ( $error ) {
1995         $dbh->rollback if $oldAutoCommit;
1996         return $error;
1997       }
1998
1999     }
2000   }
2001
2002   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2003
2004   ##
2005   # return
2006   ##
2007
2008   warn "  returning events: ". Dumper(@cust_event). "\n"
2009     if $DEBUG > 2;
2010
2011   \@cust_event;
2012
2013 }
2014
2015 =item apply_payments_and_credits [ OPTION => VALUE ... ]
2016
2017 Applies unapplied payments and credits.
2018
2019 In most cases, this new method should be used in place of sequential
2020 apply_payments and apply_credits methods.
2021
2022 A hash of optional arguments may be passed.  Currently "manual" is supported.
2023 If true, a payment receipt is sent instead of a statement when
2024 'payment_receipt_email' configuration option is set.
2025
2026 If there is an error, returns the error, otherwise returns false.
2027
2028 =cut
2029
2030 sub apply_payments_and_credits {
2031   my( $self, %options ) = @_;
2032
2033   local $SIG{HUP} = 'IGNORE';
2034   local $SIG{INT} = 'IGNORE';
2035   local $SIG{QUIT} = 'IGNORE';
2036   local $SIG{TERM} = 'IGNORE';
2037   local $SIG{TSTP} = 'IGNORE';
2038   local $SIG{PIPE} = 'IGNORE';
2039
2040   my $oldAutoCommit = $FS::UID::AutoCommit;
2041   local $FS::UID::AutoCommit = 0;
2042   my $dbh = dbh;
2043
2044   $self->select_for_update; #mutex
2045
2046   foreach my $cust_bill ( $self->open_cust_bill ) {
2047     my $error = $cust_bill->apply_payments_and_credits(%options);
2048     if ( $error ) {
2049       $dbh->rollback if $oldAutoCommit;
2050       return "Error applying: $error";
2051     }
2052   }
2053
2054   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2055   ''; #no error
2056
2057 }
2058
2059 =item apply_credits OPTION => VALUE ...
2060
2061 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
2062 to outstanding invoice balances in chronological order (or reverse
2063 chronological order if the I<order> option is set to B<newest>) and returns the
2064 value of any remaining unapplied credits available for refund (see
2065 L<FS::cust_refund>).
2066
2067 Dies if there is an error.
2068
2069 =cut
2070
2071 sub apply_credits {
2072   my $self = shift;
2073   my %opt = @_;
2074
2075   local $SIG{HUP} = 'IGNORE';
2076   local $SIG{INT} = 'IGNORE';
2077   local $SIG{QUIT} = 'IGNORE';
2078   local $SIG{TERM} = 'IGNORE';
2079   local $SIG{TSTP} = 'IGNORE';
2080   local $SIG{PIPE} = 'IGNORE';
2081
2082   my $oldAutoCommit = $FS::UID::AutoCommit;
2083   local $FS::UID::AutoCommit = 0;
2084   my $dbh = dbh;
2085
2086   $self->select_for_update; #mutex
2087
2088   unless ( $self->total_unapplied_credits ) {
2089     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2090     return 0;
2091   }
2092
2093   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
2094       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
2095
2096   my @invoices = $self->open_cust_bill;
2097   @invoices = sort { $b->_date <=> $a->_date } @invoices
2098     if defined($opt{'order'}) && $opt{'order'} eq 'newest';
2099
2100   if ( $conf->exists('pkg-balances') ) {
2101     # limit @credits to those w/ a pkgnum grepped from $self
2102     my %pkgnums = ();
2103     foreach my $i (@invoices) {
2104       foreach my $li ( $i->cust_bill_pkg ) {
2105         $pkgnums{$li->pkgnum} = 1;
2106       }
2107     }
2108     @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
2109   }
2110
2111   my $credit;
2112
2113   foreach my $cust_bill ( @invoices ) {
2114
2115     if ( !defined($credit) || $credit->credited == 0) {
2116       $credit = pop @credits or last;
2117     }
2118
2119     my $owed;
2120     if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
2121       $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
2122     } else {
2123       $owed = $cust_bill->owed;
2124     }
2125     unless ( $owed > 0 ) {
2126       push @credits, $credit;
2127       next;
2128     }
2129
2130     my $amount = min( $credit->credited, $owed );
2131
2132     my $cust_credit_bill = new FS::cust_credit_bill ( {
2133       'crednum' => $credit->crednum,
2134       'invnum'  => $cust_bill->invnum,
2135       'amount'  => $amount,
2136     } );
2137     $cust_credit_bill->pkgnum( $credit->pkgnum )
2138       if $conf->exists('pkg-balances') && $credit->pkgnum;
2139     my $error = $cust_credit_bill->insert;
2140     if ( $error ) {
2141       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2142       die $error;
2143     }
2144
2145     redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2146
2147   }
2148
2149   my $total_unapplied_credits = $self->total_unapplied_credits;
2150
2151   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2152
2153   return $total_unapplied_credits;
2154 }
2155
2156 =item apply_payments  [ OPTION => VALUE ... ]
2157
2158 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2159 to outstanding invoice balances in chronological order.
2160
2161  #and returns the value of any remaining unapplied payments.
2162
2163 A hash of optional arguments may be passed.  Currently "manual" is supported.
2164 If true, a payment receipt is sent instead of a statement when
2165 'payment_receipt_email' configuration option is set.
2166
2167 Dies if there is an error.
2168
2169 =cut
2170
2171 sub apply_payments {
2172   my( $self, %options ) = @_;
2173
2174   local $SIG{HUP} = 'IGNORE';
2175   local $SIG{INT} = 'IGNORE';
2176   local $SIG{QUIT} = 'IGNORE';
2177   local $SIG{TERM} = 'IGNORE';
2178   local $SIG{TSTP} = 'IGNORE';
2179   local $SIG{PIPE} = 'IGNORE';
2180
2181   my $oldAutoCommit = $FS::UID::AutoCommit;
2182   local $FS::UID::AutoCommit = 0;
2183   my $dbh = dbh;
2184
2185   $self->select_for_update; #mutex
2186
2187   #return 0 unless
2188
2189   my @payments = sort { $b->_date <=> $a->_date }
2190                  grep { $_->unapplied > 0 }
2191                  $self->cust_pay;
2192
2193   my @invoices = sort { $a->_date <=> $b->_date}
2194                  grep { $_->owed > 0 }
2195                  $self->cust_bill;
2196
2197   if ( $conf->exists('pkg-balances') ) {
2198     # limit @payments to those w/ a pkgnum grepped from $self
2199     my %pkgnums = ();
2200     foreach my $i (@invoices) {
2201       foreach my $li ( $i->cust_bill_pkg ) {
2202         $pkgnums{$li->pkgnum} = 1;
2203       }
2204     }
2205     @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
2206   }
2207
2208   my $payment;
2209
2210   foreach my $cust_bill ( @invoices ) {
2211
2212     if ( !defined($payment) || $payment->unapplied == 0 ) {
2213       $payment = pop @payments or last;
2214     }
2215
2216     my $owed;
2217     if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
2218       $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
2219     } else {
2220       $owed = $cust_bill->owed;
2221     }
2222     unless ( $owed > 0 ) {
2223       push @payments, $payment;
2224       next;
2225     }
2226
2227     my $amount = min( $payment->unapplied, $owed );
2228
2229     my $cust_bill_pay = new FS::cust_bill_pay ( {
2230       'paynum' => $payment->paynum,
2231       'invnum' => $cust_bill->invnum,
2232       'amount' => $amount,
2233     } );
2234     $cust_bill_pay->pkgnum( $payment->pkgnum )
2235       if $conf->exists('pkg-balances') && $payment->pkgnum;
2236     my $error = $cust_bill_pay->insert(%options);
2237     if ( $error ) {
2238       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
2239       die $error;
2240     }
2241
2242     redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
2243
2244   }
2245
2246   my $total_unapplied_payments = $self->total_unapplied_payments;
2247
2248   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2249
2250   return $total_unapplied_payments;
2251 }
2252
2253 =head1 BUGS
2254
2255 =head1 SEE ALSO
2256
2257 L<FS::cust_main>, L<FS::cust_main::Billing_Realtime>
2258
2259 =cut
2260
2261 1;