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   #warn "BEFORE: \n". $self->_dump;
 516
 517   my $error =
 518     $self->ut_numbern('custnum')
 519     || $self->ut_number('agentnum')
 520     || $self->ut_number('refnum')
 521     || $self->ut_name('last')
 522     || $self->ut_name('first')
 523     || $self->ut_textn('company')
 524     || $self->ut_text('address1')
 525     || $self->ut_textn('address2')
 526     || $self->ut_text('city')
 527     || $self->ut_textn('county')
 528     || $self->ut_textn('state')
 529     || $self->ut_country('country')
 530     || $self->ut_anything('comments')
 531     || $self->ut_numbern('referral_custnum')
 532   ;
 533   #barf.  need message catalogs.  i18n.  etc.
 534   $error .= "Please select a referral."
 535     if $error =~ /^Illegal or empty \(numeric\) refnum: /;
 536   return $error if $error;
 537
 538   return "Unknown agent"
 539     unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
 540
 541   return "Unknown referral"
 542     unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
 543
 544   return "Unknown referring custnum ". $self->referral_custnum
 545     unless ! $self->referral_custnum
 546            || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
 547
 548   if ( $self->ss eq '' ) {
 549     $self->ss('');
 550   } else {
 551     my $ss = $self->ss;
 552     $ss =~ s/\D//g;
 553     $ss =~ /^(\d{3})(\d{2})(\d{4})$/
 554       or return "Illegal social security number: ". $self->ss;
 555     $self->ss("$1-$2-$3");
 556   }
 557
 558
 559 # bad idea to disable, causes billing to fail because of no tax rates later
 560 #  unless ( $import ) {
 561     unless ( qsearchs('cust_main_county', {
 562       'country' => $self->country,
 563       'state'   => '',
 564      } ) ) {
 565       return "Unknown state/county/country: ".
 566         $self->state. "/". $self->county. "/". $self->country
 567         unless qsearchs('cust_main_county',{
 568           'state'   => $self->state,
 569           'county'  => $self->county,
 570           'country' => $self->country,
 571         } );
 572     }
 573 #  }
 574
 575   $error =
 576     $self->ut_phonen('daytime', $self->country)
 577     || $self->ut_phonen('night', $self->country)
 578     || $self->ut_phonen('fax', $self->country)
 579     || $self->ut_zip('zip', $self->country)
 580   ;
 581   return $error if $error;
 582
 583   my @addfields = qw(
 584     last first company address1 address2 city county state zip
 585     country daytime night fax
 586   );
 587
 588   if ( defined $self->dbdef_table->column('ship_last') ) {
 589     if ( scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
 590                        @addfields )
 591          && scalar ( grep { $self->getfield("ship_$_") ne '' } @addfields )
 592        )
 593     {
 594       my $error =
 595         $self->ut_name('ship_last')
 596         || $self->ut_name('ship_first')
 597         || $self->ut_textn('ship_company')
 598         || $self->ut_text('ship_address1')
 599         || $self->ut_textn('ship_address2')
 600         || $self->ut_text('ship_city')
 601         || $self->ut_textn('ship_county')
 602         || $self->ut_textn('ship_state')
 603         || $self->ut_country('ship_country')
 604       ;
 605       return $error if $error;
 606
 607       #false laziness with above
 608       unless ( qsearchs('cust_main_county', {
 609         'country' => $self->ship_country,
 610         'state'   => '',
 611        } ) ) {
 612         return "Unknown ship_state/ship_county/ship_country: ".
 613           $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
 614           unless qsearchs('cust_main_county',{
 615             'state'   => $self->ship_state,
 616             'county'  => $self->ship_county,
 617             'country' => $self->ship_country,
 618           } );
 619       }
 620       #eofalse
 621
 622       $error =
 623         $self->ut_phonen('ship_daytime', $self->ship_country)
 624         || $self->ut_phonen('ship_night', $self->ship_country)
 625         || $self->ut_phonen('ship_fax', $self->ship_country)
 626         || $self->ut_zip('ship_zip', $self->ship_country)
 627       ;
 628       return $error if $error;
 629
 630     } else { # ship_ info eq billing info, so don't store dup info in database
 631       $self->setfield("ship_$_", '')
 632         foreach qw( last first company address1 address2 city county state zip
 633                     country daytime night fax );
 634     }
 635   }
 636
 637   $self->payby =~ /^(CARD|BILL|COMP|PREPAY)$/
 638     or return "Illegal payby: ". $self->payby;
 639   $self->payby($1);
 640
 641   if ( $self->payby eq 'CARD' ) {
 642
 643     my $payinfo = $self->payinfo;
 644     $payinfo =~ s/\D//g;
 645     $payinfo =~ /^(\d{13,16})$/
 646       or return "Illegal credit card number: ". $self->payinfo;
 647     $payinfo = $1;
 648     $self->payinfo($payinfo);
 649     validate($payinfo)
 650       or return "Illegal credit card number: ". $self->payinfo;
 651     return "Unknown card type" if cardtype($self->payinfo) eq "Unknown";
 652
 653   } elsif ( $self->payby eq 'BILL' ) {
 654
 655     $error = $self->ut_textn('payinfo');
 656     return "Illegal P.O. number: ". $self->payinfo if $error;
 657
 658   } elsif ( $self->payby eq 'COMP' ) {
 659
 660     $error = $self->ut_textn('payinfo');
 661     return "Illegal comp account issuer: ". $self->payinfo if $error;
 662
 663   } elsif ( $self->payby eq 'PREPAY' ) {
 664
 665     my $payinfo = $self->payinfo;
 666     $payinfo =~ s/\W//g; #anything else would just confuse things
 667     $self->payinfo($payinfo);
 668     $error = $self->ut_alpha('payinfo');
 669     return "Illegal prepayment identifier: ". $self->payinfo if $error;
 670     return "Unknown prepayment identifier"
 671       unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
 672
 673   }
 674
 675   if ( $self->paydate eq '' || $self->paydate eq '-' ) {
 676     return "Expriation date required"
 677       unless $self->payby eq 'BILL' || $self->payby eq 'PREPAY';
 678     $self->paydate('');
 679   } else {
 680     $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/
 681       or return "Illegal expiration date: ". $self->paydate;
 682     if ( length($2) == 4 ) {
 683       $self->paydate("$2-$1-01");
 684     } else {
 685       $self->paydate("20$2-$1-01");
 686     }
 687   }
 688
 689   if ( $self->payname eq '' ) {
 690     $self->payname( $self->first. " ". $self->getfield('last') );
 691   } else {
 692     $self->payname =~ /^([\w \,\.\-\']+)$/
 693       or return "Illegal billing name: ". $self->payname;
 694     $self->payname($1);
 695   }
 696
 697   $self->tax =~ /^(Y?)$/ or return "Illegal tax: ". $self->tax;
 698   $self->tax($1);
 699
 700   $self->otaker(getotaker);
 701
 702   #warn "AFTER: \n". $self->_dump;
 703
 704   ''; #no error
 705 }
 706
 707 =item all_pkgs
 708
 709 Returns all packages (see L<FS::cust_pkg>) for this customer.
 710
 711 =cut
 712
 713 sub all_pkgs {
 714   my $self = shift;
 715   if ( $self->{'_pkgnum'} ) {
 716     values %{ $self->{'_pkgnum'}->cache };
 717   } else {
 718     qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
 719   }
 720 }
 721
 722 =item ncancelled_pkgs
 723
 724 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
 725
 726 =cut
 727
 728 sub ncancelled_pkgs {
 729   my $self = shift;
 730   if ( $self->{'_pkgnum'} ) {
 731     grep { ! $_->getfield('cancel') } values %{ $self->{'_pkgnum'}->cache };
 732   } else {
 733     @{ [ # force list context
 734       qsearch( 'cust_pkg', {
 735         'custnum' => $self->custnum,
 736         'cancel'  => '',
 737       }),
 738       qsearch( 'cust_pkg', {
 739         'custnum' => $self->custnum,
 740         'cancel'  => 0,
 741       }),
 742     ] };
 743   }
 744 }
 745
 746 =item suspended_pkgs
 747
 748 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
 749
 750 =cut
 751
 752 sub suspended_pkgs {
 753   my $self = shift;
 754   grep { $_->susp } $self->ncancelled_pkgs;
 755 }
 756
 757 =item unflagged_suspended_pkgs
 758
 759 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
 760 customer (thouse packages without the `manual_flag' set).
 761
 762 =cut
 763
 764 sub unflagged_suspended_pkgs {
 765   my $self = shift;
 766   return $self->suspended_pkgs
 767     unless dbdef->table('cust_pkg')->column('manual_flag');
 768   grep { ! $_->manual_flag } $self->suspended_pkgs;
 769 }
 770
 771 =item unsuspended_pkgs
 772
 773 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
 774 this customer.
 775
 776 =cut
 777
 778 sub unsuspended_pkgs {
 779   my $self = shift;
 780   grep { ! $_->susp } $self->ncancelled_pkgs;
 781 }
 782
 783 =item unsuspend
 784
 785 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
 786 and L<FS::cust_pkg>) for this customer.  Always returns a list: an empty list
 787 on success or a list of errors.
 788
 789 =cut
 790
 791 sub unsuspend {
 792   my $self = shift;
 793   grep { $_->unsuspend } $self->suspended_pkgs;
 794 }
 795
 796 =item suspend
 797
 798 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
 799 Always returns a list: an empty list on success or a list of errors.
 800
 801 =cut
 802
 803 sub suspend {
 804   my $self = shift;
 805   grep { $_->suspend } $self->unsuspended_pkgs;
 806 }
 807
 808 =item cancel
 809
 810 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
 811 Always returns a list: an empty list on success or a list of errors.
 812
 813 =cut
 814
 815 sub cancel {
 816   my $self = shift;
 817   grep { $_->cancel } $self->ncancelled_pkgs;
 818 }
 819
 820 =item bill OPTIONS
 821
 822 Generates invoices (see L<FS::cust_bill>) for this customer.  Usually used in
 823 conjunction with the collect method.
 824
 825 Options are passed as name-value pairs.
 826
 827 The only currently available option is `time', which bills the customer as if
 828 it were that time.  It is specified as a UNIX timestamp; see
 829 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
 830 functions.  For example:
 831
 832  use Date::Parse;
 833  ...
 834  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
 835
 836 If there is an error, returns the error, otherwise returns false.
 837
 838 =cut
 839
 840 sub bill {
 841   my( $self, %options ) = @_;
 842   my $time = $options{'time'} || time;
 843
 844   my $error;
 845
 846   #put below somehow?
 847   local $SIG{HUP} = 'IGNORE';
 848   local $SIG{INT} = 'IGNORE';
 849   local $SIG{QUIT} = 'IGNORE';
 850   local $SIG{TERM} = 'IGNORE';
 851   local $SIG{TSTP} = 'IGNORE';
 852   local $SIG{PIPE} = 'IGNORE';
 853
 854   my $oldAutoCommit = $FS::UID::AutoCommit;
 855   local $FS::UID::AutoCommit = 0;
 856   my $dbh = dbh;
 857
 858   # find the packages which are due for billing, find out how much they are
 859   # & generate invoice database.
 860
 861   my( $total_setup, $total_recur ) = ( 0, 0 );
 862   my( $taxable_setup, $taxable_recur ) = ( 0, 0 );
 863   my @cust_bill_pkg = ();
 864
 865   foreach my $cust_pkg (
 866     qsearch('cust_pkg', { 'custnum' => $self->custnum } )
 867   ) {
 868
 869     #NO!! next if $cust_pkg->cancel;
 870     next if $cust_pkg->getfield('cancel');
 871
 872     #? to avoid use of uninitialized value errors... ?
 873     $cust_pkg->setfield('bill', '')
 874       unless defined($cust_pkg->bill);
 875
 876     my $part_pkg = qsearchs( 'part_pkg', { 'pkgpart' => $cust_pkg->pkgpart } );
 877
 878     #so we don't modify cust_pkg record unnecessarily
 879     my $cust_pkg_mod_flag = 0;
 880     my %hash = $cust_pkg->hash;
 881     my $old_cust_pkg = new FS::cust_pkg \%hash;
 882
 883     # bill setup
 884     my $setup = 0;
 885     unless ( $cust_pkg->setup ) {
 886       my $setup_prog = $part_pkg->getfield('setup');
 887       $setup_prog =~ /^(.*)$/ or do {
 888         $dbh->rollback if $oldAutoCommit;
 889         return "Illegal setup for pkgpart ". $part_pkg->pkgpart.
 890                ": $setup_prog";
 891       };
 892       $setup_prog = $1;
 893
 894         #my $cpt = new Safe;
 895         ##$cpt->permit(); #what is necessary?
 896         #$cpt->share(qw( $cust_pkg )); #can $cpt now use $cust_pkg methods?
 897         #$setup = $cpt->reval($setup_prog);
 898       $setup = eval $setup_prog;
 899       unless ( defined($setup) ) {
 900         $dbh->rollback if $oldAutoCommit;
 901         return "Error eval-ing part_pkg->setup pkgpart ". $part_pkg->pkgpart.
 902                "(expression $setup_prog): $@";
 903       }
 904       $cust_pkg->setfield('setup',$time);
 905       $cust_pkg_mod_flag=1;
 906     }
 907
 908     #bill recurring fee
 909     my $recur = 0;
 910     my $sdate;
 911     if ( $part_pkg->getfield('freq') > 0 &&
 912          ! $cust_pkg->getfield('susp') &&
 913          ( $cust_pkg->getfield('bill') || 0 ) < $time
 914     ) {
 915       my $recur_prog = $part_pkg->getfield('recur');
 916       $recur_prog =~ /^(.*)$/ or do {
 917         $dbh->rollback if $oldAutoCommit;
 918         return "Illegal recur for pkgpart ". $part_pkg->pkgpart.
 919                ": $recur_prog";
 920       };
 921       $recur_prog = $1;
 922
 923       # shared with $recur_prog
 924       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
 925
 926         #my $cpt = new Safe;
 927         ##$cpt->permit(); #what is necessary?
 928         #$cpt->share(qw( $cust_pkg )); #can $cpt now use $cust_pkg methods?
 929         #$recur = $cpt->reval($recur_prog);
 930       $recur = eval $recur_prog;
 931       unless ( defined($recur) ) {
 932         $dbh->rollback if $oldAutoCommit;
 933         return "Error eval-ing part_pkg->recur pkgpart ".  $part_pkg->pkgpart.
 934                "(expression $recur_prog): $@";
 935       }
 936       #change this bit to use Date::Manip? CAREFUL with timezones (see
 937       # mailing list archive)
 938       my ($sec,$min,$hour,$mday,$mon,$year) =
 939         (localtime($sdate) )[0,1,2,3,4,5];
 940
 941       #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
 942       # only for figuring next bill date, nothing else, so, reset $sdate again
 943       # here
 944       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
 945
 946       $mon += $part_pkg->getfield('freq');
 947       until ( $mon < 12 ) { $mon -= 12; $year++; }
 948       $cust_pkg->setfield('bill',
 949         timelocal($sec,$min,$hour,$mday,$mon,$year));
 950       $cust_pkg_mod_flag = 1;
 951     }
 952
 953     warn "\$setup is undefined" unless defined($setup);
 954     warn "\$recur is undefined" unless defined($recur);
 955     warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
 956
 957     if ( $cust_pkg_mod_flag ) {
 958       $error=$cust_pkg->replace($old_cust_pkg);
 959       if ( $error ) { #just in case
 960         $dbh->rollback if $oldAutoCommit;
 961         return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
 962       }
 963       $setup = sprintf( "%.2f", $setup );
 964       $recur = sprintf( "%.2f", $recur );
 965       if ( $setup < 0 ) {
 966         $dbh->rollback if $oldAutoCommit;
 967         return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
 968       }
 969       if ( $recur < 0 ) {
 970         $dbh->rollback if $oldAutoCommit;
 971         return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
 972       }
 973       if ( $setup > 0 || $recur > 0 ) {
 974         my $cust_bill_pkg = new FS::cust_bill_pkg ({
 975           'pkgnum' => $cust_pkg->pkgnum,
 976           'setup'  => $setup,
 977           'recur'  => $recur,
 978           'sdate'  => $sdate,
 979           'edate'  => $cust_pkg->bill,
 980         });
 981         push @cust_bill_pkg, $cust_bill_pkg;
 982         $total_setup += $setup;
 983         $total_recur += $recur;
 984         $taxable_setup += $setup
 985           unless $part_pkg->dbdef_table->column('setuptax')
 986                  && $part_pkg->setuptax =~ /^Y$/i;
 987         $taxable_recur += $recur
 988           unless $part_pkg->dbdef_table->column('recurtax')
 989                  && $part_pkg->recurtax =~ /^Y$/i;
 990       }
 991     }
 992
 993   }
 994
 995   my $charged = sprintf( "%.2f", $total_setup + $total_recur );
 996   my $taxable_charged = sprintf( "%.2f", $taxable_setup + $taxable_recur );
 997
 998   unless ( @cust_bill_pkg ) {
 999     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1000     return '';
1001   }
1002
1003   unless ( $self->tax =~ /Y/i
1004            || $self->payby eq 'COMP'
1005            || $taxable_charged == 0 ) {
1006     my $cust_main_county = qsearchs('cust_main_county',{
1007         'state'   => $self->state,
1008         'county'  => $self->county,
1009         'country' => $self->country,
1010     } ) or die "fatal: can't find tax rate for state/county/country ".
1011                $self->state. "/". $self->county. "/". $self->country. "\n";
1012     my $tax = sprintf( "%.2f",
1013       $taxable_charged * ( $cust_main_county->getfield('tax') / 100 )
1014     );
1015
1016     if ( $tax > 0 ) {
1017       $charged = sprintf( "%.2f", $charged+$tax );
1018
1019       my $cust_bill_pkg = new FS::cust_bill_pkg ({
1020         'pkgnum' => 0,
1021         'setup'  => $tax,
1022         'recur'  => 0,
1023         'sdate'  => '',
1024         'edate'  => '',
1025       });
1026       push @cust_bill_pkg, $cust_bill_pkg;
1027     }
1028   }
1029
1030   my $cust_bill = new FS::cust_bill ( {
1031     'custnum' => $self->custnum,
1032     '_date'   => $time,
1033     'charged' => $charged,
1034   } );
1035   $error = $cust_bill->insert;
1036   if ( $error ) {
1037     $dbh->rollback if $oldAutoCommit;
1038     return "can't create invoice for customer #". $self->custnum. ": $error";
1039   }
1040
1041   my $invnum = $cust_bill->invnum;
1042   my $cust_bill_pkg;
1043   foreach $cust_bill_pkg ( @cust_bill_pkg ) {
1044     #warn $invnum;
1045     $cust_bill_pkg->invnum($invnum);
1046     $error = $cust_bill_pkg->insert;
1047     if ( $error ) {
1048       $dbh->rollback if $oldAutoCommit;
1049       return "can't create invoice line item for customer #". $self->custnum.
1050              ": $error";
1051     }
1052   }
1053
1054   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1055   ''; #no error
1056 }
1057
1058 =item collect OPTIONS
1059
1060 (Attempt to) collect money for this customer's outstanding invoices (see
1061 L<FS::cust_bill>).  Usually used after the bill method.
1062
1063 Depending on the value of `payby', this may print an invoice (`BILL'), charge
1064 a credit card (`CARD'), or just add any necessary (pseudo-)payment (`COMP').
1065
1066 Most actions are now triggered by invoice events; see L<FS::part_bill_event>
1067 and the invoice events web interface.
1068
1069 If there is an error, returns the error, otherwise returns false.
1070
1071 Options are passed as name-value pairs.
1072
1073 Currently available options are:
1074
1075 invoice_time - Use this time when deciding when to print invoices and
1076 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>
1077 for conversion functions.
1078
1079 batch_card - This option is deprecated.  See the invoice events web interface
1080 to control whether cards are batched or run against a realtime gateway.
1081
1082 report_badcard - This option is deprecated.
1083
1084 force_print - This option is deprecated; see the invoice events web interface.
1085
1086 =cut
1087
1088 sub collect {
1089   my( $self, %options ) = @_;
1090   my $invoice_time = $options{'invoice_time'} || time;
1091
1092   #put below somehow?
1093   local $SIG{HUP} = 'IGNORE';
1094   local $SIG{INT} = 'IGNORE';
1095   local $SIG{QUIT} = 'IGNORE';
1096   local $SIG{TERM} = 'IGNORE';
1097   local $SIG{TSTP} = 'IGNORE';
1098   local $SIG{PIPE} = 'IGNORE';
1099
1100   my $oldAutoCommit = $FS::UID::AutoCommit;
1101   local $FS::UID::AutoCommit = 0;
1102   my $dbh = dbh;
1103
1104   my $balance = $self->balance;
1105   warn "collect customer". $self->custnum. ": balance $balance" if $Debug;
1106   unless ( $balance > 0 ) { #redundant?????
1107     $dbh->rollback if $oldAutoCommit; #hmm
1108     return '';
1109   }
1110
1111   foreach my $cust_bill (
1112     qsearch('cust_bill', { 'custnum' => $self->custnum, } )
1113   ) {
1114
1115     #this has to be before next's
1116     my $amount = sprintf( "%.2f", $balance < $cust_bill->owed
1117                                   ? $balance
1118                                   : $cust_bill->owed
1119     );
1120     $balance = sprintf( "%.2f", $balance - $amount );
1121
1122     next unless $cust_bill->owed > 0;
1123
1124     # don't try to charge for the same invoice if it's already in a batch
1125     #next if qsearchs( 'cust_pay_batch', { 'invnum' => $cust_bill->invnum } );
1126
1127     warn "invnum ". $cust_bill->invnum. " (owed ". $cust_bill->owed. ", amount $amount, balance $balance)" if $Debug;
1128
1129     next unless $amount > 0;
1130
1131     foreach my $part_bill_event (
1132       sort {    $a->seconds   <=> $b->seconds
1133              || $a->weight    <=> $b->weight
1134              || $a->eventpart <=> $b->eventpart }
1135         grep { $_->seconds <= ( $invoice_time - $cust_bill->_date )
1136                && ! qsearchs( 'cust_bill_event', {
1137                                 'invnum'    => $cust_bill->invnum,
1138                                 'eventpart' => $_->eventpart       } )
1139              }
1140           qsearch('part_bill_event', { 'payby'    => $self->payby,
1141                                        'disabled' => '',           } )
1142     ) {
1143       warn "calling invoice event (". $part_bill_event->eventcode. ")\n"
1144         if $Debug;
1145       my $cust_main = $self; #for callback
1146       my $error = eval $part_bill_event->eventcode;
1147
1148       if ( $@ ) {
1149         warn "fatal error running invoice event (". $part_bill_event->eventcode.
1150              "): $@";
1151       }
1152
1153       if ( $error ) {
1154
1155         warn "Error running invoice event (". $part_bill_event->eventcode.
1156              "): $error";
1157
1158       } else {
1159
1160         #add cust_bill_event
1161         my $cust_bill_event = new FS::cust_bill_event {
1162           'invnum'    => $cust_bill->invnum,
1163           'eventpart' => $part_bill_event->eventpart,
1164           '_date'     => $invoice_time,
1165         };
1166         $cust_bill_event->insert;
1167         if ( $error ) {
1168           #$dbh->rollback if $oldAutoCommit;
1169           #return "error: $error";
1170
1171           # gah, even with transactions.
1172           $dbh->commit if $oldAutoCommit; #well.
1173           my $e = 'WARNING: Event run but database not updated - '.
1174                   'error inserting cust_bill_event, invnum #'. $cust_bill->invnum.
1175                   ', eventpart '. $part_bill_event->eventpart.
1176                   ": $error";
1177           warn $e;
1178           return $e;
1179         }
1180
1181       }
1182
1183     }
1184
1185   }
1186
1187   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1188   '';
1189
1190 }
1191
1192 =item total_owed
1193
1194 Returns the total owed for this customer on all invoices
1195 (see L<FS::cust_bill/owed>).
1196
1197 =cut
1198
1199 sub total_owed {
1200   my $self = shift;
1201   $self->total_owed_date(2145859200); #12/31/2037
1202 }
1203
1204 =item total_owed_date TIME
1205
1206 Returns the total owed for this customer on all invoices with date earlier than
1207 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
1208 see L<Time::Local> and L<Date::Parse> for conversion functions.
1209
1210 =cut
1211
1212 sub total_owed_date {
1213   my $self = shift;
1214   my $time = shift;
1215   my $total_bill = 0;
1216   foreach my $cust_bill (
1217     grep { $_->_date <= $time }
1218       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
1219   ) {
1220     $total_bill += $cust_bill->owed;
1221   }
1222   sprintf( "%.2f", $total_bill );
1223 }
1224
1225 =item apply_credits
1226
1227 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
1228 to outstanding invoice balances in chronological order and returns the value
1229 of any remaining unapplied credits available for refund
1230 (see L<FS::cust_refund>).
1231
1232 =cut
1233
1234 sub apply_credits {
1235   my $self = shift;
1236
1237   return 0 unless $self->total_credited;
1238
1239   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
1240       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
1241
1242   my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
1243       qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
1244
1245   my $credit;
1246
1247   foreach my $cust_bill ( @invoices ) {
1248     my $amount;
1249
1250     if ( !defined($credit) || $credit->credited == 0) {
1251       $credit = pop @credits or last;
1252     }
1253
1254     if ($cust_bill->owed >= $credit->credited) {
1255       $amount=$credit->credited;
1256     }else{
1257       $amount=$cust_bill->owed;
1258     }
1259
1260     my $cust_credit_bill = new FS::cust_credit_bill ( {
1261       'crednum' => $credit->crednum,
1262       'invnum'  => $cust_bill->invnum,
1263       'amount'  => $amount,
1264     } );
1265     my $error = $cust_credit_bill->insert;
1266     die $error if $error;
1267
1268     redo if ($cust_bill->owed > 0);
1269
1270   }
1271
1272   return $self->total_credited;
1273 }
1274
1275 =item apply_payments
1276
1277 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
1278 to outstanding invoice balances in chronological order.
1279
1280  #and returns the value of any remaining unapplied payments.
1281
1282 =cut
1283
1284 sub apply_payments {
1285   my $self = shift;
1286
1287   #return 0 unless
1288
1289   my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
1290       qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
1291
1292   my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
1293       qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
1294
1295   my $payment;
1296
1297   foreach my $cust_bill ( @invoices ) {
1298     my $amount;
1299
1300     if ( !defined($payment) || $payment->unapplied == 0 ) {
1301       $payment = pop @payments or last;
1302     }
1303
1304     if ( $cust_bill->owed >= $payment->unapplied ) {
1305       $amount = $payment->unapplied;
1306     } else {
1307       $amount = $cust_bill->owed;
1308     }
1309
1310     my $cust_bill_pay = new FS::cust_bill_pay ( {
1311       'paynum' => $payment->paynum,
1312       'invnum' => $cust_bill->invnum,
1313       'amount' => $amount,
1314     } );
1315     my $error = $cust_bill_pay->insert;
1316     die $error if $error;
1317
1318     redo if ( $cust_bill->owed > 0);
1319
1320   }
1321
1322   return $self->total_unapplied_payments;
1323 }
1324
1325 =item total_credited
1326
1327 Returns the total outstanding credit (see L<FS::cust_credit>) for this
1328 customer.  See L<FS::cust_credit/credited>.
1329
1330 =cut
1331
1332 sub total_credited {
1333   my $self = shift;
1334   my $total_credit = 0;
1335   foreach my $cust_credit ( qsearch('cust_credit', {
1336     'custnum' => $self->custnum,
1337   } ) ) {
1338     $total_credit += $cust_credit->credited;
1339   }
1340   sprintf( "%.2f", $total_credit );
1341 }
1342
1343 =item total_unapplied_payments
1344
1345 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
1346 See L<FS::cust_pay/unapplied>.
1347
1348 =cut
1349
1350 sub total_unapplied_payments {
1351   my $self = shift;
1352   my $total_unapplied = 0;
1353   foreach my $cust_pay ( qsearch('cust_pay', {
1354     'custnum' => $self->custnum,
1355   } ) ) {
1356     $total_unapplied += $cust_pay->unapplied;
1357   }
1358   sprintf( "%.2f", $total_unapplied );
1359 }
1360
1361 =item balance
1362
1363 Returns the balance for this customer (total_owed minus total_credited
1364 minus total_unapplied_payments).
1365
1366 =cut
1367
1368 sub balance {
1369   my $self = shift;
1370   sprintf( "%.2f",
1371     $self->total_owed - $self->total_credited - $self->total_unapplied_payments
1372   );
1373 }
1374
1375 =item balance_date TIME
1376
1377 Returns the balance for this customer, only considering invoices with date
1378 earlier than TIME (total_owed_date minus total_credited minus
1379 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
1380 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
1381 functions.
1382
1383 =cut
1384
1385 sub balance_date {
1386   my $self = shift;
1387   my $time = shift;
1388   sprintf( "%.2f",
1389     $self->total_owed_date($time)
1390       - $self->total_credited
1391       - $self->total_unapplied_payments
1392   );
1393 }
1394
1395 =item invoicing_list [ ARRAYREF ]
1396
1397 If an arguement is given, sets these email addresses as invoice recipients
1398 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
1399 (except as warnings), so use check_invoicing_list first.
1400
1401 Returns a list of email addresses (with svcnum entries expanded).
1402
1403 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
1404 check it without disturbing anything by passing nothing.
1405
1406 This interface may change in the future.
1407
1408 =cut
1409
1410 sub invoicing_list {
1411   my( $self, $arrayref ) = @_;
1412   if ( $arrayref ) {
1413     my @cust_main_invoice;
1414     if ( $self->custnum ) {
1415       @cust_main_invoice =
1416         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
1417     } else {
1418       @cust_main_invoice = ();
1419     }
1420     foreach my $cust_main_invoice ( @cust_main_invoice ) {
1421       #warn $cust_main_invoice->destnum;
1422       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
1423         #warn $cust_main_invoice->destnum;
1424         my $error = $cust_main_invoice->delete;
1425         warn $error if $error;
1426       }
1427     }
1428     if ( $self->custnum ) {
1429       @cust_main_invoice =
1430         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
1431     } else {
1432       @cust_main_invoice = ();
1433     }
1434     my %seen = map { $_->address => 1 } @cust_main_invoice;
1435     foreach my $address ( @{$arrayref} ) {
1436       #unless ( grep { $address eq $_->address } @cust_main_invoice ) {
1437       next if exists $seen{$address} && $seen{$address};
1438       $seen{$address} = 1;
1439       my $cust_main_invoice = new FS::cust_main_invoice ( {
1440         'custnum' => $self->custnum,
1441         'dest'    => $address,
1442       } );
1443       my $error = $cust_main_invoice->insert;
1444       warn $error if $error;
1445     }
1446   }
1447   if ( $self->custnum ) {
1448     map { $_->address }
1449       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
1450   } else {
1451     ();
1452   }
1453 }
1454
1455 =item check_invoicing_list ARRAYREF
1456
1457 Checks these arguements as valid input for the invoicing_list method.  If there
1458 is an error, returns the error, otherwise returns false.
1459
1460 =cut
1461
1462 sub check_invoicing_list {
1463   my( $self, $arrayref ) = @_;
1464   foreach my $address ( @{$arrayref} ) {
1465     my $cust_main_invoice = new FS::cust_main_invoice ( {
1466       'custnum' => $self->custnum,
1467       'dest'    => $address,
1468     } );
1469     my $error = $self->custnum
1470                 ? $cust_main_invoice->check
1471                 : $cust_main_invoice->checkdest
1472     ;
1473     return $error if $error;
1474   }
1475   '';
1476 }
1477
1478 =item default_invoicing_list
1479
1480 Sets the invoicing list to all accounts associated with this customer.
1481
1482 =cut
1483
1484 sub default_invoicing_list {
1485   my $self = shift;
1486   my @list = ();
1487   foreach my $cust_pkg ( $self->all_pkgs ) {
1488     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
1489     my @svc_acct =
1490       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
1491         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
1492           @cust_svc;
1493     push @list, map { $_->email } @svc_acct;
1494   }
1495   $self->invoicing_list(\@list);
1496 }
1497
1498 =item invoicing_list_addpost
1499
1500 Adds postal invoicing to this customer.  If this customer is already configured
1501 to receive postal invoices, does nothing.
1502
1503 =cut
1504
1505 sub invoicing_list_addpost {
1506   my $self = shift;
1507   return if grep { $_ eq 'POST' } $self->invoicing_list;
1508   my @invoicing_list = $self->invoicing_list;
1509   push @invoicing_list, 'POST';
1510   $self->invoicing_list(\@invoicing_list);
1511 }
1512
1513 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
1514
1515 Returns an array of customers referred by this customer (referral_custnum set
1516 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
1517 customers referred by customers referred by this customer and so on, inclusive.
1518 The default behavior is DEPTH 1 (no recursion).
1519
1520 =cut
1521
1522 sub referral_cust_main {
1523   my $self = shift;
1524   my $depth = @_ ? shift : 1;
1525   my $exclude = @_ ? shift : {};
1526
1527   my @cust_main =
1528     map { $exclude->{$_->custnum}++; $_; }
1529       grep { ! $exclude->{ $_->custnum } }
1530         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
1531
1532   if ( $depth > 1 ) {
1533     push @cust_main,
1534       map { $_->referral_cust_main($depth-1, $exclude) }
1535         @cust_main;
1536   }
1537
1538   @cust_main;
1539 }
1540
1541 =item referral_cust_main_ncancelled
1542
1543 Same as referral_cust_main, except only returns customers with uncancelled
1544 packages.
1545
1546 =cut
1547
1548 sub referral_cust_main_ncancelled {
1549   my $self = shift;
1550   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
1551 }
1552
1553 =item referral_cust_pkg [ DEPTH ]
1554
1555 Like referral_cust_main, except returns a flat list of all unsuspended (and
1556 uncancelled) packages for each customer.  The number of items in this list may
1557 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
1558
1559 =cut
1560
1561 sub referral_cust_pkg {
1562   my $self = shift;
1563   my $depth = @_ ? shift : 1;
1564
1565   map { $_->unsuspended_pkgs }
1566     grep { $_->unsuspended_pkgs }
1567       $self->referral_cust_main($depth);
1568 }
1569
1570 =item credit AMOUNT, REASON
1571
1572 Applies a credit to this customer.  If there is an error, returns the error,
1573 otherwise returns false.
1574
1575 =cut
1576
1577 sub credit {
1578   my( $self, $amount, $reason ) = @_;
1579   my $cust_credit = new FS::cust_credit {
1580     'custnum' => $self->custnum,
1581     'amount'  => $amount,
1582     'reason'  => $reason,
1583   };
1584   $cust_credit->insert;
1585 }
1586
1587 =item charge AMOUNT PKG COMMENT
1588
1589 Creates a one-time charge for this customer.  If there is an error, returns
1590 the error, otherwise returns false.
1591
1592 =cut
1593
1594 sub charge {
1595   my ( $self, $amount, $pkg, $comment ) = @_;
1596
1597   my $part_pkg = new FS::part_pkg ( {
1598     'pkg'      => $pkg || 'One-time charge',
1599     'comment'  => $comment || '$'. sprintf("%.2f".$amount),
1600     'setup'    => $amount,
1601     'freq'     => 0,
1602     'recur'    => '0',
1603     'disabled' => 'Y',
1604   } );
1605
1606   $part_pkg->insert;
1607
1608 }
1609
1610 =back
1611
1612 =head1 SUBROUTINES
1613
1614 =over 4
1615
1616 =item check_and_rebuild_fuzzyfiles
1617
1618 =cut
1619
1620 sub check_and_rebuild_fuzzyfiles {
1621   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1622   -e "$dir/cust_main.last" && -e "$dir/cust_main.company"
1623     or &rebuild_fuzzyfiles;
1624 }
1625
1626 =item rebuild_fuzzyfiles
1627
1628 =cut
1629
1630 sub rebuild_fuzzyfiles {
1631
1632   use Fcntl qw(:flock);
1633
1634   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1635
1636   #last
1637
1638   open(LASTLOCK,">>$dir/cust_main.last")
1639     or die "can't open $dir/cust_main.last: $!";
1640   flock(LASTLOCK,LOCK_EX)
1641     or die "can't lock $dir/cust_main.last: $!";
1642
1643   my @all_last = map $_->getfield('last'), qsearch('cust_main', {});
1644   push @all_last,
1645                  grep $_, map $_->getfield('ship_last'), qsearch('cust_main',{})
1646     if defined dbdef->table('cust_main')->column('ship_last');
1647
1648   open (LASTCACHE,">$dir/cust_main.last.tmp")
1649     or die "can't open $dir/cust_main.last.tmp: $!";
1650   print LASTCACHE join("\n", @all_last), "\n";
1651   close LASTCACHE or die "can't close $dir/cust_main.last.tmp: $!";
1652
1653   rename "$dir/cust_main.last.tmp", "$dir/cust_main.last";
1654   close LASTLOCK;
1655
1656   #company
1657
1658   open(COMPANYLOCK,">>$dir/cust_main.company")
1659     or die "can't open $dir/cust_main.company: $!";
1660   flock(COMPANYLOCK,LOCK_EX)
1661     or die "can't lock $dir/cust_main.company: $!";
1662
1663   my @all_company = grep $_ ne '', map $_->company, qsearch('cust_main',{});
1664   push @all_company,
1665        grep $_ ne '', map $_->ship_company, qsearch('cust_main', {})
1666     if defined dbdef->table('cust_main')->column('ship_last');
1667
1668   open (COMPANYCACHE,">$dir/cust_main.company.tmp")
1669     or die "can't open $dir/cust_main.company.tmp: $!";
1670   print COMPANYCACHE join("\n", @all_company), "\n";
1671   close COMPANYCACHE or die "can't close $dir/cust_main.company.tmp: $!";
1672
1673   rename "$dir/cust_main.company.tmp", "$dir/cust_main.company";
1674   close COMPANYLOCK;
1675
1676 }
1677
1678 =item all_last
1679
1680 =cut
1681
1682 sub all_last {
1683   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1684   open(LASTCACHE,"<$dir/cust_main.last")
1685     or die "can't open $dir/cust_main.last: $!";
1686   my @array = map { chomp; $_; } <LASTCACHE>;
1687   close LASTCACHE;
1688   \@array;
1689 }
1690
1691 =item all_company
1692
1693 =cut
1694
1695 sub all_company {
1696   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1697   open(COMPANYCACHE,"<$dir/cust_main.company")
1698     or die "can't open $dir/cust_main.last: $!";
1699   my @array = map { chomp; $_; } <COMPANYCACHE>;
1700   close COMPANYCACHE;
1701   \@array;
1702 }
1703
1704 =item append_fuzzyfiles LASTNAME COMPANY
1705
1706 =cut
1707
1708 sub append_fuzzyfiles {
1709   my( $last, $company ) = @_;
1710
1711   &check_and_rebuild_fuzzyfiles;
1712
1713   use Fcntl qw(:flock);
1714
1715   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
1716
1717   if ( $last ) {
1718
1719     open(LAST,">>$dir/cust_main.last")
1720       or die "can't open $dir/cust_main.last: $!";
1721     flock(LAST,LOCK_EX)
1722       or die "can't lock $dir/cust_main.last: $!";
1723
1724     print LAST "$last\n";
1725
1726     flock(LAST,LOCK_UN)
1727       or die "can't unlock $dir/cust_main.last: $!";
1728     close LAST;
1729   }
1730
1731   if ( $company ) {
1732
1733     open(COMPANY,">>$dir/cust_main.company")
1734       or die "can't open $dir/cust_main.company: $!";
1735     flock(COMPANY,LOCK_EX)
1736       or die "can't lock $dir/cust_main.company: $!";
1737
1738     print COMPANY "$company\n";
1739
1740     flock(COMPANY,LOCK_UN)
1741       or die "can't unlock $dir/cust_main.company: $!";
1742
1743     close COMPANY;
1744   }
1745
1746   1;
1747 }
1748
1749 =back
1750
1751 =head1 BUGS
1752
1753 The delete method.
1754
1755 The delete method should possibly take an FS::cust_main object reference
1756 instead of a scalar customer number.
1757
1758 Bill and collect options should probably be passed as references instead of a
1759 list.
1760
1761 There should probably be a configuration file with a list of allowed credit
1762 card types.
1763
1764 No multiple currency support (probably a larger project than just this module).
1765
1766 =head1 SEE ALSO
1767
1768 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
1769 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
1770 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
1771
1772 =cut
1773
1774 1;
1775
1776