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         #my $cpt = new Safe;
 917         ##$cpt->permit(); #what is necessary?
 918         #$cpt->share(qw( $cust_pkg )); #can $cpt now use $cust_pkg methods?
 919         #$recur = $cpt->reval($recur_prog);
 920       $recur = eval $recur_prog;
 921       unless ( defined($recur) ) {
 922         $dbh->rollback if $oldAutoCommit;
 923         return "Error eval-ing part_pkg->recur pkgpart ".  $part_pkg->pkgpart.
 924                "(expression $recur_prog): $@";
 925       }
 926       #change this bit to use Date::Manip? CAREFUL with timezones (see
 927       # mailing list archive)
 928       #$sdate=$cust_pkg->bill || time;
 929       #$sdate=$cust_pkg->bill || $time;
 930       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
 931       my ($sec,$min,$hour,$mday,$mon,$year) =
 932         (localtime($sdate) )[0,1,2,3,4,5];
 933       $mon += $part_pkg->getfield('freq');
 934       until ( $mon < 12 ) { $mon -= 12; $year++; }
 935       $cust_pkg->setfield('bill',
 936         timelocal($sec,$min,$hour,$mday,$mon,$year));
 937       $cust_pkg_mod_flag = 1;
 938     }
 939
 940     warn "\$setup is undefined" unless defined($setup);
 941     warn "\$recur is undefined" unless defined($recur);
 942     warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
 943
 944     if ( $cust_pkg_mod_flag ) {
 945       $error=$cust_pkg->replace($old_cust_pkg);
 946       if ( $error ) { #just in case
 947         $dbh->rollback if $oldAutoCommit;
 948         return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
 949       }
 950       $setup = sprintf( "%.2f", $setup );
 951       $recur = sprintf( "%.2f", $recur );
 952       if ( $setup < 0 ) {
 953         $dbh->rollback if $oldAutoCommit;
 954         return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
 955       }
 956       if ( $recur < 0 ) {
 957         $dbh->rollback if $oldAutoCommit;
 958         return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
 959       }
 960       if ( $setup > 0 || $recur > 0 ) {
 961         my $cust_bill_pkg = new FS::cust_bill_pkg ({
 962           'pkgnum' => $cust_pkg->pkgnum,
 963           'setup'  => $setup,
 964           'recur'  => $recur,
 965           'sdate'  => $sdate,
 966           'edate'  => $cust_pkg->bill,
 967         });
 968         push @cust_bill_pkg, $cust_bill_pkg;
 969         $total_setup += $setup;
 970         $total_recur += $recur;
 971         $taxable_setup += $setup
 972           unless $part_pkg->dbdef_table->column('setuptax')
 973                  || $part_pkg->setuptax =~ /^Y$/i;
 974         $taxable_recur += $recur
 975           unless $part_pkg->dbdef_table->column('recurtax')
 976                  || $part_pkg->recurtax =~ /^Y$/i;
 977       }
 978     }
 979
 980   }
 981
 982   my $charged = sprintf( "%.2f", $total_setup + $total_recur );
 983   my $taxable_charged = sprintf( "%.2f", $taxable_setup + $taxable_recur );
 984
 985   unless ( @cust_bill_pkg ) {
 986     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 987     return '';
 988   }
 989
 990   unless ( $self->tax =~ /Y/i
 991            || $self->payby eq 'COMP'
 992            || $taxable_charged == 0 ) {
 993     my $cust_main_county = qsearchs('cust_main_county',{
 994         'state'   => $self->state,
 995         'county'  => $self->county,
 996         'country' => $self->country,
 997     } );
 998     my $tax = sprintf( "%.2f",
 999       $taxable_charged * ( $cust_main_county->getfield('tax') / 100 )
1000     );
1001
1002     if ( $tax > 0 ) {
1003       $charged = sprintf( "%.2f", $charged+$tax );
1004
1005       my $cust_bill_pkg = new FS::cust_bill_pkg ({
1006         'pkgnum' => 0,
1007         'setup'  => $tax,
1008         'recur'  => 0,
1009         'sdate'  => '',
1010         'edate'  => '',
1011       });
1012       push @cust_bill_pkg, $cust_bill_pkg;
1013     }
1014   }
1015
1016   my $cust_bill = new FS::cust_bill ( {
1017     'custnum' => $self->custnum,
1018     '_date'   => $time,
1019     'charged' => $charged,
1020   } );
1021   $error = $cust_bill->insert;
1022   if ( $error ) {
1023     $dbh->rollback if $oldAutoCommit;
1024     return "can't create invoice for customer #". $self->custnum. ": $error";
1025   }
1026
1027   my $invnum = $cust_bill->invnum;
1028   my $cust_bill_pkg;
1029   foreach $cust_bill_pkg ( @cust_bill_pkg ) {
1030     #warn $invnum;
1031     $cust_bill_pkg->invnum($invnum);
1032     $error = $cust_bill_pkg->insert;
1033     if ( $error ) {
1034       $dbh->rollback if $oldAutoCommit;
1035       return "can't create invoice line item for customer #". $self->custnum.
1036              ": $error";
1037     }
1038   }
1039
1040   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1041   ''; #no error
1042 }
1043
1044 =item collect OPTIONS
1045
1046 (Attempt to) collect money for this customer's outstanding invoices (see
1047 L<FS::cust_bill>).  Usually used after the bill method.
1048
1049 Depending on the value of `payby', this may print an invoice (`BILL'), charge
1050 a credit card (`CARD'), or just add any necessary (pseudo-)payment (`COMP').
1051
1052 Most actions are now triggered by invoice events; see L<FS::part_bill_event>
1053 and the invoice events web interface.
1054
1055 If there is an error, returns the error, otherwise returns false.
1056
1057 Options are passed as name-value pairs.
1058
1059 Currently available options are:
1060
1061 invoice_time - Use this time when deciding when to print invoices and
1062 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>
1063 for conversion functions.
1064
1065 batch_card - This option is deprecated.  See the invoice events web interface
1066 to control whether cards are batched or run against a realtime gateway.
1067
1068 report_badcard - This option is deprecated.
1069
1070 force_print - This option is deprecated; see the invoice events web interface.
1071
1072 =cut
1073
1074 sub collect {
1075   my( $self, %options ) = @_;
1076   my $invoice_time = $options{'invoice_time'} || time;
1077
1078   #put below somehow?
1079   local $SIG{HUP} = 'IGNORE';
1080   local $SIG{INT} = 'IGNORE';
1081   local $SIG{QUIT} = 'IGNORE';
1082   local $SIG{TERM} = 'IGNORE';
1083   local $SIG{TSTP} = 'IGNORE';
1084   local $SIG{PIPE} = 'IGNORE';
1085
1086   my $oldAutoCommit = $FS::UID::AutoCommit;
1087   local $FS::UID::AutoCommit = 0;
1088   my $dbh = dbh;
1089
1090   my $balance = $self->balance;
1091   warn "collect: balance $balance" if $Debug;
1092   unless ( $balance > 0 ) { #redundant?????
1093     $dbh->rollback if $oldAutoCommit; #hmm
1094     return '';
1095   }
1096
1097   foreach my $cust_bill (
1098     qsearch('cust_bill', { 'custnum' => $self->custnum, } )
1099   ) {
1100
1101     #this has to be before next's
1102     my $amount = sprintf( "%.2f", $balance < $cust_bill->owed
1103                                   ? $balance
1104                                   : $cust_bill->owed
1105     );
1106     $balance = sprintf( "%.2f", $balance - $amount );
1107
1108     next unless $cust_bill->owed > 0;
1109
1110     # don't try to charge for the same invoice if it's already in a batch
1111     #next if qsearchs( 'cust_pay_batch', { 'invnum' => $cust_bill->invnum } );
1112
1113     warn "invnum ". $cust_bill->invnum. " (owed ". $cust_bill->owed. ", amount $amount, balance $balance)" if $Debug;
1114
1115     next unless $amount > 0;
1116
1117     foreach my $part_bill_event (
1118       sort {    $a->seconds   <=> $b->seconds
1119              || $a->weight    <=> $b->weight
1120              || $a->eventpart <=> $b->eventpart }
1121         grep { $_->seconds > ( $invoice_time - ( $cust_bill->_date || 0 ) )
1122                && ! qsearchs( 'cust_bill_event', {
1123                                 'invnum'    => $cust_bill->invnum,
1124                                 'eventpart' => $_->eventpart       } )
1125              }
1126           qsearch('part_bill_event', { 'payby'    => $self->payby,
1127                                        'disabled' => '',           } )
1128     ) {
1129       #run callback
1130       my $cust_main = $self; #for callback
1131       my $error = eval $part_bill_event->eventcode;
1132
1133       if ( $error ) {
1134
1135         warn "Error running invoice event (". $part_bill_event->eventcode.
1136              "): $error";
1137
1138       } else {
1139
1140         #add cust_bill_event
1141         my $cust_bill_event = new FS::cust_bill_event {
1142           'invnum'    => $cust_bill->invnum,
1143           'eventpart' => $part_bill_event->eventpart,
1144           '_date'     => $invoice_time,
1145         };
1146         $cust_bill_event->insert;
1147         if ( $error ) {
1148           #$dbh->rollback if $oldAutoCommit;
1149           #return "error: $error";
1150
1151           # gah, even with transactions.
1152           $dbh->commit if $oldAutoCommit; #well.
1153           my $e = 'WARNING: Event run but database not updated - '.
1154                   'error inserting cust_bill_event, invnum #'. $cust_bill->invnum.
1155                   ', eventpart '. $part_bill_event->eventpart.
1156                   ": $error";
1157           warn $e;
1158           return $e;
1159         }
1160
1161       }
1162
1163     }
1164
1165   }
1166
1167   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1168   '';
1169
1170 }
1171
1172 =item total_owed
1173
1174 Returns the total owed for this customer on all invoices
1175 (see L<FS::cust_bill/owed>).
1176
1177 =cut
1178
1179 sub total_owed {
1180   my $self = shift;
1181   $self->total_owed_date(2145859200); #12/31/2037
1182 }
1183
1184 =item total_owed_date TIME
1185
1186 Returns the total owed for this customer on all invoices with date earlier than
1187 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
1188 see L<Time::Local> and L<Date::Parse> for conversion functions.
1189
1190 =cut
1191
1192 sub total_owed_date {
1193   my $self = shift;
1194   my $time = shift;
1195   my $total_bill = 0;
1196   foreach my $cust_bill (
1197     grep { $_->_date <= $time }
1198       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
1199   ) {
1200     $total_bill += $cust_bill->owed;
1201   }
1202   sprintf( "%.2f", $total_bill );
1203 }
1204
1205 =item apply_credits
1206
1207 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1208 to outstanding invoice balances in chronological order and returns the value
1209 of any remaining unapplied credits available for refund
1210 (see L<FS::cust_refund>).
1211
1212 =cut
1213
1214 sub apply_credits {
1215   my $self = shift;
1216
1217   return 0 unless $self->total_credited;
1218
1219   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1220       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1221
1222   my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
1223       qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
1224
1225   my $credit;
1226
1227   foreach my $cust_bill ( @invoices ) {
1228     my $amount;
1229
1230     if ( !defined($credit) || $credit->credited == 0) {
1231       $credit = pop @credits or last;
1232     }
1233
1234     if ($cust_bill->owed >= $credit->credited) {
1235       $amount=$credit->credited;
1236     }else{
1237       $amount=$cust_bill->owed;
1238     }
1239
1240     my $cust_credit_bill = new FS::cust_credit_bill ( {
1241       'crednum' => $credit->crednum,
1242       'invnum'  => $cust_bill->invnum,
1243       'amount'  => $amount,
1244     } );
1245     my $error = $cust_credit_bill->insert;
1246     die $error if $error;
1247
1248     redo if ($cust_bill->owed > 0);
1249
1250   }
1251
1252   return $self->total_credited;
1253 }
1254
1255 =item apply_payments
1256
1257 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
1258 to outstanding invoice balances in chronological order.
1259
1260  #and returns the value of any remaining unapplied payments.
1261
1262 =cut
1263
1264 sub apply_payments {
1265   my $self = shift;
1266
1267   #return 0 unless
1268
1269   my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
1270       qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
1271
1272   my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
1273       qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
1274
1275   my $payment;
1276
1277   foreach my $cust_bill ( @invoices ) {
1278     my $amount;
1279
1280     if ( !defined($payment) || $payment->unapplied == 0 ) {
1281       $payment = pop @payments or last;
1282     }
1283
1284     if ( $cust_bill->owed >= $payment->unapplied ) {
1285       $amount = $payment->unapplied;
1286     } else {
1287       $amount = $cust_bill->owed;
1288     }
1289
1290     my $cust_bill_pay = new FS::cust_bill_pay ( {
1291       'paynum' => $payment->paynum,
1292       'invnum' => $cust_bill->invnum,
1293       'amount' => $amount,
1294     } );
1295     my $error = $cust_bill_pay->insert;
1296     die $error if $error;
1297
1298     redo if ( $cust_bill->owed > 0);
1299
1300   }
1301
1302   return $self->total_unapplied_payments;
1303 }
1304
1305 =item total_credited
1306
1307 Returns the total outstanding credit (see L<FS::cust_credit>) for this
1308 customer.  See L<FS::cust_credit/credited>.
1309
1310 =cut
1311
1312 sub total_credited {
1313   my $self = shift;
1314   my $total_credit = 0;
1315   foreach my $cust_credit ( qsearch('cust_credit', {
1316     'custnum' => $self->custnum,
1317   } ) ) {
1318     $total_credit += $cust_credit->credited;
1319   }
1320   sprintf( "%.2f", $total_credit );
1321 }
1322
1323 =item total_unapplied_payments
1324
1325 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
1326 See L<FS::cust_pay/unapplied>.
1327
1328 =cut
1329
1330 sub total_unapplied_payments {
1331   my $self = shift;
1332   my $total_unapplied = 0;
1333   foreach my $cust_pay ( qsearch('cust_pay', {
1334     'custnum' => $self->custnum,
1335   } ) ) {
1336     $total_unapplied += $cust_pay->unapplied;
1337   }
1338   sprintf( "%.2f", $total_unapplied );
1339 }
1340
1341 =item balance
1342
1343 Returns the balance for this customer (total_owed minus total_credited
1344 minus total_unapplied_payments).
1345
1346 =cut
1347
1348 sub balance {
1349   my $self = shift;
1350   sprintf( "%.2f",
1351     $self->total_owed - $self->total_credited - $self->total_unapplied_payments
1352   );
1353 }
1354
1355 =item balance_date TIME
1356
1357 Returns the balance for this customer, only considering invoices with date
1358 earlier than TIME (total_owed_date minus total_credited minus
1359 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
1360 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
1361 functions.
1362
1363 =cut
1364
1365 sub balance_date {
1366   my $self = shift;
1367   my $time = shift;
1368   sprintf( "%.2f",
1369     $self->total_owed_date($time)
1370       - $self->total_credited
1371       - $self->total_unapplied_payments
1372   );
1373 }
1374
1375 =item invoicing_list [ ARRAYREF ]
1376
1377 If an arguement is given, sets these email addresses as invoice recipients
1378 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
1379 (except as warnings), so use check_invoicing_list first.
1380
1381 Returns a list of email addresses (with svcnum entries expanded).
1382
1383 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
1384 check it without disturbing anything by passing nothing.
1385
1386 This interface may change in the future.
1387
1388 =cut
1389
1390 sub invoicing_list {
1391   my( $self, $arrayref ) = @_;
1392   if ( $arrayref ) {
1393     my @cust_main_invoice;
1394     if ( $self->custnum ) {
1395       @cust_main_invoice =
1396         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
1397     } else {
1398       @cust_main_invoice = ();
1399     }
1400     foreach my $cust_main_invoice ( @cust_main_invoice ) {
1401       #warn $cust_main_invoice->destnum;
1402       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
1403         #warn $cust_main_invoice->destnum;
1404         my $error = $cust_main_invoice->delete;
1405         warn $error if $error;
1406       }
1407     }
1408     if ( $self->custnum ) {
1409       @cust_main_invoice =
1410         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
1411     } else {
1412       @cust_main_invoice = ();
1413     }
1414     my %seen = map { $_->address => 1 } @cust_main_invoice;
1415     foreach my $address ( @{$arrayref} ) {
1416       #unless ( grep { $address eq $_->address } @cust_main_invoice ) {
1417       next if exists $seen{$address} && $seen{$address};
1418       $seen{$address} = 1;
1419       my $cust_main_invoice = new FS::cust_main_invoice ( {
1420         'custnum' => $self->custnum,
1421         'dest'    => $address,
1422       } );
1423       my $error = $cust_main_invoice->insert;
1424       warn $error if $error;
1425     }
1426   }
1427   if ( $self->custnum ) {
1428     map { $_->address }
1429       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
1430   } else {
1431     ();
1432   }
1433 }
1434
1435 =item check_invoicing_list ARRAYREF
1436
1437 Checks these arguements as valid input for the invoicing_list method.  If there
1438 is an error, returns the error, otherwise returns false.
1439
1440 =cut
1441
1442 sub check_invoicing_list {
1443   my( $self, $arrayref ) = @_;
1444   foreach my $address ( @{$arrayref} ) {
1445     my $cust_main_invoice = new FS::cust_main_invoice ( {
1446       'custnum' => $self->custnum,
1447       'dest'    => $address,
1448     } );
1449     my $error = $self->custnum
1450                 ? $cust_main_invoice->check
1451                 : $cust_main_invoice->checkdest
1452     ;
1453     return $error if $error;
1454   }
1455   '';
1456 }
1457
1458 =item default_invoicing_list
1459
1460 Sets the invoicing list to all accounts associated with this customer.
1461
1462 =cut
1463
1464 sub default_invoicing_list {
1465   my $self = shift;
1466   my @list = ();
1467   foreach my $cust_pkg ( $self->all_pkgs ) {
1468     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
1469     my @svc_acct =
1470       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
1471         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
1472           @cust_svc;
1473     push @list, map { $_->email } @svc_acct;
1474   }
1475   $self->invoicing_list(\@list);
1476 }
1477
1478 =item invoicing_list_addpost
1479
1480 Adds postal invoicing to this customer.  If this customer is already configured
1481 to receive postal invoices, does nothing.
1482
1483 =cut
1484
1485 sub invoicing_list_addpost {
1486   my $self = shift;
1487   return if grep { $_ eq 'POST' } $self->invoicing_list;
1488   my @invoicing_list = $self->invoicing_list;
1489   push @invoicing_list, 'POST';
1490   $self->invoicing_list(\@invoicing_list);
1491 }
1492
1493 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
1494
1495 Returns an array of customers referred by this customer (referral_custnum set
1496 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
1497 customers referred by customers referred by this customer and so on, inclusive.
1498 The default behavior is DEPTH 1 (no recursion).
1499
1500 =cut
1501
1502 sub referral_cust_main {
1503   my $self = shift;
1504   my $depth = @_ ? shift : 1;
1505   my $exclude = @_ ? shift : {};
1506
1507   my @cust_main =
1508     map { $exclude->{$_->custnum}++; $_; }
1509       grep { ! $exclude->{ $_->custnum } }
1510         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
1511
1512   if ( $depth > 1 ) {
1513     push @cust_main,
1514       map { $_->referral_cust_main($depth-1, $exclude) }
1515         @cust_main;
1516   }
1517
1518   @cust_main;
1519 }
1520
1521 =item referral_cust_pkg [ DEPTH ]
1522
1523 Like referral_cust_main, except returns a flat list of all unsuspended packages
1524 for each customer.  The number of items in this list may be useful for
1525 comission calculations (perhaps after a grep).
1526
1527 =cut
1528
1529 sub referral_cust_pkg {
1530   my $self = shift;
1531   my $depth = @_ ? shift : 1;
1532
1533   map { $_->unsuspended_pkgs }
1534     grep { $_->unsuspended_pkgs }
1535       $self->referral_cust_main($depth);
1536 }
1537
1538 =item credit AMOUNT, REASON
1539
1540 Applies a credit to this customer.  If there is an error, returns the error,
1541 otherwise returns false.
1542
1543 =cut
1544
1545 sub credit {
1546   my( $self, $amount, $reason ) = @_;
1547   my $cust_credit = new FS::cust_credit {
1548     'custnum' => $self->custnum,
1549     'amount'  => $amount,
1550     'reason'  => $reason,
1551   };
1552   $cust_credit->insert;
1553 }
1554
1555 =item charge AMOUNT PKG COMMENT
1556
1557 Creates a one-time charge for this customer.  If there is an error, returns
1558 the error, otherwise returns false.
1559
1560 =cut
1561
1562 sub charge {
1563   my ( $self, $amount, $pkg, $comment ) = @_;
1564
1565   my $part_pkg = new FS::part_pkg ( {
1566     'pkg'      => $pkg || 'One-time charge',
1567     'comment'  => $comment,
1568     'setup'    => $amount,
1569     'freq'     => 0,
1570     'recur'    => '0',
1571     'disabled' => 'Y',
1572   } );
1573
1574   $part_pkg->insert;
1575
1576 }
1577
1578 =back
1579
1580 =head1 SUBROUTINES
1581
1582 =over 4
1583
1584 =item check_and_rebuild_fuzzyfiles
1585
1586 =cut
1587
1588 sub check_and_rebuild_fuzzyfiles {
1589   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1590   -e "$dir/cust_main.last" && -e "$dir/cust_main.company"
1591     or &rebuild_fuzzyfiles;
1592 }
1593
1594 =item rebuild_fuzzyfiles
1595
1596 =cut
1597
1598 sub rebuild_fuzzyfiles {
1599
1600   use Fcntl qw(:flock);
1601
1602   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1603
1604   #last
1605
1606   open(LASTLOCK,">>$dir/cust_main.last")
1607     or die "can't open $dir/cust_main.last: $!";
1608   flock(LASTLOCK,LOCK_EX)
1609     or die "can't lock $dir/cust_main.last: $!";
1610
1611   my @all_last = map $_->getfield('last'), qsearch('cust_main', {});
1612   push @all_last,
1613                  grep $_, map $_->getfield('ship_last'), qsearch('cust_main',{})
1614     if defined dbdef->table('cust_main')->column('ship_last');
1615
1616   open (LASTCACHE,">$dir/cust_main.last.tmp")
1617     or die "can't open $dir/cust_main.last.tmp: $!";
1618   print LASTCACHE join("\n", @all_last), "\n";
1619   close LASTCACHE or die "can't close $dir/cust_main.last.tmp: $!";
1620
1621   rename "$dir/cust_main.last.tmp", "$dir/cust_main.last";
1622   close LASTLOCK;
1623
1624   #company
1625
1626   open(COMPANYLOCK,">>$dir/cust_main.company")
1627     or die "can't open $dir/cust_main.company: $!";
1628   flock(COMPANYLOCK,LOCK_EX)
1629     or die "can't lock $dir/cust_main.company: $!";
1630
1631   my @all_company = grep $_ ne '', map $_->company, qsearch('cust_main',{});
1632   push @all_company,
1633        grep $_ ne '', map $_->ship_company, qsearch('cust_main', {})
1634     if defined dbdef->table('cust_main')->column('ship_last');
1635
1636   open (COMPANYCACHE,">$dir/cust_main.company.tmp")
1637     or die "can't open $dir/cust_main.company.tmp: $!";
1638   print COMPANYCACHE join("\n", @all_company), "\n";
1639   close COMPANYCACHE or die "can't close $dir/cust_main.company.tmp: $!";
1640
1641   rename "$dir/cust_main.company.tmp", "$dir/cust_main.company";
1642   close COMPANYLOCK;
1643
1644 }
1645
1646 =item all_last
1647
1648 =cut
1649
1650 sub all_last {
1651   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1652   open(LASTCACHE,"<$dir/cust_main.last")
1653     or die "can't open $dir/cust_main.last: $!";
1654   my @array = map { chomp; $_; } <LASTCACHE>;
1655   close LASTCACHE;
1656   \@array;
1657 }
1658
1659 =item all_company
1660
1661 =cut
1662
1663 sub all_company {
1664   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1665   open(COMPANYCACHE,"<$dir/cust_main.company")
1666     or die "can't open $dir/cust_main.last: $!";
1667   my @array = map { chomp; $_; } <COMPANYCACHE>;
1668   close COMPANYCACHE;
1669   \@array;
1670 }
1671
1672 =item append_fuzzyfiles LASTNAME COMPANY
1673
1674 =cut
1675
1676 sub append_fuzzyfiles {
1677   my( $last, $company ) = @_;
1678
1679   &check_and_rebuild_fuzzyfiles;
1680
1681   use Fcntl qw(:flock);
1682
1683   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1684
1685   if ( $last ) {
1686
1687     open(LAST,">>$dir/cust_main.last")
1688       or die "can't open $dir/cust_main.last: $!";
1689     flock(LAST,LOCK_EX)
1690       or die "can't lock $dir/cust_main.last: $!";
1691
1692     print LAST "$last\n";
1693
1694     flock(LAST,LOCK_UN)
1695       or die "can't unlock $dir/cust_main.last: $!";
1696     close LAST;
1697   }
1698
1699   if ( $company ) {
1700
1701     open(COMPANY,">>$dir/cust_main.company")
1702       or die "can't open $dir/cust_main.company: $!";
1703     flock(COMPANY,LOCK_EX)
1704       or die "can't lock $dir/cust_main.company: $!";
1705
1706     print COMPANY "$company\n";
1707
1708     flock(COMPANY,LOCK_UN)
1709       or die "can't unlock $dir/cust_main.company: $!";
1710
1711     close COMPANY;
1712   }
1713
1714   1;
1715 }
1716
1717 =head1 BUGS
1718
1719 The delete method.
1720
1721 The delete method should possibly take an FS::cust_main object reference
1722 instead of a scalar customer number.
1723
1724 Bill and collect options should probably be passed as references instead of a
1725 list.
1726
1727 There should probably be a configuration file with a list of allowed credit
1728 card types.
1729
1730 No multiple currency support (probably a larger project than just this module).
1731
1732 =head1 SEE ALSO
1733
1734 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
1735 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
1736 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
1737
1738 =cut
1739
1740 1;
1741
1742