FS/FS/cust_main.pm

   1 package FS::cust_main;
   2
   3 use strict;
   4 use vars qw( @ISA $conf $DEBUG $import );
   5 use vars qw( $realtime_bop_decline_quiet ); #ugh
   6 use Safe;
   7 use Carp;
   8 BEGIN {
   9   eval "use Time::Local;";
  10   die "Time::Local minimum version 1.05 required with Perl versions before 5.6"
  11     if $] < 5.006 && !defined($Time::Local::VERSION);
  12   eval "use Time::Local qw(timelocal timelocal_nocheck);";
  13 }
  14 use Date::Format;
  15 #use Date::Manip;
  16 use Business::CreditCard;
  17 use FS::UID qw( getotaker dbh );
  18 use FS::Record qw( qsearchs qsearch dbdef );
  19 use FS::Misc qw( send_email );
  20 use FS::cust_pkg;
  21 use FS::cust_bill;
  22 use FS::cust_bill_pkg;
  23 use FS::cust_pay;
  24 use FS::cust_credit;
  25 use FS::cust_refund;
  26 use FS::part_referral;
  27 use FS::cust_main_county;
  28 use FS::agent;
  29 use FS::cust_main_invoice;
  30 use FS::cust_credit_bill;
  31 use FS::cust_bill_pay;
  32 use FS::prepay_credit;
  33 use FS::queue;
  34 use FS::part_pkg;
  35 use FS::part_bill_event;
  36 use FS::cust_bill_event;
  37 use FS::cust_tax_exempt;
  38 use FS::type_pkgs;
  39 use FS::Msgcat qw(gettext);
  40
  41 @ISA = qw( FS::Record );
  42
  43 $realtime_bop_decline_quiet = 0;
  44
  45 $DEBUG = 0;
  46 #$DEBUG = 1;
  47
  48 $import = 0;
  49
  50 #ask FS::UID to run this stuff for us later
  51 #$FS::UID::callback{'FS::cust_main'} = sub {
  52 install_callback FS::UID sub {
  53   $conf = new FS::Conf;
  54   #yes, need it for stuff below (prolly should be cached)
  55 };
  56
  57 sub _cache {
  58   my $self = shift;
  59   my ( $hashref, $cache ) = @_;
  60   if ( exists $hashref->{'pkgnum'} ) {
  61 #    #@{ $self->{'_pkgnum'} } = ();
  62     my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
  63     $self->{'_pkgnum'} = $subcache;
  64     #push @{ $self->{'_pkgnum'} },
  65     FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
  66   }
  67 }
  68
  69 =head1 NAME
  70
  71 FS::cust_main - Object methods for cust_main records
  72
  73 =head1 SYNOPSIS
  74
  75   use FS::cust_main;
  76
  77   $record = new FS::cust_main \%hash;
  78   $record = new FS::cust_main { 'column' => 'value' };
  79
  80   $error = $record->insert;
  81
  82   $error = $new_record->replace($old_record);
  83
  84   $error = $record->delete;
  85
  86   $error = $record->check;
  87
  88   @cust_pkg = $record->all_pkgs;
  89
  90   @cust_pkg = $record->ncancelled_pkgs;
  91
  92   @cust_pkg = $record->suspended_pkgs;
  93
  94   $error = $record->bill;
  95   $error = $record->bill %options;
  96   $error = $record->bill 'time' => $time;
  97
  98   $error = $record->collect;
  99   $error = $record->collect %options;
 100   $error = $record->collect 'invoice_time'   => $time,
 101                             'batch_card'     => 'yes',
 102                             'report_badcard' => 'yes',
 103                           ;
 104
 105 =head1 DESCRIPTION
 106
 107 An FS::cust_main object represents a customer.  FS::cust_main inherits from
 108 FS::Record.  The following fields are currently supported:
 109
 110 =over 4
 111
 112 =item custnum - primary key (assigned automatically for new customers)
 113
 114 =item agentnum - agent (see L<FS::agent>)
 115
 116 =item refnum - Advertising source (see L<FS::part_referral>)
 117
 118 =item first - name
 119
 120 =item last - name
 121
 122 =item ss - social security number (optional)
 123
 124 =item company - (optional)
 125
 126 =item address1
 127
 128 =item address2 - (optional)
 129
 130 =item city
 131
 132 =item county - (optional, see L<FS::cust_main_county>)
 133
 134 =item state - (see L<FS::cust_main_county>)
 135
 136 =item zip
 137
 138 =item country - (see L<FS::cust_main_county>)
 139
 140 =item daytime - phone (optional)
 141
 142 =item night - phone (optional)
 143
 144 =item fax - phone (optional)
 145
 146 =item ship_first - name
 147
 148 =item ship_last - name
 149
 150 =item ship_company - (optional)
 151
 152 =item ship_address1
 153
 154 =item ship_address2 - (optional)
 155
 156 =item ship_city
 157
 158 =item ship_county - (optional, see L<FS::cust_main_county>)
 159
 160 =item ship_state - (see L<FS::cust_main_county>)
 161
 162 =item ship_zip
 163
 164 =item ship_country - (see L<FS::cust_main_county>)
 165
 166 =item ship_daytime - phone (optional)
 167
 168 =item ship_night - phone (optional)
 169
 170 =item ship_fax - phone (optional)
 171
 172 =item payby - I<CARD> (credit card - automatic), I<DCRD> (credit card - on-demand), I<CHEK> (electronic check - automatic), I<DCHK> (electronic check - on-demand), I<LECB> (Phone bill billing), I<BILL> (billing), I<COMP> (free), or I<PREPAY> (special billing type: applies a credit - see L<FS::prepay_credit> and sets billing type to I<BILL>)
 173
 174 =item payinfo - card number, P.O., comp issuer (4-8 lowercase alphanumerics; think username) or prepayment identifier (see L<FS::prepay_credit>)
 175
 176 =item paycvv - Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
 177
 178 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
 179
 180 =item payname - name on card or billing name
 181
 182 =item tax - tax exempt, empty or `Y'
 183
 184 =item otaker - order taker (assigned automatically, see L<FS::UID>)
 185
 186 =item comments - comments (optional)
 187
 188 =item referral_custnum - referring customer number
 189
 190 =back
 191
 192 =head1 METHODS
 193
 194 =over 4
 195
 196 =item new HASHREF
 197
 198 Creates a new customer.  To add the customer to the database, see L<"insert">.
 199
 200 Note that this stores the hash reference, not a distinct copy of the hash it
 201 points to.  You can ask the object for a copy with the I<hash> method.
 202
 203 =cut
 204
 205 sub table { 'cust_main'; }
 206
 207 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
 208
 209 Adds this customer to the database.  If there is an error, returns the error,
 210 otherwise returns false.
 211
 212 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
 213 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
 214 are inserted atomicly, or the transaction is rolled back.  Passing an empty
 215 hash reference is equivalent to not supplying this parameter.  There should be
 216 a better explanation of this, but until then, here's an example:
 217
 218   use Tie::RefHash;
 219   tie %hash, 'Tie::RefHash'; #this part is important
 220   %hash = (
 221     $cust_pkg => [ $svc_acct ],
 222     ...
 223   );
 224   $cust_main->insert( \%hash );
 225
 226 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
 227 be set as the invoicing list (see L<"invoicing_list">).  Errors return as
 228 expected and rollback the entire transaction; it is not necessary to call
 229 check_invoicing_list first.  The invoicing_list is set after the records in the
 230 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
 231 invoicing_list destination to the newly-created svc_acct.  Here's an example:
 232
 233   $cust_main->insert( {}, [ $email, 'POST' ] );
 234
 235 Currently available options are: I<depend_jobnum> and I<noexport>.
 236
 237 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
 238 on the supplied jobnum (they will not run until the specific job completes).
 239 This can be used to defer provisioning until some action completes (such
 240 as running the customer's credit card sucessfully).
 241
 242 The I<noexport> option is deprecated.  If I<noexport> is set true, no
 243 provisioning jobs (exports) are scheduled.  (You can schedule them later with
 244 the B<reexport> method.)
 245
 246 =cut
 247
 248 sub insert {
 249   my $self = shift;
 250   my $cust_pkgs = @_ ? shift : {};
 251   my $invoicing_list = @_ ? shift : '';
 252   my %options = @_;
 253   warn "FS::cust_main::insert called with options ".
 254        join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
 255     if $DEBUG;
 256
 257   local $SIG{HUP} = 'IGNORE';
 258   local $SIG{INT} = 'IGNORE';
 259   local $SIG{QUIT} = 'IGNORE';
 260   local $SIG{TERM} = 'IGNORE';
 261   local $SIG{TSTP} = 'IGNORE';
 262   local $SIG{PIPE} = 'IGNORE';
 263
 264   my $oldAutoCommit = $FS::UID::AutoCommit;
 265   local $FS::UID::AutoCommit = 0;
 266   my $dbh = dbh;
 267
 268   my $amount = 0;
 269   my $seconds = 0;
 270   if ( $self->payby eq 'PREPAY' ) {
 271     $self->payby('BILL');
 272     my $prepay_credit = qsearchs(
 273       'prepay_credit',
 274       { 'identifier' => $self->payinfo },
 275       '',
 276       'FOR UPDATE'
 277     );
 278     warn "WARNING: can't find pre-found prepay_credit: ". $self->payinfo
 279       unless $prepay_credit;
 280     $amount = $prepay_credit->amount;
 281     $seconds = $prepay_credit->seconds;
 282     my $error = $prepay_credit->delete;
 283     if ( $error ) {
 284       $dbh->rollback if $oldAutoCommit;
 285       return "removing prepay_credit (transaction rolled back): $error";
 286     }
 287   }
 288
 289   my $error = $self->SUPER::insert;
 290   if ( $error ) {
 291     $dbh->rollback if $oldAutoCommit;
 292     #return "inserting cust_main record (transaction rolled back): $error";
 293     return $error;
 294   }
 295
 296   # invoicing list
 297   if ( $invoicing_list ) {
 298     $error = $self->check_invoicing_list( $invoicing_list );
 299     if ( $error ) {
 300       $dbh->rollback if $oldAutoCommit;
 301       return "checking invoicing_list (transaction rolled back): $error";
 302     }
 303     $self->invoicing_list( $invoicing_list );
 304   }
 305
 306   # packages
 307   $error = $self->order_pkgs($cust_pkgs, \$seconds, %options);
 308   if ( $error ) {
 309     $dbh->rollback if $oldAutoCommit;
 310     return $error;
 311   }
 312
 313   if ( $seconds ) {
 314     $dbh->rollback if $oldAutoCommit;
 315     return "No svc_acct record to apply pre-paid time";
 316   }
 317
 318   if ( $amount ) {
 319     my $cust_credit = new FS::cust_credit {
 320       'custnum' => $self->custnum,
 321       'amount'  => $amount,
 322     };
 323     $error = $cust_credit->insert;
 324     if ( $error ) {
 325       $dbh->rollback if $oldAutoCommit;
 326       return "inserting credit (transaction rolled back): $error";
 327     }
 328   }
 329
 330   $error = $self->queue_fuzzyfiles_update;
 331   if ( $error ) {
 332     $dbh->rollback if $oldAutoCommit;
 333     return "updating fuzzy search cache: $error";
 334   }
 335
 336   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 337   '';
 338
 339 }
 340
 341 =item order_pkgs HASHREF, [ SECONDSREF, [ , OPTION => VALUE ... ] ]
 342
 343 Like the insert method on an existing record, this method orders a package
 344 and included services atomicaly.  Pass a Tie::RefHash data structure to this
 345 method containing FS::cust_pkg and FS::svc_I<tablename> objects.  There should
 346 be a better explanation of this, but until then, here's an example:
 347
 348   use Tie::RefHash;
 349   tie %hash, 'Tie::RefHash'; #this part is important
 350   %hash = (
 351     $cust_pkg => [ $svc_acct ],
 352     ...
 353   );
 354   $cust_main->order_pkgs( \%hash, \'0', 'noexport'=>1 );
 355
 356 Currently available options are: I<depend_jobnum> and I<noexport>.
 357
 358 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
 359 on the supplied jobnum (they will not run until the specific job completes).
 360 This can be used to defer provisioning until some action completes (such
 361 as running the customer's credit card sucessfully).
 362
 363 The I<noexport> option is deprecated.  If I<noexport> is set true, no
 364 provisioning jobs (exports) are scheduled.  (You can schedule them later with
 365 the B<reexport> method for each cust_pkg object.  Using the B<reexport> method
 366 on the cust_main object is not recommended, as existing services will also be
 367 reexported.)
 368
 369 =cut
 370
 371 sub order_pkgs {
 372   my $self = shift;
 373   my $cust_pkgs = shift;
 374   my $seconds = shift;
 375   my %options = @_;
 376   my %svc_options = ();
 377   $svc_options{'depend_jobnum'} = $options{'depend_jobnum'}
 378     if exists $options{'depend_jobnum'};
 379   warn "FS::cust_main::order_pkgs called with options ".
 380        join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
 381     if $DEBUG;
 382
 383   local $SIG{HUP} = 'IGNORE';
 384   local $SIG{INT} = 'IGNORE';
 385   local $SIG{QUIT} = 'IGNORE';
 386   local $SIG{TERM} = 'IGNORE';
 387   local $SIG{TSTP} = 'IGNORE';
 388   local $SIG{PIPE} = 'IGNORE';
 389
 390   my $oldAutoCommit = $FS::UID::AutoCommit;
 391   local $FS::UID::AutoCommit = 0;
 392   my $dbh = dbh;
 393
 394   local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
 395
 396   foreach my $cust_pkg ( keys %$cust_pkgs ) {
 397     $cust_pkg->custnum( $self->custnum );
 398     my $error = $cust_pkg->insert;
 399     if ( $error ) {
 400       $dbh->rollback if $oldAutoCommit;
 401       return "inserting cust_pkg (transaction rolled back): $error";
 402     }
 403     foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
 404       $svc_something->pkgnum( $cust_pkg->pkgnum );
 405       if ( $seconds && $$seconds && $svc_something->isa('FS::svc_acct') ) {
 406         $svc_something->seconds( $svc_something->seconds + $$seconds );
 407         $$seconds = 0;
 408       }
 409       $error = $svc_something->insert(%svc_options);
 410       if ( $error ) {
 411         $dbh->rollback if $oldAutoCommit;
 412         #return "inserting svc_ (transaction rolled back): $error";
 413         return $error;
 414       }
 415     }
 416   }
 417
 418   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 419   ''; #no error
 420 }
 421
 422 =item reexport
 423
 424 This method is deprecated.  See the I<depend_jobnum> option to the insert and
 425 order_pkgs methods for a better way to defer provisioning.
 426
 427 Re-schedules all exports by calling the B<reexport> method of all associated
 428 packages (see L<FS::cust_pkg>).  If there is an error, returns the error;
 429 otherwise returns false.
 430
 431 =cut
 432
 433 sub reexport {
 434   my $self = shift;
 435
 436   carp "warning: FS::cust_main::reexport is deprectated; ".
 437        "use the depend_jobnum option to insert or order_pkgs to delay export";
 438
 439   local $SIG{HUP} = 'IGNORE';
 440   local $SIG{INT} = 'IGNORE';
 441   local $SIG{QUIT} = 'IGNORE';
 442   local $SIG{TERM} = 'IGNORE';
 443   local $SIG{TSTP} = 'IGNORE';
 444   local $SIG{PIPE} = 'IGNORE';
 445
 446   my $oldAutoCommit = $FS::UID::AutoCommit;
 447   local $FS::UID::AutoCommit = 0;
 448   my $dbh = dbh;
 449
 450   foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
 451     my $error = $cust_pkg->reexport;
 452     if ( $error ) {
 453       $dbh->rollback if $oldAutoCommit;
 454       return $error;
 455     }
 456   }
 457
 458   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 459   '';
 460
 461 }
 462
 463 =item delete NEW_CUSTNUM
 464
 465 This deletes the customer.  If there is an error, returns the error, otherwise
 466 returns false.
 467
 468 This will completely remove all traces of the customer record.  This is not
 469 what you want when a customer cancels service; for that, cancel all of the
 470 customer's packages (see L</cancel>).
 471
 472 If the customer has any uncancelled packages, you need to pass a new (valid)
 473 customer number for those packages to be transferred to.  Cancelled packages
 474 will be deleted.  Did I mention that this is NOT what you want when a customer
 475 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
 476
 477 You can't delete a customer with invoices (see L<FS::cust_bill>),
 478 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
 479 refunds (see L<FS::cust_refund>).
 480
 481 =cut
 482
 483 sub delete {
 484   my $self = shift;
 485
 486   local $SIG{HUP} = 'IGNORE';
 487   local $SIG{INT} = 'IGNORE';
 488   local $SIG{QUIT} = 'IGNORE';
 489   local $SIG{TERM} = 'IGNORE';
 490   local $SIG{TSTP} = 'IGNORE';
 491   local $SIG{PIPE} = 'IGNORE';
 492
 493   my $oldAutoCommit = $FS::UID::AutoCommit;
 494   local $FS::UID::AutoCommit = 0;
 495   my $dbh = dbh;
 496
 497   if ( $self->cust_bill ) {
 498     $dbh->rollback if $oldAutoCommit;
 499     return "Can't delete a customer with invoices";
 500   }
 501   if ( $self->cust_credit ) {
 502     $dbh->rollback if $oldAutoCommit;
 503     return "Can't delete a customer with credits";
 504   }
 505   if ( $self->cust_pay ) {
 506     $dbh->rollback if $oldAutoCommit;
 507     return "Can't delete a customer with payments";
 508   }
 509   if ( $self->cust_refund ) {
 510     $dbh->rollback if $oldAutoCommit;
 511     return "Can't delete a customer with refunds";
 512   }
 513
 514   my @cust_pkg = $self->ncancelled_pkgs;
 515   if ( @cust_pkg ) {
 516     my $new_custnum = shift;
 517     unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
 518       $dbh->rollback if $oldAutoCommit;
 519       return "Invalid new customer number: $new_custnum";
 520     }
 521     foreach my $cust_pkg ( @cust_pkg ) {
 522       my %hash = $cust_pkg->hash;
 523       $hash{'custnum'} = $new_custnum;
 524       my $new_cust_pkg = new FS::cust_pkg ( \%hash );
 525       my $error = $new_cust_pkg->replace($cust_pkg);
 526       if ( $error ) {
 527         $dbh->rollback if $oldAutoCommit;
 528         return $error;
 529       }
 530     }
 531   }
 532   my @cancelled_cust_pkg = $self->all_pkgs;
 533   foreach my $cust_pkg ( @cancelled_cust_pkg ) {
 534     my $error = $cust_pkg->delete;
 535     if ( $error ) {
 536       $dbh->rollback if $oldAutoCommit;
 537       return $error;
 538     }
 539   }
 540
 541   foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
 542     qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
 543   ) {
 544     my $error = $cust_main_invoice->delete;
 545     if ( $error ) {
 546       $dbh->rollback if $oldAutoCommit;
 547       return $error;
 548     }
 549   }
 550
 551   my $error = $self->SUPER::delete;
 552   if ( $error ) {
 553     $dbh->rollback if $oldAutoCommit;
 554     return $error;
 555   }
 556
 557   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 558   '';
 559
 560 }
 561
 562 =item replace OLD_RECORD [ INVOICING_LIST_ARYREF ]
 563
 564 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 565 returns the error, otherwise returns false.
 566
 567 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
 568 be set as the invoicing list (see L<"invoicing_list">).  Errors return as
 569 expected and rollback the entire transaction; it is not necessary to call
 570 check_invoicing_list first.  Here's an example:
 571
 572   $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
 573
 574 =cut
 575
 576 sub replace {
 577   my $self = shift;
 578   my $old = shift;
 579   my @param = @_;
 580
 581   local $SIG{HUP} = 'IGNORE';
 582   local $SIG{INT} = 'IGNORE';
 583   local $SIG{QUIT} = 'IGNORE';
 584   local $SIG{TERM} = 'IGNORE';
 585   local $SIG{TSTP} = 'IGNORE';
 586   local $SIG{PIPE} = 'IGNORE';
 587
 588   if ( $self->payby eq 'COMP' && $self->payby ne $old->payby
 589        && $conf->config('users-allow_comp')                  ) {
 590     return "You are not permitted to create complimentary accounts."
 591       unless grep { $_ eq getotaker } $conf->config('users-allow_comp');
 592   }
 593
 594   my $oldAutoCommit = $FS::UID::AutoCommit;
 595   local $FS::UID::AutoCommit = 0;
 596   my $dbh = dbh;
 597
 598   my $error = $self->SUPER::replace($old);
 599
 600   if ( $error ) {
 601     $dbh->rollback if $oldAutoCommit;
 602     return $error;
 603   }
 604
 605   if ( @param ) { # INVOICING_LIST_ARYREF
 606     my $invoicing_list = shift @param;
 607     $error = $self->check_invoicing_list( $invoicing_list );
 608     if ( $error ) {
 609       $dbh->rollback if $oldAutoCommit;
 610       return $error;
 611     }
 612     $self->invoicing_list( $invoicing_list );
 613   }
 614
 615   if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
 616        grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
 617     # card/check/lec info has changed, want to retry realtime_ invoice events
 618     my $error = $self->retry_realtime;
 619     if ( $error ) {
 620       $dbh->rollback if $oldAutoCommit;
 621       return $error;
 622     }
 623   }
 624
 625   $error = $self->queue_fuzzyfiles_update;
 626   if ( $error ) {
 627     $dbh->rollback if $oldAutoCommit;
 628     return "updating fuzzy search cache: $error";
 629   }
 630
 631   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 632   '';
 633
 634 }
 635
 636 =item queue_fuzzyfiles_update
 637
 638 Used by insert & replace to update the fuzzy search cache
 639
 640 =cut
 641
 642 sub queue_fuzzyfiles_update {
 643   my $self = shift;
 644
 645   local $SIG{HUP} = 'IGNORE';
 646   local $SIG{INT} = 'IGNORE';
 647   local $SIG{QUIT} = 'IGNORE';
 648   local $SIG{TERM} = 'IGNORE';
 649   local $SIG{TSTP} = 'IGNORE';
 650   local $SIG{PIPE} = 'IGNORE';
 651
 652   my $oldAutoCommit = $FS::UID::AutoCommit;
 653   local $FS::UID::AutoCommit = 0;
 654   my $dbh = dbh;
 655
 656   my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
 657   my $error = $queue->insert($self->getfield('last'), $self->company);
 658   if ( $error ) {
 659     $dbh->rollback if $oldAutoCommit;
 660     return "queueing job (transaction rolled back): $error";
 661   }
 662
 663   if ( defined $self->dbdef_table->column('ship_last') && $self->ship_last ) {
 664     $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
 665     $error = $queue->insert($self->getfield('ship_last'), $self->ship_company);
 666     if ( $error ) {
 667       $dbh->rollback if $oldAutoCommit;
 668       return "queueing job (transaction rolled back): $error";
 669     }
 670   }
 671
 672   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 673   '';
 674
 675 }
 676
 677 =item check
 678
 679 Checks all fields to make sure this is a valid customer record.  If there is
 680 an error, returns the error, otherwise returns false.  Called by the insert
 681 and repalce methods.
 682
 683 =cut
 684
 685 sub check {
 686   my $self = shift;
 687
 688   #warn "BEFORE: \n". $self->_dump;
 689
 690   my $error =
 691     $self->ut_numbern('custnum')
 692     || $self->ut_number('agentnum')
 693     || $self->ut_number('refnum')
 694     || $self->ut_name('last')
 695     || $self->ut_name('first')
 696     || $self->ut_textn('company')
 697     || $self->ut_text('address1')
 698     || $self->ut_textn('address2')
 699     || $self->ut_text('city')
 700     || $self->ut_textn('county')
 701     || $self->ut_textn('state')
 702     || $self->ut_country('country')
 703     || $self->ut_anything('comments')
 704     || $self->ut_numbern('referral_custnum')
 705   ;
 706   #barf.  need message catalogs.  i18n.  etc.
 707   $error .= "Please select an advertising source."
 708     if $error =~ /^Illegal or empty \(numeric\) refnum: /;
 709   return $error if $error;
 710
 711   return "Unknown agent"
 712     unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
 713
 714   return "Unknown refnum"
 715     unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
 716
 717   return "Unknown referring custnum ". $self->referral_custnum
 718     unless ! $self->referral_custnum
 719            || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
 720
 721   if ( $self->ss eq '' ) {
 722     $self->ss('');
 723   } else {
 724     my $ss = $self->ss;
 725     $ss =~ s/\D//g;
 726     $ss =~ /^(\d{3})(\d{2})(\d{4})$/
 727       or return "Illegal social security number: ". $self->ss;
 728     $self->ss("$1-$2-$3");
 729   }
 730
 731
 732 # bad idea to disable, causes billing to fail because of no tax rates later
 733 #  unless ( $import ) {
 734     unless ( qsearch('cust_main_county', {
 735       'country' => $self->country,
 736       'state'   => '',
 737      } ) ) {
 738       return "Unknown state/county/country: ".
 739         $self->state. "/". $self->county. "/". $self->country
 740         unless qsearch('cust_main_county',{
 741           'state'   => $self->state,
 742           'county'  => $self->county,
 743           'country' => $self->country,
 744         } );
 745     }
 746 #  }
 747
 748   $error =
 749     $self->ut_phonen('daytime', $self->country)
 750     || $self->ut_phonen('night', $self->country)
 751     || $self->ut_phonen('fax', $self->country)
 752     || $self->ut_zip('zip', $self->country)
 753   ;
 754   return $error if $error;
 755
 756   my @addfields = qw(
 757     last first company address1 address2 city county state zip
 758     country daytime night fax
 759   );
 760
 761   if ( defined $self->dbdef_table->column('ship_last') ) {
 762     if ( scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
 763                        @addfields )
 764          && scalar ( grep { $self->getfield("ship_$_") ne '' } @addfields )
 765        )
 766     {
 767       my $error =
 768         $self->ut_name('ship_last')
 769         || $self->ut_name('ship_first')
 770         || $self->ut_textn('ship_company')
 771         || $self->ut_text('ship_address1')
 772         || $self->ut_textn('ship_address2')
 773         || $self->ut_text('ship_city')
 774         || $self->ut_textn('ship_county')
 775         || $self->ut_textn('ship_state')
 776         || $self->ut_country('ship_country')
 777       ;
 778       return $error if $error;
 779
 780       #false laziness with above
 781       unless ( qsearchs('cust_main_county', {
 782         'country' => $self->ship_country,
 783         'state'   => '',
 784        } ) ) {
 785         return "Unknown ship_state/ship_county/ship_country: ".
 786           $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
 787           unless qsearchs('cust_main_county',{
 788             'state'   => $self->ship_state,
 789             'county'  => $self->ship_county,
 790             'country' => $self->ship_country,
 791           } );
 792       }
 793       #eofalse
 794
 795       $error =
 796         $self->ut_phonen('ship_daytime', $self->ship_country)
 797         || $self->ut_phonen('ship_night', $self->ship_country)
 798         || $self->ut_phonen('ship_fax', $self->ship_country)
 799         || $self->ut_zip('ship_zip', $self->ship_country)
 800       ;
 801       return $error if $error;
 802
 803     } else { # ship_ info eq billing info, so don't store dup info in database
 804       $self->setfield("ship_$_", '')
 805         foreach qw( last first company address1 address2 city county state zip
 806                     country daytime night fax );
 807     }
 808   }
 809
 810   $self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY)$/
 811     or return "Illegal payby: ". $self->payby;
 812   $self->payby($1);
 813
 814   if ( $self->payby eq 'CARD' || $self->payby eq 'DCRD' ) {
 815
 816     my $payinfo = $self->payinfo;
 817     $payinfo =~ s/\D//g;
 818     $payinfo =~ /^(\d{13,16})$/
 819       or return gettext('invalid_card'); # . ": ". $self->payinfo;
 820     $payinfo = $1;
 821     $self->payinfo($payinfo);
 822     validate($payinfo)
 823       or return gettext('invalid_card'); # . ": ". $self->payinfo;
 824     return gettext('unknown_card_type')
 825       if cardtype($self->payinfo) eq "Unknown";
 826     if ( defined $self->dbdef_table->column('paycvv') ) {
 827       if ( length($self->paycvv) ) {
 828         if ( cardtype($self->payinfo) eq 'American Express card' ) {
 829           $self->paycvv =~ /^(\d{4})$/
 830             or return "CVV2 (CID) for American Express cards is four digits.";
 831           $self->paycvv($1);
 832         } else {
 833           $self->paycvv =~ /^(\d{3})$/
 834             or return "CVV2 (CVC2/CID) is three digits.";
 835           $self->paycvv($1);
 836         }
 837       } else {
 838         $self->paycvv('');
 839       }
 840     }
 841
 842   } elsif ( $self->payby eq 'CHEK' || $self->payby eq 'DCHK' ) {
 843
 844     my $payinfo = $self->payinfo;
 845     $payinfo =~ s/[^\d\@]//g;
 846     $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
 847     $payinfo = "$1\@$2";
 848     $self->payinfo($payinfo);
 849     $self->paycvv('') if $self->dbdef_table->column('paycvv');
 850
 851   } elsif ( $self->payby eq 'LECB' ) {
 852
 853     my $payinfo = $self->payinfo;
 854     $payinfo =~ s/\D//g;
 855     $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
 856     $payinfo = $1;
 857     $self->payinfo($payinfo);
 858     $self->paycvv('') if $self->dbdef_table->column('paycvv');
 859
 860   } elsif ( $self->payby eq 'BILL' ) {
 861
 862     $error = $self->ut_textn('payinfo');
 863     return "Illegal P.O. number: ". $self->payinfo if $error;
 864     $self->paycvv('') if $self->dbdef_table->column('paycvv');
 865
 866   } elsif ( $self->payby eq 'COMP' ) {
 867
 868     if ( !$self->custnum && $conf->config('users-allow_comp') ) {
 869       return "You are not permitted to create complimentary accounts."
 870         unless grep { $_ eq getotaker } $conf->config('users-allow_comp');
 871     }
 872
 873     $error = $self->ut_textn('payinfo');
 874     return "Illegal comp account issuer: ". $self->payinfo if $error;
 875     $self->paycvv('') if $self->dbdef_table->column('paycvv');
 876
 877   } elsif ( $self->payby eq 'PREPAY' ) {
 878
 879     my $payinfo = $self->payinfo;
 880     $payinfo =~ s/\W//g; #anything else would just confuse things
 881     $self->payinfo($payinfo);
 882     $error = $self->ut_alpha('payinfo');
 883     return "Illegal prepayment identifier: ". $self->payinfo if $error;
 884     return "Unknown prepayment identifier"
 885       unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
 886     $self->paycvv('') if $self->dbdef_table->column('paycvv');
 887
 888   }
 889
 890   if ( $self->paydate eq '' || $self->paydate eq '-' ) {
 891     return "Expriation date required"
 892       unless $self->payby =~ /^(BILL|PREPAY|CHEK|LECB)$/;
 893     $self->paydate('');
 894   } else {
 895     my( $m, $y );
 896     if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
 897       ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
 898     } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{2})[\/\-]\d+$/ ) {
 899       ( $m, $y ) = ( $3, "20$2" );
 900     } else {
 901       return "Illegal expiration date: ". $self->paydate;
 902     }
 903     $self->paydate("$y-$m-01");
 904     my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
 905     return gettext('expired_card')
 906       if !$import && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
 907   }
 908
 909   if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
 910        ( ! $conf->exists('require_cardname')
 911          || $self->payby !~ /^(CARD|DCRD)$/  )
 912   ) {
 913     $self->payname( $self->first. " ". $self->getfield('last') );
 914   } else {
 915     $self->payname =~ /^([\w \,\.\-\']+)$/
 916       or return gettext('illegal_name'). " payname: ". $self->payname;
 917     $self->payname($1);
 918   }
 919
 920   $self->tax =~ /^(Y?)$/ or return "Illegal tax: ". $self->tax;
 921   $self->tax($1);
 922
 923   $self->otaker(getotaker) unless $self->otaker;
 924
 925   #warn "AFTER: \n". $self->_dump;
 926
 927   $self->SUPER::check;
 928 }
 929
 930 =item all_pkgs
 931
 932 Returns all packages (see L<FS::cust_pkg>) for this customer.
 933
 934 =cut
 935
 936 sub all_pkgs {
 937   my $self = shift;
 938   if ( $self->{'_pkgnum'} ) {
 939     values %{ $self->{'_pkgnum'}->cache };
 940   } else {
 941     qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
 942   }
 943 }
 944
 945 =item ncancelled_pkgs
 946
 947 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
 948
 949 =cut
 950
 951 sub ncancelled_pkgs {
 952   my $self = shift;
 953   if ( $self->{'_pkgnum'} ) {
 954     grep { ! $_->getfield('cancel') } values %{ $self->{'_pkgnum'}->cache };
 955   } else {
 956     @{ [ # force list context
 957       qsearch( 'cust_pkg', {
 958         'custnum' => $self->custnum,
 959         'cancel'  => '',
 960       }),
 961       qsearch( 'cust_pkg', {
 962         'custnum' => $self->custnum,
 963         'cancel'  => 0,
 964       }),
 965     ] };
 966   }
 967 }
 968
 969 =item suspended_pkgs
 970
 971 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
 972
 973 =cut
 974
 975 sub suspended_pkgs {
 976   my $self = shift;
 977   grep { $_->susp } $self->ncancelled_pkgs;
 978 }
 979
 980 =item unflagged_suspended_pkgs
 981
 982 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
 983 customer (thouse packages without the `manual_flag' set).
 984
 985 =cut
 986
 987 sub unflagged_suspended_pkgs {
 988   my $self = shift;
 989   return $self->suspended_pkgs
 990     unless dbdef->table('cust_pkg')->column('manual_flag');
 991   grep { ! $_->manual_flag } $self->suspended_pkgs;
 992 }
 993
 994 =item unsuspended_pkgs
 995
 996 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
 997 this customer.
 998
 999 =cut
