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