f07834297eeb99c4bb755d4460b044afbc23bbe5
[freeside.git] / FS / FS / cust_bill.pm
1 package FS::cust_bill;
2
3 use strict;
4 use vars qw( @ISA $DEBUG $me $conf
5              $money_char $date_format $rdate_format $date_format_long );
6 use vars qw( $invoice_lines @buf ); #yuck
7 use Fcntl qw(:flock); #for spool_csv
8 use List::Util qw(min max);
9 use Date::Format;
10 use Text::Template 1.20;
11 use File::Temp 0.14;
12 use String::ShellQuote;
13 use HTML::Entities;
14 use Locale::Country;
15 use Storable qw( freeze thaw );
16 use FS::UID qw( datasrc );
17 use FS::Misc qw( send_email send_fax generate_ps generate_pdf do_print );
18 use FS::Record qw( qsearch qsearchs dbh );
19 use FS::cust_main_Mixin;
20 use FS::cust_main;
21 use FS::cust_statement;
22 use FS::cust_bill_pkg;
23 use FS::cust_bill_pkg_display;
24 use FS::cust_bill_pkg_detail;
25 use FS::cust_credit;
26 use FS::cust_pay;
27 use FS::cust_pkg;
28 use FS::cust_credit_bill;
29 use FS::pay_batch;
30 use FS::cust_pay_batch;
31 use FS::cust_bill_event;
32 use FS::cust_event;
33 use FS::part_pkg;
34 use FS::cust_bill_pay;
35 use FS::cust_bill_pay_batch;
36 use FS::part_bill_event;
37 use FS::payby;
38 use FS::bill_batch;
39 use FS::cust_bill_batch;
40
41 @ISA = qw( FS::cust_main_Mixin FS::Record );
42
43 $DEBUG = 0;
44 $me = '[FS::cust_bill]';
45
46 #ask FS::UID to run this stuff for us later
47 FS::UID->install_callback( sub { 
48   $conf = new FS::Conf;
49   $money_char       = $conf->config('money_char')       || '$';  
50   $date_format      = $conf->config('date_format')      || '%x'; #/YY
51   $rdate_format     = $conf->config('date_format')      || '%m/%d/%Y';  #/YYYY
52   $date_format_long = $conf->config('date_format_long') || '%b %o, %Y';
53 } );
54
55 =head1 NAME
56
57 FS::cust_bill - Object methods for cust_bill records
58
59 =head1 SYNOPSIS
60
61   use FS::cust_bill;
62
63   $record = new FS::cust_bill \%hash;
64   $record = new FS::cust_bill { 'column' => 'value' };
65
66   $error = $record->insert;
67
68   $error = $new_record->replace($old_record);
69
70   $error = $record->delete;
71
72   $error = $record->check;
73
74   ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
75
76   @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
77
78   ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
79
80   @cust_pay_objects = $cust_bill->cust_pay;
81
82   $tax_amount = $record->tax;
83
84   @lines = $cust_bill->print_text;
85   @lines = $cust_bill->print_text $time;
86
87 =head1 DESCRIPTION
88
89 An FS::cust_bill object represents an invoice; a declaration that a customer
90 owes you money.  The specific charges are itemized as B<cust_bill_pkg> records
91 (see L<FS::cust_bill_pkg>).  FS::cust_bill inherits from FS::Record.  The
92 following fields are currently supported:
93
94 Regular fields
95
96 =over 4
97
98 =item invnum - primary key (assigned automatically for new invoices)
99
100 =item custnum - customer (see L<FS::cust_main>)
101
102 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
103 L<Time::Local> and L<Date::Parse> for conversion functions.
104
105 =item charged - amount of this invoice
106
107 =item invoice_terms - optional terms override for this specific invoice
108
109 =back
110
111 Customer info at invoice generation time
112
113 =over 4
114
115 =item previous_balance
116
117 =item billing_balance
118
119 =back
120
121 Deprecated
122
123 =over 4
124
125 =item printed - deprecated
126
127 =back
128
129 Specific use cases
130
131 =over 4
132
133 =item closed - books closed flag, empty or `Y'
134
135 =item statementnum - invoice aggregation (see L<FS::cust_statement>)
136
137 =item agent_invid - legacy invoice number
138
139 =back
140
141 =head1 METHODS
142
143 =over 4
144
145 =item new HASHREF
146
147 Creates a new invoice.  To add the invoice to the database, see L<"insert">.
148 Invoices are normally created by calling the bill method of a customer object
149 (see L<FS::cust_main>).
150
151 =cut
152
153 sub table { 'cust_bill'; }
154
155 sub cust_linked { $_[0]->cust_main_custnum; } 
156 sub cust_unlinked_msg {
157   my $self = shift;
158   "WARNING: can't find cust_main.custnum ". $self->custnum.
159   ' (cust_bill.invnum '. $self->invnum. ')';
160 }
161
162 =item insert
163
164 Adds this invoice to the database ("Posts" the invoice).  If there is an error,
165 returns the error, otherwise returns false.
166
167 =cut
168
169 sub insert {
170   my $self = shift;
171   warn "$me insert called\n" if $DEBUG;
172
173   local $SIG{HUP} = 'IGNORE';
174   local $SIG{INT} = 'IGNORE';
175   local $SIG{QUIT} = 'IGNORE';
176   local $SIG{TERM} = 'IGNORE';
177   local $SIG{TSTP} = 'IGNORE';
178   local $SIG{PIPE} = 'IGNORE';
179
180   my $oldAutoCommit = $FS::UID::AutoCommit;
181   local $FS::UID::AutoCommit = 0;
182   my $dbh = dbh;
183
184   my $error = $self->SUPER::insert;
185   if ( $error ) {
186     $dbh->rollback if $oldAutoCommit;
187     return $error;
188   }
189
190   if ( $self->get('cust_bill_pkg') ) {
191     foreach my $cust_bill_pkg ( @{$self->get('cust_bill_pkg')} ) {
192       $cust_bill_pkg->invnum($self->invnum);
193       my $error = $cust_bill_pkg->insert;
194       if ( $error ) {
195         $dbh->rollback if $oldAutoCommit;
196         return "can't create invoice line item: $error";
197       }
198     }
199   }
200
201   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
202   '';
203
204 }
205
206 =item delete
207
208 This method now works but you probably shouldn't use it.  Instead, apply a
209 credit against the invoice.
210
211 Using this method to delete invoices outright is really, really bad.  There
212 would be no record you ever posted this invoice, and there are no check to
213 make sure charged = 0 or that there are no associated cust_bill_pkg records.
214
215 Really, don't use it.
216
217 =cut
218
219 sub delete {
220   my $self = shift;
221   return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
222
223   local $SIG{HUP} = 'IGNORE';
224   local $SIG{INT} = 'IGNORE';
225   local $SIG{QUIT} = 'IGNORE';
226   local $SIG{TERM} = 'IGNORE';
227   local $SIG{TSTP} = 'IGNORE';
228   local $SIG{PIPE} = 'IGNORE';
229
230   my $oldAutoCommit = $FS::UID::AutoCommit;
231   local $FS::UID::AutoCommit = 0;
232   my $dbh = dbh;
233
234   foreach my $table (qw(
235     cust_bill_event
236     cust_event
237     cust_credit_bill
238     cust_bill_pay
239     cust_bill_pay
240     cust_credit_bill
241     cust_pay_batch
242     cust_bill_pay_batch
243     cust_bill_pkg
244   )) {
245
246     foreach my $linked ( $self->$table() ) {
247       my $error = $linked->delete;
248       if ( $error ) {
249         $dbh->rollback if $oldAutoCommit;
250         return $error;
251       }
252     }
253
254   }
255
256   my $error = $self->SUPER::delete(@_);
257   if ( $error ) {
258     $dbh->rollback if $oldAutoCommit;
259     return $error;
260   }
261
262   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
263
264   '';
265
266 }
267
268 =item replace [ OLD_RECORD ]
269
270 You can, but probably shouldn't modify invoices...
271
272 Replaces the OLD_RECORD with this one in the database, or, if OLD_RECORD is not
273 supplied, replaces this record.  If there is an error, returns the error,
274 otherwise returns false.
275
276 =cut
277
278 #replace can be inherited from Record.pm
279
280 # replace_check is now the preferred way to #implement replace data checks
281 # (so $object->replace() works without an argument)
282
283 sub replace_check {
284   my( $new, $old ) = ( shift, shift );
285   return "Can't modify closed invoice" if $old->closed =~ /^Y/i;
286   #return "Can't change _date!" unless $old->_date eq $new->_date;
287   return "Can't change _date" unless $old->_date == $new->_date;
288   return "Can't change charged" unless $old->charged == $new->charged
289                                     || $old->charged == 0;
290
291   '';
292 }
293
294 =item check
295
296 Checks all fields to make sure this is a valid invoice.  If there is an error,
297 returns the error, otherwise returns false.  Called by the insert and replace
298 methods.
299
300 =cut
301
302 sub check {
303   my $self = shift;
304
305   my $error =
306     $self->ut_numbern('invnum')
307     || $self->ut_foreign_key('custnum', 'cust_main', 'custnum' )
308     || $self->ut_numbern('_date')
309     || $self->ut_money('charged')
310     || $self->ut_numbern('printed')
311     || $self->ut_enum('closed', [ '', 'Y' ])
312     || $self->ut_foreign_keyn('statementnum', 'cust_statement', 'statementnum' )
313     || $self->ut_numbern('agent_invid') #varchar?
314   ;
315   return $error if $error;
316
317   $self->_date(time) unless $self->_date;
318
319   $self->printed(0) if $self->printed eq '';
320
321   $self->SUPER::check;
322 }
323
324 =item display_invnum
325
326 Returns the displayed invoice number for this invoice: agent_invid if
327 cust_bill-default_agent_invid is set and it has a value, invnum otherwise.
328
329 =cut
330
331 sub display_invnum {
332   my $self = shift;
333   if ( $conf->exists('cust_bill-default_agent_invid') && $self->agent_invid ){
334     return $self->agent_invid;
335   } else {
336     return $self->invnum;
337   }
338 }
339
340 =item previous
341
342 Returns a list consisting of the total previous balance for this customer, 
343 followed by the previous outstanding invoices (as FS::cust_bill objects also).
344
345 =cut
346
347 sub previous {
348   my $self = shift;
349   my $total = 0;
350   my @cust_bill = sort { $a->_date <=> $b->_date }
351     grep { $_->owed != 0 && $_->_date < $self->_date }
352       qsearch( 'cust_bill', { 'custnum' => $self->custnum } ) 
353   ;
354   foreach ( @cust_bill ) { $total += $_->owed; }
355   $total, @cust_bill;
356 }
357
358 =item cust_bill_pkg
359
360 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
361
362 =cut
363
364 sub cust_bill_pkg {
365   my $self = shift;
366   qsearch(
367     { 'table'    => 'cust_bill_pkg',
368       'hashref'  => { 'invnum' => $self->invnum },
369       'order_by' => 'ORDER BY billpkgnum',
370     }
371   );
372 }
373
374 =item cust_bill_pkg_pkgnum PKGNUM
375
376 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice and
377 specified pkgnum.
378
379 =cut
380
381 sub cust_bill_pkg_pkgnum {
382   my( $self, $pkgnum ) = @_;
383   qsearch(
384     { 'table'    => 'cust_bill_pkg',
385       'hashref'  => { 'invnum' => $self->invnum,
386                       'pkgnum' => $pkgnum,
387                     },
388       'order_by' => 'ORDER BY billpkgnum',
389     }
390   );
391 }
392
393 =item cust_pkg
394
395 Returns the packages (see L<FS::cust_pkg>) corresponding to the line items for
396 this invoice.
397
398 =cut
399
400 sub cust_pkg {
401   my $self = shift;
402   my @cust_pkg = map { $_->pkgnum > 0 ? $_->cust_pkg : () }
403                      $self->cust_bill_pkg;
404   my %saw = ();
405   grep { ! $saw{$_->pkgnum}++ } @cust_pkg;
406 }
407
408 =item no_auto
409
410 Returns true if any of the packages (or their definitions) corresponding to the
411 line items for this invoice have the no_auto flag set.
412
413 =cut
414
415 sub no_auto {
416   my $self = shift;
417   grep { $_->no_auto || $_->part_pkg->no_auto } $self->cust_pkg;
418 }
419
420 =item open_cust_bill_pkg
421
422 Returns the open line items for this invoice.
423
424 Note that cust_bill_pkg with both setup and recur fees are returned as two
425 separate line items, each with only one fee.
426
427 =cut
428
429 # modeled after cust_main::open_cust_bill
430 sub open_cust_bill_pkg {
431   my $self = shift;
432
433   # grep { $_->owed > 0 } $self->cust_bill_pkg
434
435   my %other = ( 'recur' => 'setup',
436                 'setup' => 'recur', );
437   my @open = ();
438   foreach my $field ( qw( recur setup )) {
439     push @open, map  { $_->set( $other{$field}, 0 ); $_; }
440                 grep { $_->owed($field) > 0 }
441                 $self->cust_bill_pkg;
442   }
443
444   @open;
445 }
446
447 =item cust_bill_event
448
449 Returns the completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
450
451 =cut
452
453 sub cust_bill_event {
454   my $self = shift;
455   qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
456 }
457
458 =item num_cust_bill_event
459
460 Returns the number of completed invoice events (deprecated, old-style events - see L<FS::cust_bill_event>) for this invoice.
461
462 =cut
463
464 sub num_cust_bill_event {
465   my $self = shift;
466   my $sql =
467     "SELECT COUNT(*) FROM cust_bill_event WHERE invnum = ?";
468   my $sth = dbh->prepare($sql) or die  dbh->errstr. " preparing $sql"; 
469   $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
470   $sth->fetchrow_arrayref->[0];
471 }
472
473 =item cust_event
474
475 Returns the new-style customer billing events (see L<FS::cust_event>) for this invoice.
476
477 =cut
478
479 #false laziness w/cust_pkg.pm
480 sub cust_event {
481   my $self = shift;
482   qsearch({
483     'table'     => 'cust_event',
484     'addl_from' => 'JOIN part_event USING ( eventpart )',
485     'hashref'   => { 'tablenum' => $self->invnum },
486     'extra_sql' => " AND eventtable = 'cust_bill' ",
487   });
488 }
489
490 =item num_cust_event
491
492 Returns the number of new-style customer billing events (see L<FS::cust_event>) for this invoice.
493
494 =cut
495
496 #false laziness w/cust_pkg.pm
497 sub num_cust_event {
498   my $self = shift;
499   my $sql =
500     "SELECT COUNT(*) FROM cust_event JOIN part_event USING ( eventpart ) ".
501     "  WHERE tablenum = ? AND eventtable = 'cust_bill'";
502   my $sth = dbh->prepare($sql) or die  dbh->errstr. " preparing $sql"; 
503   $sth->execute($self->invnum) or die $sth->errstr. " executing $sql";
504   $sth->fetchrow_arrayref->[0];
505 }
506
507 =item cust_main
508
509 Returns the customer (see L<FS::cust_main>) for this invoice.
510
511 =cut
512
513 sub cust_main {
514   my $self = shift;
515   qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
516 }
517
518 =item cust_suspend_if_balance_over AMOUNT
519
520 Suspends the customer associated with this invoice if the total amount owed on
521 this invoice and all older invoices is greater than the specified amount.
522
523 Returns a list: an empty list on success or a list of errors.
524
525 =cut
526
527 sub cust_suspend_if_balance_over {
528   my( $self, $amount ) = ( shift, shift );
529   my $cust_main = $self->cust_main;
530   if ( $cust_main->total_owed_date($self->_date) < $amount ) {
531     return ();
532   } else {
533     $cust_main->suspend(@_);
534   }
535 }
536
537 =item cust_credit
538
539 Depreciated.  See the cust_credited method.
540
541  #Returns a list consisting of the total previous credited (see
542  #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
543  #outstanding credits (FS::cust_credit objects).
544
545 =cut
546
547 sub cust_credit {
548   use Carp;
549   croak "FS::cust_bill->cust_credit depreciated; see ".
550         "FS::cust_bill->cust_credit_bill";
551   #my $self = shift;
552   #my $total = 0;
553   #my @cust_credit = sort { $a->_date <=> $b->_date }
554   #  grep { $_->credited != 0 && $_->_date < $self->_date }
555   #    qsearch('cust_credit', { 'custnum' => $self->custnum } )
556   #;
557   #foreach (@cust_credit) { $total += $_->credited; }
558   #$total, @cust_credit;
559 }
560
561 =item cust_pay
562
563 Depreciated.  See the cust_bill_pay method.
564
565 #Returns all payments (see L<FS::cust_pay>) for this invoice.
566
567 =cut
568
569 sub cust_pay {
570   use Carp;
571   croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
572   #my $self = shift;
573   #sort { $a->_date <=> $b->_date }
574   #  qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
575   #;
576 }
577
578 sub cust_pay_batch {
579   my $self = shift;
580   qsearch('cust_pay_batch', { 'invnum' => $self->invnum } );
581 }
582
583 sub cust_bill_pay_batch {
584   my $self = shift;
585   qsearch('cust_bill_pay_batch', { 'invnum' => $self->invnum } );
586 }
587
588 =item cust_bill_pay
589
590 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
591
592 =cut
593
594 sub cust_bill_pay {
595   my $self = shift;
596   map { $_ } #return $self->num_cust_bill_pay unless wantarray;
597   sort { $a->_date <=> $b->_date }
598     qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
599 }
600
601 =item cust_credited
602
603 =item cust_credit_bill
604
605 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
606
607 =cut
608
609 sub cust_credited {
610   my $self = shift;
611   map { $_ } #return $self->num_cust_credit_bill unless wantarray;
612   sort { $a->_date <=> $b->_date }
613     qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
614   ;
615 }
616
617 sub cust_credit_bill {
618   shift->cust_credited(@_);
619 }
620
621 =item cust_bill_pay_pkgnum PKGNUM
622
623 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice
624 with matching pkgnum.
625
626 =cut
627
628 sub cust_bill_pay_pkgnum {
629   my( $self, $pkgnum ) = @_;
630   map { $_ } #return $self->num_cust_bill_pay_pkgnum($pkgnum) unless wantarray;
631   sort { $a->_date <=> $b->_date }
632     qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum,
633                                 'pkgnum' => $pkgnum,
634                               }
635            );
636 }
637
638 =item cust_credited_pkgnum PKGNUM
639
640 =item cust_credit_bill_pkgnum PKGNUM
641
642 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice
643 with matching pkgnum.
644
645 =cut
646
647 sub cust_credited_pkgnum {
648   my( $self, $pkgnum ) = @_;
649   map { $_ } #return $self->num_cust_credit_bill_pkgnum($pkgnum) unless wantarray;
650   sort { $a->_date <=> $b->_date }
651     qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum,
652                                    'pkgnum' => $pkgnum,
653                                  }
654            );
655 }
656
657 sub cust_credit_bill_pkgnum {
658   shift->cust_credited_pkgnum(@_);
659 }
660
661 =item tax
662
663 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
664
665 =cut
666
667 sub tax {
668   my $self = shift;
669   my $total = 0;
670   my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
671                                              'pkgnum' => 0 } );
672   foreach (@taxlines) { $total += $_->setup; }
673   $total;
674 }
675
676 =item owed
677
678 Returns the amount owed (still outstanding) on this invoice, which is charged
679 minus all payment applications (see L<FS::cust_bill_pay>) and credit
680 applications (see L<FS::cust_credit_bill>).
681
682 =cut
683
684 sub owed {
685   my $self = shift;
686   my $balance = $self->charged;
687   $balance -= $_->amount foreach ( $self->cust_bill_pay );
688   $balance -= $_->amount foreach ( $self->cust_credited );
689   $balance = sprintf( "%.2f", $balance);
690   $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
691   $balance;
692 }
693
694 sub owed_pkgnum {
695   my( $self, $pkgnum ) = @_;
696
697   #my $balance = $self->charged;
698   my $balance = 0;
699   $balance += $_->setup + $_->recur for $self->cust_bill_pkg_pkgnum($pkgnum);
700
701   $balance -= $_->amount            for $self->cust_bill_pay_pkgnum($pkgnum);
702   $balance -= $_->amount            for $self->cust_credited_pkgnum($pkgnum);
703
704   $balance = sprintf( "%.2f", $balance);
705   $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
706   $balance;
707 }
708
709 =item apply_payments_and_credits [ OPTION => VALUE ... ]
710
711 Applies unapplied payments and credits to this invoice.
712
713 A hash of optional arguments may be passed.  Currently "manual" is supported.
714 If true, a payment receipt is sent instead of a statement when
715 'payment_receipt_email' configuration option is set.
716
717 If there is an error, returns the error, otherwise returns false.
718
719 =cut
720
721 sub apply_payments_and_credits {
722   my( $self, %options ) = @_;
723
724   local $SIG{HUP} = 'IGNORE';
725   local $SIG{INT} = 'IGNORE';
726   local $SIG{QUIT} = 'IGNORE';
727   local $SIG{TERM} = 'IGNORE';
728   local $SIG{TSTP} = 'IGNORE';
729   local $SIG{PIPE} = 'IGNORE';
730
731   my $oldAutoCommit = $FS::UID::AutoCommit;
732   local $FS::UID::AutoCommit = 0;
733   my $dbh = dbh;
734
735   $self->select_for_update; #mutex
736
737   my @payments = grep { $_->unapplied > 0 } $self->cust_main->cust_pay;
738   my @credits  = grep { $_->credited > 0 } $self->cust_main->cust_credit;
739
740   if ( $conf->exists('pkg-balances') ) {
741     # limit @payments & @credits to those w/ a pkgnum grepped from $self
742     my %pkgnums = map { $_ => 1 } map $_->pkgnum, $self->cust_bill_pkg;
743     @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
744     @credits  = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
745   }
746
747   while ( $self->owed > 0 and ( @payments || @credits ) ) {
748
749     my $app = '';
750     if ( @payments && @credits ) {
751
752       #decide which goes first by weight of top (unapplied) line item
753
754       my @open_lineitems = $self->open_cust_bill_pkg;
755
756       my $max_pay_weight =
757         max( map  { $_->part_pkg->pay_weight || 0 }
758              grep { $_ }
759              map  { $_->cust_pkg }
760                   @open_lineitems
761            );
762       my $max_credit_weight =
763         max( map  { $_->part_pkg->credit_weight || 0 }
764              grep { $_ } 
765              map  { $_->cust_pkg }
766                   @open_lineitems
767            );
768
769       #if both are the same... payments first?  it has to be something
770       if ( $max_pay_weight >= $max_credit_weight ) {
771         $app = 'pay';
772       } else {
773         $app = 'credit';
774       }
775     
776     } elsif ( @payments ) {
777       $app = 'pay';
778     } elsif ( @credits ) {
779       $app = 'credit';
780     } else {
781       die "guru meditation #12 and 35";
782     }
783
784     my $unapp_amount;
785     if ( $app eq 'pay' ) {
786
787       my $payment = shift @payments;
788       $unapp_amount = $payment->unapplied;
789       $app = new FS::cust_bill_pay { 'paynum'  => $payment->paynum };
790       $app->pkgnum( $payment->pkgnum )
791         if $conf->exists('pkg-balances') && $payment->pkgnum;
792
793     } elsif ( $app eq 'credit' ) {
794
795       my $credit = shift @credits;
796       $unapp_amount = $credit->credited;
797       $app = new FS::cust_credit_bill { 'crednum' => $credit->crednum };
798       $app->pkgnum( $credit->pkgnum )
799         if $conf->exists('pkg-balances') && $credit->pkgnum;
800
801     } else {
802       die "guru meditation #12 and 35";
803     }
804
805     my $owed;
806     if ( $conf->exists('pkg-balances') && $app->pkgnum ) {
807       warn "owed_pkgnum ". $app->pkgnum;
808       $owed = $self->owed_pkgnum($app->pkgnum);
809     } else {
810       $owed = $self->owed;
811     }
812     next unless $owed > 0;
813
814     warn "min ( $unapp_amount, $owed )\n" if $DEBUG;
815     $app->amount( sprintf('%.2f', min( $unapp_amount, $owed ) ) );
816
817     $app->invnum( $self->invnum );
818
819     my $error = $app->insert(%options);
820     if ( $error ) {
821       $dbh->rollback if $oldAutoCommit;
822       return "Error inserting ". $app->table. " record: $error";
823     }
824     die $error if $error;
825
826   }
827
828   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
829   ''; #no error
830
831 }
832
833 =item generate_email OPTION => VALUE ...
834
835 Options:
836
837 =over 4
838
839 =item from
840
841 sender address, required
842
843 =item tempate
844
845 alternate template name, optional
846
847 =item print_text
848
849 text attachment arrayref, optional
850
851 =item subject
852
853 email subject, optional
854
855 =item notice_name
856
857 notice name instead of "Invoice", optional
858
859 =back
860
861 Returns an argument list to be passed to L<FS::Misc::send_email>.
862
863 =cut
864
865 use MIME::Entity;
866
867 sub generate_email {
868
869   my $self = shift;
870   my %args = @_;
871
872   my $me = '[FS::cust_bill::generate_email]';
873
874   my %return = (
875     'from'      => $args{'from'},
876     'subject'   => (($args{'subject'}) ? $args{'subject'} : 'Invoice'),
877   );
878
879   my %opt = (
880     'unsquelch_cdr' => $conf->exists('voip-cdr_email'),
881     'template'      => $args{'template'},
882     'notice_name'   => ( $args{'notice_name'} || 'Invoice' ),
883   );
884
885   my $cust_main = $self->cust_main;
886
887   if (ref($args{'to'}) eq 'ARRAY') {
888     $return{'to'} = $args{'to'};
889   } else {
890     $return{'to'} = [ grep { $_ !~ /^(POST|FAX)$/ }
891                            $cust_main->invoicing_list
892                     ];
893   }
894
895   if ( $conf->exists('invoice_html') ) {
896
897     warn "$me creating HTML/text multipart message"
898       if $DEBUG;
899
900     $return{'nobody'} = 1;
901
902     my $alternative = build MIME::Entity
903       'Type'        => 'multipart/alternative',
904       'Encoding'    => '7bit',
905       'Disposition' => 'inline'
906     ;
907
908     my $data;
909     if ( $conf->exists('invoice_email_pdf')
910          and scalar($conf->config('invoice_email_pdf_note')) ) {
911
912       warn "$me using 'invoice_email_pdf_note' in multipart message"
913         if $DEBUG;
914       $data = [ map { $_ . "\n" }
915                     $conf->config('invoice_email_pdf_note')
916               ];
917
918     } else {
919
920       warn "$me not using 'invoice_email_pdf_note' in multipart message"
921         if $DEBUG;
922       if ( ref($args{'print_text'}) eq 'ARRAY' ) {
923         $data = $args{'print_text'};
924       } else {
925         $data = [ $self->print_text(\%opt) ];
926       }
927
928     }
929
930     $alternative->attach(
931       'Type'        => 'text/plain',
932       #'Encoding'    => 'quoted-printable',
933       'Encoding'    => '7bit',
934       'Data'        => $data,
935       'Disposition' => 'inline',
936     );
937
938     $args{'from'} =~ /\@([\w\.\-]+)/;
939     my $from = $1 || 'example.com';
940     my $content_id = join('.', rand()*(2**32), $$, time). "\@$from";
941
942     my $logo;
943     my $agentnum = $cust_main->agentnum;
944     if ( defined($args{'template'}) && length($args{'template'})
945          && $conf->exists( 'logo_'. $args{'template'}. '.png', $agentnum )
946        )
947     {
948       $logo = 'logo_'. $args{'template'}. '.png';
949     } else {
950       $logo = "logo.png";
951     }
952     my $image_data = $conf->config_binary( $logo, $agentnum);
953
954     my $image = build MIME::Entity
955       'Type'       => 'image/png',
956       'Encoding'   => 'base64',
957       'Data'       => $image_data,
958       'Filename'   => 'logo.png',
959       'Content-ID' => "<$content_id>",
960     ;
961
962     $alternative->attach(
963       'Type'        => 'text/html',
964       'Encoding'    => 'quoted-printable',
965       'Data'        => [ '<html>',
966                          '  <head>',
967                          '    <title>',
968                          '      '. encode_entities($return{'subject'}), 
969                          '    </title>',
970                          '  </head>',
971                          '  <body bgcolor="#e8e8e8">',
972                          $self->print_html({ 'cid'=>$content_id, %opt }),
973                          '  </body>',
974                          '</html>',
975                        ],
976       'Disposition' => 'inline',
977       #'Filename'    => 'invoice.pdf',
978     );
979
980     my @otherparts = ();
981     if ( $cust_main->email_csv_cdr ) {
982
983       push @otherparts, build MIME::Entity
984         'Type'        => 'text/csv',
985         'Encoding'    => '7bit',
986         'Data'        => [ map { "$_\n" }
987                              $self->call_details('prepend_billed_number' => 1)
988                          ],
989         'Disposition' => 'attachment',
990         'Filename'    => 'usage-'. $self->invnum. '.csv',
991       ;
992
993     }
994
995     if ( $conf->exists('invoice_email_pdf') ) {
996
997       #attaching pdf too:
998       # multipart/mixed
999       #   multipart/related
1000       #     multipart/alternative
1001       #       text/plain
1002       #       text/html
1003       #     image/png
1004       #   application/pdf
1005
1006       my $related = build MIME::Entity 'Type'     => 'multipart/related',
1007                                        'Encoding' => '7bit';
1008
1009       #false laziness w/Misc::send_email
1010       $related->head->replace('Content-type',
1011         $related->mime_type.
1012         '; boundary="'. $related->head->multipart_boundary. '"'.
1013         '; type=multipart/alternative'
1014       );
1015
1016       $related->add_part($alternative);
1017
1018       $related->add_part($image);
1019
1020       my $pdf = build MIME::Entity $self->mimebuild_pdf(\%opt);
1021
1022       $return{'mimeparts'} = [ $related, $pdf, @otherparts ];
1023
1024     } else {
1025
1026       #no other attachment:
1027       # multipart/related
1028       #   multipart/alternative
1029       #     text/plain
1030       #     text/html
1031       #   image/png
1032
1033       $return{'content-type'} = 'multipart/related';
1034       $return{'mimeparts'} = [ $alternative, $image, @otherparts ];
1035       $return{'type'} = 'multipart/alternative'; #Content-Type of first part...
1036       #$return{'disposition'} = 'inline';
1037
1038     }
1039   
1040   } else {
1041
1042     if ( $conf->exists('invoice_email_pdf') ) {
1043       warn "$me creating PDF attachment"
1044         if $DEBUG;
1045
1046       #mime parts arguments a la MIME::Entity->build().
1047       $return{'mimeparts'} = [
1048         { $self->mimebuild_pdf(\%opt) }
1049       ];
1050     }
1051   
1052     if ( $conf->exists('invoice_email_pdf')
1053          and scalar($conf->config('invoice_email_pdf_note')) ) {
1054
1055       warn "$me using 'invoice_email_pdf_note'"
1056         if $DEBUG;
1057       $return{'body'} = [ map { $_ . "\n" }
1058                               $conf->config('invoice_email_pdf_note')
1059                         ];
1060
1061     } else {
1062
1063       warn "$me not using 'invoice_email_pdf_note'"
1064         if $DEBUG;
1065       if ( ref($args{'print_text'}) eq 'ARRAY' ) {
1066         $return{'body'} = $args{'print_text'};
1067       } else {
1068         $return{'body'} = [ $self->print_text(\%opt) ];
1069       }
1070
1071     }
1072
1073   }
1074
1075   %return;
1076
1077 }
1078
1079 =item mimebuild_pdf
1080
1081 Returns a list suitable for passing to MIME::Entity->build(), representing
1082 this invoice as PDF attachment.
1083
1084 =cut
1085
1086 sub mimebuild_pdf {
1087   my $self = shift;
1088   (
1089     'Type'        => 'application/pdf',
1090     'Encoding'    => 'base64',
1091     'Data'        => [ $self->print_pdf(@_) ],
1092     'Disposition' => 'attachment',
1093     'Filename'    => 'invoice-'. $self->invnum. '.pdf',
1094   );
1095 }
1096
1097 =item send HASHREF | [ TEMPLATE [ , AGENTNUM [ , INVOICE_FROM [ , AMOUNT ] ] ] ]
1098
1099 Sends this invoice to the destinations configured for this customer: sends
1100 email, prints and/or faxes.  See L<FS::cust_main_invoice>.
1101
1102 Options can be passed as a hashref (recommended) or as a list of up to 
1103 four values for templatename, agentnum, invoice_from and amount.
1104
1105 I<template>, if specified, is the name of a suffix for alternate invoices.
1106
1107 I<agentnum>, if specified, means that this invoice will only be sent for customers
1108 of the specified agent or agent(s).  AGENTNUM can be a scalar agentnum (for a
1109 single agent) or an arrayref of agentnums.
1110
1111 I<invoice_from>, if specified, overrides the default email invoice From: address.
1112
1113 I<amount>, if specified, only sends the invoice if the total amount owed on this
1114 invoice and all older invoices is greater than the specified amount.
1115
1116 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1117
1118 =cut
1119
1120 sub queueable_send {
1121   my %opt = @_;
1122
1123   my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1124     or die "invalid invoice number: " . $opt{invnum};
1125
1126   my @args = ( $opt{template}, $opt{agentnum} );
1127   push @args, $opt{invoice_from}
1128     if exists($opt{invoice_from}) && $opt{invoice_from};
1129
1130   my $error = $self->send( @args );
1131   die $error if $error;
1132
1133 }
1134
1135 sub send {
1136   my $self = shift;
1137
1138   my( $template, $invoice_from, $notice_name );
1139   my $agentnums = '';
1140   my $balance_over = 0;
1141
1142   if ( ref($_[0]) ) {
1143     my $opt = shift;
1144     $template = $opt->{'template'} || '';
1145     if ( $agentnums = $opt->{'agentnum'} ) {
1146       $agentnums = [ $agentnums ] unless ref($agentnums);
1147     }
1148     $invoice_from = $opt->{'invoice_from'};
1149     $balance_over = $opt->{'balance_over'} if $opt->{'balance_over'};
1150     $notice_name = $opt->{'notice_name'};
1151   } else {
1152     $template = scalar(@_) ? shift : '';
1153     if ( scalar(@_) && $_[0]  ) {
1154       $agentnums = ref($_[0]) ? shift : [ shift ];
1155     }
1156     $invoice_from = shift if scalar(@_);
1157     $balance_over = shift if scalar(@_) && $_[0] !~ /^\s*$/;
1158   }
1159
1160   return 'N/A' unless ! $agentnums
1161                    or grep { $_ == $self->cust_main->agentnum } @$agentnums;
1162
1163   return ''
1164     unless $self->cust_main->total_owed_date($self->_date) > $balance_over;
1165
1166   $invoice_from ||= $self->_agent_invoice_from ||    #XXX should go away
1167                     $conf->config('invoice_from', $self->cust_main->agentnum );
1168
1169   my %opt = (
1170     'template'     => $template,
1171     'invoice_from' => $invoice_from,
1172     'notice_name'  => ( $notice_name || 'Invoice' ),
1173   );
1174
1175   my @invoicing_list = $self->cust_main->invoicing_list;
1176
1177   #$self->email_invoice(\%opt)
1178   $self->email(\%opt)
1179     if grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list or !@invoicing_list;
1180
1181   #$self->print_invoice(\%opt)
1182   $self->print(\%opt)
1183     if grep { $_ eq 'POST' } @invoicing_list; #postal
1184
1185   $self->fax_invoice(\%opt)
1186     if grep { $_ eq 'FAX' } @invoicing_list; #fax
1187
1188   '';
1189
1190 }
1191
1192 =item email HASHREF | [ TEMPLATE [ , INVOICE_FROM ] ] 
1193
1194 Emails this invoice.
1195
1196 Options can be passed as a hashref (recommended) or as a list of up to 
1197 two values for templatename and invoice_from.
1198
1199 I<template>, if specified, is the name of a suffix for alternate invoices.
1200
1201 I<invoice_from>, if specified, overrides the default email invoice From: address.
1202
1203 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1204
1205 =cut
1206
1207 sub queueable_email {
1208   my %opt = @_;
1209
1210   my $self = qsearchs('cust_bill', { 'invnum' => $opt{invnum} } )
1211     or die "invalid invoice number: " . $opt{invnum};
1212
1213   my @args = ( $opt{template} );
1214   push @args, $opt{invoice_from}
1215     if exists($opt{invoice_from}) && $opt{invoice_from};
1216
1217   my $error = $self->email( @args );
1218   die $error if $error;
1219
1220 }
1221
1222 #sub email_invoice {
1223 sub email {
1224   my $self = shift;
1225
1226   my( $template, $invoice_from, $notice_name );
1227   if ( ref($_[0]) ) {
1228     my $opt = shift;
1229     $template = $opt->{'template'} || '';
1230     $invoice_from = $opt->{'invoice_from'};
1231     $notice_name = $opt->{'notice_name'} || 'Invoice';
1232   } else {
1233     $template = scalar(@_) ? shift : '';
1234     $invoice_from = shift if scalar(@_);
1235     $notice_name = 'Invoice';
1236   }
1237
1238   $invoice_from ||= $self->_agent_invoice_from ||    #XXX should go away
1239                     $conf->config('invoice_from', $self->cust_main->agentnum );
1240
1241   my @invoicing_list = grep { $_ !~ /^(POST|FAX)$/ } 
1242                             $self->cust_main->invoicing_list;
1243
1244   if ( ! @invoicing_list ) { #no recipients
1245     if ( $conf->exists('cust_bill-no_recipients-error') ) {
1246       die 'No recipients for customer #'. $self->custnum;
1247     } else {
1248       #default: better to notify this person than silence
1249       @invoicing_list = ($invoice_from);
1250     }
1251   }
1252
1253   my $subject = $self->email_subject($template);
1254
1255   my $error = send_email(
1256     $self->generate_email(
1257       'from'        => $invoice_from,
1258       'to'          => [ grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ],
1259       'subject'     => $subject,
1260       'template'    => $template,
1261       'notice_name' => $notice_name,
1262     )
1263   );
1264   die "can't email invoice: $error\n" if $error;
1265   #die "$error\n" if $error;
1266
1267 }
1268
1269 sub email_subject {
1270   my $self = shift;
1271
1272   #my $template = scalar(@_) ? shift : '';
1273   #per-template?
1274
1275   my $subject = $conf->config('invoice_subject', $self->cust_main->agentnum)
1276                 || 'Invoice';
1277
1278   my $cust_main = $self->cust_main;
1279   my $name = $cust_main->name;
1280   my $name_short = $cust_main->name_short;
1281   my $invoice_number = $self->invnum;
1282   my $invoice_date = $self->_date_pretty;
1283
1284   eval qq("$subject");
1285 }
1286
1287 =item lpr_data HASHREF | [ TEMPLATE ]
1288
1289 Returns the postscript or plaintext for this invoice as an arrayref.
1290
1291 Options can be passed as a hashref (recommended) or as a single optional value
1292 for template.
1293
1294 I<template>, if specified, is the name of a suffix for alternate invoices.
1295
1296 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1297
1298 =cut
1299
1300 sub lpr_data {
1301   my $self = shift;
1302   my( $template, $notice_name );
1303   if ( ref($_[0]) ) {
1304     my $opt = shift;
1305     $template = $opt->{'template'} || '';
1306     $notice_name = $opt->{'notice_name'} || 'Invoice';
1307   } else {
1308     $template = scalar(@_) ? shift : '';
1309     $notice_name = 'Invoice';
1310   }
1311
1312   my %opt = (
1313     'template'    => $template,
1314     'notice_name' => $notice_name,
1315   );
1316
1317   my $method = $conf->exists('invoice_latex') ? 'print_ps' : 'print_text';
1318   [ $self->$method( \%opt ) ];
1319 }
1320
1321 =item print HASHREF | [ TEMPLATE ]
1322
1323 Prints this invoice.
1324
1325 Options can be passed as a hashref (recommended) or as a single optional
1326 value for template.
1327
1328 I<template>, if specified, is the name of a suffix for alternate invoices.
1329
1330 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1331
1332 =cut
1333
1334 #sub print_invoice {
1335 sub print {
1336   my $self = shift;
1337   my( $template, $notice_name );
1338   if ( ref($_[0]) ) {
1339     my $opt = shift;
1340     $template = $opt->{'template'} || '';
1341     $notice_name = $opt->{'notice_name'} || 'Invoice';
1342   } else {
1343     $template = scalar(@_) ? shift : '';
1344     $notice_name = 'Invoice';
1345   }
1346
1347   my %opt = (
1348     'template'    => $template,
1349     'notice_name' => $notice_name,
1350   );
1351
1352   if($conf->exists('invoice_print_pdf')) {
1353     # Add the invoice to the current batch.
1354     $self->batch_invoice(\%opt);
1355   }
1356   else {
1357     do_print $self->lpr_data(\%opt);
1358   }
1359 }
1360
1361 =item fax_invoice HASHREF | [ TEMPLATE ] 
1362
1363 Faxes this invoice.
1364
1365 Options can be passed as a hashref (recommended) or as a single optional
1366 value for template.
1367
1368 I<template>, if specified, is the name of a suffix for alternate invoices.
1369
1370 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
1371
1372 =cut
1373
1374 sub fax_invoice {
1375   my $self = shift;
1376   my( $template, $notice_name );
1377   if ( ref($_[0]) ) {
1378     my $opt = shift;
1379     $template = $opt->{'template'} || '';
1380     $notice_name = $opt->{'notice_name'} || 'Invoice';
1381   } else {
1382     $template = scalar(@_) ? shift : '';
1383     $notice_name = 'Invoice';
1384   }
1385
1386   die 'FAX invoice destination not (yet?) supported with plain text invoices.'
1387     unless $conf->exists('invoice_latex');
1388
1389   my $dialstring = $self->cust_main->getfield('fax');
1390   #Check $dialstring?
1391
1392   my %opt = (
1393     'template'    => $template,
1394     'notice_name' => $notice_name,
1395   );
1396
1397   my $error = send_fax( 'docdata'    => $self->lpr_data(\%opt),
1398                         'dialstring' => $dialstring,
1399                       );
1400   die $error if $error;
1401
1402 }
1403
1404 =item batch_invoice [ HASHREF ]
1405
1406 Place this invoice into the open batch (see C<FS::bill_batch>).  If there 
1407 isn't an open batch, one will be created.
1408
1409 =cut
1410
1411 sub batch_invoice {
1412   my ($self, $opt) = @_;
1413   my $batch = FS::bill_batch->get_open_batch;
1414   my $cust_bill_batch = FS::cust_bill_batch->new({
1415       batchnum => $batch->batchnum,
1416       invnum   => $self->invnum,
1417   });
1418   return $cust_bill_batch->insert($opt);
1419 }
1420
1421 =item ftp_invoice [ TEMPLATENAME ] 
1422
1423 Sends this invoice data via FTP.
1424
1425 TEMPLATENAME is unused?
1426
1427 =cut
1428
1429 sub ftp_invoice {
1430   my $self = shift;
1431   my $template = scalar(@_) ? shift : '';
1432
1433   $self->send_csv(
1434     'protocol'   => 'ftp',
1435     'server'     => $conf->config('cust_bill-ftpserver'),
1436     'username'   => $conf->config('cust_bill-ftpusername'),
1437     'password'   => $conf->config('cust_bill-ftppassword'),
1438     'dir'        => $conf->config('cust_bill-ftpdir'),
1439     'format'     => $conf->config('cust_bill-ftpformat'),
1440   );
1441 }
1442
1443 =item spool_invoice [ TEMPLATENAME ] 
1444
1445 Spools this invoice data (see L<FS::spool_csv>)
1446
1447 TEMPLATENAME is unused?
1448
1449 =cut
1450
1451 sub spool_invoice {
1452   my $self = shift;
1453   my $template = scalar(@_) ? shift : '';
1454
1455   $self->spool_csv(
1456     'format'       => $conf->config('cust_bill-spoolformat'),
1457     'agent_spools' => $conf->exists('cust_bill-spoolagent'),
1458   );
1459 }
1460
1461 =item send_if_newest [ TEMPLATENAME [ , AGENTNUM [ , INVOICE_FROM ] ] ]
1462
1463 Like B<send>, but only sends the invoice if it is the newest open invoice for
1464 this customer.
1465
1466 =cut
1467
1468 sub send_if_newest {
1469   my $self = shift;
1470
1471   return ''
1472     if scalar(
1473                grep { $_->owed > 0 } 
1474                     qsearch('cust_bill', {
1475                       'custnum' => $self->custnum,
1476                       #'_date'   => { op=>'>', value=>$self->_date },
1477                       'invnum'  => { op=>'>', value=>$self->invnum },
1478                     } )
1479              );
1480     
1481   $self->send(@_);
1482 }
1483
1484 =item send_csv OPTION => VALUE, ...
1485
1486 Sends invoice as a CSV data-file to a remote host with the specified protocol.
1487
1488 Options are:
1489
1490 protocol - currently only "ftp"
1491 server
1492 username
1493 password
1494 dir
1495
1496 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
1497 and YYMMDDHHMMSS is a timestamp.
1498
1499 See L</print_csv> for a description of the output format.
1500
1501 =cut
1502
1503 sub send_csv {
1504   my($self, %opt) = @_;
1505
1506   #create file(s)
1507
1508   my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1509   mkdir $spooldir, 0700 unless -d $spooldir;
1510
1511   my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1512   my $file = "$spooldir/$tracctnum.csv";
1513   
1514   my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1515
1516   open(CSV, ">$file") or die "can't open $file: $!";
1517   print CSV $header;
1518
1519   print CSV $detail;
1520
1521   close CSV;
1522
1523   my $net;
1524   if ( $opt{protocol} eq 'ftp' ) {
1525     eval "use Net::FTP;";
1526     die $@ if $@;
1527     $net = Net::FTP->new($opt{server}) or die @$;
1528   } else {
1529     die "unknown protocol: $opt{protocol}";
1530   }
1531
1532   $net->login( $opt{username}, $opt{password} )
1533     or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
1534
1535   $net->binary or die "can't set binary mode";
1536
1537   $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
1538
1539   $net->put($file) or die "can't put $file: $!";
1540
1541   $net->quit;
1542
1543   unlink $file;
1544
1545 }
1546
1547 =item spool_csv
1548
1549 Spools CSV invoice data.
1550
1551 Options are:
1552
1553 =over 4
1554
1555 =item format - 'default' or 'billco'
1556
1557 =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>).
1558
1559 =item agent_spools - if set to a true value, will spool to per-agent files rather than a single global file
1560
1561 =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.
1562
1563 =back
1564
1565 =cut
1566
1567 sub spool_csv {
1568   my($self, %opt) = @_;
1569
1570   my $cust_main = $self->cust_main;
1571
1572   if ( $opt{'dest'} ) {
1573     my %invoicing_list = map { /^(POST|FAX)$/ or 'EMAIL' =~ /^(.*)$/; $1 => 1 }
1574                              $cust_main->invoicing_list;
1575     return 'N/A' unless $invoicing_list{$opt{'dest'}}
1576                      || ! keys %invoicing_list;
1577   }
1578
1579   if ( $opt{'balanceover'} ) {
1580     return 'N/A'
1581       if $cust_main->total_owed_date($self->_date) < $opt{'balanceover'};
1582   }
1583
1584   my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
1585   mkdir $spooldir, 0700 unless -d $spooldir;
1586
1587   my $tracctnum = $self->invnum. time2str('-%Y%m%d%H%M%S', time);
1588
1589   my $file =
1590     "$spooldir/".
1591     ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1592     ( lc($opt{'format'}) eq 'billco' ? '-header' : '' ) .
1593     '.csv';
1594   
1595   my ( $header, $detail ) = $self->print_csv(%opt, 'tracctnum' => $tracctnum );
1596
1597   open(CSV, ">>$file") or die "can't open $file: $!";
1598   flock(CSV, LOCK_EX);
1599   seek(CSV, 0, 2);
1600
1601   print CSV $header;
1602
1603   if ( lc($opt{'format'}) eq 'billco' ) {
1604
1605     flock(CSV, LOCK_UN);
1606     close CSV;
1607
1608     $file =
1609       "$spooldir/".
1610       ( $opt{'agent_spools'} ? 'agentnum'.$cust_main->agentnum : 'spool' ).
1611       '-detail.csv';
1612
1613     open(CSV,">>$file") or die "can't open $file: $!";
1614     flock(CSV, LOCK_EX);
1615     seek(CSV, 0, 2);
1616   }
1617
1618   print CSV $detail;
1619
1620   flock(CSV, LOCK_UN);
1621   close CSV;
1622
1623   return '';
1624
1625 }
1626
1627 =item print_csv OPTION => VALUE, ...
1628
1629 Returns CSV data for this invoice.
1630
1631 Options are:
1632
1633 format - 'default' or 'billco'
1634
1635 Returns a list consisting of two scalars.  The first is a single line of CSV
1636 header information for this invoice.  The second is one or more lines of CSV
1637 detail information for this invoice.
1638
1639 If I<format> is not specified or "default", the fields of the CSV file are as
1640 follows:
1641
1642 record_type, invnum, custnum, _date, charged, first, last, company, address1, address2, city, state, zip, country, pkg, setup, recur, sdate, edate
1643
1644 =over 4
1645
1646 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
1647
1648 B<record_type> is C<cust_bill> for the initial header line only.  The
1649 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
1650 fields are filled in.
1651
1652 B<record_type> is C<cust_bill_pkg> for detail lines.  Only the first two fields
1653 (B<record_type> and B<invnum>) and the last five fields (B<pkg> through B<edate>)
1654 are filled in.
1655
1656 =item invnum - invoice number
1657
1658 =item custnum - customer number
1659
1660 =item _date - invoice date
1661
1662 =item charged - total invoice amount
1663
1664 =item first - customer first name
1665
1666 =item last - customer first name
1667
1668 =item company - company name
1669
1670 =item address1 - address line 1
1671
1672 =item address2 - address line 1
1673
1674 =item city
1675
1676 =item state
1677
1678 =item zip
1679
1680 =item country
1681
1682 =item pkg - line item description
1683
1684 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
1685
1686 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
1687
1688 =item sdate - start date for recurring fee
1689
1690 =item edate - end date for recurring fee
1691
1692 =back
1693
1694 If I<format> is "billco", the fields of the header CSV file are as follows:
1695
1696   +-------------------------------------------------------------------+
1697   |                        FORMAT HEADER FILE                         |
1698   |-------------------------------------------------------------------|
1699   | Field | Description                   | Name       | Type | Width |
1700   | 1     | N/A-Leave Empty               | RC         | CHAR |     2 |
1701   | 2     | N/A-Leave Empty               | CUSTID     | CHAR |    15 |
1702   | 3     | Transaction Account No        | TRACCTNUM  | CHAR |    15 |
1703   | 4     | Transaction Invoice No        | TRINVOICE  | CHAR |    15 |
1704   | 5     | Transaction Zip Code          | TRZIP      | CHAR |     5 |
1705   | 6     | Transaction Company Bill To   | TRCOMPANY  | CHAR |    30 |
1706   | 7     | Transaction Contact Bill To   | TRNAME     | CHAR |    30 |
1707   | 8     | Additional Address Unit Info  | TRADDR1    | CHAR |    30 |
1708   | 9     | Bill To Street Address        | TRADDR2    | CHAR |    30 |
1709   | 10    | Ancillary Billing Information | TRADDR3    | CHAR |    30 |
1710   | 11    | Transaction City Bill To      | TRCITY     | CHAR |    20 |
1711   | 12    | Transaction State Bill To     | TRSTATE    | CHAR |     2 |
1712   | 13    | Bill Cycle Close Date         | CLOSEDATE  | CHAR |    10 |
1713   | 14    | Bill Due Date                 | DUEDATE    | CHAR |    10 |
1714   | 15    | Previous Balance              | BALFWD     | NUM* |     9 |
1715   | 16    | Pmt/CR Applied                | CREDAPPLY  | NUM* |     9 |
1716   | 17    | Total Current Charges         | CURRENTCHG | NUM* |     9 |
1717   | 18    | Total Amt Due                 | TOTALDUE   | NUM* |     9 |
1718   | 19    | Total Amt Due                 | AMTDUE     | NUM* |     9 |
1719   | 20    | 30 Day Aging                  | AMT30      | NUM* |     9 |
1720   | 21    | 60 Day Aging                  | AMT60      | NUM* |     9 |
1721   | 22    | 90 Day Aging                  | AMT90      | NUM* |     9 |
1722   | 23    | Y/N                           | AGESWITCH  | CHAR |     1 |
1723   | 24    | Remittance automation         | SCANLINE   | CHAR |   100 |
1724   | 25    | Total Taxes & Fees            | TAXTOT     | NUM* |     9 |
1725   | 26    | Customer Reference Number     | CUSTREF    | CHAR |    15 |
1726   | 27    | Federal Tax***                | FEDTAX     | NUM* |     9 |
1727   | 28    | State Tax***                  | STATETAX   | NUM* |     9 |
1728   | 29    | Other Taxes & Fees***         | OTHERTAX   | NUM* |     9 |
1729   +-------+-------------------------------+------------+------+-------+
1730
1731 If I<format> is "billco", the fields of the detail CSV file are as follows:
1732
1733                                   FORMAT FOR DETAIL FILE
1734         |                            |           |      |
1735   Field | Description                | Name      | Type | Width
1736   1     | N/A-Leave Empty            | RC        | CHAR |     2
1737   2     | N/A-Leave Empty            | CUSTID    | CHAR |    15
1738   3     | Account Number             | TRACCTNUM | CHAR |    15
1739   4     | Invoice Number             | TRINVOICE | CHAR |    15
1740   5     | Line Sequence (sort order) | LINESEQ   | NUM  |     6
1741   6     | Transaction Detail         | DETAILS   | CHAR |   100
1742   7     | Amount                     | AMT       | NUM* |     9
1743   8     | Line Format Control**      | LNCTRL    | CHAR |     2
1744   9     | Grouping Code              | GROUP     | CHAR |     2
1745   10    | User Defined               | ACCT CODE | CHAR |    15
1746
1747 =cut
1748
1749 sub print_csv {
1750   my($self, %opt) = @_;
1751   
1752   eval "use Text::CSV_XS";
1753   die $@ if $@;
1754
1755   my $cust_main = $self->cust_main;
1756
1757   my $csv = Text::CSV_XS->new({'always_quote'=>1});
1758
1759   if ( lc($opt{'format'}) eq 'billco' ) {
1760
1761     my $taxtotal = 0;
1762     $taxtotal += $_->{'amount'} foreach $self->_items_tax;
1763
1764     my $duedate = $self->due_date2str('%m/%d/%Y'); #date_format?
1765
1766     my( $previous_balance, @unused ) = $self->previous; #previous balance
1767
1768     my $pmt_cr_applied = 0;
1769     $pmt_cr_applied += $_->{'amount'}
1770       foreach ( $self->_items_payments, $self->_items_credits ) ;
1771
1772     my $totaldue = sprintf('%.2f', $self->owed + $previous_balance);
1773
1774     $csv->combine(
1775       '',                         #  1 | N/A-Leave Empty               CHAR   2
1776       '',                         #  2 | N/A-Leave Empty               CHAR  15
1777       $opt{'tracctnum'},          #  3 | Transaction Account No        CHAR  15
1778       $self->invnum,              #  4 | Transaction Invoice No        CHAR  15
1779       $cust_main->zip,            #  5 | Transaction Zip Code          CHAR   5
1780       $cust_main->company,        #  6 | Transaction Company Bill To   CHAR  30
1781       #$cust_main->payname,        #  7 | Transaction Contact Bill To   CHAR  30
1782       $cust_main->contact,        #  7 | Transaction Contact Bill To   CHAR  30
1783       $cust_main->address2,       #  8 | Additional Address Unit Info  CHAR  30
1784       $cust_main->address1,       #  9 | Bill To Street Address        CHAR  30
1785       '',                         # 10 | Ancillary Billing Information CHAR  30
1786       $cust_main->city,           # 11 | Transaction City Bill To      CHAR  20
1787       $cust_main->state,          # 12 | Transaction State Bill To     CHAR   2
1788
1789       # XXX ?
1790       time2str("%m/%d/%Y", $self->_date), # 13 | Bill Cycle Close Date CHAR  10
1791
1792       # XXX ?
1793       $duedate,                   # 14 | Bill Due Date                 CHAR  10
1794
1795       $previous_balance,          # 15 | Previous Balance              NUM*   9
1796       $pmt_cr_applied,            # 16 | Pmt/CR Applied                NUM*   9
1797       sprintf("%.2f", $self->charged), # 17 | Total Current Charges    NUM*   9
1798       $totaldue,                  # 18 | Total Amt Due                 NUM*   9
1799       $totaldue,                  # 19 | Total Amt Due                 NUM*   9
1800       '',                         # 20 | 30 Day Aging                  NUM*   9
1801       '',                         # 21 | 60 Day Aging                  NUM*   9
1802       '',                         # 22 | 90 Day Aging                  NUM*   9
1803       'N',                        # 23 | Y/N                           CHAR   1
1804       '',                         # 24 | Remittance automation         CHAR 100
1805       $taxtotal,                  # 25 | Total Taxes & Fees            NUM*   9
1806       $self->custnum,             # 26 | Customer Reference Number     CHAR  15
1807       '0',                        # 27 | Federal Tax***                NUM*   9
1808       sprintf("%.2f", $taxtotal), # 28 | State Tax***                  NUM*   9
1809       '0',                        # 29 | Other Taxes & Fees***         NUM*   9
1810     );
1811
1812   } else {
1813   
1814     $csv->combine(
1815       'cust_bill',
1816       $self->invnum,
1817       $self->custnum,
1818       time2str("%x", $self->_date),
1819       sprintf("%.2f", $self->charged),
1820       ( map { $cust_main->getfield($_) }
1821           qw( first last company address1 address2 city state zip country ) ),
1822       map { '' } (1..5),
1823     ) or die "can't create csv";
1824   }
1825
1826   my $header = $csv->string. "\n";
1827
1828   my $detail = '';
1829   if ( lc($opt{'format'}) eq 'billco' ) {
1830
1831     my $lineseq = 0;
1832     foreach my $item ( $self->_items_pkg ) {
1833
1834       $csv->combine(
1835         '',                     #  1 | N/A-Leave Empty            CHAR   2
1836         '',                     #  2 | N/A-Leave Empty            CHAR  15
1837         $opt{'tracctnum'},      #  3 | Account Number             CHAR  15
1838         $self->invnum,          #  4 | Invoice Number             CHAR  15
1839         $lineseq++,             #  5 | Line Sequence (sort order) NUM    6
1840         $item->{'description'}, #  6 | Transaction Detail         CHAR 100
1841         $item->{'amount'},      #  7 | Amount                     NUM*   9
1842         '',                     #  8 | Line Format Control**      CHAR   2
1843         '',                     #  9 | Grouping Code              CHAR   2
1844         '',                     # 10 | User Defined               CHAR  15
1845       );
1846
1847       $detail .= $csv->string. "\n";
1848
1849     }
1850
1851   } else {
1852
1853     foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
1854
1855       my($pkg, $setup, $recur, $sdate, $edate);
1856       if ( $cust_bill_pkg->pkgnum ) {
1857       
1858         ($pkg, $setup, $recur, $sdate, $edate) = (
1859           $cust_bill_pkg->part_pkg->pkg,
1860           ( $cust_bill_pkg->setup != 0
1861             ? sprintf("%.2f", $cust_bill_pkg->setup )
1862             : '' ),
1863           ( $cust_bill_pkg->recur != 0
1864             ? sprintf("%.2f", $cust_bill_pkg->recur )
1865             : '' ),
1866           ( $cust_bill_pkg->sdate 
1867             ? time2str("%x", $cust_bill_pkg->sdate)
1868             : '' ),
1869           ($cust_bill_pkg->edate 
1870             ?time2str("%x", $cust_bill_pkg->edate)
1871             : '' ),
1872         );
1873   
1874       } else { #pkgnum tax
1875         next unless $cust_bill_pkg->setup != 0;
1876         $pkg = $cust_bill_pkg->desc;
1877         $setup = sprintf('%10.2f', $cust_bill_pkg->setup );
1878         ( $sdate, $edate ) = ( '', '' );
1879       }
1880   
1881       $csv->combine(
1882         'cust_bill_pkg',
1883         $self->invnum,
1884         ( map { '' } (1..11) ),
1885         ($pkg, $setup, $recur, $sdate, $edate)
1886       ) or die "can't create csv";
1887
1888       $detail .= $csv->string. "\n";
1889
1890     }
1891
1892   }
1893
1894   ( $header, $detail );
1895
1896 }
1897
1898 =item comp
1899
1900 Pays this invoice with a compliemntary payment.  If there is an error,
1901 returns the error, otherwise returns false.
1902
1903 =cut
1904
1905 sub comp {
1906   my $self = shift;
1907   my $cust_pay = new FS::cust_pay ( {
1908     'invnum'   => $self->invnum,
1909     'paid'     => $self->owed,
1910     '_date'    => '',
1911     'payby'    => 'COMP',
1912     'payinfo'  => $self->cust_main->payinfo,
1913     'paybatch' => '',
1914   } );
1915   $cust_pay->insert;
1916 }
1917
1918 =item realtime_card
1919
1920 Attempts to pay this invoice with a credit card payment via a
1921 Business::OnlinePayment realtime gateway.  See
1922 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1923 for supported processors.
1924
1925 =cut
1926
1927 sub realtime_card {
1928   my $self = shift;
1929   $self->realtime_bop( 'CC', @_ );
1930 }
1931
1932 =item realtime_ach
1933
1934 Attempts to pay this invoice with an electronic check (ACH) payment via a
1935 Business::OnlinePayment realtime gateway.  See
1936 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1937 for supported processors.
1938
1939 =cut
1940
1941 sub realtime_ach {
1942   my $self = shift;
1943   $self->realtime_bop( 'ECHECK', @_ );
1944 }
1945
1946 =item realtime_lec
1947
1948 Attempts to pay this invoice with phone bill (LEC) payment via a
1949 Business::OnlinePayment realtime gateway.  See
1950 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
1951 for supported processors.
1952
1953 =cut
1954
1955 sub realtime_lec {
1956   my $self = shift;
1957   $self->realtime_bop( 'LEC', @_ );
1958 }
1959
1960 sub realtime_bop {
1961   my( $self, $method ) = @_;
1962
1963   my $cust_main = $self->cust_main;
1964   my $balance = $cust_main->balance;
1965   my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
1966   $amount = sprintf("%.2f", $amount);
1967   return "not run (balance $balance)" unless $amount > 0;
1968
1969   my $description = 'Internet Services';
1970   if ( $conf->exists('business-onlinepayment-description') ) {
1971     my $dtempl = $conf->config('business-onlinepayment-description');
1972
1973     my $agent_obj = $cust_main->agent
1974       or die "can't retreive agent for $cust_main (agentnum ".
1975              $cust_main->agentnum. ")";
1976     my $agent = $agent_obj->agent;
1977     my $pkgs = join(', ',
1978       map { $_->part_pkg->pkg }
1979         grep { $_->pkgnum } $self->cust_bill_pkg
1980     );
1981     $description = eval qq("$dtempl");
1982   }
1983
1984   $cust_main->realtime_bop($method, $amount,
1985     'description' => $description,
1986     'invnum'      => $self->invnum,
1987 #this didn't do what we want, it just calls apply_payments_and_credits
1988 #    'apply'       => 1,
1989     'apply_to_invoice' => 1,
1990  #what we want:
1991  #this changes application behavior: auto payments
1992                         #triggered against a specific invoice are now applied
1993                         #to that invoice instead of oldest open.
1994                         #seem okay to me...
1995   );
1996
1997 }
1998
1999 =item batch_card OPTION => VALUE...
2000
2001 Adds a payment for this invoice to the pending credit card batch (see
2002 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2003 runs the payment using a realtime gateway.
2004
2005 =cut
2006
2007 sub batch_card {
2008   my ($self, %options) = @_;
2009   my $cust_main = $self->cust_main;
2010
2011   $options{invnum} = $self->invnum;
2012   
2013   $cust_main->batch_card(%options);
2014 }
2015
2016 sub _agent_template {
2017   my $self = shift;
2018   $self->cust_main->agent_template;
2019 }
2020
2021 sub _agent_invoice_from {
2022   my $self = shift;
2023   $self->cust_main->agent_invoice_from;
2024 }
2025
2026 =item print_text HASHREF | [ TIME [ , TEMPLATE [ , OPTION => VALUE ... ] ] ]
2027
2028 Returns an text invoice, as a list of lines.
2029
2030 Options can be passed as a hashref (recommended) or as a list of time, template
2031 and then any key/value pairs for any other options.
2032
2033 I<time>, if specified, is used to control the printing of overdue messages.  The
2034 default is now.  It isn't the date of the invoice; that's the `_date' field.
2035 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
2036 L<Time::Local> and L<Date::Parse> for conversion functions.
2037
2038 I<template>, if specified, is the name of a suffix for alternate invoices.
2039
2040 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
2041
2042 =cut
2043
2044 sub print_text {
2045   my $self = shift;
2046   my( $today, $template, %opt );
2047   if ( ref($_[0]) ) {
2048     %opt = %{ shift() };
2049     $today = delete($opt{'time'}) || '';
2050     $template = delete($opt{template}) || '';
2051   } else {
2052     ( $today, $template, %opt ) = @_;
2053   }
2054
2055   my %params = ( 'format' => 'template' );
2056   $params{'time'} = $today if $today;
2057   $params{'template'} = $template if $template;
2058   $params{$_} = $opt{$_} 
2059     foreach grep $opt{$_}, qw( unsquealch_cdr notice_name );
2060
2061   $self->print_generic( %params );
2062 }
2063
2064 =item print_latex HASHREF | [ TIME [ , TEMPLATE [ , OPTION => VALUE ... ] ] ]
2065
2066 Internal method - returns a filename of a filled-in LaTeX template for this
2067 invoice (Note: add ".tex" to get the actual filename), and a filename of
2068 an associated logo (with the .eps extension included).
2069
2070 See print_ps and print_pdf for methods that return PostScript and PDF output.
2071
2072 Options can be passed as a hashref (recommended) or as a list of time, template
2073 and then any key/value pairs for any other options.
2074
2075 I<time>, if specified, is used to control the printing of overdue messages.  The
2076 default is now.  It isn't the date of the invoice; that's the `_date' field.
2077 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
2078 L<Time::Local> and L<Date::Parse> for conversion functions.
2079
2080 I<template>, if specified, is the name of a suffix for alternate invoices.
2081
2082 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
2083
2084 =cut
2085
2086 sub print_latex {
2087   my $self = shift;
2088   my( $today, $template, %opt );
2089   if ( ref($_[0]) ) {
2090     %opt = %{ shift() };
2091     $today = delete($opt{'time'}) || '';
2092     $template = delete($opt{template}) || '';
2093   } else {
2094     ( $today, $template, %opt ) = @_;
2095   }
2096
2097   my %params = ( 'format' => 'latex' );
2098   $params{'time'} = $today if $today;
2099   $params{'template'} = $template if $template;
2100   $params{$_} = $opt{$_} 
2101     foreach grep $opt{$_}, qw( unsquealch_cdr notice_name );
2102
2103   $template ||= $self->_agent_template;
2104
2105   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
2106   my $lh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
2107                            DIR      => $dir,
2108                            SUFFIX   => '.eps',
2109                            UNLINK   => 0,
2110                          ) or die "can't open temp file: $!\n";
2111
2112   my $agentnum = $self->cust_main->agentnum;
2113
2114   if ( $template && $conf->exists("logo_${template}.eps", $agentnum) ) {
2115     print $lh $conf->config_binary("logo_${template}.eps", $agentnum)
2116       or die "can't write temp file: $!\n";
2117   } else {
2118     print $lh $conf->config_binary('logo.eps', $agentnum)
2119       or die "can't write temp file: $!\n";
2120   }
2121   close $lh;
2122   $params{'logo_file'} = $lh->filename;
2123
2124   my @filled_in = $self->print_generic( %params );
2125   
2126   my $fh = new File::Temp( TEMPLATE => 'invoice.'. $self->invnum. '.XXXXXXXX',
2127                            DIR      => $dir,
2128                            SUFFIX   => '.tex',
2129                            UNLINK   => 0,
2130                          ) or die "can't open temp file: $!\n";
2131   print $fh join('', @filled_in );
2132   close $fh;
2133
2134   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
2135   return ($1, $params{'logo_file'});
2136
2137 }
2138
2139 =item print_generic OPTION => VALUE ...
2140
2141 Internal method - returns a filled-in template for this invoice as a scalar.
2142
2143 See print_ps and print_pdf for methods that return PostScript and PDF output.
2144
2145 Non optional options include 
2146   format - latex, html, template
2147
2148 Optional options include
2149
2150 template - a value used as a suffix for a configuration template
2151
2152 time - a value used to control the printing of overdue messages.  The
2153 default is now.  It isn't the date of the invoice; that's the `_date' field.
2154 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
2155 L<Time::Local> and L<Date::Parse> for conversion functions.
2156
2157 cid - 
2158
2159 unsquelch_cdr - overrides any per customer cdr squelching when true
2160
2161 notice_name - overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
2162
2163 =cut
2164
2165 #what's with all the sprintf('%10.2f')'s in here?  will it cause any
2166 # (alignment in text invoice?) problems to change them all to '%.2f' ?
2167 # yes: fixed width (dot matrix) text printing will be borked
2168 sub print_generic {
2169
2170   my( $self, %params ) = @_;
2171   my $today = $params{today} ? $params{today} : time;
2172   warn "$me print_generic called on $self with suffix $params{template}\n"
2173     if $DEBUG;
2174
2175   my $format = $params{format};
2176   die "Unknown format: $format"
2177     unless $format =~ /^(latex|html|template)$/;
2178
2179   my $cust_main = $self->cust_main;
2180   $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
2181     unless $cust_main->payname
2182         && $cust_main->payby !~ /^(CARD|DCRD|CHEK|DCHK)$/;
2183
2184   my %delimiters = ( 'latex'    => [ '[@--', '--@]' ],
2185                      'html'     => [ '<%=', '%>' ],
2186                      'template' => [ '{', '}' ],
2187                    );
2188
2189   #create the template
2190   my $template = $params{template} ? $params{template} : $self->_agent_template;
2191   my $templatefile = "invoice_$format";
2192   $templatefile .= "_$template"
2193     if length($template);
2194   my @invoice_template = map "$_\n", $conf->config($templatefile)
2195     or die "cannot load config data $templatefile";
2196
2197   my $old_latex = '';
2198   if ( $format eq 'latex' && grep { /^%%Detail/ } @invoice_template ) {
2199     #change this to a die when the old code is removed
2200     warn "old-style invoice template $templatefile; ".
2201          "patch with conf/invoice_latex.diff or use new conf/invoice_latex*\n";
2202     $old_latex = 'true';
2203     @invoice_template = _translate_old_latex_format(@invoice_template);
2204   } 
2205
2206   my $text_template = new Text::Template(
2207     TYPE => 'ARRAY',
2208     SOURCE => \@invoice_template,
2209     DELIMITERS => $delimiters{$format},
2210   );
2211
2212   $text_template->compile()
2213     or die "Can't compile $templatefile: $Text::Template::ERROR\n";
2214
2215
2216   # additional substitution could possibly cause breakage in existing templates
2217   my %convert_maps = ( 
2218     'latex' => {
2219                  'notes'         => sub { map "$_", @_ },
2220                  'footer'        => sub { map "$_", @_ },
2221                  'smallfooter'   => sub { map "$_", @_ },
2222                  'returnaddress' => sub { map "$_", @_ },
2223                  'coupon'        => sub { map "$_", @_ },
2224                  'summary'       => sub { map "$_", @_ },
2225                },
2226     'html'  => {
2227                  'notes' =>
2228                    sub {
2229                      map { 
2230                        s/%%(.*)$/<!-- $1 -->/g;
2231                        s/\\section\*\{\\textsc\{(.)(.*)\}\}/<p><b><font size="+1">$1<\/font>\U$2<\/b>/g;
2232                        s/\\begin\{enumerate\}/<ol>/g;
2233                        s/\\item /  <li>/g;
2234                        s/\\end\{enumerate\}/<\/ol>/g;
2235                        s/\\textbf\{(.*)\}/<b>$1<\/b>/g;
2236                        s/\\\\\*/<br>/g;
2237                        s/\\dollar ?/\$/g;
2238                        s/\\#/#/g;
2239                        s/~/&nbsp;/g;
2240                        $_;
2241                      }  @_
2242                    },
2243                  'footer' =>
2244                    sub { map { s/~/&nbsp;/g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
2245                  'smallfooter' =>
2246                    sub { map { s/~/&nbsp;/g; s/\\\\\*?\s*$/<BR>/; $_; } @_ },
2247                  'returnaddress' =>
2248                    sub {
2249                      map { 
2250                        s/~/&nbsp;/g;
2251                        s/\\\\\*?\s*$/<BR>/;
2252                        s/\\hyphenation\{[\w\s\-]+}//;
2253                        s/\\([&])/$1/g;
2254                        $_;
2255                      }  @_
2256                    },
2257                  'coupon'        => sub { "" },
2258                  'summary'       => sub { "" },
2259                },
2260     'template' => {
2261                  'notes' =>
2262                    sub {
2263                      map { 
2264                        s/%%.*$//g;
2265                        s/\\section\*\{\\textsc\{(.*)\}\}/\U$1/g;
2266                        s/\\begin\{enumerate\}//g;
2267                        s/\\item /  * /g;
2268                        s/\\end\{enumerate\}//g;
2269                        s/\\textbf\{(.*)\}/$1/g;
2270                        s/\\\\\*/ /;
2271                        s/\\dollar ?/\$/g;
2272                        $_;
2273                      }  @_
2274                    },
2275                  'footer' =>
2276                    sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
2277                  'smallfooter' =>
2278                    sub { map { s/~/ /g; s/\\\\\*?\s*$/\n/; $_; } @_ },
2279                  'returnaddress' =>
2280                    sub {
2281                      map { 
2282                        s/~/ /g;
2283                        s/\\\\\*?\s*$/\n/;             # dubious
2284                        s/\\hyphenation\{[\w\s\-]+}//;
2285                        $_;
2286                      }  @_
2287                    },
2288                  'coupon'        => sub { "" },
2289                  'summary'       => sub { "" },
2290                },
2291   );
2292
2293
2294   # hashes for differing output formats
2295   my %nbsps = ( 'latex'    => '~',
2296                 'html'     => '',    # '&nbps;' would be nice
2297                 'template' => '',    # not used
2298               );
2299   my $nbsp = $nbsps{$format};
2300
2301   my %escape_functions = ( 'latex'    => \&_latex_escape,
2302                            'html'     => \&_html_escape_nbsp,#\&encode_entities,
2303                            'template' => sub { shift },
2304                          );
2305   my $escape_function = $escape_functions{$format};
2306   my $escape_function_nonbsp = ($format eq 'html')
2307                                  ? \&_html_escape : $escape_function;
2308
2309   my %date_formats = ( 'latex'    => $date_format_long,
2310                        'html'     => $date_format_long,
2311                        'template' => '%s',
2312                      );
2313   $date_formats{'html'} =~ s/ /&nbsp;/g;
2314
2315   my $date_format = $date_formats{$format};
2316
2317   my %embolden_functions = ( 'latex'    => sub { return '\textbf{'. shift(). '}'
2318                                                },
2319                              'html'     => sub { return '<b>'. shift(). '</b>'
2320                                                },
2321                              'template' => sub { shift },
2322                            );
2323   my $embolden_function = $embolden_functions{$format};
2324
2325
2326   # generate template variables
2327   my $returnaddress;
2328   if (
2329          defined( $conf->config_orbase( "invoice_${format}returnaddress",
2330                                         $template
2331                                       )
2332                 )
2333        && length( $conf->config_orbase( "invoice_${format}returnaddress",
2334                                         $template
2335                                       )
2336                 )
2337   ) {
2338
2339     $returnaddress = join("\n",
2340       $conf->config_orbase("invoice_${format}returnaddress", $template)
2341     );
2342
2343   } elsif ( grep /\S/,
2344             $conf->config_orbase('invoice_latexreturnaddress', $template) ) {
2345
2346     my $convert_map = $convert_maps{$format}{'returnaddress'};
2347     $returnaddress =
2348       join( "\n",
2349             &$convert_map( $conf->config_orbase( "invoice_latexreturnaddress",
2350                                                  $template
2351                                                )
2352                          )
2353           );
2354   } elsif ( grep /\S/, $conf->config('company_address', $self->cust_main->agentnum) ) {
2355
2356     my $convert_map = $convert_maps{$format}{'returnaddress'};
2357     $returnaddress = join( "\n", &$convert_map(
2358                                    map { s/( {2,})/'~' x length($1)/eg;
2359                                          s/$/\\\\\*/;
2360                                          $_
2361                                        }
2362                                      ( $conf->config('company_name', $self->cust_main->agentnum),
2363                                        $conf->config('company_address', $self->cust_main->agentnum),
2364                                      )
2365                                  )
2366                      );
2367
2368   } else {
2369
2370     my $warning = "Couldn't find a return address; ".
2371                   "do you need to set the company_address configuration value?";
2372     warn "$warning\n";
2373     $returnaddress = $nbsp;
2374     #$returnaddress = $warning;
2375
2376   }
2377
2378   my $agentnum = $self->cust_main->agentnum;
2379
2380   my %invoice_data = (
2381
2382     #invoice from info
2383     'company_name'    => scalar( $conf->config('company_name', $agentnum) ),
2384     'company_address' => join("\n", $conf->config('company_address', $agentnum) ). "\n",
2385     'returnaddress'   => $returnaddress,
2386     'agent'           => &$escape_function($cust_main->agent->agent),
2387
2388     #invoice info
2389     'invnum'          => $self->invnum,
2390     'date'            => time2str($date_format, $self->_date),
2391     'today'           => time2str($date_format_long, $today),
2392     'terms'           => $self->terms,
2393     'template'        => $template, #params{'template'},
2394     'notice_name'     => ($params{'notice_name'} || 'Invoice'),#escape_function?
2395     'current_charges' => sprintf("%.2f", $self->charged),
2396     'duedate'         => $self->due_date2str($rdate_format), #date_format?
2397
2398     #customer info
2399     'custnum'         => $cust_main->display_custnum,
2400     'agent_custid'    => &$escape_function($cust_main->agent_custid),
2401     ( map { $_ => &$escape_function($cust_main->$_()) } qw(
2402       payname company address1 address2 city state zip fax
2403     )),
2404
2405     #global config
2406     'ship_enable'     => $conf->exists('invoice-ship_address'),
2407     'unitprices'      => $conf->exists('invoice-unitprice'),
2408     'smallernotes'    => $conf->exists('invoice-smallernotes'),
2409     'smallerfooter'   => $conf->exists('invoice-smallerfooter'),
2410     'balance_due_below_line' => $conf->exists('balance_due_below_line'),
2411    
2412     #layout info -- would be fancy to calc some of this and bury the template
2413     #               here in the code
2414     'topmargin'             => scalar($conf->config('invoice_latextopmargin', $agentnum)),
2415     'headsep'               => scalar($conf->config('invoice_latexheadsep', $agentnum)),
2416     'textheight'            => scalar($conf->config('invoice_latextextheight', $agentnum)),
2417     'extracouponspace'      => scalar($conf->config('invoice_latexextracouponspace', $agentnum)),
2418     'couponfootsep'         => scalar($conf->config('invoice_latexcouponfootsep', $agentnum)),
2419     'verticalreturnaddress' => $conf->exists('invoice_latexverticalreturnaddress', $agentnum),
2420     'addresssep'            => scalar($conf->config('invoice_latexaddresssep', $agentnum)),
2421     'amountenclosedsep'     => scalar($conf->config('invoice_latexcouponamountenclosedsep', $agentnum)),
2422     'coupontoaddresssep'    => scalar($conf->config('invoice_latexcoupontoaddresssep', $agentnum)),
2423     'addcompanytoaddress'   => $conf->exists('invoice_latexcouponaddcompanytoaddress', $agentnum),
2424
2425     # better hang on to conf_dir for a while (for old templates)
2426     'conf_dir'        => "$FS::UID::conf_dir/conf.$FS::UID::datasrc",
2427
2428     #these are only used when doing paged plaintext
2429     'page'            => 1,
2430     'total_pages'     => 1,
2431
2432   );
2433
2434   $invoice_data{finance_section} = '';
2435   if ( $conf->config('finance_pkgclass') ) {
2436     my $pkg_class =
2437       qsearchs('pkg_class', { classnum => $conf->config('finance_pkgclass') });
2438     $invoice_data{finance_section} = $pkg_class->categoryname;
2439   } 
2440   $invoice_data{finance_amount} = '0.00';
2441   $invoice_data{finance_section} ||= 'Finance Charges'; #avoid config confusion
2442
2443   my $countrydefault = $conf->config('countrydefault') || 'US';
2444   my $prefix = $cust_main->has_ship_address ? 'ship_' : '';
2445   foreach ( qw( contact company address1 address2 city state zip country fax) ){
2446     my $method = $prefix.$_;
2447     $invoice_data{"ship_$_"} = _latex_escape($cust_main->$method);
2448   }
2449   $invoice_data{'ship_country'} = ''
2450     if ( $invoice_data{'ship_country'} eq $countrydefault );
2451   
2452   $invoice_data{'cid'} = $params{'cid'}
2453     if $params{'cid'};
2454
2455   if ( $cust_main->country eq $countrydefault ) {
2456     $invoice_data{'country'} = '';
2457   } else {
2458     $invoice_data{'country'} = &$escape_function(code2country($cust_main->country));
2459   }
2460
2461   my @address = ();
2462   $invoice_data{'address'} = \@address;
2463   push @address,
2464     $cust_main->payname.
2465       ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
2466         ? " (P.O. #". $cust_main->payinfo. ")"
2467         : ''
2468       )
2469   ;
2470   push @address, $cust_main->company
2471     if $cust_main->company;
2472   push @address, $cust_main->address1;
2473   push @address, $cust_main->address2
2474     if $cust_main->address2;
2475   push @address,
2476     $cust_main->city. ", ". $cust_main->state. "  ".  $cust_main->zip;
2477   push @address, $invoice_data{'country'}
2478     if $invoice_data{'country'};
2479   push @address, ''
2480     while (scalar(@address) < 5);
2481
2482   $invoice_data{'logo_file'} = $params{'logo_file'}
2483     if $params{'logo_file'};
2484
2485   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
2486 #  my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
2487   #my $balance_due = $self->owed + $pr_total - $cr_total;
2488   my $balance_due = $self->owed + $pr_total;
2489   $invoice_data{'true_previous_balance'} = sprintf("%.2f", ($self->previous_balance || 0) );
2490   $invoice_data{'balance_adjustments'} = sprintf("%.2f", ($self->previous_balance || 0) - ($self->billing_balance || 0) );
2491   $invoice_data{'previous_balance'} = sprintf("%.2f", $pr_total);
2492   $invoice_data{'balance'} = sprintf("%.2f", $balance_due);
2493
2494   my $summarypage = '';
2495   if ( $conf->exists('invoice_usesummary', $agentnum) ) {
2496     $summarypage = 1;
2497   }
2498   $invoice_data{'summarypage'} = $summarypage;
2499
2500   #do variable substitution in notes, footer, smallfooter
2501   foreach my $include (qw( notes footer smallfooter coupon )) {
2502
2503     my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
2504     my @inc_src;
2505
2506     if ( $conf->exists($inc_file, $agentnum)
2507          && length( $conf->config($inc_file, $agentnum) ) ) {
2508
2509       @inc_src = $conf->config($inc_file, $agentnum);
2510
2511     } else {
2512
2513       $inc_file = $conf->key_orbase("invoice_latex$include", $template);
2514
2515       my $convert_map = $convert_maps{$format}{$include};
2516
2517       @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
2518                        s/--\@\]/$delimiters{$format}[1]/g;
2519                        $_;
2520                      } 
2521                  &$convert_map( $conf->config($inc_file, $agentnum) );
2522
2523     }
2524
2525     my $inc_tt = new Text::Template (
2526       TYPE       => 'ARRAY',
2527       SOURCE     => [ map "$_\n", @inc_src ],
2528       DELIMITERS => $delimiters{$format},
2529     ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
2530
2531     unless ( $inc_tt->compile() ) {
2532       my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
2533       warn $error. "Template:\n". join('', map "$_\n", @inc_src);
2534       die $error;
2535     }
2536
2537     $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
2538
2539     $invoice_data{$include} =~ s/\n+$//
2540       if ($format eq 'latex');
2541   }
2542
2543   $invoice_data{'po_line'} =
2544     (  $cust_main->payby eq 'BILL' && $cust_main->payinfo )
2545       ? &$escape_function("Purchase Order #". $cust_main->payinfo)
2546       : $nbsp;
2547
2548   my %money_chars = ( 'latex'    => '',
2549                       'html'     => $conf->config('money_char') || '$',
2550                       'template' => '',
2551                     );
2552   my $money_char = $money_chars{$format};
2553
2554   my %other_money_chars = ( 'latex'    => '\dollar ',#XXX should be a config too
2555                             'html'     => $conf->config('money_char') || '$',
2556                             'template' => '',
2557                           );
2558   my $other_money_char = $other_money_chars{$format};
2559   $invoice_data{'dollar'} = $other_money_char;
2560
2561   my @detail_items = ();
2562   my @total_items = ();
2563   my @buf = ();
2564   my @sections = ();
2565
2566   $invoice_data{'detail_items'} = \@detail_items;
2567   $invoice_data{'total_items'} = \@total_items;
2568   $invoice_data{'buf'} = \@buf;
2569   $invoice_data{'sections'} = \@sections;
2570
2571   my $previous_section = { 'description' => 'Previous Charges',
2572                            'subtotal'    => $other_money_char.
2573                                             sprintf('%.2f', $pr_total),
2574                            'summarized'  => $summarypage ? 'Y' : '',
2575                          };
2576   $previous_section->{posttotal} = '0 / 30 / 60/ 90 days overdue '. 
2577     join(' / ', map { $cust_main->balance_date_range(@$_) }
2578                 $self->_prior_month30s
2579         )
2580     if $conf->exists('invoice_include_aging');
2581
2582   my $taxtotal = 0;
2583   my $tax_section = { 'description' => 'Taxes, Surcharges, and Fees',
2584                       'subtotal'    => $taxtotal,   # adjusted below
2585                       'summarized'  => $summarypage ? 'Y' : '',
2586                     };
2587   my $tax_weight = _pkg_category($tax_section->{description})
2588                         ? _pkg_category($tax_section->{description})->weight
2589                         : 0;
2590   $tax_section->{'summarized'} = $summarypage && !$tax_weight ? 'Y' : '';
2591   $tax_section->{'sort_weight'} = $tax_weight;
2592
2593
2594   my $adjusttotal = 0;
2595   my $adjust_section = { 'description' => 'Credits, Payments, and Adjustments',
2596                          'subtotal'    => 0,   # adjusted below
2597                          'summarized'  => $summarypage ? 'Y' : '',
2598                        };
2599   my $adjust_weight = _pkg_category($adjust_section->{description})
2600                         ? _pkg_category($adjust_section->{description})->weight
2601                         : 0;
2602   $adjust_section->{'summarized'} = $summarypage && !$adjust_weight ? 'Y' : '';
2603   $adjust_section->{'sort_weight'} = $adjust_weight;
2604
2605   my $unsquelched = $params{unsquelch_cdr} || $cust_main->squelch_cdr ne 'Y';
2606   my $multisection = $conf->exists('invoice_sections', $cust_main->agentnum);
2607   $invoice_data{'multisection'} = $multisection;
2608   my $late_sections = [];
2609   my $extra_sections = [];
2610   my $extra_lines = ();
2611   if ( $multisection ) {
2612     ($extra_sections, $extra_lines) =
2613       $self->_items_extra_usage_sections($escape_function_nonbsp, $format)
2614       if $conf->exists('usage_class_as_a_section', $cust_main->agentnum);
2615
2616     push @$extra_sections, $adjust_section if $adjust_section->{sort_weight};
2617
2618     push @detail_items, @$extra_lines if $extra_lines;
2619     push @sections,
2620       $self->_items_sections( $late_sections,      # this could stand a refactor
2621                               $summarypage,
2622                               $escape_function_nonbsp,
2623                               $extra_sections,
2624                               $format,             #bah
2625                             );
2626     if ($conf->exists('svc_phone_sections')) {
2627       my ($phone_sections, $phone_lines) =
2628         $self->_items_svc_phone_sections($escape_function_nonbsp, $format);
2629       push @{$late_sections}, @$phone_sections;
2630       push @detail_items, @$phone_lines;
2631     }
2632   }else{
2633     push @sections, { 'description' => '', 'subtotal' => '' };
2634   }
2635
2636   unless (    $conf->exists('disable_previous_balance')
2637            || $conf->exists('previous_balance-summary_only')
2638          )
2639   {
2640
2641     foreach my $line_item ( $self->_items_previous ) {
2642
2643       my $detail = {
2644         ext_description => [],
2645       };
2646       $detail->{'ref'} = $line_item->{'pkgnum'};
2647       $detail->{'quantity'} = 1;
2648       $detail->{'section'} = $previous_section;
2649       $detail->{'description'} = &$escape_function($line_item->{'description'});
2650       if ( exists $line_item->{'ext_description'} ) {
2651         @{$detail->{'ext_description'}} = map {
2652           &$escape_function($_);
2653         } @{$line_item->{'ext_description'}};
2654       }
2655       $detail->{'amount'} = ( $old_latex ? '' : $money_char).
2656                             $line_item->{'amount'};
2657       $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
2658
2659       push @detail_items, $detail;
2660       push @buf, [ $detail->{'description'},
2661                    $money_char. sprintf("%10.2f", $line_item->{'amount'}),
2662                  ];
2663     }
2664
2665   }
2666
2667   if ( @pr_cust_bill && !$conf->exists('disable_previous_balance') ) {
2668     push @buf, ['','-----------'];
2669     push @buf, [ 'Total Previous Balance',
2670                  $money_char. sprintf("%10.2f", $pr_total) ];
2671     push @buf, ['',''];
2672   }
2673  
2674   if ( $conf->exists('svc_phone-did-summary') ) {
2675       my ($didsummary,$minutes) = $self->_did_summary;
2676       my $didsummary_desc = 'DID Activity Summary (Past 30 days)';
2677       push @detail_items, 
2678         { 'description' => $didsummary_desc,
2679             'ext_description' => [ $didsummary, $minutes ],
2680         }
2681         if !$multisection;
2682   }
2683
2684   foreach my $section (@sections, @$late_sections) {
2685
2686     # begin some normalization
2687     $section->{'subtotal'} = $section->{'amount'}
2688       if $multisection
2689          && !exists($section->{subtotal})
2690          && exists($section->{amount});
2691
2692     $invoice_data{finance_amount} = sprintf('%.2f', $section->{'subtotal'} )
2693       if ( $invoice_data{finance_section} &&
2694            $section->{'description'} eq $invoice_data{finance_section} );
2695
2696     $section->{'subtotal'} = $other_money_char.
2697                              sprintf('%.2f', $section->{'subtotal'})
2698       if $multisection;
2699
2700     # continue some normalization
2701     $section->{'amount'}   = $section->{'subtotal'}
2702       if $multisection;
2703
2704
2705     if ( $section->{'description'} ) {
2706       push @buf, ( [ &$escape_function($section->{'description'}), '' ],
2707                    [ '', '' ],
2708                  );
2709     }
2710
2711     my $multilocation = scalar($cust_main->cust_location); #too expensive?
2712     my %options = ();
2713     $options{'section'} = $section if $multisection;
2714     $options{'format'} = $format;
2715     $options{'escape_function'} = $escape_function;
2716     $options{'format_function'} = sub { () } unless $unsquelched;
2717     $options{'unsquelched'} = $unsquelched;
2718     $options{'summary_page'} = $summarypage;
2719     $options{'skip_usage'} =
2720       scalar(@$extra_sections) && !grep{$section == $_} @$extra_sections;
2721     $options{'multilocation'} = $multilocation;
2722     $options{'multisection'} = $multisection;
2723
2724     foreach my $line_item ( $self->_items_pkg(%options) ) {
2725       my $detail = {
2726         ext_description => [],
2727       };
2728       $detail->{'ref'} = $line_item->{'pkgnum'};
2729       $detail->{'quantity'} = $line_item->{'quantity'};
2730       $detail->{'section'} = $section;
2731       $detail->{'description'} = &$escape_function($line_item->{'description'});
2732       if ( exists $line_item->{'ext_description'} ) {
2733         @{$detail->{'ext_description'}} = @{$line_item->{'ext_description'}};
2734       }
2735       $detail->{'amount'} = ( $old_latex ? '' : $money_char ).
2736                               $line_item->{'amount'};
2737       $detail->{'unit_amount'} = ( $old_latex ? '' : $money_char ).
2738                                  $line_item->{'unit_amount'};
2739       $detail->{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
2740   
2741       push @detail_items, $detail;
2742       push @buf, ( [ $detail->{'description'},
2743                      $money_char. sprintf("%10.2f", $line_item->{'amount'}),
2744                    ],
2745                    map { [ " ". $_, '' ] } @{$detail->{'ext_description'}},
2746                  );
2747     }
2748
2749     if ( $section->{'description'} ) {
2750       push @buf, ( ['','-----------'],
2751                    [ $section->{'description'}. ' sub-total',
2752                       $money_char. sprintf("%10.2f", $section->{'subtotal'})
2753                    ],
2754                    [ '', '' ],
2755                    [ '', '' ],
2756                  );
2757     }
2758   
2759   }
2760   
2761   $invoice_data{current_less_finance} =
2762     sprintf('%.2f', $self->charged - $invoice_data{finance_amount} );
2763
2764   if ( $multisection && !$conf->exists('disable_previous_balance')
2765     || $conf->exists('previous_balance-summary_only') )
2766   {
2767     unshift @sections, $previous_section if $pr_total;
2768   }
2769
2770   foreach my $tax ( $self->_items_tax ) {
2771
2772     $taxtotal += $tax->{'amount'};
2773
2774     my $description = &$escape_function( $tax->{'description'} );
2775     my $amount      = sprintf( '%.2f', $tax->{'amount'} );
2776
2777     if ( $multisection ) {
2778
2779       my $money = $old_latex ? '' : $money_char;
2780       push @detail_items, {
2781         ext_description => [],
2782         ref          => '',
2783         quantity     => '',
2784         description  => $description,
2785         amount       => $money. $amount,
2786         product_code => '',
2787         section      => $tax_section,
2788       };
2789
2790     } else {
2791
2792       push @total_items, {
2793         'total_item'   => $description,
2794         'total_amount' => $other_money_char. $amount,
2795       };
2796
2797     }
2798
2799     push @buf,[ $description,
2800                 $money_char. $amount,
2801               ];
2802
2803   }
2804   
2805   if ( $taxtotal ) {
2806     my $total = {};
2807     $total->{'total_item'} = 'Sub-total';
2808     $total->{'total_amount'} =
2809       $other_money_char. sprintf('%.2f', $self->charged - $taxtotal );
2810
2811     if ( $multisection ) {
2812       $tax_section->{'subtotal'} = $other_money_char.
2813                                    sprintf('%.2f', $taxtotal);
2814       $tax_section->{'pretotal'} = 'New charges sub-total '.
2815                                    $total->{'total_amount'};
2816       push @sections, $tax_section if $taxtotal;
2817     }else{
2818       unshift @total_items, $total;
2819     }
2820   }
2821   $invoice_data{'taxtotal'} = sprintf('%.2f', $taxtotal);
2822
2823   push @buf,['','-----------'];
2824   push @buf,[( $conf->exists('disable_previous_balance') 
2825                ? 'Total Charges'
2826                : 'Total New Charges'
2827              ),
2828              $money_char. sprintf("%10.2f",$self->charged) ];
2829   push @buf,['',''];
2830
2831   {
2832     my $total = {};
2833     my $item = 'Total';
2834     $item = $conf->config('previous_balance-exclude_from_total')
2835          || 'Total New Charges'
2836       if $conf->exists('previous_balance-exclude_from_total');
2837     my $amount = $self->charged +
2838                    ( $conf->exists('disable_previous_balance') ||
2839                      $conf->exists('previous_balance-exclude_from_total')
2840                      ? 0
2841                      : $pr_total
2842                    );
2843     $total->{'total_item'} = &$embolden_function($item);
2844     $total->{'total_amount'} =
2845       &$embolden_function( $other_money_char.  sprintf( '%.2f', $amount ) );
2846     if ( $multisection ) {
2847       if ( $adjust_section->{'sort_weight'} ) {
2848         $adjust_section->{'posttotal'} = 'Balance Forward '. $other_money_char.
2849           sprintf("%.2f", ($self->billing_balance || 0) );
2850       } else {
2851         $adjust_section->{'pretotal'} = 'New charges total '. $other_money_char.
2852                                         sprintf('%.2f', $self->charged );
2853       } 
2854     }else{
2855       push @total_items, $total;
2856     }
2857     push @buf,['','-----------'];
2858     push @buf,[$item,
2859                $money_char.
2860                sprintf( '%10.2f', $amount )
2861               ];
2862     push @buf,['',''];
2863   }
2864   
2865   unless ( $conf->exists('disable_previous_balance') ) {
2866     #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
2867   
2868     # credits
2869     my $credittotal = 0;
2870     foreach my $credit ( $self->_items_credits('trim_len'=>60) ) {
2871
2872       my $total;
2873       $total->{'total_item'} = &$escape_function($credit->{'description'});
2874       $credittotal += $credit->{'amount'};
2875       $total->{'total_amount'} = '-'. $other_money_char. $credit->{'amount'};
2876       $adjusttotal += $credit->{'amount'};
2877       if ( $multisection ) {
2878         my $money = $old_latex ? '' : $money_char;
2879         push @detail_items, {
2880           ext_description => [],
2881           ref          => '',
2882           quantity     => '',
2883           description  => &$escape_function($credit->{'description'}),
2884           amount       => $money. $credit->{'amount'},
2885           product_code => '',
2886           section      => $adjust_section,
2887         };
2888       } else {
2889         push @total_items, $total;
2890       }
2891
2892     }
2893     $invoice_data{'credittotal'} = sprintf('%.2f', $credittotal);
2894
2895     #credits (again)
2896     foreach my $credit ( $self->_items_credits('trim_len'=>32) ) {
2897       push @buf, [ $credit->{'description'}, $money_char.$credit->{'amount'} ];
2898     }
2899
2900     # payments
2901     my $paymenttotal = 0;
2902     foreach my $payment ( $self->_items_payments ) {
2903       my $total = {};
2904       $total->{'total_item'} = &$escape_function($payment->{'description'});
2905       $paymenttotal += $payment->{'amount'};
2906       $total->{'total_amount'} = '-'. $other_money_char. $payment->{'amount'};
2907       $adjusttotal += $payment->{'amount'};
2908       if ( $multisection ) {
2909         my $money = $old_latex ? '' : $money_char;
2910         push @detail_items, {
2911           ext_description => [],
2912           ref          => '',
2913           quantity     => '',
2914           description  => &$escape_function($payment->{'description'}),
2915           amount       => $money. $payment->{'amount'},
2916           product_code => '',
2917           section      => $adjust_section,
2918         };
2919       }else{
2920         push @total_items, $total;
2921       }
2922       push @buf, [ $payment->{'description'},
2923                    $money_char. sprintf("%10.2f", $payment->{'amount'}),
2924                  ];
2925     }
2926     $invoice_data{'paymenttotal'} = sprintf('%.2f', $paymenttotal);
2927   
2928     if ( $multisection ) {
2929       $adjust_section->{'subtotal'} = $other_money_char.
2930                                       sprintf('%.2f', $adjusttotal);
2931       push @sections, $adjust_section
2932         unless $adjust_section->{sort_weight};
2933     }
2934
2935     { 
2936       my $total;
2937       $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
2938       $total->{'total_amount'} =
2939         &$embolden_function(
2940           $other_money_char. sprintf('%.2f', $summarypage 
2941                                                ? $self->charged +
2942                                                  $self->billing_balance
2943                                                : $self->owed + $pr_total
2944                                     )
2945         );
2946       if ( $multisection && !$adjust_section->{sort_weight} ) {
2947         $adjust_section->{'posttotal'} = $total->{'total_item'}. ' '.
2948                                          $total->{'total_amount'};
2949       }else{
2950         push @total_items, $total;
2951       }
2952       push @buf,['','-----------'];
2953       push @buf,[$self->balance_due_msg, $money_char. 
2954         sprintf("%10.2f", $balance_due ) ];
2955     }
2956   }
2957
2958   if ( $multisection ) {
2959     if ($conf->exists('svc_phone_sections')) {
2960       my $total;
2961       $total->{'total_item'} = &$embolden_function($self->balance_due_msg);
2962       $total->{'total_amount'} =
2963         &$embolden_function(
2964           $other_money_char. sprintf('%.2f', $self->owed + $pr_total)
2965         );
2966       my $last_section = pop @sections;
2967       $last_section->{'posttotal'} = $total->{'total_item'}. ' '.
2968                                      $total->{'total_amount'};
2969       push @sections, $last_section;
2970     }
2971     push @sections, @$late_sections
2972       if $unsquelched;
2973   }
2974
2975   my @includelist = ();
2976   push @includelist, 'summary' if $summarypage;
2977   foreach my $include ( @includelist ) {
2978
2979     my $inc_file = $conf->key_orbase("invoice_${format}$include", $template);
2980     my @inc_src;
2981
2982     if ( length( $conf->config($inc_file, $agentnum) ) ) {
2983
2984       @inc_src = $conf->config($inc_file, $agentnum);
2985
2986     } else {
2987
2988       $inc_file = $conf->key_orbase("invoice_latex$include", $template);
2989
2990       my $convert_map = $convert_maps{$format}{$include};
2991
2992       @inc_src = map { s/\[\@--/$delimiters{$format}[0]/g;
2993                        s/--\@\]/$delimiters{$format}[1]/g;
2994                        $_;
2995                      } 
2996                  &$convert_map( $conf->config($inc_file, $agentnum) );
2997
2998     }
2999
3000     my $inc_tt = new Text::Template (
3001       TYPE       => 'ARRAY',
3002       SOURCE     => [ map "$_\n", @inc_src ],
3003       DELIMITERS => $delimiters{$format},
3004     ) or die "Can't create new Text::Template object: $Text::Template::ERROR";
3005
3006     unless ( $inc_tt->compile() ) {
3007       my $error = "Can't compile $inc_file template: $Text::Template::ERROR\n";
3008       warn $error. "Template:\n". join('', map "$_\n", @inc_src);
3009       die $error;
3010     }
3011
3012     $invoice_data{$include} = $inc_tt->fill_in( HASH => \%invoice_data );
3013
3014     $invoice_data{$include} =~ s/\n+$//
3015       if ($format eq 'latex');
3016   }
3017
3018   $invoice_lines = 0;
3019   my $wasfunc = 0;
3020   foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
3021     /invoice_lines\((\d*)\)/;
3022     $invoice_lines += $1 || scalar(@buf);
3023     $wasfunc=1;
3024   }
3025   die "no invoice_lines() functions in template?"
3026     if ( $format eq 'template' && !$wasfunc );
3027
3028   if ($format eq 'template') {
3029
3030     if ( $invoice_lines ) {
3031       $invoice_data{'total_pages'} = int( scalar(@buf) / $invoice_lines );
3032       $invoice_data{'total_pages'}++
3033         if scalar(@buf) % $invoice_lines;
3034     }
3035
3036     #setup subroutine for the template
3037     sub FS::cust_bill::_template::invoice_lines {
3038       my $lines = shift || scalar(@FS::cust_bill::_template::buf);
3039       map { 
3040         scalar(@FS::cust_bill::_template::buf)
3041           ? shift @FS::cust_bill::_template::buf
3042           : [ '', '' ];
3043       }
3044       ( 1 .. $lines );
3045     }
3046
3047     my $lines;
3048     my @collect;
3049     while (@buf) {
3050       push @collect, split("\n",
3051         $text_template->fill_in( HASH => \%invoice_data,
3052                                  PACKAGE => 'FS::cust_bill::_template'
3053                                )
3054       );
3055       $FS::cust_bill::_template::page++;
3056     }
3057     map "$_\n", @collect;
3058   }else{
3059     warn "filling in template for invoice ". $self->invnum. "\n"
3060       if $DEBUG;
3061     warn join("\n", map " $_ => ". $invoice_data{$_}, keys %invoice_data). "\n"
3062       if $DEBUG > 1;
3063
3064     $text_template->fill_in(HASH => \%invoice_data);
3065   }
3066 }
3067
3068 # helper routine for generating date ranges
3069 sub _prior_month30s {
3070   my $self = shift;
3071   my @ranges = (
3072    [ 1,       2592000 ], # 0-30 days ago
3073    [ 2592000, 5184000 ], # 30-60 days ago
3074    [ 5184000, 7776000 ], # 60-90 days ago
3075    [ 7776000, 0       ], # 90+   days ago
3076   );
3077
3078   map { [ $_->[0] ? $self->_date - $_->[0] - 1 : '',
3079           $_->[1] ? $self->_date - $_->[1] - 1 : '',
3080       ] }
3081   @ranges;
3082 }
3083
3084 =item print_ps HASHREF | [ TIME [ , TEMPLATE ] ]
3085
3086 Returns an postscript invoice, as a scalar.
3087
3088 Options can be passed as a hashref (recommended) or as a list of time, template
3089 and then any key/value pairs for any other options.
3090
3091 I<time> an optional value used to control the printing of overdue messages.  The
3092 default is now.  It isn't the date of the invoice; that's the `_date' field.
3093 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
3094 L<Time::Local> and L<Date::Parse> for conversion functions.
3095
3096 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
3097
3098 =cut
3099
3100 sub print_ps {
3101   my $self = shift;
3102
3103   my ($file, $lfile) = $self->print_latex(@_);
3104   my $ps = generate_ps($file);
3105   unlink($lfile);
3106
3107   $ps;
3108 }
3109
3110 =item print_pdf HASHREF | [ TIME [ , TEMPLATE ] ]
3111
3112 Returns an PDF invoice, as a scalar.
3113
3114 Options can be passed as a hashref (recommended) or as a list of time, template
3115 and then any key/value pairs for any other options.
3116
3117 I<time> an optional value used to control the printing of overdue messages.  The
3118 default is now.  It isn't the date of the invoice; that's the `_date' field.
3119 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
3120 L<Time::Local> and L<Date::Parse> for conversion functions.
3121
3122 I<template>, if specified, is the name of a suffix for alternate invoices.
3123
3124 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
3125
3126 =cut
3127
3128 sub print_pdf {
3129   my $self = shift;
3130
3131   my ($file, $lfile) = $self->print_latex(@_);
3132   my $pdf = generate_pdf($file);
3133   unlink($lfile);
3134
3135   $pdf;
3136 }
3137
3138 =item print_html HASHREF | [ TIME [ , TEMPLATE [ , CID ] ] ]
3139
3140 Returns an HTML invoice, as a scalar.
3141
3142 I<time> an optional value used to control the printing of overdue messages.  The
3143 default is now.  It isn't the date of the invoice; that's the `_date' field.
3144 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
3145 L<Time::Local> and L<Date::Parse> for conversion functions.
3146
3147 I<template>, if specified, is the name of a suffix for alternate invoices.
3148
3149 I<notice_name>, if specified, overrides "Invoice" as the name of the sent document (templates from 10/2009 or newer required)
3150
3151 I<cid> is a MIME Content-ID used to create a "cid:" URL for the logo image, used
3152 when emailing the invoice as part of a multipart/related MIME email.
3153
3154 =cut
3155
3156 sub print_html {
3157   my $self = shift;
3158   my %params;
3159   if ( ref($_[0]) ) {
3160     %params = %{ shift() }; 
3161   }else{
3162     $params{'time'} = shift;
3163     $params{'template'} = shift;
3164     $params{'cid'} = shift;
3165   }
3166
3167   $params{'format'} = 'html';
3168
3169   $self->print_generic( %params );
3170 }
3171
3172 # quick subroutine for print_latex
3173 #
3174 # There are ten characters that LaTeX treats as special characters, which
3175 # means that they do not simply typeset themselves: 
3176 #      # $ % & ~ _ ^ \ { }
3177 #
3178 # TeX ignores blanks following an escaped character; if you want a blank (as
3179 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ..."). 
3180
3181 sub _latex_escape {
3182   my $value = shift;
3183   $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( ( defined($2) && length($2) ) ? "\\$2" : '' )/ge;
3184   $value =~ s/([<>])/\$$1\$/g;
3185   $value;
3186 }
3187
3188 sub _html_escape {
3189   my $value = shift;
3190   encode_entities($value);
3191   $value;
3192 }
3193
3194 sub _html_escape_nbsp {
3195   my $value = _html_escape(shift);
3196   $value =~ s/ +/&nbsp;/g;
3197   $value;
3198 }
3199
3200 #utility methods for print_*
3201
3202 sub _translate_old_latex_format {
3203   warn "_translate_old_latex_format called\n"
3204     if $DEBUG; 
3205
3206   my @template = ();
3207   while ( @_ ) {
3208     my $line = shift;
3209   
3210     if ( $line =~ /^%%Detail\s*$/ ) {
3211   
3212       push @template, q![@--!,
3213                       q!  foreach my $_tr_line (@detail_items) {!,
3214                       q!    if ( scalar ($_tr_item->{'ext_description'} ) ) {!,
3215                       q!      $_tr_line->{'description'} .= !, 
3216                       q!        "\\tabularnewline\n~~".!,
3217                       q!        join( "\\tabularnewline\n~~",!,
3218                       q!          @{$_tr_line->{'ext_description'}}!,
3219                       q!        );!,
3220                       q!    }!;
3221
3222       while ( ( my $line_item_line = shift )
3223               !~ /^%%EndDetail\s*$/                            ) {
3224         $line_item_line =~ s/'/\\'/g;    # nice LTS
3225         $line_item_line =~ s/\\/\\\\/g;  # escape quotes and backslashes
3226         $line_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
3227         push @template, "    \$OUT .= '$line_item_line';";
3228       }
3229
3230       push @template, '}',
3231                       '--@]';
3232       #' doh, gvim
3233     } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
3234
3235       push @template, '[@--',
3236                       '  foreach my $_tr_line (@total_items) {';
3237
3238       while ( ( my $total_item_line = shift )
3239               !~ /^%%EndTotalDetails\s*$/                      ) {
3240         $total_item_line =~ s/'/\\'/g;    # nice LTS
3241         $total_item_line =~ s/\\/\\\\/g;  # escape quotes and backslashes
3242         $total_item_line =~ s/\$(\w+)/'. \$_tr_line->{$1}. '/g;
3243         push @template, "    \$OUT .= '$total_item_line';";
3244       }
3245
3246       push @template, '}',
3247                       '--@]';
3248
3249     } else {
3250       $line =~ s/\$(\w+)/[\@-- \$$1 --\@]/g;
3251       push @template, $line;  
3252     }
3253   
3254   }
3255
3256   if ($DEBUG) {
3257     warn "$_\n" foreach @template;
3258   }
3259
3260   (@template);
3261 }
3262
3263 sub terms {
3264   my $self = shift;
3265
3266   #check for an invoice-specific override
3267   return $self->invoice_terms if $self->invoice_terms;
3268   
3269   #check for a customer- specific override
3270   my $cust_main = $self->cust_main;
3271   return $cust_main->invoice_terms if $cust_main->invoice_terms;
3272
3273   #use configured default
3274   $conf->config('invoice_default_terms') || '';
3275 }
3276
3277 sub due_date {
3278   my $self = shift;
3279   my $duedate = '';
3280   if ( $self->terms =~ /^\s*Net\s*(\d+)\s*$/ ) {
3281     $duedate = $self->_date() + ( $1 * 86400 );
3282   }
3283   $duedate;
3284 }
3285
3286 sub due_date2str {
3287   my $self = shift;
3288   $self->due_date ? time2str(shift, $self->due_date) : '';
3289 }
3290
3291 sub balance_due_msg {
3292   my $self = shift;
3293   my $msg = 'Balance Due';
3294   return $msg unless $self->terms;
3295   if ( $self->due_date ) {
3296     $msg .= ' - Please pay by '. $self->due_date2str($date_format);
3297   } elsif ( $self->terms ) {
3298     $msg .= ' - '. $self->terms;
3299   }
3300   $msg;
3301 }
3302
3303 sub balance_due_date {
3304   my $self = shift;
3305   my $duedate = '';
3306   if (    $conf->exists('invoice_default_terms') 
3307        && $conf->config('invoice_default_terms')=~ /^\s*Net\s*(\d+)\s*$/ ) {
3308     $duedate = time2str($rdate_format, $self->_date + ($1*86400) );
3309   }
3310   $duedate;
3311 }
3312
3313 =item invnum_date_pretty
3314
3315 Returns a string with the invoice number and date, for example:
3316 "Invoice #54 (3/20/2008)"
3317
3318 =cut
3319
3320 sub invnum_date_pretty {
3321   my $self = shift;
3322   'Invoice #'. $self->invnum. ' ('. $self->_date_pretty. ')';
3323 }
3324
3325 =item _date_pretty
3326
3327 Returns a string with the date, for example: "3/20/2008"
3328
3329 =cut
3330
3331 sub _date_pretty {
3332   my $self = shift;
3333   time2str($date_format, $self->_date);
3334 }
3335
3336 use vars qw(%pkg_category_cache);
3337 sub _items_sections {
3338   my $self = shift;
3339   my $late = shift;
3340   my $summarypage = shift;
3341   my $escape = shift;
3342   my $extra_sections = shift;
3343   my $format = shift;
3344
3345   my %subtotal = ();
3346   my %late_subtotal = ();
3347   my %not_tax = ();
3348
3349   foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
3350   {
3351
3352       my $usage = $cust_bill_pkg->usage;
3353
3354       foreach my $display ($cust_bill_pkg->cust_bill_pkg_display) {
3355         next if ( $display->summary && $summarypage );
3356
3357         my $section = $display->section;
3358         my $type    = $display->type;
3359
3360         $not_tax{$section} = 1
3361           unless $cust_bill_pkg->pkgnum == 0;
3362
3363         if ( $display->post_total && !$summarypage ) {
3364           if (! $type || $type eq 'S') {
3365             $late_subtotal{$section} += $cust_bill_pkg->setup
3366               if $cust_bill_pkg->setup != 0;
3367           }
3368
3369           if (! $type) {
3370             $late_subtotal{$section} += $cust_bill_pkg->recur
3371               if $cust_bill_pkg->recur != 0;
3372           }
3373
3374           if ($type && $type eq 'R') {
3375             $late_subtotal{$section} += $cust_bill_pkg->recur - $usage
3376               if $cust_bill_pkg->recur != 0;
3377           }
3378           
3379           if ($type && $type eq 'U') {
3380             $late_subtotal{$section} += $usage
3381               unless scalar(@$extra_sections);
3382           }
3383
3384         } else {
3385
3386           next if $cust_bill_pkg->pkgnum == 0 && ! $section;
3387
3388           if (! $type || $type eq 'S') {
3389             $subtotal{$section} += $cust_bill_pkg->setup
3390               if $cust_bill_pkg->setup != 0;
3391           }
3392
3393           if (! $type) {
3394             $subtotal{$section} += $cust_bill_pkg->recur
3395               if $cust_bill_pkg->recur != 0;
3396           }
3397
3398           if ($type && $type eq 'R') {
3399             $subtotal{$section} += $cust_bill_pkg->recur - $usage
3400               if $cust_bill_pkg->recur != 0;
3401           }
3402           
3403           if ($type && $type eq 'U') {
3404             $subtotal{$section} += $usage
3405               unless scalar(@$extra_sections);
3406           }
3407
3408         }
3409
3410       }
3411
3412   }
3413
3414   %pkg_category_cache = ();
3415
3416   push @$late, map { { 'description' => &{$escape}($_),
3417                        'subtotal'    => $late_subtotal{$_},
3418                        'post_total'  => 1,
3419                        'sort_weight' => ( _pkg_category($_)
3420                                             ? _pkg_category($_)->weight
3421                                             : 0
3422                                        ),
3423                        ((_pkg_category($_) && _pkg_category($_)->condense)
3424                                            ? $self->_condense_section($format)
3425                                            : ()
3426                        ),
3427                    } }
3428                  sort _sectionsort keys %late_subtotal;
3429
3430   my @sections;
3431   if ( $summarypage ) {
3432     @sections = grep { exists($subtotal{$_}) || ! _pkg_category($_)->disabled }
3433                 map { $_->categoryname } qsearch('pkg_category', {});
3434     push @sections, '' if exists($subtotal{''});
3435   } else {
3436     @sections = keys %subtotal;
3437   }
3438
3439   my @early = map { { 'description' => &{$escape}($_),
3440                       'subtotal'    => $subtotal{$_},
3441                       'summarized'  => $not_tax{$_} ? '' : 'Y',
3442                       'tax_section' => $not_tax{$_} ? '' : 'Y',
3443                       'sort_weight' => ( _pkg_category($_)
3444                                            ? _pkg_category($_)->weight
3445                                            : 0
3446                                        ),
3447                        ((_pkg_category($_) && _pkg_category($_)->condense)
3448                                            ? $self->_condense_section($format)
3449                                            : ()
3450                        ),
3451                     }
3452                   } @sections;
3453   push @early, @$extra_sections if $extra_sections;
3454  
3455   sort { $a->{sort_weight} <=> $b->{sort_weight} } @early;
3456
3457 }
3458
3459 #helper subs for above
3460
3461 sub _sectionsort {
3462   _pkg_category($a)->weight <=> _pkg_category($b)->weight;
3463 }
3464
3465 sub _pkg_category {
3466   my $categoryname = shift;
3467   $pkg_category_cache{$categoryname} ||=
3468     qsearchs( 'pkg_category', { 'categoryname' => $categoryname } );
3469 }
3470
3471 my %condensed_format = (
3472   'label' => [ qw( Description Qty Amount ) ],
3473   'fields' => [
3474                 sub { shift->{description} },
3475                 sub { shift->{quantity} },
3476                 sub { my($href, %opt) = @_;
3477                       ($opt{dollar} || ''). $href->{amount};
3478                     },
3479               ],
3480   'align'  => [ qw( l r r ) ],
3481   'span'   => [ qw( 5 1 1 ) ],            # unitprices?
3482   'width'  => [ qw( 10.7cm 1.4cm 1.6cm ) ],   # don't like this
3483 );
3484
3485 sub _condense_section {
3486   my ( $self, $format ) = ( shift, shift );
3487   ( 'condensed' => 1,
3488     map { my $method = "_condensed_$_"; $_ => $self->$method($format) }
3489       qw( description_generator
3490           header_generator
3491           total_generator
3492           total_line_generator
3493         )
3494   );
3495 }
3496
3497 sub _condensed_generator_defaults {
3498   my ( $self, $format ) = ( shift, shift );
3499   return ( \%condensed_format, ' ', ' ', ' ', sub { shift } );
3500 }
3501
3502 my %html_align = (
3503   'c' => 'center',
3504   'l' => 'left',
3505   'r' => 'right',
3506 );
3507
3508 sub _condensed_header_generator {
3509   my ( $self, $format ) = ( shift, shift );
3510
3511   my ( $f, $prefix, $suffix, $separator, $column ) =
3512     _condensed_generator_defaults($format);
3513
3514   if ($format eq 'latex') {
3515     $prefix = "\\hline\n\\rule{0pt}{2.5ex}\n\\makebox[1.4cm]{}&\n";
3516     $suffix = "\\\\\n\\hline";
3517     $separator = "&\n";
3518     $column =
3519       sub { my ($d,$a,$s,$w) = @_;
3520             return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
3521           };
3522   } elsif ( $format eq 'html' ) {
3523     $prefix = '<th></th>';
3524     $suffix = '';
3525     $separator = '';
3526     $column =
3527       sub { my ($d,$a,$s,$w) = @_;
3528             return qq!<th align="$html_align{$a}">$d</th>!;
3529       };
3530   }
3531
3532   sub {
3533     my @args = @_;
3534     my @result = ();
3535
3536     foreach  (my $i = 0; $f->{label}->[$i]; $i++) {
3537       push @result,
3538         &{$column}( map { $f->{$_}->[$i] } qw(label align span width) );
3539     }
3540
3541     $prefix. join($separator, @result). $suffix;
3542   };
3543
3544 }
3545
3546 sub _condensed_description_generator {
3547   my ( $self, $format ) = ( shift, shift );
3548
3549   my ( $f, $prefix, $suffix, $separator, $column ) =
3550     _condensed_generator_defaults($format);
3551
3552   my $money_char = '$';
3553   if ($format eq 'latex') {
3554     $prefix = "\\hline\n\\multicolumn{1}{c}{\\rule{0pt}{2.5ex}~} &\n";
3555     $suffix = '\\\\';
3556     $separator = " & \n";
3557     $column =
3558       sub { my ($d,$a,$s,$w) = @_;
3559             return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{\\textbf{$d}}}";
3560           };
3561     $money_char = '\\dollar';
3562   }elsif ( $format eq 'html' ) {
3563     $prefix = '"><td align="center"></td>';
3564     $suffix = '';
3565     $separator = '';
3566     $column =
3567       sub { my ($d,$a,$s,$w) = @_;
3568             return qq!<td align="$html_align{$a}">$d</td>!;
3569       };
3570     #$money_char = $conf->config('money_char') || '$';
3571     $money_char = '';  # this is madness
3572   }
3573
3574   sub {
3575     #my @args = @_;
3576     my $href = shift;
3577     my @result = ();
3578
3579     foreach  (my $i = 0; $f->{label}->[$i]; $i++) {
3580       my $dollar = '';
3581       $dollar = $money_char if $i == scalar(@{$f->{label}})-1;
3582       push @result,
3583         &{$column}( &{$f->{fields}->[$i]}($href, 'dollar' => $dollar),
3584                     map { $f->{$_}->[$i] } qw(align span width)
3585                   );
3586     }
3587
3588     $prefix. join( $separator, @result ). $suffix;
3589   };
3590
3591 }
3592
3593 sub _condensed_total_generator {
3594   my ( $self, $format ) = ( shift, shift );
3595
3596   my ( $f, $prefix, $suffix, $separator, $column ) =
3597     _condensed_generator_defaults($format);
3598   my $style = '';
3599
3600   if ($format eq 'latex') {
3601     $prefix = "& ";
3602     $suffix = "\\\\\n";
3603     $separator = " & \n";
3604     $column =
3605       sub { my ($d,$a,$s,$w) = @_;
3606             return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
3607           };
3608   }elsif ( $format eq 'html' ) {
3609     $prefix = '';
3610     $suffix = '';
3611     $separator = '';
3612     $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
3613     $column =
3614       sub { my ($d,$a,$s,$w) = @_;
3615             return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
3616       };
3617   }
3618
3619
3620   sub {
3621     my @args = @_;
3622     my @result = ();
3623
3624     #  my $r = &{$f->{fields}->[$i]}(@args);
3625     #  $r .= ' Total' unless $i;
3626
3627     foreach  (my $i = 0; $f->{label}->[$i]; $i++) {
3628       push @result,
3629         &{$column}( &{$f->{fields}->[$i]}(@args). ($i ? '' : ' Total'),
3630                     map { $f->{$_}->[$i] } qw(align span width)
3631                   );
3632     }
3633
3634     $prefix. join( $separator, @result ). $suffix;
3635   };
3636
3637 }
3638
3639 =item total_line_generator FORMAT
3640
3641 Returns a coderef used for generation of invoice total line items for this
3642 usage_class.  FORMAT is either html or latex
3643
3644 =cut
3645
3646 # should not be used: will have issues with hash element names (description vs
3647 # total_item and amount vs total_amount -- another array of functions?
3648
3649 sub _condensed_total_line_generator {
3650   my ( $self, $format ) = ( shift, shift );
3651
3652   my ( $f, $prefix, $suffix, $separator, $column ) =
3653     _condensed_generator_defaults($format);
3654   my $style = '';
3655
3656   if ($format eq 'latex') {
3657     $prefix = "& ";
3658     $suffix = "\\\\\n";
3659     $separator = " & \n";
3660     $column =
3661       sub { my ($d,$a,$s,$w) = @_;
3662             return "\\multicolumn{$s}{$a}{\\makebox[$w][$a]{$d}}";
3663           };
3664   }elsif ( $format eq 'html' ) {
3665     $prefix = '';
3666     $suffix = '';
3667     $separator = '';
3668     $style = 'border-top: 3px solid #000000;border-bottom: 3px solid #000000;';
3669     $column =
3670       sub { my ($d,$a,$s,$w) = @_;
3671             return qq!<td align="$html_align{$a}" style="$style">$d</td>!;
3672       };
3673   }
3674
3675
3676   sub {
3677     my @args = @_;
3678     my @result = ();
3679
3680     foreach  (my $i = 0; $f->{label}->[$i]; $i++) {
3681       push @result,
3682         &{$column}( &{$f->{fields}->[$i]}(@args),
3683                     map { $f->{$_}->[$i] } qw(align span width)
3684                   );
3685     }
3686
3687     $prefix. join( $separator, @result ). $suffix;
3688   };
3689
3690 }
3691
3692 #sub _items_extra_usage_sections {
3693 #  my $self = shift;
3694 #  my $escape = shift;
3695 #
3696 #  my %sections = ();
3697 #
3698 #  my %usage_class =  map{ $_->classname, $_ } qsearch('usage_class', {});
3699 #  foreach my $cust_bill_pkg ( $self->cust_bill_pkg )
3700 #  {
3701 #    next unless $cust_bill_pkg->pkgnum > 0;
3702 #
3703 #    foreach my $section ( keys %usage_class ) {
3704 #
3705 #      my $usage = $cust_bill_pkg->usage($section);
3706 #
3707 #      next unless $usage && $usage > 0;
3708 #
3709 #      $sections{$section} ||= 0;
3710 #      $sections{$section} += $usage;
3711 #
3712 #    }
3713 #
3714 #  }
3715 #
3716 #  map { { 'description' => &{$escape}($_),
3717 #          'subtotal'    => $sections{$_},
3718 #          'summarized'  => '',
3719 #          'tax_section' => '',
3720 #        }
3721 #      }
3722 #    sort {$usage_class{$a}->weight <=> $usage_class{$b}->weight} keys %sections;
3723 #
3724 #}
3725
3726 sub _items_extra_usage_sections {
3727   my $self = shift;
3728   my $escape = shift;
3729   my $format = shift;
3730
3731   my %sections = ();
3732   my %classnums = ();
3733   my %lines = ();
3734
3735   my %usage_class =  map { $_->classnum => $_ } qsearch( 'usage_class', {} );
3736   foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
3737     next unless $cust_bill_pkg->pkgnum > 0;
3738
3739     foreach my $classnum ( keys %usage_class ) {
3740       my $section = $usage_class{$classnum}->classname;
3741       $classnums{$section} = $classnum;
3742
3743       foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail($classnum) ) {
3744         my $amount = $detail->amount;
3745         next unless $amount && $amount > 0;
3746  
3747         $sections{$section} ||= { 'subtotal'=>0, 'calls'=>0, 'duration'=>0 };
3748         $sections{$section}{amount} += $amount;  #subtotal
3749         $sections{$section}{calls}++;
3750         $sections{$section}{duration} += $detail->duration;
3751
3752         my $desc = $detail->regionname; 
3753         my $description = $desc;
3754         $description = substr($desc, 0, 50). '...'
3755           if $format eq 'latex' && length($desc) > 50;
3756
3757         $lines{$section}{$desc} ||= {
3758           description     => &{$escape}($description),
3759           #pkgpart         => $part_pkg->pkgpart,
3760           pkgnum          => $cust_bill_pkg->pkgnum,
3761           ref             => '',
3762           amount          => 0,
3763           calls           => 0,
3764           duration        => 0,
3765           #unit_amount     => $cust_bill_pkg->unitrecur,
3766           quantity        => $cust_bill_pkg->quantity,
3767           product_code    => 'N/A',
3768           ext_description => [],
3769         };
3770
3771         $lines{$section}{$desc}{amount} += $amount;
3772         $lines{$section}{$desc}{calls}++;
3773         $lines{$section}{$desc}{duration} += $detail->duration;
3774
3775       }
3776     }
3777   }
3778
3779   my %sectionmap = ();
3780   foreach (keys %sections) {
3781     my $usage_class = $usage_class{$classnums{$_}};
3782     $sectionmap{$_} = { 'description' => &{$escape}($_),
3783                         'amount'    => $sections{$_}{amount},    #subtotal
3784                         'calls'       => $sections{$_}{calls},
3785                         'duration'    => $sections{$_}{duration},
3786                         'summarized'  => '',
3787                         'tax_section' => '',
3788                         'sort_weight' => $usage_class->weight,
3789                         ( $usage_class->format
3790                           ? ( map { $_ => $usage_class->$_($format) }
3791                               qw( description_generator header_generator total_generator total_line_generator )
3792                             )
3793                           : ()
3794                         ), 
3795                       };
3796   }
3797
3798   my @sections = sort { $a->{sort_weight} <=> $b->{sort_weight} }
3799                  values %sectionmap;
3800
3801   my @lines = ();
3802   foreach my $section ( keys %lines ) {
3803     foreach my $line ( keys %{$lines{$section}} ) {
3804       my $l = $lines{$section}{$line};
3805       $l->{section}     = $sectionmap{$section};
3806       $l->{amount}      = sprintf( "%.2f", $l->{amount} );
3807       #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
3808       push @lines, $l;
3809     }
3810   }
3811
3812   return(\@sections, \@lines);
3813
3814 }
3815
3816 sub _did_summary {
3817     my $self = shift;
3818     my $end = $self->_date;
3819     my $start = $end - 2592000; # 30 days
3820     my $cust_main = $self->cust_main;
3821     my @pkgs = $cust_main->all_pkgs;
3822     my($num_activated,$num_deactivated,$num_portedin,$num_portedout,$minutes)
3823         = (0,0,0,0,0);
3824     my @seen = ();
3825     foreach my $pkg ( @pkgs ) {
3826         my @h_cust_svc = $pkg->h_cust_svc($end);
3827         foreach my $h_cust_svc ( @h_cust_svc ) {
3828             next if grep {$_ eq $h_cust_svc->svcnum} @seen;
3829             next unless $h_cust_svc->part_svc->svcdb eq 'svc_phone';
3830
3831             my $inserted = $h_cust_svc->date_inserted;
3832             my $deleted = $h_cust_svc->date_deleted;
3833             my $phone_inserted = $h_cust_svc->h_svc_x($inserted);
3834             my $phone_deleted;
3835             $phone_deleted =  $h_cust_svc->h_svc_x($deleted) if $deleted;
3836             
3837 # DID either activated or ported in; cannot be both for same DID simultaneously
3838             if ($inserted >= $start && $inserted <= $end && $phone_inserted
3839                 && (!$phone_inserted->lnp_status 
3840                     || $phone_inserted->lnp_status eq ''
3841                     || $phone_inserted->lnp_status eq 'native')) {
3842                 $num_activated++;
3843             }
3844             else { # this one not so clean, should probably move to (h_)svc_phone
3845                  my $phone_portedin = qsearchs( 'h_svc_phone',
3846                       { 'svcnum' => $h_cust_svc->svcnum, 
3847                         'lnp_status' => 'portedin' },  
3848                       FS::h_svc_phone->sql_h_searchs($end),  
3849                     );
3850                  $num_portedin++ if $phone_portedin;
3851             }
3852
3853 # DID either deactivated or ported out; cannot be both for same DID simultaneously
3854             if($deleted >= $start && $deleted <= $end && $phone_deleted
3855                 && (!$phone_deleted->lnp_status 
3856                     || $phone_deleted->lnp_status ne 'portingout')) {
3857                 $num_deactivated++;
3858             } 
3859             elsif($deleted >= $start && $deleted <= $end && $phone_deleted 
3860                 && $phone_deleted->lnp_status 
3861                 && $phone_deleted->lnp_status eq 'portingout') {
3862                 $num_portedout++;
3863             }
3864
3865             # increment usage minutes
3866             my @cdrs = $phone_inserted->get_cdrs('begin'=>$start,'end'=>$end);
3867             foreach my $cdr ( @cdrs ) {
3868                 $minutes += $cdr->billsec/60;
3869             }
3870
3871             # don't look at this service again
3872             push @seen, $h_cust_svc->svcnum;
3873         }
3874     }
3875
3876     $minutes = sprintf("%d", $minutes);
3877     ("Activated: $num_activated  Ported-In: $num_portedin  Deactivated: "
3878         . "$num_deactivated  Ported-Out: $num_portedout ",
3879             "Total Minutes: $minutes");
3880 }
3881
3882 sub _items_svc_phone_sections {
3883   my $self = shift;
3884   my $escape = shift;
3885   my $format = shift;
3886
3887   my %sections = ();
3888   my %classnums = ();
3889   my %lines = ();
3890
3891   my %usage_class =  map { $_->classnum => $_ } qsearch( 'usage_class', {} );
3892   $usage_class{''} ||= new FS::usage_class { 'classname' => '', 'weight' => 0 };
3893
3894   foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
3895     next unless $cust_bill_pkg->pkgnum > 0;
3896
3897     my @header = $cust_bill_pkg->details_header;
3898     next unless scalar(@header);
3899
3900     foreach my $detail ( $cust_bill_pkg->cust_bill_pkg_detail ) {
3901
3902       my $phonenum = $detail->phonenum;
3903       next unless $phonenum;
3904
3905       my $amount = $detail->amount;
3906       next unless $amount && $amount > 0;
3907
3908       $sections{$phonenum} ||= { 'amount'      => 0,
3909                                  'calls'       => 0,
3910                                  'duration'    => 0,
3911                                  'sort_weight' => -1,
3912                                  'phonenum'    => $phonenum,
3913                                 };
3914       $sections{$phonenum}{amount} += $amount;  #subtotal
3915       $sections{$phonenum}{calls}++;
3916       $sections{$phonenum}{duration} += $detail->duration;
3917
3918       my $desc = $detail->regionname; 
3919       my $description = $desc;
3920       $description = substr($desc, 0, 50). '...'
3921         if $format eq 'latex' && length($desc) > 50;
3922
3923       $lines{$phonenum}{$desc} ||= {
3924         description     => &{$escape}($description),
3925         #pkgpart         => $part_pkg->pkgpart,
3926         pkgnum          => '',
3927         ref             => '',
3928         amount          => 0,
3929         calls           => 0,
3930         duration        => 0,
3931         #unit_amount     => '',
3932         quantity        => '',
3933         product_code    => 'N/A',
3934         ext_description => [],
3935       };
3936
3937       $lines{$phonenum}{$desc}{amount} += $amount;
3938       $lines{$phonenum}{$desc}{calls}++;
3939       $lines{$phonenum}{$desc}{duration} += $detail->duration;
3940
3941       my $line = $usage_class{$detail->classnum}->classname;
3942       $sections{"$phonenum $line"} ||=
3943         { 'amount' => 0,
3944           'calls' => 0,
3945           'duration' => 0,
3946           'sort_weight' => $usage_class{$detail->classnum}->weight,
3947           'phonenum' => $phonenum,
3948           'header'  => [ @header ],
3949         };
3950       $sections{"$phonenum $line"}{amount} += $amount;  #subtotal
3951       $sections{"$phonenum $line"}{calls}++;
3952       $sections{"$phonenum $line"}{duration} += $detail->duration;
3953
3954       $lines{"$phonenum $line"}{$desc} ||= {
3955         description     => &{$escape}($description),
3956         #pkgpart         => $part_pkg->pkgpart,
3957         pkgnum          => '',
3958         ref             => '',
3959         amount          => 0,
3960         calls           => 0,
3961         duration        => 0,
3962         #unit_amount     => '',
3963         quantity        => '',
3964         product_code    => 'N/A',
3965         ext_description => [],
3966       };
3967
3968       $lines{"$phonenum $line"}{$desc}{amount} += $amount;
3969       $lines{"$phonenum $line"}{$desc}{calls}++;
3970       $lines{"$phonenum $line"}{$desc}{duration} += $detail->duration;
3971       push @{$lines{"$phonenum $line"}{$desc}{ext_description}},
3972            $detail->formatted('format' => $format);
3973
3974     }
3975   }
3976
3977   my %sectionmap = ();
3978   my $simple = new FS::usage_class { format => 'simple' }; #bleh
3979   foreach ( keys %sections ) {
3980     my @header = @{ $sections{$_}{header} || [] };
3981     my $usage_simple =
3982       new FS::usage_class { format => 'usage_'. (scalar(@header) || 6). 'col' };
3983     my $summary = $sections{$_}{sort_weight} < 0 ? 1 : 0;
3984     my $usage_class = $summary ? $simple : $usage_simple;
3985     my $ending = $summary ? ' usage charges' : '';
3986     my %gen_opt = ();
3987     unless ($summary) {
3988       $gen_opt{label} = [ map{ &{$escape}($_) } @header ];
3989     }
3990     $sectionmap{$_} = { 'description' => &{$escape}($_. $ending),
3991                         'amount'    => $sections{$_}{amount},    #subtotal
3992                         'calls'       => $sections{$_}{calls},
3993                         'duration'    => $sections{$_}{duration},
3994                         'summarized'  => '',
3995                         'tax_section' => '',
3996                         'phonenum'    => $sections{$_}{phonenum},
3997                         'sort_weight' => $sections{$_}{sort_weight},
3998                         'post_total'  => $summary, #inspire pagebreak
3999                         (
4000                           ( map { $_ => $usage_class->$_($format, %gen_opt) }
4001                             qw( description_generator
4002                                 header_generator
4003                                 total_generator
4004                                 total_line_generator
4005                               )
4006                           )
4007                         ), 
4008                       };
4009   }
4010
4011   my @sections = sort { $a->{phonenum} cmp $b->{phonenum} ||
4012                         $a->{sort_weight} <=> $b->{sort_weight}
4013                       }
4014                  values %sectionmap;
4015
4016   my @lines = ();
4017   foreach my $section ( keys %lines ) {
4018     foreach my $line ( keys %{$lines{$section}} ) {
4019       my $l = $lines{$section}{$line};
4020       $l->{section}     = $sectionmap{$section};
4021       $l->{amount}      = sprintf( "%.2f", $l->{amount} );
4022       #$l->{unit_amount} = sprintf( "%.2f", $l->{unit_amount} );
4023       push @lines, $l;
4024     }
4025   }
4026
4027   return(\@sections, \@lines);
4028
4029 }
4030
4031 sub _items {
4032   my $self = shift;
4033
4034   #my @display = scalar(@_)
4035   #              ? @_
4036   #              : qw( _items_previous _items_pkg );
4037   #              #: qw( _items_pkg );
4038   #              #: qw( _items_previous _items_pkg _items_tax _items_credits _items_payments );
4039   my @display = qw( _items_previous _items_pkg );
4040
4041   my @b = ();
4042   foreach my $display ( @display ) {
4043     push @b, $self->$display(@_);
4044   }
4045   @b;
4046 }
4047
4048 sub _items_previous {
4049   my $self = shift;
4050   my $cust_main = $self->cust_main;
4051   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
4052   my @b = ();
4053   foreach ( @pr_cust_bill ) {
4054     my $date = $conf->exists('invoice_show_prior_due_date')
4055                ? 'due '. $_->due_date2str($date_format)
4056                : time2str($date_format, $_->_date);
4057     push @b, {
4058       'description' => 'Previous Balance, Invoice #'. $_->invnum. " ($date)",
4059       #'pkgpart'     => 'N/A',
4060       'pkgnum'      => 'N/A',
4061       'amount'      => sprintf("%.2f", $_->owed),
4062     };
4063   }
4064   @b;
4065
4066   #{
4067   #    'description'     => 'Previous Balance',
4068   #    #'pkgpart'         => 'N/A',
4069   #    'pkgnum'          => 'N/A',
4070   #    'amount'          => sprintf("%10.2f", $pr_total ),
4071   #    'ext_description' => [ map {
4072   #                                 "Invoice ". $_->invnum.
4073   #                                 " (". time2str("%x",$_->_date). ") ".
4074   #                                 sprintf("%10.2f", $_->owed)
4075   #                         } @pr_cust_bill ],
4076
4077   #};
4078 }
4079
4080 sub _items_pkg {
4081   my $self = shift;
4082   my %options = @_;
4083   my @cust_bill_pkg = grep { $_->pkgnum } $self->cust_bill_pkg;
4084   my @items = $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
4085   if ($options{section} && $options{section}->{condensed}) {
4086     my %itemshash = ();
4087     local $Storable::canonical = 1;
4088     foreach ( @items ) {
4089       my $item = { %$_ };
4090       delete $item->{ref};
4091       delete $item->{ext_description};
4092       my $key = freeze($item);
4093       $itemshash{$key} ||= 0;
4094       $itemshash{$key} ++; # += $item->{quantity};
4095     }
4096     @items = sort { $a->{description} cmp $b->{description} }
4097              map { my $i = thaw($_);
4098                    $i->{quantity} = $itemshash{$_};
4099                    $i->{amount} =
4100                      sprintf( "%.2f", $i->{quantity} * $i->{amount} );#unit_amount
4101                    $i;
4102                  }
4103              keys %itemshash;
4104   }
4105   @items;
4106 }
4107
4108 sub _taxsort {
4109   return 0 unless $a->itemdesc cmp $b->itemdesc;
4110   return -1 if $b->itemdesc eq 'Tax';
4111   return 1 if $a->itemdesc eq 'Tax';
4112   return -1 if $b->itemdesc eq 'Other surcharges';
4113   return 1 if $a->itemdesc eq 'Other surcharges';
4114   $a->itemdesc cmp $b->itemdesc;
4115 }
4116
4117 sub _items_tax {
4118   my $self = shift;
4119   my @cust_bill_pkg = sort _taxsort grep { ! $_->pkgnum } $self->cust_bill_pkg;
4120   $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
4121 }
4122
4123 sub _items_cust_bill_pkg {
4124   my $self = shift;
4125   my $cust_bill_pkg = shift;
4126   my %opt = @_;
4127
4128   my $format = $opt{format} || '';
4129   my $escape_function = $opt{escape_function} || sub { shift };
4130   my $format_function = $opt{format_function} || '';
4131   my $unsquelched = $opt{unsquelched} || '';
4132   my $section = $opt{section}->{description} if $opt{section};
4133   my $summary_page = $opt{summary_page} || '';
4134   my $multilocation = $opt{multilocation} || '';
4135   my $multisection = $opt{multisection} || '';
4136   my $discount_show_always = 0;
4137
4138   my @b = ();
4139   my ($s, $r, $u) = ( undef, undef, undef );
4140   foreach my $cust_bill_pkg ( @$cust_bill_pkg )
4141   {
4142
4143     $discount_show_always = ($cust_bill_pkg->cust_bill_pkg_discount
4144                                 && $conf->exists('discount-show-always'));
4145
4146     foreach ( $s, $r, ($opt{skip_usage} ? () : $u ) ) {
4147       if ( $_ && !$cust_bill_pkg->hidden ) {
4148         $_->{amount}      = sprintf( "%.2f", $_->{amount} ),
4149         $_->{amount}      =~ s/^\-0\.00$/0.00/;
4150         $_->{unit_amount} = sprintf( "%.2f", $_->{unit_amount} ),
4151         push @b, { %$_ }
4152           unless ( $_->{amount} == 0 && !$discount_show_always );
4153         $_ = undef;
4154       }
4155     }
4156
4157     foreach my $display ( grep { defined($section)
4158                                  ? $_->section eq $section
4159                                  : 1
4160                                }
4161                           #grep { !$_->summary || !$summary_page } # bunk!
4162                           grep { !$_->summary || $multisection }
4163                           $cust_bill_pkg->cust_bill_pkg_display
4164                         )
4165     {
4166
4167       my $type = $display->type;
4168
4169       my $desc = $cust_bill_pkg->desc;
4170       $desc = substr($desc, 0, 50). '...'
4171         if $format eq 'latex' && length($desc) > 50;
4172
4173       my %details_opt = ( 'format'          => $format,
4174                           'escape_function' => $escape_function,
4175                           'format_function' => $format_function,
4176                         );
4177
4178       if ( $cust_bill_pkg->pkgnum > 0 ) {
4179
4180         my $cust_pkg = $cust_bill_pkg->cust_pkg;
4181
4182         if ( $cust_bill_pkg->setup != 0 && (!$type || $type eq 'S') ) {
4183
4184           my $description = $desc;
4185           $description .= ' Setup' if $cust_bill_pkg->recur != 0;
4186
4187           my @d = ();
4188           unless ( $cust_pkg->part_pkg->hide_svc_detail
4189                 || $cust_bill_pkg->hidden )
4190           {
4191
4192             push @d, map &{$escape_function}($_),
4193                          $cust_pkg->h_labels_short($self->_date, undef, 'I')
4194               unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
4195
4196             if ( $multilocation ) {
4197               my $loc = $cust_pkg->location_label;
4198               $loc = substr($loc, 0, 50). '...'
4199                 if $format eq 'latex' && length($loc) > 50;
4200               push @d, &{$escape_function}($loc);
4201             }
4202
4203           }
4204
4205           push @d, $cust_bill_pkg->details(%details_opt)
4206             if $cust_bill_pkg->recur == 0;
4207
4208           if ( $cust_bill_pkg->hidden ) {
4209             $s->{amount}      += $cust_bill_pkg->setup;
4210             $s->{unit_amount} += $cust_bill_pkg->unitsetup;
4211             push @{ $s->{ext_description} }, @d;
4212           } else {
4213             $s = {
4214               description     => $description,
4215               #pkgpart         => $part_pkg->pkgpart,
4216               pkgnum          => $cust_bill_pkg->pkgnum,
4217               amount          => $cust_bill_pkg->setup,
4218               unit_amount     => $cust_bill_pkg->unitsetup,
4219               quantity        => $cust_bill_pkg->quantity,
4220               ext_description => \@d,
4221             };
4222           };
4223
4224         }
4225
4226         if ( ( $cust_bill_pkg->recur != 0  || $cust_bill_pkg->setup == 0 || 
4227                 ($discount_show_always && $cust_bill_pkg->recur == 0) ) &&
4228              ( !$type || $type eq 'R' || $type eq 'U' )
4229            )
4230         {
4231
4232           my $is_summary = $display->summary;
4233           my $description = ($is_summary && $type && $type eq 'U')
4234                             ? "Usage charges" : $desc;
4235
4236           unless ( $conf->exists('disable_line_item_date_ranges') ) {
4237             $description .= " (" . time2str($date_format, $cust_bill_pkg->sdate).
4238                             " - ". time2str($date_format, $cust_bill_pkg->edate). ")";
4239           }
4240
4241           my @d = ();
4242
4243           #at least until cust_bill_pkg has "past" ranges in addition to
4244           #the "future" sdate/edate ones... see #3032
4245           my @dates = ( $self->_date );
4246           my $prev = $cust_bill_pkg->previous_cust_bill_pkg;
4247           push @dates, $prev->sdate if $prev;
4248           push @dates, undef if !$prev;
4249
4250           unless ( $cust_pkg->part_pkg->hide_svc_detail
4251                 || $cust_bill_pkg->itemdesc
4252                 || $cust_bill_pkg->hidden
4253                 || $is_summary && $type && $type eq 'U' )
4254           {
4255
4256             push @d, map &{$escape_function}($_),
4257                          $cust_pkg->h_labels_short(@dates, 'I')
4258                                                    #$cust_bill_pkg->edate,
4259                                                    #$cust_bill_pkg->sdate)
4260               unless $cust_bill_pkg->pkgpart_override; #don't redisplay services
4261
4262             if ( $multilocation ) {
4263               my $loc = $cust_pkg->location_label;
4264               $loc = substr($loc, 0, 50). '...'
4265                 if $format eq 'latex' && length($loc) > 50;
4266               push @d, &{$escape_function}($loc);
4267             }
4268
4269           }
4270
4271           push @d, $cust_bill_pkg->details(%details_opt)
4272             unless ($is_summary || $type && $type eq 'R');
4273   
4274           my $amount = 0;
4275           if (!$type) {
4276             $amount = $cust_bill_pkg->recur;
4277           }elsif($type eq 'R') {
4278             $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
4279           }elsif($type eq 'U') {
4280             $amount = $cust_bill_pkg->usage;
4281           }
4282   
4283           if ( !$type || $type eq 'R' ) {
4284
4285             if ( $cust_bill_pkg->hidden ) {
4286               $r->{amount}      += $amount;
4287               $r->{unit_amount} += $cust_bill_pkg->unitrecur;
4288      &n