FS/FS/cust_bill.pm

   1 package FS::cust_bill;
   2
   3 use strict;
   4 use vars qw( @ISA $DEBUG $me $conf $money_char );
   5 use vars qw( $invoice_lines @buf ); #yuck
   6 use Fcntl qw(:flock); #for spool_csv
   7 use List::Util qw(min max);
   8 use Date::Format;
   9 use Text::Template 1.20;
  10 use File::Temp 0.14;
  11 use String::ShellQuote;
  12 use HTML::Entities;
  13 use Locale::Country;
  14 use FS::UID qw( datasrc );
  15 use FS::Misc qw( send_email send_fax generate_ps generate_pdf do_print );
  16 use FS::Record qw( qsearch qsearchs dbh );
  17 use FS::cust_main_Mixin;
  18 use FS::cust_main;
  19 use FS::cust_bill_pkg;
  20 use FS::cust_credit;
  21 use FS::cust_pay;
  22 use FS::cust_pkg;
  23 use FS::cust_credit_bill;
  24 use FS::pay_batch;
  25 use FS::cust_pay_batch;
  26 use FS::cust_bill_event;
  27 use FS::cust_event;
  28 use FS::part_pkg;
  29 use FS::cust_bill_pay;
  30 use FS::cust_bill_pay_batch;
  31 use FS::part_bill_event;
  32 use FS::payby;
  33
  34 @ISA = qw( FS::cust_main_Mixin FS::Record );
  35
  36 $DEBUG = 0;
  37 $me = '[FS::cust_bill]';
  38
  39 #ask FS::UID to run this stuff for us later
  40 FS::UID->install_callback( sub {
  41   $conf = new FS::Conf;
  42   $money_char = $conf->config('money_char') || '$';
  43 } );
  44
  45 =head1 NAME
  46
  47 FS::cust_bill - Object methods for cust_bill records
  48
  49 =head1 SYNOPSIS
  50
  51   use FS::cust_bill;
  52
  53   $record = new FS::cust_bill \%hash;
  54   $record = new FS::cust_bill { 'column' => 'value' };
  55
  56   $error = $record->insert;
  57
  58   $error = $new_record->replace($old_record);
  59
  60   $error = $record->delete;
  61
  62   $error = $record->check;
  63
  64   ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
  65
  66   @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
  67
  68   ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
  69
  70   @cust_pay_objects = $cust_bill->cust_pay;
  71
  72   $tax_amount = $record->tax;
  73
  74   @lines = $cust_bill->print_text;
  75   @lines = $cust_bill->print_text $time;
  76
  77 =head1 DESCRIPTION
  78
  79 An FS::cust_bill object represents an invoice; a declaration that a customer
  80 owes you money.  The specific charges are itemized as B<cust_bill_pkg> records
  81 (see L<FS::cust_bill_pkg>).  FS::cust_bill inherits from FS::Record.  The
  82 following fields are currently supported:
  83
  84 =over 4
  85
  86 =item invnum - primary key (assigned automatically for new invoices)
  87
  88 =item custnum - customer (see L<FS::cust_main>)
  89
  90 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
  91 L<Time::Local> and L<Date::Parse> for conversion functions.
  92
  93 =item charged - amount of this invoice
  94
  95 =item printed - deprecated
  96
  97 =item closed - books closed flag, empty or `Y'
  98
  99 =back
 100
 101 =head1 METHODS
 102
 103 =over 4
 104
 105 =item new HASHREF
 106
 107 Creates a new invoice.  To add the invoice to the database, see L<"insert">.
 108 Invoices are normally created by calling the bill method of a customer object
 109 (see L<FS::cust_main>).
 110
 111 =cut
 112
 113 sub table { 'cust_bill'; }
 114
 115 sub cust_linked { $_[0]->cust_main_custnum; }
 116 sub cust_unlinked_msg {
 117   my $self = shift;
 118   "WARNING: can't find cust_main.custnum ". $self->custnum.
 119   ' (cust_bill.invnum '. $self->invnum. ')';
 120 }
 121
 122 =item insert
 123
 124 Adds this invoice to the database ("Posts" the invoice).  If there is an error,
 125 returns the error, otherwise returns false.
 126
 127 =item delete
 128
 129 This method now works but you probably shouldn't use it.  Instead, apply a
 130 credit against the invoice.
 131
 132 Using this method to delete invoices outright is really, really bad.  There
 133 would be no record you ever posted this invoice, and there are no check to
 134 make sure charged = 0 or that there are no associated cust_bill_pkg records.
 135
 136 Really, don't use it.
 137
 138 =cut
 139
 140 sub delete {
 141   my $self = shift;
 142   return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
 143   $self->SUPER::delete(@_);
 144 }
 145
 146 =item replace OLD_RECORD
 147
 148 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 149 returns the error, otherwise returns false.
 150
 151 Only printed may be changed.  printed is normally updated by calling the
 152 collect method of a customer object (see L<FS::cust_main>).
 153
 154 =cut
 155
 156 #replace can be inherited from Record.pm
 157
 158 # replace_check is now the preferred way to #implement replace data checks
 159 # (so $object->replace() works without an argument)
 160
 161 sub replace_check {
 162   my( $new, $old ) = ( shift, shift );
 163   return "Can't change custnum!" unless $old->custnum == $new->custnum;
 164   #return "Can't change _date!" unless $old->_date eq $new->_date;
 165   return "Can't change _date!" unless $old->_date == $new->_date;
 166   return "Can't change charged!" unless $old->charged == $new->charged
 167                                      || $old->charged == 0;
 168
 169   '';
 170 }
 171
 172 =item check
 173
 174 Checks all fields to make sure this is a valid invoice.  If there is an error,
 175 returns the error, otherwise returns false.  Called by the insert and replace
 176 methods.
 177
 178 =cut
 179
 180 sub check {
 181   my $self = shift;
 182
 183   my $error =
 184     $self->ut_numbern('invnum')
 185     || $self->ut_number('custnum')
 186     || $self->ut_numbern('_date')
 187     || $self->ut_money('charged')
 188     || $self->ut_numbern('printed')
 189     || $self->ut_enum('closed', [ '', 'Y' ])
 190   ;
 191   return $error if $error;
 192
 193   return "Unknown customer"
 194     unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
 195
 196   $self->_date(time) unless $self->_date;
 197
 198   $self->printed(0) if $self->printed eq '';
 199
 200   $self->SUPER::check;
 201 }
 202
 203 =item previous
 204
 205 Returns a list consisting of the total previous balance for this customer,
 206 followed by the previous outstanding invoices (as FS::cust_bill objects also).
 207
 208 =cut
 209
 210 sub previous {
 211   my $self = shift;
 212   my $total = 0;
 213   my @cust_bill = sort { $a->_date <=> $b->_date }
 214     grep { $_->owed != 0 && $_->_date < $self->_date }
 215       qsearch( 'cust_bill', { 'custnum' => $self->custnum } )
 216   ;
 217   foreach ( @cust_bill ) { $total += $_->owed; }
 218   $total, @cust_bill;
 219 }
 220
 221 =item cust_bill_pkg
 222
 223 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
 224
 225 =cut
 226
 227 sub cust_bill_pkg {
 228   my $self = shift;
 229   qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum } );
 230 }
 231
 232 =item cust_pkg
 233
 234 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
 235 this invoice.
 236
 237 =cut
 238
 239 sub cust_pkg {
 240   my $self = shift;
 241   my @cust_pkg = map { $_->cust_pkg } $self->cust_bill_pkg;
 242   my %saw = ();
 243   grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
 244 }
 245
 246 =item open_cust_bill_pkg
 247
 248 Returns the open line items for this invoice.
 249
 250 Note that cust_bill_pkg with both setup and recur fees are returned as two
 251 separate line items, each with only one fee.
 252
 253 =cut
 254
 255 # modeled after cust_main::open_cust_bill
 256 sub open_cust_bill_pkg {
 257   my $self = shift;
 258
 259   # grep { $_->owed > 0 } $self->cust_bill_pkg
 260
 261   my %other = ( 'recur' => 'setup',
 262                 'setup' => 'recur', );
 263   my @open = ();
 264   foreach my $field ( qw( recur setup )) {
 265     push @open, map  { $_->set( $other{$field}, 0 ); $_; }
 266                 grep { $_->owed($field) > 0 }
 267                 $self->cust_bill_pkg;
 268   }
 269
 270   @open;
 271 }
 272
 273 =item cust_bill_event
 274
 275 Returns the completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
 276
 277 =cut
 278
 279 sub cust_bill_event {
 280   my $self = shift;
 281   qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
 282 }
 283
 284 =item num_cust_bill_event
 285
 286 Returns the number of completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
 287
 288 =cut
 289
 290 sub num_cust_bill_event {
 291   my $self = shift;
 292   my $sql =
 293     "SELECT COUNT(*) FROM cust_bill_event WHERE invnum = ?";
 294   my $sth = dbh->prepare($sql) or die  dbh->errstr. " preparing $sql";
 295   $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
 296   $sth->fetchrow_arrayref->[0];
 297 }
 298
 299 =item cust_event
 300
 301 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
 302
 303 =cut
 304
 305 #false laziness w/cust_pkg.pm
 306 sub cust_event {
 307   my $self = shift;
 308   qsearch({
 309     'table'     => 'cust_event',
 310     'addl_from' => 'JOIN part_event USING ( eventpart )',
 311     'hashref'   => { 'tablenum' => $self->invnum },
 312     'extra_sql' => " AND eventtable = 'cust_bill' ",
 313   });
 314 }
 315
 316 =item num_cust_event
 317
 318 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
 319
 320 =cut
 321
 322 #false laziness w/cust_pkg.pm
 323 sub num_cust_event {
 324   my $self = shift;
 325   my $sql =
 326     "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
 327     "  WHERE tablenum = ? AND eventtable = 'cust_bill'";
 328   my $sth = dbh->prepare($sql) or die  dbh->errstr. " preparing $sql";
 329   $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
 330   $sth->fetchrow_arrayref->[0];
 331 }
 332
 333 =item cust_main
 334
 335 Returns the customer (see L<FS::cust_main>) for this invoice.
 336
 337 =cut
 338
 339 sub cust_main {
 340   my $self = shift;
 341   qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
 342 }
 343
 344 =item cust_suspend_if_balance_over AMOUNT
 345
 346 Suspends the customer associated with this invoice if the total amount owed on
 347 this invoice and all older invoices is greater than the specified amount.
 348
 349 Returns a list: an empty list on success or a list of errors.
 350
 351 =cut
 352
 353 sub cust_suspend_if_balance_over {
 354   my( $self, $amount ) = ( shift, shift );
 355   my $cust_main = $self->cust_main;
 356   if ( $cust_main->total_owed_date($self->_date) < $amount ) {
 357     return ();
 358   } else {
 359     $cust_main->suspend(@_);
 360   }
 361 }
 362
 363 =item cust_credit
 364
 365 Depreciated.  See the cust_credited method.
 366
 367  #Returns a list consisting of the total previous credited (see
 368  #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
 369  #outstanding credits (FS::cust_credit objects).
 370
 371 =cut
 372
 373 sub cust_credit {
 374   use Carp;
 375   croak "FS::cust_bill->cust_credit depreciated; see ".
 376         "FS::cust_bill->cust_credit_bill";
 377   #my $self = shift;
 378   #my $total = 0;
 379   #my @cust_credit = sort { $a->_date <=> $b->_date }
 380   #  grep { $_->credited != 0 && $_->_date < $self->_date }
 381   #    qsearch('cust_credit', { 'custnum' => $self->custnum } )
 382   #;
 383   #foreach (@cust_credit) { $total += $_->credited; }
 384   #$total, @cust_credit;
 385 }
 386
 387 =item cust_pay
 388
 389 Depreciated.  See the cust_bill_pay method.
 390
 391 #Returns all payments (see L<FS::cust_pay>) for this invoice.
 392
 393 =cut
 394
 395 sub cust_pay {
 396   use Carp;
 397   croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
 398   #my $self = shift;
 399   #sort { $a->_date <=> $b->_date }
 400   #  qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
 401   #;
 402 }
 403
 404 =item cust_bill_pay
 405
 406 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
 407
 408 =cut
 409
 410 sub cust_bill_pay {
 411   my $self = shift;
 412   sort { $a->_date <=> $b->_date }
 413     qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
 414 }
 415
 416 =item cust_credited
 417
 418 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
 419
 420 =cut
 421
 422 sub cust_credited {
 423   my $self = shift;
 424   sort { $a->_date <=> $b->_date }
 425     qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
 426   ;
 427 }
 428
 429 =item tax
 430
 431 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
 432
 433 =cut
 434
 435 sub tax {
 436   my $self = shift;
 437   my $total = 0;
 438   my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
 439                                              'pkgnum' => 0 } );
 440   foreach (@taxlines) { $total += $_->setup; }
 441   $total;
 442 }
 443
 444 =item owed
 445
 446 Returns the amount owed (still outstanding) on this invoice, which is charged
 447 minus all payment applications (see L<FS::cust_bill_pay>) and credit
 448 applications (see L<FS::cust_credit_bill>).
 449
 450 =cut
 451
 452 sub owed {
 453   my $self = shift;
 454   my $balance = $self->charged;
 455   $balance -= $_->amount foreach ( $self->cust_bill_pay );
 456   $balance -= $_->amount foreach ( $self->cust_credited );
 457   $balance = sprintf( "%.2f", $balance);
 458   $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
 459   $balance;
 460 }
 461
 462 =item apply_payments_and_credits
 463
 464 =cut
 465
 466 sub apply_payments_and_credits {
 467   my $self = shift;
 468
 469   local $SIG{HUP} = 'IGNORE';
 470   local $SIG{INT} = 'IGNORE';
 471   local $SIG{QUIT} = 'IGNORE';
 472   local $SIG{TERM} = 'IGNORE';
 473   local $SIG{TSTP} = 'IGNORE';
 474   local $SIG{PIPE} = 'IGNORE';
 475
 476   my $oldAutoCommit = $FS::UID::AutoCommit;
 477   local $FS::UID::AutoCommit = 0;
 478   my $dbh = dbh;
 479
 480   $self->select_for_update; #mutex
 481
 482   my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
 483   my @credits  = grep { $_->credited > 0 } $self->cust_main->cust_credit;
 484
 485   while ( $self->owed > 0 and ( @payments || @credits ) ) {
 486
 487     my $app = '';
 488     if ( @payments && @credits ) {
 489
 490       #decide which goes first by weight of top (unapplied) line item
 491
 492       my @open_lineitems = $self->open_cust_bill_pkg;
 493
 494       my $max_pay_weight =
 495         max( map  { $_->part_pkg->pay_weight || 0 }
 496              grep { $_ }
 497              map  { $_->cust_pkg }
 498                   @open_lineitems
 499            );
 500       my $max_credit_weight =
 501         max( map  { $_->part_pkg->credit_weight || 0 }
 502              grep { $_ }
 503              map  { $_->cust_pkg }
 504                   @open_lineitems
 505            );
 506
 507       #if both are the same... payments first?  it has to be something
 508       if ( $max_pay_weight >= $max_credit_weight ) {
 509         $app = 'pay';
 510       } else {
 511         $app = 'credit';
 512       }
 513
 514     } elsif ( @payments ) {
 515       $app = 'pay';
 516     } elsif ( @credits ) {
 517       $app = 'credit';
 518     } else {
 519       die "guru meditation #12 and 35";
 520     }
 521
 522     if ( $app eq 'pay' ) {
 523
 524       my $payment = shift @payments;
 525
 526       $app = new FS::cust_bill_pay {
 527         'paynum'  => $payment->paynum,
 528         'amount'  => sprintf('%.2f', min( $payment->unapplied, $self->owed ) ),
 529       };
 530
 531     } elsif ( $app eq 'credit' ) {
 532
 533       my $credit = shift @credits;
 534
 535       $app = new FS::cust_credit_bill {
 536         'crednum' => $credit->crednum,
 537         'amount'  => sprintf('%.2f', min( $credit->credited, $self->owed ) ),
 538       };
 539
 540     } else {
 541       die "guru meditation #12 and 35";
 542     }
 543
 544     $app->invnum( $self->invnum );
 545
 546     my $error = $app->insert;
 547     if ( $error ) {
 548       $dbh->rollback if $oldAutoCommit;
 549       return "Error inserting ". $app->table. " record: $error";
 550     }
 551     die $error if $error;
 552
 553   }
 554
 555   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 556   ''; #no error
 557
 558 }
 559
 560 =item generate_email PARAMHASH
 561
 562 PARAMHASH can contain the following:
 563
 564 =over 4
 565
 566 =item from       => sender address, required
 567
 568 =item tempate    => alternate template name, optional
 569
 570 =item print_text => text attachment arrayref, optional
 571
 572 =item subject    => email subject, optional
 573
 574 =back
 575
 576 Returns an argument list to be passed to L<FS::Misc::send_email>.
 577
 578 =cut
 579
 580 use MIME::Entity;
 581
 582 sub generate_email {
 583
 584   my $self = shift;
 585   my %args = @_;
 586
 587   my $me = '[FS::cust_bill::generate_email]';
 588
 589   my %return = (
 590     'from'      => $args{'from'},
 591     'subject'   => (($args{'subject'}) ? $args{'subject'} : 'Invoice'),
 592   );
 593
 594   if (ref($args{'to'}) eq 'ARRAY') {
 595     $return{'to'} = $args{'to'};
 596   } else {
 597     $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
 598                            $self->cust_main->invoicing_list
 599                     ];
 600   }
 601
 602   if ( $conf->exists('invoice_html') ) {
 603
 604     warn "$me creating HTML/text multipart message"
 605       if $DEBUG;
 606
 607     $return{'nobody'} = 1;
 608
 609     my $alternative = build MIME::Entity
 610       'Type'        => 'multipart/alternative',
 611       'Encoding'    => '7bit',
 612       'Disposition' => 'inline'
 613     ;
 614
 615     my $data;
 616     if ( $conf->exists('invoice_email_pdf')
 617          and scalar($conf->config('invoice_email_pdf_note')) ) {
 618
 619       warn "$me using 'invoice_email_pdf_note' in multipart message"
 620         if $DEBUG;
 621       $data = [ map { $_ . "\n" }
 622                     $conf->config('invoice_email_pdf_note')
 623               ];
 624
 625     } else {
 626
 627       warn "$me not using 'invoice_email_pdf_note' in multipart message"
 628         if $DEBUG;
 629       if ( ref($args{'print_text'}) eq 'ARRAY' ) {
 630         $data = $args{'print_text'};
 631       } else {
 632         $data = [ $self->print_text('', $args{'template'}) ];
 633       }
 634
 635     }
 636
 637     $alternative->attach(
 638       'Type'        => 'text/plain',
 639       #'Encoding'    => 'quoted-printable',
 640       'Encoding'    => '7bit',
 641       'Data'        => $data,
 642       'Disposition' => 'inline',
 643     );
 644
 645     $args{'from'} =~ /\@([\w\.\-]+)/;
 646     my $from = $1 || 'example.com';
 647     my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
 648
 649     my $path = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
 650     my $file;
 651     if ( defined($args{'template'}) && length($args{'template'})
 652          && -e "$path/logo_". $args{'template'}. ".png"
 653        )
 654     {
 655       $file = "$path/logo_". $args{'template'}. ".png";
 656     } else {
 657       $file = "$path/logo.png";
 658     }
 659
 660     my $image = build MIME::Entity
 661       'Type'       => 'image/png',
 662       'Encoding'   => 'base64',
 663       'Path'       => $file,
 664       'Filename'   => 'logo.png',
 665       'Content-ID' => "<$content_id>",
 666     ;
 667
 668     $alternative->attach(
 669       'Type'        => 'text/html',
 670       'Encoding'    => 'quoted-printable',
 671       'Data'        => [ '<html>',
 672                          '  <head>',
 673                          '    <title>',
 674                          '      '. encode_entities($return{'subject'}),
 675                          '    </title>',
 676                          '  </head>',
 677                          '  <body bgcolor="#e8e8e8">',
 678                          $self->print_html('', $args{'template'}, $content_id),
 679                          '  </body>',
 680                          '</html>',
 681                        ],
 682       'Disposition' => 'inline',
 683       #'Filename'    => 'invoice.pdf',
 684     );
 685
 686     if ( $conf->exists('invoice_email_pdf') ) {
 687
 688       #attaching pdf too:
 689       # multipart/mixed
 690       #   multipart/related
 691       #     multipart/alternative
 692       #       text/plain
 693       #       text/html
 694       #     image/png
 695       #   application/pdf
 696
 697       my $related = build MIME::Entity 'Type'     => 'multipart/related',
 698                                        'Encoding' => '7bit';
 699
 700       #false laziness w/Misc::send_email
 701       $related->head->replace('Content-type',
 702         $related->mime_type.
 703         '; boundary="'. $related->head->multipart_boundary. '"'.
 704         '; type=multipart/alternative'
 705       );
 706
 707       $related->add_part($alternative);
 708
 709       $related->add_part($image);
 710
 711       my $pdf = build MIME::Entity $self->mimebuild_pdf('', $args{'template'});
 712
 713       $return{'mimeparts'} = [ $related, $pdf ];
 714
 715     } else {
 716
 717       #no other attachment:
 718       # multipart/related
 719       #   multipart/alternative
 720       #     text/plain
 721       #     text/html
 722       #   image/png
 723
 724       $return{'content-type'} = 'multipart/related';
 725       $return{'mimeparts'} = [ $alternative, $image ];
 726       $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
 727       #$return{'disposition'} = 'inline';
 728
 729     }
 730
 731   } else {
 732
 733     if ( $conf->exists('invoice_email_pdf') ) {
 734       warn "$me creating PDF attachment"
 735         if $DEBUG;
 736
 737       #mime parts arguments a la MIME::Entity->build().
 738       $return{'mimeparts'} = [
 739         { $self->mimebuild_pdf('', $args{'template'}) }
 740       ];
 741     }
 742
 743     if ( $conf->exists('invoice_email_pdf')
 744          and scalar($conf->config('invoice_email_pdf_note')) ) {
 745
 746       warn "$me using 'invoice_email_pdf_note'"
 747         if $DEBUG;
 748       $return{'body'} = [ map { $_ . "\n" }
 749                               $conf->config('invoice_email_pdf_note')
 750                         ];
 751
 752     } else {
 753
 754       warn "$me not using 'invoice_email_pdf_note'"
 755         if $DEBUG;
 756       if ( ref($args{'print_text'}) eq 'ARRAY' ) {
 757         $return{'body'} = $args{'print_text'};
 758       } else {
 759         $return{'body'} = [ $self->print_text('', $args{'template'}) ];
 760       }
 761
 762     }
 763
 764   }
 765
 766   %return;
 767
 768 }
 769
 770 =item mimebuild_pdf
 771
 772 Returns a list suitable for passing to MIME::Entity->build(), representing
 773 this invoice as PDF attachment.
 774
 775 =cut
 776
 777 sub mimebuild_pdf {
 778   my $self = shift;
 779   (
 780     'Type'        => 'application/pdf',
 781     'Encoding'    => 'base64',
 782     'Data'        => [ $self->print_pdf(@_) ],
 783     'Disposition' => 'attachment',
 784     'Filename'    => 'invoice.pdf',
 785   );
 786 }
 787
 788 =item send [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
 789
 790 Sends this invoice to the destinations configured for this customer: sends
 791 email, prints and/or faxes.  See L<FS::cust_main_invoice>.
 792
 793 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
 794
 795 AGENTNUM, if specified, means that this invoice will only be sent for customers
 796 of the specified agent or agent(s).  AGENTNUM can be a scalar agentnum (for a
 797 single agent) or an arrayref of agentnums.
 798
 799 INVOICE_FROM, if specified, overrides the default email invoice From: address.
 800
 801 AMOUNT, if specified, only sends the invoice if the total amount owed on this
 802 invoice and all older invoices is greater than the specified amount.
 803
 804 =cut
 805
 806 sub queueable_send {
 807   my %opt = @_;
 808
 809   my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
 810     or die "invalid invoice number: " . $opt{invnum};
 811
 812   my @args = ( $opt{template}, $opt{agentnum} );
 813   push @args, $opt{invoice_from}
 814     if exists($opt{invoice_from}) && $opt{invoice_from};
 815
 816   my $error = $self->send( @args );
 817   die $error if $error;
 818
 819 }
 820
 821 sub send {
 822   my $self = shift;
 823   my $template = scalar(@_) ? shift : '';
 824   if ( scalar(@_) && $_[0]  ) {
 825     my $agentnums = ref($_[0]) ? shift : [ shift ];
 826     return 'N/A' unless grep { $_ == $self->cust_main->agentnum } @$agentnums;
 827   }
 828
 829   my $invoice_from =
 830     scalar(@_)
 831       ? shift
 832       : ( $self->_agent_invoice_from || $conf->config('invoice_from') );
 833
 834   my $balance_over = ( scalar(@_) && $_[0] !~ /^\s*$/ ) ? shift : 0;
 835
 836   return ''
 837     unless $self->cust_main->total_owed_date($self->_date) > $balance_over;
 838
 839   my @invoicing_list = $self->cust_main->invoicing_list;
 840
 841   $self->email($template, $invoice_from)
 842     if grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list;
 843
 844   $self->print($template)
 845     if grep { $_ eq 'POST' } @invoicing_list; #postal
 846
 847   $self->fax($template)
 848     if grep { $_ eq 'FAX' } @invoicing_list; #fax
 849
 850   '';
 851
 852 }
 853
 854 =item email [ TEMPLATENAME  [ , INVOICE_FROM ] ]
 855
 856 Emails this invoice.
 857
 858 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
 859
 860 INVOICE_FROM, if specified, overrides the default email invoice From: address.
 861
 862 =cut
 863
 864 sub queueable_email {
 865   my %opt = @_;
 866
 867   my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
 868     or die "invalid invoice number: " . $opt{invnum};
 869
 870   my @args = ( $opt{template} );
 871   push @args, $opt{invoice_from}
 872     if exists($opt{invoice_from}) && $opt{invoice_from};
 873
 874   my $error = $self->email( @args );
 875   die $error if $error;
 876
 877 }
 878
 879 sub email {
 880   my $self = shift;
 881   my $template = scalar(@_) ? shift : '';
 882   my $invoice_from =
 883     scalar(@_)
 884       ? shift
 885       : ( $self->_agent_invoice_from || $conf->config('invoice_from') );
 886
 887   my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
 888                             $self->cust_main->invoicing_list;
 889
 890   #better to notify this person than silence
 891   @invoicing_list = ($invoice_from) unless @invoicing_list;
 892
 893   my $error = send_email(
 894     $self->generate_email(
 895       'from'       => $invoice_from,
 896       'to'         => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
 897       'template'   => $template,
 898     )
 899   );
 900   die "can't email invoice: $error\n" if $error;
 901   #die "$error\n" if $error;
 902
 903 }
 904
 905 =item lpr_data [ TEMPLATENAME ]
 906
 907 Returns the postscript or plaintext for this invoice as an arrayref.
 908
 909 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
 910
 911 =cut
 912
 913 sub lpr_data {
 914   my( $self, $template) = @_;
 915   $conf->exists('invoice_latex')
 916     ? [ $self->print_ps('', $template) ]
 917     : [ $self->print_text('', $template) ];
 918 }
 919
 920 =item print [ TEMPLATENAME ]
 921
 922 Prints this invoice.
 923
 924 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
 925
 926 =cut
 927
 928 sub print {
 929   my $self = shift;
 930   my $template = scalar(@_) ? shift : '';
 931
 932   do_print $self->lpr_data($template);
 933 }
 934
 935 =item fax [ TEMPLATENAME ]
 936
 937 Faxes this invoice.
 938
 939 TEMPLATENAME, if specified, is the name of a suffix for alternate invoices.
 940
 941 =cut
 942
 943 sub fax {
 944   my $self = shift;
 945   my $template = scalar(@_) ? shift : '';
 946
 947   die 'FAX invoice destination not (yet?) supported with plain text invoices.'
 948     unless $conf->exists('invoice_latex');
 949
 950   my $dialstring = $self->cust_main->getfield('fax');
 951   #Check $dialstring?
 952
 953   my $error = send_fax( 'docdata'    => $self->lpr_data($template),
 954                         'dialstring' => $dialstring,
 955                       );
 956   die $error if $error;
 957
 958 }
 959
 960 =item send_if_newest [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
 961
 962 Like B<send>, but only sends the invoice if it is the newest open invoice for
 963 this customer.
 964
 965 =cut
 966
 967 sub send_if_newest {
 968   my $self = shift;
 969
 970   return ''
 971     if scalar(
 972                grep { $_->owed > 0 }
 973                     qsearch('cust_bill', {
 974                       'custnum' => $self->custnum,
 975                       #'_date'   => { op=>'>', value=>$self->_date },
 976                       'invnum'  => { op=>'>', value=>$self->invnum },
 977                     } )
 978              );
 979
 980   $self->send(@_);
 981 }
 982
 983 =item send_csv OPTION => VALUE, ...
 984
 985 Sends invoice as a CSV data-file to a remote host with the specified protocol.
 986
 987 Options are:
 988
 989 protocol - currently only "ftp"
 990 server
 991 username
 992 password
 993 dir
 994
 995 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
 996 and YYMMDDHHMMSS is a timestamp.
 997
 998 See L</print_csv> for a description of the output format.
 999
1000 =cut
1001
1002 sub send_csv {
1003   my($self, %opt) = @_;
1004
1005   #create file(s)
1006
1007   my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1008   mkdir $spooldir, 0700 unless -d $spooldir;
1009
1010   my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1011   my $file = "$spooldir/$tracctnum.csv";
1012
1013   my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1014
1015   open(CSV, ">$file") or die "can't open $file: $!";
1016   print CSV $header;
1017
1018   print CSV $detail;
1019
1020   close CSV;
1021
1022   my $net;
1023   if ( $opt{protocol} eq 'ftp' ) {
1024     eval "use Net::FTP;";
1025     die $@ if $@;
1026     $net = Net::FTP->new($opt{server}) or die @$;
1027   } else {
1028     die "unknown protocol: $opt{protocol}";
1029   }
1030
1031   $net->login( $opt{username}, $opt{password} )
1032     or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1033
1034   $net->binary or die "can't set binary mode";
1035
1036   $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1037
1038   $net->put($file) or die "can't put $file: $!";
1039
1040   $net->quit;
1041
1042   unlink $file;
1043
1044 }
1045
1046 =item spool_csv
1047
1048 Spools CSV invoice data.
1049
1050 Options are:
1051
1052 =over 4
1053
1054 =item format - 'default' or 'billco'
1055
1056 =item dest - if set (to POST, EMAIL or FAX), only sends spools invoices if the customer has the corresponding invoice destinations set (see L<FS::cust_main_invoice>).
1057
1058 =item agent_spools - if set to a true value, will spool to per-agent files rather than a single global file
1059
1060 =item balanceover - if set, only spools the invoice if the total amount owed on this invoice and all older invoices is greater than the specified amount.
1061
1062 =back
1063
1064 =cut
1065
1066 sub spool_csv {
1067   my($self, %opt) = @_;
1068
1069   my $cust_main = $self->cust_main;
1070
1071   if ( $opt{'dest'} ) {
1072     my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1073                              $cust_main->invoicing_list;
1074     return 'N/A' unless $invoicing_list{$opt{'dest'}}
1075                      || ! keys %invoicing_list;
1076   }
1077
1078   if ( $opt{'balanceover'} ) {
1079     return 'N/A'
1080       if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1081   }
1082
1083   my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1084   mkdir $spooldir, 0700 unless -d $spooldir;
1085
1086   my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1087
1088   my $file =
1089     "$spooldir/".
1090     ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1091     ( lc($opt{'format'}) eq 'billco' ? '-header' : '' ) .
1092     '.csv';
1093
1094   my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1095
1096   open(CSV, ">>$file") or die "can't open $file: $!";
1097   flock(CSV, LOCK_EX);
1098   seek(CSV, 0, 2);
1099
1100   print CSV $header;
1101
1102   if ( lc($opt{'format'}) eq 'billco' ) {
1103
1104     flock(CSV, LOCK_UN);
1105     close CSV;
1106
1107     $file =
1108       "$spooldir/".
1109       ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1110       '-detail.csv';
1111
1112     open(CSV,">>$file") or die "can't open $file: $!";
1113     flock(CSV, LOCK_EX);
1114     seek(CSV, 0, 2);
1115   }
1116
1117   print CSV $detail;
1118
1119   flock(CSV, LOCK_UN);
1120   close CSV;
1121
1122   return '';
1123
1124 }
1125
1126 =item print_csv OPTION => VALUE, ...
1127
1128 Returns CSV data for this invoice.
1129
1130 Options are:
1131
1132 format - 'default' or 'billco'
1133
1134 Returns a list consisting of two scalars.  The first is a single line of CSV
1135 header information for this invoice.  The second is one or more lines of CSV
1136 detail information for this invoice.
1137
1138 If I<format> is not specified or "default", the fields of the CSV file are as
1139 follows:
1140
1141 record_type, invnum, custnum, _date, charged, first, last, company, address1, address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1142
1143 =over 4
1144
1145 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1146
1147 B<record_type> is C<cust_bill> for the initial header line only.  The
1148 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1149 fields are filled in.
1150
1151 B<record_type> is C<cust_bill_pkg> for detail lines.  Only the first two fields
1152 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1153 are filled in.
1154
1155 =item invnum - invoice number
1156
1157 =item custnum - customer number
1158
1159 =item _date - invoice date
1160
1161 =item charged - total invoice amount
1162
1163 =item first - customer first name
1164
1165 =item last - customer first name
1166
1167 =item company - company name
1168
1169 =item address1 - address line 1
1170
1171 =item address2 - address line 1
1172
1173 =item city
1174
1175 =item state
1176
1177 =item zip
1178
1179 =item country
1180
1181 =item pkg - line item description
1182
1183 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1184
1185 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1186
1187 =item sdate - start date for recurring fee
1188
1189 =item edate - end date for recurring fee
1190
1191 =back
1192
1193 If I<format> is "billco", the fields of the header CSV file are as follows:
1194
1195   +-------------------------------------------------------------------+
1196   |                        FORMAT HEADER FILE                         |
1197   |-------------------------------------------------------------------|
1198   | Field | Description                   | Name       | Type | Width |
1199   | 1     | N/A-Leave Empty               | RC         | CHAR |     2 |
1200   | 2     | N/A-Leave Empty               | CUSTID     | CHAR |    15 |
1201   | 3     | Transaction Account No        | TRACCTNUM  | CHAR |    15 |
1202   | 4     | Transaction Invoice No        | TRINVOICE  | CHAR |    15 |
1203   | 5     | Transaction Zip Code          | TRZIP      | CHAR |     5 |
1204   | 6     | Transaction Company Bill To   | TRCOMPANY  | CHAR |    30 |
1205   | 7     | Transaction Contact Bill To   | TRNAME     | CHAR |    30 |
1206   | 8     | Additional Address Unit Info  | TRADDR1    | CHAR |    30 |
1207   | 9     | Bill To Street Address        | TRADDR2    | CHAR |    30 |
1208   | 10    | Ancillary Billing Information | TRADDR3    | CHAR |    30 |
1209   | 11    | Transaction City Bill To      | TRCITY     | CHAR |    20 |
1210   | 12    | Transaction State Bill To     | TRSTATE    | CHAR |     2 |
1211   | 13    | Bill Cycle Close Date         | CLOSEDATE  | CHAR |    10 |
1212   | 14    | Bill Due Date                 | DUEDATE    | CHAR |    10 |
1213   | 15    | Previous Balance              | BALFWD     | NUM* |     9 |
1214   | 16    | Pmt/CR Applied                | CREDAPPLY  | NUM* |     9 |
1215   | 17    | Total Current Charges         | CURRENTCHG | NUM* |     9 |
1216   | 18    | Total Amt Due                 | TOTALDUE   | NUM* |     9 |
1217   | 19    | Total Amt Due                 | AMTDUE     | NUM* |     9 |
1218   | 20    | 30 Day Aging                  | AMT30      | NUM* |     9 |
1219   | 21    | 60 Day Aging                  | AMT60      | NUM* |     9 |
1220   | 22    | 90 Day Aging                  | AMT90      | NUM* |     9 |
1221   | 23    | Y/N                           | AGESWITCH  | CHAR |     1 |
1222   | 24    | Remittance automation         | SCANLINE   | CHAR |   100 |
1223   | 25    | Total Taxes & Fees            | TAXTOT     | NUM* |     9 |
1224   | 26    | Customer Reference Number     | CUSTREF    | CHAR |    15 |
1225   | 27    | Federal Tax***                | FEDTAX     | NUM* |     9 |
1226   | 28    | State Tax***                  | STATETAX   | NUM* |     9 |
1227   | 29    | Other Taxes & Fees***         | OTHERTAX   | NUM* |     9 |
1228   +-------+-------------------------------+------------+------+-------+
1229
1230 If I<format> is "billco", the fields of the detail CSV file are as follows:
1231
1232                                   FORMAT FOR DETAIL FILE
1233         |                            |           |      |
1234   Field | Description                | Name      | Type | Width
1235   1     | N/A-Leave Empty            | RC        | CHAR |     2
1236   2     | N/A-Leave Empty            | CUSTID    | CHAR |    15
1237   3     | Account Number             | TRACCTNUM | CHAR |    15
1238   4     | Invoice Number             | TRINVOICE | CHAR |    15
1239   5     | Line Sequence (sort order) | LINESEQ   | NUM  |     6
1240   6     | Transaction Detail         | DETAILS   | CHAR |   100
1241   7     | Amount                     | AMT       | NUM* |     9
1242   8     | Line Format Control**      | LNCTRL    | CHAR |     2
1243   9     | Grouping Code              | GROUP     | CHAR |     2
1244   10    | User Defined               | ACCT CODE | CHAR |    15
1245
1246 =cut
1247
1248 sub print_csv {
1249   my($self, %opt) = @_;
1250
1251   eval "use Text::CSV_XS";
1252   die $@ if $@;
1253
1254   my $cust_main = $self->cust_main;
1255
1256   my $csv = Text::CSV_XS->new({'always_quote'=>1});
1257
1258   if ( lc($opt{'format'}) eq 'billco' ) {
1259
1260     my $taxtotal = 0;
1261     $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1262
1263     my $duedate = $self->due_date2str('%m/%d/%Y'); #date_format?
1264
1265     my( $previous_balance, @unused ) = $self->previous; #previous balance
1266
1267     my $pmt_cr_applied = 0;
1268     $pmt_cr_applied += $_->{'amount'}
1269       foreach ( $self->_items_payments, $self->_items_credits ) ;
1270
1271     my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1272
1273     $csv->combine(
1274       '',                         #  1 | N/A-Leave Empty               CHAR   2
1275       '',                         #  2 | N/A-Leave Empty               CHAR  15
1276       $opt{'tracctnum'},          #  3 | Transaction Account No        CHAR  15
1277       $self->invnum,              #  4 | Transaction Invoice No        CHAR  15
1278       $cust_main->zip,            #  5 | Transaction Zip Code          CHAR   5
1279       $cust_main->company,        #  6 | Transaction Company Bill To   CHAR  30
1280       #$cust_main->payname,        #  7 | Transaction Contact Bill To   CHAR  30
1281       $cust_main->contact,        #  7 | Transaction Contact Bill To   CHAR  30
1282       $cust_main->address2,       #  8 | Additional Address Unit Info  CHAR  30
1283       $cust_main->address1,       #  9 | Bill To Street Address        CHAR  30
1284       '',                         # 10 | Ancillary Billing Information CHAR  30
1285       $cust_main->city,           # 11 | Transaction City Bill To      CHAR  20
1286       $cust_main->state,          # 12 | Transaction State Bill To     CHAR   2
1287
1288       # XXX ?
1289       time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR  10
1290
1291       # XXX ?
1292       $duedate,                   # 14 | Bill Due Date                 CHAR  10
1293
1294       $previous_balance,          # 15 | Previous Balance              NUM*   9
1295       $pmt_cr_applied,            # 16 | Pmt/CR Applied                NUM*   9
1296       sprintf("%.2f", $self->charged), # 17 | Total Current Charges    NUM*   9
1297       $totaldue,                  # 18 | Total Amt Due                 NUM*   9
1298       $totaldue,                  # 19 | Total Amt Due                 NUM*   9
1299       '',                         # 20 | 30 Day Aging                  NUM*   9
1300       '',                         # 21 | 60 Day Aging                  NUM*   9
1301       '',                         # 22 | 90 Day Aging                  NUM*   9
1302       'N',                        # 23 | Y/N                           CHAR   1
1303       '',                         # 24 | Remittance automation         CHAR 100
1304       $taxtotal,                  # 25 | Total Taxes & Fees            NUM*   9
1305       $self->custnum,             # 26 | Customer Reference Number     CHAR  15
1306       '0',                        # 27 | Federal Tax***                NUM*   9
1307       sprintf("%.2f", $taxtotal), # 28 | State Tax***                  NUM*   9
1308       '0',                        # 29 | Other Taxes & Fees***         NUM*   9
1309     );
1310
1311   } else {
1312
1313     $csv->combine(
1314       'cust_bill',
1315       $self->invnum,
1316       $self->custnum,
1317       time2str("%x", $self->_date),
1318       sprintf("%.2f", $self->charged),
1319       ( map { $cust_main->getfield($_) }
1320           qw( first last company address1 address2 city state zip country ) ),
1321       map { '' } (1..5),
1322     ) or die "can't create csv";
1323   }
1324
1325   my $header = $csv->string. "\n";
1326
1327   my $detail = '';
1328   if ( lc($opt{'format'}) eq 'billco' ) {
1329
1330     my $lineseq = 0;
1331     foreach my $item ( $self->_items_pkg ) {
1332
1333       $csv->combine(
1334         '',                     #  1 | N/A-Leave Empty            CHAR   2
1335         '',                     #  2 | N/A-Leave Empty            CHAR  15
1336         $opt{'tracctnum'},      #  3 | Account Number             CHAR  15
1337         $self->invnum,          #  4 | Invoice Number             CHAR  15
1338         $lineseq++,             #  5 | Line Sequence (sort order) NUM    6
1339         $item->{'description'}, #  6 | Transaction Detail         CHAR 100
1340         $item->{'amount'},      #  7 | Amount                     NUM*   9
1341         '',                     #  8 | Line Format Control**      CHAR   2
1342         '',                     #  9 | Grouping Code              CHAR   2
1343         '',                     # 10 | User Defined               CHAR  15
1344       );
1345
1346       $detail .= $csv->string. "\n";
1347
1348     }
1349
1350   } else {
1351
1352     foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1353
1354       my($pkg, $setup, $recur, $sdate, $edate);
1355       if ( $cust_bill_pkg->pkgnum ) {
1356
1357         ($pkg, $setup, $recur, $sdate, $edate) = (
1358           $cust_bill_pkg->part_pkg->pkg,
1359           ( $cust_bill_pkg->setup != 0
1360             ? sprintf("%.2f", $cust_bill_pkg->setup )
1361             : '' ),
1362           ( $cust_bill_pkg->recur != 0
1363             ? sprintf("%.2f", $cust_bill_pkg->recur )
1364             : '' ),
1365           ( $cust_bill_pkg->sdate
1366             ? time2str("%x", $cust_bill_pkg->sdate)
1367             : '' ),
1368           ($cust_bill_pkg->edate
1369             ?time2str("%x", $cust_bill_pkg->edate)
1370             : '' ),
1371         );
1372
1373       } else { #pkgnum tax
1374         next unless $cust_bill_pkg->setup != 0;
1375         my $itemdesc = defined $cust_bill_pkg->dbdef_table->column('itemdesc')
1376                          ? ( $cust_bill_pkg->itemdesc || 'Tax' )
1377                          : 'Tax';
1378         ($pkg, $setup, $recur, $sdate, $edate) =
1379           ( $itemdesc, sprintf("%10.2f",$cust_bill_pkg->setup), '', '', '' );
1380       }
1381
1382       $csv->combine(
1383         'cust_bill_pkg',
1384         $self->invnum,
1385         ( map { '' } (1..11) ),
1386         ($pkg, $setup, $recur, $sdate, $edate)
1387       ) or die "can't create csv";
1388
1389       $detail .= $csv->string. "\n";
1390
1391     }
1392
1393   }
1394
1395   ( $header, $detail );
1396
1397 }
1398
1399 =item comp
1400
1401 Pays this invoice with a compliemntary payment.  If there is an error,
1402 returns the error, otherwise returns false.
1403
1404 =cut
1405
1406 sub comp {
1407   my $self = shift;
1408   my $cust_pay = new FS::cust_pay ( {
1409     'invnum'   => $self->invnum,
1410     'paid'     => $self->owed,
1411     '_date'    => '',
1412     'payby'    => 'COMP',
1413     'payinfo'  => $self->cust_main->payinfo,
1414     'paybatch' => '',
1415   } );
1416   $cust_pay->insert;
1417 }
1418
1419 =item realtime_card
1420
1421 Attempts to pay this invoice with a credit card payment via a
1422 Business::OnlinePayment realtime gateway.  See
1423 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1424 for supported processors.
1425
1426 =cut
1427
1428 sub realtime_card {
1429   my $self = shift;
1430   $self->realtime_bop( 'CC', @_ );
1431 }
1432
1433 =item realtime_ach
1434
1435 Attempts to pay this invoice with an electronic check (ACH) payment via a
1436 Business::OnlinePayment realtime gateway.  See
1437 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1438 for supported processors.
1439
1440 =cut
1441
1442 sub realtime_ach {
1443   my $self = shift;
1444   $self->realtime_bop( 'ECHECK', @_ );
1445 }
1446
1447 =item realtime_lec
1448
1449 Attempts to pay this invoice with phone bill (LEC) payment via a
1450 Business::OnlinePayment realtime gateway.  See
1451 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1452 for supported processors.
1453
1454 =cut
1455
1456 sub realtime_lec {
1457   my $self = shift;
1458   $self->realtime_bop( 'LEC', @_ );
1459 }
1460
1461 sub realtime_bop {
1462   my( $self, $method ) = @_;
1463
1464   my $cust_main = $self->cust_main;
1465   my $balance = $cust_main->balance;
1466   my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
1467   $amount = sprintf("%.2f", $amount);
1468   return "not run (balance $balance)" unless $amount > 0;
1469
1470   my $description = 'Internet Services';
1471   if ( $conf->exists('business-onlinepayment-description') ) {
1472     my $dtempl = $conf->config('business-onlinepayment-description');
1473
1474     my $agent_obj = $cust_main->agent
1475       or die "can't retreive agent for $cust_main (agentnum ".
1476              $cust_main->agentnum. ")";
1477     my $agent = $agent_obj->agent;
1478     my $pkgs = join(', ',
1479       map { $_->part_pkg->pkg }
1480         grep { $_->pkgnum } $self->cust_bill_pkg
1481     );
1482     $description = eval qq("$dtempl");
1483   }
1484
1485   $cust_main->realtime_bop($method, $amount,
1486     'description' => $description,
1487     'invnum'      => $self->invnum,
1488   );
1489
1490 }
1491
1492 =item batch_card OPTION => VALUE...
1493
1494 Adds a payment for this invoice to the pending credit card batch (see
1495 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
1496 runs the payment using a realtime gateway.
1497
1498 =cut
1499
1500 sub batch_card {
1501   my ($self, %options) = @_;
1502   my $cust_main = $self->cust_main;
1503
1504   $options{invnum} = $self->invnum;
1505
1506   $cust_main->batch_card(%options);
1507 }
1508
1509 sub _agent_template {
1510   my $self = shift;
1511   $self->cust_main->agent_template;
1512 }
1513
1514 sub _agent_invoice_from {
1515   my $self = shift;
1516   $self->cust_main->agent_invoice_from;
1517 }
1518
1519 =item print_text [ TIME [ , TEMPLATE ] ]
1520
1521 Returns an text invoice, as a list of lines.
1522
1523 TIME an optional value used to control the printing of overdue messages.  The
1524 default is now.  It isn't the date of the invoice; that's the `_date' field.
1525 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
1526 L<Time::Local> and L<Date::Parse> for conversion functions.
1527
1528 =cut
1529
1530 sub print_text {
1531   my( $self, $today, $template ) = @_;
1532
1533   my %params = ( 'format' => 'template' );
1534   $params{'time'} = $today if $today;
1535   $params{'template'} = $template if $template;
1536
1537   $self->print_generic( %params );
1538 }
1539
1540 =item print_latex [ TIME [ , TEMPLATE ] ]
1541
1542 Internal method - returns a filename of a filled-in LaTeX template for this
1543 invoice (Note: add ".tex" to get the actual filename), and a filename of
1544 an associated logo (with the .eps extension included).
1545
1546 See print_ps and print_pdf for methods that return PostScript and PDF output.
1547
1548 TIME an optional value used to control the printing of overdue messages.  The
1549 default is now.  It isn't the date of the invoice; that's the `_date' field.
1550 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
1551 L<Time::Local> and L<Date::Parse> for conversion functions.
1552
1553 =cut
1554
1555 sub print_latex {
1556
1557   my( $self, $today, $template ) = @_;
1558
1559   my %params = ( 'format' => 'latex' );
1560   $params{'time'} = $today if $today;
1561   $params{'template'} = $template if $template;
1562
1563   $template ||= $self->_agent_template;
1564
1565   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
1566   my $lh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
1567                            DIR      => $dir,
1568                            SUFFIX   => '.eps',
1569                            UNLINK   => 0,
1570                          ) or die "can't open temp file: $!\n";
1571
1572   if ($template && $conf->exists("logo_${template}.eps")) {
1573     print $lh $conf->config_binary("logo_${template}.eps")
1574       or die "can't write temp file: $!\n";
1575   }else{
1576     print $lh $conf->config_binary('logo.eps')
1577       or die "can't write temp file: $!\n";
1578   }
1579   close $lh;
1580   $params{'logo_file'} = $lh->filename;
1581
1582   my @filled_in = $self->print_generic( %params );
1583
1584   my $fh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
1585                            DIR      => $dir,
1586                            SUFFIX   => '.tex',
1587                            UNLINK   => 0,
1588                          ) or die "can't open temp file: $!\n";
1589   print $fh join('', @filled_in );
1590   close $fh;
1591
1592   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
1593   return ($1, $params{'logo_file'});
1594
1595 }
1596
1597 =item print_generic OPTIONS_HASH
1598
1599 Internal method - returns a filled-in template for this invoice as a scalar.
1600
1601 See print_ps and print_pdf for methods that return PostScript and PDF output.
1602
1603 Non optional options include
1604   format - latex, html, template
1605
1606 Optional options include
1607
1608 template - a value used as a suffix for a configuration template
1609
1610 time - a value used to control the printing of overdue messages.  The
1611 default is now.  It isn't the date of the invoice; that's the `_date' field.
1612 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
1613 L<Time::Local> and L<Date::Parse> for conversion functions.
1614
1615 cid -
1616
1617 =cut
1618
1619 sub print_generic {
1620
1621   my( $self, %params ) = @_;
1622   my $today = $params{today} ? $params{today} : time;
1623   warn "FS::cust_bill::print_generic called on $self with suffix $params{template}\n"
1624     if $DEBUG;
1625
1626   my $format = $params{format};
1627   die "Unknown format: $format"
1628     unless $format =~ /^(latex|html|template)$/;
1629
1630   my $cust_main = $self->cust_main;
1631   $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
1632     unless $cust_main->payname && $cust_main->payby !~ /^(CHEK|DCHK)$/;
1633
1634
1635   my %delimiters = ( 'latex'    => [ '[@--', '--@]' ],
1636                      'html'     => [ '<%=', '%>' ],
1637                      'template' => [ '{', '}' ],
1638                    );
1639
1640   #create the template
1641   my $template = $params{template} ? $params{template} : $self->_agent_template;
1642   my $templatefile = "invoice_$format";
1643   $templatefile .= "_$template"
1644     if length($template);
1645   my @invoice_template = map "$_\n", $conf->config($templatefile)
1646     or die "cannot load config data $templatefile";
1647
1648   my $old_latex = '';
1649   if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
1650     #change this to a die when the old code is removed
1651     warn "old-style invoice template $templatefile; ".
1652          "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
1653     $old_latex = 'true';
1654     @invoice_template = _translate_old_latex_format(@invoice_template);
1655   }
1656
1657   my $text_template = new Text::Template(
1658     TYPE => 'ARRAY',
1659     SOURCE => \@invoice_template,
1660     DELIMITERS => $delimiters{$format},
1661   );
1662
1663   $text_template->compile()
1664     or die "Can't compile $templatefile: $Text::Template::ERROR\n";
1665
1666
1667   # additional substitution could possibly cause breakage in existing templates
1668   my %convert_maps = (
1669     'latex' => {
1670                  'notes'         => sub { map "$_", @_ },
1671                  'footer'        => sub { map "$_", @_ },
1672                  'smallfooter'   => sub { map "$_", @_ },
1673                  'returnaddress' => sub { map "$_", @_ },
1674                  'coupon'        => sub { map "$_", @_ },
1675                },
1676     'html'  => {
1677                  'notes' =>
1678                    sub {
1679                      map {
1680                        s/%%(.*)$/<!-- $1 -->/g;
1681                        s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
1682                        s/\\begin\{enumerate\}/<ol>/g;
1683                        s/\\item /  <li>/g;
1684                        s/\\end\{enumerate\}/<\/ol>/g;
1685                        s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
1686                        s/\\\\\*/<br>/g;
1687                        s/\\dollar ?/\$/g;
1688                        s/\\#/#/g;
1689                        s/~/&nbsp;/g;
1690                        $_;
1691                      }  @_
1692                    },
1693                  'footer' =>
1694                    sub { map { s/~/&nbsp;/g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
1695                  'smallfooter' =>
1696                    sub { map { s/~/&nbsp;/g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
1697                  'returnaddress' =>
1698                    sub {
1699                      map {
1700                        s/~/&nbsp;/g;
1701                        s/\\\\\*?\s*$/<BR>/;
1702                        s/\\hyphenation\{[\w\s\-]+}//;
1703                        $_;
1704                      }  @_
1705                    },
1706                  'coupon'        => sub { "" },
1707                },
1708     'template' => {
1709                  'notes' =>
1710                    sub {
1711                      map {
1712                        s/%%.*$//g;
1713                        s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
1714                        s/\\begin\{enumerate\}//g;
1715                        s/\\item /  * /g;
1716                        s/\\end\{enumerate\}//g;
1717                        s/\\textbf\{(.*)\}/$1/g;
1718                        s/\\\\\*/ /;
1719                        s/\\dollar ?/\$/g;
1720                        $_;
1721                      }  @_
1722                    },
1723                  'footer' =>
1724                    sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
1725                  'smallfooter' =>
1726                    sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
1727                  'returnaddress' =>
1728                    sub {
1729                      map {
1730                        s/~/ /g;
1731                        s/\\\\\*?\s*$/\n/;             # dubious
1732                        s/\\hyphenation\{[\w\s\-]+}//;
1733                        $_;
1734                      }  @_
1735                    },
1736                  'coupon'        => sub { "" },
1737                },
1738   );
1739
1740
1741   # hashes for differing output formats
1742   my %nbsps = ( 'latex'    => '~',
1743                 'html'     => '',    # '&nbps;' would be nice
1744                 'template' => '',    # not used
1745               );
1746   my $nbsp = $nbsps{$format};
1747
1748   my %escape_functions = ( 'latex'    => \&_latex_escape,
1749                            'html'     => \&encode_entities,
1750                            'template' => sub { shift },
1751                          );
1752   my $escape_function = $escape_functions{$format};
1753
1754   my %date_formats = ( 'latex'    => '%b %o, %Y',
1755                        'html'     => '%b&nbsp;%o,&nbsp;%Y',
1756                        'template' => '%s',
1757                      );
1758   my $date_format = $date_formats{$format};
1759
1760   my %embolden_functions = ( 'latex'    => sub { return '\textbf{'. shift(). '}'
1761                                                },
1762                              'html'     => sub { return '<b>'. shift(). '</b>'
1763                                                },
1764                              'template' => sub { shift },
1765                            );
1766   my $embolden_function = $embolden_functions{$format};
1767
1768
1769   # generate template variables
1770   my $returnaddress;
1771   if (
1772          defined( $conf->config_orbase( "invoice_${format}returnaddress",
1773                                         $template
1774                                       )
1775                 )
1776        && length( $conf->config_orbase( "invoice_${format}returnaddress",
1777                                         $template
1778                                       )
1779                 )
1780   ) {
1781
1782     $returnaddress = join("\n",
1783       $conf->config_orbase("invoice_${format}returnaddress", $template)
1784     );
1785
1786   } elsif ( grep /\S/,
1787             $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
1788
1789     my $convert_map = $convert_maps{$format}{'returnaddress'};
1790     $returnaddress =
1791       join( "\n",
1792             &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
1793                                                  $template
1794                                                )
1795                          )
1796           );
1797   } elsif ( grep /\S/, $conf->config('company_address') ) {
1798
1799     my $convert_map = $convert_maps{$format}{'returnaddress'};
1800     $returnaddress = join( "\n", &$convert_map(
1801                                    map { s/( {2,})/'~' x length($1)/eg;
1802                                          s/$/\\\\\*/;
1803                                          $_
1804                                        }
1805                                      ( $conf->config('company_name'),
1806                                        $conf->config('company_address'),
1807                                      )
1808                                  )
1809                      );
1810
1811   } else {
1812
1813     my $warning = "Couldn't find a return address; ".
1814                   "do you need to set the company_address configuration value?";
1815     warn "$warning\n";
1816     $returnaddress = $nbsp;
1817     #$returnaddress = $warning;
1818
1819   }
1820
1821   my %invoice_data = (
1822     'company_name'    => scalar( $conf->config('company_name') ),
1823     'company_address' => join("\n", $conf->config('company_address') ). "\n",
1824     'custnum'         => $self->custnum,
1825     'invnum'          => $self->invnum,
1826     'date'            => time2str($date_format, $self->_date),
1827     'today'           => time2str('%b %o, %Y', $today),
1828     'agent'           => &$escape_function($cust_main->agent->agent),
1829     'payname'         => &$escape_function($cust_main->payname),
1830     'company'         => &$escape_function($cust_main->company),
1831     'address1'        => &$escape_function($cust_main->address1),
1832     'address2'        => &$escape_function($cust_main->address2),
1833     'city'            => &$escape_function($cust_main->city),
1834     'state'           => &$escape_function($cust_main->state),
1835     'zip'             => &$escape_function($cust_main->zip),
1836     'returnaddress'   => $returnaddress,
1837     'quantity'        => 1,
1838     'terms'           => $self->terms,
1839     'template'        => $params{'template'},
1840     #'notes'           => join("\n", $conf->config('invoice_latexnotes') ),
1841     # better hang on to conf_dir for a while
1842     'conf_dir'        => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
1843     'page'            => 1,
1844     'total_pages'     => 1,
1845   );
1846
1847   $invoice_data{'cid'} = $params{'cid'}
1848     if $params{'cid'};
1849
1850   my $countrydefault = $conf->config('countrydefault') || 'US';
1851   if ( $cust_main->country eq $countrydefault ) {
1852     $invoice_data{'country'} = '';
1853   } else {
1854     $invoice_data{'country'} = &$escape_function(code2country($cust_main->country));
1855   }
1856
1857   my @address = ();
1858   $invoice_data{'address'} = \@address;
1859   push @address,
1860     $cust_main->payname.
1861       ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
1862         ? " (P.O. #". $cust_main->payinfo. ")"
1863         : ''
1864       )
1865   ;
1866   push @address, $cust_main->company
1867     if $cust_main->company;
1868   push @address, $cust_main->address1;
1869   push @address, $cust_main->address2
1870     if $cust_main->address2;
1871   push @address,
1872     $cust_main->city. ", ". $cust_main->state. "  ".  $cust_main->zip;
1873   push @address, $invoice_data{'country'}
1874     if $invoice_data{'country'};
1875   push @address, ''
1876     while (scalar(@address) < 5);
1877
1878   $invoice_data{'logo_file'} = $params{'logo_file'}
1879     if $params{'logo_file'};
1880
1881   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
1882 #  my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
1883   #my $balance_due = $self->owed + $pr_total - $cr_total;
1884   my $balance_due = $self->owed + $pr_total;
1885   $invoice_data{'balance'} = $balance_due;
1886
1887   #do variable substitution in notes, footer, smallfooter
1888   foreach my $include (qw( notes footer smallfooter coupon )) {
1889
1890     my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
1891     my @inc_src;
1892
1893     if ( $conf->exists($inc_file) && length( $conf->config($inc_file) ) ) {
1894
1895       @inc_src = $conf->config($inc_file);
1896
1897     } else {
1898
1899       $inc_file = $conf->key_orbase("invoice_latex$include", $template);
1900
1901       my $convert_map = $convert_maps{$format}{$include};
1902
1903       @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
1904                        s/--\@\]/$delimiters{$format}[1]/g;
1905                        $_;
1906                      }
1907                  &$convert_map( $conf->config($inc_file) );
1908
1909     }
1910
1911     my $inc_tt = new Text::Template (
1912       TYPE       => 'ARRAY',
1913       SOURCE     => [ map "$_\n", @inc_src ],
1914       DELIMITERS => $delimiters{$format},
1915     ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
1916
1917     unless ( $inc_tt->compile() ) {
1918       my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
1919       warn $error. "Template:\n". join('', map "$_\n", @inc_src);
1920       die $error;
1921     }
1922
1923     $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
1924
1925     $invoice_data{$include} =~ s/\n+$//
1926       if ($format eq 'latex');
1927   }
1928
1929   $invoice_data{'po_line'} =
1930     (  $cust_main->payby eq 'BILL' && $cust_main->payinfo )
1931       ? &$escape_function("Purchase Order #". $cust_main->payinfo)
1932       : $nbsp;
1933
1934   my %money_chars = ( 'latex'    => '',
1935                       'html'     => $conf->config('money_char') || '$',
1936                       'template' => '',
1937                     );
1938   my $money_char = $money_chars{$format};
1939
1940   my %other_money_chars = ( 'latex'    => '\dollar ',
1941                             'html'     => $conf->config('money_char') || '$',
1942                             'template' => '',
1943                           );
1944   my $other_money_char = $other_money_chars{$format};
1945
1946   my @detail_items = ();
1947   my @total_items = ();
1948   my @buf = ();
1949   my @sections = ();
1950
1951   $invoice_data{'detail_items'} = \@detail_items;
1952   $invoice_data{'total_items'} = \@total_items;
1953   $invoice_data{'buf'} = \@buf;
1954   $invoice_data{'sections'} = \@sections;
1955
1956   my $previous_section = { 'description' => 'Previous Charges',
1957                            'subtotal'    => $other_money_char.
1958                                             sprintf('%.2f', $pr_total),
1959                          };
1960
1961   my $taxtotal = 0;
1962   my $tax_section = { 'description' => 'Taxes, Surcharges, and Fees',
1963                       'subtotal'    => $taxtotal }; # adjusted below
1964
1965   my $adjusttotal = 0;
1966   my $adjust_section = { 'description' => 'Credits, Payments, and Adjustments',
1967                          'subtotal'    => 0 }; # adjusted below
1968
1969   my $multisection = $conf->exists('invoice_sections', $cust_main->agentnum);
1970   if ( $multisection ) {
1971     push @sections, $self->_items_sections;
1972   }else{
1973     push @sections, { 'description' => '', 'subtotal' => '' };
1974   }
1975
1976   foreach my $line_item ( $conf->exists('disable_previous_balance')
1977                             ? ()
1978                             : $self->_items_previous
1979                         )
1980   {
1981     my $detail = {
1982       ext_description => [],
1983     };
1984     $detail->{'ref'} = $line_item->{'pkgnum'};
1985     $detail->{'quantity'} = 1;
1986     $detail->{'section'} = $previous_section;
1987     $detail->{'description'} = &$escape_function($line_item->{'description'});
1988     if ( exists $line_item->{'ext_description'} ) {
1989       @{$detail->{'ext_description'}} = map {
1990         &$escape_function($_);
1991       } @{$line_item->{'ext_description'}};
1992     }
1993     {
1994       my $money = $old_latex ? '' : $money_char;
1995       $detail->{'amount'} = $money. $line_item->{'amount'};
1996     }
1997     $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
1998
1999     push @detail_items, $detail;
2000     push @buf, [ $detail->{'description'},
2001                  $money_char. sprintf("%10.2f", $line_item->{'amount'}),
2002                ];
2003   }
2004
2005   if ( @pr_cust_bill && !$conf->exists('disable_previous_balance') ) {
2006     push @buf, ['','-----------'];
2007     push @buf, [ 'Total Previous Balance',
2008                  $money_char. sprintf("%10.2f", $pr_total) ];
2009     push @buf, ['',''];
2010   }
2011
2012   foreach my $section (@sections) {
2013
2014     $section->{'subtotal'} = $other_money_char.
2015                              sprintf('%.2f', $section->{'subtotal'})
2016       if $multisection;
2017
2018     if ( $section->{'description'} ) {
2019       push @buf, ( [ &$escape_function($section->{'description'}), '' ],
2020                    [ '', '' ],
2021                  );
2022     }
2023
2024     my %options = ();
2025     $options{'section'} = $section if $multisection;
2026     $options{'format'} = $format;
2027     $options{'escape_function'} = $escape_function;
2028
2029     foreach my $line_item ( $self->_items_pkg(%options) ) {
2030       my $detail = {
2031         ext_description => [],
2032       };
2033       $detail->{'ref'} = $line_item->{'pkgnum'};
2034       $detail->{'quantity'} = 1;
2035       $detail->{'section'} = $section;
2036       $detail->{'description'} = &$escape_function($line_item->{'description'});
2037       if ( exists $line_item->{'ext_description'} ) {
2038         @{$detail->{'ext_description'}} = @{$line_item->{'ext_description'}};
2039       }
2040       {
2041         my $money = $old_latex ? '' : $money_char;
2042         $detail->{'amount'} = $money. $line_item->{'amount'};
2043       }
2044       $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
2045
2046       push @detail_items, $detail;
2047       push @buf, ( [ $detail->{'description'},
2048                      $money_char. sprintf("%10.2f", $line_item->{'amount'}),
2049                    ],
2050                    map { [ " ". $_, '' ] } @{$detail->{'ext_description'}},
2051                  );
2052     }
2053
2054     if ( $section->{'description'} ) {
2055       push @buf, ( ['','-----------'],
2056                    [ $section->{'description'}. ' sub-total',
2057                       $money_char. sprintf("%10.2f", $section->{'subtotal'})
2058                    ],
2059                    [ '', '' ],
2060                    [ '', '' ],
2061                  );
2062     }
2063
2064   }
2065
2066   if ( $multisection && !$conf->exists('disable_previous_balance') ) {
2067     unshift @sections, $previous_section if $pr_total;
2068   }
2069
2070   foreach my $tax ( $self->_items_tax ) {
2071     my $total = {};
2072     $total->{'total_item'} = &$escape_function($tax->{'description'});
2073     $taxtotal += $tax->{'amount'};
2074     $total->{'total_amount'} = $other_money_char. $tax->{'amount'};
2075     if ( $multisection ) {
2076       my $money = $old_latex ? '' : $money_char;
2077       push @detail_items, {
2078         ext_description => [],
2079         ref          => '',
2080         quantity     => '',
2081         description  => &$escape_function($tax->{'description'}),
2082         amount       => $money. $tax->{'amount'},
2083         product_code => '',
2084         section      => $tax_section,
2085       };
2086     }else{
2087       push @total_items, $total;
2088     }
2089     push @buf,[ $total->{'total_item'},
2090                 $money_char. sprintf("%10.2f", $total->{'total_amount'}),
2091               ];
2092
2093   }
2094
2095   if ( $taxtotal ) {
2096     my $total = {};
2097     $total->{'total_item'} = 'Sub-total';
2098     $total->{'total_amount'} =
2099       $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
2100
2101     if ( $multisection ) {
2102       $tax_section->{'subtotal'} = $other_money_char.
2103                                    sprintf('%.2f', $taxtotal);
2104       $tax_section->{'pretotal'} = 'New charges sub-total '.
2105                                    $total->{'total_amount'};
2106       push @sections, $tax_section if $taxtotal;
2107     }else{
2108       unshift @total_items, $total;
2109     }
2110   }
2111
2112   push @buf,['','-----------'];
2113   push @buf,[( $conf->exists('disable_previous_balance')
2114                ? 'Total Charges'
2115                : 'Total New Charges'
2116              ),
2117              $money_char. sprintf("%10.2f",$self->charged) ];
2118   push @buf,['',''];
2119
2120   {
2121     my $total = {};
2122     $total->{'total_item'} = &$embolden_function('Total');
2123     $total->{'total_amount'} =
2124       &$embolden_function(
2125         $other_money_char.
2126         sprintf( '%.2f',
2127                  $self->charged + ( $conf->exists('disable_previous_balance')
2128                                     ? 0
2129                                     : $pr_total
2130                                   )
2131                )
2132       );
2133     if ( $multisection ) {
2134       $adjust_section->{'pretotal'} = 'New charges total '.
2135                                       $total->{'total_amount'};
2136     }else{
2137       push @total_items, $total;
2138     }
2139     push @buf,['','-----------'];
2140     push @buf,['Total Charges',
2141                $money_char.
2142                sprintf( '%10.2f', $self->charged +
2143                                     ( $conf->exists('disable_previous_balance')
2144                                         ? 0
2145                                         : $pr_total
2146                                     )
2147                       )
2148               ];
2149     push @buf,['',''];
2150   }
2151
2152   unless ( $conf->exists('disable_previous_balance') ) {
2153     #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
2154
2155     # credits
2156     foreach my $credit ( $self->_items_credits ) {
2157       my $total;
2158       $total->{'total_item'} = &$escape_function($credit->{'description'});
2159       #$credittotal
2160       $total->{'total_amount'} = '-'. $other_money_char. $credit->{'amount'};
2161       $adjusttotal += $credit->{'amount'};
2162       if ( $multisection ) {
2163         my $money = $old_latex ? '' : $money_char;
2164         push @detail_items, {
2165           ext_description => [],
2166           ref          => '',
2167           quantity     => '',
2168           description  => &$escape_function($credit->{'description'}),
2169           amount       => $money. $credit->{'amount'},
2170           product_code => '',
2171           section      => $adjust_section,
2172         };
2173       }else{
2174         push @total_items, $total;
2175       }
2176     }
2177
2178     # credits (again)
2179     foreach ( $self->cust_credited ) {
2180
2181       #something more elaborate if $_->amount ne $_->cust_credit->credited ?
2182
2183       my $reason = substr($_->cust_credit->reason,0,32);
2184       $reason .= '...' if length($reason) < length($_->cust_credit->reason);
2185       $reason = " ($reason) " if $reason;
2186       push @buf,[
2187         "Credit #". $_->crednum. " (". time2str("%x",$_->cust_credit->_date) .")".        $reason,
2188         $money_char. sprintf("%10.2f",$_->amount)
2189       ];
2190     }
2191
2192     # payments
2193     foreach my $payment ( $self->_items_payments ) {
2194       my $total = {};
2195       $total->{'total_item'} = &$escape_function($payment->{'description'});
2196       #$paymenttotal
2197       $total->{'total_amount'} = '-'. $other_money_char. $payment->{'amount'};
2198       $adjusttotal += $payment->{'amount'};
2199       if ( $multisection ) {
2200         my $money = $old_latex ? '' : $money_char;
2201         push @detail_items, {
2202           ext_description => [],
2203           ref          => '',
2204           quantity     => '',
2205           description  => &$escape_function($payment->{'description'}),
2206           amount       => $money. $payment->{'amount'},
2207           product_code => '',
2208           section      => $adjust_section,
2209         };
2210       }else{
2211         push @total_items, $total;
2212       }
2213       push @buf, [ $payment->{'description'},
2214                    $money_char. sprintf("%10.2f", $payment->{'amount'}),
2215                  ];
2216     }
2217
2218     if ( $multisection ) {
2219       $adjust_section->{'subtotal'} = $other_money_char.
2220                                       sprintf('%.2f', $adjusttotal);
2221       push @sections, $adjust_section;
2222     }
2223
2224     {
2225       my $total;
2226       $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
2227       $total->{'total_amount'} =
2228         &$embolden_function(
2229           $other_money_char. sprintf('%.2f', $self->owed + $pr_total )
2230         );
2231       if ( $multisection ) {
2232         $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
2233                                          $total->{'total_amount'};
2234       }else{
2235         push @total_items, $total;
2236       }
2237       push @buf,['','-----------'];
2238       push @buf,[$self->balance_due_msg, $money_char.
2239         sprintf("%10.2f", $balance_due ) ];
2240     }
2241   }
2242
2243   $invoice_lines = 0;
2244   my $wasfunc = 0;
2245   foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
2246     /invoice_lines\((\d*)\)/;
2247     $invoice_lines += $1 || scalar(@buf);
2248     $wasfunc=1;
2249   }
2250   die "no invoice_lines() functions in template?"
2251     if ( $format eq 'template' && !$wasfunc );
2252
2253   if ($format eq 'template') {
2254
2255     if ( $invoice_lines ) {
2256       $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
2257       $invoice_data{'total_pages'}++
2258         if scalar(@buf) % $invoice_lines;
2259     }
2260
2261     #setup subroutine for the template
2262     sub FS::cust_bill::_template::invoice_lines {
2263       my $lines = shift || scalar(@FS::cust_bill::_template::buf);
2264       map {
2265         scalar(@FS::cust_bill::_template::buf)
2266           ? shift @FS::cust_bill::_template::buf
2267           : [ '', '' ];
2268       }
2269       ( 1 .. $lines );
2270     }
2271
2272     my $lines;
2273     my @collect;
2274     while (@buf) {
2275       push @collect, split("\n",
2276         $text_template->fill_in( HASH => \%invoice_data,
2277                                  PACKAGE => 'FS::cust_bill::_template'
2278                                )
2279       );
2280       $FS::cust_bill::_template::page++;
2281     }
2282     map "$_\n", @collect;
2283   }else{
2284     warn "filling in template for invoice ". $self->invnum. "\n"
2285       if $DEBUG;
2286     warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
2287       if $DEBUG > 1;
2288
2289     $text_template->fill_in(HASH => \%invoice_data);
2290   }
2291 }
2292
2293 =item print_ps [ TIME [ , TEMPLATE ] ]
2294
2295 Returns an postscript invoice, as a scalar.
2296
2297 TIME an optional value used to control the printing of overdue messages.  The
2298 default is now.  It isn't the date of the invoice; that's the `_date' field.
2299 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
2300 L<Time::Local> and L<Date::Parse> for conversion functions.
2301
2302 =cut
2303
2304 sub print_ps {
2305   my $self = shift;
2306
2307   my ($file, $lfile) = $self->print_latex(@_);
2308   my $ps = generate_ps($file);
2309   unlink($lfile);
2310
2311   $ps;
2312 }
2313
2314 =item print_pdf [ TIME [ , TEMPLATE ] ]
2315
2316 Returns an PDF invoice, as a scalar.
2317
2318 TIME an optional value used to control the printing of overdue messages.  The
2319 default is now.  It isn't the date of the invoice; that's the `_date' field.
2320 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
2321 L<Time::Local> and L<Date::Parse> for conversion functions.
2322
2323 =cut
2324
2325 sub print_pdf {
2326   my $self = shift;
2327
2328   my ($file, $lfile) = $self->print_latex(@_);
2329   my $pdf = generate_pdf($file);
2330   unlink($lfile);
2331
2332   $pdf;
2333 }
2334
2335 =item print_html [ TIME [ , TEMPLATE [ , CID ] ] ]
2336
2337 Returns an HTML invoice, as a scalar.
2338
2339 TIME an optional value used to control the printing of overdue messages.  The
2340 default is now.  It isn't the date of the invoice; that's the `_date' field.
2341 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
2342 L<Time::Local> and L<Date::Parse> for conversion functions.
2343
2344 CID is a MIME Content-ID used to create a "cid:" URL for the logo image, used
2345 when emailing the invoice as part of a multipart/related MIME email.
2346
2347 =cut
2348
2349 sub print_html {
2350   my( $self, $today, $template, $cid ) = @_;
2351
2352   my %params = ( 'format' => 'html' );
2353   $params{'time'} = $today if $today;
2354   $params{'template'} = $template if $template;
2355   $params{'cid'} = $cid if $cid;
2356
2357   $self->print_generic( %params );
2358 }
2359
2360 # quick subroutine for print_latex
2361 #
2362 # There are ten characters that LaTeX treats as special characters, which
2363 # means that they do not simply typeset themselves:
2364 #      # $ % & ~ _ ^ \ { }
2365 #
2366 # TeX ignores blanks following an escaped character; if you want a blank (as
2367 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
2368
2369 sub _latex_escape {
2370   my $value = shift;
2371   $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
2372   $value =~ s/([<>])/\$$1\$/g;
2373   $value;
2374 }
2375
2376 #utility methods for print_*
2377
2378 sub _translate_old_latex_format {
2379   warn "_translate_old_latex_format called\n"
2380     if $DEBUG;
2381
2382   my @template = ();
2383   while ( @_ ) {
2384     my $line = shift;
2385
2386     if ( $line =~ /^%%Detail\s*$/ ) {
2387
2388       push @template, q![@--!,
2389                       q!  foreach my $_tr_line (@detail_items) {!,
2390                       q!    if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
2391                       q!      $_tr_line->{'description'} .= !,
2392                       q!        "\\tabularnewline\n~~".!,
2393                       q!        join( "\\tabularnewline\n~~",!,
2394                       q!          @{$_tr_line->{'ext_description'}}!,
2395                       q!        );!,
2396                       q!    }!;
2397
2398       while ( ( my $line_item_line = shift )
2399               !~ /^%%EndDetail\s*$/                            ) {
2400         $line_item_line =~ s/'/\\'/g;    # nice LTS
2401         $line_item_line =~ s/\\/\\\\/g;  # escape quotes and backslashes
2402         $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
2403         push @template, "    \$OUT .= '$line_item_line';";
2404       }
2405
2406       push @template, '}',
2407                       '--@]';
2408
2409     } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
2410
2411       push @template, '[@--',
2412                       '  foreach my $_tr_line (@total_items) {';
2413
2414       while ( ( my $total_item_line = shift )
2415               !~ /^%%EndTotalDetails\s*$/                      ) {
2416         $total_item_line =~ s/'/\\'/g;    # nice LTS
2417         $total_item_line =~ s/\\/\\\\/g;  # escape quotes and backslashes
2418         $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
2419         push @template, "    \$OUT .= '$total_item_line';";
2420       }
2421
2422       push @template, '}',
2423                       '--@]';
2424
2425     } else {
2426       $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
2427       push @template, $line;
2428     }
2429
2430   }
2431
2432   if ($DEBUG) {
2433     warn "$_\n" foreach @template;
2434   }
2435
2436   (@template);
2437 }
2438
2439 sub terms {
2440   my $self = shift;
2441
2442   #check for an invoice- specific override (eventually)
2443
2444   #check for a customer- specific override
2445   return $self->cust_main->invoice_terms
2446     if $self->cust_main->invoice_terms;
2447
2448   #use configured default or default default
2449   $conf->config('invoice_default_terms') || 'Payable upon receipt';
2450 }
2451
2452 sub due_date {
2453   my $self = shift;
2454   my $duedate = '';
2455   if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
2456     $duedate = $self->_date() + ( $1 * 86400 );
2457   }
2458   $duedate;
2459 }
2460
2461 sub due_date2str {
2462   my $self = shift;
2463   $self->due_date ? time2str(shift, $self->due_date) : '';
2464 }
2465
2466 sub balance_due_msg {
2467   my $self = shift;
2468   my $msg = 'Balance Due';
2469   return $msg unless $self->terms;
2470   if ( $self->due_date ) {
2471     $msg .= ' - Please pay by '. $self->due_date2str('%x');
2472   } elsif ( $self->terms ) {
2473     $msg .= ' - '. $self->terms;
2474   }
2475   $msg;
2476 }
2477
2478 =item invnum_date_pretty
2479
2480 Returns a string with the invoice number and date, for example:
2481 "Invoice #54 (3/20/2008)"
2482
2483 =cut
2484
2485 sub invnum_date_pretty {
2486   my $self = shift;
2487   'Invoice #'. $self->invnum. ' ('. time2str('%x', $self->_date). ')';
2488 }
2489
2490 sub _items_sections {
2491   my $self = shift;
2492
2493   my %s = ();
2494   foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2495
2496     if ( $cust_bill_pkg->pkgnum > 0 ) {
2497
2498       my $desc = $cust_bill_pkg->part_pkg->classname;
2499
2500       $s{$desc} += $cust_bill_pkg->setup
2501         if ( $cust_bill_pkg->setup != 0 );
2502
2503       $s{$desc} += $cust_bill_pkg->recur
2504         if ( $cust_bill_pkg->recur != 0 );
2505
2506     }
2507
2508   }
2509
2510   map { {'description' => $_, 'subtotal' => $s{$_}} } sort keys %s;
2511
2512 }
2513
2514 sub _items {
2515   my $self = shift;
2516
2517   #my @display = scalar(@_)
2518   #              ? @_
2519   #              : qw( _items_previous _items_pkg );
2520   #              #: qw( _items_pkg );
2521   #              #: qw( _items_previous _items_pkg _items_tax _items_credits _items_payments );
2522   my @display = qw( _items_previous _items_pkg );
2523
2524   my @b = ();
2525   foreach my $display ( @display ) {
2526     push @b, $self->$display(@_);
2527   }
2528   @b;
2529 }
2530
2531 sub _items_previous {
2532   my $self = shift;
2533   my $cust_main = $self->cust_main;
2534   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2535   my @b = ();
2536   foreach ( @pr_cust_bill ) {
2537     push @b, {
2538       'description' => 'Previous Balance, Invoice #'. $_->invnum.
2539                        ' ('. time2str('%x',$_->_date). ')',
2540       #'pkgpart'     => 'N/A',
2541       'pkgnum'      => 'N/A',
2542       'amount'      => sprintf("%.2f", $_->owed),
2543     };
2544   }
2545   @b;
2546
2547   #{
2548   #    'description'     => 'Previous Balance',
2549   #    #'pkgpart'         => 'N/A',
2550   #    'pkgnum'          => 'N/A',
2551   #    'amount'          => sprintf("%10.2f", $pr_total ),
2552   #    'ext_description' => [ map {
2553   #                                 "Invoice ". $_->invnum.
2554   #                                 " (". time2str("%x",$_->_date). ") ".
2555   #                                 sprintf("%10.2f", $_->owed)
2556   #                         } @pr_cust_bill ],
2557
2558   #};
2559 }
2560
2561 sub _items_pkg {
2562   my $self = shift;
2563   my %options = @_;
2564   my $section = delete $options{'section'};
2565   my @cust_bill_pkg =
2566     grep { $_->pkgnum &&
2567            ( defined($section)
2568                ? $_->part_pkg->classname eq $section->{'description'}
2569                : 1
2570            )
2571          } $self->cust_bill_pkg;
2572   $self->_items_cust_bill_pkg(\@cust_bill_pkg, %options);
2573 }
2574
2575 sub _taxsort {
2576   return 0 unless $a cmp $b;
2577   return -1 if $b eq 'Tax';
2578   return 1 if $a eq 'Tax';
2579   return -1 if $b eq 'Other surcharges';
2580   return 1 if $a eq 'Other surcharges';
2581   $a cmp $b;
2582 }
2583
2584 sub _items_tax {
2585   my $self = shift;
2586   my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum } $self->cust_bill_pkg;
2587   $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
2588 }
2589
2590 sub _items_cust_bill_pkg {
2591   my $self = shift;
2592   my $cust_bill_pkg = shift;
2593   my %opt = @_;
2594
2595   my $format = $opt{format} || '';
2596   my $escape_function = $opt{escape_function} || sub { shift };
2597
2598   my @b = ();
2599   foreach my $cust_bill_pkg ( @$cust_bill_pkg ) {
2600
2601     my $cust_pkg = $cust_bill_pkg->cust_pkg;
2602
2603     my $desc = $cust_bill_pkg->desc;
2604
2605     my %details_opt = ( 'format'          => $format,
2606                         'escape_function' => $escape_function,
2607                       );
2608
2609     if ( $cust_bill_pkg->pkgnum > 0 ) {
2610
2611       if ( $cust_bill_pkg->setup != 0 ) {
2612
2613         my $description = $desc;
2614         $description .= ' Setup' if $cust_bill_pkg->recur != 0;
2615
2616         my @d = map &{$escape_function}($_),
2617                        $cust_pkg->h_labels_short($self->_date);
2618         push @d, $cust_bill_pkg->details(%details_opt)
2619           if $cust_bill_pkg->recur == 0;
2620
2621         push @b, {
2622           description     => $description,
2623           #pkgpart         => $part_pkg->pkgpart,
2624           pkgnum          => $cust_bill_pkg->pkgnum,
2625           amount          => sprintf("%.2f", $cust_bill_pkg->setup),
2626           ext_description => \@d,
2627         };
2628       }
2629
2630       if ( $cust_bill_pkg->recur != 0 ) {
2631
2632         my $description = $desc;
2633         unless ( $conf->exists('disable_line_item_date_ranges') ) {
2634           $desc .= " (" . time2str("%x", $cust_bill_pkg->sdate).
2635                    " - ". time2str("%x", $cust_bill_pkg->edate). ")";
2636         }
2637
2638         #at least until cust_bill_pkg has "past" ranges in addition to
2639         #the "future" sdate/edate ones... see #3032
2640         my @d = map &{$escape_function}($_),
2641                     $cust_pkg->h_labels_short($self->_date);
2642                                               #$cust_bill_pkg->edate,
2643                                               #$cust_bill_pkg->sdate),
2644         push @d, $cust_bill_pkg->details(%details_opt);
2645
2646         push @b, {
2647           description     => $description,
2648           #pkgpart         => $part_pkg->pkgpart,
2649           pkgnum          => $cust_bill_pkg->pkgnum,
2650           amount          => sprintf("%.2f", $cust_bill_pkg->recur),
2651           ext_description => \@d,
2652
2653         };
2654
2655       }
2656
2657     } else { #pkgnum tax or one-shot line item (??)
2658
2659       if ( $cust_bill_pkg->setup != 0 ) {
2660         push @b, {
2661           'description' => $desc,
2662           'amount'      => sprintf("%.2f", $cust_bill_pkg->setup),
2663         };
2664       }
2665       if ( $cust_bill_pkg->recur != 0 ) {
2666         push @b, {
2667           'description' => "$desc (".
2668                            time2str("%x", $cust_bill_pkg->sdate). ' - '.
2669                            time2str("%x", $cust_bill_pkg->edate). ')',
2670           'amount'      => sprintf("%.2f", $cust_bill_pkg->recur),
2671         };
2672       }
2673
2674     }
2675
2676   }
2677
2678   @b;
2679
2680 }
2681
2682 sub _items_credits {
2683   my $self = shift;
2684
2685   my @b;
2686   #credits
2687   foreach ( $self->cust_credited ) {
2688
2689     #something more elaborate if $_->amount ne $_->cust_credit->credited ?
2690
2691     my $reason = $_->cust_credit->reason;
2692     #my $reason = substr($_->cust_credit->reason,0,32);
2693     #$reason .= '...' if length($reason) < length($_->cust_credit->reason);
2694     $reason = " ($reason) " if $reason;
2695     push @b, {
2696       #'description' => 'Credit ref\#'. $_->crednum.
2697       #                 " (". time2str("%x",$_->cust_credit->_date) .")".
2698       #                 $reason,
2699       'description' => 'Credit applied '.
2700                        time2str("%x",$_->cust_credit->_date). $reason,
2701       'amount'      => sprintf("%.2f",$_->amount),
2702     };
2703   }
2704   #foreach ( @cr_cust_credit ) {
2705   #  push @buf,[
2706   #    "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")",
2707   #    $money_char. sprintf("%10.2f",$_->credited)
2708   #  ];
2709   #}
2710
2711   @b;
2712
2713 }
2714
2715 sub _items_payments {
2716   my $self = shift;
2717
2718   my @b;
2719   #get & print payments
2720   foreach ( $self->cust_bill_pay ) {
2721
2722     #something more elaborate if $_->amount ne ->cust_pay->paid ?
2723
2724     push @b, {
2725       'description' => "Payment received ".
2726                        time2str("%x",$_->cust_pay->_date ),
2727       'amount'      => sprintf("%.2f", $_->amount )
2728     };
2729   }
2730
2731   @b;
2732
2733 }
2734
2735
2736 =back
2737
2738 =head1 SUBROUTINES
2739
2740 =over 4
2741
2742 =item reprint
2743
2744 =cut
2745
2746 sub process_reprint {
2747   process_re_X('print', @_);
2748 }
2749
2750 =item reemail
2751
2752 =cut
2753
2754 sub process_reemail {
2755   process_re_X('email', @_);
2756 }
2757
2758 =item refax
2759
2760 =cut
2761
2762 sub process_refax {
2763   process_re_X('fax', @_);
2764 }
2765
2766 use Storable qw(thaw);
2767 use Data::Dumper;
2768 use MIME::Base64;
2769 sub process_re_X {
2770   my( $method, $job ) = ( shift, shift );
2771   warn "$me process_re_X $method for job $job\n" if $DEBUG;
2772
2773   my $param = thaw(decode_base64(shift));
2774   warn Dumper($param) if $DEBUG;
2775
2776   re_X(
2777     $method,
2778     $job,
2779     %$param,
2780   );
2781
2782 }
2783
2784 sub re_X {
2785   my($method, $job, %param ) = @_;
2786   if ( $DEBUG ) {
2787     warn "re_X $method for job $job with param:\n".
2788          join( '', map { "  $_ => ". $param{$_}. "\n" } keys %param );
2789   }
2790
2791   #some false laziness w/search/cust_bill.html
2792   my $distinct = '';
2793   my $orderby = 'ORDER BY cust_bill._date';
2794
2795   my $extra_sql = ' WHERE '. FS::cust_bill->search_sql(\%param);
2796
2797   my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
2798
2799   my @cust_bill = qsearch( {
2800     #'select'    => "cust_bill.*",
2801     'table'     => 'cust_bill',
2802     'addl_from' => $addl_from,
2803     'hashref'   => {},
2804     'extra_sql' => $extra_sql,
2805     'order_by'  => $orderby,
2806     'debug' => 1,
2807   } );
2808
2809   warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
2810     if $DEBUG;
2811
2812   my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
2813   foreach my $cust_bill ( @cust_bill ) {
2814     $cust_bill->$method();
2815
2816     if ( $job ) { #progressbar foo
2817       $num++;
2818       if ( time - $min_sec > $last ) {
2819         my $error = $job->update_statustext(
2820           int( 100 * $num / scalar(@cust_bill) )
2821         );
2822         die $error if $error;
2823         $last = time;
2824       }
2825     }
2826
2827   }
2828
2829 }
2830
2831 =back
2832
2833 =head1 CLASS METHODS
2834
2835 =over 4
2836
2837 =item owed_sql
2838
2839 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
2840
2841 =cut
2842
2843 sub owed_sql {
2844   my $class = shift;
2845   'charged - '. $class->paid_sql. ' - '. $class->credited_sql;
2846 }
2847
2848 =item net_sql
2849
2850 Returns an SQL fragment to retreive the net amount (charged minus credited).
2851
2852 =cut
2853
2854 sub net_sql {
2855   my $class = shift;
2856   'charged - '. $class->credited_sql;
2857 }
2858
2859 =item paid_sql
2860
2861 Returns an SQL fragment to retreive the amount paid against this invoice.
2862
2863 =cut
2864
2865 sub paid_sql {
2866   #my $class = shift;
2867   "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
2868        WHERE cust_bill.invnum = cust_bill_pay.invnum   )";
2869 }
2870
2871 =item credited_sql
2872
2873 Returns an SQL fragment to retreive the amount credited against this invoice.
2874
2875 =cut
2876
2877 sub credited_sql {
2878   #my $class = shift;
2879   "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
2880        WHERE cust_bill.invnum = cust_credit_bill.invnum   )";
2881 }
2882
2883 =item search_sql HASHREF
2884
2885 Class method which returns an SQL WHERE fragment to search for parameters
2886 specified in HASHREF.  Valid parameters are
2887
2888 =over 4
2889
2890 =item begin
2891
2892 Epoch date (UNIX timestamp) setting a lower bound for _date values
2893
2894 =item end
2895
2896 Epoch date (UNIX timestamp) setting an upper bound for _date values
2897
2898 =item invnum_min
2899
2900 =item invnum_max
2901
2902 =item agentnum
2903
2904 =item owed
2905
2906 =item net
2907
2908 =item days
2909
2910 =item newest_percust
2911
2912 =back
2913
2914 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
2915
2916 =cut
2917
2918 sub search_sql {
2919   my($class, $param) = @_;
2920   if ( $DEBUG ) {
2921     warn "$me search_sql called with params: \n".
2922          join("\n", map { "  $_: ". $param->{$_} } keys %$param ). "\n";
2923   }
2924
2925   my @search = ();
2926
2927   if ( $param->{'begin'} =~ /^(\d+)$/ ) {
2928     push @search, "cust_bill._date >= $1";
2929   }
2930   if ( $param->{'end'} =~ /^(\d+)$/ ) {
2931     push @search, "cust_bill._date < $1";
2932   }
2933   if ( $param->{'invnum_min'} =~ /^(\d+)$/ ) {
2934     push @search, "cust_bill.invnum >= $1";
2935   }
2936   if ( $param->{'invnum_max'} =~ /^(\d+)$/ ) {
2937     push @search, "cust_bill.invnum <= $1";
2938   }
2939   if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
2940     push @search, "cust_main.agentnum = $1";
2941   }
2942
2943   push @search, '0 != '. FS::cust_bill->owed_sql
2944     if $param->{'open'};
2945
2946   push @search, '0 != '. FS::cust_bill->net_sql
2947     if $param->{'net'};
2948
2949   push @search, "cust_bill._date < ". (time-86400*$param->{'days'})
2950     if $param->{'days'};
2951
2952   if ( $param->{'newest_percust'} ) {
2953
2954     #$distinct = 'DISTINCT ON ( cust_bill.custnum )';
2955     #$orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
2956
2957     my @newest_where = map { my $x = $_;
2958                              $x =~ s/\bcust_bill\./newest_cust_bill./g;
2959                              $x;
2960                            }
2961                            grep ! /^cust_main./, @search;
2962     my $newest_where = scalar(@newest_where)
2963                          ? ' AND '. join(' AND ', @newest_where)
2964                          : '';
2965
2966
2967     push @search, "cust_bill._date = (
2968       SELECT(MAX(newest_cust_bill._date)) FROM cust_bill AS newest_cust_bill
2969         WHERE newest_cust_bill.custnum = cust_bill.custnum
2970           $newest_where
2971     )";
2972
2973   }
2974
2975   my $curuser = $FS::CurrentUser::CurrentUser;
2976   if ( $curuser->username eq 'fs_queue'
2977        && $param->{'CurrentUser'} =~ /^(\w+)$/ ) {
2978     my $username = $1;
2979     my $newuser = qsearchs('access_user', {
2980       'username' => $username,
2981       'disabled' => '',
2982     } );
2983     if ( $newuser ) {
2984       $curuser = $newuser;
2985     } else {
2986       warn "$me WARNING: (fs_queue) can't find CurrentUser $username\n";
2987     }
2988   }
2989
2990   push @search, $curuser->agentnums_sql;
2991
2992   join(' AND ', @search );
2993
2994 }
2995
2996 =back
2997
2998 =head1 BUGS
2999
3000 The delete method.
3001
3002 =head1 SEE ALSO
3003
3004 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
3005 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base
3006 documentation.
3007
3008 =cut
3009
3010 1;
3011