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