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