FS/FS/cust_bill.pm

   1 package FS::cust_bill;
   2
   3 use strict;
   4 use vars qw( @ISA $DEBUG $me
   5              $money_char $date_format $rdate_format $date_format_long );
   6              # but NOT $conf
   7 use vars qw( $invoice_lines @buf ); #yuck
   8 use Fcntl qw(:flock); #for spool_csv
   9 use Cwd;
  10 use List::Util qw(min max sum);
  11 use Date::Format;
  12 use Date::Language;
  13 use Text::Template 1.20;
  14 use File::Temp 0.14;
  15 use String::ShellQuote;
  16 use HTML::Entities;
  17 use Locale::Country;
  18 use Storable qw( freeze thaw );
  19 use GD::Barcode;
  20 use FS::UID qw( datasrc );
  21 use FS::Misc qw( send_email send_fax generate_ps generate_pdf do_print );
  22 use FS::Record qw( qsearch qsearchs dbh );
  23 use FS::cust_main_Mixin;
  24 use FS::cust_main;
  25 use FS::cust_statement;
  26 use FS::cust_bill_pkg;
  27 use FS::cust_bill_pkg_display;
  28 use FS::cust_bill_pkg_detail;
  29 use FS::cust_credit;
  30 use FS::cust_pay;
  31 use FS::cust_pkg;
  32 use FS::cust_credit_bill;
  33 use FS::pay_batch;
  34 use FS::cust_pay_batch;
  35 use FS::cust_bill_event;
  36 use FS::cust_event;
  37 use FS::part_pkg;
  38 use FS::cust_bill_pay;
  39 use FS::cust_bill_pay_batch;
  40 use FS::part_bill_event;
  41 use FS::payby;
  42 use FS::bill_batch;
  43 use FS::cust_bill_batch;
  44 use FS::cust_bill_pay_pkg;
  45 use FS::cust_credit_bill_pkg;
  46 use FS::discount_plan;
  47 use FS::L10N;
  48
  49 @ISA = qw( FS::cust_main_Mixin FS::Record );
  50
  51 $DEBUG = 0;
  52 $me = '[FS::cust_bill]';
  53
  54 #ask FS::UID to run this stuff for us later
  55 FS::UID->install_callback( sub {
  56   my $conf = new FS::Conf; #global
  57   $money_char       = $conf->config('money_char')       || '$';
  58   $date_format      = $conf->config('date_format')      || '%x'; #/YY
  59   $rdate_format     = $conf->config('date_format')      || '%m/%d/%Y';  #/YYYY
  60   $date_format_long = $conf->config('date_format_long') || '%b %o, %Y';
  61 } );
  62
  63 =head1 NAME
  64
  65 FS::cust_bill - Object methods for cust_bill records
  66
  67 =head1 SYNOPSIS
  68
  69   use FS::cust_bill;
  70
  71   $record = new FS::cust_bill \%hash;
  72   $record = new FS::cust_bill { 'column' => 'value' };
  73
  74   $error = $record->insert;
  75
  76   $error = $new_record->replace($old_record);
  77
  78   $error = $record->delete;
  79
  80   $error = $record->check;
  81
  82   ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
  83
  84   @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
  85
  86   ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
  87
  88   @cust_pay_objects = $cust_bill->cust_pay;
  89
  90   $tax_amount = $record->tax;
  91
  92   @lines = $cust_bill->print_text;
  93   @lines = $cust_bill->print_text $time;
  94
  95 =head1 DESCRIPTION
  96
  97 An FS::cust_bill object represents an invoice; a declaration that a customer
  98 owes you money.  The specific charges are itemized as B<cust_bill_pkg> records
  99 (see L<FS::cust_bill_pkg>).  FS::cust_bill inherits from FS::Record.  The
 100 following fields are currently supported:
 101
 102 Regular fields
 103
 104 =over 4
 105
 106 =item invnum - primary key (assigned automatically for new invoices)
 107
 108 =item custnum - customer (see L<FS::cust_main>)
 109
 110 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
 111 L<Time::Local> and L<Date::Parse> for conversion functions.
 112
 113 =item charged - amount of this invoice
 114
 115 =item invoice_terms - optional terms override for this specific invoice
 116
 117 =back
 118
 119 Customer info at invoice generation time
 120
 121 =over 4
 122
 123 =item previous_balance
 124
 125 =item billing_balance
 126
 127 =back
 128
 129 Deprecated
 130
 131 =over 4
 132
 133 =item printed - deprecated
 134
 135 =back
 136
 137 Specific use cases
 138
 139 =over 4
 140
 141 =item closed - books closed flag, empty or `Y'
 142
 143 =item statementnum - invoice aggregation (see L<FS::cust_statement>)
 144
 145 =item agent_invid - legacy invoice number
 146
 147 =item promised_date - customer promised payment date, for collection
 148
 149 =back
 150
 151 =head1 METHODS
 152
 153 =over 4
 154
 155 =item new HASHREF
 156
 157 Creates a new invoice.  To add the invoice to the database, see L<"insert">.
 158 Invoices are normally created by calling the bill method of a customer object
 159 (see L<FS::cust_main>).
 160
 161 =cut
 162
 163 sub table { 'cust_bill'; }
 164
 165 sub cust_linked { $_[0]->cust_main_custnum; }
 166 sub cust_unlinked_msg {
 167   my $self = shift;
 168   "WARNING: can't find cust_main.custnum ". $self->custnum.
 169   ' (cust_bill.invnum '. $self->invnum. ')';
 170 }
 171
 172 =item insert
 173
 174 Adds this invoice to the database ("Posts" the invoice).  If there is an error,
 175 returns the error, otherwise returns false.
 176
 177 =cut
 178
 179 sub insert {
 180   my $self = shift;
 181   warn "$me insert called\n" if $DEBUG;
 182
 183   local $SIG{HUP} = 'IGNORE';
 184   local $SIG{INT} = 'IGNORE';
 185   local $SIG{QUIT} = 'IGNORE';
 186   local $SIG{TERM} = 'IGNORE';
 187   local $SIG{TSTP} = 'IGNORE';
 188   local $SIG{PIPE} = 'IGNORE';
 189
 190   my $oldAutoCommit = $FS::UID::AutoCommit;
 191   local $FS::UID::AutoCommit = 0;
 192   my $dbh = dbh;
 193
 194   my $error = $self->SUPER::insert;
 195   if ( $error ) {
 196     $dbh->rollback if $oldAutoCommit;
 197     return $error;
 198   }
 199
 200   if ( $self->get('cust_bill_pkg') ) {
 201     foreach my $cust_bill_pkg ( @{$self->get('cust_bill_pkg')} ) {
 202       $cust_bill_pkg->invnum($self->invnum);
 203       my $error = $cust_bill_pkg->insert;
 204       if ( $error ) {
 205         $dbh->rollback if $oldAutoCommit;
 206         return "can't create invoice line item: $error";
 207       }
 208     }
 209   }
 210
 211   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 212   '';
 213
 214 }
 215
 216 =item delete
 217
 218 This method now works but you probably shouldn't use it.  Instead, apply a
 219 credit against the invoice.
 220
 221 Using this method to delete invoices outright is really, really bad.  There
 222 would be no record you ever posted this invoice, and there are no check to
 223 make sure charged = 0 or that there are no associated cust_bill_pkg records.
 224
 225 Really, don't use it.
 226
 227 =cut
 228
 229 sub delete {
 230   my $self = shift;
 231   return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
 232
 233   local $SIG{HUP} = 'IGNORE';
 234   local $SIG{INT} = 'IGNORE';
 235   local $SIG{QUIT} = 'IGNORE';
 236   local $SIG{TERM} = 'IGNORE';
 237   local $SIG{TSTP} = 'IGNORE';
 238   local $SIG{PIPE} = 'IGNORE';
 239
 240   my $oldAutoCommit = $FS::UID::AutoCommit;
 241   local $FS::UID::AutoCommit = 0;
 242   my $dbh = dbh;
 243
 244   foreach my $table (qw(
 245     cust_bill_event
 246     cust_event
 247     cust_credit_bill
 248     cust_bill_pay
 249     cust_credit_bill
 250     cust_pay_batch
 251     cust_bill_pay_batch
 252     cust_bill_pkg
 253     cust_bill_batch
 254   )) {
 255
 256     foreach my $linked ( $self->$table() ) {
 257       my $error = $linked->delete;
 258       if ( $error ) {
 259         $dbh->rollback if $oldAutoCommit;
 260         return $error;
 261       }
 262     }
 263
 264   }
 265
 266   my $error = $self->SUPER::delete(@_);
 267   if ( $error ) {
 268     $dbh->rollback if $oldAutoCommit;
 269     return $error;
 270   }
 271
 272   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 273
 274   '';
 275
 276 }
 277
 278 =item replace [ OLD_RECORD ]
 279
 280 You can, but probably shouldn't modify invoices...
 281
 282 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
 283 supplied, replaces this record.  If there is an error, returns the error,
 284 otherwise returns false.
 285
 286 =cut
 287
 288 #replace can be inherited from Record.pm
 289
 290 # replace_check is now the preferred way to #implement replace data checks
 291 # (so $object->replace() works without an argument)
 292
 293 sub replace_check {
 294   my( $new, $old ) = ( shift, shift );
 295   return "Can't modify closed invoice" if $old->closed =~ /^Y/i;
 296   #return "Can't change _date!" unless $old->_date eq $new->_date;
 297   return "Can't change _date" unless $old->_date == $new->_date;
 298   return "Can't change charged" unless $old->charged == $new->charged
 299                                     || $old->charged == 0
 300                                     || $new->{'Hash'}{'cc_surcharge_replace_hack'};
 301
 302   '';
 303 }
 304
 305
 306 =item add_cc_surcharge
 307
 308 Giant hack
 309
 310 =cut
 311
 312 sub add_cc_surcharge {
 313     my ($self, $pkgnum, $amount) = (shift, shift, shift);
 314
 315     my $error;
 316     my $cust_bill_pkg = new FS::cust_bill_pkg({
 317                                     'invnum' => $self->invnum,
 318                                     'pkgnum' => $pkgnum,
 319                                     'setup' => $amount,
 320                         });
 321     $error = $cust_bill_pkg->insert;
 322     return $error if $error;
 323
 324     $self->{'Hash'}{'cc_surcharge_replace_hack'} = 1;
 325     $self->charged($self->charged+$amount);
 326     $error = $self->replace;
 327     return $error if $error;
 328
 329     $self->apply_payments_and_credits;
 330 }
 331
 332
 333 =item check
 334
 335 Checks all fields to make sure this is a valid invoice.  If there is an error,
 336 returns the error, otherwise returns false.  Called by the insert and replace
 337 methods.
 338
 339 =cut
 340
 341 sub check {
 342   my $self = shift;
 343
 344   my $error =
 345     $self->ut_numbern('invnum')
 346     || $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
 347     || $self->ut_numbern('_date')
 348     || $self->ut_money('charged')
 349     || $self->ut_numbern('printed')
 350     || $self->ut_enum('closed', [ '', 'Y' ])
 351     || $self->ut_foreign_keyn('statementnum', 'cust_statement', 'statementnum' )
 352     || $self->ut_numbern('agent_invid') #varchar?
 353   ;
 354   return $error if $error;
 355
 356   $self->_date(time) unless $self->_date;
 357
 358   $self->printed(0) if $self->printed eq '';
 359
 360   $self->SUPER::check;
 361 }
 362
 363 =item display_invnum
 364
 365 Returns the displayed invoice number for this invoice: agent_invid if
 366 cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
 367
 368 =cut
 369
 370 sub display_invnum {
 371   my $self = shift;
 372   my $conf = $self->conf;
 373   if ( $conf->exists('cust_bill-default_agent_invid') && $self->agent_invid ){
 374     return $self->agent_invid;
 375   } else {
 376     return $self->invnum;
 377   }
 378 }
 379
 380 =item previous
 381
 382 Returns a list consisting of the total previous balance for this customer,
 383 followed by the previous outstanding invoices (as FS::cust_bill objects also).
 384
 385 =cut
 386
 387 sub previous {
 388   my $self = shift;
 389   my $total = 0;
 390   my @cust_bill = sort { $a->_date <=> $b->_date }
 391     grep { $_->owed != 0 && $_->_date < $self->_date }
 392       qsearch( 'cust_bill', { 'custnum' => $self->custnum } )
 393   ;
 394   foreach ( @cust_bill ) { $total += $_->owed; }
 395   $total, @cust_bill;
 396 }
 397
 398 =item cust_bill_pkg
 399
 400 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
 401
 402 =cut
 403
 404 sub cust_bill_pkg {
 405   my $self = shift;
 406   qsearch(
 407     { 'table'    => 'cust_bill_pkg',
 408       'hashref'  => { 'invnum' => $self->invnum },
 409       'order_by' => 'ORDER BY billpkgnum',
 410     }
 411   );
 412 }
 413
 414 =item cust_bill_pkg_pkgnum PKGNUM
 415
 416 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice and
 417 specified pkgnum.
 418
 419 =cut
 420
 421 sub cust_bill_pkg_pkgnum {
 422   my( $self, $pkgnum ) = @_;
 423   qsearch(
 424     { 'table'    => 'cust_bill_pkg',
 425       'hashref'  => { 'invnum' => $self->invnum,
 426                       'pkgnum' => $pkgnum,
 427                     },
 428       'order_by' => 'ORDER BY billpkgnum',
 429     }
 430   );
 431 }
 432
 433 =item cust_pkg
 434
 435 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
 436 this invoice.
 437
 438 =cut
 439
 440 sub cust_pkg {
 441   my $self = shift;
 442   my @cust_pkg = map { $_->pkgnum > 0 ? $_->cust_pkg : () }
 443                      $self->cust_bill_pkg;
 444   my %saw = ();
 445   grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
 446 }
 447
 448 =item no_auto
 449
 450 Returns true if any of the packages (or their definitions) corresponding to the
 451 line items for this invoice have the no_auto flag set.
 452
 453 =cut
 454
 455 sub no_auto {
 456   my $self = shift;
 457   grep { $_->no_auto || $_->part_pkg->no_auto } $self->cust_pkg;
 458 }
 459
 460 =item open_cust_bill_pkg
 461
 462 Returns the open line items for this invoice.
 463
 464 Note that cust_bill_pkg with both setup and recur fees are returned as two
 465 separate line items, each with only one fee.
 466
 467 =cut
 468
 469 # modeled after cust_main::open_cust_bill
 470 sub open_cust_bill_pkg {
 471   my $self = shift;
 472
 473   # grep { $_->owed > 0 } $self->cust_bill_pkg
 474
 475   my %other = ( 'recur' => 'setup',
 476                 'setup' => 'recur', );
 477   my @open = ();
 478   foreach my $field ( qw( recur setup )) {
 479     push @open, map  { $_->set( $other{$field}, 0 ); $_; }
 480                 grep { $_->owed($field) > 0 }
 481                 $self->cust_bill_pkg;
 482   }
 483
 484   @open;
 485 }
 486
 487 =item cust_bill_event
 488
 489 Returns the completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
 490
 491 =cut
 492
 493 sub cust_bill_event {
 494   my $self = shift;
 495   qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
 496 }
 497
 498 =item num_cust_bill_event
 499
 500 Returns the number of completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
 501
 502 =cut
 503
 504 sub num_cust_bill_event {
 505   my $self = shift;
 506   my $sql =
 507     "SELECT COUNT(*) FROM cust_bill_event WHERE invnum = ?";
 508   my $sth = dbh->prepare($sql) or die  dbh->errstr. " preparing $sql";
 509   $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
 510   $sth->fetchrow_arrayref->[0];
 511 }
 512
 513 =item cust_event
 514
 515 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
 516
 517 =cut
 518
 519 #false laziness w/cust_pkg.pm
 520 sub cust_event {
 521   my $self = shift;
 522   qsearch({
 523     'table'     => 'cust_event',
 524     'addl_from' => 'JOIN part_event USING ( eventpart )',
 525     'hashref'   => { 'tablenum' => $self->invnum },
 526     'extra_sql' => " AND eventtable = 'cust_bill' ",
 527   });
 528 }
 529
 530 =item num_cust_event
 531
 532 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
 533
 534 =cut
 535
 536 #false laziness w/cust_pkg.pm
 537 sub num_cust_event {
 538   my $self = shift;
 539   my $sql =
 540     "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
 541     "  WHERE tablenum = ? AND eventtable = 'cust_bill'";
 542   my $sth = dbh->prepare($sql) or die  dbh->errstr. " preparing $sql";
 543   $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
 544   $sth->fetchrow_arrayref->[0];
 545 }
 546
 547 =item cust_main
 548
 549 Returns the customer (see L<FS::cust_main>) for this invoice.
 550
 551 =cut
 552
 553 sub cust_main {
 554   my $self = shift;
 555   qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
 556 }
 557
 558 =item cust_suspend_if_balance_over AMOUNT
 559
 560 Suspends the customer associated with this invoice if the total amount owed on
 561 this invoice and all older invoices is greater than the specified amount.
 562
 563 Returns a list: an empty list on success or a list of errors.
 564
 565 =cut
 566
 567 sub cust_suspend_if_balance_over {
 568   my( $self, $amount ) = ( shift, shift );
 569   my $cust_main = $self->cust_main;
 570   if ( $cust_main->total_owed_date($self->_date) < $amount ) {
 571     return ();
 572   } else {
 573     $cust_main->suspend(@_);
 574   }
 575 }
 576
 577 =item cust_credit
 578
 579 Depreciated.  See the cust_credited method.
 580
 581  #Returns a list consisting of the total previous credited (see
 582  #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
 583  #outstanding credits (FS::cust_credit objects).
 584
 585 =cut
 586
 587 sub cust_credit {
 588   use Carp;
 589   croak "FS::cust_bill->cust_credit depreciated; see ".
 590         "FS::cust_bill->cust_credit_bill";
 591   #my $self = shift;
 592   #my $total = 0;
 593   #my @cust_credit = sort { $a->_date <=> $b->_date }
 594   #  grep { $_->credited != 0 && $_->_date < $self->_date }
 595   #    qsearch('cust_credit', { 'custnum' => $self->custnum } )
 596   #;
 597   #foreach (@cust_credit) { $total += $_->credited; }
 598   #$total, @cust_credit;
 599 }
 600
 601 =item cust_pay
 602
 603 Depreciated.  See the cust_bill_pay method.
 604
 605 #Returns all payments (see L<FS::cust_pay>) for this invoice.
 606
 607 =cut
 608
 609 sub cust_pay {
 610   use Carp;
 611   croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
 612   #my $self = shift;
 613   #sort { $a->_date <=> $b->_date }
 614   #  qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
 615   #;
 616 }
 617
 618 sub cust_pay_batch {
 619   my $self = shift;
 620   qsearch('cust_pay_batch', { 'invnum' => $self->invnum } );
 621 }
 622
 623 sub cust_bill_pay_batch {
 624   my $self = shift;
 625   qsearch('cust_bill_pay_batch', { 'invnum' => $self->invnum } );
 626 }
 627
 628 =item cust_bill_pay
 629
 630 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
 631
 632 =cut
 633
 634 sub cust_bill_pay {
 635   my $self = shift;
 636   map { $_ } #return $self->num_cust_bill_pay unless wantarray;
 637   sort { $a->_date <=> $b->_date }
 638     qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
 639 }
 640
 641 =item cust_credited
 642
 643 =item cust_credit_bill
 644
 645 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
 646
 647 =cut
 648
 649 sub cust_credited {
 650   my $self = shift;
 651   map { $_ } #return $self->num_cust_credit_bill unless wantarray;
 652   sort { $a->_date <=> $b->_date }
 653     qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
 654   ;
 655 }
 656
 657 sub cust_credit_bill {
 658   shift->cust_credited(@_);
 659 }
 660
 661 #=item cust_bill_pay_pkgnum PKGNUM
 662 #
 663 #Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
 664 #with matching pkgnum.
 665 #
 666 #=cut
 667 #
 668 #sub cust_bill_pay_pkgnum {
 669 #  my( $self, $pkgnum ) = @_;
 670 #  map { $_ } #return $self->num_cust_bill_pay_pkgnum($pkgnum) unless wantarray;
 671 #  sort { $a->_date <=> $b->_date }
 672 #    qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum,
 673 #                                'pkgnum' => $pkgnum,
 674 #                              }
 675 #           );
 676 #}
 677
 678 =item cust_bill_pay_pkg PKGNUM
 679
 680 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
 681 applied against the matching pkgnum.
 682
 683 =cut
 684
 685 sub cust_bill_pay_pkg {
 686   my( $self, $pkgnum ) = @_;
 687
 688   qsearch({
 689     'select'    => 'cust_bill_pay_pkg.*',
 690     'table'     => 'cust_bill_pay_pkg',
 691     'addl_from' => ' LEFT JOIN cust_bill_pay USING ( billpaynum ) '.
 692                    ' LEFT JOIN cust_bill_pkg USING ( billpkgnum ) ',
 693     'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
 694                    "   AND cust_bill_pkg.pkgnum = $pkgnum",
 695   });
 696
 697 }
 698
 699 #=item cust_credited_pkgnum PKGNUM
 700 #
 701 #=item cust_credit_bill_pkgnum PKGNUM
 702 #
 703 #Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice
 704 #with matching pkgnum.
 705 #
 706 #=cut
 707 #
 708 #sub cust_credited_pkgnum {
 709 #  my( $self, $pkgnum ) = @_;
 710 #  map { $_ } #return $self->num_cust_credit_bill_pkgnum($pkgnum) unless wantarray;
 711 #  sort { $a->_date <=> $b->_date }
 712 #    qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum,
 713 #                                   'pkgnum' => $pkgnum,
 714 #                                 }
 715 #           );
 716 #}
 717 #
 718 #sub cust_credit_bill_pkgnum {
 719 #  shift->cust_credited_pkgnum(@_);
 720 #}
 721
 722 =item cust_credit_bill_pkg PKGNUM
 723
 724 Returns all credit applications (see L<FS::cust_credit_bill>) for this invoice
 725 applied against the matching pkgnum.
 726
 727 =cut
 728
 729 sub cust_credit_bill_pkg {
 730   my( $self, $pkgnum ) = @_;
 731
 732   qsearch({
 733     'select'    => 'cust_credit_bill_pkg.*',
 734     'table'     => 'cust_credit_bill_pkg',
 735     'addl_from' => ' LEFT JOIN cust_credit_bill USING ( creditbillnum ) '.
 736                    ' LEFT JOIN cust_bill_pkg    USING ( billpkgnum    ) ',
 737     'extra_sql' => ' WHERE cust_bill_pkg.invnum = '. $self->invnum.
 738                    "   AND cust_bill_pkg.pkgnum = $pkgnum",
 739   });
 740
 741 }
 742
 743 =item cust_bill_batch
 744
 745 Returns all invoice batch records (L<FS::cust_bill_batch>) for this invoice.
 746
 747 =cut
 748
 749 sub cust_bill_batch {
 750   my $self = shift;
 751   qsearch('cust_bill_batch', { 'invnum' => $self->invnum });
 752 }
 753
 754 =item discount_plans
 755
 756 Returns all discount plans (L<FS::discount_plan>) for this invoice, as a
 757 hash keyed by term length.
 758
 759 =cut
 760
 761 sub discount_plans {
 762   my $self = shift;
 763   FS::discount_plan->all($self);
 764 }
 765
 766 =item tax
 767
 768 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
 769
 770 =cut
 771
 772 sub tax {
 773   my $self = shift;
 774   my $total = 0;
 775   my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
 776                                              'pkgnum' => 0 } );
 777   foreach (@taxlines) { $total += $_->setup; }
 778   $total;
 779 }
 780
 781 =item owed
 782
 783 Returns the amount owed (still outstanding) on this invoice, which is charged
 784 minus all payment applications (see L<FS::cust_bill_pay>) and credit
 785 applications (see L<FS::cust_credit_bill>).
 786
 787 =cut
 788
 789 sub owed {
 790   my $self = shift;
 791   my $balance = $self->charged;
 792   $balance -= $_->amount foreach ( $self->cust_bill_pay );
 793   $balance -= $_->amount foreach ( $self->cust_credited );
 794   $balance = sprintf( "%.2f", $balance);
 795   $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
 796   $balance;
 797 }
 798
 799 sub owed_pkgnum {
 800   my( $self, $pkgnum ) = @_;
 801
 802   #my $balance = $self->charged;
 803   my $balance = 0;
 804   $balance += $_->setup + $_->recur for $self->cust_bill_pkg_pkgnum($pkgnum);
 805
 806   $balance -= $_->amount            for $self->cust_bill_pay_pkg($pkgnum);
 807   $balance -= $_->amount            for $self->cust_credit_bill_pkg($pkgnum);
 808
 809   $balance = sprintf( "%.2f", $balance);
 810   $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
 811   $balance;
 812 }
 813
 814 =item hide
 815
 816 Returns true if this invoice should be hidden.  See the
 817 selfservice-hide_invoices-taxclass configuraiton setting.
 818
 819 =cut
 820
 821 sub hide {
 822   my $self = shift;
 823   my $conf = $self->conf;
 824   my $hide_taxclass = $conf->config('selfservice-hide_invoices-taxclass')
 825     or return '';
 826   my @cust_bill_pkg = $self->cust_bill_pkg;
 827   my @part_pkg = grep $_, map $_->part_pkg, @cust_bill_pkg;
 828   ! grep { $_->taxclass ne $hide_taxclass } @part_pkg;
 829 }
 830
 831 =item apply_payments_and_credits [ OPTION => VALUE ... ]
 832
 833 Applies unapplied payments and credits to this invoice.
 834
 835 A hash of optional arguments may be passed.  Currently "manual" is supported.
 836 If true, a payment receipt is sent instead of a statement when
 837 'payment_receipt_email' configuration option is set.
 838
 839 If there is an error, returns the error, otherwise returns false.
 840
 841 =cut
 842
 843 sub apply_payments_and_credits {
 844   my( $self, %options ) = @_;
 845   my $conf = $self->conf;
 846
 847   local $SIG{HUP} = 'IGNORE';
 848   local $SIG{INT} = 'IGNORE';
 849   local $SIG{QUIT} = 'IGNORE';
 850   local $SIG{TERM} = 'IGNORE';
 851   local $SIG{TSTP} = 'IGNORE';
 852   local $SIG{PIPE} = 'IGNORE';
 853
 854   my $oldAutoCommit = $FS::UID::AutoCommit;
 855   local $FS::UID::AutoCommit = 0;
 856   my $dbh = dbh;
 857
 858   $self->select_for_update; #mutex
 859
 860   my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
 861   my @credits  = grep { $_->credited > 0 } $self->cust_main->cust_credit;
 862
 863   if ( $conf->exists('pkg-balances') ) {
 864     # limit @payments & @credits to those w/ a pkgnum grepped from $self
 865     my %pkgnums = map { $_ => 1 } map $_->pkgnum, $self->cust_bill_pkg;
 866     @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
 867     @credits  = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
 868   }
 869
 870   while ( $self->owed > 0 and ( @payments || @credits ) ) {
 871
 872     my $app = '';
 873     if ( @payments && @credits ) {
 874
 875       #decide which goes first by weight of top (unapplied) line item
 876
 877       my @open_lineitems = $self->open_cust_bill_pkg;
 878
 879       my $max_pay_weight =
 880         max( map  { $_->part_pkg->pay_weight || 0 }
 881              grep { $_ }
 882              map  { $_->cust_pkg }
 883                   @open_lineitems
 884            );
 885       my $max_credit_weight =
 886         max( map  { $_->part_pkg->credit_weight || 0 }
 887              grep { $_ }
 888              map  { $_->cust_pkg }
 889                   @open_lineitems
 890            );
 891
 892       #if both are the same... payments first?  it has to be something
 893       if ( $max_pay_weight >= $max_credit_weight ) {
 894         $app = 'pay';
 895       } else {
 896         $app = 'credit';
 897       }
 898
 899     } elsif ( @payments ) {
 900       $app = 'pay';
 901     } elsif ( @credits ) {
 902       $app = 'credit';
 903     } else {
 904       die "guru meditation #12 and 35";
 905     }
 906
 907     my $unapp_amount;
 908     if ( $app eq 'pay' ) {
 909
 910       my $payment = shift @payments;
 911       $unapp_amount = $payment->unapplied;
 912       $app = new FS::cust_bill_pay { 'paynum'  => $payment->paynum };
 913       $app->pkgnum( $payment->pkgnum )
 914         if $conf->exists('pkg-balances') && $payment->pkgnum;
 915
 916     } elsif ( $app eq 'credit' ) {
 917
 918       my $credit = shift @credits;
 919       $unapp_amount = $credit->credited;
 920       $app = new FS::cust_credit_bill { 'crednum' => $credit->crednum };
 921       $app->pkgnum( $credit->pkgnum )
 922         if $conf->exists('pkg-balances') && $credit->pkgnum;
 923
 924     } else {
 925       die "guru meditation #12 and 35";
 926     }
 927
 928     my $owed;
 929     if ( $conf->exists('pkg-balances') && $app->pkgnum ) {
 930       warn "owed_pkgnum ". $app->pkgnum;
 931       $owed = $self->owed_pkgnum($app->pkgnum);
 932     } else {
 933       $owed = $self->owed;
 934     }
 935     next unless $owed > 0;
 936
 937     warn "min ( $unapp_amount, $owed )\n" if $DEBUG;
 938     $app->amount( sprintf('%.2f', min( $unapp_amount, $owed ) ) );
 939
 940     $app->invnum( $self->invnum );
 941
 942     my $error = $app->insert(%options);
 943     if ( $error ) {
 944       $dbh->rollback if $oldAutoCommit;
 945       return "Error inserting ". $app->table. " record: $error";
 946     }
 947     die $error if $error;
 948
 949   }
 950
 951   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 952   ''; #no error
 953
 954 }
 955
 956 =item generate_email OPTION => VALUE ...
 957
 958 Options:
 959
 960 =over 4
 961
 962 =item from
 963
 964 sender address, required
 965
 966 =item tempate
 967
 968 alternate template name, optional
 969
 970 =item print_text
 971
 972 text attachment arrayref, optional
 973
 974 =item subject
 975
 976 email subject, optional
 977
 978 =item notice_name
 979
 980 notice name instead of "Invoice", optional
 981
 982 =back
 983
 984 Returns an argument list to be passed to L<FS::Misc::send_email>.
 985
 986 =cut
 987
 988 use MIME::Entity;
 989
 990 sub generate_email {
 991
 992   my $self = shift;
 993   my %args = @_;
 994   my $conf = $self->conf;
 995
 996   my $me = '[FS::cust_bill::generate_email]';
 997
 998   my %return = (
 999     'from'      => $args{'from'},
1000     'subject'   => (($args{'subject'}) ? $args{'subject'} : 'Invoice'),
1001   );
1002
1003   my %opt = (
1004     'unsquelch_cdr' => $conf->exists('voip-cdr_email'),
1005     'template'      => $args{'template'},
1006     'notice_name'   => ( $args{'notice_name'} || 'Invoice' ),
1007     'no_coupon'     => $args{'no_coupon'},
1008   );
1009
1010   my $cust_main = $self->cust_main;
1011
1012   if (ref($args{'to'}) eq 'ARRAY') {
1013     $return{'to'} = $args{'to'};
1014   } else {
1015     $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
1016                            $cust_main->invoicing_list
1017                     ];
1018   }
1019
1020   if ( $conf->exists('invoice_html') ) {
1021
1022     warn "$me creating HTML/text multipart message"
1023       if $DEBUG;
1024
1025     $return{'nobody'} = 1;
1026
1027     my $alternative = build MIME::Entity
1028       'Type'        => 'multipart/alternative',
1029       #'Encoding'    => '7bit',
1030       'Disposition' => 'inline'
1031     ;
1032
1033     my $data;
1034     if ( $conf->exists('invoice_email_pdf')
1035          and scalar($conf->config('invoice_email_pdf_note')) ) {
1036
1037       warn "$me using 'invoice_email_pdf_note' in multipart message"
1038         if $DEBUG;
1039       $data = [ map { $_ . "\n" }
1040                     $conf->config('invoice_email_pdf_note')
1041               ];
1042
1043     } else {
1044
1045       warn "$me not using 'invoice_email_pdf_note' in multipart message"
1046         if $DEBUG;
1047       if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1048         $data = $args{'print_text'};
1049       } else {
1050         $data = [ $self->print_text(\%opt) ];
1051       }
1052
1053     }
1054
1055     $alternative->attach(
1056       'Type'        => 'text/plain',
1057       'Encoding'    => 'quoted-printable',
1058       #'Encoding'    => '7bit',
1059       'Data'        => $data,
1060       'Disposition' => 'inline',
1061     );
1062
1063
1064     my $htmldata;
1065     my $image = '';
1066     my $barcode = '';
1067     if ( $conf->exists('invoice_email_pdf')
1068          and scalar($conf->config('invoice_email_pdf_note')) ) {
1069
1070       $htmldata = join('<BR>', $conf->config('invoice_email_pdf_note') );
1071
1072     } else {
1073
1074       $args{'from'} =~ /\@([\w\.\-]+)/;
1075       my $from = $1 || 'example.com';
1076       my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1077
1078       my $logo;
1079       my $agentnum = $cust_main->agentnum;
1080       if ( defined($args{'template'}) && length($args{'template'})
1081            && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
1082          )
1083       {
1084         $logo = 'logo_'. $args{'template'}. '.png';
1085       } else {
1086         $logo = "logo.png";
1087       }
1088       my $image_data = $conf->config_binary( $logo, $agentnum);
1089
1090       $image = build MIME::Entity
1091         'Type'       => 'image/png',
1092         'Encoding'   => 'base64',
1093         'Data'       => $image_data,
1094         'Filename'   => 'logo.png',
1095         'Content-ID' => "<$content_id>",
1096       ;
1097
1098       if ($conf->exists('invoice-barcode')) {
1099         my $barcode_content_id = join('.', rand()*(2**32), $$, time). "\@$from";
1100         $barcode = build MIME::Entity
1101           'Type'       => 'image/png',
1102           'Encoding'   => 'base64',
1103           'Data'       => $self->invoice_barcode(0),
1104           'Filename'   => 'barcode.png',
1105           'Content-ID' => "<$barcode_content_id>",
1106         ;
1107         $opt{'barcode_cid'} = $barcode_content_id;
1108       }
1109
1110       $htmldata = $self->print_html({ 'cid'=>$content_id, %opt });
1111     }
1112
1113     $alternative->attach(
1114       'Type'        => 'text/html',
1115       'Encoding'    => 'quoted-printable',
1116       'Data'        => [ '<html>',
1117                          '  <head>',
1118                          '    <title>',
1119                          '      '. encode_entities($return{'subject'}),
1120                          '    </title>',
1121                          '  </head>',
1122                          '  <body bgcolor="#e8e8e8">',
1123                          $htmldata,
1124                          '  </body>',
1125                          '</html>',
1126                        ],
1127       'Disposition' => 'inline',
1128       #'Filename'    => 'invoice.pdf',
1129     );
1130
1131
1132     my @otherparts = ();
1133     if ( $cust_main->email_csv_cdr ) {
1134
1135       push @otherparts, build MIME::Entity
1136         'Type'        => 'text/csv',
1137         'Encoding'    => '7bit',
1138         'Data'        => [ map { "$_\n" }
1139                              $self->call_details('prepend_billed_number' => 1)
1140                          ],
1141         'Disposition' => 'attachment',
1142         'Filename'    => 'usage-'. $self->invnum. '.csv',
1143       ;
1144
1145     }
1146
1147     if ( $conf->exists('invoice_email_pdf') ) {
1148
1149       #attaching pdf too:
1150       # multipart/mixed
1151       #   multipart/related
1152       #     multipart/alternative
1153       #       text/plain
1154       #       text/html
1155       #     image/png
1156       #   application/pdf
1157
1158       my $related = build MIME::Entity 'Type'     => 'multipart/related',
1159                                        'Encoding' => '7bit';
1160
1161       #false laziness w/Misc::send_email
1162       $related->head->replace('Content-type',
1163         $related->mime_type.
1164         '; boundary="'. $related->head->multipart_boundary. '"'.
1165         '; type=multipart/alternative'
1166       );
1167
1168       $related->add_part($alternative);
1169
1170       $related->add_part($image) if $image;
1171
1172       my $pdf = build MIME::Entity $self->mimebuild_pdf(\%opt);
1173
1174       $return{'mimeparts'} = [ $related, $pdf, @otherparts ];
1175
1176     } else {
1177
1178       #no other attachment:
1179       # multipart/related
1180       #   multipart/alternative
1181       #     text/plain
1182       #     text/html
1183       #   image/png
1184
1185       $return{'content-type'} = 'multipart/related';
1186       if ($conf->exists('invoice-barcode') && $barcode) {
1187         $return{'mimeparts'} = [ $alternative, $image, $barcode, @otherparts ];
1188       } else {
1189         $return{'mimeparts'} = [ $alternative, $image, @otherparts ];
1190       }
1191       $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
1192       #$return{'disposition'} = 'inline';
1193
1194     }
1195
1196   } else {
1197
1198     if ( $conf->exists('invoice_email_pdf') ) {
1199       warn "$me creating PDF attachment"
1200         if $DEBUG;
1201
1202       #mime parts arguments a la MIME::Entity->build().
1203       $return{'mimeparts'} = [
1204         { $self->mimebuild_pdf(\%opt) }
1205       ];
1206     }
1207
1208     if ( $conf->exists('invoice_email_pdf')
1209          and scalar($conf->config('invoice_email_pdf_note')) ) {
1210
1211       warn "$me using 'invoice_email_pdf_note'"
1212         if $DEBUG;
1213       $return{'body'} = [ map { $_ . "\n" }
1214                               $conf->config('invoice_email_pdf_note')
1215                         ];
1216
1217     } else {
1218
1219       warn "$me not using 'invoice_email_pdf_note'"
1220         if $DEBUG;
1221       if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1222         $return{'body'} = $args{'print_text'};
1223       } else {
1224         $return{'body'} = [ $self->print_text(\%opt) ];
1225       }
1226
1227     }
1228
1229   }
1230
1231   %return;
1232
1233 }
1234
1235 =item mimebuild_pdf
1236
1237 Returns a list suitable for passing to MIME::Entity->build(), representing
1238 this invoice as PDF attachment.
1239
1240 =cut
1241
1242 sub mimebuild_pdf {
1243   my $self = shift;
1244   (
1245     'Type'        => 'application/pdf',
1246     'Encoding'    => 'base64',
1247     'Data'        => [ $self->print_pdf(@_) ],
1248     'Disposition' => 'attachment',
1249     'Filename'    => 'invoice-'. $self->invnum. '.pdf',
1250   );
1251 }
1252
1253 =item send HASHREF | [ TEMPLATE [ , AGENTNUM [ , INVOICE_FROM [ , AMOUNT ] ] ] ]
1254
1255 Sends this invoice to the destinations configured for this customer: sends
1256 email, prints and/or faxes.  See L<FS::cust_main_invoice>.
1257
1258 Options can be passed as a hashref (recommended) or as a list of up to
1259 four values for templatename, agentnum, invoice_from and amount.
1260
1261 I<template>, if specified, is the name of a suffix for alternate invoices.
1262
1263 I<agentnum>, if specified, means that this invoice will only be sent for customers
1264 of the specified agent or agent(s).  AGENTNUM can be a scalar agentnum (for a
1265 single agent) or an arrayref of agentnums.
1266
1267 I<invoice_from>, if specified, overrides the default email invoice From: address.
1268
1269 I<amount>, if specified, only sends the invoice if the total amount owed on this
1270 invoice and all older invoices is greater than the specified amount.
1271
1272 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1273
1274 =cut
1275
1276 sub queueable_send {
1277   my %opt = @_;
1278
1279   my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1280     or die "invalid invoice number: " . $opt{invnum};
1281
1282   my @args = ( $opt{template}, $opt{agentnum} );
1283   push @args, $opt{invoice_from}
1284     if exists($opt{invoice_from}) && $opt{invoice_from};
1285
1286   my $error = $self->send( @args );
1287   die $error if $error;
1288
1289 }
1290
1291 sub send {
1292   my $self = shift;
1293   my $conf = $self->conf;
1294
1295   my( $template, $invoice_from, $notice_name );
1296   my $agentnums = '';
1297   my $balance_over = 0;
1298
1299   if ( ref($_[0]) ) {
1300     my $opt = shift;
1301     $template = $opt->{'template'} || '';
1302     if ( $agentnums = $opt->{'agentnum'} ) {
1303       $agentnums = [ $agentnums ] unless ref($agentnums);
1304     }
1305     $invoice_from = $opt->{'invoice_from'};
1306     $balance_over = $opt->{'balance_over'} if $opt->{'balance_over'};
1307     $notice_name = $opt->{'notice_name'};
1308   } else {
1309     $template = scalar(@_) ? shift : '';
1310     if ( scalar(@_) && $_[0]  ) {
1311       $agentnums = ref($_[0]) ? shift : [ shift ];
1312     }
1313     $invoice_from = shift if scalar(@_);
1314     $balance_over = shift if scalar(@_) && $_[0] !~ /^\s*$/;
1315   }
1316
1317   my $cust_main = $self->cust_main;
1318
1319   return 'N/A' unless ! $agentnums
1320                    or grep { $_ == $cust_main->agentnum } @$agentnums;
1321
1322   return ''
1323     unless $cust_main->total_owed_date($self->_date) > $balance_over;
1324
1325   $invoice_from ||= $self->_agent_invoice_from ||    #XXX should go away
1326                     $conf->config('invoice_from', $cust_main->agentnum );
1327
1328   my %opt = (
1329     'template'     => $template,
1330     'invoice_from' => $invoice_from,
1331     'notice_name'  => ( $notice_name || 'Invoice' ),
1332   );
1333
1334   my @invoicing_list = $cust_main->invoicing_list;
1335
1336   #$self->email_invoice(\%opt)
1337   $self->email(\%opt)
1338     if ( grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list )
1339     && ! $self->invoice_noemail;
1340
1341   #$self->print_invoice(\%opt)
1342   $self->print(\%opt)
1343     if grep { $_ eq 'POST' } @invoicing_list; #postal
1344
1345   $self->fax_invoice(\%opt)
1346     if grep { $_ eq 'FAX' } @invoicing_list; #fax
1347
1348   '';
1349
1350 }
1351
1352 =item email HASHREF | [ TEMPLATE [ , INVOICE_FROM ] ]
1353
1354 Emails this invoice.
1355
1356 Options can be passed as a hashref (recommended) or as a list of up to
1357 two values for templatename and invoice_from.
1358
1359 I<template>, if specified, is the name of a suffix for alternate invoices.
1360
1361 I<invoice_from>, if specified, overrides the default email invoice From: address.
1362
1363 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1364
1365 =cut
1366
1367 sub queueable_email {
1368   my %opt = @_;
1369
1370   my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1371     or die "invalid invoice number: " . $opt{invnum};
1372
1373   my %args = ( 'template' => $opt{template} );
1374   $args{$_} = $opt{$_}
1375     foreach grep { exists($opt{$_}) && $opt{$_} }
1376               qw( invoice_from notice_name no_coupon );
1377
1378   my $error = $self->email( \%args );
1379   die $error if $error;
1380
1381 }
1382
1383 #sub email_invoice {
1384 sub email {
1385   my $self = shift;
1386   return if $self->hide;
1387   my $conf = $self->conf;
1388
1389   my( $template, $invoice_from, $notice_name, $no_coupon );
1390   if ( ref($_[0]) ) {
1391     my $opt = shift;
1392     $template = $opt->{'template'} || '';
1393     $invoice_from = $opt->{'invoice_from'};
1394     $notice_name = $opt->{'notice_name'} || 'Invoice';
1395     $no_coupon = $opt->{'no_coupon'} || 0;
1396   } else {
1397     $template = scalar(@_) ? shift : '';
1398     $invoice_from = shift if scalar(@_);
1399     $notice_name = 'Invoice';
1400     $no_coupon = 0;
1401   }
1402
1403   $invoice_from ||= $self->_agent_invoice_from ||    #XXX should go away
1404                     $conf->config('invoice_from', $self->cust_main->agentnum );
1405
1406   my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ }
1407                             $self->cust_main->invoicing_list;
1408
1409   if ( ! @invoicing_list ) { #no recipients
1410     if ( $conf->exists('cust_bill-no_recipients-error') ) {
1411       die 'No recipients for customer #'. $self->custnum;
1412     } else {
1413       #default: better to notify this person than silence
1414       @invoicing_list = ($invoice_from);
1415     }
1416   }
1417
1418   my $subject = $self->email_subject($template);
1419
1420   my $error = send_email(
1421     $self->generate_email(
1422       'from'        => $invoice_from,
1423       'to'          => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
1424       'subject'     => $subject,
1425       'template'    => $template,
1426       'notice_name' => $notice_name,
1427       'no_coupon'   => $no_coupon,
1428     )
1429   );
1430   die "can't email invoice: $error\n" if $error;
1431   #die "$error\n" if $error;
1432
1433 }
1434
1435 sub email_subject {
1436   my $self = shift;
1437   my $conf = $self->conf;
1438
1439   #my $template = scalar(@_) ? shift : '';
1440   #per-template?
1441
1442   my $subject = $conf->config('invoice_subject', $self->cust_main->agentnum)
1443                 || 'Invoice';
1444
1445   my $cust_main = $self->cust_main;
1446   my $name = $cust_main->name;
1447   my $name_short = $cust_main->name_short;
1448   my $invoice_number = $self->invnum;
1449   my $invoice_date = $self->_date_pretty;
1450
1451   eval qq("$subject");
1452 }
1453
1454 =item lpr_data HASHREF | [ TEMPLATE ]
1455
1456 Returns the postscript or plaintext for this invoice as an arrayref.
1457
1458 Options can be passed as a hashref (recommended) or as a single optional value
1459 for template.
1460
1461 I<template>, if specified, is the name of a suffix for alternate invoices.
1462
1463 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1464
1465 =cut
1466
1467 sub lpr_data {
1468   my $self = shift;
1469   my $conf = $self->conf;
1470   my( $template, $notice_name );
1471   if ( ref($_[0]) ) {
1472     my $opt = shift;
1473     $template = $opt->{'template'} || '';
1474     $notice_name = $opt->{'notice_name'} || 'Invoice';
1475   } else {
1476     $template = scalar(@_) ? shift : '';
1477     $notice_name = 'Invoice';
1478   }
1479
1480   my %opt = (
1481     'template'    => $template,
1482     'notice_name' => $notice_name,
1483   );
1484
1485   my $method = $conf->exists('invoice_latex') ? 'print_ps' : 'print_text';
1486   [ $self->$method( \%opt ) ];
1487 }
1488
1489 =item print HASHREF | [ TEMPLATE ]
1490
1491 Prints this invoice.
1492
1493 Options can be passed as a hashref (recommended) or as a single optional
1494 value for template.
1495
1496 I<template>, if specified, is the name of a suffix for alternate invoices.
1497
1498 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1499
1500 =cut
1501
1502 #sub print_invoice {
1503 sub print {
1504   my $self = shift;
1505   return if $self->hide;
1506   my $conf = $self->conf;
1507
1508   my( $template, $notice_name );
1509   if ( ref($_[0]) ) {
1510     my $opt = shift;
1511     $template = $opt->{'template'} || '';
1512     $notice_name = $opt->{'notice_name'} || 'Invoice';
1513   } else {
1514     $template = scalar(@_) ? shift : '';
1515     $notice_name = 'Invoice';
1516   }
1517
1518   my %opt = (
1519     'template'    => $template,
1520     'notice_name' => $notice_name,
1521   );
1522
1523   if($conf->exists('invoice_print_pdf')) {
1524     # Add the invoice to the current batch.
1525     $self->batch_invoice(\%opt);
1526   }
1527   else {
1528     do_print $self->lpr_data(\%opt);
1529   }
1530 }
1531
1532 =item fax_invoice HASHREF | [ TEMPLATE ]
1533
1534 Faxes this invoice.
1535
1536 Options can be passed as a hashref (recommended) or as a single optional
1537 value for template.
1538
1539 I<template>, if specified, is the name of a suffix for alternate invoices.
1540
1541 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1542
1543 =cut
1544
1545 sub fax_invoice {
1546   my $self = shift;
1547   return if $self->hide;
1548   my $conf = $self->conf;
1549
1550   my( $template, $notice_name );
1551   if ( ref($_[0]) ) {
1552     my $opt = shift;
1553     $template = $opt->{'template'} || '';
1554     $notice_name = $opt->{'notice_name'} || 'Invoice';
1555   } else {
1556     $template = scalar(@_) ? shift : '';
1557     $notice_name = 'Invoice';
1558   }
1559
1560   die 'FAX invoice destination not (yet?) supported with plain text invoices.'
1561     unless $conf->exists('invoice_latex');
1562
1563   my $dialstring = $self->cust_main->getfield('fax');
1564   #Check $dialstring?
1565
1566   my %opt = (
1567     'template'    => $template,
1568     'notice_name' => $notice_name,
1569   );
1570
1571   my $error = send_fax( 'docdata'    => $self->lpr_data(\%opt),
1572                         'dialstring' => $dialstring,
1573                       );
1574   die $error if $error;
1575
1576 }
1577
1578 =item batch_invoice [ HASHREF ]
1579
1580 Place this invoice into the open batch (see C<FS::bill_batch>).  If there
1581 isn't an open batch, one will be created.
1582
1583 =cut
1584
1585 sub batch_invoice {
1586   my ($self, $opt) = @_;
1587   my $bill_batch = $self->get_open_bill_batch;
1588   my $cust_bill_batch = FS::cust_bill_batch->new({
1589       batchnum => $bill_batch->batchnum,
1590       invnum   => $self->invnum,
1591   });
1592   return $cust_bill_batch->insert($opt);
1593 }
1594
1595 =item get_open_batch
1596
1597 Returns the currently open batch as an FS::bill_batch object, creating a new
1598 one if necessary.  (A per-agent batch if invoice_print_pdf-spoolagent is
1599 enabled)
1600
1601 =cut
1602
1603 sub get_open_bill_batch {
1604   my $self = shift;
1605   my $conf = $self->conf;
1606   my $hashref = { status => 'O' };
1607   $hashref->{'agentnum'} = $conf->exists('invoice_print_pdf-spoolagent')
1608                              ? $self->cust_main->agentnum
1609                              : '';
1610   my $batch = qsearchs('bill_batch', $hashref);
1611   return $batch if $batch;
1612   $batch = FS::bill_batch->new($hashref);
1613   my $error = $batch->insert;
1614   die $error if $error;
1615   return $batch;
1616 }
1617
1618 =item ftp_invoice [ TEMPLATENAME ]
1619
1620 Sends this invoice data via FTP.
1621
1622 TEMPLATENAME is unused?
1623
1624 =cut
1625
1626 sub ftp_invoice {
1627   my $self = shift;
1628   my $conf = $self->conf;
1629   my $template = scalar(@_) ? shift : '';
1630
1631   $self->send_csv(
1632     'protocol'   => 'ftp',
1633     'server'     => $conf->config('cust_bill-ftpserver'),
1634     'username'   => $conf->config('cust_bill-ftpusername'),
1635     'password'   => $conf->config('cust_bill-ftppassword'),
1636     'dir'        => $conf->config('cust_bill-ftpdir'),
1637     'format'     => $conf->config('cust_bill-ftpformat'),
1638   );
1639 }
1640
1641 =item spool_invoice [ TEMPLATENAME ]
1642
1643 Spools this invoice data (see L<FS::spool_csv>)
1644
1645 TEMPLATENAME is unused?
1646
1647 =cut
1648
1649 sub spool_invoice {
1650   my $self = shift;
1651   my $conf = $self->conf;
1652   my $template = scalar(@_) ? shift : '';
1653
1654   $self->spool_csv(
1655     'format'       => $conf->config('cust_bill-spoolformat'),
1656     'agent_spools' => $conf->exists('cust_bill-spoolagent'),
1657   );
1658 }
1659
1660 =item send_if_newest [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
1661
1662 Like B<send>, but only sends the invoice if it is the newest open invoice for
1663 this customer.
1664
1665 =cut
1666
1667 sub send_if_newest {
1668   my $self = shift;
1669
1670   return ''
1671     if scalar(
1672                grep { $_->owed > 0 }
1673                     qsearch('cust_bill', {
1674                       'custnum' => $self->custnum,
1675                       #'_date'   => { op=>'>', value=>$self->_date },
1676                       'invnum'  => { op=>'>', value=>$self->invnum },
1677                     } )
1678              );
1679
1680   $self->send(@_);
1681 }
1682
1683 =item send_csv OPTION => VALUE, ...
1684
1685 Sends invoice as a CSV data-file to a remote host with the specified protocol.
1686
1687 Options are:
1688
1689 protocol - currently only "ftp"
1690 server
1691 username
1692 password
1693 dir
1694
1695 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
1696 and YYMMDDHHMMSS is a timestamp.
1697
1698 See L</print_csv> for a description of the output format.
1699
1700 =cut
1701
1702 sub send_csv {
1703   my($self, %opt) = @_;
1704
1705   #create file(s)
1706
1707   my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1708   mkdir $spooldir, 0700 unless -d $spooldir;
1709
1710   my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1711   my $file = "$spooldir/$tracctnum.csv";
1712
1713   my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1714
1715   open(CSV, ">$file") or die "can't open $file: $!";
1716   print CSV $header;
1717
1718   print CSV $detail;
1719
1720   close CSV;
1721
1722   my $net;
1723   if ( $opt{protocol} eq 'ftp' ) {
1724     eval "use Net::FTP;";
1725     die $@ if $@;
1726     $net = Net::FTP->new($opt{server}) or die @$;
1727   } else {
1728     die "unknown protocol: $opt{protocol}";
1729   }
1730
1731   $net->login( $opt{username}, $opt{password} )
1732     or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1733
1734   $net->binary or die "can't set binary mode";
1735
1736   $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1737
1738   $net->put($file) or die "can't put $file: $!";
1739
1740   $net->quit;
1741
1742   unlink $file;
1743
1744 }
1745
1746 =item spool_csv
1747
1748 Spools CSV invoice data.
1749
1750 Options are:
1751
1752 =over 4
1753
1754 =item format - 'default' or 'billco'
1755
1756 =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>).
1757
1758 =item agent_spools - if set to a true value, will spool to per-agent files rather than a single global file
1759
1760 =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.
1761
1762 =back
1763
1764 =cut
1765
1766 sub spool_csv {
1767   my($self, %opt) = @_;
1768
1769   my $cust_main = $self->cust_main;
1770
1771   if ( $opt{'dest'} ) {
1772     my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1773                              $cust_main->invoicing_list;
1774     return 'N/A' unless $invoicing_list{$opt{'dest'}}
1775                      || ! keys %invoicing_list;
1776   }
1777
1778   if ( $opt{'balanceover'} ) {
1779     return 'N/A'
1780       if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1781   }
1782
1783   my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1784   mkdir $spooldir, 0700 unless -d $spooldir;
1785
1786   my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1787
1788   my $file =
1789     "$spooldir/".
1790     ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1791     ( lc($opt{'format'}) eq 'billco' ? '-header' : '' ) .
1792     '.csv';
1793
1794   my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1795
1796   open(CSV, ">>$file") or die "can't open $file: $!";
1797   flock(CSV, LOCK_EX);
1798   seek(CSV, 0, 2);
1799
1800   print CSV $header;
1801
1802   if ( lc($opt{'format'}) eq 'billco' ) {
1803
1804     flock(CSV, LOCK_UN);
1805     close CSV;
1806
1807     $file =
1808       "$spooldir/".
1809       ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1810       '-detail.csv';
1811
1812     open(CSV,">>$file") or die "can't open $file: $!";
1813     flock(CSV, LOCK_EX);
1814     seek(CSV, 0, 2);
1815   }
1816
1817   print CSV $detail;
1818
1819   flock(CSV, LOCK_UN);
1820   close CSV;
1821
1822   return '';
1823
1824 }
1825
1826 =item print_csv OPTION => VALUE, ...
1827
1828 Returns CSV data for this invoice.
1829
1830 Options are:
1831
1832 format - 'default' or 'billco'
1833
1834 Returns a list consisting of two scalars.  The first is a single line of CSV
1835 header information for this invoice.  The second is one or more lines of CSV
1836 detail information for this invoice.
1837
1838 If I<format> is not specified or "default", the fields of the CSV file are as
1839 follows:
1840
1841 record_type, invnum, custnum, _date, charged, first, last, company, address1, address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1842
1843 =over 4
1844
1845 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1846
1847 B<record_type> is C<cust_bill> for the initial header line only.  The
1848 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1849 fields are filled in.
1850
1851 B<record_type> is C<cust_bill_pkg> for detail lines.  Only the first two fields
1852 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1853 are filled in.
1854
1855 =item invnum - invoice number
1856
1857 =item custnum - customer number
1858
1859 =item _date - invoice date
1860
1861 =item charged - total invoice amount
1862
1863 =item first - customer first name
1864
1865 =item last - customer first name
1866
1867 =item company - company name
1868
1869 =item address1 - address line 1
1870
1871 =item address2 - address line 1
1872
1873 =item city
1874
1875 =item state
1876
1877 =item zip
1878
1879 =item country
1880
1881 =item pkg - line item description
1882
1883 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1884
1885 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1886
1887 =item sdate - start date for recurring fee
1888
1889 =item edate - end date for recurring fee
1890
1891 =back
1892
1893 If I<format> is "billco", the fields of the header CSV file are as follows:
1894
1895   +-------------------------------------------------------------------+
1896   |                        FORMAT HEADER FILE                         |
1897   |-------------------------------------------------------------------|
1898   | Field | Description                   | Name       | Type | Width |
1899   | 1     | N/A-Leave Empty               | RC         | CHAR |     2 |
1900   | 2     | N/A-Leave Empty               | CUSTID     | CHAR |    15 |
1901   | 3     | Transaction Account No        | TRACCTNUM  | CHAR |    15 |
1902   | 4     | Transaction Invoice No        | TRINVOICE  | CHAR |    15 |
1903   | 5     | Transaction Zip Code          | TRZIP      | CHAR |     5 |
1904   | 6     | Transaction Company Bill To   | TRCOMPANY  | CHAR |    30 |
1905   | 7     | Transaction Contact Bill To   | TRNAME     | CHAR |    30 |
1906   | 8     | Additional Address Unit Info  | TRADDR1    | CHAR |    30 |
1907   | 9     | Bill To Street Address        | TRADDR2    | CHAR |    30 |
1908   | 10    | Ancillary Billing Information | TRADDR3    | CHAR |    30 |
1909   | 11    | Transaction City Bill To      | TRCITY     | CHAR |    20 |
1910   | 12    | Transaction State Bill To     | TRSTATE    | CHAR |     2 |
1911   | 13    | Bill Cycle Close Date         | CLOSEDATE  | CHAR |    10 |
1912   | 14    | Bill Due Date                 | DUEDATE    | CHAR |    10 |
1913   | 15    | Previous Balance              | BALFWD     | NUM* |     9 |
1914   | 16    | Pmt/CR Applied                | CREDAPPLY  | NUM* |     9 |
1915   | 17    | Total Current Charges         | CURRENTCHG | NUM* |     9 |
1916   | 18    | Total Amt Due                 | TOTALDUE   | NUM* |     9 |
1917   | 19    | Total Amt Due                 | AMTDUE     | NUM* |     9 |
1918   | 20    | 30 Day Aging                  | AMT30      | NUM* |     9 |
1919   | 21    | 60 Day Aging                  | AMT60      | NUM* |     9 |
1920   | 22    | 90 Day Aging                  | AMT90      | NUM* |     9 |
1921   | 23    | Y/N                           | AGESWITCH  | CHAR |     1 |
1922   | 24    | Remittance automation         | SCANLINE   | CHAR |   100 |
1923   | 25    | Total Taxes & Fees            | TAXTOT     | NUM* |     9 |
1924   | 26    | Customer Reference Number     | CUSTREF    | CHAR |    15 |
1925   | 27    | Federal Tax***                | FEDTAX     | NUM* |     9 |
1926   | 28    | State Tax***                  | STATETAX   | NUM* |     9 |
1927   | 29    | Other Taxes & Fees***         | OTHERTAX   | NUM* |     9 |
1928   +-------+-------------------------------+------------+------+-------+
1929
1930 If I<format> is "billco", the fields of the detail CSV file are as follows:
1931
1932                                   FORMAT FOR DETAIL FILE
1933         |                            |           |      |
1934   Field | Description                | Name      | Type | Width
1935   1     | N/A-Leave Empty            | RC        | CHAR |     2
1936   2     | N/A-Leave Empty            | CUSTID    | CHAR |    15
1937   3     | Account Number             | TRACCTNUM | CHAR |    15
1938   4     | Invoice Number             | TRINVOICE | CHAR |    15
1939   5     | Line Sequence (sort order) | LINESEQ   | NUM  |     6
1940   6     | Transaction Detail         | DETAILS   | CHAR |   100
1941   7     | Amount                     | AMT       | NUM* |     9
1942   8     | Line Format Control**      | LNCTRL    | CHAR |     2
1943   9     | Grouping Code              | GROUP     | CHAR |     2
1944   10    | User Defined               | ACCT CODE | CHAR |    15
1945
1946 =cut
1947
1948 sub print_csv {
1949   my($self, %opt) = @_;
1950
1951   eval "use Text::CSV_XS";
1952   die $@ if $@;
1953
1954   my $cust_main = $self->cust_main;
1955
1956   my $csv = Text::CSV_XS->new({'always_quote'=>1});
1957
1958   if ( lc($opt{'format'}) eq 'billco' ) {
1959
1960     my $taxtotal = 0;
1961     $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1962
1963     my $duedate = $self->due_date2str('%m/%d/%Y'); #date_format?
1964
1965     my( $previous_balance, @unused ) = $self->previous; #previous balance
1966
1967     my $pmt_cr_applied = 0;
1968     $pmt_cr_applied += $_->{'amount'}
1969       foreach ( $self->_items_payments, $self->_items_credits ) ;
1970
1971     my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1972
1973     $csv->combine(
1974       '',                         #  1 | N/A-Leave Empty               CHAR   2
1975       '',                         #  2 | N/A-Leave Empty               CHAR  15
1976       $opt{'tracctnum'},          #  3 | Transaction Account No        CHAR  15
1977       $self->invnum,              #  4 | Transaction Invoice No        CHAR  15
1978       $cust_main->zip,            #  5 | Transaction Zip Code          CHAR   5
1979       $cust_main->company,        #  6 | Transaction Company Bill To   CHAR  30
1980       #$cust_main->payname,        #  7 | Transaction Contact Bill To   CHAR  30
1981       $cust_main->contact,        #  7 | Transaction Contact Bill To   CHAR  30
1982       $cust_main->address2,       #  8 | Additional Address Unit Info  CHAR  30
1983       $cust_main->address1,       #  9 | Bill To Street Address        CHAR  30
1984       '',                         # 10 | Ancillary Billing Information CHAR  30
1985       $cust_main->city,           # 11 | Transaction City Bill To      CHAR  20
1986       $cust_main->state,          # 12 | Transaction State Bill To     CHAR   2
1987
1988       # XXX ?
1989       time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR  10
1990
1991       # XXX ?
1992       $duedate,                   # 14 | Bill Due Date                 CHAR  10
1993
1994       $previous_balance,          # 15 | Previous Balance              NUM*   9
1995       $pmt_cr_applied,            # 16 | Pmt/CR Applied                NUM*   9
1996       sprintf("%.2f", $self->charged), # 17 | Total Current Charges    NUM*   9
1997       $totaldue,                  # 18 | Total Amt Due                 NUM*   9
1998       $totaldue,                  # 19 | Total Amt Due                 NUM*   9
1999       '',                         # 20 | 30 Day Aging                  NUM*   9
2000       '',                         # 21 | 60 Day Aging                  NUM*   9
2001       '',                         # 22 | 90 Day Aging                  NUM*   9
2002       'N',                        # 23 | Y/N                           CHAR   1
2003       '',                         # 24 | Remittance automation         CHAR 100
2004       $taxtotal,                  # 25 | Total Taxes & Fees            NUM*   9
2005       $self->custnum,             # 26 | Customer Reference Number     CHAR  15
2006       '0',                        # 27 | Federal Tax***                NUM*   9
2007       sprintf("%.2f", $taxtotal), # 28 | State Tax***                  NUM*   9
2008       '0',                        # 29 | Other Taxes & Fees***         NUM*   9
2009     );
2010
2011   } elsif ( lc($opt{'format'}) eq 'oneline' ) { #name?
2012
2013     my ($previous_balance) = $self->previous;
2014     my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
2015     my @items = map {
2016       ($_->{pkgnum} || ''),
2017       $_->{description},
2018       $_->{amount}
2019     } $self->_items_pkg;
2020
2021     $csv->combine(
2022       $cust_main->agentnum,
2023       $cust_main->agent->agent,
2024       $self->custnum,
2025       $cust_main->first,
2026       $cust_main->last,
2027       $cust_main->address1,
2028       $cust_main->address2,
2029       $cust_main->city,
2030       $cust_main->state,
2031       $cust_main->zip,
2032
2033       # invoice fields
2034       time2str("%x", $self->_date),
2035       $self->invnum,
2036       $self->charged,
2037       $totaldue,
2038
2039       @items,
2040     );
2041
2042   } else {
2043
2044     $csv->combine(
2045       'cust_bill',
2046       $self->invnum,
2047       $self->custnum,
2048       time2str("%x", $self->_date),
2049       sprintf("%.2f", $self->charged),
2050       ( map { $cust_main->getfield($_) }
2051           qw( first last company address1 address2 city state zip country ) ),
2052       map { '' } (1..5),
2053     ) or die "can't create csv";
2054   }
2055
2056   my $header = $csv->string. "\n";
2057
2058   my $detail = '';
2059   if ( lc($opt{'format'}) eq 'billco' ) {
2060
2061     my $lineseq = 0;
2062     foreach my $item ( $self->_items_pkg ) {
2063
2064       $csv->combine(
2065         '',                     #  1 | N/A-Leave Empty            CHAR   2
2066         '',                     #  2 | N/A-Leave Empty            CHAR  15
2067         $opt{'tracctnum'},      #  3 | Account Number             CHAR  15
2068         $self->invnum,          #  4 | Invoice Number             CHAR  15
2069         $lineseq++,             #  5 | Line Sequence (sort order) NUM    6
2070         $item->{'description'}, #  6 | Transaction Detail         CHAR 100
2071         $item->{'amount'},      #  7 | Amount                     NUM*   9
2072         '',                     #  8 | Line Format Control**      CHAR   2
2073         '',                     #  9 | Grouping Code              CHAR   2
2074         '',                     # 10 | User Defined               CHAR  15
2075       );
2076
2077       $detail .= $csv->string. "\n";
2078
2079     }
2080
2081   } elsif ( lc($opt{'format'}) eq 'oneline' ) {
2082
2083     #do nothing
2084
2085   } else {
2086
2087     foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2088
2089       my($pkg, $setup, $recur, $sdate, $edate);
2090       if ( $cust_bill_pkg->pkgnum ) {
2091
2092         ($pkg, $setup, $recur, $sdate, $edate) = (
2093           $cust_bill_pkg->part_pkg->pkg,
2094           ( $cust_bill_pkg->setup != 0
2095             ? sprintf("%.2f", $cust_bill_pkg->setup )
2096             : '' ),
2097           ( $cust_bill_pkg->recur != 0
2098             ? sprintf("%.2f", $cust_bill_pkg->recur )
2099             : '' ),
2100           ( $cust_bill_pkg->sdate
2101             ? time2str("%x", $cust_bill_pkg->sdate)
2102             : '' ),
2103           ($cust_bill_pkg->edate
2104             ?time2str("%x", $cust_bill_pkg->edate)
2105             : '' ),
2106         );
2107
2108       } else { #pkgnum tax
2109         next unless $cust_bill_pkg->setup != 0;
2110         $pkg = $cust_bill_pkg->desc;
2111         $setup = sprintf('%10.2f', $cust_bill_pkg->setup );
2112         ( $sdate, $edate ) = ( '', '' );
2113       }
2114
2115       $csv->combine(
2116         'cust_bill_pkg',
2117         $self->invnum,
2118         ( map { '' } (1..11) ),
2119         ($pkg, $setup, $recur, $sdate, $edate)
2120       ) or die "can't create csv";
2121
2122       $detail .= $csv->string. "\n";
2123
2124     }
2125
2126   }
2127
2128   ( $header, $detail );
2129
2130 }
2131
2132 =item comp
2133
2134 Pays this invoice with a compliemntary payment.  If there is an error,
2135 returns the error, otherwise returns false.
2136
2137 =cut
2138
2139 sub comp {
2140   my $self = shift;
2141   my $cust_pay = new FS::cust_pay ( {
2142     'invnum'   => $self->invnum,
2143     'paid'     => $self->owed,
2144     '_date'    => '',
2145     'payby'    => 'COMP',
2146     'payinfo'  => $self->cust_main->payinfo,
2147     'paybatch' => '',
2148   } );
2149   $cust_pay->insert;
2150 }
2151
2152 =item realtime_card
2153
2154 Attempts to pay this invoice with a credit card payment via a
2155 Business::OnlinePayment realtime gateway.  See
2156 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2157 for supported processors.
2158
2159 =cut
2160
2161 sub realtime_card {
2162   my $self = shift;
2163   $self->realtime_bop( 'CC', @_ );
2164 }
2165
2166 =item realtime_ach
2167
2168 Attempts to pay this invoice with an electronic check (ACH) payment via a
2169 Business::OnlinePayment realtime gateway.  See
2170 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2171 for supported processors.
2172
2173 =cut
2174
2175 sub realtime_ach {
2176   my $self = shift;
2177   $self->realtime_bop( 'ECHECK', @_ );
2178 }
2179
2180 =item realtime_lec
2181
2182 Attempts to pay this invoice with phone bill (LEC) payment via a
2183 Business::OnlinePayment realtime gateway.  See
2184 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
2185 for supported processors.
2186
2187 =cut
2188
2189 sub realtime_lec {
2190   my $self = shift;
2191   $self->realtime_bop( 'LEC', @_ );
2192 }
2193
2194 sub realtime_bop {
2195   my( $self, $method ) = (shift,shift);
2196   my $conf = $self->conf;
2197   my %opt = @_;
2198
2199   my $cust_main = $self->cust_main;
2200   my $balance = $cust_main->balance;
2201   my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
2202   $amount = sprintf("%.2f", $amount);
2203   return "not run (balance $balance)" unless $amount > 0;
2204
2205   my $description = 'Internet Services';
2206   if ( $conf->exists('business-onlinepayment-description') ) {
2207     my $dtempl = $conf->config('business-onlinepayment-description');
2208
2209     my $agent_obj = $cust_main->agent
2210       or die "can't retreive agent for $cust_main (agentnum ".
2211              $cust_main->agentnum. ")";
2212     my $agent = $agent_obj->agent;
2213     my $pkgs = join(', ',
2214       map { $_->part_pkg->pkg }
2215         grep { $_->pkgnum } $self->cust_bill_pkg
2216     );
2217     $description = eval qq("$dtempl");
2218   }
2219
2220   $cust_main->realtime_bop($method, $amount,
2221     'description' => $description,
2222     'invnum'      => $self->invnum,
2223 #this didn't do what we want, it just calls apply_payments_and_credits
2224 #    'apply'       => 1,
2225     'apply_to_invoice' => 1,
2226     %opt,
2227  #what we want:
2228  #this changes application behavior: auto payments
2229                         #triggered against a specific invoice are now applied
2230                         #to that invoice instead of oldest open.
2231                         #seem okay to me...
2232   );
2233
2234 }
2235
2236 =item batch_card OPTION => VALUE...
2237
2238 Adds a payment for this invoice to the pending credit card batch (see
2239 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2240 runs the payment using a realtime gateway.
2241
2242 =cut
2243
2244 sub batch_card {
2245   my ($self, %options) = @_;
2246   my $cust_main = $self->cust_main;
2247
2248   $options{invnum} = $self->invnum;
2249
2250   $cust_main->batch_card(%options);
2251 }
2252
2253 sub _agent_template {
2254   my $self = shift;
2255   $self->cust_main->agent_template;
2256 }
2257
2258 sub _agent_invoice_from {
2259   my $self = shift;
2260   $self->cust_main->agent_invoice_from;
2261 }
2262
2263 =item print_text HASHREF | [ TIME [ , TEMPLATE [ , OPTION => VALUE ... ] ] ]
2264
2265 Returns an text invoice, as a list of lines.
2266
2267 Options can be passed as a hashref (recommended) or as a list of time, template
2268 and then any key/value pairs for any other options.
2269
2270 I<time>, if specified, is used to control the printing of overdue messages.  The
2271 default is now.  It isn't the date of the invoice; that's the `_date' field.
2272 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
2273 L<Time::Local> and L<Date::Parse> for conversion functions.
2274
2275 I<template>, if specified, is the name of a suffix for alternate invoices.
2276
2277 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
2278
2279 =cut
2280
2281 sub print_text {
2282   my $self = shift;
2283   my( $today, $template, %opt );
2284   if ( ref($_[0]) ) {
2285     %opt = %{ shift() };
2286     $today = delete($opt{'time'}) || '';
2287     $template = delete($opt{template}) || '';
2288   } else {
2289     ( $today, $template, %opt ) = @_;
2290   }
2291
2292   my %params = ( 'format' => 'template' );
2293   $params{'time'} = $today if $today;
2294   $params{'template'} = $template if $template;
2295   $params{$_} = $opt{$_}
2296     foreach grep $opt{$_}, qw( unsquelch_cdr notice_name );
2297
2298   $self->print_generic( %params );
2299 }
2300
2301 =item print_latex HASHREF | [ TIME [ , TEMPLATE [ , OPTION => VALUE ... ] ] ]
2302
2303 Internal method - returns a filename of a filled-in LaTeX template for this
2304 invoice (Note: add ".tex" to get the actual filename), and a filename of
2305 an associated logo (with the .eps extension included).
2306
2307 See print_ps and print_pdf for methods that return PostScript and PDF output.
2308
2309 Options can be passed as a hashref (recommended) or as a list of time, template
2310 and then any key/value pairs for any other options.
2311
2312 I<time>, if specified, is used to control the printing of overdue messages.  The
2313 default is now.  It isn't the date of the invoice; that's the `_date' field.
2314 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
2315 L<Time::Local> and L<Date::Parse> for conversion functions.
2316
2317 I<template>, if specified, is the name of a suffix for alternate invoices.
2318
2319 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
2320
2321 =cut
2322
2323 sub print_latex {
2324   my $self = shift;
2325   my $conf = $self->conf;
2326   my( $today, $template, %opt );
2327   if ( ref($_[0]) ) {
2328     %opt = %{ shift() };
2329     $today = delete($opt{'time'}) || '';
2330     $template = delete($opt{template}) || '';
2331   } else {
2332     ( $today, $template, %opt ) = @_;
2333   }
2334
2335   my %params = ( 'format' => 'latex' );
2336   $params{'time'} = $today if $today;
2337   $params{'template'} = $template if $template;
2338   $params{$_} = $opt{$_}
2339     foreach grep $opt{$_}, qw( unsquelch_cdr notice_name );
2340
2341   $template ||= $self->_agent_template;
2342
2343   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2344   my $lh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
2345                            DIR      => $dir,
2346                            SUFFIX   => '.eps',
2347                            UNLINK   => 0,
2348                          ) or die "can't open temp file: $!\n";
2349
2350   my $agentnum = $self->cust_main->agentnum;
2351
2352   if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
2353     print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
2354       or die "can't write temp file: $!\n";
2355   } else {
2356     print $lh $conf->config_binary('logo.eps', $agentnum)
2357       or die "can't write temp file: $!\n";
2358   }
2359   close $lh;
2360   $params{'logo_file'} = $lh->filename;
2361
2362   if($conf->exists('invoice-barcode')){
2363       my $png_file = $self->invoice_barcode($dir);
2364       my $eps_file = $png_file;
2365       $eps_file =~ s/\.png$/.eps/g;
2366       $png_file =~ /(barcode.*png)/;
2367       $png_file = $1;
2368       $eps_file =~ /(barcode.*eps)/;
2369       $eps_file = $1;
2370
2371       my $curr_dir = cwd();
2372       chdir($dir);
2373       # after painfuly long experimentation, it was determined that sam2p won't
2374       # accept : and other chars in the path, no matter how hard I tried to
2375       # escape them, hence the chdir (and chdir back, just to be safe)
2376       system('sam2p', '-j:quiet', $png_file, 'EPS:', $eps_file ) == 0
2377         or die "sam2p failed: $!\n";
2378       unlink($png_file);
2379       chdir($curr_dir);
2380
2381       $params{'barcode_file'} = $eps_file;
2382   }
2383
2384   my @filled_in = $self->print_generic( %params );
2385
2386   my $fh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
2387                            DIR      => $dir,
2388                            SUFFIX   => '.tex',
2389                            UNLINK   => 0,
2390                          ) or die "can't open temp file: $!\n";
2391   binmode($fh, ':utf8'); # language support
2392   print $fh join('', @filled_in );
2393   close $fh;
2394
2395   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
2396   return ($1, $params{'logo_file'}, $params{'barcode_file'});
2397
2398 }
2399
2400 =item invoice_barcode DIR_OR_FALSE
2401
2402 Generates an invoice barcode PNG. If DIR_OR_FALSE is a true value,
2403 it is taken as the temp directory where the PNG file will be generated and the
2404 PNG file name is returned. Otherwise, the PNG image itself is returned.
2405
2406 =cut
2407
2408 sub invoice_barcode {
2409     my ($self, $dir) = (shift,shift);
2410
2411     my $gdbar = new GD::Barcode('Code39',$self->invnum);
2412         die "can't create barcode: " . $GD::Barcode::errStr unless $gdbar;
2413     my $gd = $gdbar->plot(Height => 30);
2414
2415     if($dir) {
2416         my $bh = new File::Temp( TEMPLATE => 'barcode.'. $self->invnum. '.XXXXXXXX',
2417                            DIR      => $dir,
2418                            SUFFIX   => '.png',
2419                            UNLINK   => 0,
2420                          ) or die "can't open temp file: $!\n";
2421         print $bh $gd->png or die "cannot write barcode to file: $!\n";
2422         my $png_file = $bh->filename;
2423         close $bh;
2424         return $png_file;
2425     }
2426     return $gd->png;
2427 }
2428
2429 =item print_generic OPTION => VALUE ...
2430
2431 Internal method - returns a filled-in template for this invoice as a scalar.
2432
2433 See print_ps and print_pdf for methods that return PostScript and PDF output.
2434
2435 Non optional options include
2436   format - latex, html, template
2437
2438 Optional options include
2439
2440 template - a value used as a suffix for a configuration template
2441
2442 time - a value used to control the printing of overdue messages.  The
2443 default is now.  It isn't the date of the invoice; that's the `_date' field.
2444 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
2445 L<Time::Local> and L<Date::Parse> for conversion functions.
2446
2447 cid -
2448
2449 unsquelch_cdr - overrides any per customer cdr squelching when true
2450
2451 notice_name - overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
2452
2453 locale - override customer's locale
2454
2455 =cut
2456
2457 #what's with all the sprintf('%10.2f')'s in here?  will it cause any
2458 # (alignment in text invoice?) problems to change them all to '%.2f' ?
2459 # yes: fixed width/plain text printing will be borked
2460 sub print_generic {
2461   my( $self, %params ) = @_;
2462   my $conf = $self->conf;
2463   my $today = $params{today} ? $params{today} : time;
2464   warn "$me print_generic called on $self with suffix $params{template}\n"
2465     if $DEBUG;
2466
2467   my $format = $params{format};
2468   die "Unknown format: $format"
2469     unless $format =~ /^(latex|html|template)$/;
2470
2471   my $cust_main = $self->cust_main;
2472   $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
2473     unless $cust_main->payname
2474         && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/;
2475
2476   my %delimiters = ( 'latex'    => [ '[@--', '--@]' ],
2477                      'html'     => [ '<%=', '%>' ],
2478                      'template' => [ '{', '}' ],
2479                    );
2480
2481   warn "$me print_generic creating template\n"
2482     if $DEBUG > 1;
2483
2484   #create the template
2485   my $template = $params{template} ? $params{template} : $self->_agent_template;
2486   my $templatefile = "invoice_$format";
2487   $templatefile .= "_$template"
2488     if length($template) && $conf->exists($templatefile."_$template");
2489   my @invoice_template = map "$_\n", $conf->config($templatefile)
2490     or die "cannot load config data $templatefile";
2491
2492   my $old_latex = '';
2493   if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
2494     #change this to a die when the old code is removed
2495     warn "old-style invoice template $templatefile; ".
2496          "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
2497     $old_latex = 'true';
2498     @invoice_template = _translate_old_latex_format(@invoice_template);
2499   }
2500
2501   warn "$me print_generic creating T:T object\n"
2502     if $DEBUG > 1;
2503
2504   my $text_template = new Text::Template(
2505     TYPE => 'ARRAY',
2506     SOURCE => \@invoice_template,
2507     DELIMITERS => $delimiters{$format},
2508   );
2509
2510   warn "$me print_generic compiling T:T object\n"
2511     if $DEBUG > 1;
2512
2513   $text_template->compile()
2514     or die "Can't compile $templatefile: $Text::Template::ERROR\n";
2515
2516
2517   # additional substitution could possibly cause breakage in existing templates
2518   my %convert_maps = (
2519     'latex' => {
2520                  'notes'         => sub { map "$_", @_ },
2521                  'footer'        => sub { map "$_", @_ },
2522                  'smallfooter'   => sub { map "$_", @_ },
2523                  'returnaddress' => sub { map "$_", @_ },
2524                  'coupon'        => sub { map "$_", @_ },
2525                  'summary'       => sub { map "$_", @_ },
2526                },
2527     'html'  => {
2528                  'notes' =>
2529                    sub {
2530                      map {
2531                        s/%%(.*)$/<!-- $1 -->/g;
2532                        s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
2533                        s/\\begin\{enumerate\}/<ol>/g;
2534                        s/\\item /  <li>/g;
2535                        s/\\end\{enumerate\}/<\/ol>/g;
2536                        s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
2537                        s/\\\\\*/<br>/g;
2538                        s/\\dollar ?/\$/g;
2539                        s/\\#/#/g;
2540                        s/~/&nbsp;/g;
2541                        $_;
2542                      }  @_
2543                    },
2544                  'footer' =>
2545                    sub { map { s/~/&nbsp;/g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
2546                  'smallfooter' =>
2547                    sub { map { s/~/&nbsp;/g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
2548                  'returnaddress' =>
2549                    sub {
2550                      map {
2551                        s/~/&nbsp;/g;
2552                        s/\\\\\*?\s*$/<BR>/;
2553                        s/\\hyphenation\{[\w\s\-]+}//;
2554                        s/\\([&])/$1/g;
2555                        $_;
2556                      }  @_
2557                    },
2558                  'coupon'        => sub { "" },
2559                  'summary'       => sub { "" },
2560                },
2561     'template' => {
2562                  'notes' =>
2563                    sub {
2564                      map {
2565                        s/%%.*$//g;
2566                        s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
2567                        s/\\begin\{enumerate\}//g;
2568                        s/\\item /  * /g;
2569                        s/\\end\{enumerate\}//g;
2570                        s/\\textbf\{(.*)\}/$1/g;
2571                        s/\\\\\*/ /;
2572                        s/\\dollar ?/\$/g;
2573                        $_;
2574                      }  @_
2575                    },
2576                  'footer' =>
2577                    sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
2578                  'smallfooter' =>
2579                    sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
2580                  'returnaddress' =>
2581                    sub {
2582                      map {
2583                        s/~/ /g;
2584                        s/\\\\\*?\s*$/\n/;             # dubious
2585                        s/\\hyphenation\{[\w\s\-]+}//;
2586                        $_;
2587                      }  @_
2588                    },
2589                  'coupon'        => sub { "" },
2590                  'summary'       => sub { "" },
2591                },
2592   );
2593
2594
2595   # hashes for differing output formats
2596   my %nbsps = ( 'latex'    => '~',
2597                 'html'     => '',    # '&nbps;' would be nice
2598                 'template' => '',    # not used
2599               );
2600   my $nbsp = $nbsps{$format};
2601
2602   my %escape_functions = ( 'latex'    => \&_latex_escape,
2603                            'html'     => \&_html_escape_nbsp,#\&encode_entities,
2604                            'template' => sub { shift },
2605                          );
2606   my $escape_function = $escape_functions{$format};
2607   my $escape_function_nonbsp = ($format eq 'html')
2608                                  ? \&_html_escape : $escape_function;
2609
2610   my %date_formats = ( 'latex'    => $date_format_long,
2611                        'html'     => $date_format_long,
2612                        'template' => '%s',
2613                      );
2614   $date_formats{'html'} =~ s/ /&nbsp;/g;
2615
2616   my $date_format = $date_formats{$format};
2617
2618   my %embolden_functions = ( 'latex'    => sub { return '\textbf{'. shift(). '}'
2619                                                },
2620                              'html'     => sub { return '<b>'. shift(). '</b>'
2621                                                },
2622                              'template' => sub { shift },
2623                            );
2624   my $embolden_function = $embolden_functions{$format};
2625
2626   my %newline_tokens = (  'latex'     => '\\\\',
2627                           'html'      => '<br>',
2628                           'template'  => "\n",
2629                         );
2630   my $newline_token = $newline_tokens{$format};
2631
2632   warn "$me generating template variables\n"
2633     if $DEBUG > 1;
2634
2635   # generate template variables
2636   my $returnaddress;
2637   if (
2638          defined( $conf->config_orbase( "invoice_${format}returnaddress",
2639                                         $template
2640                                       )
2641                 )
2642        && length( $conf->config_orbase( "invoice_${format}returnaddress",
2643                                         $template
2644                                       )
2645                 )
2646   ) {
2647
2648     $returnaddress = join("\n",
2649       $conf->config_orbase("invoice_${format}returnaddress", $template)
2650     );
2651
2652   } elsif ( grep /\S/,
2653             $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
2654
2655     my $convert_map = $convert_maps{$format}{'returnaddress'};
2656     $returnaddress =
2657       join( "\n",
2658             &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
2659                                                  $template
2660                                                )
2661                          )
2662           );
2663   } elsif ( grep /\S/, $conf->config('company_address', $self->cust_main->agentnum) ) {
2664
2665     my $convert_map = $convert_maps{$format}{'returnaddress'};
2666     $returnaddress = join( "\n", &$convert_map(
2667                                    map { s/( {2,})/'~' x length($1)/eg;
2668                                          s/$/\\\\\*/;
2669                                          $_
2670                                        }
2671                                      ( $conf->config('company_name', $self->cust_main->agentnum),
2672                                        $conf->config('company_address', $self->cust_main->agentnum),
2673                                      )
2674                                  )
2675                      );
2676
2677   } else {
2678
2679     my $warning = "Couldn't find a return address; ".
2680                   "do you need to set the company_address configuration value?";
2681     warn "$warning\n";
2682     $returnaddress = $nbsp;
2683     #$returnaddress = $warning;
2684
2685   }
2686
2687   warn "$me generating invoice data\n"
2688     if $DEBUG > 1;
2689
2690   my $agentnum = $self->cust_main->agentnum;
2691
2692   my %invoice_data = (
2693
2694     #invoice from info
2695     'company_name'    => scalar( $conf->config('company_name', $agentnum) ),
2696     'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
2697     'company_phonenum'=> scalar( $conf->config('company_phonenum', $agentnum) ),
2698     'returnaddress'   => $returnaddress,
2699     'agent'           => &$escape_function($cust_main->agent->agent),
2700
2701     #invoice info
2702     'invnum'          => $self->invnum,
2703     'date'            => time2str($date_format, $self->_date),
2704     'today'           => time2str($date_format_long, $today),
2705     'terms'           => $self->terms,
2706     'template'        => $template, #params{'template'},
2707     'notice_name'     => ($params{'notice_name'} || 'Invoice'),#escape_function?
2708     'current_charges' => sprintf("%.2f", $self->charged),
2709     'duedate'         => $self->due_date2str($rdate_format), #date_format?
2710
2711     #customer info
2712     'custnum'         => $cust_main->display_custnum,
2713     'agent_custid'    => &$escape_function($cust_main->agent_custid),
2714     ( map { $_ => &$escape_function($cust_main->$_()) } qw(
2715       payname company address1 address2 city state zip fax
2716     )),
2717
2718     #global config
2719     'ship_enable'     => $conf->exists('invoice-ship_address'),
2720     'unitprices'      => $conf->exists('invoice-unitprice'),
2721     'smallernotes'    => $conf->exists('invoice-smallernotes'),
2722     'smallerfooter'   => $conf->exists('invoice-smallerfooter'),
2723     'balance_due_below_line' => $conf->exists('balance_due_below_line'),
2724
2725     #layout info -- would be fancy to calc some of this and bury the template
2726     #               here in the code
2727     'topmargin'             => scalar($conf->config('invoice_latextopmargin', $agentnum)),
2728     'headsep'               => scalar($conf->config('invoice_latexheadsep', $agentnum)),
2729     'textheight'            => scalar($conf->config('invoice_latextextheight', $agentnum)),
2730     'extracouponspace'      => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
2731     'couponfootsep'         => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
2732     'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
2733     'addresssep'            => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
2734     'amountenclosedsep'     => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
2735     'coupontoaddresssep'    => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
2736     'addcompanytoaddress'   => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
2737
2738     # better hang on to conf_dir for a while (for old templates)
2739     'conf_dir'        => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
2740
2741     #these are only used when doing paged plaintext
2742     'page'            => 1,
2743     'total_pages'     => 1,
2744
2745   );
2746
2747   #localization
2748   my $lh = FS::L10N->get_handle( $params{'locale'} || $cust_main->locale );
2749   $invoice_data{'emt'} = sub { &$escape_function($self->mt(@_)) };
2750   my %info = FS::Locales->locale_info($cust_main->locale || 'en_US');
2751   # eval to avoid death for unimplemented languages
2752   my $dh = eval { Date::Language->new($info{'name'}) } ||
2753            Date::Language->new(); # fall back to English
2754   # prototype here to silence warnings
2755   $invoice_data{'time2str'} = sub ($;$$) { $dh->time2str(@_) };
2756   # eventually use this date handle everywhere in here, too
2757
2758   my $min_sdate = 999999999999;
2759   my $max_edate = 0;
2760   foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
2761     next unless $cust_bill_pkg->pkgnum > 0;
2762     $min_sdate = $cust_bill_pkg->sdate
2763       if length($cust_bill_pkg->sdate) && $cust_bill_pkg->sdate < $min_sdate;
2764     $max_edate = $cust_bill_pkg->edate
2765       if length($cust_bill_pkg->edate) && $cust_bill_pkg->edate > $max_edate;
2766   }
2767
2768   $invoice_data{'bill_period'} = '';
2769   $invoice_data{'bill_period'} = time2str('%e %h', $min_sdate)
2770     . " to " . time2str('%e %h', $max_edate)
2771     if ($max_edate != 0 && $min_sdate != 999999999999);
2772
2773   $invoice_data{finance_section} = '';
2774   if ( $conf->config('finance_pkgclass') ) {
2775     my $pkg_class =
2776       qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
2777     $invoice_data{finance_section} = $pkg_class->categoryname;
2778   }
2779   $invoice_data{finance_amount} = '0.00';
2780   $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
2781
2782   my $countrydefault = $conf->config('countrydefault') || 'US';
2783   foreach ( qw( address1 address2 city state zip country fax) ){
2784     my $method = 'ship_'.$_;
2785     $invoice_data{"ship_$_"} = _latex_escape($cust_main->$method);
2786   }
2787   foreach ( qw( contact company ) ) { #compatibility
2788     $invoice_data{"ship_$_"} = _latex_escape($cust_main->$_);
2789   }
2790   $invoice_data{'ship_country'} = ''
2791     if ( $invoice_data{'ship_country'} eq $countrydefault );
2792
2793   $invoice_data{'cid'} = $params{'cid'}
2794     if $params{'cid'};
2795
2796   if ( $cust_main->country eq $countrydefault ) {
2797     $invoice_data{'country'} = '';
2798   } else {
2799     $invoice_data{'country'} = &$escape_function(code2country($cust_main->country));
2800   }
2801
2802   my @address = ();
2803   $invoice_data{'address'} = \@address;
2804   push @address,
2805     $cust_main->payname.
2806       ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
2807         ? " (P.O. #". $cust_main->payinfo. ")"
2808         : ''
2809       )
2810   ;
2811   push @address, $cust_main->company
2812     if $cust_main->company;
2813   push @address, $cust_main->address1;
2814   push @address, $cust_main->address2
2815     if $cust_main->address2;
2816   push @address,
2817     $cust_main->city. ", ". $cust_main->state. "  ".  $cust_main->zip;
2818   push @address, $invoice_data{'country'}
2819     if $invoice_data{'country'};
2820   push @address, ''
2821     while (scalar(@address) < 5);
2822
2823   $invoice_data{'logo_file'} = $params{'logo_file'}
2824     if $params{'logo_file'};
2825   $invoice_data{'barcode_file'} = $params{'barcode_file'}
2826     if $params{'barcode_file'};
2827   $invoice_data{'barcode_img'} = $params{'barcode_img'}
2828     if $params{'barcode_img'};
2829   $invoice_data{'barcode_cid'} = $params{'barcode_cid'}
2830     if $params{'barcode_cid'};
2831
2832   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2833 #  my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
2834   #my $balance_due = $self->owed + $pr_total - $cr_total;
2835   my $balance_due = $self->owed + $pr_total;
2836
2837   # the customer's current balance as shown on the invoice before this one
2838   $invoice_data{'true_previous_balance'} = sprintf("%.2f", ($self->previous_balance || 0) );
2839
2840   # the change in balance from that invoice to this one
2841   $invoice_data{'balance_adjustments'} = sprintf("%.2f", ($self->previous_balance || 0) - ($self->billing_balance || 0) );
2842
2843   # the sum of amount owed on all previous invoices
2844   $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
2845
2846   # the sum of amount owed on all invoices
2847   $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
2848
2849   # info from customer's last invoice before this one, for some
2850   # summary formats
2851   $invoice_data{'last_bill'} = {};
2852   my $last_bill = $pr_cust_bill[-1];
2853   if ( $last_bill ) {
2854     $invoice_data{'last_bill'} = {
2855       '_date'     => $last_bill->_date, #unformatted
2856       # all we need for now
2857     };
2858   }
2859
2860   my $summarypage = '';
2861   if ( $conf->exists('invoice_usesummary', $agentnum) ) {
2862     $summarypage = 1;
2863   }
2864   $invoice_data{'summarypage'} = $summarypage;
2865
2866   warn "$me substituting variables in notes, footer, smallfooter\n"
2867     if $DEBUG > 1;
2868
2869   my @include = (qw( notes footer smallfooter ));
2870   push @include, 'coupon' unless $params{'no_coupon'};
2871   foreach my $include (@include) {
2872
2873     my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
2874     my @inc_src;
2875
2876     if ( $conf->exists($inc_file, $agentnum)
2877          && length( $conf->config($inc_file, $agentnum) ) ) {
2878
2879       @inc_src = $conf->config($inc_file, $agentnum);
2880
2881     } else {
2882
2883       $inc_file = $conf->key_orbase("invoice_latex$include", $template);
2884
2885       my $convert_map = $convert_maps{$format}{$include};
2886
2887       @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
2888                        s/--\@\]/$delimiters{$format}[1]/g;
2889                        $_;
2890                      }
2891                  &$convert_map( $conf->config($inc_file, $agentnum) );
2892
2893     }
2894
2895     my $inc_tt = new Text::Template (
2896       TYPE       => 'ARRAY',
2897       SOURCE     => [ map "$_\n", @inc_src ],
2898       DELIMITERS => $delimiters{$format},
2899     ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
2900
2901     unless ( $inc_tt->compile() ) {
2902       my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
2903       warn $error. "Template:\n". join('', map "$_\n", @inc_src);
2904       die $error;
2905     }
2906
2907     $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
2908
2909     $invoice_data{$include} =~ s/\n+$//
2910       if ($format eq 'latex');
2911   }
2912
2913   # let invoices use either of these as needed
2914   $invoice_data{'po_num'} = ($cust_main->payby eq 'BILL')
2915     ? $cust_main->payinfo : '';
2916   $invoice_data{'po_line'} =
2917     (  $cust_main->payby eq 'BILL' && $cust_main->payinfo )
2918       ? &$escape_function($self->mt("Purchase Order #").$cust_main->payinfo)
2919       : $nbsp;
2920
2921   my %money_chars = ( 'latex'    => '',
2922                       'html'     => $conf->config('money_char') || '$',
2923                       'template' => '',
2924                     );
2925   my $money_char = $money_chars{$format};
2926
2927   my %other_money_chars = ( 'latex'    => '\dollar ',#XXX should be a config too
2928                             'html'     => $conf->config('money_char') || '$',
2929                             'template' => '',
2930                           );
2931   my $other_money_char = $other_money_chars{$format};
2932   $invoice_data{'dollar'} = $other_money_char;
2933
2934   my @detail_items = ();
2935   my @total_items = ();
2936   my @buf = ();
2937   my @sections = ();
2938
2939   $invoice_data{'detail_items'} = \@detail_items;
2940   $invoice_data{'total_items'} = \@total_items;
2941   $invoice_data{'buf'} = \@buf;
2942   $invoice_data{'sections'} = \@sections;
2943
2944   warn "$me generating sections\n"
2945     if $DEBUG > 1;
2946
2947   my $previous_section = { 'description' => $self->mt('Previous Charges'),
2948                            'subtotal'    => $other_money_char.
2949                                             sprintf('%.2f', $pr_total),
2950                            'summarized'  => '', #why? $summarypage ? 'Y' : '',
2951                          };
2952   $previous_section->{posttotal} = '0 / 30 / 60 / 90 days overdue '.
2953     join(' / ', map { $cust_main->balance_date_range(@$_) }
2954                 $self->_prior_month30s
2955         )
2956     if $conf->exists('invoice_include_aging');
2957
2958   my $taxtotal = 0;
2959   my $tax_section = { 'description' => $self->mt('Taxes, Surcharges, and Fees'),
2960                       'subtotal'    => $taxtotal,   # adjusted below
2961                     };
2962   my $tax_weight = _pkg_category($tax_section->{description})
2963                         ? _pkg_category($tax_section->{description})->weight
2964                         : 0;
2965   $tax_section->{'summarized'} = ''; #why? $summarypage && !$tax_weight ? 'Y' : '';
2966   $tax_section->{'sort_weight'} = $tax_weight;
2967
2968
2969   my $adjusttotal = 0;
2970   my $adjust_section = { 'description' =>
2971     $self->mt('Credits, Payments, and Adjustments'),
2972                          'subtotal'    => 0,   # adjusted below
2973                        };
2974   my $adjust_weight = _pkg_category($adjust_section->{description})
2975                         ? _pkg_category($adjust_section->{description})->weight
2976                         : 0;
2977   $adjust_section->{'summarized'} = ''; #why? $summarypage && !$adjust_weight ? 'Y' : '';
2978   $adjust_section->{'sort_weight'} = $adjust_weight;
2979
2980   my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
2981   my $multisection = $conf->exists('invoice_sections', $cust_main->agentnum);
2982   $invoice_data{'multisection'} = $multisection;
2983   my $late_sections = [];
2984   my $extra_sections = [];
2985   my $extra_lines = ();
2986   if ( $multisection ) {
2987     ($extra_sections, $extra_lines) =
2988       $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
2989       if $conf->exists('usage_class_as_a_section', $cust_main->agentnum);
2990
2991     push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
2992
2993     push @detail_items, @$extra_lines if $extra_lines;
2994     push @sections,
2995       $self->_items_sections( $late_sections,      # this could stand a refactor
2996                               $summarypage,
2997                               $escape_function_nonbsp,
2998                               $extra_sections,
2999                               $format,             #bah
3000                             );
3001     if ($conf->exists('svc_phone_sections')) {
3002       my ($phone_sections, $phone_lines) =
3003         $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
3004       push @{$late_sections}, @$phone_sections;
3005       push @detail_items, @$phone_lines;
3006     }
3007     if ($conf->exists('voip-cust_accountcode_cdr') && $cust_main->accountcode_cdr) {
3008       my ($accountcode_section, $accountcode_lines) =
3009         $self->_items_accountcode_cdr($escape_function_nonbsp,$format);
3010       if ( scalar(@$accountcode_lines) ) {
3011           push @{$late_sections}, $accountcode_section;
3012           push @detail_items, @$accountcode_lines;
3013       }
3014     }
3015   } else {# not multisection
3016     # make a default section
3017     push @sections, { 'description' => '', 'subtotal' => '',
3018       'no_subtotal' => 1 };
3019     # and calculate the finance charge total, since it won't get done otherwise.
3020     # XXX possibly other totals?
3021     # XXX possibly finance_pkgclass should not be used in this manner?
3022     if ( $conf->exists('finance_pkgclass') ) {
3023       my @finance_charges;
3024       foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
3025         if ( grep { $_->section eq $invoice_data{finance_section} }
3026              $cust_bill_pkg->cust_bill_pkg_display ) {
3027           # I think these are always setup fees, but just to be sure...
3028           push @finance_charges, $cust_bill_pkg->recur + $cust_bill_pkg->setup;
3029         }
3030       }
3031       $invoice_data{finance_amount} =
3032         sprintf('%.2f', sum( @finance_charges ) || 0);
3033     }
3034   }
3035
3036   unless (    $conf->exists('disable_previous_balance', $agentnum)
3037            || $conf->exists('previous_balance-summary_only')
3038          )
3039   {
3040
3041     warn "$me adding previous balances\n"
3042       if $DEBUG > 1;
3043
3044     foreach my $line_item ( $self->_items_previous ) {
3045
3046       my $detail = {
3047         ext_description => [],
3048       };
3049       $detail->{'ref'} = $line_item->{'pkgnum'};
3050       $detail->{'quantity'} = 1;
3051       $detail->{'section'} = $previous_section;
3052       $detail->{'description'} = &$escape_function($line_item->{'description'});
3053       if ( exists $line_item->{'ext_description'} ) {
3054         @{$detail->{'ext_description'}} = map {
3055           &$escape_function($_);
3056         } @{$line_item->{'ext_description'}};
3057       }
3058       $detail->{'amount'} = ( $old_latex ? '' : $money_char).
3059                             $line_item->{'amount'};
3060       $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
3061
3062       push @detail_items, $detail;
3063       push @buf, [ $detail->{'description'},
3064                    $money_char. sprintf("%10.2f", $line_item->{'amount'}),
3065                  ];
3066     }
3067
3068   }
3069
3070   if ( @pr_cust_bill && !$conf->exists('disable_previous_balance', $agentnum) )
3071     {
3072     push @buf, ['','-----------'];
3073     push @buf, [ $self->mt('Total Previous Balance'),
3074                  $money_char. sprintf("%10.2f", $pr_total) ];
3075     push @buf, ['',''];
3076   }
3077
3078   if ( $conf->exists('svc_phone-did-summary') ) {
3079       warn "$me adding DID summary\n"
3080         if $DEBUG > 1;
3081
3082       my ($didsummary,$minutes) = $self->_did_summary;
3083       my $didsummary_desc = 'DID Activity Summary (since last invoice)';
3084       push @detail_items,
3085        { 'description' => $didsummary_desc,
3086            'ext_description' => [ $didsummary, $minutes ],
3087        };
3088   }
3089
3090   foreach my $section (@sections, @$late_sections) {
3091
3092     warn "$me adding section \n". Dumper($section)
3093       if $DEBUG > 1;
3094
3095     # begin some normalization
3096     $section->{'subtotal'} = $section->{'amount'}
3097       if $multisection
3098          && !exists($section->{subtotal})
3099          && exists($section->{amount});
3100
3101     $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
3102       if ( $invoice_data{finance_section} &&
3103            $section->{'description'} eq $invoice_data{finance_section} );
3104
3105     $section->{'subtotal'} = $other_money_char.
3106                              sprintf('%.2f', $section->{'subtotal'})
3107       if $multisection;
3108
3109     # continue some normalization
3110     $section->{'amount'}   = $section->{'subtotal'}
3111       if $multisection;
3112
3113
3114     if ( $section->{'description'} ) {
3115       push @buf, ( [ &$escape_function($section->{'description'}), '' ],
3116                    [ '', '' ],
3117                  );
3118     }
3119
3120     warn "$me   setting options\n"
3121       if $DEBUG > 1;
3122
3123     my $multilocation = scalar($cust_main->cust_location); #too expensive?
3124     my %options = ();
3125     $options{'section'} = $section if $multisection;
3126     $options{'format'} = $format;
3127     $options{'escape_function'} = $escape_function;
3128     $options{'no_usage'} = 1 unless $unsquelched;
3129     $options{'unsquelched'} = $unsquelched;
3130     $options{'summary_page'} = $summarypage;
3131     $options{'skip_usage'} =
3132       scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
3133     $options{'multilocation'} = $multilocation;
3134     $options{'multisection'} = $multisection;
3135
3136     warn "$me   searching for line items\n"
3137       if $DEBUG > 1;
3138
3139     foreach my $line_item ( $self->_items_pkg(%options) ) {
3140
3141       warn "$me     adding line item $line_item\n"
3142         if $DEBUG > 1;
3143
3144       my $detail = {
3145         ext_description => [],
3146       };
3147       $detail->{'ref'} = $line_item->{'pkgnum'};
3148       $detail->{'quantity'} = $line_item->{'quantity'};
3149       $detail->{'section'} = $section;
3150       $detail->{'description'} = &$escape_function($line_item->{'description'});
3151       if ( exists $line_item->{'ext_description'} ) {
3152         @{$detail->{'ext_description'}} = @{$line_item->{'ext_description'}};
3153       }
3154       $detail->{'amount'} = ( $old_latex ? '' : $money_char ).
3155                               $line_item->{'amount'};
3156       $detail->{'unit_amount'} = ( $old_latex ? '' : $money_char ).
3157                                  $line_item->{'unit_amount'};
3158       $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
3159
3160       $detail->{'sdate'} = $line_item->{'sdate'};
3161       $detail->{'edate'} = $line_item->{'edate'};
3162       $detail->{'seconds'} = $line_item->{'seconds'};
3163
3164       push @detail_items, $detail;
3165       push @buf, ( [ $detail->{'description'},
3166                      $money_char. sprintf("%10.2f", $line_item->{'amount'}),
3167                    ],
3168                    map { [ " ". $_, '' ] } @{$detail->{'ext_description'}},
3169                  );
3170     }
3171
3172     if ( $section->{'description'} ) {
3173       push @buf, ( ['','-----------'],
3174                    [ $section->{'description'}. ' sub-total',
3175                       $section->{'subtotal'} # already formatted this
3176                    ],
3177                    [ '', '' ],
3178                    [ '', '' ],
3179                  );
3180     }
3181
3182   }
3183
3184   $invoice_data{current_less_finance} =
3185     sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
3186
3187   if ( $multisection && !$conf->exists('disable_previous_balance', $agentnum)
3188     || $conf->exists('previous_balance-summary_only') )
3189   {
3190     unshift @sections, $previous_section if $pr_total;
3191   }
3192
3193   warn "$me adding taxes\n"
3194     if $DEBUG > 1;
3195
3196   foreach my $tax ( $self->_items_tax ) {
3197
3198     $taxtotal += $tax->{'amount'};
3199
3200     my $description = &$escape_function( $tax->{'description'} );
3201     my $amount      = sprintf( '%.2f', $tax->{'amount'} );
3202
3203     if ( $multisection ) {
3204
3205       my $money = $old_latex ? '' : $money_char;
3206       push @detail_items, {
3207         ext_description => [],
3208         ref          => '',
3209         quantity     => '',
3210         description  => $description,
3211         amount       => $money. $amount,
3212         product_code => '',
3213         section      => $tax_section,
3214       };
3215
3216     } else {
3217
3218       push @total_items, {
3219         'total_item'   => $description,
3220         'total_amount' => $other_money_char. $amount,
3221       };
3222
3223     }
3224
3225     push @buf,[ $description,
3226                 $money_char. $amount,
3227               ];
3228
3229   }
3230
3231   if ( $taxtotal ) {
3232     my $total = {};
3233     $total->{'total_item'} = $self->mt('Sub-total');
3234     $total->{'total_amount'} =
3235       $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
3236
3237     if ( $multisection ) {
3238       $tax_section->{'subtotal'} = $other_money_char.
3239                                    sprintf('%.2f', $taxtotal);
3240       $tax_section->{'pretotal'} = 'New charges sub-total '.
3241                                    $total->{'total_amount'};
3242       push @sections, $tax_section if $taxtotal;
3243     }else{
3244       unshift @total_items, $total;
3245     }
3246   }
3247   $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
3248
3249   push @buf,['','-----------'];
3250   push @buf,[$self->mt(
3251               $conf->exists('disable_previous_balance', $agentnum)
3252                ? 'Total Charges'
3253                : 'Total New Charges'
3254              ),
3255              $money_char. sprintf("%10.2f",$self->charged) ];
3256   push @buf,['',''];
3257
3258   {
3259     my $total = {};
3260     my $item = 'Total';
3261     $item = $conf->config('previous_balance-exclude_from_total')
3262          || 'Total New Charges'
3263       if $conf->exists('previous_balance-exclude_from_total');
3264     my $amount = $self->charged +
3265                    ( $conf->exists('disable_previous_balance', $agentnum) ||
3266                      $conf->exists('previous_balance-exclude_from_total')
3267                      ? 0
3268                      : $pr_total
3269                    );
3270     $total->{'total_item'} = &$embolden_function($self->mt($item));
3271     $total->{'total_amount'} =
3272       &$embolden_function( $other_money_char.  sprintf( '%.2f', $amount ) );
3273     if ( $multisection ) {
3274       if ( $adjust_section->{'sort_weight'} ) {
3275         $adjust_section->{'posttotal'} = $self->mt('Balance Forward').' '.
3276           $other_money_char.  sprintf("%.2f", ($self->billing_balance || 0) );
3277       } else {
3278         $adjust_section->{'pretotal'} = $self->mt('New charges total').' '.
3279           $other_money_char.  sprintf('%.2f', $self->charged );
3280       }
3281     }else{
3282       push @total_items, $total;
3283     }
3284     push @buf,['','-----------'];
3285     push @buf,[$item,
3286                $money_char.
3287                sprintf( '%10.2f', $amount )
3288               ];
3289     push @buf,['',''];
3290   }
3291
3292   unless ( $conf->exists('disable_previous_balance', $agentnum) ) {
3293     #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
3294
3295     # credits
3296     my $credittotal = 0;
3297     foreach my $credit ( $self->_items_credits('trim_len'=>60) ) {
3298
3299       my $total;
3300       $total->{'total_item'} = &$escape_function($credit->{'description'});
3301       $credittotal += $credit->{'amount'};
3302       $total->{'total_amount'} = '-'. $other_money_char. $credit->{'amount'};
3303       $adjusttotal += $credit->{'amount'};
3304       if ( $multisection ) {
3305         my $money = $old_latex ? '' : $money_char;
3306         push @detail_items, {
3307           ext_description => [],
3308           ref          => '',
3309           quantity     => '',
3310           description  => &$escape_function($credit->{'description'}),
3311           amount       => $money. $credit->{'amount'},
3312           product_code => '',
3313           section      => $adjust_section,
3314         };
3315       } else {
3316         push @total_items, $total;
3317       }
3318
3319     }
3320     $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
3321
3322     #credits (again)
3323     foreach my $credit ( $self->_items_credits('trim_len'=>32) ) {
3324       push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
3325     }
3326
3327     # payments
3328     my $paymenttotal = 0;
3329     foreach my $payment ( $self->_items_payments ) {
3330       my $total = {};
3331       $total->{'total_item'} = &$escape_function($payment->{'description'});
3332       $paymenttotal += $payment->{'amount'};
3333       $total->{'total_amount'} = '-'. $other_money_char. $payment->{'amount'};
3334       $adjusttotal += $payment->{'amount'};
3335       if ( $multisection ) {
3336         my $money = $old_latex ? '' : $money_char;
3337         push @detail_items, {
3338           ext_description => [],
3339           ref          => '',
3340           quantity     => '',
3341           description  => &$escape_function($payment->{'description'}),
3342           amount       => $money. $payment->{'amount'},
3343           product_code => '',
3344           section      => $adjust_section,
3345         };
3346       }else{
3347         push @total_items, $total;
3348       }
3349       push @buf, [ $payment->{'description'},
3350                    $money_char. sprintf("%10.2f", $payment->{'amount'}),
3351                  ];
3352     }
3353     $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
3354
3355     if ( $multisection ) {
3356       $adjust_section->{'subtotal'} = $other_money_char.
3357                                       sprintf('%.2f', $adjusttotal);
3358       push @sections, $adjust_section
3359         unless $adjust_section->{sort_weight};
3360     }
3361
3362     # create Balance Due message
3363     {
3364       my $total;
3365       $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
3366       $total->{'total_amount'} =
3367         &$embolden_function(
3368           $other_money_char. sprintf('%.2f', $summarypage
3369                                                ? $self->charged +
3370                                                  $self->billing_balance
3371                                                : $self->owed + $pr_total
3372                                     )
3373         );
3374       if ( $multisection && !$adjust_section->{sort_weight} ) {
3375         $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
3376                                          $total->{'total_amount'};
3377       }else{
3378         push @total_items, $total;
3379       }
3380       push @buf,['','-----------'];
3381       push @buf,[$self->balance_due_msg, $money_char.
3382         sprintf("%10.2f", $balance_due ) ];
3383     }
3384
3385     if ( $conf->exists('previous_balance-show_credit')
3386         and $cust_main->balance < 0 ) {
3387       my $credit_total = {
3388         'total_item'    => &$embolden_function($self->credit_balance_msg),
3389         'total_amount'  => &$embolden_function(
3390           $other_money_char. sprintf('%.2f', -$cust_main->balance)
3391         ),
3392       };
3393       if ( $multisection ) {
3394         $adjust_section->{'posttotal'} .= $newline_token .
3395           $credit_total->{'total_item'} . ' ' . $credit_total->{'total_amount'};
3396       }
3397       else {
3398         push @total_items, $credit_total;
3399       }
3400       push @buf,['','-----------'];
3401       push @buf,[$self->credit_balance_msg, $money_char.
3402         sprintf("%10.2f", -$cust_main->balance ) ];
3403     }
3404   }
3405
3406   if ( $multisection ) {
3407     if ($conf->exists('svc_phone_sections')) {
3408       my $total;
3409       $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
3410       $total->{'total_amount'} =
3411         &$embolden_function(
3412           $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
3413         );
3414       my $last_section = pop @sections;
3415       $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
3416                                      $total->{'total_amount'};
3417       push @sections, $last_section;
3418     }
3419     push @sections, @$late_sections
3420       if $unsquelched;
3421   }
3422
3423   # make a discounts-available section, even without multisection
3424   if ( $conf->exists('discount-show_available')
3425        and my @discounts_avail = $self->_items_discounts_avail ) {
3426     my $discount_section = {
3427       'description' => $self->mt('Discounts Available'),
3428       'subtotal'    => '',
3429       'no_subtotal' => 1,
3430     };
3431
3432     push @sections, $discount_section;
3433     push @detail_items, map { +{
3434         'ref'         => '', #should this be something else?
3435         'section'     => $discount_section,
3436         'description' => &$escape_function( $_->{description} ),
3437         'amount'      => $money_char . &$escape_function( $_->{amount} ),
3438         'ext_description' => [ &$escape_function($_->{ext_description}) || () ],
3439     } } @discounts_avail;
3440   }
3441
3442   # All sections and items are built; now fill in templates.
3443   my @includelist = ();
3444   push @includelist, 'summary' if $summarypage;
3445   foreach my $include ( @includelist ) {
3446
3447     my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
3448     my @inc_src;
3449
3450     if ( length( $conf->config($inc_file, $agentnum) ) ) {
3451
3452       @inc_src = $conf->config($inc_file, $agentnum);
3453
3454     } else {
3455
3456       $inc_file = $conf->key_orbase("invoice_latex$include", $template);
3457
3458       my $convert_map = $convert_maps{$format}{$include};
3459
3460       @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
3461                        s/--\@\]/$delimiters{$format}[1]/g;
3462                        $_;
3463                      }
3464                  &$convert_map( $conf->config($inc_file, $agentnum) );
3465
3466     }
3467
3468     my $inc_tt = new Text::Template (
3469       TYPE       => 'ARRAY',
3470       SOURCE     => [ map "$_\n", @inc_src ],
3471       DELIMITERS => $delimiters{$format},
3472     ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
3473
3474     unless ( $inc_tt->compile() ) {
3475       my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
3476       warn $error. "Template:\n". join('', map "$_\n", @inc_src);
3477       die $error;
3478     }
3479
3480     $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
3481
3482     $invoice_data{$include} =~ s/\n+$//
3483       if ($format eq 'latex');
3484   }
3485
3486   $invoice_lines = 0;
3487   my $wasfunc = 0;
3488   foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
3489     /invoice_lines\((\d*)\)/;
3490     $invoice_lines += $1 || scalar(@buf);
3491     $wasfunc=1;
3492   }
3493   die "no invoice_lines() functions in template?"
3494     if ( $format eq 'template' && !$wasfunc );
3495
3496   if ($format eq 'template') {
3497
3498     if ( $invoice_lines ) {
3499       $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
3500       $invoice_data{'total_pages'}++
3501         if scalar(@buf) % $invoice_lines;
3502     }
3503
3504     #setup subroutine for the template
3505     $invoice_data{invoice_lines} = sub {
3506       my $lines = shift || scalar(@buf);
3507       map {
3508         scalar(@buf)
3509           ? shift @buf
3510           : [ '', '' ];
3511       }
3512       ( 1 .. $lines );
3513     };
3514
3515     my $lines;
3516     my @collect;
3517     while (@buf) {
3518       push @collect, split("\n",
3519         $text_template->fill_in( HASH => \%invoice_data )
3520       );
3521       $invoice_data{'page'}++;
3522     }
3523     map "$_\n", @collect;
3524   }else{
3525     # this is where we actually create the invoice
3526     warn "filling in template for invoice ". $self->invnum. "\n"
3527       if $DEBUG;
3528     warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
3529       if $DEBUG > 1;
3530
3531     $text_template->fill_in(HASH => \%invoice_data);
3532   }
3533 }
3534
3535 # helper routine for generating date ranges
3536 sub _prior_month30s {
3537   my $self = shift;
3538   my @ranges = (
3539    [ 1,       2592000 ], # 0-30 days ago
3540    [ 2592000, 5184000 ], # 30-60 days ago
3541    [ 5184000, 7776000 ], # 60-90 days ago
3542    [ 7776000, 0       ], # 90+   days ago
3543   );
3544
3545   map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
3546           $_->[1] ? $self->_date - $_->[1] - 1 : '',
3547       ] }
3548   @ranges;
3549 }
3550
3551 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
3552
3553 Returns an postscript invoice, as a scalar.
3554
3555 Options can be passed as a hashref (recommended) or as a list of time, template
3556 and then any key/value pairs for any other options.
3557
3558 I<time> an optional value used to control the printing of overdue messages.  The
3559 default is now.  It isn't the date of the invoice; that's the `_date' field.
3560 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
3561 L<Time::Local> and L<Date::Parse> for conversion functions.
3562
3563 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
3564
3565 =cut
3566
3567 sub print_ps {
3568   my $self = shift;
3569
3570   my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
3571   my $ps = generate_ps($file);
3572   unlink($logofile);
3573   unlink($barcodefile) if $barcodefile;
3574
3575   $ps;
3576 }
3577
3578 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
3579
3580 Returns an PDF invoice, as a scalar.
3581
3582 Options can be passed as a hashref (recommended) or as a list of time, template
3583 and then any key/value pairs for any other options.
3584
3585 I<time> an optional value used to control the printing of overdue messages.  The
3586 default is now.  It isn't the date of the invoice; that's the `_date' field.
3587 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
3588 L<Time::Local> and L<Date::Parse> for conversion functions.
3589
3590 I<template>, if specified, is the name of a suffix for alternate invoices.
3591
3592 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
3593
3594 =cut
3595
3596 sub print_pdf {
3597   my $self = shift;
3598
3599   my ($file, $logofile, $barcodefile) = $self->print_latex(@_);
3600   my $pdf = generate_pdf($file);
3601   unlink($logofile);
3602   unlink($barcodefile) if $barcodefile;
3603
3604   $pdf;
3605 }
3606
3607 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
3608
3609 Returns an HTML invoice, as a scalar.
3610
3611 I<time> an optional value used to control the printing of overdue messages.  The
3612 default is now.  It isn't the date of the invoice; that's the `_date' field.
3613 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
3614 L<Time::Local> and L<Date::Parse> for conversion functions.
3615
3616 I<template>, if specified, is the name of a suffix for alternate invoices.
3617
3618 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
3619
3620 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
3621 when emailing the invoice as part of a multipart/related MIME email.
3622
3623 =cut
3624
3625 sub print_html {
3626   my $self = shift;
3627   my %params;
3628   if ( ref($_[0]) ) {
3629     %params = %{ shift() };
3630   }else{
3631     $params{'time'} = shift;
3632     $params{'template'} = shift;
3633     $params{'cid'} = shift;
3634   }
3635
3636   $params{'format'} = 'html';
3637
3638   $self->print_generic( %params );
3639 }
3640
3641 # quick subroutine for print_latex
3642 #
3643 # There are ten characters that LaTeX treats as special characters, which
3644 # means that they do not simply typeset themselves:
3645 #      # $ % & ~ _ ^ \ { }
3646 #
3647 # TeX ignores blanks following an escaped character; if you want a blank (as
3648 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
3649
3650 sub _latex_escape {
3651   my $value = shift;
3652   $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
3653   $value =~ s/([<>])/\$$1\$/g;
3654   $value;
3655 }
3656
3657 sub _html_escape {
3658   my $value = shift;
3659   encode_entities($value);
3660   $value;
3661 }
3662
3663 sub _html_escape_nbsp {
3664   my $value = _html_escape(shift);
3665   $value =~ s/ +/&nbsp;/g;
3666   $value;
3667 }
3668
3669 #utility methods for print_*
3670
3671 sub _translate_old_latex_format {
3672   warn "_translate_old_latex_format called\n"
3673     if $DEBUG;
3674
3675   my @template = ();
3676   while ( @_ ) {
3677     my $line = shift;
3678
3679     if ( $line =~ /^%%Detail\s*$/ ) {
3680
3681       push @template, q![@--!,
3682                       q!  foreach my $_tr_line (@detail_items) {!,
3683                       q!    if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
3684                       q!      $_tr_line->{'description'} .= !,
3685                       q!        "\\tabularnewline\n~~".!,
3686                       q!        join( "\\tabularnewline\n~~",!,
3687                       q!          @{$_tr_line->{'ext_description'}}!,
3688                       q!        );!,
3689                       q!    }!;
3690
3691       while ( ( my $line_item_line = shift )
3692               !~ /^%%EndDetail\s*$/                            ) {
3693         $line_item_line =~ s/'/\\'/g;    # nice LTS
3694         $line_item_line =~ s/\\/\\\\/g;  # escape quotes and backslashes
3695         $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
3696         push @template, "    \$OUT .= '$line_item_line';";
3697       }
3698
3699       push @template, '}',
3700                       '--@]';
3701       #' doh, gvim
3702     } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
3703
3704       push @template, '[@--',
3705                       '  foreach my $_tr_line (@total_items) {';
3706
3707       while ( ( my $total_item_line = shift )
3708               !~ /^%%EndTotalDetails\s*$/                      ) {
3709         $total_item_line =~ s/'/\\'/g;    # nice LTS
3710         $total_item_line =~ s/\\/\\\\/g;  # escape quotes and backslashes
3711         $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
3712         push @template, "    \$OUT .= '$total_item_line';";
3713       }
3714
3715       push @template, '}',
3716                       '--@]';
3717
3718     } else {
3719       $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
3720       push @template, $line;
3721     }
3722
3723   }
3724
3725   if ($DEBUG) {
3726     warn "$_\n" foreach @template;
3727   }
3728
3729   (@template);
3730 }
3731
3732 sub terms {
3733   my $self = shift;
3734   my $conf = $self->conf;
3735
3736   #check for an invoice-specific override
3737   return $self->invoice_terms if $self->invoice_terms;
3738
3739   #check for a customer- specific override
3740   my $cust_main = $self->cust_main;
3741   return $cust_main->invoice_terms if $cust_main->invoice_terms;
3742
3743   #use configured default
3744   $conf->config('invoice_default_terms') || '';
3745 }
3746
3747 sub due_date {
3748   my $self = shift;
3749   my $duedate = '';
3750   if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
3751     $duedate = $self->_date() + ( $1 * 86400 );
3752   }
3753   $duedate;
3754 }
3755
3756 sub due_date2str {
3757   my $self = shift;
3758   $self->due_date ? time2str(shift, $self->due_date) : '';
3759 }
3760
3761 sub balance_due_msg {
3762   my $self = shift;
3763   my $msg = $self->mt('Balance Due');
3764   return $msg unless $self->terms;
3765   if ( $self->due_date ) {
3766     $msg .= ' - ' . $self->mt('Please pay by'). ' '.
3767       $self->due_date2str($date_format);
3768   } elsif ( $self->terms ) {
3769     $msg .= ' - '. $self->terms;
3770   }
3771   $msg;
3772 }
3773
3774 sub balance_due_date {
3775   my $self = shift;
3776   my $conf = $self->conf;
3777   my $duedate = '';
3778   if (    $conf->exists('invoice_default_terms')
3779        && $conf->config('invoice_default_terms')=~ /^\s*Net\s*(\d+)\s*$/ ) {
3780     $duedate = time2str($rdate_format, $self->_date + ($1*86400) );
3781   }
3782   $duedate;
3783 }
3784
3785 sub credit_balance_msg {
3786   my $self = shift;
3787   $self->mt('Credit Balance Remaining')
3788 }
3789
3790 =item invnum_date_pretty
3791
3792 Returns a string with the invoice number and date, for example:
3793 "Invoice #54 (3/20/2008)"
3794
3795 =cut
3796
3797 sub invnum_date_pretty {
3798   my $self = shift;
3799   $self->mt('Invoice #'). $self->invnum. ' ('. $self->_date_pretty. ')';
3800 }
3801
3802 =item _date_pretty
3803
3804 Returns a string with the date, for example: "3/20/2008"
3805
3806 =cut
3807
3808 sub _date_pretty {
3809   my $self = shift;
3810   time2str($date_format, $self->_date);
3811 }
3812
3813 =item _items_sections LATE SUMMARYPAGE ESCAPE EXTRA_SECTIONS FORMAT
3814
3815 Generate section information for all items appearing on this invoice.
3816 This will only be called for multi-section invoices.
3817
3818 For each line item (L<FS::cust_bill_pkg> record), this will fetch all
3819 related display records (L<FS::cust_bill_pkg_display>) and organize
3820 them into two groups ("early" and "late" according to whether they come
3821 before or after the total), then into sections.  A subtotal is calculated
3822 for each section.
3823
3824 Section descriptions are returned in sort weight order.  Each consists
3825 of a hash containing:
3826
3827 description: the package category name, escaped
3828 subtotal: the total charges in that section
3829 tax_section: a flag indicating that the section contains only tax charges
3830 summarized: same as tax_section, for some reason
3831 sort_weight: the package category's sort weight
3832
3833 If 'condense' is set on the display record, it also contains everything
3834 returned from C<_condense_section()>, i.e. C<_condensed_foo_generator>
3835 coderefs to generate parts of the invoice.  This is not advised.
3836
3837 Arguments:
3838
3839 LATE: an arrayref to push the "late" section hashes onto.  The "early"
3840 group is simply returned from the method.
3841
3842 SUMMARYPAGE: a flag indicating whether this is a summary-format invoice.
3843 Turning this on has the following effects:
3844 - Ignores display items with the 'summary' flag.
3845 - Combines all items into the "early" group.
3846 - Creates sections for all non-disabled package categories, even if they
3847 have no charges on this invoice, as well as a section with no name.
3848
3849 ESCAPE: an escape function to use for section titles.
3850
3851 EXTRA_SECTIONS: an arrayref of additional sections to return after the
3852 sorted list.  If there are any of these, section subtotals exclude
3853 usage charges.
3854
3855 FORMAT: 'latex', 'html', or 'template' (i.e. text).  Not used, but
3856 passed through to C<_condense_section()>.
3857
3858 =cut
3859
3860 use vars qw(%pkg_category_cache);
3861 sub _items_sections {
3862   my $self = shift;
3863   my $late = shift;
3864   my $summarypage = shift;
3865   my $escape = shift;
3866   my $extra_sections = shift;
3867   my $format = shift;
3868
3869   my %subtotal = ();
3870   my %late_subtotal = ();
3871   my %not_tax = ();
3872
3873   foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
3874   {
3875
3876       my $usage = $cust_bill_pkg->usage;
3877
3878       foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
3879         next if ( $display->summary && $summarypage );
3880
3881         my $section = $display->section;
3882         my $type    = $display->type;
3883
3884         $not_tax{$section} = 1
3885           unless $cust_bill_pkg->pkgnum == 0;
3886
3887         if ( $display->post_total && !$summarypage ) {
3888           if (! $type || $type eq 'S') {
3889             $late_subtotal{$section} += $cust_bill_pkg->setup
3890               if $cust_bill_pkg->setup != 0
3891               || $cust_bill_pkg->setup_show_zero;
3892           }
3893
3894           if (! $type) {
3895             $late_subtotal{$section} += $cust_bill_pkg->recur
3896               if $cust_bill_pkg->recur != 0
3897               || $cust_bill_pkg->recur_show_zero;
3898           }
3899
3900           if ($type && $type eq 'R') {
3901             $late_subtotal{$section} += $cust_bill_pkg->recur - $usage
3902               if $cust_bill_pkg->recur != 0
3903               || $cust_bill_pkg->recur_show_zero;
3904           }
3905
3906           if ($type && $type eq 'U') {
3907             $late_subtotal{$section} += $usage
3908               unless scalar(@$extra_sections);
3909           }
3910
3911         } else {
3912
3913           next if $cust_bill_pkg->pkgnum == 0 && ! $section;
3914
3915           if (! $type || $type eq 'S') {
3916             $subtotal{$section} += $cust_bill_pkg->setup
3917               if $cust_bill_pkg->setup != 0
3918               || $cust_bill_pkg->setup_show_zero;
3919           }
3920
3921           if (! $type) {
3922             $subtotal{$section} += $cust_bill_pkg->recur
3923               if $cust_bill_pkg->recur != 0
3924               || $cust_bill_pkg->recur_show_zero;
3925           }
3926
3927           if ($type && $type eq 'R') {
3928             $subtotal{$section} += $cust_bill_pkg->recur - $usage
3929               if $cust_bill_pkg->recur != 0
3930               || $cust_bill_pkg->recur_show_zero;
3931           }
3932
3933           if ($type && $type eq 'U') {
3934             $subtotal{$section} += $usage
3935               unless scalar(@$extra_sections);
3936           }
3937
3938         }
3939
3940       }
3941
3942   }
3943
3944   %pkg_category_cache = ();
3945
3946   push @$late, map { { 'description' => &{$escape}($_),
3947                        'subtotal'    => $late_subtotal{$_},
3948                        'post_total'  => 1,
3949                        'sort_weight' => ( _pkg_category($_)
3950                                             ? _pkg_category($_)->weight
3951                                             : 0
3952                                        ),
3953                        ((_pkg_category($_) && _pkg_category($_)->condense)
3954                                            ? $self->_condense_section($format)
3955                                            : ()
3956                        ),
3957                    } }
3958                  sort _sectionsort keys %late_subtotal;
3959
3960   my @sections;
3961   if ( $summarypage ) {
3962     @sections = grep { exists($subtotal{$_}) || ! _pkg_category($_)->disabled }
3963                 map { $_->categoryname } qsearch('pkg_category', {});
3964     push @sections, '' if exists($subtotal{''});
3965   } else {
3966     @sections = keys %subtotal;
3967   }
3968
3969   my @early = map { { 'description' => &{$escape}($_),
3970                       'subtotal'    => $subtotal{$_},
3971                       'summarized'  => $not_tax{$_} ? '' : 'Y',
3972                       'tax_section' => $not_tax{$_} ? '' : 'Y',
3973                       'sort_weight' => ( _pkg_category($_)
3974                                            ? _pkg_category($_)->weight
3975                                            : 0
3976                                        ),
3977                        ((_pkg_category($_) && _pkg_category($_)->condense)
3978                                            ? $self->_condense_section($format)
3979                                            : ()
3980                        ),
3981                     }
3982                   } @sections;
3983   push @early, @$extra_sections if $extra_sections;
3984
3985   sort { $a->{sort_weight} <=> $b->{sort_weight} } @early;
3986
3987 }
3988
3989 #helper subs for above
3990
3991 sub _sectionsort {
3992   _pkg_category($a)->weight <=> _pkg_category($b)->weight;
3993 }
3994
3995 sub _pkg_category {
3996   my $categoryname = shift;
3997   $pkg_category_cache{$categoryname} ||=
3998     qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
3999 }
4000
4001 my %condensed_format = (
4002   'label' => [ qw( Description Qty Amount ) ],
4003   'fields' => [
4004                 sub { shift->{description} },
4005                 sub { shift->{quantity} },
4006                 sub { my($href, %opt) = @_;
4007                       ($opt{dollar} || ''). $href->{amount};
4008                     },
4009               ],
4010   'align'  => [ qw( l r r ) ],
4011   'span'   => [ qw( 5 1 1 ) ],            # unitprices?
4012   'width'  => [ qw( 10.7cm 1.4cm 1.6cm ) ],   # don't like this
4013 );
4014
4015 sub _condense_section {
4016   my ( $self, $format ) = ( shift, shift );
4017   ( 'condensed' => 1,
4018     map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
4019       qw( description_generator
4020           header_generator
4021           total_generator
4022           total_line_generator
4023         )
4024   );
4025 }
4026
4027 sub _condensed_generator_defaults {
4028   my ( $self, $format ) = ( shift, shift );
4029   return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
4030 }
4031
4032 my %html_align = (
4033   'c' => 'center',
4034   'l' => 'left',
4035   'r' => 'right',
4036 );
4037
4038 sub _condensed_header_generator {
4039   my ( $self, $format ) = ( shift, shift );
4040
4041   my ( $f, $prefix, $suffix, $separator, $column ) =
4042     _condensed_generator_defaults($format);
4043
4044   if ($format eq 'latex') {
4045     $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
4046     $suffix = "\\\\\n\\hline";
4047     $separator = "&\n";
4048     $column =
4049       sub { my ($d,$a,$s,$w) = @_;
4050             return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
4051           };
4052   } elsif ( $format eq 'html' ) {
4053     $prefix = '<th></th>';
4054     $suffix = '';
4055     $separator = '';
4056     $column =
4057       sub { my ($d,$a,$s,$w) = @_;
4058             return qq!<th align="$html_align{$a}">$d</th>!;
4059       };
4060   }
4061
4062   sub {
4063     my @args = @_;
4064     my @result = ();
4065
4066     foreach  (my $i = 0; $f->{label}->[$i]; $i++) {
4067       push @result,
4068         &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
4069     }
4070
4071     $prefix. join($separator, @result). $suffix;
4072   };
4073
4074 }
4075
4076 sub _condensed_description_generator {
4077   my ( $self, $format ) = ( shift, shift );
4078
4079   my ( $f, $prefix, $suffix, $separator, $column ) =
4080     _condensed_generator_defaults($format);
4081
4082   my $money_char = '$';
4083   if ($format eq 'latex') {
4084     $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
4085     $suffix = '\\\\';
4086     $separator = " & \n";
4087     $column =
4088       sub { my ($d,$a,$s,$w) = @_;
4089             return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
4090           };
4091     $money_char = '\\dollar';
4092   }elsif ( $format eq 'html' ) {
4093     $prefix = '"><td align="center"></td>';
4094     $suffix = '';
4095     $separator = '';
4096     $column =
4097       sub { my ($d,$a,$s,$w) = @_;
4098             return qq!<td align="$html_align{$a}">$d</td>!;
4099       };
4100     #$money_char = $conf->config('money_char') || '$';
4101     $money_char = '';  # this is madness
4102   }
4103
4104   sub {
4105     #my @args = @_;
4106     my $href = shift;
4107     my @result = ();
4108
4109     foreach  (my $i = 0; $f->{label}->[$i]; $i++) {
4110       my $dollar = '';
4111       $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
4112       push @result,
4113         &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
4114                     map { $f->{$_}->[$i] } qw(align span width)
4115                   );
4116     }
4117
4118     $prefix. join( $separator, @result ). $suffix;
4119   };
4120
4121 }
4122
4123 sub _condensed_total_generator {
4124   my ( $self, $format ) = ( shift, shift );
4125
4126   my ( $f, $prefix, $suffix, $separator, $column ) =
4127     _condensed_generator_defaults($format);
4128   my $style = '';
4129
4130   if ($format eq 'latex') {
4131     $prefix = "& ";
4132     $suffix = "\\\\\n";
4133     $separator = " & \n";
4134     $column =
4135       sub { my ($d,$a,$s,$w) = @_;
4136             return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
4137           };
4138   }elsif ( $format eq 'html' ) {
4139     $prefix = '';
4140     $suffix = '';
4141     $separator = '';
4142     $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
4143     $column =
4144       sub { my ($d,$a,$s,$w) = @_;
4145             return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
4146       };
4147   }
4148
4149
4150   sub {
4151     my @args = @_;
4152     my @result = ();
4153
4154     #  my $r = &{$f->{fields}->[$i]}(@args);
4155     #  $r .= ' Total' unless $i;
4156
4157     foreach  (my $i = 0; $f->{label}->[$i]; $i++) {
4158       push @result,
4159         &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
4160                     map { $f->{$_}->[$i] } qw(align span width)
4161                   );
4162     }
4163
4164     $prefix. join( $separator, @result ). $suffix;
4165   };
4166
4167 }
4168
4169 =item total_line_generator FORMAT
4170
4171 Returns a coderef used for generation of invoice total line items for this
4172 usage_class.  FORMAT is either html or latex
4173
4174 =cut
4175
4176 # should not be used: will have issues with hash element names (description vs
4177 # total_item and amount vs total_amount -- another array of functions?
4178
4179 sub _condensed_total_line_generator {
4180   my ( $self, $format ) = ( shift, shift );
4181
4182   my ( $f, $prefix, $suffix, $separator, $column ) =
4183     _condensed_generator_defaults($format);
4184   my $style = '';
4185
4186   if ($format eq 'latex') {
4187     $prefix = "& ";
4188     $suffix = "\\\\\n";
4189     $separator = " & \n";
4190     $column =
4191       sub { my ($d,$a,$s,$w) = @_;
4192             return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
4193           };
4194   }elsif ( $format eq 'html' ) {
4195     $prefix = '';
4196     $suffix = '';
4197     $separator = '';
4198     $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
4199     $column =
4200       sub { my ($d,$a,$s,$w) = @_;
4201             return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
4202       };
4203   }
4204
4205
4206   sub {
4207     my @args = @_;
4208     my @result = ();
4209
4210     foreach  (my $i = 0; $f->{label}->[$i]; $i++) {
4211       push @result,
4212         &{$column}( &{$f->{fields}->[$i]}(@args),
4213                     map { $f->{$_}->[$i] } qw(align span width)
4214                   );
4215     }
4216
4217     $prefix. join( $separator, @result ). $suffix;
4218   };
4219
4220 }
4221
4222 #sub _items_extra_usage_sections {
4223 #  my $self = shift;
4224 #  my $escape = shift;
4225 #
4226 #  my %sections = ();
4227 #
4228 #  my %usage_class =  map{ $_->classname, $_ } qsearch('usage_class', {});
4229 #  foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
4230 #  {
4231 #    next unless $cust_bill_pkg->pkgnum > 0;
4232 #
4233 #    foreach my $section ( keys %usage_class ) {
4234 #
4235 #      my $usage = $cust_bill_pkg->usage($section);
4236 #
4237 #      next unless $usage && $usage > 0;
4238 #
4239 #      $sections{$section} ||= 0;
4240 #      $sections{$section} += $usage;
4241 #
4242 #    }
4243 #
4244 #  }
4245 #
4246 #  map { { 'description' => &{$escape}($_),
4247 #          'subtotal'    => $sections{$_},
4248 #          'summarized'  => '',
4249 #          'tax_section' => '',
4250 #        }
4251 #      }
4252 #    sort {$usage_class{$a}->weight <=> $usage_class{$b}->weight} keys %sections;
4253 #
4254 #}
4255
4256 sub _items_extra_usage_sections {
4257   my $self = shift;
4258   my $conf = $self->conf;
4259   my $escape = shift;
4260   my $format = shift;
4261
4262   my %sections = ();
4263   my %classnums = ();
4264   my %lines = ();
4265
4266   my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
4267
4268   my %usage_class =  map { $_->classnum => $_ } qsearch( 'usage_class', {} );
4269   foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
4270     next unless $cust_bill_pkg->pkgnum > 0;
4271
4272     foreach my $classnum ( keys %usage_class ) {
4273       my $section = $usage_class{$classnum}->classname;
4274       $classnums{$section} = $classnum;
4275
4276       foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail($classnum) ) {
4277         my $amount = $detail->amount;
4278         next unless $amount && $amount > 0;
4279
4280         $sections{$section} ||= { 'subtotal'=>0, 'calls'=>0, 'duration'=>0 };
4281         $sections{$section}{amount} += $amount;  #subtotal
4282         $sections{$section}{calls}++;
4283         $sections{$section}{duration} += $detail->duration;
4284
4285         my $desc = $detail->regionname;
4286         my $description = $desc;
4287         $description = substr($desc, 0, $maxlength). '...'
4288           if $format eq 'latex' && length($desc) > $maxlength;
4289
4290         $lines{$section}{$desc} ||= {
4291           description     => &{$escape}($description),
4292           #pkgpart         => $part_pkg->pkgpart,
4293           pkgnum          => $cust_bill_pkg->pkgnum,
4294           ref             => '',
4295           amount          => 0,
4296           calls           => 0,
4297           duration        => 0,
4298           #unit_amount     => $cust_bill_pkg->unitrecur,
4299           quantity        => $cust_bill_pkg->quantity,
4300           product_code    => 'N/A',
4301           ext_description => [],
4302         };
4303
4304         $lines{$section}{$desc}{amount} += $amount;
4305         $lines{$section}{$desc}{calls}++;
4306         $lines{$section}{$desc}{duration} += $detail->duration;
4307
4308       }
4309     }
4310   }
4311
4312   my %sectionmap = ();
4313   foreach (keys %sections) {
4314     my $usage_class = $usage_class{$classnums{$_}};
4315     $sectionmap{$_} = { 'description' => &{$escape}($_),
4316                         'amount'    => $sections{$_}{amount},    #subtotal
4317                         'calls'       => $sections{$_}{calls},
4318                         'duration'    => $sections{$_}{duration},
4319                         'summarized'  => '',
4320                         'tax_section' => '',
4321                         'sort_weight' => $usage_class->weight,
4322                         ( $usage_class->format
4323                           ? ( map { $_ => $usage_class->$_($format) }
4324                               qw( description_generator header_generator total_generator total_line_generator )
4325                             )
4326                           : ()
4327                         ),
4328                       };
4329   }
4330
4331   my @sections = sort { $a->{sort_weight} <=> $b->{sort_weight} }
4332                  values %sectionmap;
4333
4334   my @lines = ();
4335   foreach my $section ( keys %lines ) {
4336     foreach my $line ( keys %{$lines{$section}} ) {
4337       my $l = $lines{$section}{$line};
4338       $l->{section}     = $sectionmap{$section};
4339       $l->{amount}      = sprintf( "%.2f", $l->{amount} );
4340       #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
4341       push @lines, $l;
4342     }
4343   }
4344
4345   return(\@sections, \@lines);
4346
4347 }
4348
4349 sub _did_summary {
4350     my $self = shift;
4351     my $end = $self->_date;
4352
4353     # start at date of previous invoice + 1 second or 0 if no previous invoice
4354     my $start = $self->scalar_sql("SELECT max(_date) FROM cust_bill WHERE custnum = ? and invnum != ?",$self->custnum,$self->invnum);
4355     $start = 0 if !$start;
4356     $start++;
4357
4358     my $cust_main = $self->cust_main;
4359     my @pkgs = $cust_main->all_pkgs;
4360     my($num_activated,$num_deactivated,$num_portedin,$num_portedout,$minutes)
4361         = (0,0,0,0,0);
4362     my @seen = ();
4363     foreach my $pkg ( @pkgs ) {
4364         my @h_cust_svc = $pkg->h_cust_svc($end);
4365         foreach my $h_cust_svc ( @h_cust_svc ) {
4366             next if grep {$_ eq $h_cust_svc->svcnum} @seen;
4367             next unless $h_cust_svc->part_svc->svcdb eq 'svc_phone';
4368
4369             my $inserted = $h_cust_svc->date_inserted;
4370             my $deleted = $h_cust_svc->date_deleted;
4371             my $phone_inserted = $h_cust_svc->h_svc_x($inserted+5);
4372             my $phone_deleted;
4373             $phone_deleted =  $h_cust_svc->h_svc_x($deleted) if $deleted;
4374
4375 # DID either activated or ported in; cannot be both for same DID simultaneously
4376             if ($inserted >= $start && $inserted <= $end && $phone_inserted
4377                 && (!$phone_inserted->lnp_status
4378                     || $phone_inserted->lnp_status eq ''
4379                     || $phone_inserted->lnp_status eq 'native')) {
4380                 $num_activated++;
4381             }
4382             else { # this one not so clean, should probably move to (h_)svc_phone
4383                  my $phone_portedin = qsearchs( 'h_svc_phone',
4384                       { 'svcnum' => $h_cust_svc->svcnum,
4385                         'lnp_status' => 'portedin' },
4386                       FS::h_svc_phone->sql_h_searchs($end),
4387                     );
4388                  $num_portedin++ if $phone_portedin;
4389             }
4390
4391 # DID either deactivated or ported out; cannot be both for same DID simultaneously
4392             if($deleted >= $start && $deleted <= $end && $phone_deleted
4393                 && (!$phone_deleted->lnp_status
4394                     || $phone_deleted->lnp_status ne 'portingout')) {
4395                 $num_deactivated++;
4396             }
4397             elsif($deleted >= $start && $deleted <= $end && $phone_deleted
4398                 && $phone_deleted->lnp_status
4399                 && $phone_deleted->lnp_status eq 'portingout') {
4400                 $num_portedout++;
4401             }
4402
4403             # increment usage minutes
4404         if ( $phone_inserted ) {
4405             my @cdrs = $phone_inserted->get_cdrs('begin'=>$start,'end'=>$end,'billsec_sum'=>1);
4406             $minutes = $cdrs[0]->billsec_sum if scalar(@cdrs) == 1;
4407         }
4408         else {
4409             warn "WARNING: no matching h_svc_phone insert record for insert time $inserted, svcnum " . $h_cust_svc->svcnum;
4410         }
4411
4412             # don't look at this service again
4413             push @seen, $h_cust_svc->svcnum;
4414         }
4415     }
4416
4417     $minutes = sprintf("%d", $minutes);
4418     ("Activated: $num_activated  Ported-In: $num_portedin  Deactivated: "
4419         . "$num_deactivated  Ported-Out: $num_portedout ",
4420             "Total Minutes: $minutes");
4421 }
4422
4423 sub _items_accountcode_cdr {
4424     my $self = shift;
4425     my $escape = shift;
4426     my $format = shift;
4427
4428     my $section = { 'amount'        => 0,
4429                     'calls'         => 0,
4430                     'duration'      => 0,
4431                     'sort_weight'   => '',
4432                     'phonenum'      => '',
4433                     'description'   => 'Usage by Account Code',
4434                     'post_total'    => '',
4435                     'summarized'    => '',
4436                     'header'        => '',
4437                   };
4438     my @lines;
4439     my %accountcodes = ();
4440
4441     foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
4442         next unless $cust_bill_pkg->pkgnum > 0;
4443
4444         my @header = $cust_bill_pkg->details_header;
4445         next unless scalar(@header);
4446         $section->{'header'} = join(',',@header);
4447
4448         foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
4449
4450             $section->{'header'} = $detail->formatted('format' => $format)
4451                 if($detail->detail eq $section->{'header'});
4452
4453             my $accountcode = $detail->accountcode;
4454             next unless $accountcode;
4455
4456             my $amount = $detail->amount;
4457             next unless $amount && $amount > 0;
4458
4459             $accountcodes{$accountcode} ||= {
4460                     description => $accountcode,
4461                     pkgnum      => '',
4462                     ref         => '',
4463                     amount      => 0,
4464                     calls       => 0,
4465                     duration    => 0,
4466                     quantity    => '',
4467                     product_code => 'N/A',
4468                     section     => $section,
4469                     ext_description => [ $section->{'header'} ],
4470                     detail_temp => [],
4471             };
4472
4473             $section->{'amount'} += $amount;
4474             $accountcodes{$accountcode}{'amount'} += $amount;
4475             $accountcodes{$accountcode}{calls}++;
4476             $accountcodes{$accountcode}{duration} += $detail->duration;
4477             push @{$accountcodes{$accountcode}{detail_temp}}, $detail;
4478         }
4479     }
4480
4481     foreach my $l ( values %accountcodes ) {
4482         $l->{amount} = sprintf( "%.2f", $l->{amount} );
4483         my @sorted_detail = sort { $a->startdate <=> $b->startdate } @{$l->{detail_temp}};
4484         foreach my $sorted_detail ( @sorted_detail ) {
4485             push @{$l->{ext_description}}, $sorted_detail->formatted('format'=>$format);
4486         }
4487         delete $l->{detail_temp};
4488         push @lines, $l;
4489     }
4490
4491     my @sorted_lines = sort { $a->{'description'} <=> $b->{'description'} } @lines;
4492
4493     return ($section,\@sorted_lines);
4494 }
4495
4496 sub _items_svc_phone_sections {
4497   my $self = shift;
4498   my $conf = $self->conf;
4499   my $escape = shift;
4500   my $format = shift;
4501
4502   my %sections = ();
4503   my %classnums = ();
4504   my %lines = ();
4505
4506   my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
4507
4508   my %usage_class =  map { $_->classnum => $_ } qsearch( 'usage_class', {} );
4509   $usage_class{''} ||= new FS::usage_class { 'classname' => '', 'weight' => 0 };
4510
4511   foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
4512     next unless $cust_bill_pkg->pkgnum > 0;
4513
4514     my @header = $cust_bill_pkg->details_header;
4515     next unless scalar(@header);
4516
4517     foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
4518
4519       my $phonenum = $detail->phonenum;
4520       next unless $phonenum;
4521
4522       my $amount = $detail->amount;
4523       next unless $amount && $amount > 0;
4524
4525       $sections{$phonenum} ||= { 'amount'      => 0,
4526                                  'calls'       => 0,
4527                                  'duration'    => 0,
4528                                  'sort_weight' => -1,
4529                                  'phonenum'    => $phonenum,
4530                                 };
4531       $sections{$phonenum}{amount} += $amount;  #subtotal
4532       $sections{$phonenum}{calls}++;
4533       $sections{$phonenum}{duration} += $detail->duration;
4534
4535       my $desc = $detail->regionname;
4536       my $description = $desc;
4537       $description = substr($desc, 0, $maxlength). '...'
4538         if $format eq 'latex' && length($desc) > $maxlength;
4539
4540       $lines{$phonenum}{$desc} ||= {
4541         description     => &{$escape}($description),
4542         #pkgpart         => $part_pkg->pkgpart,
4543         pkgnum          => '',
4544         ref             => '',
4545         amount          => 0,
4546         calls           => 0,
4547         duration        => 0,
4548         #unit_amount     => '',
4549         quantity        => '',
4550         product_code    => 'N/A',
4551         ext_description => [],
4552       };
4553
4554       $lines{$phonenum}{$desc}{amount} += $amount;
4555       $lines{$phonenum}{$desc}{calls}++;
4556       $lines{$phonenum}{$desc}{duration} += $detail->duration;
4557
4558       my $line = $usage_class{$detail->classnum}->classname;
4559       $sections{"$phonenum $line"} ||=
4560         { 'amount' => 0,
4561           'calls' => 0,
4562           'duration' => 0,
4563           'sort_weight' => $usage_class{$detail->classnum}->weight,
4564           'phonenum' => $phonenum,
4565           'header'  => [ @header ],
4566         };
4567       $sections{"$phonenum $line"}{amount} += $amount;  #subtotal
4568       $sections{"$phonenum $line"}{calls}++;
4569       $sections{"$phonenum $line"}{duration} += $detail->duration;
4570
4571       $lines{"$phonenum $line"}{$desc} ||= {
4572         description     => &{$escape}($description),
4573         #pkgpart         => $part_pkg->pkgpart,
4574         pkgnum          => '',
4575         ref             => '',
4576         amount          => 0,
4577         calls           => 0,
4578         duration        => 0,
4579         #unit_amount     => '',
4580         quantity        => '',
4581         product_code    => 'N/A',
4582         ext_description => [],
4583       };
4584
4585       $lines{"$phonenum $line"}{$desc}{amount} += $amount;
4586       $lines{"$phonenum $line"}{$desc}{calls}++;
4587       $lines{"$phonenum $line"}{$desc}{duration} += $detail->duration;
4588       push @{$lines{"$phonenum $line"}{$desc}{ext_description}},
4589            $detail->formatted('format' => $format);
4590
4591     }
4592   }
4593
4594   my %sectionmap = ();
4595   my $simple = new FS::usage_class { format => 'simple' }; #bleh
4596   foreach ( keys %sections ) {
4597     my @header = @{ $sections{$_}{header} || [] };
4598     my $usage_simple =
4599       new FS::usage_class { format => 'usage_'. (scalar(@header) || 6). 'col' };
4600     my $summary = $sections{$_}{sort_weight} < 0 ? 1 : 0;
4601     my $usage_class = $summary ? $simple : $usage_simple;
4602     my $ending = $summary ? ' usage charges' : '';
4603     my %gen_opt = ();
4604     unless ($summary) {
4605       $gen_opt{label} = [ map{ &{$escape}($_) } @header ];
4606     }
4607     $sectionmap{$_} = { 'description' => &{$escape}($_. $ending),
4608                         'amount'    => $sections{$_}{amount},    #subtotal
4609                         'calls'       => $sections{$_}{calls},
4610                         'duration'    => $sections{$_}{duration},
4611                         'summarized'  => '',
4612                         'tax_section' => '',
4613                         'phonenum'    => $sections{$_}{phonenum},
4614                         'sort_weight' => $sections{$_}{sort_weight},
4615                         'post_total'  => $summary, #inspire pagebreak
4616                         (
4617                           ( map { $_ => $usage_class->$_($format, %gen_opt) }
4618                             qw( description_generator
4619                                 header_generator
4620                                 total_generator
4621                                 total_line_generator
4622                               )
4623                           )
4624                         ),
4625                       };
4626   }
4627
4628   my @sections = sort { $a->{phonenum} cmp $b->{phonenum} ||
4629                         $a->{sort_weight} <=> $b->{sort_weight}
4630                       }
4631                  values %sectionmap;
4632
4633   my @lines = ();
4634   foreach my $section ( keys %lines ) {
4635     foreach my $line ( keys %{$lines{$section}} ) {
4636       my $l = $lines{$section}{$line};
4637       $l->{section}     = $sectionmap{$section};
4638       $l->{amount}      = sprintf( "%.2f", $l->{amount} );
4639       #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
4640       push @lines, $l;
4641     }
4642   }
4643
4644   if($conf->exists('phone_usage_class_summary')) {
4645       # this only works with Latex
4646       my @newlines;
4647       my @newsections;
4648
4649       # after this, we'll have only two sections per DID:
4650       # Calls Summary and Calls Detail
4651       foreach my $section ( @sections ) {
4652         if($section->{'post_total'}) {
4653             $section->{'description'} = 'Calls Summary: '.$section->{'phonenum'};
4654             $section->{'total_line_generator'} = sub { '' };
4655             $section->{'total_generator'} = sub { '' };
4656             $section->{'header_generator'} = sub { '' };
4657             $section->{'description_generator'} = '';
4658             push @newsections, $section;
4659             my %calls_detail = %$section;
4660             $calls_detail{'post_total'} = '';
4661             $calls_detail{'sort_weight'} = '';
4662             $calls_detail{'description_generator'} = sub { '' };
4663             $calls_detail{'header_generator'} = sub {
4664                 return ' & Date/Time & Called Number & Duration & Price'
4665                     if $format eq 'latex';
4666                 '';
4667             };
4668             $calls_detail{'description'} = 'Calls Detail: '
4669                                                     . $section->{'phonenum'};
4670             push @newsections, \%calls_detail;
4671         }
4672       }
4673
4674       # after this, each usage class is collapsed/summarized into a single
4675       # line under the Calls Summary section
4676       foreach my $newsection ( @newsections ) {
4677         if($newsection->{'post_total'}) { # this means Calls Summary
4678             foreach my $section ( @sections ) {
4679                 next unless ($section->{'phonenum'} eq $newsection->{'phonenum'}
4680                                 && !$section->{'post_total'});
4681                 my $newdesc = $section->{'description'};
4682                 my $tn = $section->{'phonenum'};
4683                 $newdesc =~ s/$tn//g;
4684                 my $line = {  ext_description => [],
4685                               pkgnum => '',
4686                               ref => '',
4687                               quantity => '',
4688                               calls => $section->{'calls'},
4689                               section => $newsection,
4690                               duration => $section->{'duration'},
4691                               description => $newdesc,
4692                               amount => sprintf("%.2f",$section->{'amount'}),
4693                               product_code => 'N/A',
4694                             };
4695                 push @newlines, $line;
4696             }
4697         }
4698       }
4699
4700       # after this, Calls Details is populated with all CDRs
4701       foreach my $newsection ( @newsections ) {
4702         if(!$newsection->{'post_total'}) { # this means Calls Details
4703             foreach my $line ( @lines ) {
4704                 next unless (scalar(@{$line->{'ext_description'}}) &&
4705                         $line->{'section'}->{'phonenum'} eq $newsection->{'phonenum'}
4706                             );
4707                 my @extdesc = @{$line->{'ext_description'}};
4708                 my @newextdesc;
4709                 foreach my $extdesc ( @extdesc ) {
4710                     $extdesc =~ s/scriptsize/normalsize/g if $format eq 'latex';
4711                     push @newextdesc, $extdesc;
4712                 }
4713                 $line->{'ext_description'} = \@newextdesc;
4714                 $line->{'section'} = $newsection;
4715                 push @newlines, $line;
4716             }
4717         }
4718       }
4719
4720       return(\@newsections, \@newlines);
4721   }
4722
4723   return(\@sections, \@lines);
4724
4725 }
4726
4727 sub _items { # seems to be unused
4728   my $self = shift;
4729
4730   #my @display = scalar(@_)
4731   #              ? @_
4732   #              : qw( _items_previous _items_pkg );
4733   #              #: qw( _items_pkg );
4734   #              #: qw( _items_previous _items_pkg _items_tax _items_credits _items_payments );
4735   my @display = qw( _items_previous _items_pkg );
4736
4737   my @b = ();
4738   foreach my $display ( @display ) {
4739     push @b, $self->$display(@_);
4740   }
4741   @b;
4742 }
4743
4744 sub _items_previous {
4745   my $self = shift;
4746   my $conf = $self->conf;
4747   my $cust_main = $self->cust_main;
4748   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
4749   my @b = ();
4750   foreach ( @pr_cust_bill ) {
4751     my $date = $conf->exists('invoice_show_prior_due_date')
4752                ? 'due '. $_->due_date2str($date_format)
4753                : time2str($date_format, $_->_date);
4754     push @b, {
4755       'description' => $self->mt('Previous Balance, Invoice #'). $_->invnum. " ($date)",
4756       #'pkgpart'     => 'N/A',
4757       'pkgnum'      => 'N/A',
4758       'amount'      => sprintf("%.2f", $_->owed),
4759     };
4760   }
4761   @b;
4762
4763   #{
4764   #    'description'     => 'Previous Balance',
4765   #    #'pkgpart'         => 'N/A',
4766   #    'pkgnum'          => 'N/A',
4767   #    'amount'          => sprintf("%10.2f", $pr_total ),
4768   #    'ext_description' => [ map {
4769   #                                 "Invoice ". $_->invnum.
4770   #                                 " (". time2str("%x",$_->_date). ") ".
4771   #                                 sprintf("%10.2f", $_->owed)
4772   #                         } @pr_cust_bill ],
4773
4774   #};
4775 }
4776
4777 =item _items_pkg [ OPTIONS ]
4778
4779 Return line item hashes for each package item on this invoice. Nearly
4780 equivalent to
4781
4782 $self->_items_cust_bill_pkg([ $self->cust_bill_pkg ])
4783
4784 The only OPTIONS accepted is 'section', which may point to a hashref
4785 with a key named 'condensed', which may have a true value.  If it
4786 does, this method tries to merge identical items into items with
4787 'quantity' equal to the number of items (not the sum of their
4788 separate quantities, for some reason).
4789
4790 =cut
4791
4792 sub _items_pkg {
4793   my $self = shift;
4794   my %options = @_;
4795
4796   warn "$me _items_pkg searching for all package line items\n"
4797     if $DEBUG > 1;
4798
4799   my @cust_bill_pkg = grep { $_->pkgnum } $self->cust_bill_pkg;
4800
4801   warn "$me _items_pkg filtering line items\n"
4802     if $DEBUG > 1;
4803   my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
4804
4805   if ($options{section} && $options{section}->{condensed}) {
4806
4807     warn "$me _items_pkg condensing section\n"
4808       if $DEBUG > 1;
4809
4810     my %itemshash = ();
4811     local $Storable::canonical = 1;
4812     foreach ( @items ) {
4813       my $item = { %$_ };
4814       delete $item->{ref};
4815       delete $item->{ext_description};
4816       my $key = freeze($item);
4817       $itemshash{$key} ||= 0;
4818       $itemshash{$key} ++; # += $item->{quantity};
4819     }
4820     @items = sort { $a->{description} cmp $b->{description} }
4821              map { my $i = thaw($_);
4822                    $i->{quantity} = $itemshash{$_};
4823                    $i->{amount} =
4824                      sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
4825                    $i;
4826                  }
4827              keys %itemshash;
4828   }
4829
4830   warn "$me _items_pkg returning ". scalar(@items). " items\n"
4831     if $DEBUG > 1;
4832
4833   @items;
4834 }
4835
4836 sub _taxsort {
4837   return 0 unless $a->itemdesc cmp $b->itemdesc;
4838   return -1 if $b->itemdesc eq 'Tax';
4839   return 1 if $a->itemdesc eq 'Tax';
4840   return -1 if $b->itemdesc eq 'Other surcharges';
4841   return 1 if $a->itemdesc eq 'Other surcharges';
4842   $a->itemdesc cmp $b->itemdesc;
4843 }
4844
4845 sub _items_tax {
4846   my $self = shift;
4847   my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum } $self->cust_bill_pkg;
4848   $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
4849 }
4850
4851 =item _items_cust_bill_pkg CUST_BILL_PKGS OPTIONS
4852
4853 Takes an arrayref of L<FS::cust_bill_pkg> objects, and returns a
4854 list of hashrefs describing the line items they generate on the invoice.
4855
4856 OPTIONS may include:
4857
4858 format: the invoice format.
4859
4860 escape_function: the function used to escape strings.
4861
4862 DEPRECATED? (expensive, mostly unused?)
4863 format_function: the function used to format CDRs.
4864
4865 section: a hashref containing 'description'; if this is present,
4866 cust_bill_pkg_display records not belonging to this section are
4867 ignored.
4868
4869 multisection: a flag indicating that this is a multisection invoice,
4870 which does something complicated.
4871
4872 multilocation: a flag to display the location label for the package.
4873
4874 Returns a list of hashrefs, each of which may contain:
4875
4876 pkgnum, description, amount, unit_amount, quantity, _is_setup, and
4877 ext_description, which is an arrayref of detail lines to show below
4878 the package line.
4879
4880 =cut
4881
4882 sub _items_cust_bill_pkg {
4883   my $self = shift;
4884   my $conf = $self->conf;
4885   my $cust_bill_pkgs = shift;
4886   my %opt = @_;
4887
4888   my $format = $opt{format} || '';
4889   my $escape_function = $opt{escape_function} || sub { shift };
4890   my $format_function = $opt{format_function} || '';
4891   my $no_usage = $opt{no_usage} || '';
4892   my $unsquelched = $opt{unsquelched} || ''; #unused
4893   my $section = $opt{section}->{description} if $opt{section};
4894   my $summary_page = $opt{summary_page} || ''; #unused
4895   my $multilocation = $opt{multilocation} || '';
4896   my $multisection = $opt{multisection} || '';
4897   my $discount_show_always = 0;
4898
4899   my $maxlength = $conf->config('cust_bill-latex_lineitem_maxlength') || 50;
4900
4901   my $cust_main = $self->cust_main;#for per-agent cust_bill-line_item-ate_style
4902
4903   my @b = ();
4904   my ($s, $r, $u) = ( undef, undef, undef );
4905   foreach my $cust_bill_pkg ( @$cust_bill_pkgs )
4906   {
4907
4908     foreach ( $s, $r, ($opt{skip_usage} ? () : $u ) ) {
4909       if ( $_ && !$cust_bill_pkg->hidden ) {
4910         $_->{amount}      = sprintf( "%.2f", $_->{amount} ),
4911         $_->{amount}      =~ s/^\-0\.00$/0.00/;
4912         $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} ),
4913         push @b, { %$_ }
4914           if $_->{amount} != 0
4915           || $discount_show_always
4916           || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
4917           || (   $_->{_is_setup} && $_->{setup_show_zero} )
4918         ;
4919         $_ = undef;
4920       }
4921     }
4922
4923     my @cust_bill_pkg_display = $cust_bill_pkg->cust_bill_pkg_display;
4924
4925     warn "$me _items_cust_bill_pkg considering cust_bill_pkg ".
4926          $cust_bill_pkg->billpkgnum. ", pkgnum ". $cust_bill_pkg->pkgnum. "\n"
4927       if $DEBUG > 1;
4928
4929     foreach my $display ( grep { defined($section)
4930                                  ? $_->section eq $section
4931                                  : 1
4932                                }
4933                           #grep { !$_->summary || !$summary_page } # bunk!
4934                           grep { !$_->summary || $multisection }
4935                           @cust_bill_pkg_display
4936                         )
4937     {
4938
4939       warn "$me _items_cust_bill_pkg considering cust_bill_pkg_display ".
4940            $display->billpkgdisplaynum. "\n"
4941         if $DEBUG > 1;
4942
4943       my $type = $display->type;
4944
4945       my $desc = $cust_bill_pkg->desc;
4946       $desc = substr($desc, 0, $maxlength). '...'
4947         if $format eq 'latex' && length($desc) > $maxlength;
4948
4949       my %details_opt = ( 'format'          => $format,
4950                           'escape_function' => $escape_function,
4951                           'format_function' => $format_function,
4952                           'no_usage'        => $opt{'no_usage'},
4953                         );
4954
4955       if ( $cust_bill_pkg->pkgnum > 0 ) {
4956
4957         warn "$me _items_cust_bill_pkg cust_bill_pkg is non-tax\n"
4958           if $DEBUG > 1;
4959
4960         my $cust_pkg = $cust_bill_pkg->cust_pkg;
4961
4962         # start/end dates for invoice formats that do nonstandard
4963         # things with them
4964         my %item_dates = map { $_ => $cust_bill_pkg->$_ } ('sdate', 'edate');
4965
4966         if (    (!$type || $type eq 'S')
4967              && (    $cust_bill_pkg->setup != 0
4968                   || $cust_bill_pkg->setup_show_zero
4969                 )
4970            )
4971          {
4972
4973           warn "$me _items_cust_bill_pkg adding setup\n"
4974             if $DEBUG > 1;
4975
4976           my $description = $desc;
4977           $description .= ' Setup'
4978             if $cust_bill_pkg->recur != 0
4979             || $discount_show_always
4980             || $cust_bill_pkg->recur_show_zero;
4981
4982           my @d = ();
4983           unless ( $cust_pkg->part_pkg->hide_svc_detail
4984                 || $cust_bill_pkg->hidden )
4985           {
4986
4987             push @d, map &{$escape_function}($_),
4988                          $cust_pkg->h_labels_short($self->_date, undef, 'I')
4989               unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
4990
4991             if ( $multilocation ) {
4992               my $loc = $cust_pkg->location_label;
4993               $loc = substr($loc, 0, $maxlength). '...'
4994                 if $format eq 'latex' && length($loc) > $maxlength;
4995               push @d, &{$escape_function}($loc);
4996             }
4997
4998           } #unless hiding service details
4999
5000           push @d, $cust_bill_pkg->details(%details_opt)
5001             if $cust_bill_pkg->recur == 0;
5002
5003           if ( $cust_bill_pkg->hidden ) {
5004             $s->{amount}      += $cust_bill_pkg->setup;
5005             $s->{unit_amount} += $cust_bill_pkg->unitsetup;
5006             push @{ $s->{ext_description} }, @d;
5007           } else {
5008             $s = {
5009               _is_setup       => 1,
5010               description     => $description,
5011               #pkgpart         => $part_pkg->pkgpart,
5012               pkgnum          => $cust_bill_pkg->pkgnum,
5013               amount          => $cust_bill_pkg->setup,
5014               setup_show_zero => $cust_bill_pkg->setup_show_zero,
5015               unit_amount     => $cust_bill_pkg->unitsetup,
5016               quantity        => $cust_bill_pkg->quantity,
5017               ext_description => \@d,
5018             };
5019           };
5020
5021         }
5022
5023         if (    ( !$type || $type eq 'R' || $type eq 'U' )
5024              && (
5025                      $cust_bill_pkg->recur != 0
5026                   || $cust_bill_pkg->setup == 0
5027                   || $discount_show_always
5028                   || $cust_bill_pkg->recur_show_zero
5029                 )
5030            )
5031         {
5032
5033           warn "$me _items_cust_bill_pkg adding recur/usage\n"
5034             if $DEBUG > 1;
5035
5036           my $is_summary = $display->summary;
5037           my $description = ($is_summary && $type && $type eq 'U')
5038                             ? "Usage charges" : $desc;
5039
5040           #pry be a bit more efficient to look some of this conf stuff up
5041           # outside the loop
5042           unless (
5043             $conf->exists('disable_line_item_date_ranges')
5044               || $cust_pkg->part_pkg->option('disable_line_item_date_ranges',1)
5045           ) {
5046             my $time_period;
5047             my $date_style = $conf->config( 'cust_bill-line_item-date_style',
5048                                             $cust_main->agentnum
5049                                           );
5050             if ( defined($date_style) && $date_style eq 'month_of' ) {
5051               $time_period = time2str('The month of %B', $cust_bill_pkg->sdate);
5052             } elsif ( defined($date_style) && $date_style eq 'X_month' ) {
5053               my $desc = $conf->config( 'cust_bill-line_item-date_description',
5054                                          $cust_main->agentnum
5055                                       );
5056               $desc .= ' ' unless $desc =~ /\s$/;
5057               $time_period = $desc. time2str('%B', $cust_bill_pkg->sdate);
5058             } else {
5059               $time_period =      time2str($date_format, $cust_bill_pkg->sdate).
5060                            " - ". time2str($date_format, $cust_bill_pkg->edate);
5061             }
5062             $description .= " ($time_period)";
5063           }
5064
5065           my @d = ();
5066           my @seconds = (); # for display of usage info
5067
5068           #at least until cust_bill_pkg has "past" ranges in addition to
5069           #the "future" sdate/edate ones... see #3032
5070           my @dates = ( $self->_date );
5071           my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
5072           push @dates, $prev->sdate if $prev;
5073           push @dates, undef if !$prev;
5074
5075           unless ( $cust_pkg->part_pkg->hide_svc_detail
5076                 || $cust_bill_pkg->itemdesc
5077                 || $cust_bill_pkg->hidden
5078                 || $is_summary && $type && $type eq 'U' )
5079           {
5080
5081             warn "$me _items_cust_bill_pkg adding service details\n"
5082               if $DEBUG > 1;
5083
5084             push @d, map &{$escape_function}($_),
5085                          $cust_pkg->h_labels_short(@dates, 'I')
5086                                                    #$cust_bill_pkg->edate,
5087                                                    #$cust_bill_pkg->sdate)
5088               unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
5089
5090             warn "$me _items_cust_bill_pkg done adding service details\n"
5091               if $DEBUG > 1;
5092
5093             if ( $multilocation ) {
5094               my $loc = $cust_pkg->location_label;
5095               $loc = substr($loc, 0, $maxlength). '...'
5096                 if $format eq 'latex' && length($loc) > $maxlength;
5097               push @d, &{$escape_function}($loc);
5098             }
5099
5100             # Display of seconds_since_sqlradacct:
5101             # On the invoice, when processing @detail_items, look for a field
5102             # named 'seconds'.  This will contain total seconds for each
5103             # service, in the same order as @ext_description.  For services
5104             # that don't support this it will show undef.
5105             if ( $conf->exists('svc_acct-usage_seconds')
5106                  and ! $cust_bill_pkg->pkgpart_override ) {
5107               foreach my $cust_svc (
5108                   $cust_pkg->h_cust_svc(@dates, 'I')
5109                 ) {
5110
5111                 # eval because not having any part_export_usage exports
5112                 # is a fatal error, last_bill/_date because that's how
5113                 # sqlradius_hour billing does it
5114                 my $sec = eval {
5115                   $cust_svc->seconds_since_sqlradacct($dates[1] || 0, $dates[0]);
5116                 };
5117                 push @seconds, $sec;
5118               }
5119             } #if svc_acct-usage_seconds
5120
5121           }
5122
5123           unless ( $is_summary ) {
5124             warn "$me _items_cust_bill_pkg adding details\n"
5125               if $DEBUG > 1;
5126
5127             #instead of omitting details entirely in this case (unwanted side
5128             # effects), just omit CDRs
5129             $details_opt{'no_usage'} = 1
5130               if $type && $type eq 'R';
5131
5132             push @d, $cust_bill_pkg->details(%details_opt);
5133           }
5134
5135           warn "$me _items_cust_bill_pkg calculating amount\n"
5136             if $DEBUG > 1;
5137
5138           my $amount = 0;
5139           if (!$type) {
5140             $amount = $cust_bill_pkg->recur;
5141           } elsif ($type eq 'R') {
5142             $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
5143           } elsif ($type eq 'U') {
5144             $amount = $cust_bill_pkg->usage;
5145           }
5146
5147           if ( !$type || $type eq 'R' ) {
5148
5149             warn "$me _items_cust_bill_pkg adding recur\n"
5150               if $DEBUG > 1;
5151
5152             if ( $cust_bill_pkg->hidden ) {
5153               $r->{amount}      += $amount;
5154               $r->{unit_amount} += $cust_bill_pkg->unitrecur;
5155               push @{ $r->{ext_description} }, @d;
5156             } else {
5157               $r = {
5158                 description     => $description,
5159                 #pkgpart         => $part_pkg->pkgpart,
5160                 pkgnum          => $cust_bill_pkg->pkgnum,
5161                 amount          => $amount,
5162                 recur_show_zero => $cust_bill_pkg->recur_show_zero,
5163                 unit_amount     => $cust_bill_pkg->unitrecur,
5164                 quantity        => $cust_bill_pkg->quantity,
5165                 %item_dates,
5166                 ext_description => \@d,
5167               };
5168               $r->{'seconds'} = \@seconds if grep {defined $_} @seconds;
5169             }
5170
5171           } else {  # $type eq 'U'
5172
5173             warn "$me _items_cust_bill_pkg adding usage\n"
5174               if $DEBUG > 1;
5175
5176             if ( $cust_bill_pkg->hidden ) {
5177               $u->{amount}      += $amount;
5178               $u->{unit_amount} += $cust_bill_pkg->unitrecur;
5179               push @{ $u->{ext_description} }, @d;
5180             } else {
5181               $u = {
5182                 description     => $description,
5183                 #pkgpart         => $part_pkg->pkgpart,
5184                 pkgnum          => $cust_bill_pkg->pkgnum,
5185                 amount          => $amount,
5186                 recur_show_zero => $cust_bill_pkg->recur_show_zero,
5187                 unit_amount     => $cust_bill_pkg->unitrecur,
5188                 quantity        => $cust_bill_pkg->quantity,
5189                 %item_dates,
5190                 ext_description => \@d,
5191               };
5192             }
5193           }
5194
5195         } # recurring or usage with recurring charge
5196
5197       } else { #pkgnum tax or one-shot line item (??)
5198
5199         warn "$me _items_cust_bill_pkg cust_bill_pkg is tax\n"
5200           if $DEBUG > 1;
5201
5202         if ( $cust_bill_pkg->setup != 0 ) {
5203           push @b, {
5204             'description' => $desc,
5205             'amount'      => sprintf("%.2f", $cust_bill_pkg->setup),
5206           };
5207         }
5208         if ( $cust_bill_pkg->recur != 0 ) {
5209           push @b, {
5210             'description' => "$desc (".
5211                              time2str($date_format, $cust_bill_pkg->sdate). ' - '.
5212                              time2str($date_format, $cust_bill_pkg->edate). ')',
5213             'amount'      => sprintf("%.2f", $cust_bill_pkg->recur),
5214           };
5215         }
5216
5217       }
5218
5219     }
5220
5221     $discount_show_always = ($cust_bill_pkg->cust_bill_pkg_discount
5222                                 && $conf->exists('discount-show-always'));
5223
5224   }
5225
5226   foreach ( $s, $r, ($opt{skip_usage} ? () : $u ) ) {
5227     if ( $_  ) {
5228       $_->{amount}      = sprintf( "%.2f", $_->{amount} ),
5229       $_->{amount}      =~ s/^\-0\.00$/0.00/;
5230       $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} ),
5231       push @b, { %$_ }
5232         if $_->{amount} != 0
5233         || $discount_show_always
5234         || ( ! $_->{_is_setup} && $_->{recur_show_zero} )
5235         || (   $_->{_is_setup} && $_->{setup_show_zero} )
5236     }
5237   }
5238
5239   warn "$me _items_cust_bill_pkg done considering cust_bill_pkgs\n"
5240     if $DEBUG > 1;
5241
5242   @b;
5243
5244 }
5245
5246 sub _items_credits {
5247   my( $self, %opt ) = @_;
5248   my $trim_len = $opt{'trim_len'} || 60;
5249
5250   my @b;
5251   #credits
5252   foreach ( $self->cust_credited ) {
5253
5254     #something more elaborate if $_->amount ne $_->cust_credit->credited ?
5255
5256     my $reason = substr($_->cust_credit->reason, 0, $trim_len);
5257     $reason .= '...' if length($reason) < length($_->cust_credit->reason);
5258     $reason = " ($reason) " if $reason;
5259
5260     push @b, {
5261       #'description' => 'Credit ref\#'. $_->crednum.
5262       #                 " (". time2str("%x",$_->cust_credit->_date) .")".
5263       #                 $reason,
5264       'description' => $self->mt('Credit applied').' '.
5265                        time2str($date_format,$_->cust_credit->_date). $reason,
5266       'amount'      => sprintf("%.2f",$_->amount),
5267     };
5268   }
5269
5270   @b;
5271
5272 }
5273
5274 sub _items_payments {
5275   my $self = shift;
5276
5277   my @b;
5278   #get & print payments
5279   foreach ( $self->cust_bill_pay ) {
5280
5281     #something more elaborate if $_->amount ne ->cust_pay->paid ?
5282
5283     push @b, {
5284       'description' => $self->mt('Payment received').' '.
5285                        time2str($date_format,$_->cust_pay->_date ),
5286       'amount'      => sprintf("%.2f", $_->amount )
5287     };
5288   }
5289
5290   @b;
5291
5292 }
5293
5294 =item _items_discounts_avail
5295
5296 Returns an array of line item hashrefs representing available term discounts
5297 for this invoice.  This makes the same assumptions that apply to term
5298 discounts in general: that the package is billed monthly, at a flat rate,
5299 with no usage charges.  A prorated first month will be handled, as will
5300 a setup fee if the discount is allowed to apply to setup fees.
5301
5302 =cut
5303
5304 sub _items_discounts_avail {
5305   my $self = shift;
5306   my $list_pkgnums = 0; # if any packages are not eligible for all discounts
5307
5308   my %plans = $self->discount_plans;
5309
5310   $list_pkgnums = grep { $_->list_pkgnums } values %plans;
5311
5312   map {
5313     my $months = $_;
5314     my $plan = $plans{$months};
5315
5316     my $term_total = sprintf('%.2f', $plan->discounted_total);
5317     my $percent = sprintf('%.0f',
5318                           100 * (1 - $term_total / $plan->base_total) );
5319     my $permonth = sprintf('%.2f', $term_total / $months);
5320     my $detail = $self->mt('discount on item'). ' '.
5321                  join(', ', map { "#$_" } $plan->pkgnums)
5322       if $list_pkgnums;
5323
5324     # discounts for non-integer months don't work anyway
5325     $months = sprintf("%d", $months);
5326
5327     +{
5328       description => $self->mt('Save [_1]% by paying for [_2] months',
5329                                 $percent, $months),
5330       amount      => $self->mt('[_1] ([_2] per month)',
5331                                 $term_total, $money_char.$permonth),
5332       ext_description => ($detail || ''),
5333     }
5334   } #map
5335   sort { $b <=> $a } keys %plans;
5336
5337 }
5338
5339 =item call_details [ OPTION => VALUE ... ]
5340
5341 Returns an array of CSV strings representing the call details for this invoice
5342 The only option available is the boolean prepend_billed_number
5343
5344 =cut
5345
5346 sub call_details {
5347   my ($self, %opt) = @_;
5348
5349   my $format_function = sub { shift };
5350
5351   if ($opt{prepend_billed_number}) {
5352     $format_function = sub {
5353       my $detail = shift;
5354       my $row = shift;
5355
5356       $row->amount ? $row->phonenum. ",". $detail : '"Billed number",'. $detail;
5357
5358     };
5359   }
5360
5361   my @details = map { $_->details( 'format_function' => $format_function,
5362                                    'escape_function' => sub{ return() },
5363                                  )
5364                     }
5365                   grep { $_->pkgnum }
5366                   $self->cust_bill_pkg;
5367   my $header = $details[0];
5368   ( $header, grep { $_ ne $header } @details );
5369 }
5370
5371
5372 =back
5373
5374 =head1 SUBROUTINES
5375
5376 =over 4
5377
5378 =item process_reprint
5379
5380 =cut
5381
5382 sub process_reprint {
5383   process_re_X('print', @_);
5384 }
5385
5386 =item process_reemail
5387
5388 =cut
5389
5390 sub process_reemail {
5391   process_re_X('email', @_);
5392 }
5393
5394 =item process_refax
5395
5396 =cut
5397
5398 sub process_refax {
5399   process_re_X('fax', @_);
5400 }
5401
5402 =item process_reftp
5403
5404 =cut
5405
5406 sub process_reftp {
5407   process_re_X('ftp', @_);
5408 }
5409
5410 =item respool
5411
5412 =cut
5413
5414 sub process_respool {
5415   process_re_X('spool', @_);
5416 }
5417
5418 use Storable qw(thaw);
5419 use Data::Dumper;
5420 use MIME::Base64;
5421 sub process_re_X {
5422   my( $method, $job ) = ( shift, shift );
5423   warn "$me process_re_X $method for job $job\n" if $DEBUG;
5424
5425   my $param = thaw(decode_base64(shift));
5426   warn Dumper($param) if $DEBUG;
5427
5428   re_X(
5429     $method,
5430     $job,
5431     %$param,
5432   );
5433
5434 }
5435
5436 sub re_X {
5437   my($method, $job, %param ) = @_;
5438   if ( $DEBUG ) {
5439     warn "re_X $method for job $job with param:\n".
5440          join( '', map { "  $_ => ". $param{$_}. "\n" } keys %param );
5441   }
5442
5443   #some false laziness w/search/cust_bill.html
5444   my $distinct = '';
5445   my $orderby = 'ORDER BY cust_bill._date';
5446
5447   my $extra_sql = ' WHERE '. FS::cust_bill->search_sql_where(\%param);
5448
5449   my $addl_from = 'LEFT JOIN cust_main USING ( custnum )';
5450
5451   my @cust_bill = qsearch( {
5452     #'select'    => "cust_bill.*",
5453     'table'     => 'cust_bill',
5454     'addl_from' => $addl_from,
5455     'hashref'   => {},
5456     'extra_sql' => $extra_sql,
5457     'order_by'  => $orderby,
5458     'debug' => 1,
5459   } );
5460
5461   $method .= '_invoice' unless $method eq 'email' || $method eq 'print';
5462
5463   warn " $me re_X $method: ". scalar(@cust_bill). " invoices found\n"
5464     if $DEBUG;
5465
5466   my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
5467   foreach my $cust_bill ( @cust_bill ) {
5468     $cust_bill->$method();
5469
5470     if ( $job ) { #progressbar foo
5471       $num++;
5472       if ( time - $min_sec > $last ) {
5473         my $error = $job->update_statustext(
5474           int( 100 * $num / scalar(@cust_bill) )
5475         );
5476         die $error if $error;
5477         $last = time;
5478       }
5479     }
5480
5481   }
5482
5483 }
5484
5485 =back
5486
5487 =head1 CLASS METHODS
5488
5489 =over 4
5490
5491 =item owed_sql
5492
5493 Returns an SQL fragment to retreive the amount owed (charged minus credited and paid).
5494
5495 =cut
5496
5497 sub owed_sql {
5498   my ($class, $start, $end) = @_;
5499   'charged - '.
5500     $class->paid_sql($start, $end). ' - '.
5501     $class->credited_sql($start, $end);
5502 }
5503
5504 =item net_sql
5505
5506 Returns an SQL fragment to retreive the net amount (charged minus credited).
5507
5508 =cut
5509
5510 sub net_sql {
5511   my ($class, $start, $end) = @_;
5512   'charged - '. $class->credited_sql($start, $end);
5513 }
5514
5515 =item paid_sql
5516
5517 Returns an SQL fragment to retreive the amount paid against this invoice.
5518
5519 =cut
5520
5521 sub paid_sql {
5522   my ($class, $start, $end) = @_;
5523   $start &&= "AND cust_bill_pay._date <= $start";
5524   $end   &&= "AND cust_bill_pay._date > $end";
5525   $start = '' unless defined($start);
5526   $end   = '' unless defined($end);
5527   "( SELECT COALESCE(SUM(amount),0) FROM cust_bill_pay
5528        WHERE cust_bill.invnum = cust_bill_pay.invnum $start $end  )";
5529 }
5530
5531 =item credited_sql
5532
5533 Returns an SQL fragment to retreive the amount credited against this invoice.
5534
5535 =cut
5536
5537 sub credited_sql {
5538   my ($class, $start, $end) = @_;
5539   $start &&= "AND cust_credit_bill._date <= $start";
5540   $end   &&= "AND cust_credit_bill._date >  $end";
5541   $start = '' unless defined($start);
5542   $end   = '' unless defined($end);
5543   "( SELECT COALESCE(SUM(amount),0) FROM cust_credit_bill
5544        WHERE cust_bill.invnum = cust_credit_bill.invnum $start $end  )";
5545 }
5546
5547 =item due_date_sql
5548
5549 Returns an SQL fragment to retrieve the due date of an invoice.
5550 Currently only supported on PostgreSQL.
5551
5552 =cut
5553
5554 sub due_date_sql {
5555   my $conf = new FS::Conf;
5556 'COALESCE(
5557   SUBSTRING(
5558     COALESCE(
5559       cust_bill.invoice_terms,
5560       cust_main.invoice_terms,
5561       \''.($conf->config('invoice_default_terms') || '').'\'
5562     ), E\'Net (\\\\d+)\'
5563   )::INTEGER, 0
5564 ) * 86400 + cust_bill._date'
5565 }
5566
5567 =item search_sql_where HASHREF
5568
5569 Class method which returns an SQL WHERE fragment to search for parameters
5570 specified in HASHREF.  Valid parameters are
5571
5572 =over 4
5573
5574 =item _date
5575
5576 List reference of start date, end date, as UNIX timestamps.
5577
5578 =item invnum_min
5579
5580 =item invnum_max
5581
5582 =item agentnum
5583
5584 =item charged
5585
5586 List reference of charged limits (exclusive).
5587
5588 =item owed
5589
5590 List reference of charged limits (exclusive).
5591
5592 =item open
5593
5594 flag, return open invoices only
5595
5596 =item net
5597
5598 flag, return net invoices only
5599
5600 =item days
5601
5602 =item newest_percust
5603
5604 =back
5605
5606 Note: validates all passed-in data; i.e. safe to use with unchecked CGI params.
5607
5608 =cut
5609
5610 sub search_sql_where {
5611   my($class, $param) = @_;
5612   if ( $DEBUG ) {
5613     warn "$me search_sql_where called with params: \n".
5614          join("\n", map { "  $_: ". $param->{$_} } keys %$param ). "\n";
5615   }
5616
5617   my @search = ();
5618
5619   #agentnum
5620   if ( $param->{'agentnum'} =~ /^(\d+)$/ ) {
5621     push @search, "cust_main.agentnum = $1";
5622   }
5623
5624   #agentnum
5625   if ( $param->{'custnum'} =~ /^(\d+)$/ ) {
5626     push @search, "cust_bill.custnum = $1";
5627   }
5628
5629   #_date
5630   if ( $param->{_date} ) {
5631     my($beginning, $ending) = @{$param->{_date}};
5632
5633     push @search, "cust_bill._date >= $beginning",
5634                   "cust_bill._date <  $ending";
5635   }
5636
5637   #invnum
5638   if ( $param->{'invnum_min'} =~ /^(\d+)$/ ) {
5639     push @search, "cust_bill.invnum >= $1";
5640   }
5641   if ( $param->{'invnum_max'} =~ /^(\d+)$/ ) {
5642     push @search, "cust_bill.invnum <= $1";
5643   }
5644
5645   #charged
5646   if ( $param->{charged} ) {
5647     my @charged = ref($param->{charged})
5648                     ? @{ $param->{charged} }
5649                     : ($param->{charged});
5650
5651     push @search, map { s/^charged/cust_bill.charged/; $_; }
5652                       @charged;
5653   }
5654
5655   my $owed_sql = FS::cust_bill->owed_sql;
5656
5657   #owed
5658   if ( $param->{owed} ) {
5659     my @owed = ref($param->{owed})
5660                  ? @{ $param->{owed} }
5661                  : ($param->{owed});
5662     push @search, map { s/^owed/$owed_sql/; $_; }
5663                       @owed;
5664   }
5665
5666   #open/net flags
5667   push @search, "0 != $owed_sql"
5668     if $param->{'open'};
5669   push @search, '0 != '. FS::cust_bill->net_sql
5670     if $param->{'net'};
5671
5672   #days
5673   push @search, "cust_bill._date < ". (time-86400*$param->{'days'})
5674     if $param->{'days'};
5675
5676   #newest_percust
5677   if ( $param->{'newest_percust'} ) {
5678
5679     #$distinct = 'DISTINCT ON ( cust_bill.custnum )';
5680     #$orderby = 'ORDER BY cust_bill.custnum ASC, cust_bill._date DESC';
5681
5682     my @newest_where = map { my $x = $_;
5683                              $x =~ s/\bcust_bill\./newest_cust_bill./g;
5684                              $x;
5685                            }
5686                            grep ! /^cust_main./, @search;
5687     my $newest_where = scalar(@newest_where)
5688                          ? ' AND '. join(' AND ', @newest_where)
5689                          : '';
5690
5691
5692     push @search, "cust_bill._date = (
5693       SELECT(MAX(newest_cust_bill._date)) FROM cust_bill AS newest_cust_bill
5694         WHERE newest_cust_bill.custnum = cust_bill.custnum
5695           $newest_where
5696     )";
5697
5698   }
5699
5700   #promised_date - also has an option to accept nulls
5701   if ( $param->{promised_date} ) {
5702     my($beginning, $ending, $null) = @{$param->{promised_date}};
5703
5704     push @search, "(( cust_bill.promised_date >= $beginning AND ".
5705                     "cust_bill.promised_date <  $ending )" .
5706                     ($null ? ' OR cust_bill.promised_date IS NULL ) ' : ')');
5707   }
5708
5709   #agent virtualization
5710   my $curuser = $FS::CurrentUser::CurrentUser;
5711   if ( $curuser->username eq 'fs_queue'
5712        && $param->{'CurrentUser'} =~ /^(\w+)$/ ) {
5713     my $username = $1;
5714     my $newuser = qsearchs('access_user', {
5715       'username' => $username,
5716       'disabled' => '',
5717     } );
5718     if ( $newuser ) {
5719       $curuser = $newuser;
5720     } else {
5721       warn "$me WARNING: (fs_queue) can't find CurrentUser $username\n";
5722     }
5723   }
5724   push @search, $curuser->agentnums_sql;
5725
5726   join(' AND ', @search );
5727
5728 }
5729
5730 =back
5731
5732 =head1 BUGS
5733
5734 The delete method.
5735
5736 =head1 SEE ALSO
5737
5738 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
5739 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base
5740 documentation.
5741
5742 =cut
5743
5744 1;
5745