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       if ( $error ) {
1016         $dbh->rollback if $oldAutoCommit;
1017         return $error;
1018       }
1019     }
1020   }
1021   my @cancelled_cust_pkg = $self->all_pkgs;
1022   foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1023     my $error = $cust_pkg->delete;
1024     if ( $error ) {
1025       $dbh->rollback if $oldAutoCommit;
1026       return $error;
1027     }
1028   }
1029
1030   foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1031     qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1032   ) {
1033     my $error = $cust_main_invoice->delete;
1034     if ( $error ) {
1035       $dbh->rollback if $oldAutoCommit;
1036       return $error;
1037     }
1038   }
1039
1040   my $error = $self->SUPER::delete;
1041   if ( $error ) {
1042     $dbh->rollback if $oldAutoCommit;
1043     return $error;
1044   }
1045
1046   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1047   '';
1048
1049 }
1050
1051 =item replace OLD_RECORD [ INVOICING_LIST_ARYREF ]
1052
1053 Replaces the OLD_RECORD with this one in the database.  If there is an error,
1054 returns the error, otherwise returns false.
1055
1056 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1057 be set as the invoicing list (see L<"invoicing_list">).  Errors return as
1058 expected and rollback the entire transaction; it is not necessary to call
1059 check_invoicing_list first.  Here's an example:
1060
1061   $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1062
1063 =cut
1064
1065 sub replace {
1066   my $self = shift;
1067   my $old = shift;
1068   my @param = @_;
1069   warn "$me replace called\n"
1070     if $DEBUG;
1071
1072   local $SIG{HUP} = 'IGNORE';
1073   local $SIG{INT} = 'IGNORE';
1074   local $SIG{QUIT} = 'IGNORE';
1075   local $SIG{TERM} = 'IGNORE';
1076   local $SIG{TSTP} = 'IGNORE';
1077   local $SIG{PIPE} = 'IGNORE';
1078
1079   # We absolutely have to have an old vs. new record to make this work.
1080   if (!defined($old)) {
1081     $old = qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
1082   }
1083
1084   my $curuser = $FS::CurrentUser::CurrentUser;
1085   if (    $self->payby eq 'COMP'
1086        && $self->payby ne $old->payby
1087        && ! $curuser->access_right('Complimentary customer')
1088      )
1089   {
1090     return "You are not permitted to create complimentary accounts.";
1091   }
1092
1093   local($ignore_expired_card) = 1
1094     if $old->payby  =~ /^(CARD|DCRD)$/
1095     && $self->payby =~ /^(CARD|DCRD)$/
1096     && $old->payinfo eq $self->payinfo;
1097
1098   my $oldAutoCommit = $FS::UID::AutoCommit;
1099   local $FS::UID::AutoCommit = 0;
1100   my $dbh = dbh;
1101
1102   my $error = $self->SUPER::replace($old);
1103
1104   if ( $error ) {
1105     $dbh->rollback if $oldAutoCommit;
1106     return $error;
1107   }
1108
1109   if ( @param ) { # INVOICING_LIST_ARYREF
1110     my $invoicing_list = shift @param;
1111     $error = $self->check_invoicing_list( $invoicing_list );
1112     if ( $error ) {
1113       $dbh->rollback if $oldAutoCommit;
1114       return $error;
1115     }
1116     $self->invoicing_list( $invoicing_list );
1117   }
1118
1119   if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1120        grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1121     # card/check/lec info has changed, want to retry realtime_ invoice events
1122     my $error = $self->retry_realtime;
1123     if ( $error ) {
1124       $dbh->rollback if $oldAutoCommit;
1125       return $error;
1126     }
1127   }
1128
1129   unless ( $import || $skip_fuzzyfiles ) {
1130     $error = $self->queue_fuzzyfiles_update;
1131     if ( $error ) {
1132       $dbh->rollback if $oldAutoCommit;
1133       return "updating fuzzy search cache: $error";
1134     }
1135   }
1136
1137   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1138   '';
1139
1140 }
1141
1142 =item queue_fuzzyfiles_update
1143
1144 Used by insert & replace to update the fuzzy search cache
1145
1146 =cut
1147
1148 sub queue_fuzzyfiles_update {
1149   my $self = shift;
1150
1151   local $SIG{HUP} = 'IGNORE';
1152   local $SIG{INT} = 'IGNORE';
1153   local $SIG{QUIT} = 'IGNORE';
1154   local $SIG{TERM} = 'IGNORE';
1155   local $SIG{TSTP} = 'IGNORE';
1156   local $SIG{PIPE} = 'IGNORE';
1157
1158   my $oldAutoCommit = $FS::UID::AutoCommit;
1159   local $FS::UID::AutoCommit = 0;
1160   my $dbh = dbh;
1161
1162   my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1163   my $error = $queue->insert( map $self->getfield($_),
1164                                   qw(first last company)
1165                             );
1166   if ( $error ) {
1167     $dbh->rollback if $oldAutoCommit;
1168     return "queueing job (transaction rolled back): $error";
1169   }
1170
1171   if ( $self->ship_last ) {
1172     $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1173     $error = $queue->insert( map $self->getfield("ship_$_"),
1174                                  qw(first last company)
1175                            );
1176     if ( $error ) {
1177       $dbh->rollback if $oldAutoCommit;
1178       return "queueing job (transaction rolled back): $error";
1179     }
1180   }
1181
1182   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1183   '';
1184
1185 }
1186
1187 =item check
1188
1189 Checks all fields to make sure this is a valid customer record.  If there is
1190 an error, returns the error, otherwise returns false.  Called by the insert
1191 and replace methods.
1192
1193 =cut
1194
1195 sub check {
1196   my $self = shift;
1197
1198   warn "$me check BEFORE: \n". $self->_dump
1199     if $DEBUG > 2;
1200
1201   my $error =
1202     $self->ut_numbern('custnum')
1203     || $self->ut_number('agentnum')
1204     || $self->ut_textn('agent_custid')
1205     || $self->ut_number('refnum')
1206     || $self->ut_name('last')
1207     || $self->ut_name('first')
1208     || $self->ut_snumbern('birthdate')
1209     || $self->ut_snumbern('signupdate')
1210     || $self->ut_textn('company')
1211     || $self->ut_text('address1')
1212     || $self->ut_textn('address2')
1213     || $self->ut_text('city')
1214     || $self->ut_textn('county')
1215     || $self->ut_textn('state')
1216     || $self->ut_country('country')
1217     || $self->ut_anything('comments')
1218     || $self->ut_numbern('referral_custnum')
1219   ;
1220   #barf.  need message catalogs.  i18n.  etc.
1221   $error .= "Please select an advertising source."
1222     if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1223   return $error if $error;
1224
1225   return "Unknown agent"
1226     unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1227
1228   return "Unknown refnum"
1229     unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1230
1231   return "Unknown referring custnum: ". $self->referral_custnum
1232     unless ! $self->referral_custnum
1233            || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1234
1235   if ( $self->ss eq '' ) {
1236     $self->ss('');
1237   } else {
1238     my $ss = $self->ss;
1239     $ss =~ s/\D//g;
1240     $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1241       or return "Illegal social security number: ". $self->ss;
1242     $self->ss("$1-$2-$3");
1243   }
1244
1245
1246 # bad idea to disable, causes billing to fail because of no tax rates later
1247 #  unless ( $import ) {
1248     unless ( qsearch('cust_main_county', {
1249       'country' => $self->country,
1250       'state'   => '',
1251      } ) ) {
1252       return "Unknown state/county/country: ".
1253         $self->state. "/". $self->county. "/". $self->country
1254         unless qsearch('cust_main_county',{
1255           'state'   => $self->state,
1256           'county'  => $self->county,
1257           'country' => $self->country,
1258         } );
1259     }
1260 #  }
1261
1262   $error =
1263     $self->ut_phonen('daytime', $self->country)
1264     || $self->ut_phonen('night', $self->country)
1265     || $self->ut_phonen('fax', $self->country)
1266     || $self->ut_zip('zip', $self->country)
1267   ;
1268   return $error if $error;
1269
1270   my @addfields = qw(
1271     last first company address1 address2 city county state zip
1272     country daytime night fax
1273   );
1274
1275   if ( defined $self->dbdef_table->column('ship_last') ) {
1276     if ( scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1277                        @addfields )
1278          && scalar ( grep { $self->getfield("ship_$_") ne '' } @addfields )
1279        )
1280     {
1281       my $error =
1282         $self->ut_name('ship_last')
1283         || $self->ut_name('ship_first')
1284         || $self->ut_textn('ship_company')
1285         || $self->ut_text('ship_address1')
1286         || $self->ut_textn('ship_address2')
1287         || $self->ut_text('ship_city')
1288         || $self->ut_textn('ship_county')
1289         || $self->ut_textn('ship_state')
1290         || $self->ut_country('ship_country')
1291       ;
1292       return $error if $error;
1293
1294       #false laziness with above
1295       unless ( qsearchs('cust_main_county', {
1296         'country' => $self->ship_country,
1297         'state'   => '',
1298        } ) ) {
1299         return "Unknown ship_state/ship_county/ship_country: ".
1300           $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1301           unless qsearch('cust_main_county',{
1302             'state'   => $self->ship_state,
1303             'county'  => $self->ship_county,
1304             'country' => $self->ship_country,
1305           } );
1306       }
1307       #eofalse
1308
1309       $error =
1310         $self->ut_phonen('ship_daytime', $self->ship_country)
1311         || $self->ut_phonen('ship_night', $self->ship_country)
1312         || $self->ut_phonen('ship_fax', $self->ship_country)
1313         || $self->ut_zip('ship_zip', $self->ship_country)
1314       ;
1315       return $error if $error;
1316
1317     } else { # ship_ info eq billing info, so don't store dup info in database
1318       $self->setfield("ship_$_", '')
1319         foreach qw( last first company address1 address2 city county state zip
1320                     country daytime night fax );
1321     }
1322   }
1323
1324   $self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1325     or return "Illegal payby: ". $self->payby;
1326
1327   $error =    $self->ut_numbern('paystart_month')
1328            || $self->ut_numbern('paystart_year')
1329            || $self->ut_numbern('payissue')
1330   ;
1331   return $error if $error;
1332
1333   if ( $self->payip eq '' ) {
1334     $self->payip('');
1335   } else {
1336     $error = $self->ut_ip('payip');
1337     return $error if $error;
1338   }
1339
1340   # If it is encrypted and the private key is not availaible then we can't
1341   # check the credit card.
1342
1343   my $check_payinfo = 1;
1344
1345   if ($self->is_encrypted($self->payinfo)) {
1346     $check_payinfo = 0;
1347   }
1348
1349   $self->payby($1);
1350
1351   if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1352
1353     my $payinfo = $self->payinfo;
1354     $payinfo =~ s/\D//g;
1355     $payinfo =~ /^(\d{13,16})$/
1356       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1357     $payinfo = $1;
1358     $self->payinfo($payinfo);
1359     validate($payinfo)
1360       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1361
1362     return gettext('unknown_card_type')
1363       if cardtype($self->payinfo) eq "Unknown";
1364
1365     my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1366     if ( $ban ) {
1367       return 'Banned credit card: banned on '.
1368              time2str('%a %h %o at %r', $ban->_date).
1369              ' by '. $ban->otaker.
1370              ' (ban# '. $ban->bannum. ')';
1371     }
1372
1373     if ( defined $self->dbdef_table->column('paycvv') ) {
1374       if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1375         if ( cardtype($self->payinfo) eq 'American Express card' ) {
1376           $self->paycvv =~ /^(\d{4})$/
1377             or return "CVV2 (CID) for American Express cards is four digits.";
1378           $self->paycvv($1);
1379         } else {
1380           $self->paycvv =~ /^(\d{3})$/
1381             or return "CVV2 (CVC2/CID) is three digits.";
1382           $self->paycvv($1);
1383         }
1384       } else {
1385         $self->paycvv('');
1386       }
1387     }
1388
1389     my $cardtype = cardtype($payinfo);
1390     if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1391
1392       return "Start date or issue number is required for $cardtype cards"
1393         unless $self->paystart_month && $self->paystart_year or $self->payissue;
1394
1395       return "Start month must be between 1 and 12"
1396         if $self->paystart_month
1397            and $self->paystart_month < 1 || $self->paystart_month > 12;
1398
1399       return "Start year must be 1990 or later"
1400         if $self->paystart_year
1401            and $self->paystart_year < 1990;
1402
1403       return "Issue number must be beween 1 and 99"
1404         if $self->payissue
1405           and $self->payissue < 1 || $self->payissue > 99;
1406
1407     } else {
1408       $self->paystart_month('');
1409       $self->paystart_year('');
1410       $self->payissue('');
1411     }
1412
1413   } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1414
1415     my $payinfo = $self->payinfo;
1416     $payinfo =~ s/[^\d\@]//g;
1417     if ( $conf->exists('echeck-nonus') ) {
1418       $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1419     } else {
1420       $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1421     }
1422     $payinfo = "$1\@$2";
1423     $self->payinfo($payinfo);
1424     $self->paycvv('') if $self->dbdef_table->column('paycvv');
1425
1426     my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1427     if ( $ban ) {
1428       return 'Banned ACH account: banned on '.
1429              time2str('%a %h %o at %r', $ban->_date).
1430              ' by '. $ban->otaker.
1431              ' (ban# '. $ban->bannum. ')';
1432     }
1433
1434   } elsif ( $self->payby eq 'LECB' ) {
1435
1436     my $payinfo = $self->payinfo;
1437     $payinfo =~ s/\D//g;
1438     $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1439     $payinfo = $1;
1440     $self->payinfo($payinfo);
1441     $self->paycvv('') if $self->dbdef_table->column('paycvv');
1442
1443   } elsif ( $self->payby eq 'BILL' ) {
1444
1445     $error = $self->ut_textn('payinfo');
1446     return "Illegal P.O. number: ". $self->payinfo if $error;
1447     $self->paycvv('') if $self->dbdef_table->column('paycvv');
1448
1449   } elsif ( $self->payby eq 'COMP' ) {
1450
1451     my $curuser = $FS::CurrentUser::CurrentUser;
1452     if (    ! $self->custnum
1453          && ! $curuser->access_right('Complimentary customer')
1454        )
1455     {
1456       return "You are not permitted to create complimentary accounts."
1457     }
1458
1459     $error = $self->ut_textn('payinfo');
1460     return "Illegal comp account issuer: ". $self->payinfo if $error;
1461     $self->paycvv('') if $self->dbdef_table->column('paycvv');
1462
1463   } elsif ( $self->payby eq 'PREPAY' ) {
1464
1465     my $payinfo = $self->payinfo;
1466     $payinfo =~ s/\W//g; #anything else would just confuse things
1467     $self->payinfo($payinfo);
1468     $error = $self->ut_alpha('payinfo');
1469     return "Illegal prepayment identifier: ". $self->payinfo if $error;
1470     return "Unknown prepayment identifier"
1471       unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1472     $self->paycvv('') if $self->dbdef_table->column('paycvv');
1473
1474   }
1475
1476   if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1477     return "Expiration date required"
1478       unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1479     $self->paydate('');
1480   } else {
1481     my( $m, $y );
1482     if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1483       ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1484     } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1485       ( $m, $y ) = ( $3, "20$2" );
1486     } else {
1487       return "Illegal expiration date: ". $self->paydate;
1488     }
1489     $self->paydate("$y-$m-01");
1490     my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1491     return gettext('expired_card')
1492       if !$import
1493       && !$ignore_expired_card
1494       && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1495   }
1496
1497   if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1498        ( ! $conf->exists('require_cardname')
1499          || $self->payby !~ /^(CARD|DCRD)$/  )
1500   ) {
1501     $self->payname( $self->first. " ". $self->getfield('last') );
1502   } else {
1503     $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1504       or return gettext('illegal_name'). " payname: ". $self->payname;
1505     $self->payname($1);
1506   }
1507
1508   foreach my $flag (qw( tax spool_cdr )) {
1509     $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1510     $self->$flag($1);
1511   }
1512
1513   $self->otaker(getotaker) unless $self->otaker;
1514
1515   warn "$me check AFTER: \n". $self->_dump
1516     if $DEBUG > 2;
1517
1518   $self->SUPER::check;
1519 }
1520
1521 =item all_pkgs
1522
1523 Returns all packages (see L<FS::cust_pkg>) for this customer.
1524
1525 =cut
1526
1527 sub all_pkgs {
1528   my $self = shift;
1529   if ( $self->{'_pkgnum'} ) {
1530     values %{ $self->{'_pkgnum'}->cache };
1531   } else {
1532     qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1533   }
1534 }
1535
1536 =item ncancelled_pkgs
1537
1538 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1539
1540 =cut
1541
1542 sub ncancelled_pkgs {
1543   my $self = shift;
1544   if ( $self->{'_pkgnum'} ) {
1545     grep { ! $_->getfield('cancel') } values %{ $self->{'_pkgnum'}->cache };
1546   } else {
1547     @{ [ # force list context
1548       qsearch( 'cust_pkg', {
1549         'custnum' => $self->custnum,
1550         'cancel'  => '',
1551       }),
1552       qsearch( 'cust_pkg', {
1553         'custnum' => $self->custnum,
1554         'cancel'  => 0,
1555       }),
1556     ] };
1557   }
1558 }
1559
1560 =item suspended_pkgs
1561
1562 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1563
1564 =cut
1565
1566 sub suspended_pkgs {
1567   my $self = shift;
1568   grep { $_->susp } $self->ncancelled_pkgs;
1569 }
1570
1571 =item unflagged_suspended_pkgs
1572
1573 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1574 customer (thouse packages without the `manual_flag' set).
1575
1576 =cut
1577
1578 sub unflagged_suspended_pkgs {
1579   my $self = shift;
1580   return $self->suspended_pkgs
1581     unless dbdef->table('cust_pkg')->column('manual_flag');
1582   grep { ! $_->manual_flag } $self->suspended_pkgs;
1583 }
1584
1585 =item unsuspended_pkgs
1586
1587 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1588 this customer.
1589
1590 =cut
1591
1592 sub unsuspended_pkgs {
1593   my $self = shift;
1594   grep { ! $_->susp } $self->ncancelled_pkgs;
1595 }
1596
1597 =item num_cancelled_pkgs
1598
1599 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1600 customer.
1601
1602 =cut
1603
1604 sub num_cancelled_pkgs {
1605   my $self = shift;
1606   $self->num_pkgs("cancel IS NOT NULL AND cust_pkg.cancel != 0");
1607 }
1608
1609 sub num_pkgs {
1610   my( $self, $sql ) = @_;
1611   my $sth = dbh->prepare(
1612     "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? AND $sql"
1613   ) or die dbh->errstr;
1614   $sth->execute($self->custnum) or die $sth->errstr;
1615   $sth->fetchrow_arrayref->[0];
1616 }
1617
1618 =item unsuspend
1619
1620 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1621 and L<FS::cust_pkg>) for this customer.  Always returns a list: an empty list
1622 on success or a list of errors.
1623
1624 =cut
1625
1626 sub unsuspend {
1627   my $self = shift;
1628   grep { $_->unsuspend } $self->suspended_pkgs;
1629 }
1630
1631 =item suspend
1632
1633 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1634
1635 Returns a list: an empty list on success or a list of errors.
1636
1637 =cut
1638
1639 sub suspend {
1640   my $self = shift;
1641   grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1642 }
1643
1644 =item suspend_if_pkgpart PKGPART [ , PKGPART ... ]
1645
1646 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1647 PKGPARTs (see L<FS::part_pkg>).
1648
1649 Returns a list: an empty list on success or a list of errors.
1650
1651 =cut
1652
1653 sub suspend_if_pkgpart {
1654   my $self = shift;
1655   my (@pkgparts, %opt);
1656   if (ref($_[0]) eq 'HASH'){
1657     @pkgparts = @{$_[0]{pkgparts}};
1658     %opt      = %{$_[0]};
1659   }else{
1660     @pkgparts = @_;
1661   }
1662   grep { $_->suspend(%opt) }
1663     grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1664       $self->unsuspended_pkgs;
1665 }
1666
1667 =item suspend_unless_pkgpart PKGPART [ , PKGPART ... ]
1668
1669 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1670 listed PKGPARTs (see L<FS::part_pkg>).
1671
1672 Returns a list: an empty list on success or a list of errors.
1673
1674 =cut
1675
1676 sub suspend_unless_pkgpart {
1677   my $self = shift;
1678   my (@pkgparts, %opt);
1679   if (ref($_[0]) eq 'HASH'){
1680     @pkgparts = @{$_[0]{pkgparts}};
1681     %opt      = %{$_[0]};
1682   }else{
1683     @pkgparts = @_;
1684   }
1685   grep { $_->suspend(%opt) }
1686     grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1687       $self->unsuspended_pkgs;
1688 }
1689
1690 =item cancel [ OPTION => VALUE ... ]
1691
1692 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1693
1694 Available options are: I<quiet>, I<reasonnum>, and I<ban>
1695
1696 I<quiet> can be set true to supress email cancellation notices.
1697
1698 # I<reasonnum> can be set to a cancellation reason (see L<FS::cancel_reason>)
1699
1700 I<ban> can be set true to ban this customer's credit card or ACH information,
1701 if present.
1702
1703 Always returns a list: an empty list on success or a list of errors.
1704
1705 =cut
1706
1707 sub cancel {
1708   my $self = shift;
1709   my %opt = @_;
1710
1711   if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1712
1713     #should try decryption (we might have the private key)
1714     # and if not maybe queue a job for the server that does?
1715     return ( "Can't (yet) ban encrypted credit cards" )
1716       if $self->is_encrypted($self->payinfo);
1717
1718     my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1719     my $error = $ban->insert;
1720     return ( $error ) if $error;
1721
1722   }
1723
1724   grep { $_ } map { $_->cancel(@_) } $self->ncancelled_pkgs;
1725 }
1726
1727 sub _banned_pay_hashref {
1728   my $self = shift;
1729
1730   my %payby2ban = (
1731     'CARD' => 'CARD',
1732     'DCRD' => 'CARD',
1733     'CHEK' => 'CHEK',
1734     'DCHK' => 'CHEK'
1735   );
1736
1737   {
1738     'payby'   => $payby2ban{$self->payby},
1739     'payinfo' => md5_base64($self->payinfo),
1740     #'reason'  =>
1741   };
1742 }
1743
1744 =item notes
1745
1746 Returns all notes (see L<FS::cust_main_note>) for this customer.
1747
1748 =cut
1749
1750 sub notes {
1751   my $self = shift;
1752   #order by?
1753   qsearch( 'cust_main_note',
1754            { 'custnum' => $self->custnum },
1755            '',
1756            'ORDER BY _DATE DESC'
1757          );
1758 }
1759
1760 =item agent
1761
1762 Returns the agent (see L<FS::agent>) for this customer.
1763
1764 =cut
1765
1766 sub agent {
1767   my $self = shift;
1768   qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1769 }
1770
1771 =item bill OPTIONS
1772
1773 Generates invoices (see L<FS::cust_bill>) for this customer.  Usually used in
1774 conjunction with the collect method.
1775
1776 Options are passed as name-value pairs.
1777
1778 Currently available options are:
1779
1780 resetup - if set true, re-charges setup fees.
1781
1782 time - bills the customer as if it were that time.  Specified as a UNIX
1783 timestamp; see L<perlfunc/"time">).  Also see L<Time::Local> and
1784 L<Date::Parse> for conversion functions.  For example:
1785
1786  use Date::Parse;
1787  ...
1788  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1789
1790
1791 If there is an error, returns the error, otherwise returns false.
1792
1793 =cut
1794
1795 sub bill {
1796   my( $self, %options ) = @_;
1797   return '' if $self->payby eq 'COMP';
1798   warn "$me bill customer ". $self->custnum. "\n"
1799     if $DEBUG;
1800
1801   my $time = $options{'time'} || time;
1802
1803   my $error;
1804
1805   #put below somehow?
1806   local $SIG{HUP} = 'IGNORE';
1807   local $SIG{INT} = 'IGNORE';
1808   local $SIG{QUIT} = 'IGNORE';
1809   local $SIG{TERM} = 'IGNORE';
1810   local $SIG{TSTP} = 'IGNORE';
1811   local $SIG{PIPE} = 'IGNORE';
1812
1813   my $oldAutoCommit = $FS::UID::AutoCommit;
1814   local $FS::UID::AutoCommit = 0;
1815   my $dbh = dbh;
1816
1817   $self->select_for_update; #mutex
1818
1819   #create a new invoice
1820   #(we'll remove it later if it doesn't actually need to be generated [contains
1821   # no line items] and we're inside a transaciton so nothing else will see it)
1822   my $cust_bill = new FS::cust_bill ( {
1823     'custnum' => $self->custnum,
1824     '_date'   => $time,
1825     #'charged' => $charged,
1826     'charged' => 0,
1827   } );
1828   $error = $cust_bill->insert;
1829   if ( $error ) {
1830     $dbh->rollback if $oldAutoCommit;
1831     return "can't create invoice for customer #". $self->custnum. ": $error";
1832   }
1833   my $invnum = $cust_bill->invnum;
1834
1835   ###
1836   # find the packages which are due for billing, find out how much they are
1837   # & generate invoice database.
1838   ###
1839
1840   my( $total_setup, $total_recur ) = ( 0, 0 );
1841   my %tax;
1842   my @precommit_hooks = ();
1843
1844   foreach my $cust_pkg (
1845     qsearch('cust_pkg', { 'custnum' => $self->custnum } )
1846   ) {
1847
1848     #NO!! next if $cust_pkg->cancel;
1849     next if $cust_pkg->getfield('cancel');
1850
1851     warn "  bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
1852
1853     #? to avoid use of uninitialized value errors... ?
1854     $cust_pkg->setfield('bill', '')
1855       unless defined($cust_pkg->bill);
1856
1857     my $part_pkg = $cust_pkg->part_pkg;
1858
1859     my %hash = $cust_pkg->hash;
1860     my $old_cust_pkg = new FS::cust_pkg \%hash;
1861
1862     my @details = ();
1863
1864     ###
1865     # bill setup
1866     ###
1867
1868     my $setup = 0;
1869     if ( !$cust_pkg->setup || $options{'resetup'} ) {
1870
1871       warn "    bill setup\n" if $DEBUG > 1;
1872
1873       $setup = eval { $cust_pkg->calc_setup( $time ) };
1874       if ( $@ ) {
1875         $dbh->rollback if $oldAutoCommit;
1876         return "$@ running calc_setup for $cust_pkg\n";
1877       }
1878
1879       $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
1880     }
1881
1882     ###
1883     # bill recurring fee
1884     ###
1885
1886     my $recur = 0;
1887     my $sdate;
1888     if ( $part_pkg->getfield('freq') ne '0' &&
1889          ! $cust_pkg->getfield('susp') &&
1890          ( $cust_pkg->getfield('bill') || 0 ) <= $time
1891     ) {
1892
1893       warn "    bill recur\n" if $DEBUG > 1;
1894
1895       # XXX shared with $recur_prog
1896       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1897
1898       #over two params!  lets at least switch to a hashref for the rest...
1899       my %param = ( 'precommit_hooks' => \@precommit_hooks, );
1900
1901       $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
1902       if ( $@ ) {
1903         $dbh->rollback if $oldAutoCommit;
1904         return "$@ running calc_recur for $cust_pkg\n";
1905       }
1906
1907       #change this bit to use Date::Manip? CAREFUL with timezones (see
1908       # mailing list archive)
1909       my ($sec,$min,$hour,$mday,$mon,$year) =
1910         (localtime($sdate) )[0,1,2,3,4,5];
1911
1912       #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
1913       # only for figuring next bill date, nothing else, so, reset $sdate again
1914       # here
1915       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1916       $cust_pkg->last_bill($sdate)
1917         if $cust_pkg->dbdef_table->column('last_bill');
1918
1919       if ( $part_pkg->freq =~ /^\d+$/ ) {
1920         $mon += $part_pkg->freq;
1921         until ( $mon < 12 ) { $mon -= 12; $year++; }
1922       } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
1923         my $weeks = $1;
1924         $mday += $weeks * 7;
1925       } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
1926         my $days = $1;
1927         $mday += $days;
1928       } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
1929         my $hours = $1;
1930         $hour += $hours;
1931       } else {
1932         $dbh->rollback if $oldAutoCommit;
1933         return "unparsable frequency: ". $part_pkg->freq;
1934       }
1935       $cust_pkg->setfield('bill',
1936         timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
1937     }
1938
1939     warn "\$setup is undefined" unless defined($setup);
1940     warn "\$recur is undefined" unless defined($recur);
1941     warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1942
1943     ###
1944     # If $cust_pkg has been modified, update it and create cust_bill_pkg records
1945     ###
1946
1947     if ( $cust_pkg->modified ) {
1948
1949       warn "  package ". $cust_pkg->pkgnum. " modified; updating\n"
1950         if $DEBUG >1;
1951
1952       $error=$cust_pkg->replace($old_cust_pkg);
1953       if ( $error ) { #just in case
1954         $dbh->rollback if $oldAutoCommit;
1955         return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
1956       }
1957
1958       $setup = sprintf( "%.2f", $setup );
1959       $recur = sprintf( "%.2f", $recur );
1960       if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
1961         $dbh->rollback if $oldAutoCommit;
1962         return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
1963       }
1964       if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
1965         $dbh->rollback if $oldAutoCommit;
1966         return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
1967       }
1968
1969       if ( $setup != 0 || $recur != 0 ) {
1970
1971         warn "    charges (setup=$setup, recur=$recur); adding line items\n"
1972           if $DEBUG > 1;
1973         my $cust_bill_pkg = new FS::cust_bill_pkg ({
1974           'invnum'  => $invnum,
1975           'pkgnum'  => $cust_pkg->pkgnum,
1976           'setup'   => $setup,
1977           'recur'   => $recur,
1978           'sdate'   => $sdate,
1979           'edate'   => $cust_pkg->bill,
1980           'details' => \@details,
1981         });
1982         $error = $cust_bill_pkg->insert;
1983         if ( $error ) {
1984           $dbh->rollback if $oldAutoCommit;
1985           return "can't create invoice line item for invoice #$invnum: $error";
1986         }
1987         $total_setup += $setup;
1988         $total_recur += $recur;
1989
1990         ###
1991         # handle taxes
1992         ###
1993
1994         unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
1995
1996           my $prefix =
1997             ( $conf->exists('tax-ship_address') && length($self->ship_last) )
1998             ? 'ship_'
1999             : '';
2000           my %taxhash = map { $_ => $self->get("$prefix$_") }
2001                             qw( state county country );
2002
2003           $taxhash{'taxclass'} = $part_pkg->taxclass;
2004
2005           my @taxes = qsearch( 'cust_main_county', \%taxhash );
2006
2007           unless ( @taxes ) {
2008             $taxhash{'taxclass'} = '';
2009             @taxes =  qsearch( 'cust_main_county', \%taxhash );
2010           }
2011
2012           #one more try at a whole-country tax rate
2013           unless ( @taxes ) {
2014             $taxhash{$_} = '' foreach qw( state county );
2015             @taxes =  qsearch( 'cust_main_county', \%taxhash );
2016           }
2017
2018           # maybe eliminate this entirely, along with all the 0% records
2019           unless ( @taxes ) {
2020             $dbh->rollback if $oldAutoCommit;
2021             return
2022               "fatal: can't find tax rate for state/county/country/taxclass ".
2023               join('/', ( map $self->get("$prefix$_"),
2024                               qw(state county country)
2025                         ),
2026                         $part_pkg->taxclass ). "\n";
2027           }
2028
2029           foreach my $tax ( @taxes ) {
2030
2031             my $taxable_charged = 0;
2032             $taxable_charged += $setup
2033               unless $part_pkg->setuptax =~ /^Y$/i
2034                   || $tax->setuptax =~ /^Y$/i;
2035             $taxable_charged += $recur
2036               unless $part_pkg->recurtax =~ /^Y$/i
2037                   || $tax->recurtax =~ /^Y$/i;
2038             next unless $taxable_charged;
2039
2040             if ( $tax->exempt_amount && $tax->exempt_amount > 0 ) {
2041               #my ($mon,$year) = (localtime($sdate) )[4,5];
2042               my ($mon,$year) = (localtime( $sdate || $cust_bill->_date ) )[4,5];
2043               $mon++;
2044               my $freq = $part_pkg->freq || 1;
2045               if ( $freq !~ /(\d+)$/ ) {
2046                 $dbh->rollback if $oldAutoCommit;
2047                 return "daily/weekly package definitions not (yet?)".
2048                        " compatible with monthly tax exemptions";
2049               }
2050               my $taxable_per_month =
2051                 sprintf("%.2f", $taxable_charged / $freq );
2052
2053               #call the whole thing off if this customer has any old
2054               #exemption records...
2055               my @cust_tax_exempt =
2056                 qsearch( 'cust_tax_exempt' => { custnum=> $self->custnum } );
2057               if ( @cust_tax_exempt ) {
2058                 $dbh->rollback if $oldAutoCommit;
2059                 return
2060                   'this customer still has old-style tax exemption records; '.
2061                   'run bin/fs-migrate-cust_tax_exempt?';
2062               }
2063
2064               foreach my $which_month ( 1 .. $freq ) {
2065
2066                 #maintain the new exemption table now
2067                 my $sql = "
2068                   SELECT SUM(amount)
2069                     FROM cust_tax_exempt_pkg
2070                       LEFT JOIN cust_bill_pkg USING ( billpkgnum )
2071                       LEFT JOIN cust_bill     USING ( invnum     )
2072                     WHERE custnum = ?
2073                       AND taxnum  = ?
2074                       AND year    = ?
2075                       AND month   = ?
2076                 ";
2077                 my $sth = dbh->prepare($sql) or do {
2078                   $dbh->rollback if $oldAutoCommit;
2079                   return "fatal: can't lookup exising exemption: ". dbh->errstr;
2080                 };
2081                 $sth->execute(
2082                   $self->custnum,
2083                   $tax->taxnum,
2084                   1900+$year,
2085                   $mon,
2086                 ) or do {
2087                   $dbh->rollback if $oldAutoCommit;
2088                   return "fatal: can't lookup exising exemption: ". dbh->errstr;
2089                 };
2090                 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
2091
2092                 my $remaining_exemption =
2093                   $tax->exempt_amount - $existing_exemption;
2094                 if ( $remaining_exemption > 0 ) {
2095                   my $addl = $remaining_exemption > $taxable_per_month
2096                     ? $taxable_per_month
2097                     : $remaining_exemption;
2098                   $taxable_charged -= $addl;
2099
2100                   my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg ( {
2101                     'billpkgnum' => $cust_bill_pkg->billpkgnum,
2102                     'taxnum'     => $tax->taxnum,
2103                     'year'       => 1900+$year,
2104                     'month'      => $mon,
2105                     'amount'     => sprintf("%.2f", $addl ),
2106                   } );
2107                   $error = $cust_tax_exempt_pkg->insert;
2108                   if ( $error ) {
2109                     $dbh->rollback if $oldAutoCommit;
2110                     return "fatal: can't insert cust_tax_exempt_pkg: $error";
2111                   }
2112                 } # if $remaining_exemption > 0
2113
2114                 #++
2115                 $mon++;
2116                 #until ( $mon < 12 ) { $mon -= 12; $year++; }
2117                 until ( $mon < 13 ) { $mon -= 12; $year++; }
2118
2119               } #foreach $which_month
2120
2121             } #if $tax->exempt_amount
2122
2123             $taxable_charged = sprintf( "%.2f", $taxable_charged);
2124
2125             #$tax += $taxable_charged * $cust_main_county->tax / 100
2126             $tax{ $tax->taxname || 'Tax' } +=
2127               $taxable_charged * $tax->tax / 100
2128
2129           } #foreach my $tax ( @taxes )
2130
2131         } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2132
2133       } #if $setup != 0 || $recur != 0
2134
2135     } #if $cust_pkg->modified
2136
2137   } #foreach my $cust_pkg
2138
2139   unless ( $cust_bill->cust_bill_pkg ) {
2140     $cust_bill->delete; #don't create an invoice w/o line items
2141     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2142     return '';
2143   }
2144
2145   my $charged = sprintf( "%.2f", $total_setup + $total_recur );
2146
2147   foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2148     my $tax = sprintf("%.2f", $tax{$taxname} );
2149     $charged = sprintf( "%.2f", $charged+$tax );
2150
2151     my $cust_bill_pkg = new FS::cust_bill_pkg ({
2152       'invnum'   => $invnum,
2153       'pkgnum'   => 0,
2154       'setup'    => $tax,
2155       'recur'    => 0,
2156       'sdate'    => '',
2157       'edate'    => '',
2158       'itemdesc' => $taxname,
2159     });
2160     $error = $cust_bill_pkg->insert;
2161     if ( $error ) {
2162       $dbh->rollback if $oldAutoCommit;
2163       return "can't create invoice line item for invoice #$invnum: $error";
2164     }
2165     $total_setup += $tax;
2166
2167   }
2168
2169   $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2170   $error = $cust_bill->replace;
2171   if ( $error ) {
2172     $dbh->rollback if $oldAutoCommit;
2173     return "can't update charged for invoice #$invnum: $error";
2174   }
2175
2176   foreach my $hook ( @precommit_hooks ) {
2177     eval {
2178       &{$hook}; #($self) ?
2179     };
2180     if ( $@ ) {
2181       $dbh->rollback if $oldAutoCommit;
2182       return "$@ running precommit hook $hook\n";
2183     }
2184   }
2185
2186   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2187   ''; #no error
2188 }
2189
2190 =item collect OPTIONS
2191
2192 (Attempt to) collect money for this customer's outstanding invoices (see
2193 L<FS::cust_bill>).  Usually used after the bill method.
2194
2195 Depending on the value of `payby', this may print or email an invoice (I<BILL>,
2196 I<DCRD>, or I<DCHK>), charge a credit card (I<CARD>), charge via electronic
2197 check/ACH (I<CHEK>), or just add any necessary (pseudo-)payment (I<COMP>).
2198
2199 Most actions are now triggered by invoice events; see L<FS::part_bill_event>
2200 and the invoice events web interface.
2201
2202 If there is an error, returns the error, otherwise returns false.
2203
2204 Options are passed as name-value pairs.
2205
2206 Currently available options are:
2207
2208 invoice_time - Use this time when deciding when to print invoices and
2209 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>
2210 for conversion functions.
2211
2212 retry - Retry card/echeck/LEC transactions even when not scheduled by invoice
2213 events.
2214
2215 quiet - set true to surpress email card/ACH decline notices.
2216
2217 freq - "1d" for the traditional, daily events (the default), or "1m" for the
2218 new monthly events
2219
2220 payby - allows for one time override of normal customer billing method
2221
2222 =cut
2223
2224 sub collect {
2225   my( $self, %options ) = @_;
2226   my $invoice_time = $options{'invoice_time'} || time;
2227
2228   #put below somehow?
2229   local $SIG{HUP} = 'IGNORE';
2230   local $SIG{INT} = 'IGNORE';
2231   local $SIG{QUIT} = 'IGNORE';
2232   local $SIG{TERM} = 'IGNORE';
2233   local $SIG{TSTP} = 'IGNORE';
2234   local $SIG{PIPE} = 'IGNORE';
2235
2236   my $oldAutoCommit = $FS::UID::AutoCommit;
2237   local $FS::UID::AutoCommit = 0;
2238   my $dbh = dbh;
2239
2240   $self->select_for_update; #mutex
2241
2242   my $balance = $self->balance;
2243   warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2244     if $DEBUG;
2245   unless ( $balance > 0 ) { #redundant?????
2246     $dbh->rollback if $oldAutoCommit; #hmm
2247     return '';
2248   }
2249
2250   if ( exists($options{'retry_card'}) ) {
2251     carp 'retry_card option passed to collect is deprecated; use retry';
2252     $options{'retry'} ||= $options{'retry_card'};
2253   }
2254   if ( exists($options{'retry'}) && $options{'retry'} ) {
2255     my $error = $self->retry_realtime;
2256     if ( $error ) {
2257       $dbh->rollback if $oldAutoCommit;
2258       return $error;
2259     }
2260   }
2261
2262   my $extra_sql = '';
2263   if ( defined $options{'freq'} && $options{'freq'} eq '1m' ) {
2264     $extra_sql = " AND freq = '1m' ";
2265   } else {
2266     $extra_sql = " AND ( freq = '1d' OR freq IS NULL OR freq = '' ) ";
2267   }
2268
2269   foreach my $cust_bill ( $self->open_cust_bill ) {
2270
2271     # don't try to charge for the same invoice if it's already in a batch
2272     #next if qsearchs( 'cust_pay_batch', { 'invnum' => $cust_bill->invnum } );
2273
2274     last if $self->balance <= 0;
2275
2276     warn "  invnum ". $cust_bill->invnum. " (owed ". $cust_bill->owed. ")\n"
2277       if $DEBUG > 1;
2278
2279     foreach my $part_bill_event ( due_events ( $cust_bill,
2280                                                exists($options{'payby'})
2281                                                  ? $options{'payby'}
2282                                                  : $self->payby,
2283                                                $invoice_time,
2284                                                $extra_sql ) ) {
2285
2286       last if $cust_bill->owed <= 0  # don't run subsequent events if owed<=0
2287            || $self->balance   <= 0; # or if balance<=0
2288
2289       {
2290         local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2291         warn "  do_event " .  $cust_bill . " ". (%options) .  "\n"
2292           if $DEBUG > 1;
2293
2294         if (my $error = $part_bill_event->do_event($cust_bill, %options)) {
2295           # gah, even with transactions.
2296           $dbh->commit if $oldAutoCommit; #well.
2297           return $error;
2298         }
2299       }
2300
2301     }
2302
2303   }
2304
2305   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2306   '';
2307
2308 }
2309
2310 =item retry_realtime
2311
2312 Schedules realtime / batch  credit card / electronic check / LEC billing
2313 events for for retry.  Useful if card information has changed or manual
2314 retry is desired.  The 'collect' method must be called to actually retry
2315 the transaction.
2316
2317 Implementation details: For each of this customer's open invoices, changes
2318 the status of the first "done" (with statustext error) realtime processing
2319 event to "failed".
2320
2321 =cut
2322
2323 sub retry_realtime {
2324   my $self = shift;
2325
2326   local $SIG{HUP} = 'IGNORE';
2327   local $SIG{INT} = 'IGNORE';
2328   local $SIG{QUIT} = 'IGNORE';
2329   local $SIG{TERM} = 'IGNORE';
2330   local $SIG{TSTP} = 'IGNORE';
2331   local $SIG{PIPE} = 'IGNORE';
2332
2333   my $oldAutoCommit = $FS::UID::AutoCommit;
2334   local $FS::UID::AutoCommit = 0;
2335   my $dbh = dbh;
2336
2337   foreach my $cust_bill (
2338     grep { $_->cust_bill_event }
2339       $self->open_cust_bill
2340   ) {
2341     my @cust_bill_event =
2342       sort { $a->part_bill_event->seconds <=> $b->part_bill_event->seconds }
2343         grep {
2344                #$_->part_bill_event->plan eq 'realtime-card'
2345                $_->part_bill_event->eventcode =~
2346                    /\$cust_bill\->(batch|realtime)_(card|ach|lec)/
2347                  && $_->status eq 'done'
2348                  && $_->statustext
2349              }
2350           $cust_bill->cust_bill_event;
2351     next unless @cust_bill_event;
2352     my $error = $cust_bill_event[0]->retry;
2353     if ( $error ) {
2354       $dbh->rollback if $oldAutoCommit;
2355       return "error scheduling invoice event for retry: $error";
2356     }
2357
2358   }
2359
2360   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2361   '';
2362
2363 }
2364
2365 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2366
2367 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2368 via a Business::OnlinePayment realtime gateway.  See
2369 L<http://420.am/business-onlinepayment> for supported gateways.
2370
2371 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2372
2373 Available options are: I<description>, I<invnum>, I<quiet>
2374
2375 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2376 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
2377 if set, will override the value from the customer record.
2378
2379 I<description> is a free-text field passed to the gateway.  It defaults to
2380 "Internet services".
2381
2382 If an I<invnum> is specified, this payment (if successful) is applied to the
2383 specified invoice.  If you don't specify an I<invnum> you might want to
2384 call the B<apply_payments> method.
2385
2386 I<quiet> can be set true to surpress email decline notices.
2387
2388 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2389
2390 =cut
2391
2392 sub realtime_bop {
2393   my( $self, $method, $amount, %options ) = @_;
2394   if ( $DEBUG ) {
2395     warn "$me realtime_bop: $method $amount\n";
2396     warn "  $_ => $options{$_}\n" foreach keys %options;
2397   }
2398
2399   $options{'description'} ||= 'Internet services';
2400
2401   eval "use Business::OnlinePayment";
2402   die $@ if $@;
2403
2404   my $payinfo = exists($options{'payinfo'})
2405                   ? $options{'payinfo'}
2406                   : $self->payinfo;
2407
2408   ###
2409   # select a gateway
2410   ###
2411
2412   my $taxclass = '';
2413   if ( $options{'invnum'} ) {
2414     my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2415     die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2416     my @taxclasses =
2417       map  { $_->part_pkg->taxclass }
2418       grep { $_ }
2419       map  { $_->cust_pkg }
2420       $cust_bill->cust_bill_pkg;
2421     unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2422                                                            #different taxclasses
2423       $taxclass = $taxclasses[0];
2424     }
2425   }
2426
2427   #look for an agent gateway override first
2428   my $cardtype;
2429   if ( $method eq 'CC' ) {
2430     $cardtype = cardtype($payinfo);
2431   } elsif ( $method eq 'ECHECK' ) {
2432     $cardtype = 'ACH';
2433   } else {
2434     $cardtype = $method;
2435   }
2436
2437   my $override =
2438        qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2439                                            cardtype => $cardtype,
2440                                            taxclass => $taxclass,       } )
2441     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2442                                            cardtype => '',
2443                                            taxclass => $taxclass,       } )
2444     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2445                                            cardtype => $cardtype,
2446                                            taxclass => '',              } )
2447     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2448                                            cardtype => '',
2449                                            taxclass => '',              } );
2450
2451   my $payment_gateway = '';
2452   my( $processor, $login, $password, $action, @bop_options );
2453   if ( $override ) { #use a payment gateway override
2454
2455     $payment_gateway = $override->payment_gateway;
2456
2457     $processor   = $payment_gateway->gateway_module;
2458     $login       = $payment_gateway->gateway_username;
2459     $password    = $payment_gateway->gateway_password;
2460     $action      = $payment_gateway->gateway_action;
2461     @bop_options = $payment_gateway->options;
2462
2463   } else { #use the standard settings from the config
2464
2465     ( $processor, $login, $password, $action, @bop_options ) =
2466       $self->default_payment_gateway($method);
2467
2468   }
2469
2470   ###
2471   # massage data
2472   ###
2473
2474   my $address = exists($options{'address1'})
2475                     ? $options{'address1'}
2476                     : $self->address1;
2477   my $address2 = exists($options{'address2'})
2478                     ? $options{'address2'}
2479                     : $self->address2;
2480   $address .= ", ". $address2 if length($address2);
2481
2482   my $o_payname = exists($options{'payname'})
2483                     ? $options{'payname'}
2484                     : $self->payname;
2485   my($payname, $payfirst, $paylast);
2486   if ( $o_payname && $method ne 'ECHECK' ) {
2487     ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2488       or return "Illegal payname $payname";
2489     ($payfirst, $paylast) = ($1, $2);
2490   } else {
2491     $payfirst = $self->getfield('first');
2492     $paylast = $self->getfield('last');
2493     $payname =  "$payfirst $paylast";
2494   }
2495
2496   my @invoicing_list = grep { $_ ne 'POST' } $self->invoicing_list;
2497   if ( $conf->exists('emailinvoiceauto')
2498        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
2499     push @invoicing_list, $self->all_emails;
2500   }
2501
2502   my $email = ($conf->exists('business-onlinepayment-email-override'))
2503               ? $conf->config('business-onlinepayment-email-override')
2504               : $invoicing_list[0];
2505
2506   my %content = ();
2507
2508   my $payip = exists($options{'payip'})
2509                 ? $options{'payip'}
2510                 : $self->payip;
2511   $content{customer_ip} = $payip
2512     if length($payip);
2513
2514   $content{invoice_number} = $options{'invnum'}
2515     if exists($options{'invnum'}) && length($options{'invnum'});
2516
2517   if ( $method eq 'CC' ) {
2518
2519     $content{card_number} = $payinfo;
2520     my $paydate = exists($options{'paydate'})
2521                     ? $options{'paydate'}
2522                     : $self->paydate;
2523     $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2524     $content{expiration} = "$2/$1";
2525
2526     my $paycvv = exists($options{'paycvv'})
2527                    ? $options{'paycvv'}
2528                    : $self->paycvv;
2529     $content{cvv2} = $self->paycvv
2530       if length($paycvv);
2531
2532     my $paystart_month = exists($options{'paystart_month'})
2533                            ? $options{'paystart_month'}
2534                            : $self->paystart_month;
2535
2536     my $paystart_year  = exists($options{'paystart_year'})
2537                            ? $options{'paystart_year'}
2538                            : $self->paystart_year;
2539
2540     $content{card_start} = "$paystart_month/$paystart_year"
2541       if $paystart_month && $paystart_year;
2542
2543     my $payissue       = exists($options{'payissue'})
2544                            ? $options{'payissue'}
2545                            : $self->payissue;
2546     $content{issue_number} = $payissue if $payissue;
2547
2548     $content{recurring_billing} = 'YES'
2549       if qsearch('cust_pay', { 'custnum' => $self->custnum,
2550                                'payby'   => 'CARD',
2551                                'payinfo' => $payinfo,
2552                              } );
2553
2554   } elsif ( $method eq 'ECHECK' ) {
2555     ( $content{account_number}, $content{routing_code} ) =
2556       split('@', $payinfo);
2557     $content{bank_name} = $o_payname;
2558     $content{account_type} = 'CHECKING';
2559     $content{account_name} = $payname;
2560     $content{customer_org} = $self->company ? 'B' : 'I';
2561     $content{customer_ssn} = exists($options{'ss'})
2562                                ? $options{'ss'}
2563                                : $self->ss;
2564   } elsif ( $method eq 'LEC' ) {
2565     $content{phone} = $payinfo;
2566   }
2567
2568   ###
2569   # run transaction(s)
2570   ###
2571
2572   my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
2573
2574   my $transaction = new Business::OnlinePayment( $processor, @bop_options );
2575   $transaction->content(
2576     'type'           => $method,
2577     'login'          => $login,
2578     'password'       => $password,
2579     'action'         => $action1,
2580     'description'    => $options{'description'},
2581     'amount'         => $amount,
2582     #'invoice_number' => $options{'invnum'},
2583     'customer_id'    => $self->custnum,
2584     'last_name'      => $paylast,
2585     'first_name'     => $payfirst,
2586     'name'           => $payname,
2587     'address'        => $address,
2588     'city'           => ( exists($options{'city'})
2589                             ? $options{'city'}
2590                             : $self->city          ),
2591     'state'          => ( exists($options{'state'})
2592                             ? $options{'state'}
2593                             : $self->state          ),
2594     'zip'            => ( exists($options{'zip'})
2595                             ? $options{'zip'}
2596                             : $self->zip          ),
2597     'country'        => ( exists($options{'country'})
2598                             ? $options{'country'}
2599                             : $self->country          ),
2600     'referer'        => 'http://cleanwhisker.420.am/',
2601     'email'          => $email,
2602     'phone'          => $self->daytime || $self->night,
2603     %content, #after
2604   );
2605   $transaction->submit();
2606
2607   if ( $transaction->is_success() && $action2 ) {
2608     my $auth = $transaction->authorization;
2609     my $ordernum = $transaction->can('order_number')
2610                    ? $transaction->order_number
2611                    : '';
2612
2613     my $capture =
2614       new Business::OnlinePayment( $processor, @bop_options );
2615
2616     my %capture = (
2617       %content,
2618       type           => $method,
2619       action         => $action2,
2620       login          => $login,
2621       password       => $password,
2622       order_number   => $ordernum,
2623       amount         => $amount,
2624       authorization  => $auth,
2625       description    => $options{'description'},
2626     );
2627
2628     foreach my $field (qw( authorization_source_code returned_ACI
2629                            transaction_identifier validation_code
2630                            transaction_sequence_num local_transaction_date
2631                            local_transaction_time AVS_result_code          )) {
2632       $capture{$field} = $transaction->$field() if $transaction->can($field);
2633     }
2634
2635     $capture->content( %capture );
2636
2637     $capture->submit();
2638
2639     unless ( $capture->is_success ) {
2640       my $e = "Authorization successful but capture failed, custnum #".
2641               $self->custnum. ': '.  $capture->result_code.
2642               ": ". $capture->error_message;
2643       warn $e;
2644       return $e;
2645     }
2646
2647   }
2648
2649   ###
2650   # remove paycvv after initial transaction
2651   ###
2652
2653   #false laziness w/misc/process/payment.cgi - check both to make sure working
2654   # correctly
2655   if ( defined $self->dbdef_table->column('paycvv')
2656        && length($self->paycvv)
2657        && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
2658   ) {
2659     my $error = $self->remove_cvv;
2660     if ( $error ) {
2661       warn "WARNING: error removing cvv: $error\n";
2662     }
2663   }
2664
2665   ###
2666   # result handling
2667   ###
2668
2669   if ( $transaction->is_success() ) {
2670
2671     my %method2payby = (
2672       'CC'     => 'CARD',
2673       'ECHECK' => 'CHEK',
2674       'LEC'    => 'LECB',
2675     );
2676
2677     my $paybatch = '';
2678     if ( $payment_gateway ) { # agent override
2679       $paybatch = $payment_gateway->gatewaynum. '-';
2680     }
2681
2682     $paybatch .= "$processor:". $transaction->authorization;
2683
2684     $paybatch .= ':'. $transaction->order_number
2685       if $transaction->can('order_number')
2686       && length($transaction->order_number);
2687
2688     my $cust_pay = new FS::cust_pay ( {
2689        'custnum'  => $self->custnum,
2690        'invnum'   => $options{'invnum'},
2691        'paid'     => $amount,
2692        '_date'     => '',
2693        'payby'    => $method2payby{$method},
2694        'payinfo'  => $payinfo,
2695        'paybatch' => $paybatch,
2696     } );
2697     my $error = $cust_pay->insert;
2698     if ( $error ) {
2699       $cust_pay->invnum(''); #try again with no specific invnum
2700       my $error2 = $cust_pay->insert;
2701       if ( $error2 ) {
2702         # gah, even with transactions.
2703         my $e = 'WARNING: Card/ACH debited but database not updated - '.
2704                 "error inserting payment ($processor): $error2".
2705                 " (previously tried insert with invnum #$options{'invnum'}" .
2706                 ": $error )";
2707         warn $e;
2708         return $e;
2709       }
2710     }
2711     return ''; #no error
2712
2713   } else {
2714
2715     my $perror = "$processor error: ". $transaction->error_message;
2716
2717     if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
2718          && $conf->exists('emaildecline')
2719          && grep { $_ ne 'POST' } $self->invoicing_list
2720          && ! grep { $transaction->error_message =~ /$_/ }
2721                    $conf->config('emaildecline-exclude')
2722     ) {
2723       my @templ = $conf->config('declinetemplate');
2724       my $template = new Text::Template (
2725         TYPE   => 'ARRAY',
2726         SOURCE => [ map "$_\n", @templ ],
2727       ) or return "($perror) can't create template: $Text::Template::ERROR";
2728       $template->compile()
2729         or return "($perror) can't compile template: $Text::Template::ERROR";
2730
2731       my $templ_hash = { error => $transaction->error_message };
2732
2733       my $error = send_email(
2734         'from'    => $conf->config('invoice_from'),
2735         'to'      => [ grep { $_ ne 'POST' } $self->invoicing_list ],
2736         'subject' => 'Your payment could not be processed',
2737         'body'    => [ $template->fill_in(HASH => $templ_hash) ],
2738       );
2739
2740       $perror .= " (also received error sending decline notification: $error)"
2741         if $error;
2742
2743     }
2744
2745     return $perror;
2746   }
2747
2748 }
2749
2750 =item default_payment_gateway
2751
2752 =cut
2753
2754 sub default_payment_gateway {
2755   my( $self, $method ) = @_;
2756
2757   die "Real-time processing not enabled\n"
2758     unless $conf->exists('business-onlinepayment');
2759
2760   #load up config
2761   my $bop_config = 'business-onlinepayment';
2762   $bop_config .= '-ach'
2763     if $method eq 'ECHECK' && $conf->exists($bop_config. '-ach');
2764   my ( $processor, $login, $password, $action, @bop_options ) =
2765     $conf->config($bop_config);
2766   $action ||= 'normal authorization';
2767   pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
2768   die "No real-time processor is enabled - ".
2769       "did you set the business-onlinepayment configuration value?\n"
2770     unless $processor;
2771
2772   ( $processor, $login, $password, $action, @bop_options )
2773 }
2774
2775 =item remove_cvv
2776
2777 Removes the I<paycvv> field from the database directly.
2778
2779 If there is an error, returns the error, otherwise returns false.
2780
2781 =cut
2782
2783 sub remove_cvv {
2784   my $self = shift;
2785   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2786     or return dbh->errstr;
2787   $sth->execute($self->custnum)
2788     or return $sth->errstr;
2789   $self->paycvv('');
2790   '';
2791 }
2792
2793 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
2794
2795 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
2796 via a Business::OnlinePayment realtime gateway.  See
2797 L<http://420.am/business-onlinepayment> for supported gateways.
2798
2799 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2800
2801 Available options are: I<amount>, I<reason>, I<paynum>
2802
2803 Most gateways require a reference to an original payment transaction to refund,
2804 so you probably need to specify a I<paynum>.
2805
2806 I<amount> defaults to the original amount of the payment if not specified.
2807
2808 I<reason> specifies a reason for the refund.
2809
2810 Implementation note: If I<amount> is unspecified or equal to the amount of the
2811 orignal payment, first an attempt is made to "void" the transaction via
2812 the gateway (to cancel a not-yet settled transaction) and then if that fails,
2813 the normal attempt is made to "refund" ("credit") the transaction via the
2814 gateway is attempted.
2815
2816 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2817 #I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
2818 #if set, will override the value from the customer record.
2819
2820 #If an I<invnum> is specified, this payment (if successful) is applied to the
2821 #specified invoice.  If you don't specify an I<invnum> you might want to
2822 #call the B<apply_payments> method.
2823
2824 =cut
2825
2826 #some false laziness w/realtime_bop, not enough to make it worth merging
2827 #but some useful small subs should be pulled out
2828 sub realtime_refund_bop {
2829   my( $self, $method, %options ) = @_;
2830   if ( $DEBUG ) {
2831     warn "$me realtime_refund_bop: $method refund\n";
2832     warn "  $_ => $options{$_}\n" foreach keys %options;
2833   }
2834
2835   eval "use Business::OnlinePayment";
2836   die $@ if $@;
2837
2838   ###
2839   # look up the original payment and optionally a gateway for that payment
2840   ###
2841
2842   my $cust_pay = '';
2843   my $amount = $options{'amount'};
2844
2845   my( $processor, $login, $password, @bop_options ) ;
2846   my( $auth, $order_number ) = ( '', '', '' );
2847
2848   if ( $options{'paynum'} ) {
2849
2850     warn "  paynum: $options{paynum}\n" if $DEBUG > 1;
2851     $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
2852       or return "Unknown paynum $options{'paynum'}";
2853     $amount ||= $cust_pay->paid;
2854
2855     $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-]*)(:([\w\-]+))?$/
2856       or return "Can't parse paybatch for paynum $options{'paynum'}: ".
2857                 $cust_pay->paybatch;
2858     my $gatewaynum = '';
2859     ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
2860
2861     if ( $gatewaynum ) { #gateway for the payment to be refunded
2862
2863       my $payment_gateway =
2864         qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
2865       die "payment gateway $gatewaynum not found"
2866         unless $payment_gateway;
2867
2868       $processor   = $payment_gateway->gateway_module;
2869       $login       = $payment_gateway->gateway_username;
2870       $password    = $payment_gateway->gateway_password;
2871       @bop_options = $payment_gateway->options;
2872
2873     } else { #try the default gateway
2874
2875       my( $conf_processor, $unused_action );
2876       ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
2877         $self->default_payment_gateway($method);
2878
2879       return "processor of payment $options{'paynum'} $processor does not".
2880              " match default processor $conf_processor"
2881         unless $processor eq $conf_processor;
2882
2883     }
2884
2885
2886   } else { # didn't specify a paynum, so look for agent gateway overrides
2887            # like a normal transaction
2888
2889     my $cardtype;
2890     if ( $method eq 'CC' ) {
2891       $cardtype = cardtype($self->payinfo);
2892     } elsif ( $method eq 'ECHECK' ) {
2893       $cardtype = 'ACH';
2894     } else {
2895       $cardtype = $method;
2896     }
2897     my $override =
2898            qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2899                                                cardtype => $cardtype,
2900                                                taxclass => '',              } )
2901         || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2902                                                cardtype => '',
2903                                                taxclass => '',              } );
2904
2905     if ( $override ) { #use a payment gateway override
2906
2907       my $payment_gateway = $override->payment_gateway;
2908
2909       $processor   = $payment_gateway->gateway_module;
2910       $login       = $payment_gateway->gateway_username;
2911       $password    = $payment_gateway->gateway_password;
2912       #$action      = $payment_gateway->gateway_action;
2913       @bop_options = $payment_gateway->options;
2914
2915     } else { #use the standard settings from the config
2916
2917       my $unused_action;
2918       ( $processor, $login, $password, $unused_action, @bop_options ) =
2919         $self->default_payment_gateway($method);
2920
2921     }
2922
2923   }
2924   return "neither amount nor paynum specified" unless $amount;
2925
2926   my %content = (
2927     'type'           => $method,
2928     'login'          => $login,
2929     'password'       => $password,
2930     'order_number'   => $order_number,
2931     'amount'         => $amount,
2932     'referer'        => 'http://cleanwhisker.420.am/',
2933   );
2934   $content{authorization} = $auth
2935     if length($auth); #echeck/ACH transactions have an order # but no auth
2936                       #(at least with authorize.net)
2937
2938   #first try void if applicable
2939   if ( $cust_pay && $cust_pay->paid == $amount ) { #and check dates?
2940     warn "  attempting void\n" if $DEBUG > 1;
2941     my $void = new Business::OnlinePayment( $processor, @bop_options );
2942     $void->content( 'action' => 'void', %content );
2943     $void->submit();
2944     if ( $void->is_success ) {
2945       my $error = $cust_pay->void($options{'reason'});
2946       if ( $error ) {
2947         # gah, even with transactions.
2948         my $e = 'WARNING: Card/ACH voided but database not updated - '.
2949                 "error voiding payment: $error";
2950         warn $e;
2951         return $e;
2952       }
2953       warn "  void successful\n" if $DEBUG > 1;
2954       return '';
2955     }
2956   }
2957
2958   warn "  void unsuccessful, trying refund\n"
2959     if $DEBUG > 1;
2960
2961   #massage data
2962   my $address = $self->address1;
2963   $address .= ", ". $self->address2 if $self->address2;
2964
2965   my($payname, $payfirst, $paylast);
2966   if ( $self->payname && $method ne 'ECHECK' ) {
2967     $payname = $self->payname;
2968     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2969       or return "Illegal payname $payname";
2970     ($payfirst, $paylast) = ($1, $2);
2971   } else {
2972     $payfirst = $self->getfield('first');
2973     $paylast = $self->getfield('last');
2974     $payname =  "$payfirst $paylast";
2975   }
2976
2977   my @invoicing_list = grep { $_ ne 'POST' } $self->invoicing_list;
2978   if ( $conf->exists('emailinvoiceauto')
2979        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
2980     push @invoicing_list, $self->all_emails;
2981   }
2982
2983   my $email = ($conf->exists('business-onlinepayment-email-override'))
2984               ? $conf->config('business-onlinepayment-email-override')
2985               : $invoicing_list[0];
2986
2987   my $payip = exists($options{'payip'})
2988                 ? $options{'payip'}
2989                 : $self->payip;
2990   $content{customer_ip} = $payip
2991     if length($payip);
2992
2993   my $payinfo = '';
2994   if ( $method eq 'CC' ) {
2995
2996     if ( $cust_pay ) {
2997       $content{card_number} = $payinfo = $cust_pay->payinfo;
2998       #$self->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2999       #$content{expiration} = "$2/$1";
3000     } else {
3001       $content{card_number} = $payinfo = $self->payinfo;
3002       $self->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3003       $content{expiration} = "$2/$1";
3004     }
3005
3006   } elsif ( $method eq 'ECHECK' ) {
3007     ( $content{account_number}, $content{routing_code} ) =
3008       split('@', $payinfo = $self->payinfo);
3009     $content{bank_name} = $self->payname;
3010     $content{account_type} = 'CHECKING';
3011     $content{account_name} = $payname;
3012     $content{customer_org} = $self->company ? 'B' : 'I';
3013     $content{customer_ssn} = $self->ss;
3014   } elsif ( $method eq 'LEC' ) {
3015     $content{phone} = $payinfo = $self->payinfo;
3016   }
3017
3018   #then try refund
3019   my $refund = new Business::OnlinePayment( $processor, @bop_options );
3020   my %sub_content = $refund->content(
3021     'action'         => 'credit',
3022     'customer_id'    => $self->custnum,
3023     'last_name'      => $paylast,
3024     'first_name'     => $payfirst,
3025     'name'           => $payname,
3026     'address'        => $address,
3027     'city'           => $self->city,
3028     'state'          => $self->state,
3029     'zip'            => $self->zip,
3030     'country'        => $self->country,
3031     'email'          => $email,
3032     'phone'          => $self->daytime || $self->night,
3033     %content, #after
3034   );
3035   warn join('', map { "  $_ => $sub_content{$_}\n" } keys %sub_content )
3036     if $DEBUG > 1;
3037   $refund->submit();
3038
3039   return "$processor error: ". $refund->error_message
3040     unless $refund->is_success();
3041
3042   my %method2payby = (
3043     'CC'     => 'CARD',
3044     'ECHECK' => 'CHEK',
3045     'LEC'    => 'LECB',
3046   );
3047
3048   my $paybatch = "$processor:". $refund->authorization;
3049   $paybatch .= ':'. $refund->order_number
3050     if $refund->can('order_number') && $refund->order_number;
3051
3052   while ( $cust_pay && $cust_pay->unappled < $amount ) {
3053     my @cust_bill_pay = $cust_pay->cust_bill_pay;
3054     last unless @cust_bill_pay;
3055     my $cust_bill_pay = pop @cust_bill_pay;
3056     my $error = $cust_bill_pay->delete;
3057     last if $error;
3058   }
3059
3060   my $cust_refund = new FS::cust_refund ( {
3061     'custnum'  => $self->custnum,
3062     'paynum'   => $options{'paynum'},
3063     'refund'   => $amount,
3064     '_date'    => '',
3065     'payby'    => $method2payby{$method},
3066     'payinfo'  => $payinfo,
3067     'paybatch' => $paybatch,
3068     'reason'   => $options{'reason'} || 'card or ACH refund',
3069   } );
3070   my $error = $cust_refund->insert;
3071   if ( $error ) {
3072     $cust_refund->paynum(''); #try again with no specific paynum
3073     my $error2 = $cust_refund->insert;
3074     if ( $error2 ) {
3075       # gah, even with transactions.
3076       my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3077               "error inserting refund ($processor): $error2".
3078               " (previously tried insert with paynum #$options{'paynum'}" .
3079               ": $error )";
3080       warn $e;
3081       return $e;
3082     }
3083   }
3084
3085   ''; #no error
3086
3087 }
3088
3089 =item total_owed
3090
3091 Returns the total owed for this customer on all invoices
3092 (see L<FS::cust_bill/owed>).
3093
3094 =cut
3095
3096 sub total_owed {
3097   my $self = shift;
3098   $self->total_owed_date(2145859200); #12/31/2037
3099 }
3100
3101 =item total_owed_date TIME
3102
3103 Returns the total owed for this customer on all invoices with date earlier than
3104 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
3105 see L<Time::Local> and L<Date::Parse> for conversion functions.
3106
3107 =cut
3108
3109 sub total_owed_date {
3110   my $self = shift;
3111   my $time = shift;
3112   my $total_bill = 0;
3113   foreach my $cust_bill (
3114     grep { $_->_date <= $time }
3115       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3116   ) {
3117     $total_bill += $cust_bill->owed;
3118   }
3119   sprintf( "%.2f", $total_bill );
3120 }
3121
3122 =item apply_credits OPTION => VALUE ...
3123
3124 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3125 to outstanding invoice balances in chronological order (or reverse
3126 chronological order if the I<order> option is set to B<newest>) and returns the
3127 value of any remaining unapplied credits available for refund (see
3128 L<FS::cust_refund>).
3129
3130 =cut
3131
3132 sub apply_credits {
3133   my $self = shift;
3134   my %opt = @_;
3135
3136   return 0 unless $self->total_credited;
3137
3138   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3139       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3140
3141   my @invoices = $self->open_cust_bill;
3142   @invoices = sort { $b->_date <=> $a->_date } @invoices
3143     if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3144
3145   my $credit;
3146   foreach my $cust_bill ( @invoices ) {
3147     my $amount;
3148
3149     if ( !defined($credit) || $credit->credited == 0) {
3150       $credit = pop @credits or last;
3151     }
3152
3153     if ($cust_bill->owed >= $credit->credited) {
3154       $amount=$credit->credited;
3155     }else{
3156       $amount=$cust_bill->owed;
3157     }
3158
3159     my $cust_credit_bill = new FS::cust_credit_bill ( {
3160       'crednum' => $credit->crednum,
3161       'invnum'  => $cust_bill->invnum,
3162       'amount'  => $amount,
3163     } );
3164     my $error = $cust_credit_bill->insert;
3165     die $error if $error;
3166
3167     redo if ($cust_bill->owed > 0);
3168
3169   }
3170
3171   return $self->total_credited;
3172 }
3173
3174 =item apply_payments
3175
3176 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3177 to outstanding invoice balances in chronological order.
3178
3179  #and returns the value of any remaining unapplied payments.
3180
3181 =cut
3182
3183 sub apply_payments {
3184   my $self = shift;
3185
3186   #return 0 unless
3187
3188   my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
3189       qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
3190
3191   my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
3192       qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
3193
3194   my $payment;
3195
3196   foreach my $cust_bill ( @invoices ) {
3197     my $amount;
3198
3199     if ( !defined($payment) || $payment->unapplied == 0 ) {
3200       $payment = pop @payments or last;
3201     }
3202
3203     if ( $cust_bill->owed >= $payment->unapplied ) {
3204       $amount = $payment->unapplied;
3205     } else {
3206       $amount = $cust_bill->owed;
3207     }
3208
3209     my $cust_bill_pay = new FS::cust_bill_pay ( {
3210       'paynum' => $payment->paynum,
3211       'invnum' => $cust_bill->invnum,
3212       'amount' => $amount,
3213     } );
3214     my $error = $cust_bill_pay->insert;
3215     die $error if $error;
3216
3217     redo if ( $cust_bill->owed > 0);
3218
3219   }
3220
3221   return $self->total_unapplied_payments;
3222 }
3223
3224 =item total_credited
3225
3226 Returns the total outstanding credit (see L<FS::cust_credit>) for this
3227 customer.  See L<FS::cust_credit/credited>.
3228
3229 =cut
3230
3231 sub total_credited {
3232   my $self = shift;
3233   my $total_credit = 0;
3234   foreach my $cust_credit ( qsearch('cust_credit', {
3235     'custnum' => $self->custnum,
3236   } ) ) {
3237     $total_credit += $cust_credit->credited;
3238   }
3239   sprintf( "%.2f", $total_credit );
3240 }
3241
3242 =item total_unapplied_payments
3243
3244 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
3245 See L<FS::cust_pay/unapplied>.
3246
3247 =cut
3248
3249 sub total_unapplied_payments {
3250   my $self = shift;
3251   my $total_unapplied = 0;
3252   foreach my $cust_pay ( qsearch('cust_pay', {
3253     'custnum' => $self->custnum,
3254   } ) ) {
3255     $total_unapplied += $cust_pay->unapplied;
3256   }
3257   sprintf( "%.2f", $total_unapplied );
3258 }
3259
3260 =item balance
3261
3262 Returns the balance for this customer (total_owed minus total_credited
3263 minus total_unapplied_payments).
3264
3265 =cut
3266
3267 sub balance {
3268   my $self = shift;
3269   sprintf( "%.2f",
3270     $self->total_owed - $self->total_credited - $self->total_unapplied_payments
3271   );
3272 }
3273
3274 =item balance_date TIME
3275
3276 Returns the balance for this customer, only considering invoices with date
3277 earlier than TIME (total_owed_date minus total_credited minus
3278 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
3279 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
3280 functions.
3281
3282 =cut
3283
3284 sub balance_date {
3285   my $self = shift;
3286   my $time = shift;
3287   sprintf( "%.2f",
3288     $self->total_owed_date($time)
3289       - $self->total_credited
3290       - $self->total_unapplied_payments
3291   );
3292 }
3293
3294 =item in_transit_payments
3295
3296 Returns the total of requests for payments for this customer pending in
3297 batches in transit to the bank.  See L<FS::pay_batch> and L<FS::cust_pay_batch>
3298
3299 =cut
3300
3301 sub in_transit_payments {
3302   my $self = shift;
3303   my $in_transit_payments = 0;
3304   foreach my $pay_batch ( qsearch('pay_batch', {
3305     'status' => 'I',
3306   } ) ) {
3307     foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
3308       'batchnum' => $pay_batch->batchnum,
3309       'custnum' => $self->custnum,
3310     } ) ) {
3311       $in_transit_payments += $cust_pay_batch->amount;
3312     }
3313   }
3314   sprintf( "%.2f", $in_transit_payments );
3315 }
3316
3317 =item paydate_monthyear
3318
3319 Returns a two-element list consisting of the month and year of this customer's
3320 paydate (credit card expiration date for CARD customers)
3321
3322 =cut
3323
3324 sub paydate_monthyear {
3325   my $self = shift;
3326   if ( $self->paydate  =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3327     ( $2, $1 );
3328   } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3329     ( $1, $3 );
3330   } else {
3331     ('', '');
3332   }
3333 }
3334
3335 =item payinfo_masked
3336
3337 < DEPRICATED > Use $self->paymask
3338
3339 Returns a "masked" payinfo field appropriate to the payment type.  Masked characters are replaced by 'x'es.  Use this to display publicly accessable account Information.
3340
3341 Credit Cards - Mask all but the last four characters.
3342 Checks - Mask all but last 2 of account number and bank routing number.
3343 Others - Do nothing, return the unmasked string.
3344
3345 =cut
3346
3347 sub payinfo_masked {
3348   my $self = shift;
3349   return $self->paymask;
3350 }
3351
3352 =item invoicing_list [ ARRAYREF ]
3353
3354 If an arguement is given, sets these email addresses as invoice recipients
3355 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
3356 (except as warnings), so use check_invoicing_list first.
3357
3358 Returns a list of email addresses (with svcnum entries expanded).
3359
3360 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
3361 check it without disturbing anything by passing nothing.
3362
3363 This interface may change in the future.
3364
3365 =cut
3366
3367 sub invoicing_list {
3368   my( $self, $arrayref ) = @_;
3369
3370   if ( $arrayref ) {
3371     my @cust_main_invoice;
3372     if ( $self->custnum ) {
3373       @cust_main_invoice =
3374         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3375     } else {
3376       @cust_main_invoice = ();
3377     }
3378     foreach my $cust_main_invoice ( @cust_main_invoice ) {
3379       #warn $cust_main_invoice->destnum;
3380       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3381         #warn $cust_main_invoice->destnum;
3382         my $error = $cust_main_invoice->delete;
3383         warn $error if $error;
3384       }
3385     }
3386     if ( $self->custnum ) {
3387       @cust_main_invoice =
3388         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3389     } else {
3390       @cust_main_invoice = ();
3391     }
3392     my %seen = map { $_->address => 1 } @cust_main_invoice;
3393     foreach my $address ( @{$arrayref} ) {
3394       next if exists $seen{$address} && $seen{$address};
3395       $seen{$address} = 1;
3396       my $cust_main_invoice = new FS::cust_main_invoice ( {
3397         'custnum' => $self->custnum,
3398         'dest'    => $address,
3399       } );
3400       my $error = $cust_main_invoice->insert;
3401       warn $error if $error;
3402     }
3403   }
3404
3405   if ( $self->custnum ) {
3406     map { $_->address }
3407       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3408   } else {
3409     ();
3410   }
3411
3412 }
3413
3414 =item check_invoicing_list ARRAYREF
3415
3416 Checks these arguements as valid input for the invoicing_list method.  If there
3417 is an error, returns the error, otherwise returns false.
3418
3419 =cut
3420
3421 sub check_invoicing_list {
3422   my( $self, $arrayref ) = @_;
3423   foreach my $address ( @{$arrayref} ) {
3424
3425     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3426       return 'Can\'t add FAX invoice destination with a blank FAX number.';
3427     }
3428
3429     my $cust_main_invoice = new FS::cust_main_invoice ( {
3430       'custnum' => $self->custnum,
3431       'dest'    => $address,
3432     } );
3433     my $error = $self->custnum
3434                 ? $cust_main_invoice->check
3435                 : $cust_main_invoice->checkdest
3436     ;
3437     return $error if $error;
3438   }
3439   '';
3440 }
3441
3442 =item set_default_invoicing_list
3443
3444 Sets the invoicing list to all accounts associated with this customer,
3445 overwriting any previous invoicing list.
3446
3447 =cut
3448
3449 sub set_default_invoicing_list {
3450   my $self = shift;
3451   $self->invoicing_list($self->all_emails);
3452 }
3453
3454 =item all_emails
3455
3456 Returns the email addresses of all accounts provisioned for this customer.
3457
3458 =cut
3459
3460 sub all_emails {
3461   my $self = shift;
3462   my %list;
3463   foreach my $cust_pkg ( $self->all_pkgs ) {
3464     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3465     my @svc_acct =
3466       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3467         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3468           @cust_svc;
3469     $list{$_}=1 foreach map { $_->email } @svc_acct;
3470   }
3471   keys %list;
3472 }
3473
3474 =item invoicing_list_addpost
3475
3476 Adds postal invoicing to this customer.  If this customer is already configured
3477 to receive postal invoices, does nothing.
3478
3479 =cut
3480
3481 sub invoicing_list_addpost {
3482   my $self = shift;
3483   return if grep { $_ eq 'POST' } $self->invoicing_list;
3484   my @invoicing_list = $self->invoicing_list;
3485   push @invoicing_list, 'POST';
3486   $self->invoicing_list(\@invoicing_list);
3487 }
3488
3489 =item invoicing_list_emailonly
3490
3491 Returns the list of email invoice recipients (invoicing_list without non-email
3492 destinations such as POST and FAX).
3493
3494 =cut
3495
3496 sub invoicing_list_emailonly {
3497   my $self = shift;
3498   grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3499 }
3500
3501 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3502
3503 Returns an array of customers referred by this customer (referral_custnum set
3504 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
3505 customers referred by customers referred by this customer and so on, inclusive.
3506 The default behavior is DEPTH 1 (no recursion).
3507
3508 =cut
3509
3510 sub referral_cust_main {
3511   my $self = shift;
3512   my $depth = @_ ? shift : 1;
3513   my $exclude = @_ ? shift : {};
3514
3515   my @cust_main =
3516     map { $exclude->{$_->custnum}++; $_; }
3517       grep { ! $exclude->{ $_->custnum } }
3518         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3519
3520   if ( $depth > 1 ) {
3521     push @cust_main,
3522       map { $_->referral_cust_main($depth-1, $exclude) }
3523         @cust_main;
3524   }
3525
3526   @cust_main;
3527 }
3528
3529 =item referral_cust_main_ncancelled
3530
3531 Same as referral_cust_main, except only returns customers with uncancelled
3532 packages.
3533
3534 =cut
3535
3536 sub referral_cust_main_ncancelled {
3537   my $self = shift;
3538   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3539 }
3540
3541 =item referral_cust_pkg [ DEPTH ]
3542
3543 Like referral_cust_main, except returns a flat list of all unsuspended (and
3544 uncancelled) packages for each customer.  The number of items in this list may
3545 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3546
3547 =cut
3548
3549 sub referral_cust_pkg {
3550   my $self = shift;
3551   my $depth = @_ ? shift : 1;
3552
3553   map { $_->unsuspended_pkgs }
3554     grep { $_->unsuspended_pkgs }
3555       $self->referral_cust_main($depth);
3556 }
3557
3558 =item referring_cust_main
3559
3560 Returns the single cust_main record for the customer who referred this customer
3561 (referral_custnum), or false.
3562
3563 =cut
3564
3565 sub referring_cust_main {
3566   my $self = shift;
3567   return '' unless $self->referral_custnum;
3568   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3569 }
3570
3571 =item credit AMOUNT, REASON
3572
3573 Applies a credit to this customer.  If there is an error, returns the error,
3574 otherwise returns false.
3575
3576 =cut
3577
3578 sub credit {
3579   my( $self, $amount, $reason ) = @_;
3580   my $cust_credit = new FS::cust_credit {
3581     'custnum' => $self->custnum,
3582     'amount'  => $amount,
3583     'reason'  => $reason,
3584   };
3585   $cust_credit->insert;
3586 }
3587
3588 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3589
3590 Creates a one-time charge for this customer.  If there is an error, returns
3591 the error, otherwise returns false.
3592
3593 =cut
3594
3595 sub charge {
3596   my ( $self, $amount ) = ( shift, shift );
3597   my $pkg      = @_ ? shift : 'One-time charge';
3598   my $comment  = @_ ? shift : '$'. sprintf("%.2f",$amount);
3599   my $taxclass = @_ ? shift : '';
3600
3601   local $SIG{HUP} = 'IGNORE';
3602   local $SIG{INT} = 'IGNORE';
3603   local $SIG{QUIT} = 'IGNORE';
3604   local $SIG{TERM} = 'IGNORE';
3605   local $SIG{TSTP} = 'IGNORE';
3606   local $SIG{PIPE} = 'IGNORE';
3607
3608   my $oldAutoCommit = $FS::UID::AutoCommit;
3609   local $FS::UID::AutoCommit = 0;
3610   my $dbh = dbh;
3611
3612   my $part_pkg = new FS::part_pkg ( {
3613     'pkg'      => $pkg,
3614     'comment'  => $comment,
3615     #'setup'    => $amount,
3616     #'recur'    => '0',
3617     'plan'     => 'flat',
3618     'plandata' => "setup_fee=$amount",
3619     'freq'     => 0,
3620     'disabled' => 'Y',
3621     'taxclass' => $taxclass,
3622   } );
3623
3624   my $error = $part_pkg->insert;
3625   if ( $error ) {
3626     $dbh->rollback if $oldAutoCommit;
3627     return $error;
3628   }
3629
3630   my $pkgpart = $part_pkg->pkgpart;
3631   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3632   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3633     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3634     $error = $type_pkgs->insert;
3635     if ( $error ) {
3636       $dbh->rollback if $oldAutoCommit;
3637       return $error;
3638     }
3639   }
3640
3641   my $cust_pkg = new FS::cust_pkg ( {
3642     'custnum' => $self->custnum,
3643     'pkgpart' => $pkgpart,
3644   } );
3645
3646   $error = $cust_pkg->insert;
3647   if ( $error ) {
3648     $dbh->rollback if $oldAutoCommit;
3649     return $error;
3650   }
3651
3652   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3653   '';
3654
3655 }
3656
3657 =item cust_bill
3658
3659 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3660
3661 =cut
3662
3663 sub cust_bill {
3664   my $self = shift;
3665   sort { $a->_date <=> $b->_date }
3666     qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3667 }
3668
3669 =item open_cust_bill
3670
3671 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3672 customer.
3673
3674 =cut
3675
3676 sub open_cust_bill {
3677   my $self = shift;
3678   grep { $_->owed > 0 } $self->cust_bill;
3679 }
3680
3681 =item cust_credit
3682
3683 Returns all the credits (see L<FS::cust_credit>) for this customer.
3684
3685 =cut
3686
3687 sub cust_credit {
3688   my $self = shift;
3689   sort { $a->_date <=> $b->_date }
3690     qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3691 }
3692
3693 =item cust_pay
3694
3695 Returns all the payments (see L<FS::cust_pay>) for this customer.
3696
3697 =cut
3698
3699 sub cust_pay {
3700   my $self = shift;
3701   sort { $a->_date <=> $b->_date }
3702     qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3703 }
3704
3705 =item cust_pay_void
3706
3707 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3708
3709 =cut
3710
3711 sub cust_pay_void {
3712   my $self = shift;
3713   sort { $a->_date <=> $b->_date }
3714     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3715 }
3716
3717
3718 =item cust_refund
3719
3720 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3721
3722 =cut
3723
3724 sub cust_refund {
3725   my $self = shift;
3726   sort { $a->_date <=> $b->_date }
3727     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3728 }
3729
3730 =item select_for_update
3731
3732 Selects this record with the SQL "FOR UPDATE" command.  This can be useful as
3733 a mutex.
3734
3735 =cut
3736
3737 sub select_for_update {
3738   my $self = shift;
3739   qsearch('cust_main', { 'custnum' => $self->custnum }, '*', 'FOR UPDATE' );
3740 }
3741
3742 =item name
3743
3744 Returns a name string for this customer, either "Company (Last, First)" or
3745 "Last, First".
3746
3747 =cut
3748
3749 sub name {
3750   my $self = shift;
3751   my $name = $self->contact;
3752   $name = $self->company. " ($name)" if $self->company;
3753   $name;
3754 }
3755
3756 =item ship_name
3757
3758 Returns a name string for this (service/shipping) contact, either
3759 "Company (Last, First)" or "Last, First".
3760
3761 =cut
3762
3763 sub ship_name {
3764   my $self = shift;
3765   if ( $self->get('ship_last') ) {
3766     my $name = $self->ship_contact;
3767     $name = $self->ship_company. " ($name)" if $self->ship_company;
3768     $name;
3769   } else {
3770     $self->name;
3771   }
3772 }
3773
3774 =item contact
3775
3776 Returns this customer's full (billing) contact name only, "Last, First"
3777
3778 =cut
3779
3780 sub contact {
3781   my $self = shift;
3782   $self->get('last'). ', '. $self->first;
3783 }
3784
3785 =item ship_contact
3786
3787 Returns this customer's full (shipping) contact name only, "Last, First"
3788
3789 =cut
3790
3791 sub ship_contact {
3792   my $self = shift;
3793   $self->get('ship_last')
3794     ? $self->get('ship_last'). ', '. $self->ship_first
3795     : $self->contact;
3796 }
3797
3798 =item country_full
3799
3800 Returns this customer's full country name
3801
3802 =cut
3803
3804 sub country_full {
3805   my $self = shift;
3806   code2country($self->country);
3807 }
3808
3809 =item status
3810
3811 Returns a status string for this customer, currently:
3812
3813 =over 4
3814
3815 =item prospect - No packages have ever been ordered
3816
3817 =item active - One or more recurring packages is active
3818
3819 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
3820
3821 =item suspended - All non-cancelled recurring packages are suspended
3822
3823 =item cancelled - All recurring packages are cancelled
3824
3825 =back
3826
3827 =cut
3828
3829 sub status {
3830   my $self = shift;
3831   for my $status (qw( prospect active inactive suspended cancelled )) {
3832     my $method = $status.'_sql';
3833     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
3834     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
3835     $sth->execute( ($self->custnum) x $numnum ) or die $sth->errstr;
3836     return $status if $sth->fetchrow_arrayref->[0];
3837   }
3838 }
3839
3840 =item statuscolor
3841
3842 Returns a hex triplet color string for this customer's status.
3843
3844 =cut
3845
3846 use vars qw(%statuscolor);
3847 %statuscolor = (
3848   'prospect'  => '7e0079', #'000000', #black?  naw, purple
3849   'active'    => '00CC00', #green
3850   'inactive'  => '0000CC', #blue
3851   'suspended' => 'FF9900', #yellow
3852   'cancelled' => 'FF0000', #red
3853 );
3854
3855 sub statuscolor {
3856   my $self = shift;
3857   $statuscolor{$self->status};
3858 }
3859
3860 =back
3861
3862 =head1 CLASS METHODS
3863
3864 =over 4
3865
3866 =item prospect_sql
3867
3868 Returns an SQL expression identifying prospective cust_main records (customers
3869 with no packages ever ordered)
3870
3871 =cut
3872
3873 use vars qw($select_count_pkgs);
3874 $select_count_pkgs =
3875   "SELECT COUNT(*) FROM cust_pkg
3876     WHERE cust_pkg.custnum = cust_main.custnum";
3877
3878 sub select_count_pkgs_sql {
3879   $select_count_pkgs;
3880 }
3881
3882 sub prospect_sql { "
3883   0 = ( $select_count_pkgs )
3884 "; }
3885
3886 =item active_sql
3887
3888 Returns an SQL expression identifying active cust_main records (customers with
3889 no active recurring packages, but otherwise unsuspended/uncancelled).
3890
3891 =cut
3892
3893 sub active_sql { "
3894   0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
3895       )
3896 "; }
3897
3898 =item inactive_sql
3899
3900 Returns an SQL expression identifying inactive cust_main records (customers with
3901 active recurring packages).
3902
3903 =cut
3904
3905 sub inactive_sql { "
3906   0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
3907   AND
3908   0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
3909 "; }
3910
3911 =item susp_sql
3912 =item suspended_sql
3913
3914 Returns an SQL expression identifying suspended cust_main records.
3915
3916 =cut
3917
3918
3919 sub suspended_sql { susp_sql(@_); }
3920 sub susp_sql { "
3921     0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
3922     AND
3923     0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
3924 "; }
3925
3926 =item cancel_sql
3927 =item cancelled_sql
3928
3929 Returns an SQL expression identifying cancelled cust_main records.
3930
3931 =cut
3932
3933 sub cancelled_sql { cancel_sql(@_); }
3934 sub cancel_sql {
3935
3936   my $recurring_sql = FS::cust_pkg->recurring_sql;
3937   #my $recurring_sql = "
3938   #  '0' != ( select freq from part_pkg
3939   #             where cust_pkg.pkgpart = part_pkg.pkgpart )
3940   #";
3941
3942   "
3943     0 < ( $select_count_pkgs )
3944     AND 0 = ( $select_count_pkgs AND $recurring_sql
3945                   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
3946             )
3947   ";
3948 }
3949
3950 =item uncancel_sql
3951 =item uncancelled_sql
3952
3953 Returns an SQL expression identifying un-cancelled cust_main records.
3954
3955 =cut
3956
3957 sub uncancelled_sql { uncancel_sql(@_); }
3958 sub uncancel_sql { "
3959   ( 0 < ( $select_count_pkgs
3960                    AND ( cust_pkg.cancel IS NULL
3961                          OR cust_pkg.cancel = 0
3962                        )
3963         )
3964     OR 0 = ( $select_count_pkgs )
3965   )
3966 "; }
3967
3968 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
3969
3970 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
3971 records.  Currently, I<first>, I<last> and/or I<company> may be specified (the
3972 appropriate ship_ field is also searched).
3973
3974 Additional options are the same as FS::Record::qsearch
3975
3976 =cut
3977
3978 sub fuzzy_search {
3979   my( $self, $fuzzy, $hash, @opt) = @_;
3980   #$self
3981   $hash ||= {};
3982   my @cust_main = ();
3983
3984   check_and_rebuild_fuzzyfiles();
3985   foreach my $field ( keys %$fuzzy ) {
3986
3987     my $all = $self->all_X($field);
3988     next unless scalar(@$all);
3989
3990     my %match = ();
3991     $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
3992
3993     my @fcust = ();
3994     foreach ( keys %match ) {
3995       push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
3996       push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
3997     }
3998     my %fsaw = ();
3999     push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
4000   }
4001
4002   # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
4003   my %saw = ();
4004   @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
4005
4006   @cust_main;
4007
4008 }
4009
4010 =back
4011
4012 =head1 SUBROUTINES
4013
4014 =over 4
4015
4016 =item smart_search OPTION => VALUE ...
4017
4018 Accepts the following options: I<search>, the string to search for.  The string
4019 will be searched for as a customer number, phone number, name or company name,
4020 as an exact, or, in some cases, a substring or fuzzy match (see the source code
4021 for the exact heuristics used).
4022
4023 Any additional options are treated as an additional qualifier on the search
4024 (i.e. I<agentnum>).
4025
4026 Returns a (possibly empty) array of FS::cust_main objects.
4027
4028 =cut
4029
4030 sub smart_search {
4031   my %options = @_;
4032
4033   #here is the agent virtualization
4034   my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
4035
4036   my @cust_main = ();
4037
4038   my $search = delete $options{'search'};
4039   ( my $alphanum_search = $search ) =~ s/\W//g;
4040
4041   if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
4042
4043     #false laziness w/Record::ut_phone
4044     my $phonen = "$1-$2-$3";
4045     $phonen .= " x$4" if $4;
4046
4047     push @cust_main, qsearch( {
4048       'table'   => 'cust_main',
4049       'hashref' => { %options },
4050       'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4051                      ' ( '.
4052                          join(' OR ', map "$_ = '$phonen'",
4053                                           qw( daytime night fax
4054                                               ship_daytime ship_night ship_fax )
4055                              ).
4056                      ' ) '.
4057                      " AND $agentnums_sql", #agent virtualization
4058     } );
4059
4060     unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
4061       #try looking for matches with extensions unless one was specified
4062
4063       push @cust_main, qsearch( {
4064         'table'   => 'cust_main',
4065         'hashref' => { %options },
4066         'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4067                        ' ( '.
4068                            join(' OR ', map "$_ LIKE '$phonen\%'",
4069                                             qw( daytime night
4070                                                 ship_daytime ship_night )
4071                                ).
4072                        ' ) '.
4073                        " AND $agentnums_sql", #agent virtualization
4074       } );
4075
4076     }
4077
4078   } elsif ( $search =~ /^\s*(\d+)\s*$/ ) { # customer # search
4079
4080     push @cust_main, qsearch( {
4081       'table'     => 'cust_main',
4082       'hashref'   => { 'custnum' => $1, %options },
4083       'extra_sql' => " AND $agentnums_sql", #agent virtualization
4084     } );
4085
4086   } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
4087
4088     my($company, $last, $first) = ( $1, $2, $3 );
4089
4090     # "Company (Last, First)"
4091     #this is probably something a browser remembered,
4092     #so just do an exact search
4093
4094     foreach my $prefix ( '', 'ship_' ) {
4095       push @cust_main, qsearch( {
4096         'table'     => 'cust_main',
4097         'hashref'   => { $prefix.'first'   => $first,
4098                          $prefix.'last'    => $last,
4099                          $prefix.'company' => $company,
4100                          %options,
4101                        },
4102         'extra_sql' => " AND $agentnums_sql",
4103       } );
4104     }
4105
4106   } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
4107                                               # try (ship_){last,company}
4108
4109     my $value = lc($1);
4110
4111     # # remove "(Last, First)" in "Company (Last, First)", otherwise the
4112     # # full strings the browser remembers won't work
4113     # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
4114
4115     use Lingua::EN::NameParse;
4116     my $NameParse = new Lingua::EN::NameParse(
4117              auto_clean     => 1,
4118              allow_reversed => 1,
4119     );
4120
4121     my($last, $first) = ( '', '' );
4122     #maybe disable this too and just rely on NameParse?
4123     if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
4124
4125       ($last, $first) = ( $1, $2 );
4126
4127     #} elsif  ( $value =~ /^(.+)\s+(.+)$/ ) {
4128     } elsif ( ! $NameParse->parse($value) ) {
4129
4130       my %name = $NameParse->components;
4131       $first = $name{'given_name_1'};
4132       $last  = $name{'surname_1'};
4133
4134     }
4135
4136     if ( $first && $last ) {
4137
4138       my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
4139
4140       #exact
4141       my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4142       $sql .= "
4143         (     ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
4144            OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
4145         )";
4146
4147       push @cust_main, qsearch( {
4148         'table'     => 'cust_main',
4149         'hashref'   => \%options,
4150         'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4151       } );
4152
4153       # or it just be something that was typed in... (try that in a sec)
4154
4155     }
4156
4157     my $q_value = dbh->quote($value);
4158
4159     #exact
4160     my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4161     $sql .= " (    LOWER(last)         = $q_value
4162                 OR LOWER(company)      = $q_value
4163                 OR LOWER(ship_last)    = $q_value
4164                 OR LOWER(ship_company) = $q_value
4165               )";
4166
4167     push @cust_main, qsearch( {
4168       'table'     => 'cust_main',
4169       'hashref'   => \%options,
4170       'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4171     } );
4172
4173     #always do substring & fuzzy,
4174     #getting complains searches are not returning enough
4175     #unless ( @cust_main ) {  #no exact match, trying substring/fuzzy
4176
4177       #still some false laziness w/ search/cust_main.cgi
4178
4179       #substring
4180
4181       my @hashrefs = (
4182         { 'company'      => { op=>'ILIKE', value=>"%$value%" }, },
4183         { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
4184       );
4185
4186       if ( $first && $last ) {
4187
4188         push @hashrefs,
4189           { 'first'        => { op=>'ILIKE', value=>"%$first%" },
4190             'last'         => { op=>'ILIKE', value=>"%$last%" },
4191           },
4192           { 'ship_first'   => { op=>'ILIKE', value=>"%$first%" },
4193             'ship_last'    => { op=>'ILIKE', value=>"%$last%" },
4194           },
4195         ;
4196
4197       } else {
4198
4199         push @hashrefs,
4200           { 'last'         => { op=>'ILIKE', value=>"%$value%" }, },
4201           { 'ship_last'    => { op=>'ILIKE', value=>"%$value%" }, },
4202         ;
4203       }
4204
4205       foreach my $hashref ( @hashrefs ) {
4206
4207         push @cust_main, qsearch( {
4208           'table'     => 'cust_main',
4209           'hashref'   => { %$hashref,
4210                            %options,
4211                          },
4212           'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
4213         } );
4214
4215       }
4216
4217       #fuzzy
4218       my @fuzopts = (
4219         \%options,                #hashref
4220         '',                       #select
4221         " AND $agentnums_sql",    #extra_sql  #agent virtualization
4222       );
4223
4224       if ( $first && $last ) {
4225         push @cust_main, FS::cust_main->fuzzy_search(
4226           { 'last'   => $last,    #fuzzy hashref
4227             'first'  => $first }, #
4228           @fuzopts
4229         );
4230       }
4231       foreach my $field ( 'last', 'company' ) {
4232         push @cust_main,
4233           FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
4234       }
4235
4236     #}
4237
4238     #eliminate duplicates
4239     my %saw = ();
4240     @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
4241
4242   }
4243
4244   @cust_main;
4245
4246 }
4247
4248 =item check_and_rebuild_fuzzyfiles
4249
4250 =cut
4251
4252 use vars qw(@fuzzyfields);
4253 @fuzzyfields = ( 'last', 'first', 'company' );
4254
4255 sub check_and_rebuild_fuzzyfiles {
4256   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4257   rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
4258 }
4259
4260 =item rebuild_fuzzyfiles
4261
4262 =cut
4263
4264 sub rebuild_fuzzyfiles {
4265
4266   use Fcntl qw(:flock);
4267
4268   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4269   mkdir $dir, 0700 unless -d $dir;
4270
4271   foreach my $fuzzy ( @fuzzyfields ) {
4272
4273     open(LOCK,">>$dir/cust_main.$fuzzy")
4274       or die "can't open $dir/cust_main.$fuzzy: $!";
4275     flock(LOCK,LOCK_EX)
4276       or die "can't lock $dir/cust_main.$fuzzy: $!";
4277
4278     open (CACHE,">$dir/cust_main.$fuzzy.tmp")
4279       or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
4280
4281     foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
4282       my $sth = dbh->prepare("SELECT $field FROM cust_main".
4283                              " WHERE $field != '' AND $field IS NOT NULL");
4284       $sth->execute or die $sth->errstr;
4285
4286       while ( my $row = $sth->fetchrow_arrayref ) {
4287         print CACHE $row->[0]. "\n";
4288       }
4289
4290     }
4291
4292     close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
4293
4294     rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
4295     close LOCK;
4296   }
4297
4298 }
4299
4300 =item all_X
4301
4302 =cut
4303
4304 sub all_X {
4305   my( $self, $field ) = @_;
4306   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4307   open(CACHE,"<$dir/cust_main.$field")
4308     or die "can't open $dir/cust_main.$field: $!";
4309   my @array = map { chomp; $_; } <CACHE>;
4310   close CACHE;
4311   \@array;
4312 }
4313
4314 =item append_fuzzyfiles LASTNAME COMPANY
4315
4316 =cut
4317
4318 sub append_fuzzyfiles {
4319   #my( $first, $last, $company ) = @_;
4320
4321   &check_and_rebuild_fuzzyfiles;
4322
4323   use Fcntl qw(:flock);
4324
4325   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4326
4327   foreach my $field (qw( first last company )) {
4328     my $value = shift;
4329
4330     if ( $value ) {
4331
4332       open(CACHE,">>$dir/cust_main.$field")
4333         or die "can't open $dir/cust_main.$field: $!";
4334       flock(CACHE,LOCK_EX)
4335         or die "can't lock $dir/cust_main.$field: $!";
4336
4337       print CACHE "$value\n";
4338
4339       flock(CACHE,LOCK_UN)
4340         or die "can't unlock $dir/cust_main.$field: $!";
4341       close CACHE;
4342     }
4343
4344   }
4345
4346   1;
4347 }
4348
4349 =item batch_import
4350
4351 =cut
4352
4353 sub batch_import {
4354   my $param = shift;
4355   #warn join('-',keys %$param);
4356   my $fh = $param->{filehandle};
4357   my $agentnum = $param->{agentnum};
4358
4359   my $refnum = $param->{refnum};
4360   my $pkgpart = $param->{pkgpart};
4361
4362   #my @fields = @{$param->{fields}};
4363   my $format = $param->{'format'};
4364   my @fields;
4365   my $payby;
4366   if ( $format eq 'simple' ) {
4367     @fields = qw( cust_pkg.setup dayphone first last
4368                   address1 address2 city state zip comments );
4369     $payby = 'BILL';
4370   } elsif ( $format eq 'extended' ) {
4371     @fields = qw( agent_custid refnum
4372                   last first address1 address2 city state zip country
4373                   daytime night
4374                   ship_last ship_first ship_address1 ship_address2
4375                   ship_city ship_state ship_zip ship_country
4376                   payinfo paycvv paydate
4377                   invoicing_list
4378                   cust_pkg.pkgpart
4379                   svc_acct.username svc_acct._password
4380                 );
4381     $payby = 'BILL';
4382   } else {
4383     die "unknown format $format";
4384   }
4385
4386   eval "use Text::CSV_XS;";
4387   die $@ if $@;
4388
4389   my $csv = new Text::CSV_XS;
4390   #warn $csv;
4391   #warn $fh;
4392
4393   my $imported = 0;
4394   #my $columns;
4395
4396   local $SIG{HUP} = 'IGNORE';
4397   local $SIG{INT} = 'IGNORE';
4398   local $SIG{QUIT} = 'IGNORE';
4399   local $SIG{TERM} = 'IGNORE';
4400   local $SIG{TSTP} = 'IGNORE';
4401   local $SIG{PIPE} = 'IGNORE';
4402
4403   my $oldAutoCommit = $FS::UID::AutoCommit;
4404   local $FS::UID::AutoCommit = 0;
4405   my $dbh = dbh;
4406
4407   #while ( $columns = $csv->getline($fh) ) {
4408   my $line;
4409   while ( defined($line=<$fh>) ) {
4410
4411     $csv->parse($line) or do {
4412       $dbh->rollback if $oldAutoCommit;
4413       return "can't parse: ". $csv->error_input();
4414     };
4415
4416     my @columns = $csv->fields();
4417     #warn join('-',@columns);
4418
4419     my %cust_main = (
4420       agentnum => $agentnum,
4421       refnum   => $refnum,
4422       country  => $conf->config('countrydefault') || 'US',
4423       payby    => $payby, #default
4424       paydate  => '12/2037', #default
4425     );
4426     my $billtime = time;
4427     my %cust_pkg = ( pkgpart => $pkgpart );
4428     my %svc_acct = ();
4429     foreach my $field ( @fields ) {
4430
4431       if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|expire|cancel)$/ ) {
4432
4433         #$cust_pkg{$1} = str2time( shift @$columns );
4434         if ( $1 eq 'pkgpart' ) {
4435           $cust_pkg{$1} = shift @columns;
4436         } elsif ( $1 eq 'setup' ) {
4437           $billtime = str2time(shift @columns);
4438         } else {
4439           $cust_pkg{$1} = str2time( shift @columns );
4440         }
4441
4442       } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
4443
4444         $svc_acct{$1} = shift @columns;
4445
4446       } else {
4447
4448         #refnum interception
4449         if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
4450
4451           my $referral = $columns[0];
4452           my %hash = ( 'referral' => $referral,
4453                        'agentnum' => $agentnum,
4454                        'disabled' => '',
4455                      );
4456
4457           my $part_referral = qsearchs('part_referral', \%hash )
4458                               || new FS::part_referral \%hash;
4459
4460           unless ( $part_referral->refnum ) {
4461             my $error = $part_referral->insert;
4462             if ( $error ) {
4463               $dbh->rollback if $oldAutoCommit;
4464               return "can't auto-insert advertising source: $referral: $error";
4465             }
4466           }
4467
4468           $columns[0] = $part_referral->refnum;
4469         }
4470
4471         #$cust_main{$field} = shift @$columns;
4472         $cust_main{$field} = shift @columns;
4473       }
4474     }
4475
4476     $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
4477
4478     my $invoicing_list = $cust_main{'invoicing_list'}
4479                            ? [ delete $cust_main{'invoicing_list'} ]
4480                            : [];
4481
4482     my $cust_main = new FS::cust_main ( \%cust_main );
4483
4484     use Tie::RefHash;
4485     tie my %hash, 'Tie::RefHash'; #this part is important
4486
4487     if ( $cust_pkg{'pkgpart'} ) {
4488       my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
4489
4490       my @svc_acct = ();
4491       if ( $svc_acct{'username'} ) {
4492         my $part_pkg = $cust_pkg->part_pkg;
4493         unless ( $part_pkg ) {
4494           $dbh->rollback if $oldAutoCommit;
4495           return "unknown pkgnum ". $cust_pkg{'pkgpart'};
4496         }
4497         $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
4498         push @svc_acct, new FS::svc_acct ( \%svc_acct )
4499       }
4500
4501       $hash{$cust_pkg} = \@svc_acct;
4502     }
4503
4504     my $error = $cust_main->insert( \%hash, $invoicing_list );
4505
4506     if ( $error ) {
4507       $dbh->rollback if $oldAutoCommit;
4508       return "can't insert customer for $line: $error";
4509     }
4510
4511     if ( $format eq 'simple' ) {
4512
4513       #false laziness w/bill.cgi
4514       $error = $cust_main->bill( 'time' => $billtime );
4515       if ( $error ) {
4516         $dbh->rollback if $oldAutoCommit;
4517         return "can't bill customer for $line: $error";
4518       }
4519
4520       $cust_main->apply_payments;
4521       $cust_main->apply_credits;
4522
4523       $error = $cust_main->collect();
4524       if ( $error ) {
4525         $dbh->rollback if $oldAutoCommit;
4526         return "can't collect customer for $line: $error";
4527       }
4528
4529     }
4530
4531     $imported++;
4532   }
4533
4534   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4535
4536   return "Empty file!" unless $imported;
4537
4538   ''; #no error
4539
4540 }
4541
4542 =item batch_charge
4543
4544 =cut
4545
4546 sub batch_charge {
4547   my $param = shift;
4548   #warn join('-',keys %$param);
4549   my $fh = $param->{filehandle};
4550   my @fields = @{$param->{fields}};
4551
4552   eval "use Text::CSV_XS;";
4553   die $@ if $@;
4554
4555   my $csv = new Text::CSV_XS;
4556   #warn $csv;
4557   #warn $fh;
4558
4559   my $imported = 0;
4560   #my $columns;
4561
4562   local $SIG{HUP} = 'IGNORE';
4563   local $SIG{INT} = 'IGNORE';
4564   local $SIG{QUIT} = 'IGNORE';
4565   local $SIG{TERM} = 'IGNORE';
4566   local $SIG{TSTP} = 'IGNORE';
4567   local $SIG{PIPE} = 'IGNORE';
4568
4569   my $oldAutoCommit = $FS::UID::AutoCommit;
4570   local $FS::UID::AutoCommit = 0;
4571   my $dbh = dbh;
4572
4573   #while ( $columns = $csv->getline($fh) ) {
4574   my $line;
4575   while ( defined($line=<$fh>) ) {
4576
4577     $csv->parse($line) or do {
4578       $dbh->rollback if $oldAutoCommit;
4579       return "can't parse: ". $csv->error_input();
4580     };
4581
4582     my @columns = $csv->fields();
4583     #warn join('-',@columns);
4584
4585     my %row = ();
4586     foreach my $field ( @fields ) {
4587       $row{$field} = shift @columns;
4588     }
4589
4590     my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
4591     unless ( $cust_main ) {
4592       $dbh->rollback if $oldAutoCommit;
4593       return "unknown custnum $row{'custnum'}";
4594     }
4595
4596     if ( $row{'amount'} > 0 ) {
4597       my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4598       if ( $error ) {
4599         $dbh->rollback if $oldAutoCommit;
4600         return $error;
4601       }
4602       $imported++;
4603     } elsif ( $row{'amount'} < 0 ) {
4604       my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4605                                       $row{'pkg'}                         );
4606       if ( $error ) {
4607         $dbh->rollback if $oldAutoCommit;
4608         return $error;
4609       }
4610       $imported++;
4611     } else {
4612       #hmm?
4613     }
4614
4615   }
4616
4617   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4618
4619   return "Empty file!" unless $imported;
4620
4621   ''; #no error
4622
4623 }
4624
4625 =back
4626
4627 =head1 BUGS
4628
4629 The delete method.
4630
4631 The delete method should possibly take an FS::cust_main object reference
4632 instead of a scalar customer number.
4633
4634 Bill and collect options should probably be passed as references instead of a
4635 list.
4636
4637 There should probably be a configuration file with a list of allowed credit
4638 card types.
4639
4640 No multiple currency support (probably a larger project than just this module).
4641
4642 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
4643
4644 Birthdates rely on negative epoch values.
4645
4646 =head1 SEE ALSO
4647
4648 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
4649 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
4650 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
4651
4652 =cut
4653
4654 1;
4655