1000
1001 sub unsuspended_pkgs {
1002   my $self = shift;
1003   grep { ! $_->susp } $self->ncancelled_pkgs;
1004 }
1005
1006 =item unsuspend
1007
1008 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1009 and L<FS::cust_pkg>) for this customer.  Always returns a list: an empty list
1010 on success or a list of errors.
1011
1012 =cut
1013
1014 sub unsuspend {
1015   my $self = shift;
1016   grep { $_->unsuspend } $self->suspended_pkgs;
1017 }
1018
1019 =item suspend
1020
1021 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1022 Always returns a list: an empty list on success or a list of errors.
1023
1024 =cut
1025
1026 sub suspend {
1027   my $self = shift;
1028   grep { $_->suspend } $self->unsuspended_pkgs;
1029 }
1030
1031 =item cancel [ OPTION => VALUE ... ]
1032
1033 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1034
1035 Available options are: I<quiet>
1036
1037 I<quiet> can be set true to supress email cancellation notices.
1038
1039 Always returns a list: an empty list on success or a list of errors.
1040
1041 =cut
1042
1043 sub cancel {
1044   my $self = shift;
1045   grep { $_ } map { $_->cancel(@_) } $self->ncancelled_pkgs;
1046 }
1047
1048 =item agent
1049
1050 Returns the agent (see L<FS::agent>) for this customer.
1051
1052 =cut
1053
1054 sub agent {
1055   my $self = shift;
1056   qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1057 }
1058
1059 =item bill OPTIONS
1060
1061 Generates invoices (see L<FS::cust_bill>) for this customer.  Usually used in
1062 conjunction with the collect method.
1063
1064 Options are passed as name-value pairs.
1065
1066 Currently available options are:
1067
1068 resetup - if set true, re-charges setup fees.
1069
1070 time - bills the customer as if it were that time.  Specified as a UNIX
1071 timestamp; see L<perlfunc/"time">).  Also see L<Time::Local> and
1072 L<Date::Parse> for conversion functions.  For example:
1073
1074  use Date::Parse;
1075  ...
1076  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1077
1078
1079 If there is an error, returns the error, otherwise returns false.
1080
1081 =cut
1082
1083 sub bill {
1084   my( $self, %options ) = @_;
1085   my $time = $options{'time'} || time;
1086
1087   my $error;
1088
1089   #put below somehow?
1090   local $SIG{HUP} = 'IGNORE';
1091   local $SIG{INT} = 'IGNORE';
1092   local $SIG{QUIT} = 'IGNORE';
1093   local $SIG{TERM} = 'IGNORE';
1094   local $SIG{TSTP} = 'IGNORE';
1095   local $SIG{PIPE} = 'IGNORE';
1096
1097   my $oldAutoCommit = $FS::UID::AutoCommit;
1098   local $FS::UID::AutoCommit = 0;
1099   my $dbh = dbh;
1100
1101   # find the packages which are due for billing, find out how much they are
1102   # & generate invoice database.
1103
1104   my( $total_setup, $total_recur ) = ( 0, 0 );
1105   #my( $taxable_setup, $taxable_recur ) = ( 0, 0 );
1106   my @cust_bill_pkg = ();
1107   #my $tax = 0;##
1108   #my $taxable_charged = 0;##
1109   #my $charged = 0;##
1110
1111   my %tax;
1112
1113   foreach my $cust_pkg (
1114     qsearch('cust_pkg', { 'custnum' => $self->custnum } )
1115   ) {
1116
1117     #NO!! next if $cust_pkg->cancel;
1118     next if $cust_pkg->getfield('cancel');
1119
1120     #? to avoid use of uninitialized value errors... ?
1121     $cust_pkg->setfield('bill', '')
1122       unless defined($cust_pkg->bill);
1123
1124     my $part_pkg = $cust_pkg->part_pkg;
1125
1126     #so we don't modify cust_pkg record unnecessarily
1127     my $cust_pkg_mod_flag = 0;
1128     my %hash = $cust_pkg->hash;
1129     my $old_cust_pkg = new FS::cust_pkg \%hash;
1130
1131     my @details = ();
1132
1133     # bill setup
1134     my $setup = 0;
1135     if ( !$cust_pkg->setup || $options{'resetup'} ) {
1136       my $setup_prog = $part_pkg->getfield('setup');
1137       $setup_prog =~ /^(.*)$/ or do {
1138         $dbh->rollback if $oldAutoCommit;
1139         return "Illegal setup for pkgpart ". $part_pkg->pkgpart.
1140                ": $setup_prog";
1141       };
1142       $setup_prog = $1;
1143       $setup_prog = '0' if $setup_prog =~ /^\s*$/;
1144
1145         #my $cpt = new Safe;
1146         ##$cpt->permit(); #what is necessary?
1147         #$cpt->share(qw( $cust_pkg )); #can $cpt now use $cust_pkg methods?
1148         #$setup = $cpt->reval($setup_prog);
1149       $setup = eval $setup_prog;
1150       unless ( defined($setup) ) {
1151         $dbh->rollback if $oldAutoCommit;
1152         return "Error eval-ing part_pkg->setup pkgpart ". $part_pkg->pkgpart.
1153                "(expression $setup_prog): $@";
1154       }
1155       $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
1156       $cust_pkg_mod_flag=1;
1157     }
1158
1159     #bill recurring fee
1160     my $recur = 0;
1161     my $sdate;
1162     if ( $part_pkg->getfield('freq') ne '0' &&
1163          ! $cust_pkg->getfield('susp') &&
1164          ( $cust_pkg->getfield('bill') || 0 ) <= $time
1165     ) {
1166       my $recur_prog = $part_pkg->getfield('recur');
1167       $recur_prog =~ /^(.*)$/ or do {
1168         $dbh->rollback if $oldAutoCommit;
1169         return "Illegal recur for pkgpart ". $part_pkg->pkgpart.
1170                ": $recur_prog";
1171       };
1172       $recur_prog = $1;
1173       $recur_prog = '0' if $recur_prog =~ /^\s*$/;
1174
1175       # shared with $recur_prog
1176       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1177
1178         #my $cpt = new Safe;
1179         ##$cpt->permit(); #what is necessary?
1180         #$cpt->share(qw( $cust_pkg )); #can $cpt now use $cust_pkg methods?
1181         #$recur = $cpt->reval($recur_prog);
1182       $recur = eval $recur_prog;
1183       unless ( defined($recur) ) {
1184         $dbh->rollback if $oldAutoCommit;
1185         return "Error eval-ing part_pkg->recur pkgpart ".  $part_pkg->pkgpart.
1186                "(expression $recur_prog): $@";
1187       }
1188       #change this bit to use Date::Manip? CAREFUL with timezones (see
1189       # mailing list archive)
1190       my ($sec,$min,$hour,$mday,$mon,$year) =
1191         (localtime($sdate) )[0,1,2,3,4,5];
1192
1193       #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
1194       # only for figuring next bill date, nothing else, so, reset $sdate again
1195       # here
1196       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1197       $cust_pkg->last_bill($sdate)
1198         if $cust_pkg->dbdef_table->column('last_bill');
1199
1200       if ( $part_pkg->freq =~ /^\d+$/ ) {
1201         $mon += $part_pkg->freq;
1202         until ( $mon < 12 ) { $mon -= 12; $year++; }
1203       } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
1204         my $weeks = $1;
1205         $mday += $weeks * 7;
1206       } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
1207         my $days = $1;
1208         $mday += $days;
1209       } else {
1210         $dbh->rollback if $oldAutoCommit;
1211         return "unparsable frequency: ". $part_pkg->freq;
1212       }
1213       $cust_pkg->setfield('bill',
1214         timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
1215       $cust_pkg_mod_flag = 1;
1216     }
1217
1218     warn "\$setup is undefined" unless defined($setup);
1219     warn "\$recur is undefined" unless defined($recur);
1220     warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1221
1222     if ( $cust_pkg_mod_flag ) {
1223       $error=$cust_pkg->replace($old_cust_pkg);
1224       if ( $error ) { #just in case
1225         $dbh->rollback if $oldAutoCommit;
1226         return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
1227       }
1228       $setup = sprintf( "%.2f", $setup );
1229       $recur = sprintf( "%.2f", $recur );
1230       if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1231         $dbh->rollback if $oldAutoCommit;
1232         return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1233       }
1234       if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1235         $dbh->rollback if $oldAutoCommit;
1236         return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1237       }
1238       if ( $setup != 0 || $recur != 0 ) {
1239         my $cust_bill_pkg = new FS::cust_bill_pkg ({
1240           'pkgnum'  => $cust_pkg->pkgnum,
1241           'setup'   => $setup,
1242           'recur'   => $recur,
1243           'sdate'   => $sdate,
1244           'edate'   => $cust_pkg->bill,
1245           'details' => \@details,
1246         });
1247         push @cust_bill_pkg, $cust_bill_pkg;
1248         $total_setup += $setup;
1249         $total_recur += $recur;
1250
1251         unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
1252
1253           my @taxes = qsearch( 'cust_main_county', {
1254                                  'state'    => $self->state,
1255                                  'county'   => $self->county,
1256                                  'country'  => $self->country,
1257                                  'taxclass' => $part_pkg->taxclass,
1258                                                                       } );
1259           unless ( @taxes ) {
1260             @taxes =  qsearch( 'cust_main_county', {
1261                                   'state'    => $self->state,
1262                                   'county'   => $self->county,
1263                                   'country'  => $self->country,
1264                                   'taxclass' => '',
1265                                                                       } );
1266           }
1267
1268           #one more try at a whole-country tax rate
1269           unless ( @taxes ) {
1270             @taxes =  qsearch( 'cust_main_county', {
1271                                   'state'    => '',
1272                                   'county'   => '',
1273                                   'country'  => $self->country,
1274                                   'taxclass' => '',
1275                                                                       } );
1276           }
1277
1278           # maybe eliminate this entirely, along with all the 0% records
1279           unless ( @taxes ) {
1280             $dbh->rollback if $oldAutoCommit;
1281             return
1282               "fatal: can't find tax rate for state/county/country/taxclass ".
1283               join('/', ( map $self->$_(), qw(state county country) ),
1284                         $part_pkg->taxclass ).  "\n";
1285           }
1286
1287           foreach my $tax ( @taxes ) {
1288
1289             my $taxable_charged = 0;
1290             $taxable_charged += $setup
1291               unless $part_pkg->setuptax =~ /^Y$/i
1292                   || $tax->setuptax =~ /^Y$/i;
1293             $taxable_charged += $recur
1294               unless $part_pkg->recurtax =~ /^Y$/i
1295                   || $tax->recurtax =~ /^Y$/i;
1296             next unless $taxable_charged;
1297
1298             if ( $tax->exempt_amount > 0 ) {
1299               my ($mon,$year) = (localtime($sdate) )[4,5];
1300               $mon++;
1301               my $freq = $part_pkg->freq || 1;
1302               if ( $freq !~ /(\d+)$/ ) {
1303                 $dbh->rollback if $oldAutoCommit;
1304                 return "daily/weekly package definitions not (yet?)".
1305                        " compatible with monthly tax exemptions";
1306               }
1307               my $taxable_per_month = sprintf("%.2f", $taxable_charged / $freq );
1308               foreach my $which_month ( 1 .. $freq ) {
1309                 my %hash = (
1310                   'custnum' => $self->custnum,
1311                   'taxnum'  => $tax->taxnum,
1312                   'year'    => 1900+$year,
1313                   'month'   => $mon++,
1314                 );
1315                 #until ( $mon < 12 ) { $mon -= 12; $year++; }
1316                 until ( $mon < 13 ) { $mon -= 12; $year++; }
1317                 my $cust_tax_exempt =
1318                   qsearchs('cust_tax_exempt', \%hash)
1319                   || new FS::cust_tax_exempt( { %hash, 'amount' => 0 } );
1320                 my $remaining_exemption = sprintf("%.2f",
1321                   $tax->exempt_amount - $cust_tax_exempt->amount );
1322                 if ( $remaining_exemption > 0 ) {
1323                   my $addl = $remaining_exemption > $taxable_per_month
1324                     ? $taxable_per_month
1325                     : $remaining_exemption;
1326                   $taxable_charged -= $addl;
1327                   my $new_cust_tax_exempt = new FS::cust_tax_exempt ( {
1328                     $cust_tax_exempt->hash,
1329                     'amount' =>
1330                       sprintf("%.2f", $cust_tax_exempt->amount + $addl),
1331                   } );
1332                   $error = $new_cust_tax_exempt->exemptnum
1333                     ? $new_cust_tax_exempt->replace($cust_tax_exempt)
1334                     : $new_cust_tax_exempt->insert;
1335                   if ( $error ) {
1336                     $dbh->rollback if $oldAutoCommit;
1337                     return "fatal: can't update cust_tax_exempt: $error";
1338                   }
1339
1340                 } # if $remaining_exemption > 0
1341
1342               } #foreach $which_month
1343
1344             } #if $tax->exempt_amount
1345
1346             $taxable_charged = sprintf( "%.2f", $taxable_charged);
1347
1348             #$tax += $taxable_charged * $cust_main_county->tax / 100
1349             $tax{ $tax->taxname || 'Tax' } +=
1350               $taxable_charged * $tax->tax / 100
1351
1352           } #foreach my $tax ( @taxes )
1353
1354         } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
1355
1356       } #if $setup != 0 || $recur != 0
1357
1358     } #if $cust_pkg_mod_flag
1359
1360   } #foreach my $cust_pkg
1361
1362   my $charged = sprintf( "%.2f", $total_setup + $total_recur );
1363 #  my $taxable_charged = sprintf( "%.2f", $taxable_setup + $taxable_recur );
1364
1365   unless ( @cust_bill_pkg ) { #don't create invoices with no line items
1366     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1367     return '';
1368   }
1369
1370 #  unless ( $self->tax =~ /Y/i
1371 #           || $self->payby eq 'COMP'
1372 #           || $taxable_charged == 0 ) {
1373 #    my $cust_main_county = qsearchs('cust_main_county',{
1374 #        'state'   => $self->state,
1375 #        'county'  => $self->county,
1376 #        'country' => $self->country,
1377 #    } ) or die "fatal: can't find tax rate for state/county/country ".
1378 #               $self->state. "/". $self->county. "/". $self->country. "\n";
1379 #    my $tax = sprintf( "%.2f",
1380 #      $taxable_charged * ( $cust_main_county->getfield('tax') / 100 )
1381 #    );
1382
1383   if ( dbdef->table('cust_bill_pkg')->column('itemdesc') ) { #1.5 schema
1384
1385     foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
1386       my $tax = sprintf("%.2f", $tax{$taxname} );
1387       $charged = sprintf( "%.2f", $charged+$tax );
1388
1389       my $cust_bill_pkg = new FS::cust_bill_pkg ({
1390         'pkgnum'   => 0,
1391         'setup'    => $tax,
1392         'recur'    => 0,
1393         'sdate'    => '',
1394         'edate'    => '',
1395         'itemdesc' => $taxname,
1396       });
1397       push @cust_bill_pkg, $cust_bill_pkg;
1398     }
1399
1400   } else { #1.4 schema
1401
1402     my $tax = 0;
1403     foreach ( values %tax ) { $tax += $_ };
1404     $tax = sprintf("%.2f", $tax);
1405     if ( $tax > 0 ) {
1406       $charged = sprintf( "%.2f", $charged+$tax );
1407
1408       my $cust_bill_pkg = new FS::cust_bill_pkg ({
1409         'pkgnum' => 0,
1410         'setup'  => $tax,
1411         'recur'  => 0,
1412         'sdate'  => '',
1413         'edate'  => '',
1414       });
1415       push @cust_bill_pkg, $cust_bill_pkg;
1416     }
1417
1418   }
1419
1420   my $cust_bill = new FS::cust_bill ( {
1421     'custnum' => $self->custnum,
1422     '_date'   => $time,
1423     'charged' => $charged,
1424   } );
1425   $error = $cust_bill->insert;
1426   if ( $error ) {
1427     $dbh->rollback if $oldAutoCommit;
1428     return "can't create invoice for customer #". $self->custnum. ": $error";
1429   }
1430
1431   my $invnum = $cust_bill->invnum;
1432   my $cust_bill_pkg;
1433   foreach $cust_bill_pkg ( @cust_bill_pkg ) {
1434     #warn $invnum;
1435     $cust_bill_pkg->invnum($invnum);
1436     $error = $cust_bill_pkg->insert;
1437     if ( $error ) {
1438       $dbh->rollback if $oldAutoCommit;
1439       return "can't create invoice line item for customer #". $self->custnum.
1440              ": $error";
1441     }
1442   }
1443
1444   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1445   ''; #no error
1446 }
1447
1448 =item collect OPTIONS
1449
1450 (Attempt to) collect money for this customer's outstanding invoices (see
1451 L<FS::cust_bill>).  Usually used after the bill method.
1452
1453 Depending on the value of `payby', this may print or email an invoice (I<BILL>,
1454 I<DCRD>, or I<DCHK>), charge a credit card (I<CARD>), charge via electronic
1455 check/ACH (I<CHEK>), or just add any necessary (pseudo-)payment (I<COMP>).
1456
1457 Most actions are now triggered by invoice events; see L<FS::part_bill_event>
1458 and the invoice events web interface.
1459
1460 If there is an error, returns the error, otherwise returns false.
1461
1462 Options are passed as name-value pairs.
1463
1464 Currently available options are:
1465
1466 invoice_time - Use this time when deciding when to print invoices and
1467 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>
1468 for conversion functions.
1469
1470 retry - Retry card/echeck/LEC transactions even when not scheduled by invoice
1471 events.
1472
1473 retry_card - Deprecated alias for 'retry'
1474
1475 batch_card - This option is deprecated.  See the invoice events web interface
1476 to control whether cards are batched or run against a realtime gateway.
1477
1478 report_badcard - This option is deprecated.
1479
1480 force_print - This option is deprecated; see the invoice events web interface.
1481
1482 quiet - set true to surpress email card/ACH decline notices.
1483
1484 =cut
1485
1486 sub collect {
1487   my( $self, %options ) = @_;
1488   my $invoice_time = $options{'invoice_time'} || time;
1489
1490   #put below somehow?
1491   local $SIG{HUP} = 'IGNORE';
1492   local $SIG{INT} = 'IGNORE';
1493   local $SIG{QUIT} = 'IGNORE';
1494   local $SIG{TERM} = 'IGNORE';
1495   local $SIG{TSTP} = 'IGNORE';
1496   local $SIG{PIPE} = 'IGNORE';
1497
1498   my $oldAutoCommit = $FS::UID::AutoCommit;
1499   local $FS::UID::AutoCommit = 0;
1500   my $dbh = dbh;
1501
1502   my $balance = $self->balance;
1503   warn "collect customer". $self->custnum. ": balance $balance" if $DEBUG;
1504   unless ( $balance > 0 ) { #redundant?????
1505     $dbh->rollback if $oldAutoCommit; #hmm
1506     return '';
1507   }
1508
1509   if ( exists($options{'retry_card'}) ) {
1510     carp 'retry_card option passed to collect is deprecated; use retry';
1511     $options{'retry'} ||= $options{'retry_card'};
1512   }
1513   if ( exists($options{'retry'}) && $options{'retry'} ) {
1514     my $error = $self->retry_realtime;
1515     if ( $error ) {
1516       $dbh->rollback if $oldAutoCommit;
1517       return $error;
1518     }
1519   }
1520
1521   foreach my $cust_bill ( $self->open_cust_bill ) {
1522
1523     # don't try to charge for the same invoice if it's already in a batch
1524     #next if qsearchs( 'cust_pay_batch', { 'invnum' => $cust_bill->invnum } );
1525
1526     last if $self->balance <= 0;
1527
1528     warn "invnum ". $cust_bill->invnum. " (owed ". $cust_bill->owed. ")"
1529       if $DEBUG;
1530
1531     foreach my $part_bill_event (
1532       sort {    $a->seconds   <=> $b->seconds
1533              || $a->weight    <=> $b->weight
1534              || $a->eventpart <=> $b->eventpart }
1535         grep { $_->seconds <= ( $invoice_time - $cust_bill->_date )
1536                && ! qsearchs( 'cust_bill_event', {
1537                                 'invnum'    => $cust_bill->invnum,
1538                                 'eventpart' => $_->eventpart,
1539                                 'status'    => 'done',
1540                                                                    } )
1541              }
1542           qsearch('part_bill_event', { 'payby'    => $self->payby,
1543                                        'disabled' => '',           } )
1544     ) {
1545
1546       last if $cust_bill->owed <= 0  # don't run subsequent events if owed<=0
1547            || $self->balance   <= 0; # or if balance<=0
1548
1549       warn "calling invoice event (". $part_bill_event->eventcode. ")\n"
1550         if $DEBUG;
1551       my $cust_main = $self; #for callback
1552
1553       my $error;
1554       {
1555         local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
1556         $error = eval $part_bill_event->eventcode;
1557       }
1558
1559       my $status = '';
1560       my $statustext = '';
1561       if ( $@ ) {
1562         $status = 'failed';
1563         $statustext = $@;
1564       } elsif ( $error ) {
1565         $status = 'done';
1566         $statustext = $error;
1567       } else {
1568         $status = 'done'
1569       }
1570
1571       #add cust_bill_event
1572       my $cust_bill_event = new FS::cust_bill_event {
1573         'invnum'     => $cust_bill->invnum,
1574         'eventpart'  => $part_bill_event->eventpart,
1575         #'_date'      => $invoice_time,
1576         '_date'      => time,
1577         'status'     => $status,
1578         'statustext' => $statustext,
1579       };
1580       $error = $cust_bill_event->insert;
1581       if ( $error ) {
1582         #$dbh->rollback if $oldAutoCommit;
1583         #return "error: $error";
1584
1585         # gah, even with transactions.
1586         $dbh->commit if $oldAutoCommit; #well.
1587         my $e = 'WARNING: Event run but database not updated - '.
1588                 'error inserting cust_bill_event, invnum #'. $cust_bill->invnum.
1589                 ', eventpart '. $part_bill_event->eventpart.
1590                 ": $error";
1591         warn $e;
1592         return $e;
1593       }
1594
1595
1596     }
1597
1598   }
1599
1600   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1601   '';
1602
1603 }
1604
1605 =item retry_realtime
1606
1607 Schedules realtime credit card / electronic check / LEC billing events for
1608 for retry.  Useful if card information has changed or manual retry is desired.
1609 The 'collect' method must be called to actually retry the transaction.
1610
1611 Implementation details: For each of this customer's open invoices, changes
1612 the status of the first "done" (with statustext error) realtime processing
1613 event to "failed".
1614
1615 =cut
1616
1617 sub retry_realtime {
1618   my $self = shift;
1619
1620   local $SIG{HUP} = 'IGNORE';
1621   local $SIG{INT} = 'IGNORE';
1622   local $SIG{QUIT} = 'IGNORE';
1623   local $SIG{TERM} = 'IGNORE';
1624   local $SIG{TSTP} = 'IGNORE';
1625   local $SIG{PIPE} = 'IGNORE';
1626
1627   my $oldAutoCommit = $FS::UID::AutoCommit;
1628   local $FS::UID::AutoCommit = 0;
1629   my $dbh = dbh;
1630
1631   foreach my $cust_bill (
1632     grep { $_->cust_bill_event }
1633       $self->open_cust_bill
1634   ) {
1635     my @cust_bill_event =
1636       sort { $a->part_bill_event->seconds <=> $b->part_bill_event->seconds }
1637         grep {
1638                #$_->part_bill_event->plan eq 'realtime-card'
1639                $_->part_bill_event->eventcode =~
1640                    /\$cust_bill\->realtime_(card|ach|lec)/
1641                  && $_->status eq 'done'
1642                  && $_->statustext
1643              }
1644           $cust_bill->cust_bill_event;
1645     next unless @cust_bill_event;
1646     my $error = $cust_bill_event[0]->retry;
1647     if ( $error ) {
1648       $dbh->rollback if $oldAutoCommit;
1649       return "error scheduling invoice event for retry: $error";
1650     }
1651
1652   }
1653
1654   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1655   '';
1656
1657 }
1658
1659 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
1660
1661 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
1662 via a Business::OnlinePayment realtime gateway.  See
1663 L<http://420.am/business-onlinepayment> for supported gateways.
1664
1665 Available methods are: I<CC>, I<ECHECK> and I<LEC>
1666
1667 Available options are: I<description>, I<invnum>, I<quiet>
1668
1669 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
1670 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
1671 if set, will override the value from the customer record.
1672
1673 I<description> is a free-text field passed to the gateway.  It defaults to
1674 "Internet services".
1675
1676 If an I<invnum> is specified, this payment (if sucessful) is applied to the
1677 specified invoice.  If you don't specify an I<invnum> you might want to
1678 call the B<apply_payments> method.
1679
1680 I<quiet> can be set true to surpress email decline notices.
1681
1682 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
1683
1684 =cut
1685
1686 sub realtime_bop {
1687   my( $self, $method, $amount, %options ) = @_;
1688   if ( $DEBUG ) {
1689     warn "$self $method $amount\n";
1690     warn "  $_ => $options{$_}\n" foreach keys %options;
1691   }
1692
1693   $options{'description'} ||= 'Internet services';
1694
1695   #pre-requisites
1696   die "Real-time processing not enabled\n"
1697     unless $conf->exists('business-onlinepayment');
1698   eval "use Business::OnlinePayment";
1699   die $@ if $@;
1700
1701   #overrides
1702   $self->set( $_ => $options{$_} )
1703     foreach grep { exists($options{$_}) }
1704             qw( payname address1 address2 city state zip payinfo paydate );
1705
1706   #load up config
1707   my $bop_config = 'business-onlinepayment';
1708   $bop_config .= '-ach'
1709     if $method eq 'ECHECK' && $conf->exists($bop_config. '-ach');
1710   my ( $processor, $login, $password, $action, @bop_options ) =
1711     $conf->config($bop_config);
1712   $action ||= 'normal authorization';
1713   pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
1714
1715   #massage data
1716
1717   my $address = $self->address1;
1718   $address .= ", ". $self->address2 if $self->address2;
1719
1720   my($payname, $payfirst, $paylast);
1721   if ( $self->payname && $method ne 'ECHECK' ) {
1722     $payname = $self->payname;
1723     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
1724       or return "Illegal payname $payname";
1725     ($payfirst, $paylast) = ($1, $2);
1726   } else {
1727     $payfirst = $self->getfield('first');
1728     $paylast = $self->getfield('last');
1729     $payname =  "$payfirst $paylast";
1730   }
1731
1732   my @invoicing_list = grep { $_ ne 'POST' } $self->invoicing_list;
1733   if ( $conf->exists('emailinvoiceauto')
1734        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
1735     push @invoicing_list, $self->all_emails;
1736   }
1737   my $email = $invoicing_list[0];
1738
1739   my %content;
1740   if ( $method eq 'CC' ) {
1741
1742     $content{card_number} = $self->payinfo;
1743     $self->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
1744     $content{expiration} = "$2/$1";
1745
1746     $content{cvv2} = $self->paycvv
1747       if defined $self->dbdef_table->column('paycvv')
1748          && length($self->paycvv);
1749
1750     $content{recurring_billing} = 'YES'
1751       if qsearch('cust_pay', { 'custnum' => $self->custnum,
1752                                'payby'   => 'CARD',
1753                                'payinfo' => $self->payinfo, } );
1754
1755   } elsif ( $method eq 'ECHECK' ) {
1756     my($account_number,$routing_code) = $self->payinfo;
1757     ( $content{account_number}, $content{routing_code} ) =
1758       split('@', $self->payinfo);
1759     $content{bank_name} = $self->payname;
1760     $content{account_type} = 'CHECKING';
1761     $content{account_name} = $payname;
1762     $content{customer_org} = $self->company ? 'B' : 'I';
1763     $content{customer_ssn} = $self->ss;
1764   } elsif ( $method eq 'LEC' ) {
1765     $content{phone} = $self->payinfo;
1766   }
1767
1768   #transaction(s)
1769
1770   my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
1771
1772   my $transaction =
1773     new Business::OnlinePayment( $processor, @bop_options );
1774   $transaction->content(
1775     'type'           => $method,
1776     'login'          => $login,
1777     'password'       => $password,
1778     'action'         => $action1,
1779     'description'    => $options{'description'},
1780     'amount'         => $amount,
1781     'invoice_number' => $options{'invnum'},
1782     'customer_id'    => $self->custnum,
1783     'last_name'      => $paylast,
1784     'first_name'     => $payfirst,
1785     'name'           => $payname,
1786     'address'        => $address,
1787     'city'           => $self->city,
1788     'state'          => $self->state,
1789     'zip'            => $self->zip,
1790     'country'        => $self->country,
1791     'referer'        => 'http://cleanwhisker.420.am/',
1792     'email'          => $email,
1793     'phone'          => $self->daytime || $self->night,
1794     %content, #after
1795   );
1796   $transaction->submit();
1797
1798   if ( $transaction->is_success() && $action2 ) {
1799     my $auth = $transaction->authorization;
1800     my $ordernum = $transaction->can('order_number')
1801                    ? $transaction->order_number
1802                    : '';
1803
1804     my $capture =
1805       new Business::OnlinePayment( $processor, @bop_options );
1806
1807     my %capture = (
1808       %content,
1809       type           => $method,
1810       action         => $action2,
1811       login          => $login,
1812       password       => $password,
1813       order_number   => $ordernum,
1814       amount         => $amount,
1815       authorization  => $auth,
1816       description    => $options{'description'},
1817     );
1818
1819     foreach my $field (qw( authorization_source_code returned_ACI                                          transaction_identifier validation_code
1820                            transaction_sequence_num local_transaction_date
1821                            local_transaction_time AVS_result_code          )) {
1822       $capture{$field} = $transaction->$field() if $transaction->can($field);
1823     }
1824
1825     $capture->content( %capture );
1826
1827     $capture->submit();
1828
1829     unless ( $capture->is_success ) {
1830       my $e = "Authorization sucessful but capture failed, custnum #".
1831               $self->custnum. ': '.  $capture->result_code.
1832               ": ". $capture->error_message;
1833       warn $e;
1834       return $e;
1835     }
1836
1837   }
1838
1839   #remove paycvv after initial transaction
1840   #make this disable-able via a config option if anyone insists?
1841   # (though that probably violates cardholder agreements)
1842   if ( defined $self->dbdef_table->column('paycvv')
1843        && length($self->paycvv)
1844        && ! grep { $_ eq cardtype($self->payinfo) } $conf->config('cvv-save')
1845   ) {
1846     my $new = new FS::cust_main { $self->hash };
1847     $new->paycvv('');
1848     my $error = $new->replace($self);
1849     if ( $error ) {
1850       warn "error removing cvv: $error\n";
1851     }
1852   }
1853
1854   #result handling
1855   if ( $transaction->is_success() ) {
1856
1857     my %method2payby = (
1858       'CC'     => 'CARD',
1859       'ECHECK' => 'CHEK',
1860       'LEC'    => 'LECB',
1861     );
1862
1863     my $cust_pay = new FS::cust_pay ( {
1864        'custnum'  => $self->custnum,
1865        'invnum'   => $options{'invnum'},
1866        'paid'     => $amount,
1867        '_date'     => '',
1868        'payby'    => $method2payby{$method},
1869        'payinfo'  => $self->payinfo,
1870        'paybatch' => "$processor:". $transaction->authorization,
1871     } );
1872     my $error = $cust_pay->insert;
1873     if ( $error ) {
1874       # gah, even with transactions.
1875       my $e = 'WARNING: Card/ACH debited but database not updated - '.
1876               'error applying payment, invnum #' . $self->invnum.
1877               " ($processor): $error";
1878       warn $e;
1879       return $e;
1880     } else {
1881       return '';
1882     }
1883
1884   } else {
1885
1886     my $perror = "$processor error: ". $transaction->error_message;
1887
1888     if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
1889          && $conf->exists('emaildecline')
1890          && grep { $_ ne 'POST' } $self->invoicing_list
1891          && ! grep { $_ eq $transaction->error_message }
1892                    $conf->config('emaildecline-exclude')
1893     ) {
1894       my @templ = $conf->config('declinetemplate');
1895       my $template = new Text::Template (
1896         TYPE   => 'ARRAY',
1897         SOURCE => [ map "$_\n", @templ ],
1898       ) or return "($perror) can't create template: $Text::Template::ERROR";
1899       $template->compile()
1900         or return "($perror) can't compile template: $Text::Template::ERROR";
1901
1902       my $templ_hash = { error => $transaction->error_message };
1903
1904       my $error = send_email(
1905         'from'    => $conf->config('invoice_from'),
1906         'to'      => [ grep { $_ ne 'POST' } $self->invoicing_list ],
1907         'subject' => 'Your payment could not be processed',
1908         'body'    => [ $template->fill_in(HASH => $templ_hash) ],
1909       );
1910
1911       $perror .= " (also received error sending decline notification: $error)"
1912         if $error;
1913
1914     }
1915
1916     return $perror;
1917   }
1918
1919 }
1920
1921 =item total_owed
1922
1923 Returns the total owed for this customer on all invoices
1924 (see L<FS::cust_bill/owed>).
1925
1926 =cut
1927
1928 sub total_owed {
1929   my $self = shift;
1930   $self->total_owed_date(2145859200); #12/31/2037
1931 }
1932
1933 =item total_owed_date TIME
1934
1935 Returns the total owed for this customer on all invoices with date earlier than
1936 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
1937 see L<Time::Local> and L<Date::Parse> for conversion functions.
1938
1939 =cut
1940
1941 sub total_owed_date {
1942   my $self = shift;
1943   my $time = shift;
1944   my $total_bill = 0;
1945   foreach my $cust_bill (
1946     grep { $_->_date <= $time }
1947       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
1948   ) {
1949     $total_bill += $cust_bill->owed;
1950   }
1951   sprintf( "%.2f", $total_bill );
1952 }
1953
1954 =item apply_credits
1955
1956 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1957 to outstanding invoice balances in chronological order and returns the value
1958 of any remaining unapplied credits available for refund
1959 (see L<FS::cust_refund>).
1960
1961 =cut
1962
1963 sub apply_credits {
1964   my $self = shift;
1965
1966   return 0 unless $self->total_credited;
1967
1968   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1969       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1970
1971   my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
1972       qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
1973
1974   my $credit;
1975
1976   foreach my $cust_bill ( @invoices ) {
1977     my $amount;
1978
1979     if ( !defined($credit) || $credit->credited == 0) {
1980       $credit = pop @credits or last;
1981     }
1982
1983     if ($cust_bill->owed >= $credit->credited) {
1984       $amount=$credit->credited;
1985     }else{
1986       $amount=$cust_bill->owed;
1987     }
1988
1989     my $cust_credit_bill = new FS::cust_credit_bill ( {
1990       'crednum' => $credit->crednum,
1991       'invnum'  => $cust_bill->invnum,
1992       'amount'  => $amount,
1993     } );
1994     my $error = $cust_credit_bill->insert;
1995     die $error if $error;
1996
1997     redo if ($cust_bill->owed > 0);
1998
1999   }
2000
2001   return $self->total_credited;
2002 }
2003
2004 =item apply_payments
2005
2006 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
2007 to outstanding invoice balances in chronological order.
2008
2009  #and returns the value of any remaining unapplied payments.
2010
2011 =cut
2012
2013 sub apply_payments {
2014   my $self = shift;
2015
2016   #return 0 unless
2017
2018   my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
2019       qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
2020
2021   my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
2022       qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
2023
2024   my $payment;
2025
2026   foreach my $cust_bill ( @invoices ) {
2027     my $amount;
2028
2029     if ( !defined($payment) || $payment->unapplied == 0 ) {
2030       $payment = pop @payments or last;
2031     }
2032
2033     if ( $cust_bill->owed >= $payment->unapplied ) {
2034       $amount = $payment->unapplied;
2035     } else {
2036       $amount = $cust_bill->owed;
2037     }
2038
2039     my $cust_bill_pay = new FS::cust_bill_pay ( {
2040       'paynum' => $payment->paynum,
2041       'invnum' => $cust_bill->invnum,
2042       'amount' => $amount,
2043     } );
2044     my $error = $cust_bill_pay->insert;
2045     die $error if $error;
2046
2047     redo if ( $cust_bill->owed > 0);
2048
2049   }
2050
2051   return $self->total_unapplied_payments;
2052 }
2053
2054 =item total_credited
2055
2056 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2057 customer.  See L<FS::cust_credit/credited>.
2058
2059 =cut
2060
2061 sub total_credited {
2062   my $self = shift;
2063   my $total_credit = 0;
2064   foreach my $cust_credit ( qsearch('cust_credit', {
2065     'custnum' => $self->custnum,
2066   } ) ) {
2067     $total_credit += $cust_credit->credited;
2068   }
2069   sprintf( "%.2f", $total_credit );
2070 }
2071
2072 =item total_unapplied_payments
2073
2074 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2075 See L<FS::cust_pay/unapplied>.
2076
2077 =cut
2078
2079 sub total_unapplied_payments {
2080   my $self = shift;
2081   my $total_unapplied = 0;
2082   foreach my $cust_pay ( qsearch('cust_pay', {
2083     'custnum' => $self->custnum,
2084   } ) ) {
2085     $total_unapplied += $cust_pay->unapplied;
2086   }
2087   sprintf( "%.2f", $total_unapplied );
2088 }
2089
2090 =item balance
2091
2092 Returns the balance for this customer (total_owed minus total_credited
2093 minus total_unapplied_payments).
2094
2095 =cut
2096
2097 sub balance {
2098   my $self = shift;
2099   sprintf( "%.2f",
2100     $self->total_owed - $self->total_credited - $self->total_unapplied_payments
2101   );
2102 }
2103
2104 =item balance_date TIME
2105
2106 Returns the balance for this customer, only considering invoices with date
2107 earlier than TIME (total_owed_date minus total_credited minus
2108 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
2109 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
2110 functions.
2111
2112 =cut
2113
2114 sub balance_date {
2115   my $self = shift;
2116   my $time = shift;
2117   sprintf( "%.2f",
2118     $self->total_owed_date($time)
2119       - $self->total_credited
2120       - $self->total_unapplied_payments
2121   );
2122 }
2123
2124 =item invoicing_list [ ARRAYREF ]
2125
2126 If an arguement is given, sets these email addresses as invoice recipients
2127 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
2128 (except as warnings), so use check_invoicing_list first.
2129
2130 Returns a list of email addresses (with svcnum entries expanded).
2131
2132 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
2133 check it without disturbing anything by passing nothing.
2134
2135 This interface may change in the future.
2136
2137 =cut
2138
2139 sub invoicing_list {
2140   my( $self, $arrayref ) = @_;
2141   if ( $arrayref ) {
2142     my @cust_main_invoice;
2143     if ( $self->custnum ) {
2144       @cust_main_invoice =
2145         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
2146     } else {
2147       @cust_main_invoice = ();
2148     }
2149     foreach my $cust_main_invoice ( @cust_main_invoice ) {
2150       #warn $cust_main_invoice->destnum;
2151       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
2152         #warn $cust_main_invoice->destnum;
2153         my $error = $cust_main_invoice->delete;
2154         warn $error if $error;
2155       }
2156     }
2157     if ( $self->custnum ) {
2158       @cust_main_invoice =
2159         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
2160     } else {
2161       @cust_main_invoice = ();
2162     }
2163     my %seen = map { $_->address => 1 } @cust_main_invoice;
2164     foreach my $address ( @{$arrayref} ) {
2165       next if exists $seen{$address} && $seen{$address};
2166       $seen{$address} = 1;
2167       my $cust_main_invoice = new FS::cust_main_invoice ( {
2168         'custnum' => $self->custnum,
2169         'dest'    => $address,
2170       } );
2171       my $error = $cust_main_invoice->insert;
2172       warn $error if $error;
2173     }
2174   }
2175   if ( $self->custnum ) {
2176     map { $_->address }
2177       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
2178   } else {
2179     ();
2180   }
2181 }
2182
2183 =item check_invoicing_list ARRAYREF
2184
2185 Checks these arguements as valid input for the invoicing_list method.  If there
2186 is an error, returns the error, otherwise returns false.
2187
2188 =cut
2189
2190 sub check_invoicing_list {
2191   my( $self, $arrayref ) = @_;
2192   foreach my $address ( @{$arrayref} ) {
2193     my $cust_main_invoice = new FS::cust_main_invoice ( {
2194       'custnum' => $self->custnum,
2195       'dest'    => $address,
2196     } );
2197     my $error = $self->custnum
2198                 ? $cust_main_invoice->check
2199                 : $cust_main_invoice->checkdest
2200     ;
2201     return $error if $error;
2202   }
2203   '';
2204 }
2205
2206 =item set_default_invoicing_list
2207
2208 Sets the invoicing list to all accounts associated with this customer,
2209 overwriting any previous invoicing list.
2210
2211 =cut
2212
2213 sub set_default_invoicing_list {
2214   my $self = shift;
2215   $self->invoicing_list($self->all_emails);
2216 }
2217
2218 =item all_emails
2219
2220 Returns the email addresses of all accounts provisioned for this customer.
2221
2222 =cut
2223
2224 sub all_emails {
2225   my $self = shift;
2226   my %list;
2227   foreach my $cust_pkg ( $self->all_pkgs ) {
2228     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
2229     my @svc_acct =
2230       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2231         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
2232           @cust_svc;
2233     $list{$_}=1 foreach map { $_->email } @svc_acct;
2234   }
2235   keys %list;
2236 }
2237
2238 =item invoicing_list_addpost
2239
2240 Adds postal invoicing to this customer.  If this customer is already configured
2241 to receive postal invoices, does nothing.
2242
2243 =cut
2244
2245 sub invoicing_list_addpost {
2246   my $self = shift;
2247   return if grep { $_ eq 'POST' } $self->invoicing_list;
2248   my @invoicing_list = $self->invoicing_list;
2249   push @invoicing_list, 'POST';
2250   $self->invoicing_list(\@invoicing_list);
2251 }
2252
2253 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
2254
2255 Returns an array of customers referred by this customer (referral_custnum set
2256 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
2257 customers referred by customers referred by this customer and so on, inclusive.
2258 The default behavior is DEPTH 1 (no recursion).
2259
2260 =cut
2261
2262 sub referral_cust_main {
2263   my $self = shift;
2264   my $depth = @_ ? shift : 1;
2265   my $exclude = @_ ? shift : {};
2266
2267   my @cust_main =
2268     map { $exclude->{$_->custnum}++; $_; }
2269       grep { ! $exclude->{ $_->custnum } }
2270         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
2271
2272   if ( $depth > 1 ) {
2273     push @cust_main,
2274       map { $_->referral_cust_main($depth-1, $exclude) }
2275         @cust_main;
2276   }
2277
2278   @cust_main;
2279 }
2280
2281 =item referral_cust_main_ncancelled
2282
2283 Same as referral_cust_main, except only returns customers with uncancelled
2284 packages.
2285
2286 =cut
2287
2288 sub referral_cust_main_ncancelled {
2289   my $self = shift;
2290   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
2291 }
2292
2293 =item referral_cust_pkg [ DEPTH ]
2294
2295 Like referral_cust_main, except returns a flat list of all unsuspended (and
2296 uncancelled) packages for each customer.  The number of items in this list may
2297 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
2298
2299 =cut
2300
2301 sub referral_cust_pkg {
2302   my $self = shift;
2303   my $depth = @_ ? shift : 1;
2304
2305   map { $_->unsuspended_pkgs }
2306     grep { $_->unsuspended_pkgs }
2307       $self->referral_cust_main($depth);
2308 }
2309
2310 =item credit AMOUNT, REASON
2311
2312 Applies a credit to this customer.  If there is an error, returns the error,
2313 otherwise returns false.
2314
2315 =cut
2316
2317 sub credit {
2318   my( $self, $amount, $reason ) = @_;
2319   my $cust_credit = new FS::cust_credit {
2320     'custnum' => $self->custnum,
2321     'amount'  => $amount,
2322     'reason'  => $reason,
2323   };
2324   $cust_credit->insert;
2325 }
2326
2327 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
2328
2329 Creates a one-time charge for this customer.  If there is an error, returns
2330 the error, otherwise returns false.
2331
2332 =cut
2333
2334 sub charge {
2335   my ( $self, $amount ) = ( shift, shift );
2336   my $pkg      = @_ ? shift : 'One-time charge';
2337   my $comment  = @_ ? shift : '$'. sprintf("%.2f",$amount);
2338   my $taxclass = @_ ? shift : '';
2339
2340   local $SIG{HUP} = 'IGNORE';
2341   local $SIG{INT} = 'IGNORE';
2342   local $SIG{QUIT} = 'IGNORE';
2343   local $SIG{TERM} = 'IGNORE';
2344   local $SIG{TSTP} = 'IGNORE';
2345   local $SIG{PIPE} = 'IGNORE';
2346
2347   my $oldAutoCommit = $FS::UID::AutoCommit;
2348   local $FS::UID::AutoCommit = 0;
2349   my $dbh = dbh;
2350
2351   my $part_pkg = new FS::part_pkg ( {
2352     'pkg'      => $pkg,
2353     'comment'  => $comment,
2354     'setup'    => $amount,
2355     'freq'     => 0,
2356     'recur'    => '0',
2357     'disabled' => 'Y',
2358     'taxclass' => $taxclass,
2359   } );
2360
2361   my $error = $part_pkg->insert;
2362   if ( $error ) {
2363     $dbh->rollback if $oldAutoCommit;
2364     return $error;
2365   }
2366
2367   my $pkgpart = $part_pkg->pkgpart;
2368   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
2369   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
2370     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
2371     $error = $type_pkgs->insert;
2372     if ( $error ) {
2373       $dbh->rollback if $oldAutoCommit;
2374       return $error;
2375     }
2376   }
2377
2378   my $cust_pkg = new FS::cust_pkg ( {
2379     'custnum' => $self->custnum,
2380     'pkgpart' => $pkgpart,
2381   } );
2382
2383   $error = $cust_pkg->insert;
2384   if ( $error ) {
2385     $dbh->rollback if $oldAutoCommit;
2386     return $error;
2387   }
2388
2389   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2390   '';
2391
2392 }
2393
2394 =item cust_bill
2395
2396 Returns all the invoices (see L<FS::cust_bill>) for this customer.
2397
2398 =cut
2399
2400 sub cust_bill {
2401   my $self = shift;
2402   sort { $a->_date <=> $b->_date }
2403     qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2404 }
2405
2406 =item open_cust_bill
2407
2408 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
2409 customer.
2410
2411 =cut
2412
2413 sub open_cust_bill {
2414   my $self = shift;
2415   grep { $_->owed > 0 } $self->cust_bill;
2416 }
2417
2418 =item cust_credit
2419
2420 Returns all the credits (see L<FS::cust_credit>) for this customer.
2421
2422 =cut
2423
2424 sub cust_credit {
2425   my $self = shift;
2426   sort { $a->_date <=> $b->_date }
2427     qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
2428 }
2429
2430 =item cust_pay
2431
2432 Returns all the payments (see L<FS::cust_pay>) for this customer.
2433
2434 =cut
2435
2436 sub cust_pay {
2437   my $self = shift;
2438   sort { $a->_date <=> $b->_date }
2439     qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
2440 }
2441
2442 =item cust_refund
2443
2444 Returns all the refunds (see L<FS::cust_refund>) for this customer.
2445
2446 =cut
2447
2448 sub cust_refund {
2449   my $self = shift;
2450   sort { $a->_date <=> $b->_date }
2451     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
2452 }
2453
2454 =back
2455
2456 =head1 SUBROUTINES
2457
2458 =over 4
2459
2460 =item check_and_rebuild_fuzzyfiles
2461
2462 =cut
2463
2464 sub check_and_rebuild_fuzzyfiles {
2465   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
2466   -e "$dir/cust_main.last" && -e "$dir/cust_main.company"
2467     or &rebuild_fuzzyfiles;
2468 }
2469
2470 =item rebuild_fuzzyfiles
2471
2472 =cut
2473
2474 sub rebuild_fuzzyfiles {
2475
2476   use Fcntl qw(:flock);
2477
2478   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
2479
2480   #last
2481
2482   open(LASTLOCK,">>$dir/cust_main.last")
2483     or die "can't open $dir/cust_main.last: $!";
2484   flock(LASTLOCK,LOCK_EX)
2485     or die "can't lock $dir/cust_main.last: $!";
2486
2487   my @all_last = map $_->getfield('last'), qsearch('cust_main', {});
2488   push @all_last,
2489                  grep $_, map $_->getfield('ship_last'), qsearch('cust_main',{})
2490     if defined dbdef->table('cust_main')->column('ship_last');
2491
2492   open (LASTCACHE,">$dir/cust_main.last.tmp")
2493     or die "can't open $dir/cust_main.last.tmp: $!";
2494   print LASTCACHE join("\n", @all_last), "\n";
2495   close LASTCACHE or die "can't close $dir/cust_main.last.tmp: $!";
2496
2497   rename "$dir/cust_main.last.tmp", "$dir/cust_main.last";
2498   close LASTLOCK;
2499
2500   #company
2501
2502   open(COMPANYLOCK,">>$dir/cust_main.company")
2503     or die "can't open $dir/cust_main.company: $!";
2504   flock(COMPANYLOCK,LOCK_EX)
2505     or die "can't lock $dir/cust_main.company: $!";
2506
2507   my @all_company = grep $_ ne '', map $_->company, qsearch('cust_main',{});
2508   push @all_company,
2509        grep $_ ne '', map $_->ship_company, qsearch('cust_main', {})
2510     if defined dbdef->table('cust_main')->column('ship_last');
2511
2512   open (COMPANYCACHE,">$dir/cust_main.company.tmp")
2513     or die "can't open $dir/cust_main.company.tmp: $!";
2514   print COMPANYCACHE join("\n", @all_company), "\n";
2515   close COMPANYCACHE or die "can't close $dir/cust_main.company.tmp: $!";
2516
2517   rename "$dir/cust_main.company.tmp", "$dir/cust_main.company";
2518   close COMPANYLOCK;
2519
2520 }
2521
2522 =item all_last
2523
2524 =cut
2525
2526 sub all_last {
2527   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
2528   open(LASTCACHE,"<$dir/cust_main.last")
2529     or die "can't open $dir/cust_main.last: $!";
2530   my @array = map { chomp; $_; } <LASTCACHE>;
2531   close LASTCACHE;
2532   \@array;
2533 }
2534
2535 =item all_company
2536
2537 =cut
2538
2539 sub all_company {
2540   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
2541   open(COMPANYCACHE,"<$dir/cust_main.company")
2542     or die "can't open $dir/cust_main.last: $!";
2543   my @array = map { chomp; $_; } <COMPANYCACHE>;
2544   close COMPANYCACHE;
2545   \@array;
2546 }
2547
2548 =item append_fuzzyfiles LASTNAME COMPANY
2549
2550 =cut
2551
2552 sub append_fuzzyfiles {
2553   my( $last, $company ) = @_;
2554
2555   &check_and_rebuild_fuzzyfiles;
2556
2557   use Fcntl qw(:flock);
2558
2559   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
2560
2561   if ( $last ) {
2562
2563     open(LAST,">>$dir/cust_main.last")
2564       or die "can't open $dir/cust_main.last: $!";
2565     flock(LAST,LOCK_EX)
2566       or die "can't lock $dir/cust_main.last: $!";
2567
2568     print LAST "$last\n";
2569
2570     flock(LAST,LOCK_UN)
2571       or die "can't unlock $dir/cust_main.last: $!";
2572     close LAST;
2573   }
2574
2575   if ( $company ) {
2576
2577     open(COMPANY,">>$dir/cust_main.company")
2578       or die "can't open $dir/cust_main.company: $!";
2579     flock(COMPANY,LOCK_EX)
2580       or die "can't lock $dir/cust_main.company: $!";
2581
2582     print COMPANY "$company\n";
2583
2584     flock(COMPANY,LOCK_UN)
2585       or die "can't unlock $dir/cust_main.company: $!";
2586
2587     close COMPANY;
2588   }
2589
2590   1;
2591 }
2592
2593 =item batch_import
2594
2595 =cut
2596
2597 sub batch_import {
2598   my $param = shift;
2599   #warn join('-',keys %$param);
2600   my $fh = $param->{filehandle};
2601   my $agentnum = $param->{agentnum};
2602   my $refnum = $param->{refnum};
2603   my $pkgpart = $param->{pkgpart};
2604   my @fields = @{$param->{fields}};
2605
2606   eval "use Date::Parse;";
2607   die $@ if $@;
2608   eval "use Text::CSV_XS;";
2609   die $@ if $@;
2610
2611   my $csv = new Text::CSV_XS;
2612   #warn $csv;
2613   #warn $fh;
2614
2615   my $imported = 0;
2616   #my $columns;
2617
2618   local $SIG{HUP} = 'IGNORE';
2619   local $SIG{INT} = 'IGNORE';
2620   local $SIG{QUIT} = 'IGNORE';
2621   local $SIG{TERM} = 'IGNORE';
2622   local $SIG{TSTP} = 'IGNORE';
2623   local $SIG{PIPE} = 'IGNORE';
2624
2625   my $oldAutoCommit = $FS::UID::AutoCommit;
2626   local $FS::UID::AutoCommit = 0;
2627   my $dbh = dbh;
2628
2629   #while ( $columns = $csv->getline($fh) ) {
2630   my $line;
2631   while ( defined($line=<$fh>) ) {
2632
2633     $csv->parse($line) or do {
2634       $dbh->rollback if $oldAutoCommit;
2635       return "can't parse: ". $csv->error_input();
2636     };
2637
2638     my @columns = $csv->fields();
2639     #warn join('-',@columns);
2640
2641     my %cust_main = (
2642       agentnum => $agentnum,
2643       refnum   => $refnum,
2644       country  => 'US', #default
2645       payby    => 'BILL', #default
2646       paydate  => '12/2037', #default
2647     );
2648     my $billtime = time;
2649     my %cust_pkg = ( pkgpart => $pkgpart );
2650     foreach my $field ( @fields ) {
2651       if ( $field =~ /^cust_pkg\.(setup|bill|susp|expire|cancel)$/ ) {
2652         #$cust_pkg{$1} = str2time( shift @$columns );
2653         if ( $1 eq 'setup' ) {
2654           $billtime = str2time(shift @columns);
2655         } else {
2656           $cust_pkg{$1} = str2time( shift @columns );
2657         }
2658       } else {
2659         #$cust_main{$field} = shift @$columns;
2660         $cust_main{$field} = shift @columns;
2661       }
2662     }
2663
2664     my $cust_pkg = new FS::cust_pkg ( \%cust_pkg ) if $pkgpart;
2665     my $cust_main = new FS::cust_main ( \%cust_main );
2666     use Tie::RefHash;
2667     tie my %hash, 'Tie::RefHash'; #this part is important
2668     $hash{$cust_pkg} = [] if $pkgpart;
2669     my $error = $cust_main->insert( \%hash );
2670
2671     if ( $error ) {
2672       $dbh->rollback if $oldAutoCommit;
2673       return "can't insert customer for $line: $error";
2674     }
2675
2676     #false laziness w/bill.cgi
2677     $error = $cust_main->bill( 'time' => $billtime );
2678     if ( $error ) {
2679       $dbh->rollback if $oldAutoCommit;
2680       return "can't bill customer for $line: $error";
2681     }
2682
2683     $cust_main->apply_payments;
2684     $cust_main->apply_credits;
2685
2686     $error = $cust_main->collect();
2687     if ( $error ) {
2688       $dbh->rollback if $oldAutoCommit;
2689       return "can't collect customer for $line: $error";
2690     }
2691
2692     $imported++;
2693   }
2694
2695   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2696
2697   return "Empty file!" unless $imported;
2698
2699   ''; #no error
2700
2701 }
2702
2703 =item batch_charge
2704
2705 =cut
2706
2707 sub batch_charge {
2708   my $param = shift;
2709   #warn join('-',keys %$param);
2710   my $fh = $param->{filehandle};
2711   my @fields = @{$param->{fields}};
2712
2713   eval "use Date::Parse;";
2714   die $@ if $@;
2715   eval "use Text::CSV_XS;";
2716   die $@ if $@;
2717
2718   my $csv = new Text::CSV_XS;
2719   #warn $csv;
2720   #warn $fh;
2721
2722   my $imported = 0;
2723   #my $columns;
2724
2725   local $SIG{HUP} = 'IGNORE';
2726   local $SIG{INT} = 'IGNORE';
2727   local $SIG{QUIT} = 'IGNORE';
2728   local $SIG{TERM} = 'IGNORE';
2729   local $SIG{TSTP} = 'IGNORE';
2730   local $SIG{PIPE} = 'IGNORE';
2731
2732   my $oldAutoCommit = $FS::UID::AutoCommit;
2733   local $FS::UID::AutoCommit = 0;
2734   my $dbh = dbh;
2735
2736   #while ( $columns = $csv->getline($fh) ) {
2737   my $line;
2738   while ( defined($line=<$fh>) ) {
2739
2740     $csv->parse($line) or do {
2741       $dbh->rollback if $oldAutoCommit;
2742       return "can't parse: ". $csv->error_input();
2743     };
2744
2745     my @columns = $csv->fields();
2746     #warn join('-',@columns);
2747
2748     my %row = ();
2749     foreach my $field ( @fields ) {
2750       $row{$field} = shift @columns;
2751     }
2752
2753     my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
2754     unless ( $cust_main ) {
2755       $dbh->rollback if $oldAutoCommit;
2756       return "unknown custnum $row{'custnum'}";
2757     }
2758
2759     if ( $row{'amount'} > 0 ) {
2760       my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
2761       if ( $error ) {
2762         $dbh->rollback if $oldAutoCommit;
2763         return $error;
2764       }
2765       $imported++;
2766     } elsif ( $row{'amount'} < 0 ) {
2767       my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
2768                                       $row{'pkg'}                         );
2769       if ( $error ) {
2770         $dbh->rollback if $oldAutoCommit;
2771         return $error;
2772       }
2773       $imported++;
2774     } else {
2775       #hmm?
2776     }
2777
2778   }
2779
2780   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2781
2782   return "Empty file!" unless $imported;
2783
2784   ''; #no error
2785
2786 }
2787
2788 =back
2789
2790 =head1 BUGS
2791
2792 The delete method.
2793
2794 The delete method should possibly take an FS::cust_main object reference
2795 instead of a scalar customer number.
2796
2797 Bill and collect options should probably be passed as references instead of a
2798 list.
2799
2800 There should probably be a configuration file with a list of allowed credit
2801 card types.
2802
2803 No multiple currency support (probably a larger project than just this module).
2804
2805 =head1 SEE ALSO
2806
2807 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
2808 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
2809 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
2810
2811 =cut
2812
2813 1;
2814