FS/FS/cust_bill.pm

   1 package FS::cust_bill;
   2
   3 use strict;
   4 use vars qw( @ISA $conf $money_char );
   5 use vars qw( $lpr $invoice_from $smtpmachine );
   6 use vars qw( $cybercash );
   7 use vars qw( $xaction $E_NoErr );
   8 use vars qw( $bop_processor $bop_login $bop_password $bop_action @bop_options );
   9 use vars qw( $ach_processor $ach_login $ach_password $ach_action @ach_options );
  10 use vars qw( $invoice_lines @buf ); #yuck
  11 use vars qw( $realtime_bop_decline_quiet );
  12 use Date::Format;
  13 use Mail::Internet 1.44;
  14 use Mail::Header;
  15 use Text::Template;
  16 use FS::UID qw( datasrc );
  17 use FS::Record qw( qsearch qsearchs );
  18 use FS::cust_main;
  19 use FS::cust_bill_pkg;
  20 use FS::cust_credit;
  21 use FS::cust_pay;
  22 use FS::cust_pkg;
  23 use FS::cust_credit_bill;
  24 use FS::cust_pay_batch;
  25 use FS::cust_bill_event;
  26
  27 @ISA = qw( FS::Record );
  28
  29 $realtime_bop_decline_quiet = 0;
  30
  31 #ask FS::UID to run this stuff for us later
  32 $FS::UID::callback{'FS::cust_bill'} = sub {
  33
  34   $conf = new FS::Conf;
  35
  36   $money_char = $conf->config('money_char') || '$';
  37
  38   $lpr = $conf->config('lpr');
  39   $invoice_from = $conf->config('invoice_from');
  40   $smtpmachine = $conf->config('smtpmachine');
  41
  42   ( $bop_processor,$bop_login, $bop_password, $bop_action ) = ( '', '', '', '');
  43   @bop_options = ();
  44   ( $ach_processor,$ach_login, $ach_password, $ach_action ) = ( '', '', '', '');
  45   @ach_options = ();
  46
  47   if ( $conf->exists('cybercash3.2') ) {
  48     require CCMckLib3_2;
  49       #qw($MCKversion %Config InitConfig CCError CCDebug CCDebug2);
  50     require CCMckDirectLib3_2;
  51       #qw(SendCC2_1Server);
  52     require CCMckErrno3_2;
  53       #qw(MCKGetErrorMessage $E_NoErr);
  54     import CCMckErrno3_2 qw($E_NoErr);
  55
  56     my $merchant_conf;
  57     ($merchant_conf,$xaction)= $conf->config('cybercash3.2');
  58     my $status = &CCMckLib3_2::InitConfig($merchant_conf);
  59     if ( $status != $E_NoErr ) {
  60       warn "CCMckLib3_2::InitConfig error:\n";
  61       foreach my $key (keys %CCMckLib3_2::Config) {
  62         warn "  $key => $CCMckLib3_2::Config{$key}\n"
  63       }
  64       my($errmsg) = &CCMckErrno3_2::MCKGetErrorMessage($status);
  65       die "CCMckLib3_2::InitConfig fatal error: $errmsg\n";
  66     }
  67     $cybercash='cybercash3.2';
  68   } elsif ( $conf->exists('business-onlinepayment') ) {
  69     ( $bop_processor,
  70       $bop_login,
  71       $bop_password,
  72       $bop_action,
  73       @bop_options
  74     ) = $conf->config('business-onlinepayment');
  75     $bop_action ||= 'normal authorization';
  76     ( $ach_processor, $ach_login, $ach_password, $ach_action, @ach_options ) =
  77       ( $bop_processor, $bop_login, $bop_password, $bop_action, @bop_options );
  78     eval "use Business::OnlinePayment";
  79   }
  80
  81   if ( $conf->exists('business-onlinepayment-ach') ) {
  82     ( $ach_processor,
  83       $ach_login,
  84       $ach_password,
  85       $ach_action,
  86       @ach_options
  87     ) = $conf->config('business-onlinepayment-ach');
  88     $ach_action ||= 'normal authorization';
  89     eval "use Business::OnlinePayment";
  90   }
  91
  92 };
  93
  94 =head1 NAME
  95
  96 FS::cust_bill - Object methods for cust_bill records
  97
  98 =head1 SYNOPSIS
  99
 100   use FS::cust_bill;
 101
 102   $record = new FS::cust_bill \%hash;
 103   $record = new FS::cust_bill { 'column' => 'value' };
 104
 105   $error = $record->insert;
 106
 107   $error = $new_record->replace($old_record);
 108
 109   $error = $record->delete;
 110
 111   $error = $record->check;
 112
 113   ( $total_previous_balance, @previous_cust_bill ) = $record->previous;
 114
 115   @cust_bill_pkg_objects = $cust_bill->cust_bill_pkg;
 116
 117   ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;
 118
 119   @cust_pay_objects = $cust_bill->cust_pay;
 120
 121   $tax_amount = $record->tax;
 122
 123   @lines = $cust_bill->print_text;
 124   @lines = $cust_bill->print_text $time;
 125
 126 =head1 DESCRIPTION
 127
 128 An FS::cust_bill object represents an invoice; a declaration that a customer
 129 owes you money.  The specific charges are itemized as B<cust_bill_pkg> records
 130 (see L<FS::cust_bill_pkg>).  FS::cust_bill inherits from FS::Record.  The
 131 following fields are currently supported:
 132
 133 =over 4
 134
 135 =item invnum - primary key (assigned automatically for new invoices)
 136
 137 =item custnum - customer (see L<FS::cust_main>)
 138
 139 =item _date - specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
 140 L<Time::Local> and L<Date::Parse> for conversion functions.
 141
 142 =item charged - amount of this invoice
 143
 144 =item printed - deprecated
 145
 146 =item closed - books closed flag, empty or `Y'
 147
 148 =back
 149
 150 =head1 METHODS
 151
 152 =over 4
 153
 154 =item new HASHREF
 155
 156 Creates a new invoice.  To add the invoice to the database, see L<"insert">.
 157 Invoices are normally created by calling the bill method of a customer object
 158 (see L<FS::cust_main>).
 159
 160 =cut
 161
 162 sub table { 'cust_bill'; }
 163
 164 =item insert
 165
 166 Adds this invoice to the database ("Posts" the invoice).  If there is an error,
 167 returns the error, otherwise returns false.
 168
 169 =item delete
 170
 171 Currently unimplemented.  I don't remove invoices because there would then be
 172 no record you ever posted this invoice (which is bad, no?)
 173
 174 =cut
 175
 176 sub delete {
 177   my $self = shift;
 178   return "Can't delete closed invoice" if $self->closed =~ /^Y/i;
 179   $self->SUPER::delete(@_);
 180 }
 181
 182 =item replace OLD_RECORD
 183
 184 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 185 returns the error, otherwise returns false.
 186
 187 Only printed may be changed.  printed is normally updated by calling the
 188 collect method of a customer object (see L<FS::cust_main>).
 189
 190 =cut
 191
 192 sub replace {
 193   my( $new, $old ) = ( shift, shift );
 194   return "Can't change custnum!" unless $old->custnum == $new->custnum;
 195   #return "Can't change _date!" unless $old->_date eq $new->_date;
 196   return "Can't change _date!" unless $old->_date == $new->_date;
 197   return "Can't change charged!" unless $old->charged == $new->charged;
 198
 199   $new->SUPER::replace($old);
 200 }
 201
 202 =item check
 203
 204 Checks all fields to make sure this is a valid invoice.  If there is an error,
 205 returns the error, otherwise returns false.  Called by the insert and replace
 206 methods.
 207
 208 =cut
 209
 210 sub check {
 211   my $self = shift;
 212
 213   my $error =
 214     $self->ut_numbern('invnum')
 215     || $self->ut_number('custnum')
 216     || $self->ut_numbern('_date')
 217     || $self->ut_money('charged')
 218     || $self->ut_numbern('printed')
 219     || $self->ut_enum('closed', [ '', 'Y' ])
 220   ;
 221   return $error if $error;
 222
 223   return "Unknown customer"
 224     unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
 225
 226   $self->_date(time) unless $self->_date;
 227
 228   $self->printed(0) if $self->printed eq '';
 229
 230   ''; #no error
 231 }
 232
 233 =item previous
 234
 235 Returns a list consisting of the total previous balance for this customer,
 236 followed by the previous outstanding invoices (as FS::cust_bill objects also).
 237
 238 =cut
 239
 240 sub previous {
 241   my $self = shift;
 242   my $total = 0;
 243   my @cust_bill = sort { $a->_date <=> $b->_date }
 244     grep { $_->owed != 0 && $_->_date < $self->_date }
 245       qsearch( 'cust_bill', { 'custnum' => $self->custnum } )
 246   ;
 247   foreach ( @cust_bill ) { $total += $_->owed; }
 248   $total, @cust_bill;
 249 }
 250
 251 =item cust_bill_pkg
 252
 253 Returns the line items (see L<FS::cust_bill_pkg>) for this invoice.
 254
 255 =cut
 256
 257 sub cust_bill_pkg {
 258   my $self = shift;
 259   qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum } );
 260 }
 261
 262 =item cust_bill_event
 263
 264 Returns the completed invoice events (see L<FS::cust_bill_event>) for this
 265 invoice.
 266
 267 =cut
 268
 269 sub cust_bill_event {
 270   my $self = shift;
 271   qsearch( 'cust_bill_event', { 'invnum' => $self->invnum } );
 272 }
 273
 274
 275 =item cust_main
 276
 277 Returns the customer (see L<FS::cust_main>) for this invoice.
 278
 279 =cut
 280
 281 sub cust_main {
 282   my $self = shift;
 283   qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
 284 }
 285
 286 =item cust_credit
 287
 288 Depreciated.  See the cust_credited method.
 289
 290  #Returns a list consisting of the total previous credited (see
 291  #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
 292  #outstanding credits (FS::cust_credit objects).
 293
 294 =cut
 295
 296 sub cust_credit {
 297   use Carp;
 298   croak "FS::cust_bill->cust_credit depreciated; see ".
 299         "FS::cust_bill->cust_credit_bill";
 300   #my $self = shift;
 301   #my $total = 0;
 302   #my @cust_credit = sort { $a->_date <=> $b->_date }
 303   #  grep { $_->credited != 0 && $_->_date < $self->_date }
 304   #    qsearch('cust_credit', { 'custnum' => $self->custnum } )
 305   #;
 306   #foreach (@cust_credit) { $total += $_->credited; }
 307   #$total, @cust_credit;
 308 }
 309
 310 =item cust_pay
 311
 312 Depreciated.  See the cust_bill_pay method.
 313
 314 #Returns all payments (see L<FS::cust_pay>) for this invoice.
 315
 316 =cut
 317
 318 sub cust_pay {
 319   use Carp;
 320   croak "FS::cust_bill->cust_pay depreciated; see FS::cust_bill->cust_bill_pay";
 321   #my $self = shift;
 322   #sort { $a->_date <=> $b->_date }
 323   #  qsearch( 'cust_pay', { 'invnum' => $self->invnum } )
 324   #;
 325 }
 326
 327 =item cust_bill_pay
 328
 329 Returns all payment applications (see L<FS::cust_bill_pay>) for this invoice.
 330
 331 =cut
 332
 333 sub cust_bill_pay {
 334   my $self = shift;
 335   sort { $a->_date <=> $b->_date }
 336     qsearch( 'cust_bill_pay', { 'invnum' => $self->invnum } );
 337 }
 338
 339 =item cust_credited
 340
 341 Returns all applied credits (see L<FS::cust_credit_bill>) for this invoice.
 342
 343 =cut
 344
 345 sub cust_credited {
 346   my $self = shift;
 347   sort { $a->_date <=> $b->_date }
 348     qsearch( 'cust_credit_bill', { 'invnum' => $self->invnum } )
 349   ;
 350 }
 351
 352 =item tax
 353
 354 Returns the tax amount (see L<FS::cust_bill_pkg>) for this invoice.
 355
 356 =cut
 357
 358 sub tax {
 359   my $self = shift;
 360   my $total = 0;
 361   my @taxlines = qsearch( 'cust_bill_pkg', { 'invnum' => $self->invnum ,
 362                                              'pkgnum' => 0 } );
 363   foreach (@taxlines) { $total += $_->setup; }
 364   $total;
 365 }
 366
 367 =item owed
 368
 369 Returns the amount owed (still outstanding) on this invoice, which is charged
 370 minus all payment applications (see L<FS::cust_bill_pay>) and credit
 371 applications (see L<FS::cust_credit_bill>).
 372
 373 =cut
 374
 375 sub owed {
 376   my $self = shift;
 377   my $balance = $self->charged;
 378   $balance -= $_->amount foreach ( $self->cust_bill_pay );
 379   $balance -= $_->amount foreach ( $self->cust_credited );
 380   $balance = sprintf( "%.2f", $balance);
 381   $balance =~ s/^\-0\.00$/0.00/; #yay ieee fp
 382   $balance;
 383 }
 384
 385 =item send
 386
 387 Sends this invoice to the destinations configured for this customer: send
 388 emails or print.  See L<FS::cust_main_invoice>.
 389
 390 =cut
 391
 392 sub send {
 393   my($self,$template) = @_;
 394   my @print_text = $self->print_text('', $template);
 395   my @invoicing_list = $self->cust_main->invoicing_list;
 396
 397   if ( grep { $_ ne 'POST' } @invoicing_list or !@invoicing_list ) { #email
 398
 399     #better to notify this person than silence
 400     @invoicing_list = ($invoice_from) unless @invoicing_list;
 401
 402     #false laziness w/FS::cust_pay::delete & fs_signup_server && ::realtime_card
 403     #$ENV{SMTPHOSTS} = $smtpmachine;
 404     $ENV{MAILADDRESS} = $invoice_from;
 405     my $header = new Mail::Header ( [
 406       "From: $invoice_from",
 407       "To: ". join(', ', grep { $_ ne 'POST' } @invoicing_list ),
 408       "Sender: $invoice_from",
 409       "Reply-To: $invoice_from",
 410       "Date: ". time2str("%a, %d %b %Y %X %z", time),
 411       "Subject: Invoice",
 412     ] );
 413     my $message = new Mail::Internet (
 414       'Header' => $header,
 415       'Body' => [ @print_text ], #( date)
 416     );
 417     $!=0;
 418     $message->smtpsend( Host => $smtpmachine )
 419       or $message->smtpsend( Host => $smtpmachine, Debug => 1 )
 420         or return "(customer # ". $self->custnum. ") can't send invoice email".
 421                   " to ". join(', ', grep { $_ ne 'POST' } @invoicing_list ).
 422                   " via server $smtpmachine with SMTP: $!";
 423
 424   }
 425
 426   if ( $conf->config('invoice_latex') ) {
 427     @print_text = $self->print_ps('', $template);
 428   }
 429
 430   if ( grep { $_ eq 'POST' } @invoicing_list ) { #postal
 431     open(LPR, "|$lpr")
 432       or return "Can't open pipe to $lpr: $!";
 433     print LPR @print_text;
 434     close LPR
 435       or return $! ? "Error closing $lpr: $!"
 436                    : "Exit status $? from $lpr";
 437   }
 438
 439   '';
 440
 441 }
 442
 443 =item send_csv OPTIONS
 444
 445 Sends invoice as a CSV data-file to a remote host with the specified protocol.
 446
 447 Options are:
 448
 449 protocol - currently only "ftp"
 450 server
 451 username
 452 password
 453 dir
 454
 455 The file will be named "N-YYYYMMDDHHMMSS.csv" where N is the invoice number
 456 and YYMMDDHHMMSS is a timestamp.
 457
 458 The fields of the CSV file is as follows:
 459
 460 record_type, invnum, custnum, _date, charged, first, last, company, address1, address2, city, state, zip, country, pkg, setup, recur, sdate, edate
 461
 462 =over 4
 463
 464 =item record type - B<record_type> is either C<cust_bill> or C<cust_bill_pkg>
 465
 466 If B<record_type> is C<cust_bill>, this is a primary invoice record.  The
 467 last five fields (B<pkg> through B<edate>) are irrelevant, and all other
 468 fields are filled in.
 469
 470 If B<record_type> is C<cust_bill_pkg>, this is a line item record.  Only the
 471 first two fields (B<record_type> and B<invnum>) and the last five fields
 472 (B<pkg> through B<edate>) are filled in.
 473
 474 =item invnum - invoice number
 475
 476 =item custnum - customer number
 477
 478 =item _date - invoice date
 479
 480 =item charged - total invoice amount
 481
 482 =item first - customer first name
 483
 484 =item last - customer first name
 485
 486 =item company - company name
 487
 488 =item address1 - address line 1
 489
 490 =item address2 - address line 1
 491
 492 =item city
 493
 494 =item state
 495
 496 =item zip
 497
 498 =item country
 499
 500 =item pkg - line item description
 501
 502 =item setup - line item setup fee (one or both of B<setup> and B<recur> will be defined)
 503
 504 =item recur - line item recurring fee (one or both of B<setup> and B<recur> will be defined)
 505
 506 =item sdate - start date for recurring fee
 507
 508 =item edate - end date for recurring fee
 509
 510 =back
 511
 512 =cut
 513
 514 sub send_csv {
 515   my($self, %opt) = @_;
 516
 517   #part one: create file
 518
 519   my $spooldir = "/usr/local/etc/freeside/export.". datasrc. "/cust_bill";
 520   mkdir $spooldir, 0700 unless -d $spooldir;
 521
 522   my $file = $spooldir. '/'. $self->invnum. time2str('-%Y%m%d%H%M%S.csv', time);
 523
 524   open(CSV, ">$file") or die "can't open $file: $!";
 525
 526   eval "use Text::CSV_XS";
 527   die $@ if $@;
 528
 529   my $csv = Text::CSV_XS->new({'always_quote'=>1});
 530
 531   my $cust_main = $self->cust_main;
 532
 533   $csv->combine(
 534     'cust_bill',
 535     $self->invnum,
 536     $self->custnum,
 537     time2str("%x", $self->_date),
 538     sprintf("%.2f", $self->charged),
 539     ( map { $cust_main->getfield($_) }
 540         qw( first last company address1 address2 city state zip country ) ),
 541     map { '' } (1..5),
 542   ) or die "can't create csv";
 543   print CSV $csv->string. "\n";
 544
 545   #new charges (false laziness w/print_text)
 546   foreach my $cust_bill_pkg ( $self->cust_bill_pkg ) {
 547
 548     my($pkg, $setup, $recur, $sdate, $edate);
 549     if ( $cust_bill_pkg->pkgnum ) {
 550
 551       ($pkg, $setup, $recur, $sdate, $edate) = (
 552         $cust_bill_pkg->cust_pkg->part_pkg->pkg,
 553         ( $cust_bill_pkg->setup != 0
 554           ? sprintf("%.2f", $cust_bill_pkg->setup )
 555           : '' ),
 556         ( $cust_bill_pkg->recur != 0
 557           ? sprintf("%.2f", $cust_bill_pkg->recur )
 558           : '' ),
 559         time2str("%x", $cust_bill_pkg->sdate),
 560         time2str("%x", $cust_bill_pkg->edate),
 561       );
 562
 563     } else { #pkgnum Tax
 564       next unless $cust_bill_pkg->setup != 0;
 565       ($pkg, $setup, $recur, $sdate, $edate) =
 566         ( 'Tax', sprintf("%10.2f",$cust_bill_pkg->setup), '', '', '' );
 567     }
 568
 569     $csv->combine(
 570       'cust_bill_pkg',
 571       $self->invnum,
 572       ( map { '' } (1..11) ),
 573       ($pkg, $setup, $recur, $sdate, $edate)
 574     ) or die "can't create csv";
 575     print CSV $csv->string. "\n";
 576
 577   }
 578
 579   close CSV or die "can't close CSV: $!";
 580
 581   #part two: upload it
 582
 583   my $net;
 584   if ( $opt{protocol} eq 'ftp' ) {
 585     eval "use Net::FTP;";
 586     die $@ if $@;
 587     $net = Net::FTP->new($opt{server}) or die @$;
 588   } else {
 589     die "unknown protocol: $opt{protocol}";
 590   }
 591
 592   $net->login( $opt{username}, $opt{password} )
 593     or die "can't FTP to $opt{username}\@$opt{server}: login error: $@";
 594
 595   $net->binary or die "can't set binary mode";
 596
 597   $net->cwd($opt{dir}) or die "can't cwd to $opt{dir}";
 598
 599   $net->put($file) or die "can't put $file: $!";
 600
 601   $net->quit;
 602
 603   unlink $file;
 604
 605 }
 606
 607 =item comp
 608
 609 Pays this invoice with a compliemntary payment.  If there is an error,
 610 returns the error, otherwise returns false.
 611
 612 =cut
 613
 614 sub comp {
 615   my $self = shift;
 616   my $cust_pay = new FS::cust_pay ( {
 617     'invnum'   => $self->invnum,
 618     'paid'     => $self->owed,
 619     '_date'    => '',
 620     'payby'    => 'COMP',
 621     'payinfo'  => $self->cust_main->payinfo,
 622     'paybatch' => '',
 623   } );
 624   $cust_pay->insert;
 625 }
 626
 627 =item realtime_card
 628
 629 Attempts to pay this invoice with a credit card payment via a
 630 Business::OnlinePayment realtime gateway.  See
 631 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
 632 for supported processors.
 633
 634 =cut
 635
 636 sub realtime_card {
 637   my $self = shift;
 638   $self->realtime_bop(
 639     'CC',
 640     $bop_processor,
 641     $bop_login,
 642     $bop_password,
 643     $bop_action,
 644     \@bop_options,
 645     @_
 646   );
 647 }
 648
 649 =item realtime_ach
 650
 651 Attempts to pay this invoice with an electronic check (ACH) payment via a
 652 Business::OnlinePayment realtime gateway.  See
 653 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
 654 for supported processors.
 655
 656 =cut
 657
 658 sub realtime_ach {
 659   my $self = shift;
 660   $self->realtime_bop(
 661     'ECHECK',
 662     $ach_processor,
 663     $ach_login,
 664     $ach_password,
 665     $ach_action,
 666     \@ach_options,
 667     @_
 668   );
 669 }
 670
 671 =item realtime_lec
 672
 673 Attempts to pay this invoice with phone bill (LEC) payment via a
 674 Business::OnlinePayment realtime gateway.  See
 675 http://search.cpan.org/search?mode=module&query=Business%3A%3AOnlinePayment
 676 for supported processors.
 677
 678 =cut
 679
 680 sub realtime_lec {
 681   my $self = shift;
 682   $self->realtime_bop(
 683     'LEC',
 684     $bop_processor,
 685     $bop_login,
 686     $bop_password,
 687     $bop_action,
 688     \@bop_options,
 689     @_
 690   );
 691 }
 692
 693 sub realtime_bop {
 694   my( $self, $method, $processor, $login, $password, $action, $options ) = @_;
 695
 696   #trim an extraneous blank line
 697   pop @$options if scalar(@$options) % 2 && $options->[-1] =~ /^\s*$/;
 698
 699   my $cust_main = $self->cust_main;
 700   my $balance = $cust_main->balance;
 701   my $amount = ( $balance < $self->owed ) ? $balance : $self->owed;
 702   $amount = sprintf("%.2f", $amount);
 703   return "not run (balance $balance)" unless $amount > 0;
 704
 705   my $address = $cust_main->address1;
 706   $address .= ", ". $cust_main->address2 if $cust_main->address2;
 707
 708   my($payname, $payfirst, $paylast);
 709   if ( $cust_main->payname && $method ne 'ECHECK' ) {
 710     $payname = $cust_main->payname;
 711     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
 712       or do {
 713               #$dbh->rollback if $oldAutoCommit;
 714               return "Illegal payname $payname";
 715             };
 716     ($payfirst, $paylast) = ($1, $2);
 717   } else {
 718     $payfirst = $cust_main->getfield('first');
 719     $paylast = $cust_main->getfield('last');
 720     $payname =  "$payfirst $paylast";
 721   }
 722
 723   my @invoicing_list = grep { $_ ne 'POST' } $cust_main->invoicing_list;
 724   if ( $conf->exists('emailinvoiceauto')
 725        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
 726     push @invoicing_list, $cust_main->all_emails;
 727   }
 728   my $email = $invoicing_list[0];
 729
 730   my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
 731
 732   my $description = 'Internet Services';
 733   if ( $conf->exists('business-onlinepayment-description') ) {
 734     my $dtempl = $conf->config('business-onlinepayment-description');
 735
 736     my $agent_obj = $cust_main->agent
 737       or die "can't retreive agent for $cust_main (agentnum ".
 738              $cust_main->agentnum. ")";
 739     my $agent = $agent_obj->agent;
 740     my $pkgs = join(', ',
 741       map { $_->cust_pkg->part_pkg->pkg }
 742         grep { $_->pkgnum } $self->cust_bill_pkg
 743     );
 744     $description = eval qq("$dtempl");
 745
 746   }
 747
 748   my %content;
 749   if ( $method eq 'CC' ) {
 750
 751     $content{card_number} = $cust_main->payinfo;
 752     $cust_main->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
 753     $content{expiration} = "$2/$1";
 754
 755     $content{cvv2} = $cust_main->paycvv
 756       if defined $cust_main->dbdef_table->column('paycvv')
 757          && length($cust_main->paycvv);
 758
 759     $content{recurring_billing} = 'YES'
 760       if qsearch('cust_pay', { 'custnum' => $cust_main->custnum,
 761                                'payby'   => 'CARD',
 762                                'payinfo' => $cust_main->payinfo, } );
 763
 764   } elsif ( $method eq 'ECHECK' ) {
 765     my($account_number,$routing_code) = $cust_main->payinfo;
 766     ( $content{account_number}, $content{routing_code} ) =
 767       split('@', $cust_main->payinfo);
 768     $content{bank_name} = $cust_main->payname;
 769     $content{account_type} = 'CHECKING';
 770     $content{account_name} = $payname;
 771     $content{customer_org} = $self->company ? 'B' : 'I';
 772     $content{customer_ssn} = $self->ss;
 773   } elsif ( $method eq 'LEC' ) {
 774     $content{phone} = $cust_main->payinfo;
 775   }
 776
 777   my $transaction =
 778     new Business::OnlinePayment( $processor, @$options );
 779   $transaction->content(
 780     'type'           => $method,
 781     'login'          => $login,
 782     'password'       => $password,
 783     'action'         => $action1,
 784     'description'    => $description,
 785     'amount'         => $amount,
 786     'invoice_number' => $self->invnum,
 787     'customer_id'    => $self->custnum,
 788     'last_name'      => $paylast,
 789     'first_name'     => $payfirst,
 790     'name'           => $payname,
 791     'address'        => $address,
 792     'city'           => $cust_main->city,
 793     'state'          => $cust_main->state,
 794     'zip'            => $cust_main->zip,
 795     'country'        => $cust_main->country,
 796     'referer'        => 'http://cleanwhisker.420.am/',
 797     'email'          => $email,
 798     'phone'          => $cust_main->daytime || $cust_main->night,
 799     %content, #after
 800   );
 801   $transaction->submit();
 802
 803   if ( $transaction->is_success() && $action2 ) {
 804     my $auth = $transaction->authorization;
 805     my $ordernum = $transaction->can('order_number')
 806                    ? $transaction->order_number
 807                    : '';
 808
 809     #warn "********* $auth ***********\n";
 810     #warn "********* $ordernum ***********\n";
 811     my $capture =
 812       new Business::OnlinePayment( $processor, @$options );
 813
 814     my %capture = (
 815       %content,
 816       type           => $method,
 817       action         => $action2,
 818       login          => $login,
 819       password       => $password,
 820       order_number   => $ordernum,
 821       amount         => $amount,
 822       authorization  => $auth,
 823       description    => $description,
 824     );
 825
 826     foreach my $field (qw( authorization_source_code returned_ACI                                          transaction_identifier validation_code
 827                            transaction_sequence_num local_transaction_date
 828                            local_transaction_time AVS_result_code          )) {
 829       $capture{$field} = $transaction->$field() if $transaction->can($field);
 830     }
 831
 832     $capture->content( %capture );
 833
 834     $capture->submit();
 835
 836     unless ( $capture->is_success ) {
 837       my $e = "Authorization sucessful but capture failed, invnum #".
 838               $self->invnum. ': '.  $capture->result_code.
 839               ": ". $capture->error_message;
 840       warn $e;
 841       return $e;
 842     }
 843
 844   }
 845
 846   #remove paycvv after initial transaction
 847   #make this disable-able via a config option if anyone insists?
 848   # (though that probably violates cardholder agreements)
 849   use Business::CreditCard;
 850   if ( defined $cust_main->dbdef_table->column('paycvv')
 851        && length($cust_main->paycvv)
 852        && ! grep { $_ eq cardtype($cust_main->payinfo) } $conf->config('cvv-save')
 853
 854   ) {
 855     my $new = new FS::cust_main { $cust_main->hash };
 856     $new->paycvv('');
 857     my $error = $new->replace($cust_main);
 858     if ( $error ) {
 859       warn "error removing cvv: $error\n";
 860     }
 861   }
 862
 863   #result handling
 864   if ( $transaction->is_success() ) {
 865
 866     my %method2payby = (
 867       'CC'     => 'CARD',
 868       'ECHECK' => 'CHEK',
 869       'LEC'    => 'LECB',
 870     );
 871
 872     my $cust_pay = new FS::cust_pay ( {
 873        'invnum'   => $self->invnum,
 874        'paid'     => $amount,
 875        '_date'     => '',
 876        'payby'    => $method2payby{$method},
 877        'payinfo'  => $cust_main->payinfo,
 878        'paybatch' => "$processor:". $transaction->authorization,
 879     } );
 880     my $error = $cust_pay->insert;
 881     if ( $error ) {
 882       # gah, even with transactions.
 883       my $e = 'WARNING: Card/ACH debited but database not updated - '.
 884               'error applying payment, invnum #' . $self->invnum.
 885               " ($processor): $error";
 886       warn $e;
 887       return $e;
 888     } else {
 889       return '';
 890     }
 891   #} elsif ( $options{'report_badcard'} ) {
 892   } else {
 893
 894     my $perror = "$processor error, invnum #". $self->invnum. ': '.
 895                  $transaction->result_code. ": ". $transaction->error_message;
 896
 897     if ( !$realtime_bop_decline_quiet && $conf->exists('emaildecline')
 898          && grep { $_ ne 'POST' } $cust_main->invoicing_list
 899          && ! grep { $_ eq $transaction->error_message }
 900                    $conf->config('emaildecline-exclude')
 901     ) {
 902       my @templ = $conf->config('declinetemplate');
 903       my $template = new Text::Template (
 904         TYPE   => 'ARRAY',
 905         SOURCE => [ map "$_\n", @templ ],
 906       ) or return "($perror) can't create template: $Text::Template::ERROR";
 907       $template->compile()
 908         or return "($perror) can't compile template: $Text::Template::ERROR";
 909
 910       my $templ_hash = { error => $transaction->error_message };
 911
 912       #false laziness w/FS::cust_pay::delete & fs_signup_server && ::send
 913       $ENV{MAILADDRESS} = $invoice_from;
 914       my $header = new Mail::Header ( [
 915         "From: $invoice_from",
 916         "To: ". join(', ', grep { $_ ne 'POST' } $cust_main->invoicing_list ),
 917         "Sender: $invoice_from",
 918         "Reply-To: $invoice_from",
 919         "Date: ". time2str("%a, %d %b %Y %X %z", time),
 920         "Subject: Your payment could not be processed",
 921       ] );
 922       my $message = new Mail::Internet (
 923         'Header' => $header,
 924         'Body' => [ $template->fill_in(HASH => $templ_hash) ],
 925       );
 926       $!=0;
 927       $message->smtpsend( Host => $smtpmachine )
 928         or $message->smtpsend( Host => $smtpmachine, Debug => 1 )
 929           or return "($perror) (customer # ". $self->custnum.
 930             ") can't send card decline email to ".
 931             join(', ', grep { $_ ne 'POST' } $cust_main->invoicing_list ).
 932             " via server $smtpmachine with SMTP: $!";
 933     }
 934
 935     return $perror;
 936   }
 937
 938 }
 939
 940 =item realtime_card_cybercash
 941
 942 Attempts to pay this invoice with the CyberCash CashRegister realtime gateway.
 943
 944 =cut
 945
 946 sub realtime_card_cybercash {
 947   my $self = shift;
 948   my $cust_main = $self->cust_main;
 949   my $amount = $self->owed;
 950
 951   return "CyberCash CashRegister real-time card processing not enabled!"
 952     unless $cybercash eq 'cybercash3.2';
 953
 954   my $address = $cust_main->address1;
 955   $address .= ", ". $cust_main->address2 if $cust_main->address2;
 956
 957   #fix exp. date
 958   #$cust_main->paydate =~ /^(\d+)\/\d*(\d{2})$/;
 959   $cust_main->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
 960   my $exp = "$2/$1";
 961
 962   #
 963
 964   my $paybatch = $self->invnum.
 965                   '-' . time2str("%y%m%d%H%M%S", time);
 966
 967   my $payname = $cust_main->payname ||
 968                 $cust_main->getfield('first').' '.$cust_main->getfield('last');
 969
 970   my $country = $cust_main->country eq 'US' ? 'USA' : $cust_main->country;
 971
 972   my @full_xaction = ( $xaction,
 973     'Order-ID'     => $paybatch,
 974     'Amount'       => "usd $amount",
 975     'Card-Number'  => $cust_main->getfield('payinfo'),
 976     'Card-Name'    => $payname,
 977     'Card-Address' => $address,
 978     'Card-City'    => $cust_main->getfield('city'),
 979     'Card-State'   => $cust_main->getfield('state'),
 980     'Card-Zip'     => $cust_main->getfield('zip'),
 981     'Card-Country' => $country,
 982     'Card-Exp'     => $exp,
 983   );
 984
 985   my %result;
 986   %result = &CCMckDirectLib3_2::SendCC2_1Server(@full_xaction);
 987
 988   if ( $result{'MStatus'} eq 'success' ) { #cybercash smps v.2 or 3
 989     my $cust_pay = new FS::cust_pay ( {
 990        'invnum'   => $self->invnum,
 991        'paid'     => $amount,
 992        '_date'     => '',
 993        'payby'    => 'CARD',
 994        'payinfo'  => $cust_main->payinfo,
 995        'paybatch' => "$cybercash:$paybatch",
 996     } );
 997     my $error = $cust_pay->insert;
 998     if ( $error ) {
 999       # gah, even with transactions.
1000       my $e = 'WARNING: Card debited but database not updated - '.
1001               'error applying payment, invnum #' . $self->invnum.
1002               " (CyberCash Order-ID $paybatch): $error";
1003       warn $e;
1004       return $e;
1005     } else {
1006       return '';
1007     }
1008 #  } elsif ( $result{'Mstatus'} ne 'failure-bad-money'
1009 #            || $options{'report_badcard'}
1010 #          ) {
1011   } else {
1012      return 'Cybercash error, invnum #' .
1013        $self->invnum. ':'. $result{'MErrMsg'};
1014   }
1015
1016 }
1017
1018 =item batch_card
1019
1020 Adds a payment for this invoice to the pending credit card batch (see
1021 L<FS::cust_pay_batch>).
1022
1023 =cut
1024
1025 sub batch_card {
1026   my $self = shift;
1027   my $cust_main = $self->cust_main;
1028
1029   my $cust_pay_batch = new FS::cust_pay_batch ( {
1030     'invnum'   => $self->getfield('invnum'),
1031     'custnum'  => $cust_main->getfield('custnum'),
1032     'last'     => $cust_main->getfield('last'),
1033     'first'    => $cust_main->getfield('first'),
1034     'address1' => $cust_main->getfield('address1'),
1035     'address2' => $cust_main->getfield('address2'),
1036     'city'     => $cust_main->getfield('city'),
1037     'state'    => $cust_main->getfield('state'),
1038     'zip'      => $cust_main->getfield('zip'),
1039     'country'  => $cust_main->getfield('country'),
1040     'cardnum'  => $cust_main->getfield('payinfo'),
1041     'exp'      => $cust_main->getfield('paydate'),
1042     'payname'  => $cust_main->getfield('payname'),
1043     'amount'   => $self->owed,
1044   } );
1045   my $error = $cust_pay_batch->insert;
1046   die $error if $error;
1047
1048   '';
1049 }
1050
1051 =item print_text [ TIME [ , TEMPLATE ] ]
1052
1053 Returns an text invoice, as a list of lines.
1054
1055 TIME an optional value used to control the printing of overdue messages.  The
1056 default is now.  It isn't the date of the invoice; that's the `_date' field.
1057 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
1058 L<Time::Local> and L<Date::Parse> for conversion functions.
1059
1060 =cut
1061
1062 sub print_text {
1063
1064   my( $self, $today, $template ) = @_;
1065   $today ||= time;
1066 #  my $invnum = $self->invnum;
1067   my $cust_main = qsearchs('cust_main', { 'custnum', $self->custnum } );
1068   $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
1069     unless $cust_main->payname && $cust_main->payby ne 'CHEK';
1070
1071   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
1072 #  my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
1073   #my $balance_due = $self->owed + $pr_total - $cr_total;
1074   my $balance_due = $self->owed + $pr_total;
1075
1076   #my @collect = ();
1077   #my($description,$amount);
1078   @buf = ();
1079
1080   #previous balance
1081   foreach ( @pr_cust_bill ) {
1082     push @buf, [
1083       "Previous Balance, Invoice #". $_->invnum.
1084                  " (". time2str("%x",$_->_date). ")",
1085       $money_char. sprintf("%10.2f",$_->owed)
1086     ];
1087   }
1088   if (@pr_cust_bill) {
1089     push @buf,['','-----------'];
1090     push @buf,[ 'Total Previous Balance',
1091                 $money_char. sprintf("%10.2f",$pr_total ) ];
1092     push @buf,['',''];
1093   }
1094
1095   #new charges
1096   foreach my $cust_bill_pkg (
1097     ( grep {   $_->pkgnum } $self->cust_bill_pkg ),  #packages first
1098     ( grep { ! $_->pkgnum } $self->cust_bill_pkg ),  #then taxes
1099   ) {
1100
1101     if ( $cust_bill_pkg->pkgnum ) {
1102
1103       my $cust_pkg = qsearchs('cust_pkg', { pkgnum =>$cust_bill_pkg->pkgnum } );
1104       my $part_pkg = qsearchs('part_pkg', { pkgpart=>$cust_pkg->pkgpart } );
1105       my $pkg = $part_pkg->pkg;
1106
1107       if ( $cust_bill_pkg->setup != 0 ) {
1108         my $description = $pkg;
1109         $description .= ' Setup' if $cust_bill_pkg->recur != 0;
1110         push @buf, [ $description,
1111                      $money_char. sprintf("%10.2f", $cust_bill_pkg->setup) ];
1112         push @buf,
1113           map { [ "  ". $_->[0]. ": ". $_->[1], '' ] } $cust_pkg->labels;
1114       }
1115
1116       if ( $cust_bill_pkg->recur != 0 ) {
1117         push @buf, [
1118           "$pkg (" . time2str("%x", $cust_bill_pkg->sdate) . " - " .
1119                                 time2str("%x", $cust_bill_pkg->edate) . ")",
1120           $money_char. sprintf("%10.2f", $cust_bill_pkg->recur)
1121         ];
1122         push @buf,
1123           map { [ "  ". $_->[0]. ": ". $_->[1], '' ] } $cust_pkg->labels;
1124       }
1125
1126     } else { #pkgnum tax or one-shot line item
1127       my $itemdesc = defined $cust_bill_pkg->dbdef_table->column('itemdesc')
1128                      ? ( $cust_bill_pkg->itemdesc || 'Tax' )
1129                      : 'Tax';
1130       if ( $cust_bill_pkg->setup != 0 ) {
1131         push @buf, [ $itemdesc,
1132                      $money_char. sprintf("%10.2f", $cust_bill_pkg->setup) ];
1133       }
1134       if ( $cust_bill_pkg->recur != 0 ) {
1135         push @buf, [ "$itemdesc (". time2str("%x", $cust_bill_pkg->sdate). " - "
1136                                   . time2str("%x", $cust_bill_pkg->edate). ")",
1137                      $money_char. sprintf("%10.2f", $cust_bill_pkg->recur)
1138                    ];
1139       }
1140     }
1141   }
1142
1143   push @buf,['','-----------'];
1144   push @buf,['Total New Charges',
1145              $money_char. sprintf("%10.2f",$self->charged) ];
1146   push @buf,['',''];
1147
1148   push @buf,['','-----------'];
1149   push @buf,['Total Charges',
1150              $money_char. sprintf("%10.2f",$self->charged + $pr_total) ];
1151   push @buf,['',''];
1152
1153   #credits
1154   foreach ( $self->cust_credited ) {
1155
1156     #something more elaborate if $_->amount ne $_->cust_credit->credited ?
1157
1158     my $reason = substr($_->cust_credit->reason,0,32);
1159     $reason .= '...' if length($reason) < length($_->cust_credit->reason);
1160     $reason = " ($reason) " if $reason;
1161     push @buf,[
1162       "Credit #". $_->crednum. " (". time2str("%x",$_->cust_credit->_date) .")".
1163         $reason,
1164       $money_char. sprintf("%10.2f",$_->amount)
1165     ];
1166   }
1167   #foreach ( @cr_cust_credit ) {
1168   #  push @buf,[
1169   #    "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")",
1170   #    $money_char. sprintf("%10.2f",$_->credited)
1171   #  ];
1172   #}
1173
1174   #get & print payments
1175   foreach ( $self->cust_bill_pay ) {
1176
1177     #something more elaborate if $_->amount ne ->cust_pay->paid ?
1178
1179     push @buf,[
1180       "Payment received ". time2str("%x",$_->cust_pay->_date ),
1181       $money_char. sprintf("%10.2f",$_->amount )
1182     ];
1183   }
1184
1185   #balance due
1186   my $balance_due_msg = $self->balance_due_msg;
1187
1188   push @buf,['','-----------'];
1189   push @buf,[$balance_due_msg, $money_char.
1190     sprintf("%10.2f", $balance_due ) ];
1191
1192   #create the template
1193   my $templatefile = 'invoice_template';
1194   $templatefile .= "_$template" if $template;
1195   my @invoice_template = $conf->config($templatefile)
1196   or die "cannot load config file $templatefile";
1197   $invoice_lines = 0;
1198   my $wasfunc = 0;
1199   foreach ( grep /invoice_lines\(\d*\)/, @invoice_template ) { #kludgy
1200     /invoice_lines\((\d*)\)/;
1201     $invoice_lines += $1 || scalar(@buf);
1202     $wasfunc=1;
1203   }
1204   die "no invoice_lines() functions in template?" unless $wasfunc;
1205   my $invoice_template = new Text::Template (
1206     TYPE   => 'ARRAY',
1207     SOURCE => [ map "$_\n", @invoice_template ],
1208   ) or die "can't create new Text::Template object: $Text::Template::ERROR";
1209   $invoice_template->compile()
1210     or die "can't compile template: $Text::Template::ERROR";
1211
1212   #setup template variables
1213   package FS::cust_bill::_template; #!
1214   use vars qw( $invnum $date $page $total_pages @address $overdue @buf $agent );
1215
1216   $invnum = $self->invnum;
1217   $date = $self->_date;
1218   $page = 1;
1219   $agent = $self->cust_main->agent->agent;
1220
1221   if ( $FS::cust_bill::invoice_lines ) {
1222     $total_pages =
1223       int( scalar(@FS::cust_bill::buf) / $FS::cust_bill::invoice_lines );
1224     $total_pages++
1225       if scalar(@FS::cust_bill::buf) % $FS::cust_bill::invoice_lines;
1226   } else {
1227     $total_pages = 1;
1228   }
1229
1230   #format address (variable for the template)
1231   my $l = 0;
1232   @address = ( '', '', '', '', '', '' );
1233   package FS::cust_bill; #!
1234   $FS::cust_bill::_template::address[$l++] =
1235     $cust_main->payname.
1236       ( ( $cust_main->payby eq 'BILL' ) && $cust_main->payinfo
1237         ? " (P.O. #". $cust_main->payinfo. ")"
1238         : ''
1239       )
1240   ;
1241   $FS::cust_bill::_template::address[$l++] = $cust_main->company
1242     if $cust_main->company;
1243   $FS::cust_bill::_template::address[$l++] = $cust_main->address1;
1244   $FS::cust_bill::_template::address[$l++] = $cust_main->address2
1245     if $cust_main->address2;
1246   $FS::cust_bill::_template::address[$l++] =
1247     $cust_main->city. ", ". $cust_main->state. "  ".  $cust_main->zip;
1248   $FS::cust_bill::_template::address[$l++] = $cust_main->country
1249     unless $cust_main->country eq 'US';
1250
1251         #  #overdue? (variable for the template)
1252         #  $FS::cust_bill::_template::overdue = (
1253         #    $balance_due > 0
1254         #    && $today > $self->_date
1255         ##    && $self->printed > 1
1256         #    && $self->printed > 0
1257         #  );
1258
1259   #and subroutine for the template
1260   sub FS::cust_bill::_template::invoice_lines {
1261     my $lines = shift || scalar(@buf);
1262     map {
1263       scalar(@buf) ? shift @buf : [ '', '' ];
1264     }
1265     ( 1 .. $lines );
1266   }
1267
1268   #and fill it in
1269   $FS::cust_bill::_template::page = 1;
1270   my $lines;
1271   my @collect;
1272   while (@buf) {
1273     push @collect, split("\n",
1274       $invoice_template->fill_in( PACKAGE => 'FS::cust_bill::_template' )
1275     );
1276     $FS::cust_bill::_template::page++;
1277   }
1278
1279   map "$_\n", @collect;
1280
1281 }
1282
1283 =item print_latex [ TIME [ , TEMPLATE ] ]
1284
1285 Internal method - returns a filename of a filled-in LaTeX template for this
1286 invoice (Note: add ".tex" to get the actual filename).
1287
1288 See print_ps and print_pdf for methods that return PostScript and PDF output.
1289
1290 TIME an optional value used to control the printing of overdue messages.  The
1291 default is now.  It isn't the date of the invoice; that's the `_date' field.
1292 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
1293 L<Time::Local> and L<Date::Parse> for conversion functions.
1294
1295 =cut
1296
1297 #still some false laziness w/print_text
1298 sub print_latex {
1299
1300   my( $self, $today, $template ) = @_;
1301   $today ||= time;
1302
1303 #  my $invnum = $self->invnum;
1304   my $cust_main = $self->cust_main;
1305   $cust_main->payname( $cust_main->first. ' '. $cust_main->getfield('last') )
1306     unless $cust_main->payname && $cust_main->payby ne 'CHEK';
1307
1308   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
1309 #  my( $cr_total, @cr_cust_credit ) = $self->cust_credit; #credits
1310   #my $balance_due = $self->owed + $pr_total - $cr_total;
1311   my $balance_due = $self->owed + $pr_total;
1312
1313   #my @collect = ();
1314   #my($description,$amount);
1315   @buf = ();
1316
1317   #create the template
1318   my $templatefile = 'invoice_latex';
1319   $templatefile .= "_$template" if $template;
1320   my @invoice_template = $conf->config($templatefile)
1321     or die "cannot load config file $templatefile";
1322
1323   my %invoice_data = (
1324     'invnum'       => $self->invnum,
1325     'date'         => time2str('%b %o, %Y', $self->_date),
1326     'agent'        => _latex_escape($cust_main->agent->agent),
1327     'payname'      => _latex_escape($cust_main->payname),
1328     'company'      => _latex_escape($cust_main->company),
1329     'address1'     => _latex_escape($cust_main->address1),
1330     'address2'     => _latex_escape($cust_main->address2),
1331     'city'         => _latex_escape($cust_main->city),
1332     'state'        => _latex_escape($cust_main->state),
1333     'zip'          => _latex_escape($cust_main->zip),
1334     'country'      => _latex_escape($cust_main->country),
1335     'footer'       => join("\n", $conf->config('invoice_latexfooter') ),
1336     'smallfooter'  => join("\n", $conf->config('invoice_latexsmallfooter') ),
1337     'quantity'     => 1,
1338     'terms'        => $conf->config('invoice_default_terms') || 'Payable upon receipt',
1339     #'notes'        => join("\n", $conf->config('invoice_latexnotes') ),
1340   );
1341
1342   my $countrydefault = $conf->config('countrydefault') || 'US';
1343   $invoice_data{'country'} = '' if $invoice_data{'country'} eq $countrydefault;
1344
1345   #do variable substitutions in notes
1346   $invoice_data{'notes'} =
1347     join("\n",
1348       map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1349         $conf->config('invoice_latexnotes')
1350     );
1351
1352   $invoice_data{'footer'} =~ s/\n+$//;
1353   $invoice_data{'smallfooter'} =~ s/\n+$//;
1354   $invoice_data{'notes'} =~ s/\n+$//;
1355
1356   $invoice_data{'po_line'} =
1357     (  $cust_main->payby eq 'BILL' && $cust_main->payinfo )
1358       ? _latex_escape("Purchase Order #". $cust_main->payinfo)
1359       : '~';
1360
1361   my @line_item = ();
1362   my @total_item = ();
1363   my @filled_in = ();
1364   while ( @invoice_template ) {
1365     my $line = shift @invoice_template;
1366
1367     if ( $line =~ /^%%Detail\s*$/ ) {
1368
1369       while ( ( my $line_item_line = shift @invoice_template )
1370               !~ /^%%EndDetail\s*$/                            ) {
1371         push @line_item, $line_item_line;
1372       }
1373       foreach my $line_item ( $self->_items ) {
1374       #foreach my $line_item ( $self->_items_pkg ) {
1375         $invoice_data{'ref'} = $line_item->{'pkgnum'};
1376         $invoice_data{'description'} = _latex_escape($line_item->{'description'});
1377         if ( exists $line_item->{'ext_description'} ) {
1378           $invoice_data{'description'} .=
1379             "\\tabularnewline\n~~".
1380             join("\\tabularnewline\n~~", map { _latex_escape($_) } @{$line_item->{'ext_description'}} );
1381         }
1382         $invoice_data{'amount'} = $line_item->{'amount'};
1383         $invoice_data{'product_code'} = $line_item->{'pkgpart'} || 'N/A';
1384         push @filled_in,
1385           map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b } @line_item;
1386       }
1387
1388     } elsif ( $line =~ /^%%TotalDetails\s*$/ ) {
1389
1390       while ( ( my $total_item_line = shift @invoice_template )
1391               !~ /^%%EndTotalDetails\s*$/                      ) {
1392         push @total_item, $total_item_line;
1393       }
1394
1395       my @total_fill = ();
1396
1397       my $taxtotal = 0;
1398       foreach my $tax ( $self->_items_tax ) {
1399         $invoice_data{'total_item'} = _latex_escape($tax->{'description'});
1400         $taxtotal += ( $invoice_data{'total_amount'} = $tax->{'amount'} );
1401         push @total_fill,
1402           map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1403               @total_item;
1404       }
1405
1406       if ( $taxtotal ) {
1407         $invoice_data{'total_item'} = 'Sub-total';
1408         $invoice_data{'total_amount'} =
1409           '\dollar '. sprintf('%.2f', $self->charged - $taxtotal );
1410         unshift @total_fill,
1411           map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1412               @total_item;
1413       }
1414
1415       $invoice_data{'total_item'} = '\textbf{Total}';
1416       $invoice_data{'total_amount'} =
1417         '\textbf{\dollar '. sprintf('%.2f', $self->charged + $pr_total ). '}';
1418       push @total_fill,
1419         map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1420             @total_item;
1421
1422       #foreach my $thing ( sort { $a->_date <=> $b->_date } $self->_items_credits, $self->_items_payments
1423
1424       # credits
1425       foreach my $credit ( $self->_items_credits ) {
1426         $invoice_data{'total_item'} = _latex_escape($credit->{'description'});
1427         #$credittotal
1428         $invoice_data{'total_amount'} = '-\dollar '. $credit->{'amount'};
1429         push @total_fill,
1430           map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1431               @total_item;
1432       }
1433
1434       # payments
1435       foreach my $payment ( $self->_items_payments ) {
1436         $invoice_data{'total_item'} = _latex_escape($payment->{'description'});
1437         #$paymenttotal
1438         $invoice_data{'total_amount'} = '-\dollar '. $payment->{'amount'};
1439         push @total_fill,
1440           map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1441               @total_item;
1442       }
1443
1444       $invoice_data{'total_item'} = '\textbf{'. $self->balance_due_msg. '}';
1445       $invoice_data{'total_amount'} =
1446         '\textbf{\dollar '. sprintf('%.2f', $self->owed + $pr_total ). '}';
1447       push @total_fill,
1448         map { my $b=$_; $b =~ s/\$(\w+)/$invoice_data{$1}/eg; $b }
1449             @total_item;
1450
1451       push @filled_in, @total_fill;
1452
1453     } else {
1454       #$line =~ s/\$(\w+)/$invoice_data{$1}/eg;
1455       $line =~ s/\$(\w+)/exists($invoice_data{$1}) ? $invoice_data{$1} : nounder($1)/eg;
1456       push @filled_in, $line;
1457     }
1458
1459   }
1460
1461   sub nounder {
1462     my $var = $1;
1463     $var =~ s/_/\-/g;
1464     $var;
1465   }
1466
1467   my $dir = '/tmp'; #! /usr/local/etc/freeside/invoices.datasrc/
1468   my $unique = int(rand(2**31)); #UGH... use File::Temp or something
1469
1470   chdir($dir);
1471   my $file = $self->invnum. ".$unique";
1472
1473   open(TEX,">$file.tex") or die "can't open $file.tex: $!\n";
1474   print TEX join("\n", @filled_in ), "\n";
1475   close TEX;
1476
1477   return $file;
1478
1479 }
1480
1481 =item print_ps [ TIME [ , TEMPLATE ] ]
1482
1483 Returns an postscript invoice, as a scalar.
1484
1485 TIME an optional value used to control the printing of overdue messages.  The
1486 default is now.  It isn't the date of the invoice; that's the `_date' field.
1487 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
1488 L<Time::Local> and L<Date::Parse> for conversion functions.
1489
1490 =cut
1491
1492 sub print_ps {
1493   my $self = shift;
1494
1495   my $file = $self->print_latex(@_);
1496
1497   #error checking!!
1498   system('pslatex', "$file.tex");
1499   system('pslatex', "$file.tex");
1500   system('dvips', '-q', '-t', 'letter', "$file.dvi", '-o', "$file.ps" );
1501
1502   open(POSTSCRIPT, "<$file.ps")
1503     or die "can't open $file.ps (probable error in LaTeX template): $!\n";
1504
1505   unlink("$file.dvi", "$file.log", "$file.aux", "$file.ps", "$file.tex");
1506
1507   my $ps = '';
1508   while (<POSTSCRIPT>) {
1509     $ps .= $_;
1510   }
1511
1512   close POSTSCRIPT;
1513
1514   return $ps;
1515
1516 }
1517
1518 =item print_pdf [ TIME [ , TEMPLATE ] ]
1519
1520 Returns an PDF invoice, as a scalar.
1521
1522 TIME an optional value used to control the printing of overdue messages.  The
1523 default is now.  It isn't the date of the invoice; that's the `_date' field.
1524 It is specified as a UNIX timestamp; see L<perlfunc/"time">.  Also see
1525 L<Time::Local> and L<Date::Parse> for conversion functions.
1526
1527 =cut
1528
1529 sub print_pdf {
1530   my $self = shift;
1531
1532   my $file = $self->print_latex(@_);
1533
1534   #system('pdflatex', "$file.tex");
1535   #system('pdflatex', "$file.tex");
1536   #! LaTeX Error: Unknown graphics extension: .eps.
1537
1538   #error checking!!
1539   system('pslatex', "$file.tex");
1540   system('pslatex', "$file.tex");
1541
1542   #system('dvipdf', "$file.dvi", "$file.pdf" );
1543   system("dvips -q -t letter -f $file.dvi | gs -q -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sOutputFile=$file.pdf -c save pop -");
1544
1545   open(PDF, "<$file.pdf")
1546     or die "can't open $file.pdf (probably error in LaTeX tempalte: $!\n";
1547
1548   unlink("$file.dvi", "$file.log", "$file.aux", "$file.pdf", "$file.tex");
1549
1550   my $pdf = '';
1551   while (<PDF>) {
1552     $pdf .= $_;
1553   }
1554
1555   close PDF;
1556
1557   return $pdf;
1558
1559 }
1560
1561 # quick subroutine for print_latex
1562 #
1563 # There are ten characters that LaTeX treats as special characters, which
1564 # means that they do not simply typeset themselves:
1565 #      # $ % & ~ _ ^ \ { }
1566 #
1567 # TeX ignores blanks following an escaped character; if you want a blank (as
1568 # in "10% of ..."), you have to "escape" the blank as well ("10\%\ of ...").
1569
1570 sub _latex_escape {
1571   my $value = shift;
1572   $value =~ s/([#\$%&~_\^{}])( )?/"\\$1". ( length($2) ? "\\$2" : '' )/ge;
1573   $value;
1574 }
1575
1576 #utility methods for print_*
1577
1578 sub balance_due_msg {
1579   my $self = shift;
1580   my $msg = 'Balance Due';
1581   return $msg unless $conf->exists('invoice_default_terms');
1582   if ( $conf->config('invoice_default_terms') =~ /^\s*Net\s*(\d+)\s*$/ ) {
1583     $msg .= ' - Please pay by '. time2str("%x", $self->_date + ($1*86400) );
1584   } elsif ( $conf->config('invoice_default_terms') ) {
1585     $msg .= ' - '. $conf->config('invoice_default_terms');
1586   }
1587   $msg;
1588 }
1589
1590 sub _items {
1591   my $self = shift;
1592   my @display = scalar(@_)
1593                 ? @_
1594                 : qw( _items_previous _items_pkg );
1595                 #: qw( _items_pkg );
1596                 #: qw( _items_previous _items_pkg _items_tax _items_credits _items_payments );
1597   my @b = ();
1598   foreach my $display ( @display ) {
1599     push @b, $self->$display(@_);
1600   }
1601   @b;
1602 }
1603
1604 sub _items_previous {
1605   my $self = shift;
1606   my $cust_main = $self->cust_main;
1607   my( $pr_total, @pr_cust_bill ) = $self->previous; #previous balance
1608   my @b = ();
1609   foreach ( @pr_cust_bill ) {
1610     push @b, {
1611       'description' => 'Previous Balance, Invoice #'. $_->invnum.
1612                        ' ('. time2str('%x',$_->_date). ')',
1613       #'pkgpart'     => 'N/A',
1614       'pkgnum'      => 'N/A',
1615       'amount'      => sprintf("%10.2f", $_->owed),
1616     };
1617   }
1618   @b;
1619
1620   #{
1621   #    'description'     => 'Previous Balance',
1622   #    #'pkgpart'         => 'N/A',
1623   #    'pkgnum'          => 'N/A',
1624   #    'amount'          => sprintf("%10.2f", $pr_total ),
1625   #    'ext_description' => [ map {
1626   #                                 "Invoice ". $_->invnum.
1627   #                                 " (". time2str("%x",$_->_date). ") ".
1628   #                                 sprintf("%10.2f", $_->owed)
1629   #                         } @pr_cust_bill ],
1630
1631   #};
1632 }
1633
1634 sub _items_pkg {
1635   my $self = shift;
1636   my @cust_bill_pkg = grep { $_->pkgnum } $self->cust_bill_pkg;
1637   $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
1638 }
1639
1640 sub _items_tax {
1641   my $self = shift;
1642   my @cust_bill_pkg = grep { ! $_->pkgnum } $self->cust_bill_pkg;
1643   $self->_items_cust_bill_pkg(\@cust_bill_pkg, @_);
1644 }
1645
1646 sub _items_cust_bill_pkg {
1647   my $self = shift;
1648   my $cust_bill_pkg = shift;
1649
1650   my @b = ();
1651   foreach my $cust_bill_pkg ( @$cust_bill_pkg ) {
1652
1653     if ( $cust_bill_pkg->pkgnum ) {
1654
1655       my $cust_pkg = qsearchs('cust_pkg', { pkgnum =>$cust_bill_pkg->pkgnum } );
1656       my $part_pkg = qsearchs('part_pkg', { pkgpart=>$cust_pkg->pkgpart } );
1657       my $pkg = $part_pkg->pkg;
1658
1659       my %labels;
1660       #tie %labels, 'Tie::IxHash';
1661       push @{ $labels{$_->[0]} }, $_->[1] foreach $cust_pkg->labels;
1662       my @ext_description;
1663       foreach my $label ( keys %labels ) {
1664         my @values = @{ $labels{$label} };
1665         my $num = scalar(@values);
1666         if ( $num > 5 ) {
1667           push @ext_description, "$label ($num)";
1668         } else {
1669           push @ext_description, map { "$label: $_" } @values;
1670         }
1671       }
1672
1673       if ( $cust_bill_pkg->setup != 0 ) {
1674         my $description = $pkg;
1675         $description .= ' Setup' if $cust_bill_pkg->recur != 0;
1676         my @d = @ext_description;
1677         push @d, $cust_bill_pkg->details if $cust_bill_pkg->recur == 0;
1678         push @b, {
1679           'description'     => $description,
1680           #'pkgpart'         => $part_pkg->pkgpart,
1681           'pkgnum'          => $cust_pkg->pkgnum,
1682           'amount'          => sprintf("%10.2f", $cust_bill_pkg->setup),
1683           'ext_description' => \@d,
1684         };
1685       }
1686
1687       if ( $cust_bill_pkg->recur != 0 ) {
1688         push @b, {
1689           'description'     => "$pkg (" .
1690                                time2str('%x', $cust_bill_pkg->sdate). ' - '.
1691                                time2str('%x', $cust_bill_pkg->edate). ')',
1692           #'pkgpart'         => $part_pkg->pkgpart,
1693           'pkgnum'          => $cust_pkg->pkgnum,
1694           'amount'          => sprintf("%10.2f", $cust_bill_pkg->recur),
1695           'ext_description' => [ @ext_description,
1696                                  $cust_bill_pkg->details,
1697                                ],
1698         };
1699       }
1700
1701     } else { #pkgnum tax or one-shot line item (??)
1702
1703       my $itemdesc = defined $cust_bill_pkg->dbdef_table->column('itemdesc')
1704                      ? ( $cust_bill_pkg->itemdesc || 'Tax' )
1705                      : 'Tax';
1706       if ( $cust_bill_pkg->setup != 0 ) {
1707         push @b, {
1708           'description' => $itemdesc,
1709           'amount'      => sprintf("%10.2f", $cust_bill_pkg->setup),
1710         };
1711       }
1712       if ( $cust_bill_pkg->recur != 0 ) {
1713         push @b, {
1714           'description' => "$itemdesc (".
1715                            time2str("%x", $cust_bill_pkg->sdate). ' - '.
1716                            time2str("%x", $cust_bill_pkg->edate). ')',
1717           'amount'      => sprintf("%10.2f", $cust_bill_pkg->recur),
1718         };
1719       }
1720
1721     }
1722
1723   }
1724
1725   @b;
1726
1727 }
1728
1729 sub _items_credits {
1730   my $self = shift;
1731
1732   my @b;
1733   #credits
1734   foreach ( $self->cust_credited ) {
1735
1736     #something more elaborate if $_->amount ne $_->cust_credit->credited ?
1737
1738     my $reason = $_->cust_credit->reason;
1739     #my $reason = substr($_->cust_credit->reason,0,32);
1740     #$reason .= '...' if length($reason) < length($_->cust_credit->reason);
1741     $reason = " ($reason) " if $reason;
1742     push @b, {
1743       #'description' => 'Credit ref\#'. $_->crednum.
1744       #                 " (". time2str("%x",$_->cust_credit->_date) .")".
1745       #                 $reason,
1746       'description' => 'Credit applied'.
1747                        time2str("%x",$_->cust_credit->_date). $reason,
1748       'amount'      => sprintf("%10.2f",$_->amount),
1749     };
1750   }
1751   #foreach ( @cr_cust_credit ) {
1752   #  push @buf,[
1753   #    "Credit #". $_->crednum. " (" . time2str("%x",$_->_date) .")",
1754   #    $money_char. sprintf("%10.2f",$_->credited)
1755   #  ];
1756   #}
1757
1758   @b;
1759
1760 }
1761
1762 sub _items_payments {
1763   my $self = shift;
1764
1765   my @b;
1766   #get & print payments
1767   foreach ( $self->cust_bill_pay ) {
1768
1769     #something more elaborate if $_->amount ne ->cust_pay->paid ?
1770
1771     push @b, {
1772       'description' => "Payment received ".
1773                        time2str("%x",$_->cust_pay->_date ),
1774       'amount'      => sprintf("%10.2f", $_->amount )
1775     };
1776   }
1777
1778   @b;
1779
1780 }
1781
1782 =back
1783
1784 =head1 BUGS
1785
1786 The delete method.
1787
1788 print_text formatting (and some logic :/) is in source, but needs to be
1789 slurped in from a file.  Also number of lines ($=).
1790
1791 missing print_ps for a nice postscript copy (maybe HylaFAX-cover-page-style
1792 or something similar so the look can be completely customized?)
1793
1794 =head1 SEE ALSO
1795
1796 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill_pay>, L<FS::cust_pay>,
1797 L<FS::cust_bill_pkg>, L<FS::cust_bill_credit>, schema.html from the base
1798 documentation.
1799
1800 =cut
1801
1802 1;
1803