FS/FS/cust_main.pm

   1 package FS::cust_main;
   2
   3 use strict;
   4 use vars qw( @ISA @EXPORT_OK $DEBUG $me $conf @encrypted_fields
   5              $import $skip_fuzzyfiles $ignore_expired_card );
   6 use vars qw( $realtime_bop_decline_quiet ); #ugh
   7 use Safe;
   8 use Carp;
   9 use Exporter;
  10 BEGIN {
  11   eval "use Time::Local;";
  12   die "Time::Local minimum version 1.05 required with Perl versions before 5.6"
  13     if $] < 5.006 && !defined($Time::Local::VERSION);
  14   #eval "use Time::Local qw(timelocal timelocal_nocheck);";
  15   eval "use Time::Local qw(timelocal_nocheck);";
  16 }
  17 use Digest::MD5 qw(md5_base64);
  18 use Date::Format;
  19 use Date::Parse;
  20 #use Date::Manip;
  21 use String::Approx qw(amatch);
  22 use Business::CreditCard 0.28;
  23 use Locale::Country;
  24 use FS::UID qw( getotaker dbh );
  25 use FS::Record qw( qsearchs qsearch dbdef );
  26 use FS::Misc qw( send_email );
  27 use FS::Msgcat qw(gettext);
  28 use FS::cust_pkg;
  29 use FS::cust_svc;
  30 use FS::cust_bill;
  31 use FS::cust_bill_pkg;
  32 use FS::cust_pay;
  33 use FS::cust_pay_void;
  34 use FS::cust_credit;
  35 use FS::cust_refund;
  36 use FS::part_referral;
  37 use FS::cust_main_county;
  38 use FS::agent;
  39 use FS::cust_main_invoice;
  40 use FS::cust_credit_bill;
  41 use FS::cust_bill_pay;
  42 use FS::prepay_credit;
  43 use FS::queue;
  44 use FS::part_pkg;
  45 use FS::part_bill_event qw(due_events);
  46 use FS::cust_bill_event;
  47 use FS::cust_tax_exempt;
  48 use FS::cust_tax_exempt_pkg;
  49 use FS::type_pkgs;
  50 use FS::payment_gateway;
  51 use FS::agent_payment_gateway;
  52 use FS::banned_pay;
  53 use FS::payinfo_Mixin;
  54
  55 @ISA = qw( FS::Record FS::payinfo_Mixin );
  56
  57 @EXPORT_OK = qw( smart_search );
  58
  59 $realtime_bop_decline_quiet = 0;
  60
  61 # 1 is mostly method/subroutine entry and options
  62 # 2 traces progress of some operations
  63 # 3 is even more information including possibly sensitive data
  64 $DEBUG = 0;
  65 $me = '[FS::cust_main]';
  66
  67 $import = 0;
  68 $skip_fuzzyfiles = 0;
  69 $ignore_expired_card = 0;
  70
  71 @encrypted_fields = ('payinfo', 'paycvv');
  72
  73 #ask FS::UID to run this stuff for us later
  74 #$FS::UID::callback{'FS::cust_main'} = sub {
  75 install_callback FS::UID sub {
  76   $conf = new FS::Conf;
  77   #yes, need it for stuff below (prolly should be cached)
  78 };
  79
  80 sub _cache {
  81   my $self = shift;
  82   my ( $hashref, $cache ) = @_;
  83   if ( exists $hashref->{'pkgnum'} ) {
  84     #@{ $self->{'_pkgnum'} } = ();
  85     my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
  86     $self->{'_pkgnum'} = $subcache;
  87     #push @{ $self->{'_pkgnum'} },
  88     FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
  89   }
  90 }
  91
  92 =head1 NAME
  93
  94 FS::cust_main - Object methods for cust_main records
  95
  96 =head1 SYNOPSIS
  97
  98   use FS::cust_main;
  99
 100   $record = new FS::cust_main \%hash;
 101   $record = new FS::cust_main { 'column' => 'value' };
 102
 103   $error = $record->insert;
 104
 105   $error = $new_record->replace($old_record);
 106
 107   $error = $record->delete;
 108
 109   $error = $record->check;
 110
 111   @cust_pkg = $record->all_pkgs;
 112
 113   @cust_pkg = $record->ncancelled_pkgs;
 114
 115   @cust_pkg = $record->suspended_pkgs;
 116
 117   $error = $record->bill;
 118   $error = $record->bill %options;
 119   $error = $record->bill 'time' => $time;
 120
 121   $error = $record->collect;
 122   $error = $record->collect %options;
 123   $error = $record->collect 'invoice_time'   => $time,
 124                           ;
 125
 126 =head1 DESCRIPTION
 127
 128 An FS::cust_main object represents a customer.  FS::cust_main inherits from
 129 FS::Record.  The following fields are currently supported:
 130
 131 =over 4
 132
 133 =item custnum - primary key (assigned automatically for new customers)
 134
 135 =item agentnum - agent (see L<FS::agent>)
 136
 137 =item refnum - Advertising source (see L<FS::part_referral>)
 138
 139 =item first - name
 140
 141 =item last - name
 142
 143 =item ss - social security number (optional)
 144
 145 =item company - (optional)
 146
 147 =item address1
 148
 149 =item address2 - (optional)
 150
 151 =item city
 152
 153 =item county - (optional, see L<FS::cust_main_county>)
 154
 155 =item state - (see L<FS::cust_main_county>)
 156
 157 =item zip
 158
 159 =item country - (see L<FS::cust_main_county>)
 160
 161 =item daytime - phone (optional)
 162
 163 =item night - phone (optional)
 164
 165 =item fax - phone (optional)
 166
 167 =item ship_first - name
 168
 169 =item ship_last - name
 170
 171 =item ship_company - (optional)
 172
 173 =item ship_address1
 174
 175 =item ship_address2 - (optional)
 176
 177 =item ship_city
 178
 179 =item ship_county - (optional, see L<FS::cust_main_county>)
 180
 181 =item ship_state - (see L<FS::cust_main_county>)
 182
 183 =item ship_zip
 184
 185 =item ship_country - (see L<FS::cust_main_county>)
 186
 187 =item ship_daytime - phone (optional)
 188
 189 =item ship_night - phone (optional)
 190
 191 =item ship_fax - phone (optional)
 192
 193 =item payby - Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
 194
 195 =item payinfo - Payment Information (See L<FS::payinfo_Mixin> for data format)
 196
 197 =item paymask - Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
 198
 199 =item paycvv
 200
 201 Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card
 202
 203 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
 204
 205 =item paystart_month - start date month (maestro/solo cards only)
 206
 207 =item paystart_year - start date year (maestro/solo cards only)
 208
 209 =item payissue - issue number (maestro/solo cards only)
 210
 211 =item payname - name on card or billing name
 212
 213 =item payip - IP address from which payment information was received
 214
 215 =item tax - tax exempt, empty or `Y'
 216
 217 =item otaker - order taker (assigned automatically, see L<FS::UID>)
 218
 219 =item comments - comments (optional)
 220
 221 =item referral_custnum - referring customer number
 222
 223 =item spool_cdr - Enable individual CDR spooling, empty or `Y'
 224
 225 =back
 226
 227 =head1 METHODS
 228
 229 =over 4
 230
 231 =item new HASHREF
 232
 233 Creates a new customer.  To add the customer to the database, see L<"insert">.
 234
 235 Note that this stores the hash reference, not a distinct copy of the hash it
 236 points to.  You can ask the object for a copy with the I<hash> method.
 237
 238 =cut
 239
 240 sub table { 'cust_main'; }
 241
 242 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
 243
 244 Adds this customer to the database.  If there is an error, returns the error,
 245 otherwise returns false.
 246
 247 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
 248 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
 249 are inserted atomicly, or the transaction is rolled back.  Passing an empty
 250 hash reference is equivalent to not supplying this parameter.  There should be
 251 a better explanation of this, but until then, here's an example:
 252
 253   use Tie::RefHash;
 254   tie %hash, 'Tie::RefHash'; #this part is important
 255   %hash = (
 256     $cust_pkg => [ $svc_acct ],
 257     ...
 258   );
 259   $cust_main->insert( \%hash );
 260
 261 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
 262 be set as the invoicing list (see L<"invoicing_list">).  Errors return as
 263 expected and rollback the entire transaction; it is not necessary to call
 264 check_invoicing_list first.  The invoicing_list is set after the records in the
 265 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
 266 invoicing_list destination to the newly-created svc_acct.  Here's an example:
 267
 268   $cust_main->insert( {}, [ $email, 'POST' ] );
 269
 270 Currently available options are: I<depend_jobnum> and I<noexport>.
 271
 272 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
 273 on the supplied jobnum (they will not run until the specific job completes).
 274 This can be used to defer provisioning until some action completes (such
 275 as running the customer's credit card successfully).
 276
 277 The I<noexport> option is deprecated.  If I<noexport> is set true, no
 278 provisioning jobs (exports) are scheduled.  (You can schedule them later with
 279 the B<reexport> method.)
 280
 281 =cut
 282
 283 sub insert {
 284   my $self = shift;
 285   my $cust_pkgs = @_ ? shift : {};
 286   my $invoicing_list = @_ ? shift : '';
 287   my %options = @_;
 288   warn "$me insert called with options ".
 289        join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
 290     if $DEBUG;
 291
 292   local $SIG{HUP} = 'IGNORE';
 293   local $SIG{INT} = 'IGNORE';
 294   local $SIG{QUIT} = 'IGNORE';
 295   local $SIG{TERM} = 'IGNORE';
 296   local $SIG{TSTP} = 'IGNORE';
 297   local $SIG{PIPE} = 'IGNORE';
 298
 299   my $oldAutoCommit = $FS::UID::AutoCommit;
 300   local $FS::UID::AutoCommit = 0;
 301   my $dbh = dbh;
 302
 303   my $prepay_identifier = '';
 304   my( $amount, $seconds ) = ( 0, 0 );
 305   my $payby = '';
 306   if ( $self->payby eq 'PREPAY' ) {
 307
 308     $self->payby('BILL');
 309     $prepay_identifier = $self->payinfo;
 310     $self->payinfo('');
 311
 312     warn "  looking up prepaid card $prepay_identifier\n"
 313       if $DEBUG > 1;
 314
 315     my $error = $self->get_prepay($prepay_identifier, \$amount, \$seconds);
 316     if ( $error ) {
 317       $dbh->rollback if $oldAutoCommit;
 318       #return "error applying prepaid card (transaction rolled back): $error";
 319       return $error;
 320     }
 321
 322     $payby = 'PREP' if $amount;
 323
 324   } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
 325
 326     $payby = $1;
 327     $self->payby('BILL');
 328     $amount = $self->paid;
 329
 330   }
 331
 332   warn "  inserting $self\n"
 333     if $DEBUG > 1;
 334
 335   $self->signupdate(time) unless $self->signupdate;
 336
 337   my $error = $self->SUPER::insert;
 338   if ( $error ) {
 339     $dbh->rollback if $oldAutoCommit;
 340     #return "inserting cust_main record (transaction rolled back): $error";
 341     return $error;
 342   }
 343
 344   warn "  setting invoicing list\n"
 345     if $DEBUG > 1;
 346
 347   if ( $invoicing_list ) {
 348     $error = $self->check_invoicing_list( $invoicing_list );
 349     if ( $error ) {
 350       $dbh->rollback if $oldAutoCommit;
 351       return "checking invoicing_list (transaction rolled back): $error";
 352     }
 353     $self->invoicing_list( $invoicing_list );
 354   }
 355
 356   if (    $conf->config('cust_main-skeleton_tables')
 357        && $conf->config('cust_main-skeleton_custnum') ) {
 358
 359     warn "  inserting skeleton records\n"
 360       if $DEBUG > 1;
 361
 362     my $error = $self->start_copy_skel;
 363     if ( $error ) {
 364       $dbh->rollback if $oldAutoCommit;
 365       return $error;
 366     }
 367
 368   }
 369
 370   warn "  ordering packages\n"
 371     if $DEBUG > 1;
 372
 373   $error = $self->order_pkgs($cust_pkgs, \$seconds, %options);
 374   if ( $error ) {
 375     $dbh->rollback if $oldAutoCommit;
 376     return $error;
 377   }
 378
 379   if ( $seconds ) {
 380     $dbh->rollback if $oldAutoCommit;
 381     return "No svc_acct record to apply pre-paid time";
 382   }
 383
 384   if ( $amount ) {
 385     warn "  inserting initial $payby payment of $amount\n"
 386       if $DEBUG > 1;
 387     $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
 388     if ( $error ) {
 389       $dbh->rollback if $oldAutoCommit;
 390       return "inserting payment (transaction rolled back): $error";
 391     }
 392   }
 393
 394   unless ( $import || $skip_fuzzyfiles ) {
 395     warn "  queueing fuzzyfiles update\n"
 396       if $DEBUG > 1;
 397     $error = $self->queue_fuzzyfiles_update;
 398     if ( $error ) {
 399       $dbh->rollback if $oldAutoCommit;
 400       return "updating fuzzy search cache: $error";
 401     }
 402   }
 403
 404   warn "  insert complete; committing transaction\n"
 405     if $DEBUG > 1;
 406
 407   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 408   '';
 409
 410 }
 411
 412 sub start_copy_skel {
 413   my $self = shift;
 414
 415   #'mg_user_preference' => {},
 416   #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
 417   #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
 418   #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
 419   #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
 420   my @tables = eval($conf->config_binary('cust_main-skeleton_tables'));
 421   die $@ if $@;
 422
 423   _copy_skel( 'cust_main',                                 #tablename
 424               $conf->config('cust_main-skeleton_custnum'), #sourceid
 425               $self->custnum,                              #destid
 426               @tables,                                     #child tables
 427             );
 428 }
 429
 430 #recursive subroutine, not a method
 431 sub _copy_skel {
 432   my( $table, $sourceid, $destid, %child_tables ) = @_;
 433
 434   my $primary_key;
 435   if ( $table =~ /^(\w+)\.(\w+)$/ ) {
 436     ( $table, $primary_key ) = ( $1, $2 );
 437   } else {
 438     my $dbdef_table = dbdef->table($table);
 439     $primary_key = $dbdef_table->primary_key
 440       or return "$table has no primary key".
 441                 " (or do you need to run dbdef-create?)";
 442   }
 443
 444   warn "  _copy_skel: $table.$primary_key $sourceid to $destid for ".
 445        join (', ', keys %child_tables). "\n"
 446     if $DEBUG > 2;
 447
 448   foreach my $child_table_def ( keys %child_tables ) {
 449
 450     my $child_table;
 451     my $child_pkey = '';
 452     if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
 453       ( $child_table, $child_pkey ) = ( $1, $2 );
 454     } else {
 455       $child_table = $child_table_def;
 456
 457       $child_pkey = dbdef->table($child_table)->primary_key;
 458       #  or return "$table has no primary key".
 459       #            " (or do you need to run dbdef-create?)\n";
 460     }
 461
 462     my $sequence = '';
 463     if ( keys %{ $child_tables{$child_table_def} } ) {
 464
 465       return "$child_table has no primary key".
 466              " (run dbdef-create or try specifying it?)\n"
 467         unless $child_pkey;
 468
 469       #false laziness w/Record::insert and only works on Pg
 470       #refactor the proper last-inserted-id stuff out of Record::insert if this
 471       # ever gets use for anything besides a quick kludge for one customer
 472       my $default = dbdef->table($child_table)->column($child_pkey)->default;
 473       $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
 474         or return "can't parse $child_table.$child_pkey default value ".
 475                   " for sequence name: $default";
 476       $sequence = $1;
 477
 478     }
 479
 480     my @sel_columns = grep { $_ ne $primary_key }
 481                            dbdef->table($child_table)->columns;
 482     my $sel_columns = join(', ', @sel_columns );
 483
 484     my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
 485     my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
 486     my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
 487
 488     my $sel_st = "SELECT $sel_columns FROM $child_table".
 489                  " WHERE $primary_key = $sourceid";
 490     warn "    $sel_st\n"
 491       if $DEBUG > 2;
 492     my $sel_sth = dbh->prepare( $sel_st )
 493       or return dbh->errstr;
 494
 495     $sel_sth->execute or return $sel_sth->errstr;
 496
 497     while ( my $row = $sel_sth->fetchrow_hashref ) {
 498
 499       warn "    selected row: ".
 500            join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
 501         if $DEBUG > 2;
 502
 503       my $statement =
 504         "INSERT INTO $child_table $ins_columns VALUES $placeholders";
 505       my $ins_sth =dbh->prepare($statement)
 506           or return dbh->errstr;
 507       my @param = ( $destid, map $row->{$_}, @ins_columns );
 508       warn "    $statement: [ ". join(', ', @param). " ]\n"
 509         if $DEBUG > 2;
 510       $ins_sth->execute( @param )
 511         or return $ins_sth->errstr;
 512
 513       #next unless keys %{ $child_tables{$child_table} };
 514       next unless $sequence;
 515
 516       #another section of that laziness
 517       my $seq_sql = "SELECT currval('$sequence')";
 518       my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
 519       $seq_sth->execute or return $seq_sth->errstr;
 520       my $insertid = $seq_sth->fetchrow_arrayref->[0];
 521
 522       # don't drink soap!  recurse!  recurse!  okay!
 523       my $error =
 524         _copy_skel( $child_table_def,
 525                     $row->{$child_pkey}, #sourceid
 526                     $insertid, #destid
 527                     %{ $child_tables{$child_table_def} },
 528                   );
 529       return $error if $error;
 530
 531     }
 532
 533   }
 534
 535   return '';
 536
 537 }
 538
 539 =item order_pkgs HASHREF, [ SECONDSREF, [ , OPTION => VALUE ... ] ]
 540
 541 Like the insert method on an existing record, this method orders a package
 542 and included services atomicaly.  Pass a Tie::RefHash data structure to this
 543 method containing FS::cust_pkg and FS::svc_I<tablename> objects.  There should
 544 be a better explanation of this, but until then, here's an example:
 545
 546   use Tie::RefHash;
 547   tie %hash, 'Tie::RefHash'; #this part is important
 548   %hash = (
 549     $cust_pkg => [ $svc_acct ],
 550     ...
 551   );
 552   $cust_main->order_pkgs( \%hash, \'0', 'noexport'=>1 );
 553
 554 Services can be new, in which case they are inserted, or existing unaudited
 555 services, in which case they are linked to the newly-created package.
 556
 557 Currently available options are: I<depend_jobnum> and I<noexport>.
 558
 559 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
 560 on the supplied jobnum (they will not run until the specific job completes).
 561 This can be used to defer provisioning until some action completes (such
 562 as running the customer's credit card successfully).
 563
 564 The I<noexport> option is deprecated.  If I<noexport> is set true, no
 565 provisioning jobs (exports) are scheduled.  (You can schedule them later with
 566 the B<reexport> method for each cust_pkg object.  Using the B<reexport> method
 567 on the cust_main object is not recommended, as existing services will also be
 568 reexported.)
 569
 570 =cut
 571
 572 sub order_pkgs {
 573   my $self = shift;
 574   my $cust_pkgs = shift;
 575   my $seconds = shift;
 576   my %options = @_;
 577   my %svc_options = ();
 578   $svc_options{'depend_jobnum'} = $options{'depend_jobnum'}
 579     if exists $options{'depend_jobnum'};
 580   warn "$me order_pkgs called with options ".
 581        join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
 582     if $DEBUG;
 583
 584   local $SIG{HUP} = 'IGNORE';
 585   local $SIG{INT} = 'IGNORE';
 586   local $SIG{QUIT} = 'IGNORE';
 587   local $SIG{TERM} = 'IGNORE';
 588   local $SIG{TSTP} = 'IGNORE';
 589   local $SIG{PIPE} = 'IGNORE';
 590
 591   my $oldAutoCommit = $FS::UID::AutoCommit;
 592   local $FS::UID::AutoCommit = 0;
 593   my $dbh = dbh;
 594
 595   local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
 596
 597   foreach my $cust_pkg ( keys %$cust_pkgs ) {
 598     $cust_pkg->custnum( $self->custnum );
 599     my $error = $cust_pkg->insert;
 600     if ( $error ) {
 601       $dbh->rollback if $oldAutoCommit;
 602       return "inserting cust_pkg (transaction rolled back): $error";
 603     }
 604     foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
 605       if ( $svc_something->svcnum ) {
 606         my $old_cust_svc = $svc_something->cust_svc;
 607         my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
 608         $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
 609         $error = $new_cust_svc->replace($old_cust_svc);
 610       } else {
 611         $svc_something->pkgnum( $cust_pkg->pkgnum );
 612         if ( $seconds && $$seconds && $svc_something->isa('FS::svc_acct') ) {
 613           $svc_something->seconds( $svc_something->seconds + $$seconds );
 614           $$seconds = 0;
 615         }
 616         $error = $svc_something->insert(%svc_options);
 617       }
 618       if ( $error ) {
 619         $dbh->rollback if $oldAutoCommit;
 620         #return "inserting svc_ (transaction rolled back): $error";
 621         return $error;
 622       }
 623     }
 624   }
 625
 626   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 627   ''; #no error
 628 }
 629
 630 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
 631
 632 Recharges this (existing) customer with the specified prepaid card (see
 633 L<FS::prepay_credit>), specified either by I<identifier> or as an
 634 FS::prepay_credit object.  If there is an error, returns the error, otherwise
 635 returns false.
 636
 637 Optionally, four scalar references can be passed as well.  They will have their
 638 values filled in with the amount, number of seconds, and number of upload and
 639 download bytes applied by this prepaid
 640 card.
 641
 642 =cut
 643
 644 sub recharge_prepay {
 645   my( $self, $prepay_credit, $amountref, $secondsref,
 646       $upbytesref, $downbytesref, $totalbytesref ) = @_;
 647
 648   local $SIG{HUP} = 'IGNORE';
 649   local $SIG{INT} = 'IGNORE';
 650   local $SIG{QUIT} = 'IGNORE';
 651   local $SIG{TERM} = 'IGNORE';
 652   local $SIG{TSTP} = 'IGNORE';
 653   local $SIG{PIPE} = 'IGNORE';
 654
 655   my $oldAutoCommit = $FS::UID::AutoCommit;
 656   local $FS::UID::AutoCommit = 0;
 657   my $dbh = dbh;
 658
 659   my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
 660
 661   my $error = $self->get_prepay($prepay_credit, \$amount,
 662                                 \$seconds, \$upbytes, \$downbytes, \$totalbytes)
 663            || $self->increment_seconds($seconds)
 664            || $self->increment_upbytes($upbytes)
 665            || $self->increment_downbytes($downbytes)
 666            || $self->increment_totalbytes($totalbytes)
 667            || $self->insert_cust_pay_prepay( $amount,
 668                                              ref($prepay_credit)
 669                                                ? $prepay_credit->identifier
 670                                                : $prepay_credit
 671                                            );
 672
 673   if ( $error ) {
 674     $dbh->rollback if $oldAutoCommit;
 675     return $error;
 676   }
 677
 678   if ( defined($amountref)  ) { $$amountref  = $amount;  }
 679   if ( defined($secondsref) ) { $$secondsref = $seconds; }
 680   if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
 681   if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
 682   if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
 683
 684   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 685   '';
 686
 687 }
 688
 689 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ , AMOUNTREF, SECONDSREF
 690
 691 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
 692 specified either by I<identifier> or as an FS::prepay_credit object.
 693
 694 References to I<amount> and I<seconds> scalars should be passed as arguments
 695 and will be incremented by the values of the prepaid card.
 696
 697 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
 698 check or set this customer's I<agentnum>.
 699
 700 If there is an error, returns the error, otherwise returns false.
 701
 702 =cut
 703
 704
 705 sub get_prepay {
 706   my( $self, $prepay_credit, $amountref, $secondsref,
 707       $upref, $downref, $totalref) = @_;
 708
 709   local $SIG{HUP} = 'IGNORE';
 710   local $SIG{INT} = 'IGNORE';
 711   local $SIG{QUIT} = 'IGNORE';
 712   local $SIG{TERM} = 'IGNORE';
 713   local $SIG{TSTP} = 'IGNORE';
 714   local $SIG{PIPE} = 'IGNORE';
 715
 716   my $oldAutoCommit = $FS::UID::AutoCommit;
 717   local $FS::UID::AutoCommit = 0;
 718   my $dbh = dbh;
 719
 720   unless ( ref($prepay_credit) ) {
 721
 722     my $identifier = $prepay_credit;
 723
 724     $prepay_credit = qsearchs(
 725       'prepay_credit',
 726       { 'identifier' => $prepay_credit },
 727       '',
 728       'FOR UPDATE'
 729     );
 730
 731     unless ( $prepay_credit ) {
 732       $dbh->rollback if $oldAutoCommit;
 733       return "Invalid prepaid card: ". $identifier;
 734     }
 735
 736   }
 737
 738   if ( $prepay_credit->agentnum ) {
 739     if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
 740       $dbh->rollback if $oldAutoCommit;
 741       return "prepaid card not valid for agent ". $self->agentnum;
 742     }
 743     $self->agentnum($prepay_credit->agentnum);
 744   }
 745
 746   my $error = $prepay_credit->delete;
 747   if ( $error ) {
 748     $dbh->rollback if $oldAutoCommit;
 749     return "removing prepay_credit (transaction rolled back): $error";
 750   }
 751
 752   $$amountref  += $prepay_credit->amount;
 753   $$secondsref += $prepay_credit->seconds;
 754   $$upref      += $prepay_credit->upbytes;
 755   $$downref    += $prepay_credit->downbytes;
 756   $$totalref   += $prepay_credit->totalbytes;
 757
 758   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 759   '';
 760
 761 }
 762
 763 =item increment_upbytes SECONDS
 764
 765 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 766 the specified number of upbytes.  If there is an error, returns the error,
 767 otherwise returns false.
 768
 769 =cut
 770
 771 sub increment_upbytes {
 772   _increment_column( shift, 'upbytes', @_);
 773 }
 774
 775 =item increment_downbytes SECONDS
 776
 777 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 778 the specified number of downbytes.  If there is an error, returns the error,
 779 otherwise returns false.
 780
 781 =cut
 782
 783 sub increment_downbytes {
 784   _increment_column( shift, 'downbytes', @_);
 785 }
 786
 787 =item increment_totalbytes SECONDS
 788
 789 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 790 the specified number of totalbytes.  If there is an error, returns the error,
 791 otherwise returns false.
 792
 793 =cut
 794
 795 sub increment_totalbytes {
 796   _increment_column( shift, 'totalbytes', @_);
 797 }
 798
 799 =item increment_seconds SECONDS
 800
 801 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 802 the specified number of seconds.  If there is an error, returns the error,
 803 otherwise returns false.
 804
 805 =cut
 806
 807 sub increment_seconds {
 808   _increment_column( shift, 'seconds', @_);
 809 }
 810
 811 =item _increment_column AMOUNT
 812
 813 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 814 the specified number of seconds or bytes.  If there is an error, returns
 815 the error, otherwise returns false.
 816
 817 =cut
 818
 819 sub _increment_column {
 820   my( $self, $column, $amount ) = @_;
 821   warn "$me increment_column called: $column, $amount\n"
 822     if $DEBUG;
 823
 824   return '' unless $amount;
 825
 826   my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
 827                       $self->ncancelled_pkgs;
 828
 829   if ( ! @cust_pkg ) {
 830     return 'No packages with primary or single services found'.
 831            ' to apply pre-paid time';
 832   } elsif ( scalar(@cust_pkg) > 1 ) {
 833     #maybe have a way to specify the package/account?
 834     return 'Multiple packages found to apply pre-paid time';
 835   }
 836
 837   my $cust_pkg = $cust_pkg[0];
 838   warn "  found package pkgnum ". $cust_pkg->pkgnum. "\n"
 839     if $DEBUG > 1;
 840
 841   my @cust_svc =
 842     $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
 843
 844   if ( ! @cust_svc ) {
 845     return 'No account found to apply pre-paid time';
 846   } elsif ( scalar(@cust_svc) > 1 ) {
 847     return 'Multiple accounts found to apply pre-paid time';
 848   }
 849
 850   my $svc_acct = $cust_svc[0]->svc_x;
 851   warn "  found service svcnum ". $svc_acct->pkgnum.
 852        ' ('. $svc_acct->email. ")\n"
 853     if $DEBUG > 1;
 854
 855   $column = "increment_$column";
 856   $svc_acct->$column($amount);
 857
 858 }
 859
 860 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
 861
 862 Inserts a prepayment in the specified amount for this customer.  An optional
 863 second argument can specify the prepayment identifier for tracking purposes.
 864 If there is an error, returns the error, otherwise returns false.
 865
 866 =cut
 867
 868 sub insert_cust_pay_prepay {
 869   shift->insert_cust_pay('PREP', @_);
 870 }
 871
 872 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
 873
 874 Inserts a cash payment in the specified amount for this customer.  An optional
 875 second argument can specify the payment identifier for tracking purposes.
 876 If there is an error, returns the error, otherwise returns false.
 877
 878 =cut
 879
 880 sub insert_cust_pay_cash {
 881   shift->insert_cust_pay('CASH', @_);
 882 }
 883
 884 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
 885
 886 Inserts a Western Union payment in the specified amount for this customer.  An
 887 optional second argument can specify the prepayment identifier for tracking
 888 purposes.  If there is an error, returns the error, otherwise returns false.
 889
 890 =cut
 891
 892 sub insert_cust_pay_west {
 893   shift->insert_cust_pay('WEST', @_);
 894 }
 895
 896 sub insert_cust_pay {
 897   my( $self, $payby, $amount ) = splice(@_, 0, 3);
 898   my $payinfo = scalar(@_) ? shift : '';
 899
 900   my $cust_pay = new FS::cust_pay {
 901     'custnum' => $self->custnum,
 902     'paid'    => sprintf('%.2f', $amount),
 903     #'_date'   => #date the prepaid card was purchased???
 904     'payby'   => $payby,
 905     'payinfo' => $payinfo,
 906   };
 907   $cust_pay->insert;
 908
 909 }
 910
 911 =item reexport
 912
 913 This method is deprecated.  See the I<depend_jobnum> option to the insert and
 914 order_pkgs methods for a better way to defer provisioning.
 915
 916 Re-schedules all exports by calling the B<reexport> method of all associated
 917 packages (see L<FS::cust_pkg>).  If there is an error, returns the error;
 918 otherwise returns false.
 919
 920 =cut
 921
 922 sub reexport {
 923   my $self = shift;
 924
 925   carp "WARNING: FS::cust_main::reexport is deprectated; ".
 926        "use the depend_jobnum option to insert or order_pkgs to delay export";
 927
 928   local $SIG{HUP} = 'IGNORE';
 929   local $SIG{INT} = 'IGNORE';
 930   local $SIG{QUIT} = 'IGNORE';
 931   local $SIG{TERM} = 'IGNORE';
 932   local $SIG{TSTP} = 'IGNORE';
 933   local $SIG{PIPE} = 'IGNORE';
 934
 935   my $oldAutoCommit = $FS::UID::AutoCommit;
 936   local $FS::UID::AutoCommit = 0;
 937   my $dbh = dbh;
 938
 939   foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
 940     my $error = $cust_pkg->reexport;
 941     if ( $error ) {
 942       $dbh->rollback if $oldAutoCommit;
 943       return $error;
 944     }
 945   }
 946
 947   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 948   '';
 949
 950 }
 951
 952 =item delete NEW_CUSTNUM
 953
 954 This deletes the customer.  If there is an error, returns the error, otherwise
 955 returns false.
 956
 957 This will completely remove all traces of the customer record.  This is not
 958 what you want when a customer cancels service; for that, cancel all of the
 959 customer's packages (see L</cancel>).
 960
 961 If the customer has any uncancelled packages, you need to pass a new (valid)
 962 customer number for those packages to be transferred to.  Cancelled packages
 963 will be deleted.  Did I mention that this is NOT what you want when a customer
 964 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
 965
 966 You can't delete a customer with invoices (see L<FS::cust_bill>),
 967 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
 968 refunds (see L<FS::cust_refund>).
 969
 970 =cut
 971
 972 sub delete {
 973   my $self = shift;
 974
 975   local $SIG{HUP} = 'IGNORE';
 976   local $SIG{INT} = 'IGNORE';
 977   local $SIG{QUIT} = 'IGNORE';
 978   local $SIG{TERM} = 'IGNORE';
 979   local $SIG{TSTP} = 'IGNORE';
 980   local $SIG{PIPE} = 'IGNORE';
 981
 982   my $oldAutoCommit = $FS::UID::AutoCommit;
 983   local $FS::UID::AutoCommit = 0;
 984   my $dbh = dbh;
 985
 986   if ( $self->cust_bill ) {
 987     $dbh->rollback if $oldAutoCommit;
 988     return "Can't delete a customer with invoices";
 989   }
 990   if ( $self->cust_credit ) {
 991     $dbh->rollback if $oldAutoCommit;
 992     return "Can't delete a customer with credits";
 993   }
 994   if ( $self->cust_pay ) {
 995     $dbh->rollback if $oldAutoCommit;
 996     return "Can't delete a customer with payments";
 997   }
 998   if ( $self->cust_refund ) {
 999     $dbh->rollback if $oldAutoCommit;
1000     return "Can't delete a customer with refunds";
1001   }
1002
1003   my @cust_pkg = $self->ncancelled_pkgs;
1004   if ( @cust_pkg ) {
1005     my $new_custnum = shift;
1006     unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1007       $dbh->rollback if $oldAutoCommit;
1008       return "Invalid new customer number: $new_custnum";
1009     }
1010     foreach my $cust_pkg ( @cust_pkg ) {
1011       my %hash = $cust_pkg->hash;
1012       $hash{'custnum'} = $new_custnum;
1013       my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1014       my $error = $new_cust_pkg->replace($cust_pkg,
1015                                          options => { $cust_pkg->options },
1016                                         );
1017       if ( $error ) {
1018         $dbh->rollback if $oldAutoCommit;
1019         return $error;
1020       }
1021     }
1022   }
1023   my @cancelled_cust_pkg = $self->all_pkgs;
1024   foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1025     my $error = $cust_pkg->delete;
1026     if ( $error ) {
1027       $dbh->rollback if $oldAutoCommit;
1028       return $error;
1029     }
1030   }
1031
1032   foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1033     qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1034   ) {
1035     my $error = $cust_main_invoice->delete;
1036     if ( $error ) {
1037       $dbh->rollback if $oldAutoCommit;
1038       return $error;
1039     }
1040   }
1041
1042   my $error = $self->SUPER::delete;
1043   if ( $error ) {
1044     $dbh->rollback if $oldAutoCommit;
1045     return $error;
1046   }
1047
1048   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1049   '';
1050
1051 }
1052
1053 =item replace OLD_RECORD [ INVOICING_LIST_ARYREF ]
1054
1055 Replaces the OLD_RECORD with this one in the database.  If there is an error,
1056 returns the error, otherwise returns false.
1057
1058 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1059 be set as the invoicing list (see L<"invoicing_list">).  Errors return as
1060 expected and rollback the entire transaction; it is not necessary to call
1061 check_invoicing_list first.  Here's an example:
1062
1063   $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1064
1065 =cut
1066
1067 sub replace {
1068   my $self = shift;
1069   my $old = shift;
1070   my @param = @_;
1071   warn "$me replace called\n"
1072     if $DEBUG;
1073
1074   local $SIG{HUP} = 'IGNORE';
1075   local $SIG{INT} = 'IGNORE';
1076   local $SIG{QUIT} = 'IGNORE';
1077   local $SIG{TERM} = 'IGNORE';
1078   local $SIG{TSTP} = 'IGNORE';
1079   local $SIG{PIPE} = 'IGNORE';
1080
1081   # We absolutely have to have an old vs. new record to make this work.
1082   if (!defined($old)) {
1083     $old = qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
1084   }
1085
1086   my $curuser = $FS::CurrentUser::CurrentUser;
1087   if (    $self->payby eq 'COMP'
1088        && $self->payby ne $old->payby
1089        && ! $curuser->access_right('Complimentary customer')
1090      )
1091   {
1092     return "You are not permitted to create complimentary accounts.";
1093   }
1094
1095   local($ignore_expired_card) = 1
1096     if $old->payby  =~ /^(CARD|DCRD)$/
1097     && $self->payby =~ /^(CARD|DCRD)$/
1098     && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1099
1100   my $oldAutoCommit = $FS::UID::AutoCommit;
1101   local $FS::UID::AutoCommit = 0;
1102   my $dbh = dbh;
1103
1104   my $error = $self->SUPER::replace($old);
1105
1106   if ( $error ) {
1107     $dbh->rollback if $oldAutoCommit;
1108     return $error;
1109   }
1110
1111   if ( @param ) { # INVOICING_LIST_ARYREF
1112     my $invoicing_list = shift @param;
1113     $error = $self->check_invoicing_list( $invoicing_list );
1114     if ( $error ) {
1115       $dbh->rollback if $oldAutoCommit;
1116       return $error;
1117     }
1118     $self->invoicing_list( $invoicing_list );
1119   }
1120
1121   if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1122        grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1123     # card/check/lec info has changed, want to retry realtime_ invoice events
1124     my $error = $self->retry_realtime;
1125     if ( $error ) {
1126       $dbh->rollback if $oldAutoCommit;
1127       return $error;
1128     }
1129   }
1130
1131   unless ( $import || $skip_fuzzyfiles ) {
1132     $error = $self->queue_fuzzyfiles_update;
1133     if ( $error ) {
1134       $dbh->rollback if $oldAutoCommit;
1135       return "updating fuzzy search cache: $error";
1136     }
1137   }
1138
1139   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1140   '';
1141
1142 }
1143
1144 =item queue_fuzzyfiles_update
1145
1146 Used by insert & replace to update the fuzzy search cache
1147
1148 =cut
1149
1150 sub queue_fuzzyfiles_update {
1151   my $self = shift;
1152
1153   local $SIG{HUP} = 'IGNORE';
1154   local $SIG{INT} = 'IGNORE';
1155   local $SIG{QUIT} = 'IGNORE';
1156   local $SIG{TERM} = 'IGNORE';
1157   local $SIG{TSTP} = 'IGNORE';
1158   local $SIG{PIPE} = 'IGNORE';
1159
1160   my $oldAutoCommit = $FS::UID::AutoCommit;
1161   local $FS::UID::AutoCommit = 0;
1162   my $dbh = dbh;
1163
1164   my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1165   my $error = $queue->insert( map $self->getfield($_),
1166                                   qw(first last company)
1167                             );
1168   if ( $error ) {
1169     $dbh->rollback if $oldAutoCommit;
1170     return "queueing job (transaction rolled back): $error";
1171   }
1172
1173   if ( $self->ship_last ) {
1174     $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1175     $error = $queue->insert( map $self->getfield("ship_$_"),
1176                                  qw(first last company)
1177                            );
1178     if ( $error ) {
1179       $dbh->rollback if $oldAutoCommit;
1180       return "queueing job (transaction rolled back): $error";
1181     }
1182   }
1183
1184   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1185   '';
1186
1187 }
1188
1189 =item check
1190
1191 Checks all fields to make sure this is a valid customer record.  If there is
1192 an error, returns the error, otherwise returns false.  Called by the insert
1193 and replace methods.
1194
1195 =cut
1196
1197 sub check {
1198   my $self = shift;
1199
1200   warn "$me check BEFORE: \n". $self->_dump
1201     if $DEBUG > 2;
1202
1203   my $error =
1204     $self->ut_numbern('custnum')
1205     || $self->ut_number('agentnum')
1206     || $self->ut_textn('agent_custid')
1207     || $self->ut_number('refnum')
1208     || $self->ut_name('last')
1209     || $self->ut_name('first')
1210     || $self->ut_snumbern('birthdate')
1211     || $self->ut_snumbern('signupdate')
1212     || $self->ut_textn('company')
1213     || $self->ut_text('address1')
1214     || $self->ut_textn('address2')
1215     || $self->ut_text('city')
1216     || $self->ut_textn('county')
1217     || $self->ut_textn('state')
1218     || $self->ut_country('country')
1219     || $self->ut_anything('comments')
1220     || $self->ut_numbern('referral_custnum')
1221   ;
1222   #barf.  need message catalogs.  i18n.  etc.
1223   $error .= "Please select an advertising source."
1224     if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1225   return $error if $error;
1226
1227   return "Unknown agent"
1228     unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1229
1230   return "Unknown refnum"
1231     unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1232
1233   return "Unknown referring custnum: ". $self->referral_custnum
1234     unless ! $self->referral_custnum
1235            || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1236
1237   if ( $self->ss eq '' ) {
1238     $self->ss('');
1239   } else {
1240     my $ss = $self->ss;
1241     $ss =~ s/\D//g;
1242     $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1243       or return "Illegal social security number: ". $self->ss;
1244     $self->ss("$1-$2-$3");
1245   }
1246
1247
1248 # bad idea to disable, causes billing to fail because of no tax rates later
1249 #  unless ( $import ) {
1250     unless ( qsearch('cust_main_county', {
1251       'country' => $self->country,
1252       'state'   => '',
1253      } ) ) {
1254       return "Unknown state/county/country: ".
1255         $self->state. "/". $self->county. "/". $self->country
1256         unless qsearch('cust_main_county',{
1257           'state'   => $self->state,
1258           'county'  => $self->county,
1259           'country' => $self->country,
1260         } );
1261     }
1262 #  }
1263
1264   $error =
1265     $self->ut_phonen('daytime', $self->country)
1266     || $self->ut_phonen('night', $self->country)
1267     || $self->ut_phonen('fax', $self->country)
1268     || $self->ut_zip('zip', $self->country)
1269   ;
1270   return $error if $error;
1271
1272   my @addfields = qw(
1273     last first company address1 address2 city county state zip
1274     country daytime night fax
1275   );
1276
1277   if ( defined $self->dbdef_table->column('ship_last') ) {
1278     if ( scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1279                        @addfields )
1280          && scalar ( grep { $self->getfield("ship_$_") ne '' } @addfields )
1281        )
1282     {
1283       my $error =
1284         $self->ut_name('ship_last')
1285         || $self->ut_name('ship_first')
1286         || $self->ut_textn('ship_company')
1287         || $self->ut_text('ship_address1')
1288         || $self->ut_textn('ship_address2')
1289         || $self->ut_text('ship_city')
1290         || $self->ut_textn('ship_county')
1291         || $self->ut_textn('ship_state')
1292         || $self->ut_country('ship_country')
1293       ;
1294       return $error if $error;
1295
1296       #false laziness with above
1297       unless ( qsearchs('cust_main_county', {
1298         'country' => $self->ship_country,
1299         'state'   => '',
1300        } ) ) {
1301         return "Unknown ship_state/ship_county/ship_country: ".
1302           $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1303           unless qsearch('cust_main_county',{
1304             'state'   => $self->ship_state,
1305             'county'  => $self->ship_county,
1306             'country' => $self->ship_country,
1307           } );
1308       }
1309       #eofalse
1310
1311       $error =
1312         $self->ut_phonen('ship_daytime', $self->ship_country)
1313         || $self->ut_phonen('ship_night', $self->ship_country)
1314         || $self->ut_phonen('ship_fax', $self->ship_country)
1315         || $self->ut_zip('ship_zip', $self->ship_country)
1316       ;
1317       return $error if $error;
1318
1319     } else { # ship_ info eq billing info, so don't store dup info in database
1320       $self->setfield("ship_$_", '')
1321         foreach qw( last first company address1 address2 city county state zip
1322                     country daytime night fax );
1323     }
1324   }
1325
1326   #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1327   #  or return "Illegal payby: ". $self->payby;
1328   #$self->payby($1);
1329   FS::payby->can_payby($self->table, $self->payby)
1330     or return "Illegal payby: ". $self->payby;
1331
1332   $error =    $self->ut_numbern('paystart_month')
1333            || $self->ut_numbern('paystart_year')
1334            || $self->ut_numbern('payissue')
1335   ;
1336   return $error if $error;
1337
1338   if ( $self->payip eq '' ) {
1339     $self->payip('');
1340   } else {
1341     $error = $self->ut_ip('payip');
1342     return $error if $error;
1343   }
1344
1345   # If it is encrypted and the private key is not availaible then we can't
1346   # check the credit card.
1347
1348   my $check_payinfo = 1;
1349
1350   if ($self->is_encrypted($self->payinfo)) {
1351     $check_payinfo = 0;
1352   }
1353
1354   if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1355
1356     my $payinfo = $self->payinfo;
1357     $payinfo =~ s/\D//g;
1358     $payinfo =~ /^(\d{13,16})$/
1359       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1360     $payinfo = $1;
1361     $self->payinfo($payinfo);
1362     validate($payinfo)
1363       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1364
1365     return gettext('unknown_card_type')
1366       if cardtype($self->payinfo) eq "Unknown";
1367
1368     my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1369     if ( $ban ) {
1370       return 'Banned credit card: banned on '.
1371              time2str('%a %h %o at %r', $ban->_date).
1372              ' by '. $ban->otaker.
1373              ' (ban# '. $ban->bannum. ')';
1374     }
1375
1376     if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1377       if ( cardtype($self->payinfo) eq 'American Express card' ) {
1378         $self->paycvv =~ /^(\d{4})$/
1379           or return "CVV2 (CID) for American Express cards is four digits.";
1380         $self->paycvv($1);
1381       } else {
1382         $self->paycvv =~ /^(\d{3})$/
1383           or return "CVV2 (CVC2/CID) is three digits.";
1384         $self->paycvv($1);
1385       }
1386     } else {
1387       $self->paycvv('');
1388     }
1389
1390     my $cardtype = cardtype($payinfo);
1391     if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1392
1393       return "Start date or issue number is required for $cardtype cards"
1394         unless $self->paystart_month && $self->paystart_year or $self->payissue;
1395
1396       return "Start month must be between 1 and 12"
1397         if $self->paystart_month
1398            and $self->paystart_month < 1 || $self->paystart_month > 12;
1399
1400       return "Start year must be 1990 or later"
1401         if $self->paystart_year
1402            and $self->paystart_year < 1990;
1403
1404       return "Issue number must be beween 1 and 99"
1405         if $self->payissue
1406           and $self->payissue < 1 || $self->payissue > 99;
1407
1408     } else {
1409       $self->paystart_month('');
1410       $self->paystart_year('');
1411       $self->payissue('');
1412     }
1413
1414   } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1415
1416     my $payinfo = $self->payinfo;
1417     $payinfo =~ s/[^\d\@]//g;
1418     if ( $conf->exists('echeck-nonus') ) {
1419       $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1420       $payinfo = "$1\@$2";
1421     } else {
1422       $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1423       $payinfo = "$1\@$2";
1424     }
1425     $self->payinfo($payinfo);
1426     $self->paycvv('');
1427
1428     my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1429     if ( $ban ) {
1430       return 'Banned ACH account: banned on '.
1431              time2str('%a %h %o at %r', $ban->_date).
1432              ' by '. $ban->otaker.
1433              ' (ban# '. $ban->bannum. ')';
1434     }
1435
1436   } elsif ( $self->payby eq 'LECB' ) {
1437
1438     my $payinfo = $self->payinfo;
1439     $payinfo =~ s/\D//g;
1440     $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1441     $payinfo = $1;
1442     $self->payinfo($payinfo);
1443     $self->paycvv('');
1444
1445   } elsif ( $self->payby eq 'BILL' ) {
1446
1447     $error = $self->ut_textn('payinfo');
1448     return "Illegal P.O. number: ". $self->payinfo if $error;
1449     $self->paycvv('');
1450
1451   } elsif ( $self->payby eq 'COMP' ) {
1452
1453     my $curuser = $FS::CurrentUser::CurrentUser;
1454     if (    ! $self->custnum
1455          && ! $curuser->access_right('Complimentary customer')
1456        )
1457     {
1458       return "You are not permitted to create complimentary accounts."
1459     }
1460
1461     $error = $self->ut_textn('payinfo');
1462     return "Illegal comp account issuer: ". $self->payinfo if $error;
1463     $self->paycvv('');
1464
1465   } elsif ( $self->payby eq 'PREPAY' ) {
1466
1467     my $payinfo = $self->payinfo;
1468     $payinfo =~ s/\W//g; #anything else would just confuse things
1469     $self->payinfo($payinfo);
1470     $error = $self->ut_alpha('payinfo');
1471     return "Illegal prepayment identifier: ". $self->payinfo if $error;
1472     return "Unknown prepayment identifier"
1473       unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1474     $self->paycvv('');
1475
1476   }
1477
1478   if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1479     return "Expiration date required"
1480       unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1481     $self->paydate('');
1482   } else {
1483     my( $m, $y );
1484     if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1485       ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1486     } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1487       ( $m, $y ) = ( $3, "20$2" );
1488     } else {
1489       return "Illegal expiration date: ". $self->paydate;
1490     }
1491     $self->paydate("$y-$m-01");
1492     my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1493     return gettext('expired_card')
1494       if !$import
1495       && !$ignore_expired_card
1496       && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1497   }
1498
1499   if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1500        ( ! $conf->exists('require_cardname')
1501          || $self->payby !~ /^(CARD|DCRD)$/  )
1502   ) {
1503     $self->payname( $self->first. " ". $self->getfield('last') );
1504   } else {
1505     $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1506       or return gettext('illegal_name'). " payname: ". $self->payname;
1507     $self->payname($1);
1508   }
1509
1510   foreach my $flag (qw( tax spool_cdr )) {
1511     $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1512     $self->$flag($1);
1513   }
1514
1515   $self->otaker(getotaker) unless $self->otaker;
1516
1517   warn "$me check AFTER: \n". $self->_dump
1518     if $DEBUG > 2;
1519
1520   $self->SUPER::check;
1521 }
1522
1523 =item all_pkgs
1524
1525 Returns all packages (see L<FS::cust_pkg>) for this customer.
1526
1527 =cut
1528
1529 sub all_pkgs {
1530   my $self = shift;
1531
1532   return $self->num_pkgs unless wantarray;
1533
1534   my @cust_pkg = ();
1535   if ( $self->{'_pkgnum'} ) {
1536     @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1537   } else {
1538     @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1539   }
1540
1541   sort sort_packages @cust_pkg;
1542 }
1543
1544 =item ncancelled_pkgs
1545
1546 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1547
1548 =cut
1549
1550 sub ncancelled_pkgs {
1551   my $self = shift;
1552
1553   return $self->num_ncancelled_pkgs unless wantarray;
1554
1555   my @cust_pkg = ();
1556   if ( $self->{'_pkgnum'} ) {
1557
1558     @cust_pkg = grep { ! $_->getfield('cancel') }
1559                 values %{ $self->{'_pkgnum'}->cache };
1560
1561   } else {
1562
1563     @cust_pkg =
1564       qsearch( 'cust_pkg', {
1565                              'custnum' => $self->custnum,
1566                              'cancel'  => '',
1567                            });
1568     push @cust_pkg,
1569       qsearch( 'cust_pkg', {
1570                              'custnum' => $self->custnum,
1571                              'cancel'  => 0,
1572                            });
1573   }
1574
1575   sort sort_packages @cust_pkg;
1576
1577 }
1578
1579 # This should be generalized to use config options to determine order.
1580 sub sort_packages {
1581   if ( $a->get('cancel') and $b->get('cancel') ) {
1582     $a->pkgnum <=> $b->pkgnum;
1583   } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1584     return -1 if $b->get('cancel');
1585     return  1 if $a->get('cancel');
1586     return 0;
1587   } else {
1588     $a->pkgnum <=> $b->pkgnum;
1589   }
1590 }
1591
1592 =item suspended_pkgs
1593
1594 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1595
1596 =cut
1597
1598 sub suspended_pkgs {
1599   my $self = shift;
1600   grep { $_->susp } $self->ncancelled_pkgs;
1601 }
1602
1603 =item unflagged_suspended_pkgs
1604
1605 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1606 customer (thouse packages without the `manual_flag' set).
1607
1608 =cut
1609
1610 sub unflagged_suspended_pkgs {
1611   my $self = shift;
1612   return $self->suspended_pkgs
1613     unless dbdef->table('cust_pkg')->column('manual_flag');
1614   grep { ! $_->manual_flag } $self->suspended_pkgs;
1615 }
1616
1617 =item unsuspended_pkgs
1618
1619 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1620 this customer.
1621
1622 =cut
1623
1624 sub unsuspended_pkgs {
1625   my $self = shift;
1626   grep { ! $_->susp } $self->ncancelled_pkgs;
1627 }
1628
1629 =item num_cancelled_pkgs
1630
1631 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1632 customer.
1633
1634 =cut
1635
1636 sub num_cancelled_pkgs {
1637   shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1638 }
1639
1640 sub num_ncancelled_pkgs {
1641   shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1642 }
1643
1644 sub num_pkgs {
1645   my( $self, $sql ) = @_;
1646   $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1647   my $sth = dbh->prepare(
1648     "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1649   ) or die dbh->errstr;
1650   $sth->execute($self->custnum) or die $sth->errstr;
1651   $sth->fetchrow_arrayref->[0];
1652 }
1653
1654 =item unsuspend
1655
1656 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1657 and L<FS::cust_pkg>) for this customer.  Always returns a list: an empty list
1658 on success or a list of errors.
1659
1660 =cut
1661
1662 sub unsuspend {
1663   my $self = shift;
1664   grep { $_->unsuspend } $self->suspended_pkgs;
1665 }
1666
1667 =item suspend
1668
1669 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1670
1671 Returns a list: an empty list on success or a list of errors.
1672
1673 =cut
1674
1675 sub suspend {
1676   my $self = shift;
1677   grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1678 }
1679
1680 =item suspend_if_pkgpart PKGPART [ , PKGPART ... ]
1681
1682 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1683 PKGPARTs (see L<FS::part_pkg>).
1684
1685 Returns a list: an empty list on success or a list of errors.
1686
1687 =cut
1688
1689 sub suspend_if_pkgpart {
1690   my $self = shift;
1691   my (@pkgparts, %opt);
1692   if (ref($_[0]) eq 'HASH'){
1693     @pkgparts = @{$_[0]{pkgparts}};
1694     %opt      = %{$_[0]};
1695   }else{
1696     @pkgparts = @_;
1697   }
1698   grep { $_->suspend(%opt) }
1699     grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1700       $self->unsuspended_pkgs;
1701 }
1702
1703 =item suspend_unless_pkgpart PKGPART [ , PKGPART ... ]
1704
1705 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1706 listed PKGPARTs (see L<FS::part_pkg>).
1707
1708 Returns a list: an empty list on success or a list of errors.
1709
1710 =cut
1711
1712 sub suspend_unless_pkgpart {
1713   my $self = shift;
1714   my (@pkgparts, %opt);
1715   if (ref($_[0]) eq 'HASH'){
1716     @pkgparts = @{$_[0]{pkgparts}};
1717     %opt      = %{$_[0]};
1718   }else{
1719     @pkgparts = @_;
1720   }
1721   grep { $_->suspend(%opt) }
1722     grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1723       $self->unsuspended_pkgs;
1724 }
1725
1726 =item cancel [ OPTION => VALUE ... ]
1727
1728 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1729
1730 Available options are: I<quiet>, I<reasonnum>, and I<ban>
1731
1732 I<quiet> can be set true to supress email cancellation notices.
1733
1734 # I<reasonnum> can be set to a cancellation reason (see L<FS::cancel_reason>)
1735
1736 I<ban> can be set true to ban this customer's credit card or ACH information,
1737 if present.
1738
1739 Always returns a list: an empty list on success or a list of errors.
1740
1741 =cut
1742
1743 sub cancel {
1744   my $self = shift;
1745   my %opt = @_;
1746
1747   if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1748
1749     #should try decryption (we might have the private key)
1750     # and if not maybe queue a job for the server that does?
1751     return ( "Can't (yet) ban encrypted credit cards" )
1752       if $self->is_encrypted($self->payinfo);
1753
1754     my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1755     my $error = $ban->insert;
1756     return ( $error ) if $error;
1757
1758   }
1759
1760   grep { $_ } map { $_->cancel(@_) } $self->ncancelled_pkgs;
1761 }
1762
1763 sub _banned_pay_hashref {
1764   my $self = shift;
1765
1766   my %payby2ban = (
1767     'CARD' => 'CARD',
1768     'DCRD' => 'CARD',
1769     'CHEK' => 'CHEK',
1770     'DCHK' => 'CHEK'
1771   );
1772
1773   {
1774     'payby'   => $payby2ban{$self->payby},
1775     'payinfo' => md5_base64($self->payinfo),
1776     #don't ever *search* on reason! #'reason'  =>
1777   };
1778 }
1779
1780 =item notes
1781
1782 Returns all notes (see L<FS::cust_main_note>) for this customer.
1783
1784 =cut
1785
1786 sub notes {
1787   my $self = shift;
1788   #order by?
1789   qsearch( 'cust_main_note',
1790            { 'custnum' => $self->custnum },
1791            '',
1792            'ORDER BY _DATE DESC'
1793          );
1794 }
1795
1796 =item agent
1797
1798 Returns the agent (see L<FS::agent>) for this customer.
1799
1800 =cut
1801
1802 sub agent {
1803   my $self = shift;
1804   qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1805 }
1806
1807 =item bill OPTIONS
1808
1809 Generates invoices (see L<FS::cust_bill>) for this customer.  Usually used in
1810 conjunction with the collect method.
1811
1812 Options are passed as name-value pairs.
1813
1814 Currently available options are:
1815
1816 resetup - if set true, re-charges setup fees.
1817
1818 time - bills the customer as if it were that time.  Specified as a UNIX
1819 timestamp; see L<perlfunc/"time">).  Also see L<Time::Local> and
1820 L<Date::Parse> for conversion functions.  For example:
1821
1822  use Date::Parse;
1823  ...
1824  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1825
1826
1827 If there is an error, returns the error, otherwise returns false.
1828
1829 =cut
1830
1831 sub bill {
1832   my( $self, %options ) = @_;
1833   return '' if $self->payby eq 'COMP';
1834   warn "$me bill customer ". $self->custnum. "\n"
1835     if $DEBUG;
1836
1837   my $time = $options{'time'} || time;
1838
1839   my $error;
1840
1841   #put below somehow?
1842   local $SIG{HUP} = 'IGNORE';
1843   local $SIG{INT} = 'IGNORE';
1844   local $SIG{QUIT} = 'IGNORE';
1845   local $SIG{TERM} = 'IGNORE';
1846   local $SIG{TSTP} = 'IGNORE';
1847   local $SIG{PIPE} = 'IGNORE';
1848
1849   my $oldAutoCommit = $FS::UID::AutoCommit;
1850   local $FS::UID::AutoCommit = 0;
1851   my $dbh = dbh;
1852
1853   $self->select_for_update; #mutex
1854
1855   #create a new invoice
1856   #(we'll remove it later if it doesn't actually need to be generated [contains
1857   # no line items] and we're inside a transaciton so nothing else will see it)
1858   my $cust_bill = new FS::cust_bill ( {
1859     'custnum' => $self->custnum,
1860     '_date'   => $time,
1861     #'charged' => $charged,
1862     'charged' => 0,
1863   } );
1864   $error = $cust_bill->insert;
1865   if ( $error ) {
1866     $dbh->rollback if $oldAutoCommit;
1867     return "can't create invoice for customer #". $self->custnum. ": $error";
1868   }
1869   my $invnum = $cust_bill->invnum;
1870
1871   ###
1872   # find the packages which are due for billing, find out how much they are
1873   # & generate invoice database.
1874   ###
1875
1876   my( $total_setup, $total_recur ) = ( 0, 0 );
1877   my %tax;
1878   my @precommit_hooks = ();
1879
1880   foreach my $cust_pkg (
1881     qsearch('cust_pkg', { 'custnum' => $self->custnum } )
1882   ) {
1883
1884     #NO!! next if $cust_pkg->cancel;
1885     next if $cust_pkg->getfield('cancel');
1886
1887     warn "  bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
1888
1889     #? to avoid use of uninitialized value errors... ?
1890     $cust_pkg->setfield('bill', '')
1891       unless defined($cust_pkg->bill);
1892
1893     my $part_pkg = $cust_pkg->part_pkg;
1894
1895     my %hash = $cust_pkg->hash;
1896     my $old_cust_pkg = new FS::cust_pkg \%hash;
1897
1898     my @details = ();
1899
1900     ###
1901     # bill setup
1902     ###
1903
1904     my $setup = 0;
1905     if ( !$cust_pkg->setup || $options{'resetup'} ) {
1906
1907       warn "    bill setup\n" if $DEBUG > 1;
1908
1909       $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
1910       if ( $@ ) {
1911         $dbh->rollback if $oldAutoCommit;
1912         return "$@ running calc_setup for $cust_pkg\n";
1913       }
1914
1915       $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
1916     }
1917
1918     ###
1919     # bill recurring fee
1920     ###
1921
1922     my $recur = 0;
1923     my $sdate;
1924     if ( $part_pkg->getfield('freq') ne '0' &&
1925          ! $cust_pkg->getfield('susp') &&
1926          ( $cust_pkg->getfield('bill') || 0 ) <= $time
1927     ) {
1928
1929       warn "    bill recur\n" if $DEBUG > 1;
1930
1931       # XXX shared with $recur_prog
1932       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1933
1934       #over two params!  lets at least switch to a hashref for the rest...
1935       my %param = ( 'precommit_hooks' => \@precommit_hooks, );
1936
1937       $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
1938       if ( $@ ) {
1939         $dbh->rollback if $oldAutoCommit;
1940         return "$@ running calc_recur for $cust_pkg\n";
1941       }
1942
1943       #change this bit to use Date::Manip? CAREFUL with timezones (see
1944       # mailing list archive)
1945       my ($sec,$min,$hour,$mday,$mon,$year) =
1946         (localtime($sdate) )[0,1,2,3,4,5];
1947
1948       #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
1949       # only for figuring next bill date, nothing else, so, reset $sdate again
1950       # here
1951       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1952       $cust_pkg->last_bill($sdate)
1953         if $cust_pkg->dbdef_table->column('last_bill');
1954
1955       if ( $part_pkg->freq =~ /^\d+$/ ) {
1956         $mon += $part_pkg->freq;
1957         until ( $mon < 12 ) { $mon -= 12; $year++; }
1958       } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
1959         my $weeks = $1;
1960         $mday += $weeks * 7;
1961       } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
1962         my $days = $1;
1963         $mday += $days;
1964       } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
1965         my $hours = $1;
1966         $hour += $hours;
1967       } else {
1968         $dbh->rollback if $oldAutoCommit;
1969         return "unparsable frequency: ". $part_pkg->freq;
1970       }
1971       $cust_pkg->setfield('bill',
1972         timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
1973     }
1974
1975     warn "\$setup is undefined" unless defined($setup);
1976     warn "\$recur is undefined" unless defined($recur);
1977     warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1978
1979     ###
1980     # If $cust_pkg has been modified, update it and create cust_bill_pkg records
1981     ###
1982
1983     if ( $cust_pkg->modified ) {  # hmmm.. and if the options are modified?
1984
1985       warn "  package ". $cust_pkg->pkgnum. " modified; updating\n"
1986         if $DEBUG >1;
1987
1988       $error=$cust_pkg->replace($old_cust_pkg,
1989                                 options => { $cust_pkg->options },
1990                                );
1991       if ( $error ) { #just in case
1992         $dbh->rollback if $oldAutoCommit;
1993         return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
1994       }
1995
1996       $setup = sprintf( "%.2f", $setup );
1997       $recur = sprintf( "%.2f", $recur );
1998       if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1999         $dbh->rollback if $oldAutoCommit;
2000         return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2001       }
2002       if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2003         $dbh->rollback if $oldAutoCommit;
2004         return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2005       }
2006
2007       if ( $setup != 0 || $recur != 0 ) {
2008
2009         warn "    charges (setup=$setup, recur=$recur); adding line items\n"
2010           if $DEBUG > 1;
2011         my $cust_bill_pkg = new FS::cust_bill_pkg ({
2012           'invnum'  => $invnum,
2013           'pkgnum'  => $cust_pkg->pkgnum,
2014           'setup'   => $setup,
2015           'recur'   => $recur,
2016           'sdate'   => $sdate,
2017           'edate'   => $cust_pkg->bill,
2018           'details' => \@details,
2019         });
2020         $error = $cust_bill_pkg->insert;
2021         if ( $error ) {
2022           $dbh->rollback if $oldAutoCommit;
2023           return "can't create invoice line item for invoice #$invnum: $error";
2024         }
2025         $total_setup += $setup;
2026         $total_recur += $recur;
2027
2028         ###
2029         # handle taxes
2030         ###
2031
2032         unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2033
2034           my $prefix =
2035             ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2036             ? 'ship_'
2037             : '';
2038           my %taxhash = map { $_ => $self->get("$prefix$_") }
2039                             qw( state county country );
2040
2041           $taxhash{'taxclass'} = $part_pkg->taxclass;
2042
2043           my @taxes = qsearch( 'cust_main_county', \%taxhash );
2044
2045           unless ( @taxes ) {
2046             $taxhash{'taxclass'} = '';
2047             @taxes =  qsearch( 'cust_main_county', \%taxhash );
2048           }
2049
2050           #one more try at a whole-country tax rate
2051           unless ( @taxes ) {
2052             $taxhash{$_} = '' foreach qw( state county );
2053             @taxes =  qsearch( 'cust_main_county', \%taxhash );
2054           }
2055
2056           # maybe eliminate this entirely, along with all the 0% records
2057           unless ( @taxes ) {
2058             $dbh->rollback if $oldAutoCommit;
2059             return
2060               "fatal: can't find tax rate for state/county/country/taxclass ".
2061               join('/', ( map $self->get("$prefix$_"),
2062                               qw(state county country)
2063                         ),
2064                         $part_pkg->taxclass ). "\n";
2065           }
2066
2067           foreach my $tax ( @taxes ) {
2068
2069             my $taxable_charged = 0;
2070             $taxable_charged += $setup
2071               unless $part_pkg->setuptax =~ /^Y$/i
2072                   || $tax->setuptax =~ /^Y$/i;
2073             $taxable_charged += $recur
2074               unless $part_pkg->recurtax =~ /^Y$/i
2075                   || $tax->recurtax =~ /^Y$/i;
2076             next unless $taxable_charged;
2077
2078             if ( $tax->exempt_amount && $tax->exempt_amount > 0 ) {
2079               #my ($mon,$year) = (localtime($sdate) )[4,5];
2080               my ($mon,$year) = (localtime( $sdate || $cust_bill->_date ) )[4,5];
2081               $mon++;
2082               my $freq = $part_pkg->freq || 1;
2083               if ( $freq !~ /(\d+)$/ ) {
2084                 $dbh->rollback if $oldAutoCommit;
2085                 return "daily/weekly package definitions not (yet?)".
2086                        " compatible with monthly tax exemptions";
2087               }
2088               my $taxable_per_month =
2089                 sprintf("%.2f", $taxable_charged / $freq );
2090
2091               #call the whole thing off if this customer has any old
2092               #exemption records...
2093               my @cust_tax_exempt =
2094                 qsearch( 'cust_tax_exempt' => { custnum=> $self->custnum } );
2095               if ( @cust_tax_exempt ) {
2096                 $dbh->rollback if $oldAutoCommit;
2097                 return
2098                   'this customer still has old-style tax exemption records; '.
2099                   'run bin/fs-migrate-cust_tax_exempt?';
2100               }
2101
2102               foreach my $which_month ( 1 .. $freq ) {
2103
2104                 #maintain the new exemption table now
2105                 my $sql = "
2106                   SELECT SUM(amount)
2107                     FROM cust_tax_exempt_pkg
2108                       LEFT JOIN cust_bill_pkg USING ( billpkgnum )
2109                       LEFT JOIN cust_bill     USING ( invnum     )
2110                     WHERE custnum = ?
2111                       AND taxnum  = ?
2112                       AND year    = ?
2113                       AND month   = ?
2114                 ";
2115                 my $sth = dbh->prepare($sql) or do {
2116                   $dbh->rollback if $oldAutoCommit;
2117                   return "fatal: can't lookup exising exemption: ". dbh->errstr;
2118                 };
2119                 $sth->execute(
2120                   $self->custnum,
2121                   $tax->taxnum,
2122                   1900+$year,
2123                   $mon,
2124                 ) or do {
2125                   $dbh->rollback if $oldAutoCommit;
2126                   return "fatal: can't lookup exising exemption: ". dbh->errstr;
2127                 };
2128                 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
2129
2130                 my $remaining_exemption =
2131                   $tax->exempt_amount - $existing_exemption;
2132                 if ( $remaining_exemption > 0 ) {
2133                   my $addl = $remaining_exemption > $taxable_per_month
2134                     ? $taxable_per_month
2135                     : $remaining_exemption;
2136                   $taxable_charged -= $addl;
2137
2138                   my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg ( {
2139                     'billpkgnum' => $cust_bill_pkg->billpkgnum,
2140                     'taxnum'     => $tax->taxnum,
2141                     'year'       => 1900+$year,
2142                     'month'      => $mon,
2143                     'amount'     => sprintf("%.2f", $addl ),
2144                   } );
2145                   $error = $cust_tax_exempt_pkg->insert;
2146                   if ( $error ) {
2147                     $dbh->rollback if $oldAutoCommit;
2148                     return "fatal: can't insert cust_tax_exempt_pkg: $error";
2149                   }
2150                 } # if $remaining_exemption > 0
2151
2152                 #++
2153                 $mon++;
2154                 #until ( $mon < 12 ) { $mon -= 12; $year++; }
2155                 until ( $mon < 13 ) { $mon -= 12; $year++; }
2156
2157               } #foreach $which_month
2158
2159             } #if $tax->exempt_amount
2160
2161             $taxable_charged = sprintf( "%.2f", $taxable_charged);
2162
2163             #$tax += $taxable_charged * $cust_main_county->tax / 100
2164             $tax{ $tax->taxname || 'Tax' } +=
2165               $taxable_charged * $tax->tax / 100
2166
2167           } #foreach my $tax ( @taxes )
2168
2169         } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2170
2171       } #if $setup != 0 || $recur != 0
2172
2173     } #if $cust_pkg->modified
2174
2175   } #foreach my $cust_pkg
2176
2177   unless ( $cust_bill->cust_bill_pkg ) {
2178     $cust_bill->delete; #don't create an invoice w/o line items
2179     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2180     return '';
2181   }
2182
2183   my $charged = sprintf( "%.2f", $total_setup + $total_recur );
2184
2185   foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2186     my $tax = sprintf("%.2f", $tax{$taxname} );
2187     $charged = sprintf( "%.2f", $charged+$tax );
2188
2189     my $cust_bill_pkg = new FS::cust_bill_pkg ({
2190       'invnum'   => $invnum,
2191       'pkgnum'   => 0,
2192       'setup'    => $tax,
2193       'recur'    => 0,
2194       'sdate'    => '',
2195       'edate'    => '',
2196       'itemdesc' => $taxname,
2197     });
2198     $error = $cust_bill_pkg->insert;
2199     if ( $error ) {
2200       $dbh->rollback if $oldAutoCommit;
2201       return "can't create invoice line item for invoice #$invnum: $error";
2202     }
2203     $total_setup += $tax;
2204
2205   }
2206
2207   $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2208   $error = $cust_bill->replace;
2209   if ( $error ) {
2210     $dbh->rollback if $oldAutoCommit;
2211     return "can't update charged for invoice #$invnum: $error";
2212   }
2213
2214   foreach my $hook ( @precommit_hooks ) {
2215     eval {
2216       &{$hook}; #($self) ?
2217     };
2218     if ( $@ ) {
2219       $dbh->rollback if $oldAutoCommit;
2220       return "$@ running precommit hook $hook\n";
2221     }
2222   }
2223
2224   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2225   ''; #no error
2226 }
2227
2228 =item collect OPTIONS
2229
2230 (Attempt to) collect money for this customer's outstanding invoices (see
2231 L<FS::cust_bill>).  Usually used after the bill method.
2232
2233 Depending on the value of `payby', this may print or email an invoice (I<BILL>,
2234 I<DCRD>, or I<DCHK>), charge a credit card (I<CARD>), charge via electronic
2235 check/ACH (I<CHEK>), or just add any necessary (pseudo-)payment (I<COMP>).
2236
2237 Most actions are now triggered by invoice events; see L<FS::part_bill_event>
2238 and the invoice events web interface.
2239
2240 If there is an error, returns the error, otherwise returns false.
2241
2242 Options are passed as name-value pairs.
2243
2244 Currently available options are:
2245
2246 invoice_time - Use this time when deciding when to print invoices and
2247 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>
2248 for conversion functions.
2249
2250 retry - Retry card/echeck/LEC transactions even when not scheduled by invoice
2251 events.
2252
2253 quiet - set true to surpress email card/ACH decline notices.
2254
2255 freq - "1d" for the traditional, daily events (the default), or "1m" for the
2256 new monthly events
2257
2258 payby - allows for one time override of normal customer billing method
2259
2260 =cut
2261
2262 sub collect {
2263   my( $self, %options ) = @_;
2264   my $invoice_time = $options{'invoice_time'} || time;
2265
2266   #put below somehow?
2267   local $SIG{HUP} = 'IGNORE';
2268   local $SIG{INT} = 'IGNORE';
2269   local $SIG{QUIT} = 'IGNORE';
2270   local $SIG{TERM} = 'IGNORE';
2271   local $SIG{TSTP} = 'IGNORE';
2272   local $SIG{PIPE} = 'IGNORE';
2273
2274   my $oldAutoCommit = $FS::UID::AutoCommit;
2275   local $FS::UID::AutoCommit = 0;
2276   my $dbh = dbh;
2277
2278   $self->select_for_update; #mutex
2279
2280   my $balance = $self->balance;
2281   warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2282     if $DEBUG;
2283   unless ( $balance > 0 ) { #redundant?????
2284     $dbh->rollback if $oldAutoCommit; #hmm
2285     return '';
2286   }
2287
2288   if ( exists($options{'retry_card'}) ) {
2289     carp 'retry_card option passed to collect is deprecated; use retry';
2290     $options{'retry'} ||= $options{'retry_card'};
2291   }
2292   if ( exists($options{'retry'}) && $options{'retry'} ) {
2293     my $error = $self->retry_realtime;
2294     if ( $error ) {
2295       $dbh->rollback if $oldAutoCommit;
2296       return $error;
2297     }
2298   }
2299
2300   my $extra_sql = '';
2301   if ( defined $options{'freq'} && $options{'freq'} eq '1m' ) {
2302     $extra_sql = " AND freq = '1m' ";
2303   } else {
2304     $extra_sql = " AND ( freq = '1d' OR freq IS NULL OR freq = '' ) ";
2305   }
2306
2307   foreach my $cust_bill ( $self->open_cust_bill ) {
2308
2309     # don't try to charge for the same invoice if it's already in a batch
2310     #next if qsearchs( 'cust_pay_batch', { 'invnum' => $cust_bill->invnum } );
2311
2312     last if $self->balance <= 0;
2313
2314     warn "  invnum ". $cust_bill->invnum. " (owed ". $cust_bill->owed. ")\n"
2315       if $DEBUG > 1;
2316
2317     foreach my $part_bill_event ( due_events ( $cust_bill,
2318                                                exists($options{'payby'})
2319                                                  ? $options{'payby'}
2320                                                  : $self->payby,
2321                                                $invoice_time,
2322                                                $extra_sql ) ) {
2323
2324       last if $cust_bill->owed <= 0  # don't run subsequent events if owed<=0
2325            || $self->balance   <= 0; # or if balance<=0
2326
2327       {
2328         local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2329         warn "  do_event " .  $cust_bill . " ". (%options) .  "\n"
2330           if $DEBUG > 1;
2331
2332         if (my $error = $part_bill_event->do_event($cust_bill, %options)) {
2333           # gah, even with transactions.
2334           $dbh->commit if $oldAutoCommit; #well.
2335           return $error;
2336         }
2337       }
2338
2339     }
2340
2341   }
2342
2343   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2344   '';
2345
2346 }
2347
2348 =item retry_realtime
2349
2350 Schedules realtime / batch  credit card / electronic check / LEC billing
2351 events for for retry.  Useful if card information has changed or manual
2352 retry is desired.  The 'collect' method must be called to actually retry
2353 the transaction.
2354
2355 Implementation details: For each of this customer's open invoices, changes
2356 the status of the first "done" (with statustext error) realtime processing
2357 event to "failed".
2358
2359 =cut
2360
2361 sub retry_realtime {
2362   my $self = shift;
2363
2364   local $SIG{HUP} = 'IGNORE';
2365   local $SIG{INT} = 'IGNORE';
2366   local $SIG{QUIT} = 'IGNORE';
2367   local $SIG{TERM} = 'IGNORE';
2368   local $SIG{TSTP} = 'IGNORE';
2369   local $SIG{PIPE} = 'IGNORE';
2370
2371   my $oldAutoCommit = $FS::UID::AutoCommit;
2372   local $FS::UID::AutoCommit = 0;
2373   my $dbh = dbh;
2374
2375   foreach my $cust_bill (
2376     grep { $_->cust_bill_event }
2377       $self->open_cust_bill
2378   ) {
2379     my @cust_bill_event =
2380       sort { $a->part_bill_event->seconds <=> $b->part_bill_event->seconds }
2381         grep {
2382                #$_->part_bill_event->plan eq 'realtime-card'
2383                $_->part_bill_event->eventcode =~
2384                    /\$cust_bill\->(batch|realtime)_(card|ach|lec)/
2385                  && $_->status eq 'done'
2386                  && $_->statustext
2387              }
2388           $cust_bill->cust_bill_event;
2389     next unless @cust_bill_event;
2390     my $error = $cust_bill_event[0]->retry;
2391     if ( $error ) {
2392       $dbh->rollback if $oldAutoCommit;
2393       return "error scheduling invoice event for retry: $error";
2394     }
2395
2396   }
2397
2398   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2399   '';
2400
2401 }
2402
2403 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2404
2405 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2406 via a Business::OnlinePayment realtime gateway.  See
2407 L<http://420.am/business-onlinepayment> for supported gateways.
2408
2409 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2410
2411 Available options are: I<description>, I<invnum>, I<quiet>
2412
2413 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2414 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
2415 if set, will override the value from the customer record.
2416
2417 I<description> is a free-text field passed to the gateway.  It defaults to
2418 "Internet services".
2419
2420 If an I<invnum> is specified, this payment (if successful) is applied to the
2421 specified invoice.  If you don't specify an I<invnum> you might want to
2422 call the B<apply_payments> method.
2423
2424 I<quiet> can be set true to surpress email decline notices.
2425
2426 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2427
2428 =cut
2429
2430 sub realtime_bop {
2431   my( $self, $method, $amount, %options ) = @_;
2432   if ( $DEBUG ) {
2433     warn "$me realtime_bop: $method $amount\n";
2434     warn "  $_ => $options{$_}\n" foreach keys %options;
2435   }
2436
2437   $options{'description'} ||= 'Internet services';
2438
2439   eval "use Business::OnlinePayment";
2440   die $@ if $@;
2441
2442   my $payinfo = exists($options{'payinfo'})
2443                   ? $options{'payinfo'}
2444                   : $self->payinfo;
2445
2446   ###
2447   # select a gateway
2448   ###
2449
2450   my $taxclass = '';
2451   if ( $options{'invnum'} ) {
2452     my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2453     die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2454     my @taxclasses =
2455       map  { $_->part_pkg->taxclass }
2456       grep { $_ }
2457       map  { $_->cust_pkg }
2458       $cust_bill->cust_bill_pkg;
2459     unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2460                                                            #different taxclasses
2461       $taxclass = $taxclasses[0];
2462     }
2463   }
2464
2465   #look for an agent gateway override first
2466   my $cardtype;
2467   if ( $method eq 'CC' ) {
2468     $cardtype = cardtype($payinfo);
2469   } elsif ( $method eq 'ECHECK' ) {
2470     $cardtype = 'ACH';
2471   } else {
2472     $cardtype = $method;
2473   }
2474
2475   my $override =
2476        qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2477                                            cardtype => $cardtype,
2478                                            taxclass => $taxclass,       } )
2479     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2480                                            cardtype => '',
2481                                            taxclass => $taxclass,       } )
2482     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2483                                            cardtype => $cardtype,
2484                                            taxclass => '',              } )
2485     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2486                                            cardtype => '',
2487                                            taxclass => '',              } );
2488
2489   my $payment_gateway = '';
2490   my( $processor, $login, $password, $action, @bop_options );
2491   if ( $override ) { #use a payment gateway override
2492
2493     $payment_gateway = $override->payment_gateway;
2494
2495     $processor   = $payment_gateway->gateway_module;
2496     $login       = $payment_gateway->gateway_username;
2497     $password    = $payment_gateway->gateway_password;
2498     $action      = $payment_gateway->gateway_action;
2499     @bop_options = $payment_gateway->options;
2500
2501   } else { #use the standard settings from the config
2502
2503     ( $processor, $login, $password, $action, @bop_options ) =
2504       $self->default_payment_gateway($method);
2505
2506   }
2507
2508   ###
2509   # massage data
2510   ###
2511
2512   my $address = exists($options{'address1'})
2513                     ? $options{'address1'}
2514                     : $self->address1;
2515   my $address2 = exists($options{'address2'})
2516                     ? $options{'address2'}
2517                     : $self->address2;
2518   $address .= ", ". $address2 if length($address2);
2519
2520   my $o_payname = exists($options{'payname'})
2521                     ? $options{'payname'}
2522                     : $self->payname;
2523   my($payname, $payfirst, $paylast);
2524   if ( $o_payname && $method ne 'ECHECK' ) {
2525     ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2526       or return "Illegal payname $payname";
2527     ($payfirst, $paylast) = ($1, $2);
2528   } else {
2529     $payfirst = $self->getfield('first');
2530     $paylast = $self->getfield('last');
2531     $payname =  "$payfirst $paylast";
2532   }
2533
2534   my @invoicing_list = grep { $_ ne 'POST' } $self->invoicing_list;
2535   if ( $conf->exists('emailinvoiceauto')
2536        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
2537     push @invoicing_list, $self->all_emails;
2538   }
2539
2540   my $email = ($conf->exists('business-onlinepayment-email-override'))
2541               ? $conf->config('business-onlinepayment-email-override')
2542               : $invoicing_list[0];
2543
2544   my %content = ();
2545
2546   my $payip = exists($options{'payip'})
2547                 ? $options{'payip'}
2548                 : $self->payip;
2549   $content{customer_ip} = $payip
2550     if length($payip);
2551
2552   $content{invoice_number} = $options{'invnum'}
2553     if exists($options{'invnum'}) && length($options{'invnum'});
2554
2555   if ( $method eq 'CC' ) {
2556
2557     $content{card_number} = $payinfo;
2558     my $paydate = exists($options{'paydate'})
2559                     ? $options{'paydate'}
2560                     : $self->paydate;
2561     $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2562     $content{expiration} = "$2/$1";
2563
2564     my $paycvv = exists($options{'paycvv'})
2565                    ? $options{'paycvv'}
2566                    : $self->paycvv;
2567     $content{cvv2} = $self->paycvv
2568       if length($paycvv);
2569
2570     my $paystart_month = exists($options{'paystart_month'})
2571                            ? $options{'paystart_month'}
2572                            : $self->paystart_month;
2573
2574     my $paystart_year  = exists($options{'paystart_year'})
2575                            ? $options{'paystart_year'}
2576                            : $self->paystart_year;
2577
2578     $content{card_start} = "$paystart_month/$paystart_year"
2579       if $paystart_month && $paystart_year;
2580
2581     my $payissue       = exists($options{'payissue'})
2582                            ? $options{'payissue'}
2583                            : $self->payissue;
2584     $content{issue_number} = $payissue if $payissue;
2585
2586     $content{recurring_billing} = 'YES'
2587       if qsearch('cust_pay', { 'custnum' => $self->custnum,
2588                                'payby'   => 'CARD',
2589                                'payinfo' => $payinfo,
2590                              } )
2591       || qsearch('cust_pay', { 'custnum' => $self->custnum,
2592                                'payby'   => 'CARD',
2593                                'paymask' => $self->mask_payinfo('CARD', $payinfo),
2594                              } );
2595
2596
2597   } elsif ( $method eq 'ECHECK' ) {
2598     ( $content{account_number}, $content{routing_code} ) =
2599       split('@', $payinfo);
2600     $content{bank_name} = $o_payname;
2601     $content{account_type} = 'CHECKING';
2602     $content{account_name} = $payname;
2603     $content{customer_org} = $self->company ? 'B' : 'I';
2604     $content{customer_ssn} = exists($options{'ss'})
2605                                ? $options{'ss'}
2606                                : $self->ss;
2607   } elsif ( $method eq 'LEC' ) {
2608     $content{phone} = $payinfo;
2609   }
2610
2611   ###
2612   # run transaction(s)
2613   ###
2614
2615   my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
2616
2617   my $transaction = new Business::OnlinePayment( $processor, @bop_options );
2618   $transaction->content(
2619     'type'           => $method,
2620     'login'          => $login,
2621     'password'       => $password,
2622     'action'         => $action1,
2623     'description'    => $options{'description'},
2624     'amount'         => $amount,
2625     #'invoice_number' => $options{'invnum'},
2626     'customer_id'    => $self->custnum,
2627     'last_name'      => $paylast,
2628     'first_name'     => $payfirst,
2629     'name'           => $payname,
2630     'address'        => $address,
2631     'city'           => ( exists($options{'city'})
2632                             ? $options{'city'}
2633                             : $self->city          ),
2634     'state'          => ( exists($options{'state'})
2635                             ? $options{'state'}
2636                             : $self->state          ),
2637     'zip'            => ( exists($options{'zip'})
2638                             ? $options{'zip'}
2639                             : $self->zip          ),
2640     'country'        => ( exists($options{'country'})
2641                             ? $options{'country'}
2642                             : $self->country          ),
2643     'referer'        => 'http://cleanwhisker.420.am/',
2644     'email'          => $email,
2645     'phone'          => $self->daytime || $self->night,
2646     %content, #after
2647   );
2648   $transaction->submit();
2649
2650   if ( $transaction->is_success() && $action2 ) {
2651     my $auth = $transaction->authorization;
2652     my $ordernum = $transaction->can('order_number')
2653                    ? $transaction->order_number
2654                    : '';
2655
2656     my $capture =
2657       new Business::OnlinePayment( $processor, @bop_options );
2658
2659     my %capture = (
2660       %content,
2661       type           => $method,
2662       action         => $action2,
2663       login          => $login,
2664       password       => $password,
2665       order_number   => $ordernum,
2666       amount         => $amount,
2667       authorization  => $auth,
2668       description    => $options{'description'},
2669     );
2670
2671     foreach my $field (qw( authorization_source_code returned_ACI
2672                            transaction_identifier validation_code
2673                            transaction_sequence_num local_transaction_date
2674                            local_transaction_time AVS_result_code          )) {
2675       $capture{$field} = $transaction->$field() if $transaction->can($field);
2676     }
2677
2678     $capture->content( %capture );
2679
2680     $capture->submit();
2681
2682     unless ( $capture->is_success ) {
2683       my $e = "Authorization successful but capture failed, custnum #".
2684               $self->custnum. ': '.  $capture->result_code.
2685               ": ". $capture->error_message;
2686       warn $e;
2687       return $e;
2688     }
2689
2690   }
2691
2692   ###
2693   # remove paycvv after initial transaction
2694   ###
2695
2696   #false laziness w/misc/process/payment.cgi - check both to make sure working
2697   # correctly
2698   if ( defined $self->dbdef_table->column('paycvv')
2699        && length($self->paycvv)
2700        && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
2701   ) {
2702     my $error = $self->remove_cvv;
2703     if ( $error ) {
2704       warn "WARNING: error removing cvv: $error\n";
2705     }
2706   }
2707
2708   ###
2709   # result handling
2710   ###
2711
2712   if ( $transaction->is_success() ) {
2713
2714     my %method2payby = (
2715       'CC'     => 'CARD',
2716       'ECHECK' => 'CHEK',
2717       'LEC'    => 'LECB',
2718     );
2719
2720     my $paybatch = '';
2721     if ( $payment_gateway ) { # agent override
2722       $paybatch = $payment_gateway->gatewaynum. '-';
2723     }
2724
2725     $paybatch .= "$processor:". $transaction->authorization;
2726
2727     $paybatch .= ':'. $transaction->order_number
2728       if $transaction->can('order_number')
2729       && length($transaction->order_number);
2730
2731     my $cust_pay = new FS::cust_pay ( {
2732        'custnum'  => $self->custnum,
2733        'invnum'   => $options{'invnum'},
2734        'paid'     => $amount,
2735        '_date'     => '',
2736        'payby'    => $method2payby{$method},
2737        'payinfo'  => $payinfo,
2738        'paybatch' => $paybatch,
2739     } );
2740     my $error = $cust_pay->insert;
2741     if ( $error ) {
2742       $cust_pay->invnum(''); #try again with no specific invnum
2743       my $error2 = $cust_pay->insert;
2744       if ( $error2 ) {
2745         # gah, even with transactions.
2746         my $e = 'WARNING: Card/ACH debited but database not updated - '.
2747                 "error inserting payment ($processor): $error2".
2748                 " (previously tried insert with invnum #$options{'invnum'}" .
2749                 ": $error )";
2750         warn $e;
2751         return $e;
2752       }
2753     }
2754     return ''; #no error
2755
2756   } else {
2757
2758     my $perror = "$processor error: ". $transaction->error_message;
2759
2760     if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
2761          && $conf->exists('emaildecline')
2762          && grep { $_ ne 'POST' } $self->invoicing_list
2763          && ! grep { $transaction->error_message =~ /$_/ }
2764                    $conf->config('emaildecline-exclude')
2765     ) {
2766       my @templ = $conf->config('declinetemplate');
2767       my $template = new Text::Template (
2768         TYPE   => 'ARRAY',
2769         SOURCE => [ map "$_\n", @templ ],
2770       ) or return "($perror) can't create template: $Text::Template::ERROR";
2771       $template->compile()
2772         or return "($perror) can't compile template: $Text::Template::ERROR";
2773
2774       my $templ_hash = { error => $transaction->error_message };
2775
2776       my $error = send_email(
2777         'from'    => $conf->config('invoice_from'),
2778         'to'      => [ grep { $_ ne 'POST' } $self->invoicing_list ],
2779         'subject' => 'Your payment could not be processed',
2780         'body'    => [ $template->fill_in(HASH => $templ_hash) ],
2781       );
2782
2783       $perror .= " (also received error sending decline notification: $error)"
2784         if $error;
2785
2786     }
2787
2788     return $perror;
2789   }
2790
2791 }
2792
2793 =item default_payment_gateway
2794
2795 =cut
2796
2797 sub default_payment_gateway {
2798   my( $self, $method ) = @_;
2799
2800   die "Real-time processing not enabled\n"
2801     unless $conf->exists('business-onlinepayment');
2802
2803   #load up config
2804   my $bop_config = 'business-onlinepayment';
2805   $bop_config .= '-ach'
2806     if $method eq 'ECHECK' && $conf->exists($bop_config. '-ach');
2807   my ( $processor, $login, $password, $action, @bop_options ) =
2808     $conf->config($bop_config);
2809   $action ||= 'normal authorization';
2810   pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
2811   die "No real-time processor is enabled - ".
2812       "did you set the business-onlinepayment configuration value?\n"
2813     unless $processor;
2814
2815   ( $processor, $login, $password, $action, @bop_options )
2816 }
2817
2818 =item remove_cvv
2819
2820 Removes the I<paycvv> field from the database directly.
2821
2822 If there is an error, returns the error, otherwise returns false.
2823
2824 =cut
2825
2826 sub remove_cvv {
2827   my $self = shift;
2828   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2829     or return dbh->errstr;
2830   $sth->execute($self->custnum)
2831     or return $sth->errstr;
2832   $self->paycvv('');
2833   '';
2834 }
2835
2836 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
2837
2838 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
2839 via a Business::OnlinePayment realtime gateway.  See
2840 L<http://420.am/business-onlinepayment> for supported gateways.
2841
2842 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2843
2844 Available options are: I<amount>, I<reason>, I<paynum>
2845
2846 Most gateways require a reference to an original payment transaction to refund,
2847 so you probably need to specify a I<paynum>.
2848
2849 I<amount> defaults to the original amount of the payment if not specified.
2850
2851 I<reason> specifies a reason for the refund.
2852
2853 Implementation note: If I<amount> is unspecified or equal to the amount of the
2854 orignal payment, first an attempt is made to "void" the transaction via
2855 the gateway (to cancel a not-yet settled transaction) and then if that fails,
2856 the normal attempt is made to "refund" ("credit") the transaction via the
2857 gateway is attempted.
2858
2859 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2860 #I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
2861 #if set, will override the value from the customer record.
2862
2863 #If an I<invnum> is specified, this payment (if successful) is applied to the
2864 #specified invoice.  If you don't specify an I<invnum> you might want to
2865 #call the B<apply_payments> method.
2866
2867 =cut
2868
2869 #some false laziness w/realtime_bop, not enough to make it worth merging
2870 #but some useful small subs should be pulled out
2871 sub realtime_refund_bop {
2872   my( $self, $method, %options ) = @_;
2873   if ( $DEBUG ) {
2874     warn "$me realtime_refund_bop: $method refund\n";
2875     warn "  $_ => $options{$_}\n" foreach keys %options;
2876   }
2877
2878   eval "use Business::OnlinePayment";
2879   die $@ if $@;
2880
2881   ###
2882   # look up the original payment and optionally a gateway for that payment
2883   ###
2884
2885   my $cust_pay = '';
2886   my $amount = $options{'amount'};
2887
2888   my( $processor, $login, $password, @bop_options ) ;
2889   my( $auth, $order_number ) = ( '', '', '' );
2890
2891   if ( $options{'paynum'} ) {
2892
2893     warn "  paynum: $options{paynum}\n" if $DEBUG > 1;
2894     $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
2895       or return "Unknown paynum $options{'paynum'}";
2896     $amount ||= $cust_pay->paid;
2897
2898     $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-]*)(:([\w\-]+))?$/
2899       or return "Can't parse paybatch for paynum $options{'paynum'}: ".
2900                 $cust_pay->paybatch;
2901     my $gatewaynum = '';
2902     ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
2903
2904     if ( $gatewaynum ) { #gateway for the payment to be refunded
2905
2906       my $payment_gateway =
2907         qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
2908       die "payment gateway $gatewaynum not found"
2909         unless $payment_gateway;
2910
2911       $processor   = $payment_gateway->gateway_module;
2912       $login       = $payment_gateway->gateway_username;
2913       $password    = $payment_gateway->gateway_password;
2914       @bop_options = $payment_gateway->options;
2915
2916     } else { #try the default gateway
2917
2918       my( $conf_processor, $unused_action );
2919       ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
2920         $self->default_payment_gateway($method);
2921
2922       return "processor of payment $options{'paynum'} $processor does not".
2923              " match default processor $conf_processor"
2924         unless $processor eq $conf_processor;
2925
2926     }
2927
2928
2929   } else { # didn't specify a paynum, so look for agent gateway overrides
2930            # like a normal transaction
2931
2932     my $cardtype;
2933     if ( $method eq 'CC' ) {
2934       $cardtype = cardtype($self->payinfo);
2935     } elsif ( $method eq 'ECHECK' ) {
2936       $cardtype = 'ACH';
2937     } else {
2938       $cardtype = $method;
2939     }
2940     my $override =
2941            qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2942                                                cardtype => $cardtype,
2943                                                taxclass => '',              } )
2944         || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2945                                                cardtype => '',
2946                                                taxclass => '',              } );
2947
2948     if ( $override ) { #use a payment gateway override
2949
2950       my $payment_gateway = $override->payment_gateway;
2951
2952       $processor   = $payment_gateway->gateway_module;
2953       $login       = $payment_gateway->gateway_username;
2954       $password    = $payment_gateway->gateway_password;
2955       #$action      = $payment_gateway->gateway_action;
2956       @bop_options = $payment_gateway->options;
2957
2958     } else { #use the standard settings from the config
2959
2960       my $unused_action;
2961       ( $processor, $login, $password, $unused_action, @bop_options ) =
2962         $self->default_payment_gateway($method);
2963
2964     }
2965
2966   }
2967   return "neither amount nor paynum specified" unless $amount;
2968
2969   my %content = (
2970     'type'           => $method,
2971     'login'          => $login,
2972     'password'       => $password,
2973     'order_number'   => $order_number,
2974     'amount'         => $amount,
2975     'referer'        => 'http://cleanwhisker.420.am/',
2976   );
2977   $content{authorization} = $auth
2978     if length($auth); #echeck/ACH transactions have an order # but no auth
2979                       #(at least with authorize.net)
2980
2981   #first try void if applicable
2982   if ( $cust_pay && $cust_pay->paid == $amount ) { #and check dates?
2983     warn "  attempting void\n" if $DEBUG > 1;
2984     my $void = new Business::OnlinePayment( $processor, @bop_options );
2985     $void->content( 'action' => 'void', %content );
2986     $void->submit();
2987     if ( $void->is_success ) {
2988       my $error = $cust_pay->void($options{'reason'});
2989       if ( $error ) {
2990         # gah, even with transactions.
2991         my $e = 'WARNING: Card/ACH voided but database not updated - '.
2992                 "error voiding payment: $error";
2993         warn $e;
2994         return $e;
2995       }
2996       warn "  void successful\n" if $DEBUG > 1;
2997       return '';
2998     }
2999   }
3000
3001   warn "  void unsuccessful, trying refund\n"
3002     if $DEBUG > 1;
3003
3004   #massage data
3005   my $address = $self->address1;
3006   $address .= ", ". $self->address2 if $self->address2;
3007
3008   my($payname, $payfirst, $paylast);
3009   if ( $self->payname && $method ne 'ECHECK' ) {
3010     $payname = $self->payname;
3011     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3012       or return "Illegal payname $payname";
3013     ($payfirst, $paylast) = ($1, $2);
3014   } else {
3015     $payfirst = $self->getfield('first');
3016     $paylast = $self->getfield('last');
3017     $payname =  "$payfirst $paylast";
3018   }
3019
3020   my @invoicing_list = grep { $_ ne 'POST' } $self->invoicing_list;
3021   if ( $conf->exists('emailinvoiceauto')
3022        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3023     push @invoicing_list, $self->all_emails;
3024   }
3025
3026   my $email = ($conf->exists('business-onlinepayment-email-override'))
3027               ? $conf->config('business-onlinepayment-email-override')
3028               : $invoicing_list[0];
3029
3030   my $payip = exists($options{'payip'})
3031                 ? $options{'payip'}
3032                 : $self->payip;
3033   $content{customer_ip} = $payip
3034     if length($payip);
3035
3036   my $payinfo = '';
3037   if ( $method eq 'CC' ) {
3038
3039     if ( $cust_pay ) {
3040       $content{card_number} = $payinfo = $cust_pay->payinfo;
3041       #$self->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3042       #$content{expiration} = "$2/$1";
3043     } else {
3044       $content{card_number} = $payinfo = $self->payinfo;
3045       $self->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3046       $content{expiration} = "$2/$1";
3047     }
3048
3049   } elsif ( $method eq 'ECHECK' ) {
3050     ( $content{account_number}, $content{routing_code} ) =
3051       split('@', $payinfo = $self->payinfo);
3052     $content{bank_name} = $self->payname;
3053     $content{account_type} = 'CHECKING';
3054     $content{account_name} = $payname;
3055     $content{customer_org} = $self->company ? 'B' : 'I';
3056     $content{customer_ssn} = $self->ss;
3057   } elsif ( $method eq 'LEC' ) {
3058     $content{phone} = $payinfo = $self->payinfo;
3059   }
3060
3061   #then try refund
3062   my $refund = new Business::OnlinePayment( $processor, @bop_options );
3063   my %sub_content = $refund->content(
3064     'action'         => 'credit',
3065     'customer_id'    => $self->custnum,
3066     'last_name'      => $paylast,
3067     'first_name'     => $payfirst,
3068     'name'           => $payname,
3069     'address'        => $address,
3070     'city'           => $self->city,
3071     'state'          => $self->state,
3072     'zip'            => $self->zip,
3073     'country'        => $self->country,
3074     'email'          => $email,
3075     'phone'          => $self->daytime || $self->night,
3076     %content, #after
3077   );
3078   warn join('', map { "  $_ => $sub_content{$_}\n" } keys %sub_content )
3079     if $DEBUG > 1;
3080   $refund->submit();
3081
3082   return "$processor error: ". $refund->error_message
3083     unless $refund->is_success();
3084
3085   my %method2payby = (
3086     'CC'     => 'CARD',
3087     'ECHECK' => 'CHEK',
3088     'LEC'    => 'LECB',
3089   );
3090
3091   my $paybatch = "$processor:". $refund->authorization;
3092   $paybatch .= ':'. $refund->order_number
3093     if $refund->can('order_number') && $refund->order_number;
3094
3095   while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3096     my @cust_bill_pay = $cust_pay->cust_bill_pay;
3097     last unless @cust_bill_pay;
3098     my $cust_bill_pay = pop @cust_bill_pay;
3099     my $error = $cust_bill_pay->delete;
3100     last if $error;
3101   }
3102
3103   my $cust_refund = new FS::cust_refund ( {
3104     'custnum'  => $self->custnum,
3105     'paynum'   => $options{'paynum'},
3106     'refund'   => $amount,
3107     '_date'    => '',
3108     'payby'    => $method2payby{$method},
3109     'payinfo'  => $payinfo,
3110     'paybatch' => $paybatch,
3111     'reason'   => $options{'reason'} || 'card or ACH refund',
3112   } );
3113   my $error = $cust_refund->insert;
3114   if ( $error ) {
3115     $cust_refund->paynum(''); #try again with no specific paynum
3116     my $error2 = $cust_refund->insert;
3117     if ( $error2 ) {
3118       # gah, even with transactions.
3119       my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3120               "error inserting refund ($processor): $error2".
3121               " (previously tried insert with paynum #$options{'paynum'}" .
3122               ": $error )";
3123       warn $e;
3124       return $e;
3125     }
3126   }
3127
3128   ''; #no error
3129
3130 }
3131
3132 =item total_owed
3133
3134 Returns the total owed for this customer on all invoices
3135 (see L<FS::cust_bill/owed>).
3136
3137 =cut
3138
3139 sub total_owed {
3140   my $self = shift;
3141   $self->total_owed_date(2145859200); #12/31/2037
3142 }
3143
3144 =item total_owed_date TIME
3145
3146 Returns the total owed for this customer on all invoices with date earlier than
3147 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
3148 see L<Time::Local> and L<Date::Parse> for conversion functions.
3149
3150 =cut
3151
3152 sub total_owed_date {
3153   my $self = shift;
3154   my $time = shift;
3155   my $total_bill = 0;
3156   foreach my $cust_bill (
3157     grep { $_->_date <= $time }
3158       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3159   ) {
3160     $total_bill += $cust_bill->owed;
3161   }
3162   sprintf( "%.2f", $total_bill );
3163 }
3164
3165 =item apply_payments_and_credits
3166
3167 Applies unapplied payments and credits.
3168
3169 In most cases, this new method should be used in place of sequential
3170 apply_payments and apply_credits methods.
3171
3172 =cut
3173
3174 sub apply_payments_and_credits {
3175   my $self = shift;
3176
3177   foreach my $cust_bill ( $self->open_cust_bill ) {
3178     $cust_bill->apply_payments_and_credits;
3179   }
3180
3181 }
3182
3183 =item apply_credits OPTION => VALUE ...
3184
3185 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3186 to outstanding invoice balances in chronological order (or reverse
3187 chronological order if the I<order> option is set to B<newest>) and returns the
3188 value of any remaining unapplied credits available for refund (see
3189 L<FS::cust_refund>).
3190
3191 =cut
3192
3193 sub apply_credits {
3194   my $self = shift;
3195   my %opt = @_;
3196
3197   return 0 unless $self->total_credited;
3198
3199   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3200       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3201
3202   my @invoices = $self->open_cust_bill;
3203   @invoices = sort { $b->_date <=> $a->_date } @invoices
3204     if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3205
3206   my $credit;
3207   foreach my $cust_bill ( @invoices ) {
3208     my $amount;
3209
3210     if ( !defined($credit) || $credit->credited == 0) {
3211       $credit = pop @credits or last;
3212     }
3213
3214     if ($cust_bill->owed >= $credit->credited) {
3215       $amount=$credit->credited;
3216     }else{
3217       $amount=$cust_bill->owed;
3218     }
3219
3220     my $cust_credit_bill = new FS::cust_credit_bill ( {
3221       'crednum' => $credit->crednum,
3222       'invnum'  => $cust_bill->invnum,
3223       'amount'  => $amount,
3224     } );
3225     my $error = $cust_credit_bill->insert;
3226     die $error if $error;
3227
3228     redo if ($cust_bill->owed > 0);
3229
3230   }
3231
3232   return $self->total_credited;
3233 }
3234
3235 =item apply_payments
3236
3237 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3238 to outstanding invoice balances in chronological order.
3239
3240  #and returns the value of any remaining unapplied payments.
3241
3242 =cut
3243
3244 sub apply_payments {
3245   my $self = shift;
3246
3247   #return 0 unless
3248
3249   my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
3250       qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
3251
3252   my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
3253       qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
3254
3255   my $payment;
3256
3257   foreach my $cust_bill ( @invoices ) {
3258     my $amount;
3259
3260     if ( !defined($payment) || $payment->unapplied == 0 ) {
3261       $payment = pop @payments or last;
3262     }
3263
3264     if ( $cust_bill->owed >= $payment->unapplied ) {
3265       $amount = $payment->unapplied;
3266     } else {
3267       $amount = $cust_bill->owed;
3268     }
3269
3270     my $cust_bill_pay = new FS::cust_bill_pay ( {
3271       'paynum' => $payment->paynum,
3272       'invnum' => $cust_bill->invnum,
3273       'amount' => $amount,
3274     } );
3275     my $error = $cust_bill_pay->insert;
3276     die $error if $error;
3277
3278     redo if ( $cust_bill->owed > 0);
3279
3280   }
3281
3282   return $self->total_unapplied_payments;
3283 }
3284
3285 =item total_credited
3286
3287 Returns the total outstanding credit (see L<FS::cust_credit>) for this
3288 customer.  See L<FS::cust_credit/credited>.
3289
3290 =cut
3291
3292 sub total_credited {
3293   my $self = shift;
3294   my $total_credit = 0;
3295   foreach my $cust_credit ( qsearch('cust_credit', {
3296     'custnum' => $self->custnum,
3297   } ) ) {
3298     $total_credit += $cust_credit->credited;
3299   }
3300   sprintf( "%.2f", $total_credit );
3301 }
3302
3303 =item total_unapplied_payments
3304
3305 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
3306 See L<FS::cust_pay/unapplied>.
3307
3308 =cut
3309
3310 sub total_unapplied_payments {
3311   my $self = shift;
3312   my $total_unapplied = 0;
3313   foreach my $cust_pay ( qsearch('cust_pay', {
3314     'custnum' => $self->custnum,
3315   } ) ) {
3316     $total_unapplied += $cust_pay->unapplied;
3317   }
3318   sprintf( "%.2f", $total_unapplied );
3319 }
3320
3321 =item balance
3322
3323 Returns the balance for this customer (total_owed minus total_credited
3324 minus total_unapplied_payments).
3325
3326 =cut
3327
3328 sub balance {
3329   my $self = shift;
3330   sprintf( "%.2f",
3331     $self->total_owed - $self->total_credited - $self->total_unapplied_payments
3332   );
3333 }
3334
3335 =item balance_date TIME
3336
3337 Returns the balance for this customer, only considering invoices with date
3338 earlier than TIME (total_owed_date minus total_credited minus
3339 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
3340 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
3341 functions.
3342
3343 =cut
3344
3345 sub balance_date {
3346   my $self = shift;
3347   my $time = shift;
3348   sprintf( "%.2f",
3349     $self->total_owed_date($time)
3350       - $self->total_credited
3351       - $self->total_unapplied_payments
3352   );
3353 }
3354
3355 =item in_transit_payments
3356
3357 Returns the total of requests for payments for this customer pending in
3358 batches in transit to the bank.  See L<FS::pay_batch> and L<FS::cust_pay_batch>
3359
3360 =cut
3361
3362 sub in_transit_payments {
3363   my $self = shift;
3364   my $in_transit_payments = 0;
3365   foreach my $pay_batch ( qsearch('pay_batch', {
3366     'status' => 'I',
3367   } ) ) {
3368     foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
3369       'batchnum' => $pay_batch->batchnum,
3370       'custnum' => $self->custnum,
3371     } ) ) {
3372       $in_transit_payments += $cust_pay_batch->amount;
3373     }
3374   }
3375   sprintf( "%.2f", $in_transit_payments );
3376 }
3377
3378 =item paydate_monthyear
3379
3380 Returns a two-element list consisting of the month and year of this customer's
3381 paydate (credit card expiration date for CARD customers)
3382
3383 =cut
3384
3385 sub paydate_monthyear {
3386   my $self = shift;
3387   if ( $self->paydate  =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3388     ( $2, $1 );
3389   } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3390     ( $1, $3 );
3391   } else {
3392     ('', '');
3393   }
3394 }
3395
3396 =item invoicing_list [ ARRAYREF ]
3397
3398 If an arguement is given, sets these email addresses as invoice recipients
3399 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
3400 (except as warnings), so use check_invoicing_list first.
3401
3402 Returns a list of email addresses (with svcnum entries expanded).
3403
3404 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
3405 check it without disturbing anything by passing nothing.
3406
3407 This interface may change in the future.
3408
3409 =cut
3410
3411 sub invoicing_list {
3412   my( $self, $arrayref ) = @_;
3413
3414   if ( $arrayref ) {
3415     my @cust_main_invoice;
3416     if ( $self->custnum ) {
3417       @cust_main_invoice =
3418         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3419     } else {
3420       @cust_main_invoice = ();
3421     }
3422     foreach my $cust_main_invoice ( @cust_main_invoice ) {
3423       #warn $cust_main_invoice->destnum;
3424       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3425         #warn $cust_main_invoice->destnum;
3426         my $error = $cust_main_invoice->delete;
3427         warn $error if $error;
3428       }
3429     }
3430     if ( $self->custnum ) {
3431       @cust_main_invoice =
3432         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3433     } else {
3434       @cust_main_invoice = ();
3435     }
3436     my %seen = map { $_->address => 1 } @cust_main_invoice;
3437     foreach my $address ( @{$arrayref} ) {
3438       next if exists $seen{$address} && $seen{$address};
3439       $seen{$address} = 1;
3440       my $cust_main_invoice = new FS::cust_main_invoice ( {
3441         'custnum' => $self->custnum,
3442         'dest'    => $address,
3443       } );
3444       my $error = $cust_main_invoice->insert;
3445       warn $error if $error;
3446     }
3447   }
3448
3449   if ( $self->custnum ) {
3450     map { $_->address }
3451       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3452   } else {
3453     ();
3454   }
3455
3456 }
3457
3458 =item check_invoicing_list ARRAYREF
3459
3460 Checks these arguements as valid input for the invoicing_list method.  If there
3461 is an error, returns the error, otherwise returns false.
3462
3463 =cut
3464
3465 sub check_invoicing_list {
3466   my( $self, $arrayref ) = @_;
3467   foreach my $address ( @{$arrayref} ) {
3468
3469     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3470       return 'Can\'t add FAX invoice destination with a blank FAX number.';
3471     }
3472
3473     my $cust_main_invoice = new FS::cust_main_invoice ( {
3474       'custnum' => $self->custnum,
3475       'dest'    => $address,
3476     } );
3477     my $error = $self->custnum
3478                 ? $cust_main_invoice->check
3479                 : $cust_main_invoice->checkdest
3480     ;
3481     return $error if $error;
3482   }
3483   '';
3484 }
3485
3486 =item set_default_invoicing_list
3487
3488 Sets the invoicing list to all accounts associated with this customer,
3489 overwriting any previous invoicing list.
3490
3491 =cut
3492
3493 sub set_default_invoicing_list {
3494   my $self = shift;
3495   $self->invoicing_list($self->all_emails);
3496 }
3497
3498 =item all_emails
3499
3500 Returns the email addresses of all accounts provisioned for this customer.
3501
3502 =cut
3503
3504 sub all_emails {
3505   my $self = shift;
3506   my %list;
3507   foreach my $cust_pkg ( $self->all_pkgs ) {
3508     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3509     my @svc_acct =
3510       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3511         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3512           @cust_svc;
3513     $list{$_}=1 foreach map { $_->email } @svc_acct;
3514   }
3515   keys %list;
3516 }
3517
3518 =item invoicing_list_addpost
3519
3520 Adds postal invoicing to this customer.  If this customer is already configured
3521 to receive postal invoices, does nothing.
3522
3523 =cut
3524
3525 sub invoicing_list_addpost {
3526   my $self = shift;
3527   return if grep { $_ eq 'POST' } $self->invoicing_list;
3528   my @invoicing_list = $self->invoicing_list;
3529   push @invoicing_list, 'POST';
3530   $self->invoicing_list(\@invoicing_list);
3531 }
3532
3533 =item invoicing_list_emailonly
3534
3535 Returns the list of email invoice recipients (invoicing_list without non-email
3536 destinations such as POST and FAX).
3537
3538 =cut
3539
3540 sub invoicing_list_emailonly {
3541   my $self = shift;
3542   warn "$me invoicing_list_emailonly called"
3543     if $DEBUG;
3544   grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3545 }
3546
3547 =item invoicing_list_emailonly_scalar
3548
3549 Returns the list of email invoice recipients (invoicing_list without non-email
3550 destinations such as POST and FAX) as a comma-separated scalar.
3551
3552 =cut
3553
3554 sub invoicing_list_emailonly_scalar {
3555   my $self = shift;
3556   warn "$me invoicing_list_emailonly_scalar called"
3557     if $DEBUG;
3558   join(', ', $self->invoicing_list_emailonly);
3559 }
3560
3561 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3562
3563 Returns an array of customers referred by this customer (referral_custnum set
3564 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
3565 customers referred by customers referred by this customer and so on, inclusive.
3566 The default behavior is DEPTH 1 (no recursion).
3567
3568 =cut
3569
3570 sub referral_cust_main {
3571   my $self = shift;
3572   my $depth = @_ ? shift : 1;
3573   my $exclude = @_ ? shift : {};
3574
3575   my @cust_main =
3576     map { $exclude->{$_->custnum}++; $_; }
3577       grep { ! $exclude->{ $_->custnum } }
3578         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3579
3580   if ( $depth > 1 ) {
3581     push @cust_main,
3582       map { $_->referral_cust_main($depth-1, $exclude) }
3583         @cust_main;
3584   }
3585
3586   @cust_main;
3587 }
3588
3589 =item referral_cust_main_ncancelled
3590
3591 Same as referral_cust_main, except only returns customers with uncancelled
3592 packages.
3593
3594 =cut
3595
3596 sub referral_cust_main_ncancelled {
3597   my $self = shift;
3598   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3599 }
3600
3601 =item referral_cust_pkg [ DEPTH ]
3602
3603 Like referral_cust_main, except returns a flat list of all unsuspended (and
3604 uncancelled) packages for each customer.  The number of items in this list may
3605 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3606
3607 =cut
3608
3609 sub referral_cust_pkg {
3610   my $self = shift;
3611   my $depth = @_ ? shift : 1;
3612
3613   map { $_->unsuspended_pkgs }
3614     grep { $_->unsuspended_pkgs }
3615       $self->referral_cust_main($depth);
3616 }
3617
3618 =item referring_cust_main
3619
3620 Returns the single cust_main record for the customer who referred this customer
3621 (referral_custnum), or false.
3622
3623 =cut
3624
3625 sub referring_cust_main {
3626   my $self = shift;
3627   return '' unless $self->referral_custnum;
3628   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3629 }
3630
3631 =item credit AMOUNT, REASON
3632
3633 Applies a credit to this customer.  If there is an error, returns the error,
3634 otherwise returns false.
3635
3636 =cut
3637
3638 sub credit {
3639   my( $self, $amount, $reason ) = @_;
3640   my $cust_credit = new FS::cust_credit {
3641     'custnum' => $self->custnum,
3642     'amount'  => $amount,
3643     'reason'  => $reason,
3644   };
3645   $cust_credit->insert;
3646 }
3647
3648 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3649
3650 Creates a one-time charge for this customer.  If there is an error, returns
3651 the error, otherwise returns false.
3652
3653 =cut
3654
3655 sub charge {
3656   my $self = shift;
3657   my ( $amount, $pkg, $comment, $taxclass, $additional );
3658   if ( ref( $_[0] ) ) {
3659     $amount     = $_[0]->{amount};
3660     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3661     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
3662                                            : '$'. sprintf("%.2f",$amount);
3663     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3664     $additional = $_[0]->{additional};
3665   }else{
3666     $amount     = shift;
3667     $pkg        = @_ ? shift : 'One-time charge';
3668     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
3669     $taxclass   = @_ ? shift : '';
3670     $additional = [];
3671   }
3672
3673   local $SIG{HUP} = 'IGNORE';
3674   local $SIG{INT} = 'IGNORE';
3675   local $SIG{QUIT} = 'IGNORE';
3676   local $SIG{TERM} = 'IGNORE';
3677   local $SIG{TSTP} = 'IGNORE';
3678   local $SIG{PIPE} = 'IGNORE';
3679
3680   my $oldAutoCommit = $FS::UID::AutoCommit;
3681   local $FS::UID::AutoCommit = 0;
3682   my $dbh = dbh;
3683
3684   my $part_pkg = new FS::part_pkg ( {
3685     'pkg'      => $pkg,
3686     'comment'  => $comment,
3687     'plan'     => 'flat',
3688     'freq'     => 0,
3689     'disabled' => 'Y',
3690     'taxclass' => $taxclass,
3691   } );
3692
3693   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3694                         ( 0 .. @$additional - 1 )
3695                   ),
3696                   'additional_count' => scalar(@$additional),
3697                   'setup_fee' => $amount,
3698                 );
3699
3700   my $error = $part_pkg->insert( options => \%options );
3701   if ( $error ) {
3702     $dbh->rollback if $oldAutoCommit;
3703     return $error;
3704   }
3705
3706   my $pkgpart = $part_pkg->pkgpart;
3707   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3708   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3709     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3710     $error = $type_pkgs->insert;
3711     if ( $error ) {
3712       $dbh->rollback if $oldAutoCommit;
3713       return $error;
3714     }
3715   }
3716
3717   my $cust_pkg = new FS::cust_pkg ( {
3718     'custnum' => $self->custnum,
3719     'pkgpart' => $pkgpart,
3720   } );
3721
3722   $error = $cust_pkg->insert;
3723   if ( $error ) {
3724     $dbh->rollback if $oldAutoCommit;
3725     return $error;
3726   }
3727
3728   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3729   '';
3730
3731 }
3732
3733 =item cust_bill
3734
3735 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3736
3737 =cut
3738
3739 sub cust_bill {
3740   my $self = shift;
3741   sort { $a->_date <=> $b->_date }
3742     qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3743 }
3744
3745 =item open_cust_bill
3746
3747 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3748 customer.
3749
3750 =cut
3751
3752 sub open_cust_bill {
3753   my $self = shift;
3754   grep { $_->owed > 0 } $self->cust_bill;
3755 }
3756
3757 =item cust_credit
3758
3759 Returns all the credits (see L<FS::cust_credit>) for this customer.
3760
3761 =cut
3762
3763 sub cust_credit {
3764   my $self = shift;
3765   sort { $a->_date <=> $b->_date }
3766     qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3767 }
3768
3769 =item cust_pay
3770
3771 Returns all the payments (see L<FS::cust_pay>) for this customer.
3772
3773 =cut
3774
3775 sub cust_pay {
3776   my $self = shift;
3777   sort { $a->_date <=> $b->_date }
3778     qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3779 }
3780
3781 =item cust_pay_void
3782
3783 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3784
3785 =cut
3786
3787 sub cust_pay_void {
3788   my $self = shift;
3789   sort { $a->_date <=> $b->_date }
3790     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3791 }
3792
3793
3794 =item cust_refund
3795
3796 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3797
3798 =cut
3799
3800 sub cust_refund {
3801   my $self = shift;
3802   sort { $a->_date <=> $b->_date }
3803     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3804 }
3805
3806 =item select_for_update
3807
3808 Selects this record with the SQL "FOR UPDATE" command.  This can be useful as
3809 a mutex.
3810
3811 =cut
3812
3813 sub select_for_update {
3814   my $self = shift;
3815   qsearch('cust_main', { 'custnum' => $self->custnum }, '*', 'FOR UPDATE' );
3816 }
3817
3818 =item name
3819
3820 Returns a name string for this customer, either "Company (Last, First)" or
3821 "Last, First".
3822
3823 =cut
3824
3825 sub name {
3826   my $self = shift;
3827   my $name = $self->contact;
3828   $name = $self->company. " ($name)" if $self->company;
3829   $name;
3830 }
3831
3832 =item ship_name
3833
3834 Returns a name string for this (service/shipping) contact, either
3835 "Company (Last, First)" or "Last, First".
3836
3837 =cut
3838
3839 sub ship_name {
3840   my $self = shift;
3841   if ( $self->get('ship_last') ) {
3842     my $name = $self->ship_contact;
3843     $name = $self->ship_company. " ($name)" if $self->ship_company;
3844     $name;
3845   } else {
3846     $self->name;
3847   }
3848 }
3849
3850 =item contact
3851
3852 Returns this customer's full (billing) contact name only, "Last, First"
3853
3854 =cut
3855
3856 sub contact {
3857   my $self = shift;
3858   $self->get('last'). ', '. $self->first;
3859 }
3860
3861 =item ship_contact
3862
3863 Returns this customer's full (shipping) contact name only, "Last, First"
3864
3865 =cut
3866
3867 sub ship_contact {
3868   my $self = shift;
3869   $self->get('ship_last')
3870     ? $self->get('ship_last'). ', '. $self->ship_first
3871     : $self->contact;
3872 }
3873
3874 =item country_full
3875
3876 Returns this customer's full country name
3877
3878 =cut
3879
3880 sub country_full {
3881   my $self = shift;
3882   code2country($self->country);
3883 }
3884
3885 =item status
3886
3887 Returns a status string for this customer, currently:
3888
3889 =over 4
3890
3891 =item prospect - No packages have ever been ordered
3892
3893 =item active - One or more recurring packages is active
3894
3895 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
3896
3897 =item suspended - All non-cancelled recurring packages are suspended
3898
3899 =item cancelled - All recurring packages are cancelled
3900
3901 =back
3902
3903 =cut
3904
3905 sub status {
3906   my $self = shift;
3907   for my $status (qw( prospect active inactive suspended cancelled )) {
3908     my $method = $status.'_sql';
3909     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
3910     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
3911     $sth->execute( ($self->custnum) x $numnum ) or die $sth->errstr;
3912     return $status if $sth->fetchrow_arrayref->[0];
3913   }
3914 }
3915
3916 =item statuscolor
3917
3918 Returns a hex triplet color string for this customer's status.
3919
3920 =cut
3921
3922 use vars qw(%statuscolor);
3923 %statuscolor = (
3924   'prospect'  => '7e0079', #'000000', #black?  naw, purple
3925   'active'    => '00CC00', #green
3926   'inactive'  => '0000CC', #blue
3927   'suspended' => 'FF9900', #yellow
3928   'cancelled' => 'FF0000', #red
3929 );
3930
3931 sub statuscolor {
3932   my $self = shift;
3933   $statuscolor{$self->status};
3934 }
3935
3936 =back
3937
3938 =head1 CLASS METHODS
3939
3940 =over 4
3941
3942 =item prospect_sql
3943
3944 Returns an SQL expression identifying prospective cust_main records (customers
3945 with no packages ever ordered)
3946
3947 =cut
3948
3949 use vars qw($select_count_pkgs);
3950 $select_count_pkgs =
3951   "SELECT COUNT(*) FROM cust_pkg
3952     WHERE cust_pkg.custnum = cust_main.custnum";
3953
3954 sub select_count_pkgs_sql {
3955   $select_count_pkgs;
3956 }
3957
3958 sub prospect_sql { "
3959   0 = ( $select_count_pkgs )
3960 "; }
3961
3962 =item active_sql
3963
3964 Returns an SQL expression identifying active cust_main records (customers with
3965 no active recurring packages, but otherwise unsuspended/uncancelled).
3966
3967 =cut
3968
3969 sub active_sql { "
3970   0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
3971       )
3972 "; }
3973
3974 =item inactive_sql
3975
3976 Returns an SQL expression identifying inactive cust_main records (customers with
3977 active recurring packages).
3978
3979 =cut
3980
3981 sub inactive_sql { "
3982   0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
3983   AND
3984   0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
3985 "; }
3986
3987 =item susp_sql
3988 =item suspended_sql
3989
3990 Returns an SQL expression identifying suspended cust_main records.
3991
3992 =cut
3993
3994
3995 sub suspended_sql { susp_sql(@_); }
3996 sub susp_sql { "
3997     0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
3998     AND
3999     0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4000 "; }
4001
4002 =item cancel_sql
4003 =item cancelled_sql
4004
4005 Returns an SQL expression identifying cancelled cust_main records.
4006
4007 =cut
4008
4009 sub cancelled_sql { cancel_sql(@_); }
4010 sub cancel_sql {
4011
4012   my $recurring_sql = FS::cust_pkg->recurring_sql;
4013   #my $recurring_sql = "
4014   #  '0' != ( select freq from part_pkg
4015   #             where cust_pkg.pkgpart = part_pkg.pkgpart )
4016   #";
4017
4018   "
4019     0 < ( $select_count_pkgs )
4020     AND 0 = ( $select_count_pkgs AND $recurring_sql
4021                   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4022             )
4023   ";
4024 }
4025
4026 =item uncancel_sql
4027 =item uncancelled_sql
4028
4029 Returns an SQL expression identifying un-cancelled cust_main records.
4030
4031 =cut
4032
4033 sub uncancelled_sql { uncancel_sql(@_); }
4034 sub uncancel_sql { "
4035   ( 0 < ( $select_count_pkgs
4036                    AND ( cust_pkg.cancel IS NULL
4037                          OR cust_pkg.cancel = 0
4038                        )
4039         )
4040     OR 0 = ( $select_count_pkgs )
4041   )
4042 "; }
4043
4044 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
4045
4046 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
4047 records.  Currently, I<first>, I<last> and/or I<company> may be specified (the
4048 appropriate ship_ field is also searched).
4049
4050 Additional options are the same as FS::Record::qsearch
4051
4052 =cut
4053
4054 sub fuzzy_search {
4055   my( $self, $fuzzy, $hash, @opt) = @_;
4056   #$self
4057   $hash ||= {};
4058   my @cust_main = ();
4059
4060   check_and_rebuild_fuzzyfiles();
4061   foreach my $field ( keys %$fuzzy ) {
4062
4063     my $all = $self->all_X($field);
4064     next unless scalar(@$all);
4065
4066     my %match = ();
4067     $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
4068
4069     my @fcust = ();
4070     foreach ( keys %match ) {
4071       push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
4072       push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
4073     }
4074     my %fsaw = ();
4075     push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
4076   }
4077
4078   # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
4079   my %saw = ();
4080   @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
4081
4082   @cust_main;
4083
4084 }
4085
4086 =back
4087
4088 =head1 SUBROUTINES
4089
4090 =over 4
4091
4092 =item smart_search OPTION => VALUE ...
4093
4094 Accepts the following options: I<search>, the string to search for.  The string
4095 will be searched for as a customer number, phone number, name or company name,
4096 as an exact, or, in some cases, a substring or fuzzy match (see the source code
4097 for the exact heuristics used).
4098
4099 Any additional options are treated as an additional qualifier on the search
4100 (i.e. I<agentnum>).
4101
4102 Returns a (possibly empty) array of FS::cust_main objects.
4103
4104 =cut
4105
4106 sub smart_search {
4107   my %options = @_;
4108
4109   #here is the agent virtualization
4110   my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
4111
4112   my @cust_main = ();
4113
4114   my $search = delete $options{'search'};
4115   ( my $alphanum_search = $search ) =~ s/\W//g;
4116
4117   if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
4118
4119     #false laziness w/Record::ut_phone
4120     my $phonen = "$1-$2-$3";
4121     $phonen .= " x$4" if $4;
4122
4123     push @cust_main, qsearch( {
4124       'table'   => 'cust_main',
4125       'hashref' => { %options },
4126       'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4127                      ' ( '.
4128                          join(' OR ', map "$_ = '$phonen'",
4129                                           qw( daytime night fax
4130                                               ship_daytime ship_night ship_fax )
4131                              ).
4132                      ' ) '.
4133                      " AND $agentnums_sql", #agent virtualization
4134     } );
4135
4136     unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
4137       #try looking for matches with extensions unless one was specified
4138
4139       push @cust_main, qsearch( {
4140         'table'   => 'cust_main',
4141         'hashref' => { %options },
4142         'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4143                        ' ( '.
4144                            join(' OR ', map "$_ LIKE '$phonen\%'",
4145                                             qw( daytime night
4146                                                 ship_daytime ship_night )
4147                                ).
4148                        ' ) '.
4149                        " AND $agentnums_sql", #agent virtualization
4150       } );
4151
4152     }
4153
4154   } elsif ( $search =~ /^\s*(\d+)\s*$/ ) { # customer # search
4155
4156     push @cust_main, qsearch( {
4157       'table'     => 'cust_main',
4158       'hashref'   => { 'custnum' => $1, %options },
4159       'extra_sql' => " AND $agentnums_sql", #agent virtualization
4160     } );
4161
4162   } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
4163
4164     my($company, $last, $first) = ( $1, $2, $3 );
4165
4166     # "Company (Last, First)"
4167     #this is probably something a browser remembered,
4168     #so just do an exact search
4169
4170     foreach my $prefix ( '', 'ship_' ) {
4171       push @cust_main, qsearch( {
4172         'table'     => 'cust_main',
4173         'hashref'   => { $prefix.'first'   => $first,
4174                          $prefix.'last'    => $last,
4175                          $prefix.'company' => $company,
4176                          %options,
4177                        },
4178         'extra_sql' => " AND $agentnums_sql",
4179       } );
4180     }
4181
4182   } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
4183                                               # try (ship_){last,company}
4184
4185     my $value = lc($1);
4186
4187     # # remove "(Last, First)" in "Company (Last, First)", otherwise the
4188     # # full strings the browser remembers won't work
4189     # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
4190
4191     use Lingua::EN::NameParse;
4192     my $NameParse = new Lingua::EN::NameParse(
4193              auto_clean     => 1,
4194              allow_reversed => 1,
4195     );
4196
4197     my($last, $first) = ( '', '' );
4198     #maybe disable this too and just rely on NameParse?
4199     if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
4200
4201       ($last, $first) = ( $1, $2 );
4202
4203     #} elsif  ( $value =~ /^(.+)\s+(.+)$/ ) {
4204     } elsif ( ! $NameParse->parse($value) ) {
4205
4206       my %name = $NameParse->components;
4207       $first = $name{'given_name_1'};
4208       $last  = $name{'surname_1'};
4209
4210     }
4211
4212     if ( $first && $last ) {
4213
4214       my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
4215
4216       #exact
4217       my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4218       $sql .= "
4219         (     ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
4220            OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
4221         )";
4222
4223       push @cust_main, qsearch( {
4224         'table'     => 'cust_main',
4225         'hashref'   => \%options,
4226         'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4227       } );
4228
4229       # or it just be something that was typed in... (try that in a sec)
4230
4231     }
4232
4233     my $q_value = dbh->quote($value);
4234
4235     #exact
4236     my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4237     $sql .= " (    LOWER(last)         = $q_value
4238                 OR LOWER(company)      = $q_value
4239                 OR LOWER(ship_last)    = $q_value
4240                 OR LOWER(ship_company) = $q_value
4241               )";
4242
4243     push @cust_main, qsearch( {
4244       'table'     => 'cust_main',
4245       'hashref'   => \%options,
4246       'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4247     } );
4248
4249     #always do substring & fuzzy,
4250     #getting complains searches are not returning enough
4251     #unless ( @cust_main ) {  #no exact match, trying substring/fuzzy
4252
4253       #still some false laziness w/ search/cust_main.cgi
4254
4255       #substring
4256
4257       my @hashrefs = (
4258         { 'company'      => { op=>'ILIKE', value=>"%$value%" }, },
4259         { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
4260       );
4261
4262       if ( $first && $last ) {
4263
4264         push @hashrefs,
4265           { 'first'        => { op=>'ILIKE', value=>"%$first%" },
4266             'last'         => { op=>'ILIKE', value=>"%$last%" },
4267           },
4268           { 'ship_first'   => { op=>'ILIKE', value=>"%$first%" },
4269             'ship_last'    => { op=>'ILIKE', value=>"%$last%" },
4270           },
4271         ;
4272
4273       } else {
4274
4275         push @hashrefs,
4276           { 'last'         => { op=>'ILIKE', value=>"%$value%" }, },
4277           { 'ship_last'    => { op=>'ILIKE', value=>"%$value%" }, },
4278         ;
4279       }
4280
4281       foreach my $hashref ( @hashrefs ) {
4282
4283         push @cust_main, qsearch( {
4284           'table'     => 'cust_main',
4285           'hashref'   => { %$hashref,
4286                            %options,
4287                          },
4288           'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
4289         } );
4290
4291       }
4292
4293       #fuzzy
4294       my @fuzopts = (
4295         \%options,                #hashref
4296         '',                       #select
4297         " AND $agentnums_sql",    #extra_sql  #agent virtualization
4298       );
4299
4300       if ( $first && $last ) {
4301         push @cust_main, FS::cust_main->fuzzy_search(
4302           { 'last'   => $last,    #fuzzy hashref
4303             'first'  => $first }, #
4304           @fuzopts
4305         );
4306       }
4307       foreach my $field ( 'last', 'company' ) {
4308         push @cust_main,
4309           FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
4310       }
4311
4312     #}
4313
4314     #eliminate duplicates
4315     my %saw = ();
4316     @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
4317
4318   }
4319
4320   @cust_main;
4321
4322 }
4323
4324 =item check_and_rebuild_fuzzyfiles
4325
4326 =cut
4327
4328 use vars qw(@fuzzyfields);
4329 @fuzzyfields = ( 'last', 'first', 'company' );
4330
4331 sub check_and_rebuild_fuzzyfiles {
4332   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4333   rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
4334 }
4335
4336 =item rebuild_fuzzyfiles
4337
4338 =cut
4339
4340 sub rebuild_fuzzyfiles {
4341
4342   use Fcntl qw(:flock);
4343
4344   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4345   mkdir $dir, 0700 unless -d $dir;
4346
4347   foreach my $fuzzy ( @fuzzyfields ) {
4348
4349     open(LOCK,">>$dir/cust_main.$fuzzy")
4350       or die "can't open $dir/cust_main.$fuzzy: $!";
4351     flock(LOCK,LOCK_EX)
4352       or die "can't lock $dir/cust_main.$fuzzy: $!";
4353
4354     open (CACHE,">$dir/cust_main.$fuzzy.tmp")
4355       or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
4356
4357     foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
4358       my $sth = dbh->prepare("SELECT $field FROM cust_main".
4359                              " WHERE $field != '' AND $field IS NOT NULL");
4360       $sth->execute or die $sth->errstr;
4361
4362       while ( my $row = $sth->fetchrow_arrayref ) {
4363         print CACHE $row->[0]. "\n";
4364       }
4365
4366     }
4367
4368     close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
4369
4370     rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
4371     close LOCK;
4372   }
4373
4374 }
4375
4376 =item all_X
4377
4378 =cut
4379
4380 sub all_X {
4381   my( $self, $field ) = @_;
4382   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4383   open(CACHE,"<$dir/cust_main.$field")
4384     or die "can't open $dir/cust_main.$field: $!";
4385   my @array = map { chomp; $_; } <CACHE>;
4386   close CACHE;
4387   \@array;
4388 }
4389
4390 =item append_fuzzyfiles LASTNAME COMPANY
4391
4392 =cut
4393
4394 sub append_fuzzyfiles {
4395   #my( $first, $last, $company ) = @_;
4396
4397   &check_and_rebuild_fuzzyfiles;
4398
4399   use Fcntl qw(:flock);
4400
4401   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4402
4403   foreach my $field (qw( first last company )) {
4404     my $value = shift;
4405
4406     if ( $value ) {
4407
4408       open(CACHE,">>$dir/cust_main.$field")
4409         or die "can't open $dir/cust_main.$field: $!";
4410       flock(CACHE,LOCK_EX)
4411         or die "can't lock $dir/cust_main.$field: $!";
4412
4413       print CACHE "$value\n";
4414
4415       flock(CACHE,LOCK_UN)
4416         or die "can't unlock $dir/cust_main.$field: $!";
4417       close CACHE;
4418     }
4419
4420   }
4421
4422   1;
4423 }
4424
4425 =item batch_import
4426
4427 =cut
4428
4429 sub batch_import {
4430   my $param = shift;
4431   #warn join('-',keys %$param);
4432   my $fh = $param->{filehandle};
4433   my $agentnum = $param->{agentnum};
4434
4435   my $refnum = $param->{refnum};
4436   my $pkgpart = $param->{pkgpart};
4437
4438   #my @fields = @{$param->{fields}};
4439   my $format = $param->{'format'};
4440   my @fields;
4441   my $payby;
4442   if ( $format eq 'simple' ) {
4443     @fields = qw( cust_pkg.setup dayphone first last
4444                   address1 address2 city state zip comments );
4445     $payby = 'BILL';
4446   } elsif ( $format eq 'extended' ) {
4447     @fields = qw( agent_custid refnum
4448                   last first address1 address2 city state zip country
4449                   daytime night
4450                   ship_last ship_first ship_address1 ship_address2
4451                   ship_city ship_state ship_zip ship_country
4452                   payinfo paycvv paydate
4453                   invoicing_list
4454                   cust_pkg.pkgpart
4455                   svc_acct.username svc_acct._password
4456                 );
4457     $payby = 'BILL';
4458   } else {
4459     die "unknown format $format";
4460   }
4461
4462   eval "use Text::CSV_XS;";
4463   die $@ if $@;
4464
4465   my $csv = new Text::CSV_XS;
4466   #warn $csv;
4467   #warn $fh;
4468
4469   my $imported = 0;
4470   #my $columns;
4471
4472   local $SIG{HUP} = 'IGNORE';
4473   local $SIG{INT} = 'IGNORE';
4474   local $SIG{QUIT} = 'IGNORE';
4475   local $SIG{TERM} = 'IGNORE';
4476   local $SIG{TSTP} = 'IGNORE';
4477   local $SIG{PIPE} = 'IGNORE';
4478
4479   my $oldAutoCommit = $FS::UID::AutoCommit;
4480   local $FS::UID::AutoCommit = 0;
4481   my $dbh = dbh;
4482
4483   #while ( $columns = $csv->getline($fh) ) {
4484   my $line;
4485   while ( defined($line=<$fh>) ) {
4486
4487     $csv->parse($line) or do {
4488       $dbh->rollback if $oldAutoCommit;
4489       return "can't parse: ". $csv->error_input();
4490     };
4491
4492     my @columns = $csv->fields();
4493     #warn join('-',@columns);
4494
4495     my %cust_main = (
4496       agentnum => $agentnum,
4497       refnum   => $refnum,
4498       country  => $conf->config('countrydefault') || 'US',
4499       payby    => $payby, #default
4500       paydate  => '12/2037', #default
4501     );
4502     my $billtime = time;
4503     my %cust_pkg = ( pkgpart => $pkgpart );
4504     my %svc_acct = ();
4505     foreach my $field ( @fields ) {
4506
4507       if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|expire|cancel)$/ ) {
4508
4509         #$cust_pkg{$1} = str2time( shift @$columns );
4510         if ( $1 eq 'pkgpart' ) {
4511           $cust_pkg{$1} = shift @columns;
4512         } elsif ( $1 eq 'setup' ) {
4513           $billtime = str2time(shift @columns);
4514         } else {
4515           $cust_pkg{$1} = str2time( shift @columns );
4516         }
4517
4518       } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
4519
4520         $svc_acct{$1} = shift @columns;
4521
4522       } else {
4523
4524         #refnum interception
4525         if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
4526
4527           my $referral = $columns[0];
4528           my %hash = ( 'referral' => $referral,
4529                        'agentnum' => $agentnum,
4530                        'disabled' => '',
4531                      );
4532
4533           my $part_referral = qsearchs('part_referral', \%hash )
4534                               || new FS::part_referral \%hash;
4535
4536           unless ( $part_referral->refnum ) {
4537             my $error = $part_referral->insert;
4538             if ( $error ) {
4539               $dbh->rollback if $oldAutoCommit;
4540               return "can't auto-insert advertising source: $referral: $error";
4541             }
4542           }
4543
4544           $columns[0] = $part_referral->refnum;
4545         }
4546
4547         #$cust_main{$field} = shift @$columns;
4548         $cust_main{$field} = shift @columns;
4549       }
4550     }
4551
4552     $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
4553
4554     my $invoicing_list = $cust_main{'invoicing_list'}
4555                            ? [ delete $cust_main{'invoicing_list'} ]
4556                            : [];
4557
4558     my $cust_main = new FS::cust_main ( \%cust_main );
4559
4560     use Tie::RefHash;
4561     tie my %hash, 'Tie::RefHash'; #this part is important
4562
4563     if ( $cust_pkg{'pkgpart'} ) {
4564       my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
4565
4566       my @svc_acct = ();
4567       if ( $svc_acct{'username'} ) {
4568         my $part_pkg = $cust_pkg->part_pkg;
4569         unless ( $part_pkg ) {
4570           $dbh->rollback if $oldAutoCommit;
4571           return "unknown pkgnum ". $cust_pkg{'pkgpart'};
4572         }
4573         $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
4574         push @svc_acct, new FS::svc_acct ( \%svc_acct )
4575       }
4576
4577       $hash{$cust_pkg} = \@svc_acct;
4578     }
4579
4580     my $error = $cust_main->insert( \%hash, $invoicing_list );
4581
4582     if ( $error ) {
4583       $dbh->rollback if $oldAutoCommit;
4584       return "can't insert customer for $line: $error";
4585     }
4586
4587     if ( $format eq 'simple' ) {
4588
4589       #false laziness w/bill.cgi
4590       $error = $cust_main->bill( 'time' => $billtime );
4591       if ( $error ) {
4592         $dbh->rollback if $oldAutoCommit;
4593         return "can't bill customer for $line: $error";
4594       }
4595
4596       $cust_main->apply_payments_and_credits;
4597
4598       $error = $cust_main->collect();
4599       if ( $error ) {
4600         $dbh->rollback if $oldAutoCommit;
4601         return "can't collect customer for $line: $error";
4602       }
4603
4604     }
4605
4606     $imported++;
4607   }
4608
4609   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4610
4611   return "Empty file!" unless $imported;
4612
4613   ''; #no error
4614
4615 }
4616
4617 =item batch_charge
4618
4619 =cut
4620
4621 sub batch_charge {
4622   my $param = shift;
4623   #warn join('-',keys %$param);
4624   my $fh = $param->{filehandle};
4625   my @fields = @{$param->{fields}};
4626
4627   eval "use Text::CSV_XS;";
4628   die $@ if $@;
4629
4630   my $csv = new Text::CSV_XS;
4631   #warn $csv;
4632   #warn $fh;
4633
4634   my $imported = 0;
4635   #my $columns;
4636
4637   local $SIG{HUP} = 'IGNORE';
4638   local $SIG{INT} = 'IGNORE';
4639   local $SIG{QUIT} = 'IGNORE';
4640   local $SIG{TERM} = 'IGNORE';
4641   local $SIG{TSTP} = 'IGNORE';
4642   local $SIG{PIPE} = 'IGNORE';
4643
4644   my $oldAutoCommit = $FS::UID::AutoCommit;
4645   local $FS::UID::AutoCommit = 0;
4646   my $dbh = dbh;
4647
4648   #while ( $columns = $csv->getline($fh) ) {
4649   my $line;
4650   while ( defined($line=<$fh>) ) {
4651
4652     $csv->parse($line) or do {
4653       $dbh->rollback if $oldAutoCommit;
4654       return "can't parse: ". $csv->error_input();
4655     };
4656
4657     my @columns = $csv->fields();
4658     #warn join('-',@columns);
4659
4660     my %row = ();
4661     foreach my $field ( @fields ) {
4662       $row{$field} = shift @columns;
4663     }
4664
4665     my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
4666     unless ( $cust_main ) {
4667       $dbh->rollback if $oldAutoCommit;
4668       return "unknown custnum $row{'custnum'}";
4669     }
4670
4671     if ( $row{'amount'} > 0 ) {
4672       my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4673       if ( $error ) {
4674         $dbh->rollback if $oldAutoCommit;
4675         return $error;
4676       }
4677       $imported++;
4678     } elsif ( $row{'amount'} < 0 ) {
4679       my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4680                                       $row{'pkg'}                         );
4681       if ( $error ) {
4682         $dbh->rollback if $oldAutoCommit;
4683         return $error;
4684       }
4685       $imported++;
4686     } else {
4687       #hmm?
4688     }
4689
4690   }
4691
4692   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4693
4694   return "Empty file!" unless $imported;
4695
4696   ''; #no error
4697
4698 }
4699
4700 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4701
4702 Sends a templated email notification to the customer (see L<Text::Template).
4703
4704 OPTIONS is a hash and may include
4705
4706 I<from> - the email sender (default is invoice_from)
4707
4708 I<to> - comma-separated scalar or arrayref of recipients
4709    (default is invoicing_list)
4710
4711 I<subject> - The subject line of the sent email notification
4712    (default is "Notice from company_name")
4713
4714 I<extra_fields> - a hashref of name/value pairs which will be substituted
4715    into the template
4716
4717 The following variables are vavailable in the template.
4718
4719 I<$first> - the customer first name
4720 I<$last> - the customer last name
4721 I<$company> - the customer company
4722 I<$payby> - a description of the method of payment for the customer
4723             # would be nice to use FS::payby::shortname
4724 I<$payinfo> - the account information used to collect for this customer
4725 I<$expdate> - the expiration of the customer payment in seconds from epoch
4726
4727 =cut
4728
4729 sub notify {
4730   my ($customer, $template, %options) = @_;
4731
4732   return unless $conf->exists($template);
4733
4734   my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
4735   $from = $options{from} if exists($options{from});
4736
4737   my $to = join(',', $customer->invoicing_list_emailonly);
4738   $to = $options{to} if exists($options{to});
4739
4740   my $subject = "Notice from " . $conf->config('company_name')
4741     if $conf->exists('company_name');
4742   $subject = $options{subject} if exists($options{subject});
4743
4744   my $notify_template = new Text::Template (TYPE => 'ARRAY',
4745                                             SOURCE => [ map "$_\n",
4746                                               $conf->config($template)]
4747                                            )
4748     or die "can't create new Text::Template object: Text::Template::ERROR";
4749   $notify_template->compile()
4750     or die "can't compile template: Text::Template::ERROR";
4751
4752   my $paydate = $customer->paydate;
4753   $FS::notify_template::_template::first = $customer->first;
4754   $FS::notify_template::_template::last = $customer->last;
4755   $FS::notify_template::_template::company = $customer->company;
4756   $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
4757   my $payby = $customer->payby;
4758   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4759   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4760
4761   #credit cards expire at the end of the month/year of their exp date
4762   if ($payby eq 'CARD' || $payby eq 'DCRD') {
4763     $FS::notify_template::_template::payby = 'credit card';
4764     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4765     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4766     $expire_time--;
4767   }elsif ($payby eq 'COMP') {
4768     $FS::notify_template::_template::payby = 'complimentary account';
4769   }else{
4770     $FS::notify_template::_template::payby = 'current method';
4771   }
4772   $FS::notify_template::_template::expdate = $expire_time;
4773
4774   for (keys %{$options{extra_fields}}){
4775     no strict "refs";
4776     ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4777   }
4778
4779   send_email(from => $from,
4780              to => $to,
4781              subject => $subject,
4782              body => $notify_template->fill_in( PACKAGE =>
4783                                                 'FS::notify_template::_template'                                              ),
4784             );
4785
4786 }
4787
4788 =back
4789
4790 =head1 BUGS
4791
4792 The delete method.
4793
4794 The delete method should possibly take an FS::cust_main object reference
4795 instead of a scalar customer number.
4796
4797 Bill and collect options should probably be passed as references instead of a
4798 list.
4799
4800 There should probably be a configuration file with a list of allowed credit
4801 card types.
4802
4803 No multiple currency support (probably a larger project than just this module).
4804
4805 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
4806
4807 Birthdates rely on negative epoch values.
4808
4809 =head1 SEE ALSO
4810
4811 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
4812 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
4813 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
4814
4815 =cut
4816
4817 1;
4818