FS/FS/cust_main.pm

   1 package FS::cust_main;
   2
   3 use strict;
   4 use vars qw( @ISA $conf $Debug $import );
   5 use Safe;
   6 use Carp;
   7 use Time::Local;
   8 use Date::Format;
   9 #use Date::Manip;
  10 use Business::CreditCard;
  11 use FS::UID qw( getotaker dbh );
  12 use FS::Record qw( qsearchs qsearch dbdef );
  13 use FS::cust_pkg;
  14 use FS::cust_bill;
  15 use FS::cust_bill_pkg;
  16 use FS::cust_pay;
  17 use FS::cust_credit;
  18 use FS::part_referral;
  19 use FS::cust_main_county;
  20 use FS::agent;
  21 use FS::cust_main_invoice;
  22 use FS::cust_credit_bill;
  23 use FS::cust_bill_pay;
  24 use FS::prepay_credit;
  25 use FS::queue;
  26 use FS::part_pkg;
  27 use FS::part_bill_event;
  28 use FS::cust_bill_event;
  29 use FS::cust_tax_exempt;
  30 use FS::type_pkgs;
  31 use FS::Msgcat qw(gettext);
  32
  33 @ISA = qw( FS::Record );
  34
  35 $Debug = 0;
  36 #$Debug = 1;
  37
  38 $import = 0;
  39
  40 #ask FS::UID to run this stuff for us later
  41 $FS::UID::callback{'FS::cust_main'} = sub {
  42   $conf = new FS::Conf;
  43   #yes, need it for stuff below (prolly should be cached)
  44 };
  45
  46 sub _cache {
  47   my $self = shift;
  48   my ( $hashref, $cache ) = @_;
  49   if ( exists $hashref->{'pkgnum'} ) {
  50 #    #@{ $self->{'_pkgnum'} } = ();
  51     my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
  52     $self->{'_pkgnum'} = $subcache;
  53     #push @{ $self->{'_pkgnum'} },
  54     FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
  55   }
  56 }
  57
  58 =head1 NAME
  59
  60 FS::cust_main - Object methods for cust_main records
  61
  62 =head1 SYNOPSIS
  63
  64   use FS::cust_main;
  65
  66   $record = new FS::cust_main \%hash;
  67   $record = new FS::cust_main { 'column' => 'value' };
  68
  69   $error = $record->insert;
  70
  71   $error = $new_record->replace($old_record);
  72
  73   $error = $record->delete;
  74
  75   $error = $record->check;
  76
  77   @cust_pkg = $record->all_pkgs;
  78
  79   @cust_pkg = $record->ncancelled_pkgs;
  80
  81   @cust_pkg = $record->suspended_pkgs;
  82
  83   $error = $record->bill;
  84   $error = $record->bill %options;
  85   $error = $record->bill 'time' => $time;
  86
  87   $error = $record->collect;
  88   $error = $record->collect %options;
  89   $error = $record->collect 'invoice_time'   => $time,
  90                             'batch_card'     => 'yes',
  91                             'report_badcard' => 'yes',
  92                           ;
  93
  94 =head1 DESCRIPTION
  95
  96 An FS::cust_main object represents a customer.  FS::cust_main inherits from
  97 FS::Record.  The following fields are currently supported:
  98
  99 =over 4
 100
 101 =item custnum - primary key (assigned automatically for new customers)
 102
 103 =item agentnum - agent (see L<FS::agent>)
 104
 105 =item refnum - Advertising source (see L<FS::part_referral>)
 106
 107 =item first - name
 108
 109 =item last - name
 110
 111 =item ss - social security number (optional)
 112
 113 =item company - (optional)
 114
 115 =item address1
 116
 117 =item address2 - (optional)
 118
 119 =item city
 120
 121 =item county - (optional, see L<FS::cust_main_county>)
 122
 123 =item state - (see L<FS::cust_main_county>)
 124
 125 =item zip
 126
 127 =item country - (see L<FS::cust_main_county>)
 128
 129 =item daytime - phone (optional)
 130
 131 =item night - phone (optional)
 132
 133 =item fax - phone (optional)
 134
 135 =item ship_first - name
 136
 137 =item ship_last - name
 138
 139 =item ship_company - (optional)
 140
 141 =item ship_address1
 142
 143 =item ship_address2 - (optional)
 144
 145 =item ship_city
 146
 147 =item ship_county - (optional, see L<FS::cust_main_county>)
 148
 149 =item ship_state - (see L<FS::cust_main_county>)
 150
 151 =item ship_zip
 152
 153 =item ship_country - (see L<FS::cust_main_county>)
 154
 155 =item ship_daytime - phone (optional)
 156
 157 =item ship_night - phone (optional)
 158
 159 =item ship_fax - phone (optional)
 160
 161 =item payby - `CARD' (credit cards), `CHEK' (electronic check), `LECB' (Phone bill billing), `BILL' (billing), `COMP' (free), or `PREPAY' (special billing type: applies a credit - see L<FS::prepay_credit> and sets billing type to BILL)
 162
 163 =item payinfo - card number, P.O., comp issuer (4-8 lowercase alphanumerics; think username) or prepayment identifier (see L<FS::prepay_credit>)
 164
 165 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
 166
 167 =item payname - name on card or billing name
 168
 169 =item tax - tax exempt, empty or `Y'
 170
 171 =item otaker - order taker (assigned automatically, see L<FS::UID>)
 172
 173 =item comments - comments (optional)
 174
 175 =item referral_custnum - referring customer number
 176
 177 =back
 178
 179 =head1 METHODS
 180
 181 =over 4
 182
 183 =item new HASHREF
 184
 185 Creates a new customer.  To add the customer to the database, see L<"insert">.
 186
 187 Note that this stores the hash reference, not a distinct copy of the hash it
 188 points to.  You can ask the object for a copy with the I<hash> method.
 189
 190 =cut
 191
 192 sub table { 'cust_main'; }
 193
 194 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] ]
 195
 196 Adds this customer to the database.  If there is an error, returns the error,
 197 otherwise returns false.
 198
 199 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
 200 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
 201 are inserted atomicly, or the transaction is rolled back.  Passing an empty
 202 hash reference is equivalent to not supplying this parameter.  There should be
 203 a better explanation of this, but until then, here's an example:
 204
 205   use Tie::RefHash;
 206   tie %hash, 'Tie::RefHash'; #this part is important
 207   %hash = (
 208     $cust_pkg => [ $svc_acct ],
 209     ...
 210   );
 211   $cust_main->insert( \%hash );
 212
 213 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
 214 be set as the invoicing list (see L<"invoicing_list">).  Errors return as
 215 expected and rollback the entire transaction; it is not necessary to call
 216 check_invoicing_list first.  The invoicing_list is set after the records in the
 217 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
 218 invoicing_list destination to the newly-created svc_acct.  Here's an example:
 219
 220   $cust_main->insert( {}, [ $email, 'POST' ] );
 221
 222 =cut
 223
 224 sub insert {
 225   my $self = shift;
 226   my $cust_pkgs = @_ ? shift : {};
 227   my $invoicing_list = @_ ? shift : '';
 228
 229   local $SIG{HUP} = 'IGNORE';
 230   local $SIG{INT} = 'IGNORE';
 231   local $SIG{QUIT} = 'IGNORE';
 232   local $SIG{TERM} = 'IGNORE';
 233   local $SIG{TSTP} = 'IGNORE';
 234   local $SIG{PIPE} = 'IGNORE';
 235
 236   my $oldAutoCommit = $FS::UID::AutoCommit;
 237   local $FS::UID::AutoCommit = 0;
 238   my $dbh = dbh;
 239
 240   my $amount = 0;
 241   my $seconds = 0;
 242   if ( $self->payby eq 'PREPAY' ) {
 243     $self->payby('BILL');
 244     my $prepay_credit = qsearchs(
 245       'prepay_credit',
 246       { 'identifier' => $self->payinfo },
 247       '',
 248       'FOR UPDATE'
 249     );
 250     warn "WARNING: can't find pre-found prepay_credit: ". $self->payinfo
 251       unless $prepay_credit;
 252     $amount = $prepay_credit->amount;
 253     $seconds = $prepay_credit->seconds;
 254     my $error = $prepay_credit->delete;
 255     if ( $error ) {
 256       $dbh->rollback if $oldAutoCommit;
 257       return "removing prepay_credit (transaction rolled back): $error";
 258     }
 259   }
 260
 261   my $error = $self->SUPER::insert;
 262   if ( $error ) {
 263     $dbh->rollback if $oldAutoCommit;
 264     #return "inserting cust_main record (transaction rolled back): $error";
 265     return $error;
 266   }
 267
 268   # invoicing list
 269   if ( $invoicing_list ) {
 270     $error = $self->check_invoicing_list( $invoicing_list );
 271     if ( $error ) {
 272       $dbh->rollback if $oldAutoCommit;
 273       return "checking invoicing_list (transaction rolled back): $error";
 274     }
 275     $self->invoicing_list( $invoicing_list );
 276   }
 277
 278   # packages
 279   foreach my $cust_pkg ( keys %$cust_pkgs ) {
 280     $cust_pkg->custnum( $self->custnum );
 281     $error = $cust_pkg->insert;
 282     if ( $error ) {
 283       $dbh->rollback if $oldAutoCommit;
 284       return "inserting cust_pkg (transaction rolled back): $error";
 285     }
 286     foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
 287       $svc_something->pkgnum( $cust_pkg->pkgnum );
 288       if ( $seconds && $svc_something->isa('FS::svc_acct') ) {
 289         $svc_something->seconds( $svc_something->seconds + $seconds );
 290         $seconds = 0;
 291       }
 292       $error = $svc_something->insert;
 293       if ( $error ) {
 294         $dbh->rollback if $oldAutoCommit;
 295         #return "inserting svc_ (transaction rolled back): $error";
 296         return $error;
 297       }
 298     }
 299   }
 300
 301   if ( $seconds ) {
 302     $dbh->rollback if $oldAutoCommit;
 303     return "No svc_acct record to apply pre-paid time";
 304   }
 305
 306   if ( $amount ) {
 307     my $cust_credit = new FS::cust_credit {
 308       'custnum' => $self->custnum,
 309       'amount'  => $amount,
 310     };
 311     $error = $cust_credit->insert;
 312     if ( $error ) {
 313       $dbh->rollback if $oldAutoCommit;
 314       return "inserting credit (transaction rolled back): $error";
 315     }
 316   }
 317
 318   #false laziness with sub replace
 319   my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
 320   $error = $queue->insert($self->getfield('last'), $self->company);
 321   if ( $error ) {
 322     $dbh->rollback if $oldAutoCommit;
 323     return "queueing job (transaction rolled back): $error";
 324   }
 325
 326   if ( defined $self->dbdef_table->column('ship_last') && $self->ship_last ) {
 327     $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
 328     $error = $queue->insert($self->getfield('last'), $self->company);
 329     if ( $error ) {
 330       $dbh->rollback if $oldAutoCommit;
 331       return "queueing job (transaction rolled back): $error";
 332     }
 333   }
 334   #eslaf
 335
 336   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 337   '';
 338
 339 }
 340
 341 =item delete NEW_CUSTNUM
 342
 343 This deletes the customer.  If there is an error, returns the error, otherwise
 344 returns false.
 345
 346 This will completely remove all traces of the customer record.  This is not
 347 what you want when a customer cancels service; for that, cancel all of the
 348 customer's packages (see L<FS::cust_pkg/cancel>).
 349
 350 If the customer has any uncancelled packages, you need to pass a new (valid)
 351 customer number for those packages to be transferred to.  Cancelled packages
 352 will be deleted.  Did I mention that this is NOT what you want when a customer
 353 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
 354
 355 You can't delete a customer with invoices (see L<FS::cust_bill>),
 356 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
 357 refunds (see L<FS::cust_refund>).
 358
 359 =cut
 360
 361 sub delete {
 362   my $self = shift;
 363
 364   local $SIG{HUP} = 'IGNORE';
 365   local $SIG{INT} = 'IGNORE';
 366   local $SIG{QUIT} = 'IGNORE';
 367   local $SIG{TERM} = 'IGNORE';
 368   local $SIG{TSTP} = 'IGNORE';
 369   local $SIG{PIPE} = 'IGNORE';
 370
 371   my $oldAutoCommit = $FS::UID::AutoCommit;
 372   local $FS::UID::AutoCommit = 0;
 373   my $dbh = dbh;
 374
 375   if ( qsearch( 'cust_bill', { 'custnum' => $self->custnum } ) ) {
 376     $dbh->rollback if $oldAutoCommit;
 377     return "Can't delete a customer with invoices";
 378   }
 379   if ( qsearch( 'cust_credit', { 'custnum' => $self->custnum } ) ) {
 380     $dbh->rollback if $oldAutoCommit;
 381     return "Can't delete a customer with credits";
 382   }
 383   if ( qsearch( 'cust_pay', { 'custnum' => $self->custnum } ) ) {
 384     $dbh->rollback if $oldAutoCommit;
 385     return "Can't delete a customer with payments";
 386   }
 387   if ( qsearch( 'cust_refund', { 'custnum' => $self->custnum } ) ) {
 388     $dbh->rollback if $oldAutoCommit;
 389     return "Can't delete a customer with refunds";
 390   }
 391
 392   my @cust_pkg = $self->ncancelled_pkgs;
 393   if ( @cust_pkg ) {
 394     my $new_custnum = shift;
 395     unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
 396       $dbh->rollback if $oldAutoCommit;
 397       return "Invalid new customer number: $new_custnum";
 398     }
 399     foreach my $cust_pkg ( @cust_pkg ) {
 400       my %hash = $cust_pkg->hash;
 401       $hash{'custnum'} = $new_custnum;
 402       my $new_cust_pkg = new FS::cust_pkg ( \%hash );
 403       my $error = $new_cust_pkg->replace($cust_pkg);
 404       if ( $error ) {
 405         $dbh->rollback if $oldAutoCommit;
 406         return $error;
 407       }
 408     }
 409   }
 410   my @cancelled_cust_pkg = $self->all_pkgs;
 411   foreach my $cust_pkg ( @cancelled_cust_pkg ) {
 412     my $error = $cust_pkg->delete;
 413     if ( $error ) {
 414       $dbh->rollback if $oldAutoCommit;
 415       return $error;
 416     }
 417   }
 418
 419   foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
 420     qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
 421   ) {
 422     my $error = $cust_main_invoice->delete;
 423     if ( $error ) {
 424       $dbh->rollback if $oldAutoCommit;
 425       return $error;
 426     }
 427   }
 428
 429   my $error = $self->SUPER::delete;
 430   if ( $error ) {
 431     $dbh->rollback if $oldAutoCommit;
 432     return $error;
 433   }
 434
 435   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 436   '';
 437
 438 }
 439
 440 =item replace OLD_RECORD [ INVOICING_LIST_ARYREF ]
 441
 442 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 443 returns the error, otherwise returns false.
 444
 445 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
 446 be set as the invoicing list (see L<"invoicing_list">).  Errors return as
 447 expected and rollback the entire transaction; it is not necessary to call
 448 check_invoicing_list first.  Here's an example:
 449
 450   $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
 451
 452 =cut
 453
 454 sub replace {
 455   my $self = shift;
 456   my $old = shift;
 457   my @param = @_;
 458
 459   local $SIG{HUP} = 'IGNORE';
 460   local $SIG{INT} = 'IGNORE';
 461   local $SIG{QUIT} = 'IGNORE';
 462   local $SIG{TERM} = 'IGNORE';
 463   local $SIG{TSTP} = 'IGNORE';
 464   local $SIG{PIPE} = 'IGNORE';
 465
 466   my $oldAutoCommit = $FS::UID::AutoCommit;
 467   local $FS::UID::AutoCommit = 0;
 468   my $dbh = dbh;
 469
 470   my $error = $self->SUPER::replace($old);
 471
 472   if ( $error ) {
 473     $dbh->rollback if $oldAutoCommit;
 474     return $error;
 475   }
 476
 477   if ( @param ) { # INVOICING_LIST_ARYREF
 478     my $invoicing_list = shift @param;
 479     $error = $self->check_invoicing_list( $invoicing_list );
 480     if ( $error ) {
 481       $dbh->rollback if $oldAutoCommit;
 482       return $error;
 483     }
 484     $self->invoicing_list( $invoicing_list );
 485   }
 486
 487   if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
 488        grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
 489     # card/check info has changed, want to retry realtime_card invoice events
 490     #false laziness w/collect
 491     foreach my $cust_bill_event (
 492       grep {
 493              #$_->part_bill_event->plan eq 'realtime-card'
 494              $_->part_bill_event->eventcode =~
 495                  /^\$cust_bill\->realtime_(card|ach|lec)\(\);$/
 496                && $_->status eq 'done'
 497                && $_->statustext
 498            }
 499         map { $_->cust_bill_event }
 500           grep { $_->cust_bill_event }
 501             $self->open_cust_bill
 502
 503     ) {
 504       my $error = $cust_bill_event->retry;
 505       if ( $error ) {
 506         $dbh->rollback if $oldAutoCommit;
 507         return "error scheduling invoice events for retry: $error";
 508       }
 509     }
 510     #eslaf
 511
 512   }
 513
 514   #false laziness with sub insert
 515   my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
 516   $error = $queue->insert($self->getfield('last'), $self->company);
 517   if ( $error ) {
 518     $dbh->rollback if $oldAutoCommit;
 519     return "queueing job (transaction rolled back): $error";
 520   }
 521
 522   if ( defined $self->dbdef_table->column('ship_last') && $self->ship_last ) {
 523     $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
 524     $error = $queue->insert($self->getfield('last'), $self->company);
 525     if ( $error ) {
 526       $dbh->rollback if $oldAutoCommit;
 527       return "queueing job (transaction rolled back): $error";
 528     }
 529   }
 530   #eslaf
 531
 532   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 533   '';
 534
 535 }
 536
 537 =item check
 538
 539 Checks all fields to make sure this is a valid customer record.  If there is
 540 an error, returns the error, otherwise returns false.  Called by the insert
 541 and repalce methods.
 542
 543 =cut
 544
 545 sub check {
 546   my $self = shift;
 547
 548   #warn "BEFORE: \n". $self->_dump;
 549
 550   my $error =
 551     $self->ut_numbern('custnum')
 552     || $self->ut_number('agentnum')
 553     || $self->ut_number('refnum')
 554     || $self->ut_name('last')
 555     || $self->ut_name('first')
 556     || $self->ut_textn('company')
 557     || $self->ut_text('address1')
 558     || $self->ut_textn('address2')
 559     || $self->ut_text('city')
 560     || $self->ut_textn('county')
 561     || $self->ut_textn('state')
 562     || $self->ut_country('country')
 563     || $self->ut_anything('comments')
 564     || $self->ut_numbern('referral_custnum')
 565   ;
 566   #barf.  need message catalogs.  i18n.  etc.
 567   $error .= "Please select a advertising source."
 568     if $error =~ /^Illegal or empty \(numeric\) refnum: /;
 569   return $error if $error;
 570
 571   return "Unknown agent"
 572     unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
 573
 574   return "Unknown refnum"
 575     unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
 576
 577   return "Unknown referring custnum ". $self->referral_custnum
 578     unless ! $self->referral_custnum
 579            || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
 580
 581   if ( $self->ss eq '' ) {
 582     $self->ss('');
 583   } else {
 584     my $ss = $self->ss;
 585     $ss =~ s/\D//g;
 586     $ss =~ /^(\d{3})(\d{2})(\d{4})$/
 587       or return "Illegal social security number: ". $self->ss;
 588     $self->ss("$1-$2-$3");
 589   }
 590
 591
 592 # bad idea to disable, causes billing to fail because of no tax rates later
 593 #  unless ( $import ) {
 594     unless ( qsearchs('cust_main_county', {
 595       'country' => $self->country,
 596       'state'   => '',
 597      } ) ) {
 598       return "Unknown state/county/country: ".
 599         $self->state. "/". $self->county. "/". $self->country
 600         unless qsearchs('cust_main_county',{
 601           'state'   => $self->state,
 602           'county'  => $self->county,
 603           'country' => $self->country,
 604         } );
 605     }
 606 #  }
 607
 608   $error =
 609     $self->ut_phonen('daytime', $self->country)
 610     || $self->ut_phonen('night', $self->country)
 611     || $self->ut_phonen('fax', $self->country)
 612     || $self->ut_zip('zip', $self->country)
 613   ;
 614   return $error if $error;
 615
 616   my @addfields = qw(
 617     last first company address1 address2 city county state zip
 618     country daytime night fax
 619   );
 620
 621   if ( defined $self->dbdef_table->column('ship_last') ) {
 622     if ( scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
 623                        @addfields )
 624          && scalar ( grep { $self->getfield("ship_$_") ne '' } @addfields )
 625        )
 626     {
 627       my $error =
 628         $self->ut_name('ship_last')
 629         || $self->ut_name('ship_first')
 630         || $self->ut_textn('ship_company')
 631         || $self->ut_text('ship_address1')
 632         || $self->ut_textn('ship_address2')
 633         || $self->ut_text('ship_city')
 634         || $self->ut_textn('ship_county')
 635         || $self->ut_textn('ship_state')
 636         || $self->ut_country('ship_country')
 637       ;
 638       return $error if $error;
 639
 640       #false laziness with above
 641       unless ( qsearchs('cust_main_county', {
 642         'country' => $self->ship_country,
 643         'state'   => '',
 644        } ) ) {
 645         return "Unknown ship_state/ship_county/ship_country: ".
 646           $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
 647           unless qsearchs('cust_main_county',{
 648             'state'   => $self->ship_state,
 649             'county'  => $self->ship_county,
 650             'country' => $self->ship_country,
 651           } );
 652       }
 653       #eofalse
 654
 655       $error =
 656         $self->ut_phonen('ship_daytime', $self->ship_country)
 657         || $self->ut_phonen('ship_night', $self->ship_country)
 658         || $self->ut_phonen('ship_fax', $self->ship_country)
 659         || $self->ut_zip('ship_zip', $self->ship_country)
 660       ;
 661       return $error if $error;
 662
 663     } else { # ship_ info eq billing info, so don't store dup info in database
 664       $self->setfield("ship_$_", '')
 665         foreach qw( last first company address1 address2 city county state zip
 666                     country daytime night fax );
 667     }
 668   }
 669
 670   $self->payby =~ /^(CARD|CHEK|LECB|BILL|COMP|PREPAY)$/
 671     or return "Illegal payby: ". $self->payby;
 672   $self->payby($1);
 673
 674   if ( $self->payby eq 'CARD' ) {
 675
 676     my $payinfo = $self->payinfo;
 677     $payinfo =~ s/\D//g;
 678     $payinfo =~ /^(\d{13,16})$/
 679       or return gettext('invalid_card'); # . ": ". $self->payinfo;
 680     $payinfo = $1;
 681     $self->payinfo($payinfo);
 682     validate($payinfo)
 683       or return gettext('invalid_card'); # . ": ". $self->payinfo;
 684     return gettext('unknown_card_type')
 685       if cardtype($self->payinfo) eq "Unknown";
 686
 687   } elsif ( $self->payby eq 'CHEK' ) {
 688
 689     my $payinfo = $self->payinfo;
 690     $payinfo =~ s/[^\d\@]//g;
 691     $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
 692     $payinfo = "$1\@$2";
 693     $self->payinfo($payinfo);
 694
 695   } elsif ( $self->payby eq 'LECB' ) {
 696
 697     my $payinfo = $self->payinfo;
 698     $payinfo =~ s/\D//g;
 699     $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
 700     $payinfo = $1;
 701     $self->payinfo($payinfo);
 702
 703   } elsif ( $self->payby eq 'BILL' ) {
 704
 705     $error = $self->ut_textn('payinfo');
 706     return "Illegal P.O. number: ". $self->payinfo if $error;
 707
 708   } elsif ( $self->payby eq 'COMP' ) {
 709
 710     $error = $self->ut_textn('payinfo');
 711     return "Illegal comp account issuer: ". $self->payinfo if $error;
 712
 713   } elsif ( $self->payby eq 'PREPAY' ) {
 714
 715     my $payinfo = $self->payinfo;
 716     $payinfo =~ s/\W//g; #anything else would just confuse things
 717     $self->payinfo($payinfo);
 718     $error = $self->ut_alpha('payinfo');
 719     return "Illegal prepayment identifier: ". $self->payinfo if $error;
 720     return "Unknown prepayment identifier"
 721       unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
 722
 723   }
 724
 725   if ( $self->paydate eq '' || $self->paydate eq '-' ) {
 726     return "Expriation date required"
 727       unless $self->payby =~ /^(BILL|PREPAY|CHEK|LECB)$/;
 728     $self->paydate('');
 729   } else {
 730     $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/
 731       or return "Illegal expiration date: ". $self->paydate;
 732     my $y = length($2) == 4 ? $2 : "20$2";
 733     $self->paydate("$y-$1-01");
 734     my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
 735     return gettext('expired_card')
 736       if !$import && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
 737   }
 738
 739   if ( $self->payname eq '' && $self->payby ne 'CHEK' &&
 740        ( ! $conf->exists('require_cardname') || $self->payby ne 'CARD' ) ) {
 741     $self->payname( $self->first. " ". $self->getfield('last') );
 742   } else {
 743     $self->payname =~ /^([\w \,\.\-\']+)$/
 744       or return gettext('illegal_name'). " payname: ". $self->payname;
 745     $self->payname($1);
 746   }
 747
 748   $self->tax =~ /^(Y?)$/ or return "Illegal tax: ". $self->tax;
 749   $self->tax($1);
 750
 751   $self->otaker(getotaker);
 752
 753   #warn "AFTER: \n". $self->_dump;
 754
 755   ''; #no error
 756 }
 757
 758 =item all_pkgs
 759
 760 Returns all packages (see L<FS::cust_pkg>) for this customer.
 761
 762 =cut
 763
 764 sub all_pkgs {
 765   my $self = shift;
 766   if ( $self->{'_pkgnum'} ) {
 767     values %{ $self->{'_pkgnum'}->cache };
 768   } else {
 769     qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
 770   }
 771 }
 772
 773 =item ncancelled_pkgs
 774
 775 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
 776
 777 =cut
 778
 779 sub ncancelled_pkgs {
 780   my $self = shift;
 781   if ( $self->{'_pkgnum'} ) {
 782     grep { ! $_->getfield('cancel') } values %{ $self->{'_pkgnum'}->cache };
 783   } else {
 784     @{ [ # force list context
 785       qsearch( 'cust_pkg', {
 786         'custnum' => $self->custnum,
 787         'cancel'  => '',
 788       }),
 789       qsearch( 'cust_pkg', {
 790         'custnum' => $self->custnum,
 791         'cancel'  => 0,
 792       }),
 793     ] };
 794   }
 795 }
 796
 797 =item suspended_pkgs
 798
 799 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
 800
 801 =cut
 802
 803 sub suspended_pkgs {
 804   my $self = shift;
 805   grep { $_->susp } $self->ncancelled_pkgs;
 806 }
 807
 808 =item unflagged_suspended_pkgs
 809
 810 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
 811 customer (thouse packages without the `manual_flag' set).
 812
 813 =cut
 814
 815 sub unflagged_suspended_pkgs {
 816   my $self = shift;
 817   return $self->suspended_pkgs
 818     unless dbdef->table('cust_pkg')->column('manual_flag');
 819   grep { ! $_->manual_flag } $self->suspended_pkgs;
 820 }
 821
 822 =item unsuspended_pkgs
 823
 824 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
 825 this customer.
 826
 827 =cut
 828
 829 sub unsuspended_pkgs {
 830   my $self = shift;
 831   grep { ! $_->susp } $self->ncancelled_pkgs;
 832 }
 833
 834 =item unsuspend
 835
 836 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
 837 and L<FS::cust_pkg>) for this customer.  Always returns a list: an empty list
 838 on success or a list of errors.
 839
 840 =cut
 841
 842 sub unsuspend {
 843   my $self = shift;
 844   grep { $_->unsuspend } $self->suspended_pkgs;
 845 }
 846
 847 =item suspend
 848
 849 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
 850 Always returns a list: an empty list on success or a list of errors.
 851
 852 =cut
 853
 854 sub suspend {
 855   my $self = shift;
 856   grep { $_->suspend } $self->unsuspended_pkgs;
 857 }
 858
 859 =item cancel
 860
 861 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
 862 Always returns a list: an empty list on success or a list of errors.
 863
 864 =cut
 865
 866 sub cancel {
 867   my $self = shift;
 868   grep { $_->cancel } $self->ncancelled_pkgs;
 869 }
 870
 871 =item agent
 872
 873 Returns the agent (see L<FS::agent>) for this customer.
 874
 875 =cut
 876
 877 sub agent {
 878   my $self = shift;
 879   qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
 880 }
 881
 882 =item bill OPTIONS
 883
 884 Generates invoices (see L<FS::cust_bill>) for this customer.  Usually used in
 885 conjunction with the collect method.
 886
 887 Options are passed as name-value pairs.
 888
 889 The only currently available option is `time', which bills the customer as if
 890 it were that time.  It is specified as a UNIX timestamp; see
 891 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
 892 functions.  For example:
 893
 894  use Date::Parse;
 895  ...
 896  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
 897
 898 If there is an error, returns the error, otherwise returns false.
 899
 900 =cut
 901
 902 sub bill {
 903   my( $self, %options ) = @_;
 904   my $time = $options{'time'} || time;
 905
 906   my $error;
 907
 908   #put below somehow?
 909   local $SIG{HUP} = 'IGNORE';
 910   local $SIG{INT} = 'IGNORE';
 911   local $SIG{QUIT} = 'IGNORE';
 912   local $SIG{TERM} = 'IGNORE';
 913   local $SIG{TSTP} = 'IGNORE';
 914   local $SIG{PIPE} = 'IGNORE';
 915
 916   my $oldAutoCommit = $FS::UID::AutoCommit;
 917   local $FS::UID::AutoCommit = 0;
 918   my $dbh = dbh;
 919
 920   # find the packages which are due for billing, find out how much they are
 921   # & generate invoice database.
 922
 923   my( $total_setup, $total_recur ) = ( 0, 0 );
 924   #my( $taxable_setup, $taxable_recur ) = ( 0, 0 );
 925   my @cust_bill_pkg = ();
 926   #my $tax = 0;##
 927   #my $taxable_charged = 0;##
 928   #my $charged = 0;##
 929
 930   my %tax;
 931
 932   foreach my $cust_pkg (
 933     qsearch('cust_pkg', { 'custnum' => $self->custnum } )
 934   ) {
 935
 936     #NO!! next if $cust_pkg->cancel;
 937     next if $cust_pkg->getfield('cancel');
 938
 939     #? to avoid use of uninitialized value errors... ?
 940     $cust_pkg->setfield('bill', '')
 941       unless defined($cust_pkg->bill);
 942
 943     my $part_pkg = $cust_pkg->part_pkg;
 944
 945     #so we don't modify cust_pkg record unnecessarily
 946     my $cust_pkg_mod_flag = 0;
 947     my %hash = $cust_pkg->hash;
 948     my $old_cust_pkg = new FS::cust_pkg \%hash;
 949
 950     # bill setup
 951     my $setup = 0;
 952     unless ( $cust_pkg->setup ) {
 953       my $setup_prog = $part_pkg->getfield('setup');
 954       $setup_prog =~ /^(.*)$/ or do {
 955         $dbh->rollback if $oldAutoCommit;
 956         return "Illegal setup for pkgpart ". $part_pkg->pkgpart.
 957                ": $setup_prog";
 958       };
 959       $setup_prog = $1;
 960
 961         #my $cpt = new Safe;
 962         ##$cpt->permit(); #what is necessary?
 963         #$cpt->share(qw( $cust_pkg )); #can $cpt now use $cust_pkg methods?
 964         #$setup = $cpt->reval($setup_prog);
 965       $setup = eval $setup_prog;
 966       unless ( defined($setup) ) {
 967         $dbh->rollback if $oldAutoCommit;
 968         return "Error eval-ing part_pkg->setup pkgpart ". $part_pkg->pkgpart.
 969                "(expression $setup_prog): $@";
 970       }
 971       $cust_pkg->setfield('setup',$time);
 972       $cust_pkg_mod_flag=1;
 973     }
 974
 975     #bill recurring fee
 976     my $recur = 0;
 977     my $sdate;
 978     if ( $part_pkg->getfield('freq') > 0 &&
 979          ! $cust_pkg->getfield('susp') &&
 980          ( $cust_pkg->getfield('bill') || 0 ) < $time
 981     ) {
 982       my $recur_prog = $part_pkg->getfield('recur');
 983       $recur_prog =~ /^(.*)$/ or do {
 984         $dbh->rollback if $oldAutoCommit;
 985         return "Illegal recur for pkgpart ". $part_pkg->pkgpart.
 986                ": $recur_prog";
 987       };
 988       $recur_prog = $1;
 989
 990       # shared with $recur_prog
 991       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
 992
 993         #my $cpt = new Safe;
 994         ##$cpt->permit(); #what is necessary?
 995         #$cpt->share(qw( $cust_pkg )); #can $cpt now use $cust_pkg methods?
 996         #$recur = $cpt->reval($recur_prog);
 997       $recur = eval $recur_prog;
 998       unless ( defined($recur) ) {
 999         $dbh->rollback if $oldAutoCommit;
1000         return "Error eval-ing part_pkg->recur pkgpart ".  $part_pkg->pkgpart.
1001                "(expression $recur_prog): $@";
1002       }
1003       #change this bit to use Date::Manip? CAREFUL with timezones (see
1004       # mailing list archive)
1005       my ($sec,$min,$hour,$mday,$mon,$year) =
1006         (localtime($sdate) )[0,1,2,3,4,5];
1007
1008       #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
1009       # only for figuring next bill date, nothing else, so, reset $sdate again
1010       # here
1011       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1012
1013       $mon += $part_pkg->freq;
1014       until ( $mon < 12 ) { $mon -= 12; $year++; }
1015       $cust_pkg->setfield('bill',
1016         timelocal($sec,$min,$hour,$mday,$mon,$year));
1017       $cust_pkg_mod_flag = 1;
1018     }
1019
1020     warn "\$setup is undefined" unless defined($setup);
1021     warn "\$recur is undefined" unless defined($recur);
1022     warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1023
1024     my $taxable_charged = 0;
1025     if ( $cust_pkg_mod_flag ) {
1026       $error=$cust_pkg->replace($old_cust_pkg);
1027       if ( $error ) { #just in case
1028         $dbh->rollback if $oldAutoCommit;
1029         return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
1030       }
1031       $setup = sprintf( "%.2f", $setup );
1032       $recur = sprintf( "%.2f", $recur );
1033       if ( $setup < 0 ) {
1034         $dbh->rollback if $oldAutoCommit;
1035         return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1036       }
1037       if ( $recur < 0 ) {
1038         $dbh->rollback if $oldAutoCommit;
1039         return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1040       }
1041       if ( $setup > 0 || $recur > 0 ) {
1042         my $cust_bill_pkg = new FS::cust_bill_pkg ({
1043           'pkgnum' => $cust_pkg->pkgnum,
1044           'setup'  => $setup,
1045           'recur'  => $recur,
1046           'sdate'  => $sdate,
1047           'edate'  => $cust_pkg->bill,
1048         });
1049         push @cust_bill_pkg, $cust_bill_pkg;
1050         $total_setup += $setup;
1051         $total_recur += $recur;
1052         $taxable_charged += $setup
1053           unless $part_pkg->setuptax =~ /^Y$/i;
1054         $taxable_charged += $recur
1055           unless $part_pkg->recurtax =~ /^Y$/i;
1056
1057         unless ( $self->tax =~ /Y/i
1058                  || $self->payby eq 'COMP'
1059                  || $taxable_charged == 0 ) {
1060
1061           my $cust_main_county = qsearchs('cust_main_county',{
1062               'state'    => $self->state,
1063               'county'   => $self->county,
1064               'country'  => $self->country,
1065               'taxclass' => $part_pkg->taxclass,
1066           } );
1067           $cust_main_county ||= qsearchs('cust_main_county',{
1068               'state'    => $self->state,
1069               'county'   => $self->county,
1070               'country'  => $self->country,
1071               'taxclass' => '',
1072           } );
1073           unless ( $cust_main_county ) {
1074             $dbh->rollback if $oldAutoCommit;
1075             return
1076               "fatal: can't find tax rate for state/county/country/taxclass ".
1077               join('/', ( map $self->$_(), qw(state county country) ),
1078                         $part_pkg->taxclass ).  "\n";
1079           }
1080
1081           if ( $cust_main_county->exempt_amount ) {
1082             my ($mon,$year) = (localtime($sdate) )[4,5];
1083             $mon++;
1084             my $freq = $part_pkg->freq || 1;
1085             my $taxable_per_month = sprintf("%.2f", $taxable_charged / $freq );
1086             foreach my $which_month ( 1 .. $freq ) {
1087               my %hash = (
1088                 'custnum' => $self->custnum,
1089                 'taxnum'  => $cust_main_county->taxnum,
1090                 'year'    => 1900+$year,
1091                 'month'   => $mon++,
1092               );
1093               #until ( $mon < 12 ) { $mon -= 12; $year++; }
1094               until ( $mon < 13 ) { $mon -= 12; $year++; }
1095               my $cust_tax_exempt =
1096                 qsearchs('cust_tax_exempt', \%hash)
1097                 || new FS::cust_tax_exempt( { %hash, 'amount' => 0 } );
1098               my $remaining_exemption = sprintf("%.2f",
1099                 $cust_main_county->exempt_amount - $cust_tax_exempt->amount );
1100               if ( $remaining_exemption > 0 ) {
1101                 my $addl = $remaining_exemption > $taxable_per_month
1102                   ? $taxable_per_month
1103                   : $remaining_exemption;
1104                 $taxable_charged -= $addl;
1105                 my $new_cust_tax_exempt = new FS::cust_tax_exempt ( {
1106                   $cust_tax_exempt->hash,
1107                   'amount' => sprintf("%.2f", $cust_tax_exempt->amount + $addl),
1108                 } );
1109                 $error = $new_cust_tax_exempt->exemptnum
1110                   ? $new_cust_tax_exempt->replace($cust_tax_exempt)
1111                   : $new_cust_tax_exempt->insert;
1112                 if ( $error ) {
1113                   $dbh->rollback if $oldAutoCommit;
1114                   return "fatal: can't update cust_tax_exempt: $error";
1115                 }
1116
1117               } # if $remaining_exemption > 0
1118
1119             } #foreach $which_month
1120
1121           } #if $cust_main_county->exempt_amount
1122
1123           $taxable_charged = sprintf( "%.2f", $taxable_charged);
1124
1125           #$tax += $taxable_charged * $cust_main_county->tax / 100
1126           $tax{ $cust_main_county->taxname || 'Tax' } +=
1127             $taxable_charged * $cust_main_county->tax / 100
1128
1129         } #unless $self->tax =~ /Y/i
1130           #       || $self->payby eq 'COMP'
1131           #       || $taxable_charged == 0
1132
1133       } #if $setup > 0 || $recur > 0
1134
1135     } #if $cust_pkg_mod_flag
1136
1137   } #foreach my $cust_pkg
1138
1139   my $charged = sprintf( "%.2f", $total_setup + $total_recur );
1140 #  my $taxable_charged = sprintf( "%.2f", $taxable_setup + $taxable_recur );
1141
1142   unless ( @cust_bill_pkg ) { #don't create invoices with no line items
1143     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1144     return '';
1145   }
1146
1147 #  unless ( $self->tax =~ /Y/i
1148 #           || $self->payby eq 'COMP'
1149 #           || $taxable_charged == 0 ) {
1150 #    my $cust_main_county = qsearchs('cust_main_county',{
1151 #        'state'   => $self->state,
1152 #        'county'  => $self->county,
1153 #        'country' => $self->country,
1154 #    } ) or die "fatal: can't find tax rate for state/county/country ".
1155 #               $self->state. "/". $self->county. "/". $self->country. "\n";
1156 #    my $tax = sprintf( "%.2f",
1157 #      $taxable_charged * ( $cust_main_county->getfield('tax') / 100 )
1158 #    );
1159
1160   foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
1161     my $tax = sprintf("%.2f", $tax{$taxname} );
1162     $charged = sprintf( "%.2f", $charged+$tax );
1163
1164     my $cust_bill_pkg = new FS::cust_bill_pkg ({
1165       'pkgnum'   => 0,
1166       'setup'    => $tax,
1167       'recur'    => 0,
1168       'sdate'    => '',
1169       'edate'    => '',
1170       'itemdesc' => $taxname,
1171     });
1172     push @cust_bill_pkg, $cust_bill_pkg;
1173   }
1174 #  }
1175
1176   my $cust_bill = new FS::cust_bill ( {
1177     'custnum' => $self->custnum,
1178     '_date'   => $time,
1179     'charged' => $charged,
1180   } );
1181   $error = $cust_bill->insert;
1182   if ( $error ) {
1183     $dbh->rollback if $oldAutoCommit;
1184     return "can't create invoice for customer #". $self->custnum. ": $error";
1185   }
1186
1187   my $invnum = $cust_bill->invnum;
1188   my $cust_bill_pkg;
1189   foreach $cust_bill_pkg ( @cust_bill_pkg ) {
1190     #warn $invnum;
1191     $cust_bill_pkg->invnum($invnum);
1192     $error = $cust_bill_pkg->insert;
1193     if ( $error ) {
1194       $dbh->rollback if $oldAutoCommit;
1195       return "can't create invoice line item for customer #". $self->custnum.
1196              ": $error";
1197     }
1198   }
1199
1200   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1201   ''; #no error
1202 }
1203
1204 =item collect OPTIONS
1205
1206 (Attempt to) collect money for this customer's outstanding invoices (see
1207 L<FS::cust_bill>).  Usually used after the bill method.
1208
1209 Depending on the value of `payby', this may print an invoice (`BILL'), charge
1210 a credit card (`CARD'), or just add any necessary (pseudo-)payment (`COMP').
1211
1212 Most actions are now triggered by invoice events; see L<FS::part_bill_event>
1213 and the invoice events web interface.
1214
1215 If there is an error, returns the error, otherwise returns false.
1216
1217 Options are passed as name-value pairs.
1218
1219 Currently available options are:
1220
1221 invoice_time - Use this time when deciding when to print invoices and
1222 late notices on those invoices.  The default is now.  It is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse>
1223 for conversion functions.
1224
1225 retry_card - Retry cards even when not scheduled by invoice events.
1226
1227 batch_card - This option is deprecated.  See the invoice events web interface
1228 to control whether cards are batched or run against a realtime gateway.
1229
1230 report_badcard - This option is deprecated.
1231
1232 force_print - This option is deprecated; see the invoice events web interface.
1233
1234 =cut
1235
1236 sub collect {
1237   my( $self, %options ) = @_;
1238   my $invoice_time = $options{'invoice_time'} || time;
1239
1240   #put below somehow?
1241   local $SIG{HUP} = 'IGNORE';
1242   local $SIG{INT} = 'IGNORE';
1243   local $SIG{QUIT} = 'IGNORE';
1244   local $SIG{TERM} = 'IGNORE';
1245   local $SIG{TSTP} = 'IGNORE';
1246   local $SIG{PIPE} = 'IGNORE';
1247
1248   my $oldAutoCommit = $FS::UID::AutoCommit;
1249   local $FS::UID::AutoCommit = 0;
1250   my $dbh = dbh;
1251
1252   my $balance = $self->balance;
1253   warn "collect customer". $self->custnum. ": balance $balance" if $Debug;
1254   unless ( $balance > 0 ) { #redundant?????
1255     $dbh->rollback if $oldAutoCommit; #hmm
1256     return '';
1257   }
1258
1259   if ( exists($options{'retry_card'}) && $options{'retry_card'} ) {
1260     #false laziness w/replace
1261     foreach my $cust_bill_event (
1262       grep {
1263              #$_->part_bill_event->plan eq 'realtime-card'
1264              $_->part_bill_event->eventcode eq '$cust_bill->realtime_card();'
1265                && $_->status eq 'done'
1266                && $_->statustext
1267            }
1268         map { $_->cust_bill_event }
1269           grep { $_->cust_bill_event }
1270             $self->open_cust_bill
1271     ) {
1272       my $error = $cust_bill_event->retry;
1273       if ( $error ) {
1274         $dbh->rollback if $oldAutoCommit;
1275         return "error scheduling invoice events for retry: $error";
1276       }
1277     }
1278     #eslaf
1279   }
1280
1281   foreach my $cust_bill ( $self->cust_bill ) {
1282
1283     #this has to be before next's
1284     my $amount = sprintf( "%.2f", $balance < $cust_bill->owed
1285                                   ? $balance
1286                                   : $cust_bill->owed
1287     );
1288     $balance = sprintf( "%.2f", $balance - $amount );
1289
1290     next unless $cust_bill->owed > 0;
1291
1292     # don't try to charge for the same invoice if it's already in a batch
1293     #next if qsearchs( 'cust_pay_batch', { 'invnum' => $cust_bill->invnum } );
1294
1295     warn "invnum ". $cust_bill->invnum. " (owed ". $cust_bill->owed. ", amount $amount, balance $balance)" if $Debug;
1296
1297     next unless $amount > 0;
1298
1299
1300     foreach my $part_bill_event (
1301       sort {    $a->seconds   <=> $b->seconds
1302              || $a->weight    <=> $b->weight
1303              || $a->eventpart <=> $b->eventpart }
1304         grep { $_->seconds <= ( $invoice_time - $cust_bill->_date )
1305                && ! qsearchs( 'cust_bill_event', {
1306                                 'invnum'    => $cust_bill->invnum,
1307                                 'eventpart' => $_->eventpart,
1308                                 'status'    => 'done',
1309                                                                    } )
1310              }
1311           qsearch('part_bill_event', { 'payby'    => $self->payby,
1312                                        'disabled' => '',           } )
1313     ) {
1314
1315       last unless $cust_bill->owed > 0; #don't run subsequent events if owed=0
1316
1317       warn "calling invoice event (". $part_bill_event->eventcode. ")\n"
1318         if $Debug;
1319       my $cust_main = $self; #for callback
1320       my $error = eval $part_bill_event->eventcode;
1321
1322       my $status = '';
1323       my $statustext = '';
1324       if ( $@ ) {
1325         $status = 'failed';
1326         $statustext = $@;
1327       } elsif ( $error ) {
1328         $status = 'done';
1329         $statustext = $error;
1330       } else {
1331         $status = 'done'
1332       }
1333
1334       #add cust_bill_event
1335       my $cust_bill_event = new FS::cust_bill_event {
1336         'invnum'     => $cust_bill->invnum,
1337         'eventpart'  => $part_bill_event->eventpart,
1338         '_date'      => $invoice_time,
1339         'status'     => $status,
1340         'statustext' => $statustext,
1341       };
1342       $error = $cust_bill_event->insert;
1343       if ( $error ) {
1344         #$dbh->rollback if $oldAutoCommit;
1345         #return "error: $error";
1346
1347         # gah, even with transactions.
1348         $dbh->commit if $oldAutoCommit; #well.
1349         my $e = 'WARNING: Event run but database not updated - '.
1350                 'error inserting cust_bill_event, invnum #'. $cust_bill->invnum.
1351                 ', eventpart '. $part_bill_event->eventpart.
1352                 ": $error";
1353         warn $e;
1354         return $e;
1355       }
1356
1357
1358     }
1359
1360   }
1361
1362   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1363   '';
1364
1365 }
1366
1367 =item total_owed
1368
1369 Returns the total owed for this customer on all invoices
1370 (see L<FS::cust_bill/owed>).
1371
1372 =cut
1373
1374 sub total_owed {
1375   my $self = shift;
1376   $self->total_owed_date(2145859200); #12/31/2037
1377 }
1378
1379 =item total_owed_date TIME
1380
1381 Returns the total owed for this customer on all invoices with date earlier than
1382 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
1383 see L<Time::Local> and L<Date::Parse> for conversion functions.
1384
1385 =cut
1386
1387 sub total_owed_date {
1388   my $self = shift;
1389   my $time = shift;
1390   my $total_bill = 0;
1391   foreach my $cust_bill (
1392     grep { $_->_date <= $time }
1393       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
1394   ) {
1395     $total_bill += $cust_bill->owed;
1396   }
1397   sprintf( "%.2f", $total_bill );
1398 }
1399
1400 =item apply_credits
1401
1402 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1403 to outstanding invoice balances in chronological order and returns the value
1404 of any remaining unapplied credits available for refund
1405 (see L<FS::cust_refund>).
1406
1407 =cut
1408
1409 sub apply_credits {
1410   my $self = shift;
1411
1412   return 0 unless $self->total_credited;
1413
1414   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1415       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1416
1417   my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
1418       qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
1419
1420   my $credit;
1421
1422   foreach my $cust_bill ( @invoices ) {
1423     my $amount;
1424
1425     if ( !defined($credit) || $credit->credited == 0) {
1426       $credit = pop @credits or last;
1427     }
1428
1429     if ($cust_bill->owed >= $credit->credited) {
1430       $amount=$credit->credited;
1431     }else{
1432       $amount=$cust_bill->owed;
1433     }
1434
1435     my $cust_credit_bill = new FS::cust_credit_bill ( {
1436       'crednum' => $credit->crednum,
1437       'invnum'  => $cust_bill->invnum,
1438       'amount'  => $amount,
1439     } );
1440     my $error = $cust_credit_bill->insert;
1441     die $error if $error;
1442
1443     redo if ($cust_bill->owed > 0);
1444
1445   }
1446
1447   return $self->total_credited;
1448 }
1449
1450 =item apply_payments
1451
1452 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
1453 to outstanding invoice balances in chronological order.
1454
1455  #and returns the value of any remaining unapplied payments.
1456
1457 =cut
1458
1459 sub apply_payments {
1460   my $self = shift;
1461
1462   #return 0 unless
1463
1464   my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
1465       qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
1466
1467   my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
1468       qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
1469
1470   my $payment;
1471
1472   foreach my $cust_bill ( @invoices ) {
1473     my $amount;
1474
1475     if ( !defined($payment) || $payment->unapplied == 0 ) {
1476       $payment = pop @payments or last;
1477     }
1478
1479     if ( $cust_bill->owed >= $payment->unapplied ) {
1480       $amount = $payment->unapplied;
1481     } else {
1482       $amount = $cust_bill->owed;
1483     }
1484
1485     my $cust_bill_pay = new FS::cust_bill_pay ( {
1486       'paynum' => $payment->paynum,
1487       'invnum' => $cust_bill->invnum,
1488       'amount' => $amount,
1489     } );
1490     my $error = $cust_bill_pay->insert;
1491     die $error if $error;
1492
1493     redo if ( $cust_bill->owed > 0);
1494
1495   }
1496
1497   return $self->total_unapplied_payments;
1498 }
1499
1500 =item total_credited
1501
1502 Returns the total outstanding credit (see L<FS::cust_credit>) for this
1503 customer.  See L<FS::cust_credit/credited>.
1504
1505 =cut
1506
1507 sub total_credited {
1508   my $self = shift;
1509   my $total_credit = 0;
1510   foreach my $cust_credit ( qsearch('cust_credit', {
1511     'custnum' => $self->custnum,
1512   } ) ) {
1513     $total_credit += $cust_credit->credited;
1514   }
1515   sprintf( "%.2f", $total_credit );
1516 }
1517
1518 =item total_unapplied_payments
1519
1520 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
1521 See L<FS::cust_pay/unapplied>.
1522
1523 =cut
1524
1525 sub total_unapplied_payments {
1526   my $self = shift;
1527   my $total_unapplied = 0;
1528   foreach my $cust_pay ( qsearch('cust_pay', {
1529     'custnum' => $self->custnum,
1530   } ) ) {
1531     $total_unapplied += $cust_pay->unapplied;
1532   }
1533   sprintf( "%.2f", $total_unapplied );
1534 }
1535
1536 =item balance
1537
1538 Returns the balance for this customer (total_owed minus total_credited
1539 minus total_unapplied_payments).
1540
1541 =cut
1542
1543 sub balance {
1544   my $self = shift;
1545   sprintf( "%.2f",
1546     $self->total_owed - $self->total_credited - $self->total_unapplied_payments
1547   );
1548 }
1549
1550 =item balance_date TIME
1551
1552 Returns the balance for this customer, only considering invoices with date
1553 earlier than TIME (total_owed_date minus total_credited minus
1554 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
1555 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
1556 functions.
1557
1558 =cut
1559
1560 sub balance_date {
1561   my $self = shift;
1562   my $time = shift;
1563   sprintf( "%.2f",
1564     $self->total_owed_date($time)
1565       - $self->total_credited
1566       - $self->total_unapplied_payments
1567   );
1568 }
1569
1570 =item invoicing_list [ ARRAYREF ]
1571
1572 If an arguement is given, sets these email addresses as invoice recipients
1573 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
1574 (except as warnings), so use check_invoicing_list first.
1575
1576 Returns a list of email addresses (with svcnum entries expanded).
1577
1578 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
1579 check it without disturbing anything by passing nothing.
1580
1581 This interface may change in the future.
1582
1583 =cut
1584
1585 sub invoicing_list {
1586   my( $self, $arrayref ) = @_;
1587   if ( $arrayref ) {
1588     my @cust_main_invoice;
1589     if ( $self->custnum ) {
1590       @cust_main_invoice =
1591         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
1592     } else {
1593       @cust_main_invoice = ();
1594     }
1595     foreach my $cust_main_invoice ( @cust_main_invoice ) {
1596       #warn $cust_main_invoice->destnum;
1597       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
1598         #warn $cust_main_invoice->destnum;
1599         my $error = $cust_main_invoice->delete;
1600         warn $error if $error;
1601       }
1602     }
1603     if ( $self->custnum ) {
1604       @cust_main_invoice =
1605         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
1606     } else {
1607       @cust_main_invoice = ();
1608     }
1609     my %seen = map { $_->address => 1 } @cust_main_invoice;
1610     foreach my $address ( @{$arrayref} ) {
1611       next if exists $seen{$address} && $seen{$address};
1612       $seen{$address} = 1;
1613       my $cust_main_invoice = new FS::cust_main_invoice ( {
1614         'custnum' => $self->custnum,
1615         'dest'    => $address,
1616       } );
1617       my $error = $cust_main_invoice->insert;
1618       warn $error if $error;
1619     }
1620   }
1621   if ( $self->custnum ) {
1622     map { $_->address }
1623       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
1624   } else {
1625     ();
1626   }
1627 }
1628
1629 =item check_invoicing_list ARRAYREF
1630
1631 Checks these arguements as valid input for the invoicing_list method.  If there
1632 is an error, returns the error, otherwise returns false.
1633
1634 =cut
1635
1636 sub check_invoicing_list {
1637   my( $self, $arrayref ) = @_;
1638   foreach my $address ( @{$arrayref} ) {
1639     my $cust_main_invoice = new FS::cust_main_invoice ( {
1640       'custnum' => $self->custnum,
1641       'dest'    => $address,
1642     } );
1643     my $error = $self->custnum
1644                 ? $cust_main_invoice->check
1645                 : $cust_main_invoice->checkdest
1646     ;
1647     return $error if $error;
1648   }
1649   '';
1650 }
1651
1652 =item set_default_invoicing_list
1653
1654 Sets the invoicing list to all accounts associated with this customer,
1655 overwriting any previous invoicing list.
1656
1657 =cut
1658
1659 sub set_default_invoicing_list {
1660   my $self = shift;
1661   $self->invoicing_list($self->all_emails);
1662 }
1663
1664 =item all_emails
1665
1666 Returns the email addresses of all accounts provisioned for this customer.
1667
1668 =cut
1669
1670 sub all_emails {
1671   my $self = shift;
1672   my %list;
1673   foreach my $cust_pkg ( $self->all_pkgs ) {
1674     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
1675     my @svc_acct =
1676       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
1677         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
1678           @cust_svc;
1679     $list{$_}=1 foreach map { $_->email } @svc_acct;
1680   }
1681   keys %list;
1682 }
1683
1684 =item invoicing_list_addpost
1685
1686 Adds postal invoicing to this customer.  If this customer is already configured
1687 to receive postal invoices, does nothing.
1688
1689 =cut
1690
1691 sub invoicing_list_addpost {
1692   my $self = shift;
1693   return if grep { $_ eq 'POST' } $self->invoicing_list;
1694   my @invoicing_list = $self->invoicing_list;
1695   push @invoicing_list, 'POST';
1696   $self->invoicing_list(\@invoicing_list);
1697 }
1698
1699 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
1700
1701 Returns an array of customers referred by this customer (referral_custnum set
1702 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
1703 customers referred by customers referred by this customer and so on, inclusive.
1704 The default behavior is DEPTH 1 (no recursion).
1705
1706 =cut
1707
1708 sub referral_cust_main {
1709   my $self = shift;
1710   my $depth = @_ ? shift : 1;
1711   my $exclude = @_ ? shift : {};
1712
1713   my @cust_main =
1714     map { $exclude->{$_->custnum}++; $_; }
1715       grep { ! $exclude->{ $_->custnum } }
1716         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
1717
1718   if ( $depth > 1 ) {
1719     push @cust_main,
1720       map { $_->referral_cust_main($depth-1, $exclude) }
1721         @cust_main;
1722   }
1723
1724   @cust_main;
1725 }
1726
1727 =item referral_cust_main_ncancelled
1728
1729 Same as referral_cust_main, except only returns customers with uncancelled
1730 packages.
1731
1732 =cut
1733
1734 sub referral_cust_main_ncancelled {
1735   my $self = shift;
1736   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
1737 }
1738
1739 =item referral_cust_pkg [ DEPTH ]
1740
1741 Like referral_cust_main, except returns a flat list of all unsuspended (and
1742 uncancelled) packages for each customer.  The number of items in this list may
1743 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
1744
1745 =cut
1746
1747 sub referral_cust_pkg {
1748   my $self = shift;
1749   my $depth = @_ ? shift : 1;
1750
1751   map { $_->unsuspended_pkgs }
1752     grep { $_->unsuspended_pkgs }
1753       $self->referral_cust_main($depth);
1754 }
1755
1756 =item credit AMOUNT, REASON
1757
1758 Applies a credit to this customer.  If there is an error, returns the error,
1759 otherwise returns false.
1760
1761 =cut
1762
1763 sub credit {
1764   my( $self, $amount, $reason ) = @_;
1765   my $cust_credit = new FS::cust_credit {
1766     'custnum' => $self->custnum,
1767     'amount'  => $amount,
1768     'reason'  => $reason,
1769   };
1770   $cust_credit->insert;
1771 }
1772
1773 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
1774
1775 Creates a one-time charge for this customer.  If there is an error, returns
1776 the error, otherwise returns false.
1777
1778 =cut
1779
1780 sub charge {
1781   my ( $self, $amount ) = ( shift, shift );
1782   my $pkg      = @_ ? shift : 'One-time charge';
1783   my $comment  = @_ ? shift : '$'. sprintf("%.2f",$amount);
1784   my $taxclass = @_ ? shift : '';
1785
1786   local $SIG{HUP} = 'IGNORE';
1787   local $SIG{INT} = 'IGNORE';
1788   local $SIG{QUIT} = 'IGNORE';
1789   local $SIG{TERM} = 'IGNORE';
1790   local $SIG{TSTP} = 'IGNORE';
1791   local $SIG{PIPE} = 'IGNORE';
1792
1793   my $oldAutoCommit = $FS::UID::AutoCommit;
1794   local $FS::UID::AutoCommit = 0;
1795   my $dbh = dbh;
1796
1797   my $part_pkg = new FS::part_pkg ( {
1798     'pkg'      => $pkg,
1799     'comment'  => $comment,
1800     'setup'    => $amount,
1801     'freq'     => 0,
1802     'recur'    => '0',
1803     'disabled' => 'Y',
1804     'taxclass' => $taxclass,
1805   } );
1806
1807   my $error = $part_pkg->insert;
1808   if ( $error ) {
1809     $dbh->rollback if $oldAutoCommit;
1810     return $error;
1811   }
1812
1813   my $pkgpart = $part_pkg->pkgpart;
1814   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
1815   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
1816     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
1817     $error = $type_pkgs->insert;
1818     if ( $error ) {
1819       $dbh->rollback if $oldAutoCommit;
1820       return $error;
1821     }
1822   }
1823
1824   my $cust_pkg = new FS::cust_pkg ( {
1825     'custnum' => $self->custnum,
1826     'pkgpart' => $pkgpart,
1827   } );
1828
1829   $error = $cust_pkg->insert;
1830   if ( $error ) {
1831     $dbh->rollback if $oldAutoCommit;
1832     return $error;
1833   }
1834
1835   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1836   '';
1837
1838 }
1839
1840 =item cust_bill
1841
1842 Returns all the invoices (see L<FS::cust_bill>) for this customer.
1843
1844 =cut
1845
1846 sub cust_bill {
1847   my $self = shift;
1848   sort { $a->_date <=> $b->_date }
1849     qsearch('cust_bill', { 'custnum' => $self->custnum, } )
1850 }
1851
1852 =item open_cust_bill
1853
1854 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
1855 customer.
1856
1857 =cut
1858
1859 sub open_cust_bill {
1860   my $self = shift;
1861   grep { $_->owed > 0 } $self->cust_bill;
1862 }
1863
1864 =back
1865
1866 =head1 SUBROUTINES
1867
1868 =over 4
1869
1870 =item check_and_rebuild_fuzzyfiles
1871
1872 =cut
1873
1874 sub check_and_rebuild_fuzzyfiles {
1875   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1876   -e "$dir/cust_main.last" && -e "$dir/cust_main.company"
1877     or &rebuild_fuzzyfiles;
1878 }
1879
1880 =item rebuild_fuzzyfiles
1881
1882 =cut
1883
1884 sub rebuild_fuzzyfiles {
1885
1886   use Fcntl qw(:flock);
1887
1888   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1889
1890   #last
1891
1892   open(LASTLOCK,">>$dir/cust_main.last")
1893     or die "can't open $dir/cust_main.last: $!";
1894   flock(LASTLOCK,LOCK_EX)
1895     or die "can't lock $dir/cust_main.last: $!";
1896
1897   my @all_last = map $_->getfield('last'), qsearch('cust_main', {});
1898   push @all_last,
1899                  grep $_, map $_->getfield('ship_last'), qsearch('cust_main',{})
1900     if defined dbdef->table('cust_main')->column('ship_last');
1901
1902   open (LASTCACHE,">$dir/cust_main.last.tmp")
1903     or die "can't open $dir/cust_main.last.tmp: $!";
1904   print LASTCACHE join("\n", @all_last), "\n";
1905   close LASTCACHE or die "can't close $dir/cust_main.last.tmp: $!";
1906
1907   rename "$dir/cust_main.last.tmp", "$dir/cust_main.last";
1908   close LASTLOCK;
1909
1910   #company
1911
1912   open(COMPANYLOCK,">>$dir/cust_main.company")
1913     or die "can't open $dir/cust_main.company: $!";
1914   flock(COMPANYLOCK,LOCK_EX)
1915     or die "can't lock $dir/cust_main.company: $!";
1916
1917   my @all_company = grep $_ ne '', map $_->company, qsearch('cust_main',{});
1918   push @all_company,
1919        grep $_ ne '', map $_->ship_company, qsearch('cust_main', {})
1920     if defined dbdef->table('cust_main')->column('ship_last');
1921
1922   open (COMPANYCACHE,">$dir/cust_main.company.tmp")
1923     or die "can't open $dir/cust_main.company.tmp: $!";
1924   print COMPANYCACHE join("\n", @all_company), "\n";
1925   close COMPANYCACHE or die "can't close $dir/cust_main.company.tmp: $!";
1926
1927   rename "$dir/cust_main.company.tmp", "$dir/cust_main.company";
1928   close COMPANYLOCK;
1929
1930 }
1931
1932 =item all_last
1933
1934 =cut
1935
1936 sub all_last {
1937   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1938   open(LASTCACHE,"<$dir/cust_main.last")
1939     or die "can't open $dir/cust_main.last: $!";
1940   my @array = map { chomp; $_; } <LASTCACHE>;
1941   close LASTCACHE;
1942   \@array;
1943 }
1944
1945 =item all_company
1946
1947 =cut
1948
1949 sub all_company {
1950   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1951   open(COMPANYCACHE,"<$dir/cust_main.company")
1952     or die "can't open $dir/cust_main.last: $!";
1953   my @array = map { chomp; $_; } <COMPANYCACHE>;
1954   close COMPANYCACHE;
1955   \@array;
1956 }
1957
1958 =item append_fuzzyfiles LASTNAME COMPANY
1959
1960 =cut
1961
1962 sub append_fuzzyfiles {
1963   my( $last, $company ) = @_;
1964
1965   &check_and_rebuild_fuzzyfiles;
1966
1967   use Fcntl qw(:flock);
1968
1969   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1970
1971   if ( $last ) {
1972
1973     open(LAST,">>$dir/cust_main.last")
1974       or die "can't open $dir/cust_main.last: $!";
1975     flock(LAST,LOCK_EX)
1976       or die "can't lock $dir/cust_main.last: $!";
1977
1978     print LAST "$last\n";
1979
1980     flock(LAST,LOCK_UN)
1981       or die "can't unlock $dir/cust_main.last: $!";
1982     close LAST;
1983   }
1984
1985   if ( $company ) {
1986
1987     open(COMPANY,">>$dir/cust_main.company")
1988       or die "can't open $dir/cust_main.company: $!";
1989     flock(COMPANY,LOCK_EX)
1990       or die "can't lock $dir/cust_main.company: $!";
1991
1992     print COMPANY "$company\n";
1993
1994     flock(COMPANY,LOCK_UN)
1995       or die "can't unlock $dir/cust_main.company: $!";
1996
1997     close COMPANY;
1998   }
1999
2000   1;
2001 }
2002
2003 =item batch_import
2004
2005 =cut
2006
2007 sub batch_import {
2008   my $param = shift;
2009   #warn join('-',keys %$param);
2010   my $fh = $param->{filehandle};
2011   my $agentnum = $param->{agentnum};
2012   my $refnum = $param->{refnum};
2013   my $pkgpart = $param->{pkgpart};
2014   my @fields = @{$param->{fields}};
2015
2016   eval "use Date::Parse;";
2017   die $@ if $@;
2018   eval "use Text::CSV_XS;";
2019   die $@ if $@;
2020
2021   my $csv = new Text::CSV_XS;
2022   #warn $csv;
2023   #warn $fh;
2024
2025   my $imported = 0;
2026   #my $columns;
2027
2028   local $SIG{HUP} = 'IGNORE';
2029   local $SIG{INT} = 'IGNORE';
2030   local $SIG{QUIT} = 'IGNORE';
2031   local $SIG{TERM} = 'IGNORE';
2032   local $SIG{TSTP} = 'IGNORE';
2033   local $SIG{PIPE} = 'IGNORE';
2034
2035   my $oldAutoCommit = $FS::UID::AutoCommit;
2036   local $FS::UID::AutoCommit = 0;
2037   my $dbh = dbh;
2038
2039   #while ( $columns = $csv->getline($fh) ) {
2040   my $line;
2041   while ( defined($line=<$fh>) ) {
2042
2043     $csv->parse($line) or do {
2044       $dbh->rollback if $oldAutoCommit;
2045       return "can't parse: ". $csv->error_input();
2046     };
2047
2048     my @columns = $csv->fields();
2049     #warn join('-',@columns);
2050
2051     my %cust_main = (
2052       agentnum => $agentnum,
2053       refnum   => $refnum,
2054       country  => 'US', #default
2055       payby    => 'BILL', #default
2056       paydate  => '12/2037', #default
2057     );
2058     my $billtime = time;
2059     my %cust_pkg = ( pkgpart => $pkgpart );
2060     foreach my $field ( @fields ) {
2061       if ( $field =~ /^cust_pkg\.(setup|bill|susp|expire|cancel)$/ ) {
2062         #$cust_pkg{$1} = str2time( shift @$columns );
2063         if ( $1 eq 'setup' ) {
2064           $billtime = str2time(shift @columns);
2065         } else {
2066           $cust_pkg{$1} = str2time( shift @columns );
2067         }
2068       } else {
2069         #$cust_main{$field} = shift @$columns;
2070         $cust_main{$field} = shift @columns;
2071       }
2072     }
2073
2074     my $cust_pkg = new FS::cust_pkg ( \%cust_pkg ) if $pkgpart;
2075     my $cust_main = new FS::cust_main ( \%cust_main );
2076     use Tie::RefHash;
2077     tie my %hash, 'Tie::RefHash'; #this part is important
2078     $hash{$cust_pkg} = [] if $pkgpart;
2079     my $error = $cust_main->insert( \%hash );
2080
2081     if ( $error ) {
2082       $dbh->rollback if $oldAutoCommit;
2083       return "can't insert customer for $line: $error";
2084     }
2085
2086     #false laziness w/bill.cgi
2087     $error = $cust_main->bill( 'time' => $billtime );
2088     if ( $error ) {
2089       $dbh->rollback if $oldAutoCommit;
2090       return "can't bill customer for $line: $error";
2091     }
2092
2093     $cust_main->apply_payments;
2094     $cust_main->apply_credits;
2095
2096     $error = $cust_main->collect();
2097     if ( $error ) {
2098       $dbh->rollback if $oldAutoCommit;
2099       return "can't collect customer for $line: $error";
2100     }
2101
2102     $imported++;
2103   }
2104
2105   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2106
2107   return "Empty file!" unless $imported;
2108
2109   ''; #no error
2110
2111 }
2112
2113 =item batch_charge
2114
2115 =cut
2116
2117 sub batch_charge {
2118   my $param = shift;
2119   #warn join('-',keys %$param);
2120   my $fh = $param->{filehandle};
2121   my @fields = @{$param->{fields}};
2122
2123   eval "use Date::Parse;";
2124   die $@ if $@;
2125   eval "use Text::CSV_XS;";
2126   die $@ if $@;
2127
2128   my $csv = new Text::CSV_XS;
2129   #warn $csv;
2130   #warn $fh;
2131
2132   my $imported = 0;
2133   #my $columns;
2134
2135   local $SIG{HUP} = 'IGNORE';
2136   local $SIG{INT} = 'IGNORE';
2137   local $SIG{QUIT} = 'IGNORE';
2138   local $SIG{TERM} = 'IGNORE';
2139   local $SIG{TSTP} = 'IGNORE';
2140   local $SIG{PIPE} = 'IGNORE';
2141
2142   my $oldAutoCommit = $FS::UID::AutoCommit;
2143   local $FS::UID::AutoCommit = 0;
2144   my $dbh = dbh;
2145
2146   #while ( $columns = $csv->getline($fh) ) {
2147   my $line;
2148   while ( defined($line=<$fh>) ) {
2149
2150     $csv->parse($line) or do {
2151       $dbh->rollback if $oldAutoCommit;
2152       return "can't parse: ". $csv->error_input();
2153     };
2154
2155     my @columns = $csv->fields();
2156     #warn join('-',@columns);
2157
2158     my %row = ();
2159     foreach my $field ( @fields ) {
2160       $row{$field} = shift @columns;
2161     }
2162
2163     my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
2164     unless ( $cust_main ) {
2165       $dbh->rollback if $oldAutoCommit;
2166       return "unknown custnum $row{'custnum'}";
2167     }
2168
2169     if ( $row{'amount'} > 0 ) {
2170       my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
2171       if ( $error ) {
2172         $dbh->rollback if $oldAutoCommit;
2173         return $error;
2174       }
2175       $imported++;
2176     } elsif ( $row{'amount'} < 0 ) {
2177       my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
2178                                       $row{'pkg'}                         );
2179       if ( $error ) {
2180         $dbh->rollback if $oldAutoCommit;
2181         return $error;
2182       }
2183       $imported++;
2184     } else {
2185       #hmm?
2186     }
2187
2188   }
2189
2190   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2191
2192   return "Empty file!" unless $imported;
2193
2194   ''; #no error
2195
2196 }
2197
2198 =back
2199
2200 =head1 BUGS
2201
2202 The delete method.
2203
2204 The delete method should possibly take an FS::cust_main object reference
2205 instead of a scalar customer number.
2206
2207 Bill and collect options should probably be passed as references instead of a
2208 list.
2209
2210 There should probably be a configuration file with a list of allowed credit
2211 card types.
2212
2213 No multiple currency support (probably a larger project than just this module).
2214
2215 =head1 SEE ALSO
2216
2217 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
2218 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
2219 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
2220
2221 =cut
2222
2223 1;
2224
2225