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