FS/FS/cust_main.pm

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