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