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 generate_ps do_print );
  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>, I<paydate>
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 I<paydate> specifies the expiration date for a credit card overriding the
2904 value from the customer record or the payment record. Specified as yyyy-mm-dd
2905
2906 Implementation note: If I<amount> is unspecified or equal to the amount of the
2907 orignal payment, first an attempt is made to "void" the transaction via
2908 the gateway (to cancel a not-yet settled transaction) and then if that fails,
2909 the normal attempt is made to "refund" ("credit") the transaction via the
2910 gateway is attempted.
2911
2912 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2913 #I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
2914 #if set, will override the value from the customer record.
2915
2916 #If an I<invnum> is specified, this payment (if successful) is applied to the
2917 #specified invoice.  If you don't specify an I<invnum> you might want to
2918 #call the B<apply_payments> method.
2919
2920 =cut
2921
2922 #some false laziness w/realtime_bop, not enough to make it worth merging
2923 #but some useful small subs should be pulled out
2924 sub realtime_refund_bop {
2925   my( $self, $method, %options ) = @_;
2926   if ( $DEBUG ) {
2927     warn "$me realtime_refund_bop: $method refund\n";
2928     warn "  $_ => $options{$_}\n" foreach keys %options;
2929   }
2930
2931   eval "use Business::OnlinePayment";
2932   die $@ if $@;
2933
2934   ###
2935   # look up the original payment and optionally a gateway for that payment
2936   ###
2937
2938   my $cust_pay = '';
2939   my $amount = $options{'amount'};
2940
2941   my( $processor, $login, $password, @bop_options ) ;
2942   my( $auth, $order_number ) = ( '', '', '' );
2943
2944   if ( $options{'paynum'} ) {
2945
2946     warn "  paynum: $options{paynum}\n" if $DEBUG > 1;
2947     $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
2948       or return "Unknown paynum $options{'paynum'}";
2949     $amount ||= $cust_pay->paid;
2950
2951     $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
2952       or return "Can't parse paybatch for paynum $options{'paynum'}: ".
2953                 $cust_pay->paybatch;
2954     my $gatewaynum = '';
2955     ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
2956
2957     if ( $gatewaynum ) { #gateway for the payment to be refunded
2958
2959       my $payment_gateway =
2960         qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
2961       die "payment gateway $gatewaynum not found"
2962         unless $payment_gateway;
2963
2964       $processor   = $payment_gateway->gateway_module;
2965       $login       = $payment_gateway->gateway_username;
2966       $password    = $payment_gateway->gateway_password;
2967       @bop_options = $payment_gateway->options;
2968
2969     } else { #try the default gateway
2970
2971       my( $conf_processor, $unused_action );
2972       ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
2973         $self->default_payment_gateway($method);
2974
2975       return "processor of payment $options{'paynum'} $processor does not".
2976              " match default processor $conf_processor"
2977         unless $processor eq $conf_processor;
2978
2979     }
2980
2981
2982   } else { # didn't specify a paynum, so look for agent gateway overrides
2983            # like a normal transaction
2984
2985     my $cardtype;
2986     if ( $method eq 'CC' ) {
2987       $cardtype = cardtype($self->payinfo);
2988     } elsif ( $method eq 'ECHECK' ) {
2989       $cardtype = 'ACH';
2990     } else {
2991       $cardtype = $method;
2992     }
2993     my $override =
2994            qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2995                                                cardtype => $cardtype,
2996                                                taxclass => '',              } )
2997         || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2998                                                cardtype => '',
2999                                                taxclass => '',              } );
3000
3001     if ( $override ) { #use a payment gateway override
3002
3003       my $payment_gateway = $override->payment_gateway;
3004
3005       $processor   = $payment_gateway->gateway_module;
3006       $login       = $payment_gateway->gateway_username;
3007       $password    = $payment_gateway->gateway_password;
3008       #$action      = $payment_gateway->gateway_action;
3009       @bop_options = $payment_gateway->options;
3010
3011     } else { #use the standard settings from the config
3012
3013       my $unused_action;
3014       ( $processor, $login, $password, $unused_action, @bop_options ) =
3015         $self->default_payment_gateway($method);
3016
3017     }
3018
3019   }
3020   return "neither amount nor paynum specified" unless $amount;
3021
3022   my %content = (
3023     'type'           => $method,
3024     'login'          => $login,
3025     'password'       => $password,
3026     'order_number'   => $order_number,
3027     'amount'         => $amount,
3028     'referer'        => 'http://cleanwhisker.420.am/',
3029   );
3030   $content{authorization} = $auth
3031     if length($auth); #echeck/ACH transactions have an order # but no auth
3032                       #(at least with authorize.net)
3033
3034   my $disable_void_after;
3035   if ($conf->exists('disable_void_after')
3036       && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3037     $disable_void_after = $1;
3038   }
3039
3040   #first try void if applicable
3041   if ( $cust_pay && $cust_pay->paid == $amount
3042     && (
3043       ( not defined($disable_void_after) )
3044       || ( time < ($cust_pay->_date + $disable_void_after ) )
3045     )
3046   ) {
3047     warn "  attempting void\n" if $DEBUG > 1;
3048     my $void = new Business::OnlinePayment( $processor, @bop_options );
3049     $void->content( 'action' => 'void', %content );
3050     $void->submit();
3051     if ( $void->is_success ) {
3052       my $error = $cust_pay->void($options{'reason'});
3053       if ( $error ) {
3054         # gah, even with transactions.
3055         my $e = 'WARNING: Card/ACH voided but database not updated - '.
3056                 "error voiding payment: $error";
3057         warn $e;
3058         return $e;
3059       }
3060       warn "  void successful\n" if $DEBUG > 1;
3061       return '';
3062     }
3063   }
3064
3065   warn "  void unsuccessful, trying refund\n"
3066     if $DEBUG > 1;
3067
3068   #massage data
3069   my $address = $self->address1;
3070   $address .= ", ". $self->address2 if $self->address2;
3071
3072   my($payname, $payfirst, $paylast);
3073   if ( $self->payname && $method ne 'ECHECK' ) {
3074     $payname = $self->payname;
3075     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3076       or return "Illegal payname $payname";
3077     ($payfirst, $paylast) = ($1, $2);
3078   } else {
3079     $payfirst = $self->getfield('first');
3080     $paylast = $self->getfield('last');
3081     $payname =  "$payfirst $paylast";
3082   }
3083
3084   my @invoicing_list = $self->invoicing_list_emailonly;
3085   if ( $conf->exists('emailinvoiceautoalways')
3086        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3087        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3088     push @invoicing_list, $self->all_emails;
3089   }
3090
3091   my $email = ($conf->exists('business-onlinepayment-email-override'))
3092               ? $conf->config('business-onlinepayment-email-override')
3093               : $invoicing_list[0];
3094
3095   my $payip = exists($options{'payip'})
3096                 ? $options{'payip'}
3097                 : $self->payip;
3098   $content{customer_ip} = $payip
3099     if length($payip);
3100
3101   my $payinfo = '';
3102   if ( $method eq 'CC' ) {
3103
3104     if ( $cust_pay ) {
3105       $content{card_number} = $payinfo = $cust_pay->payinfo;
3106       (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
3107         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
3108         ($content{expiration} = "$2/$1");  # where available
3109     } else {
3110       $content{card_number} = $payinfo = $self->payinfo;
3111       (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
3112         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3113       $content{expiration} = "$2/$1";
3114     }
3115
3116   } elsif ( $method eq 'ECHECK' ) {
3117     ( $content{account_number}, $content{routing_code} ) =
3118       split('@', $payinfo = $self->payinfo);
3119     $content{bank_name} = $self->payname;
3120     $content{account_type} = 'CHECKING';
3121     $content{account_name} = $payname;
3122     $content{customer_org} = $self->company ? 'B' : 'I';
3123     $content{customer_ssn} = $self->ss;
3124   } elsif ( $method eq 'LEC' ) {
3125     $content{phone} = $payinfo = $self->payinfo;
3126   }
3127
3128   #then try refund
3129   my $refund = new Business::OnlinePayment( $processor, @bop_options );
3130   my %sub_content = $refund->content(
3131     'action'         => 'credit',
3132     'customer_id'    => $self->custnum,
3133     'last_name'      => $paylast,
3134     'first_name'     => $payfirst,
3135     'name'           => $payname,
3136     'address'        => $address,
3137     'city'           => $self->city,
3138     'state'          => $self->state,
3139     'zip'            => $self->zip,
3140     'country'        => $self->country,
3141     'email'          => $email,
3142     'phone'          => $self->daytime || $self->night,
3143     %content, #after
3144   );
3145   warn join('', map { "  $_ => $sub_content{$_}\n" } keys %sub_content )
3146     if $DEBUG > 1;
3147   $refund->submit();
3148
3149   return "$processor error: ". $refund->error_message
3150     unless $refund->is_success();
3151
3152   my %method2payby = (
3153     'CC'     => 'CARD',
3154     'ECHECK' => 'CHEK',
3155     'LEC'    => 'LECB',
3156   );
3157
3158   my $paybatch = "$processor:". $refund->authorization;
3159   $paybatch .= ':'. $refund->order_number
3160     if $refund->can('order_number') && $refund->order_number;
3161
3162   while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3163     my @cust_bill_pay = $cust_pay->cust_bill_pay;
3164     last unless @cust_bill_pay;
3165     my $cust_bill_pay = pop @cust_bill_pay;
3166     my $error = $cust_bill_pay->delete;
3167     last if $error;
3168   }
3169
3170   my $cust_refund = new FS::cust_refund ( {
3171     'custnum'  => $self->custnum,
3172     'paynum'   => $options{'paynum'},
3173     'refund'   => $amount,
3174     '_date'    => '',
3175     'payby'    => $method2payby{$method},
3176     'payinfo'  => $payinfo,
3177     'paybatch' => $paybatch,
3178     'reason'   => $options{'reason'} || 'card or ACH refund',
3179   } );
3180   my $error = $cust_refund->insert;
3181   if ( $error ) {
3182     $cust_refund->paynum(''); #try again with no specific paynum
3183     my $error2 = $cust_refund->insert;
3184     if ( $error2 ) {
3185       # gah, even with transactions.
3186       my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3187               "error inserting refund ($processor): $error2".
3188               " (previously tried insert with paynum #$options{'paynum'}" .
3189               ": $error )";
3190       warn $e;
3191       return $e;
3192     }
3193   }
3194
3195   ''; #no error
3196
3197 }
3198
3199 =item batch_card OPTION => VALUE...
3200
3201 Adds a payment for this invoice to the pending credit card batch (see
3202 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
3203 runs the payment using a realtime gateway.
3204
3205 =cut
3206
3207 sub batch_card {
3208   my ($self, %options) = @_;
3209
3210   my $amount;
3211   if (exists($options{amount})) {
3212     $amount = $options{amount};
3213   }else{
3214     $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
3215   }
3216   return '' unless $amount > 0;
3217
3218   my $invnum = delete $options{invnum};
3219   my $payby = $options{invnum} || $self->payby;  #dubious
3220
3221   if ($options{'realtime'}) {
3222     return $self->realtime_bop( FS::payby->payby2bop($self->payby),
3223                                 $amount,
3224                                 %options,
3225                               );
3226   }
3227
3228   my $oldAutoCommit = $FS::UID::AutoCommit;
3229   local $FS::UID::AutoCommit = 0;
3230   my $dbh = dbh;
3231
3232   $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
3233     or return "Cannot lock pay_batch: " . $dbh->errstr;
3234
3235   my %pay_batch = (
3236     'status' => 'O',
3237     'payby'  => FS::payby->payby2payment($payby),
3238   );
3239
3240   my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
3241
3242   unless ( $pay_batch ) {
3243     $pay_batch = new FS::pay_batch \%pay_batch;
3244     my $error = $pay_batch->insert;
3245     if ( $error ) {
3246       $dbh->rollback if $oldAutoCommit;
3247       die "error creating new batch: $error\n";
3248     }
3249   }
3250
3251   my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
3252       'batchnum' => $pay_batch->batchnum,
3253       'custnum'  => $self->custnum,
3254   } );
3255
3256   foreach (qw( address1 address2 city state zip country payby payinfo paydate
3257                payname )) {
3258     $options{$_} = '' unless exists($options{$_});
3259   }
3260
3261   my $cust_pay_batch = new FS::cust_pay_batch ( {
3262     'batchnum' => $pay_batch->batchnum,
3263     'invnum'   => $invnum || 0,                    # is there a better value?
3264                                                    # this field should be
3265                                                    # removed...
3266                                                    # cust_bill_pay_batch now
3267     'custnum'  => $self->custnum,
3268     'last'     => $self->getfield('last'),
3269     'first'    => $self->getfield('first'),
3270     'address1' => $options{address1} || $self->address1,
3271     'address2' => $options{address2} || $self->address2,
3272     'city'     => $options{city}     || $self->city,
3273     'state'    => $options{state}    || $self->state,
3274     'zip'      => $options{zip}      || $self->zip,
3275     'country'  => $options{country}  || $self->country,
3276     'payby'    => $options{payby}    || $self->payby,
3277     'payinfo'  => $options{payinfo}  || $self->payinfo,
3278     'exp'      => $options{paydate}  || $self->paydate,
3279     'payname'  => $options{payname}  || $self->payname,
3280     'amount'   => $amount,                         # consolidating
3281   } );
3282
3283   $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
3284     if $old_cust_pay_batch;
3285
3286   my $error;
3287   if ($old_cust_pay_batch) {
3288     $error = $cust_pay_batch->replace($old_cust_pay_batch)
3289   } else {
3290     $error = $cust_pay_batch->insert;
3291   }
3292
3293   if ( $error ) {
3294     $dbh->rollback if $oldAutoCommit;
3295     die $error;
3296   }
3297
3298   my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
3299   foreach my $cust_bill ($self->open_cust_bill) {
3300     #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
3301     my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
3302       'invnum' => $cust_bill->invnum,
3303       'paybatchnum' => $cust_pay_batch->paybatchnum,
3304       'amount' => $cust_bill->owed,
3305       '_date' => time,
3306     };
3307     if ($unapplied >= $cust_bill_pay_batch->amount){
3308       $unapplied -= $cust_bill_pay_batch->amount;
3309       next;
3310     }else{
3311       $cust_bill_pay_batch->amount(sprintf ( "%.2f",
3312                                    $cust_bill_pay_batch->amount - $unapplied ));      $unapplied = 0;
3313     }
3314     $error = $cust_bill_pay_batch->insert;
3315     if ( $error ) {
3316       $dbh->rollback if $oldAutoCommit;
3317       die $error;
3318     }
3319   }
3320
3321   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3322   '';
3323 }
3324
3325 =item total_owed
3326
3327 Returns the total owed for this customer on all invoices
3328 (see L<FS::cust_bill/owed>).
3329
3330 =cut
3331
3332 sub total_owed {
3333   my $self = shift;
3334   $self->total_owed_date(2145859200); #12/31/2037
3335 }
3336
3337 =item total_owed_date TIME
3338
3339 Returns the total owed for this customer on all invoices with date earlier than
3340 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
3341 see L<Time::Local> and L<Date::Parse> for conversion functions.
3342
3343 =cut
3344
3345 sub total_owed_date {
3346   my $self = shift;
3347   my $time = shift;
3348   my $total_bill = 0;
3349   foreach my $cust_bill (
3350     grep { $_->_date <= $time }
3351       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3352   ) {
3353     $total_bill += $cust_bill->owed;
3354   }
3355   sprintf( "%.2f", $total_bill );
3356 }
3357
3358 =item apply_payments_and_credits
3359
3360 Applies unapplied payments and credits.
3361
3362 In most cases, this new method should be used in place of sequential
3363 apply_payments and apply_credits methods.
3364
3365 =cut
3366
3367 sub apply_payments_and_credits {
3368   my $self = shift;
3369
3370   foreach my $cust_bill ( $self->open_cust_bill ) {
3371     $cust_bill->apply_payments_and_credits;
3372   }
3373
3374 }
3375
3376 =item apply_credits OPTION => VALUE ...
3377
3378 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3379 to outstanding invoice balances in chronological order (or reverse
3380 chronological order if the I<order> option is set to B<newest>) and returns the
3381 value of any remaining unapplied credits available for refund (see
3382 L<FS::cust_refund>).
3383
3384 =cut
3385
3386 sub apply_credits {
3387   my $self = shift;
3388   my %opt = @_;
3389
3390   return 0 unless $self->total_credited;
3391
3392   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3393       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3394
3395   my @invoices = $self->open_cust_bill;
3396   @invoices = sort { $b->_date <=> $a->_date } @invoices
3397     if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3398
3399   my $credit;
3400   foreach my $cust_bill ( @invoices ) {
3401     my $amount;
3402
3403     if ( !defined($credit) || $credit->credited == 0) {
3404       $credit = pop @credits or last;
3405     }
3406
3407     if ($cust_bill->owed >= $credit->credited) {
3408       $amount=$credit->credited;
3409     }else{
3410       $amount=$cust_bill->owed;
3411     }
3412
3413     my $cust_credit_bill = new FS::cust_credit_bill ( {
3414       'crednum' => $credit->crednum,
3415       'invnum'  => $cust_bill->invnum,
3416       'amount'  => $amount,
3417     } );
3418     my $error = $cust_credit_bill->insert;
3419     die $error if $error;
3420
3421     redo if ($cust_bill->owed > 0);
3422
3423   }
3424
3425   return $self->total_credited;
3426 }
3427
3428 =item apply_payments
3429
3430 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3431 to outstanding invoice balances in chronological order.
3432
3433  #and returns the value of any remaining unapplied payments.
3434
3435 =cut
3436
3437 sub apply_payments {
3438   my $self = shift;
3439
3440   #return 0 unless
3441
3442   my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
3443       qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
3444
3445   my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
3446       qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
3447
3448   my $payment;
3449
3450   foreach my $cust_bill ( @invoices ) {
3451     my $amount;
3452
3453     if ( !defined($payment) || $payment->unapplied == 0 ) {
3454       $payment = pop @payments or last;
3455     }
3456
3457     if ( $cust_bill->owed >= $payment->unapplied ) {
3458       $amount = $payment->unapplied;
3459     } else {
3460       $amount = $cust_bill->owed;
3461     }
3462
3463     my $cust_bill_pay = new FS::cust_bill_pay ( {
3464       'paynum' => $payment->paynum,
3465       'invnum' => $cust_bill->invnum,
3466       'amount' => $amount,
3467     } );
3468     my $error = $cust_bill_pay->insert;
3469     die $error if $error;
3470
3471     redo if ( $cust_bill->owed > 0);
3472
3473   }
3474
3475   return $self->total_unapplied_payments;
3476 }
3477
3478 =item total_credited
3479
3480 Returns the total outstanding credit (see L<FS::cust_credit>) for this
3481 customer.  See L<FS::cust_credit/credited>.
3482
3483 =cut
3484
3485 sub total_credited {
3486   my $self = shift;
3487   my $total_credit = 0;
3488   foreach my $cust_credit ( qsearch('cust_credit', {
3489     'custnum' => $self->custnum,
3490   } ) ) {
3491     $total_credit += $cust_credit->credited;
3492   }
3493   sprintf( "%.2f", $total_credit );
3494 }
3495
3496 =item total_unapplied_payments
3497
3498 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
3499 See L<FS::cust_pay/unapplied>.
3500
3501 =cut
3502
3503 sub total_unapplied_payments {
3504   my $self = shift;
3505   my $total_unapplied = 0;
3506   foreach my $cust_pay ( qsearch('cust_pay', {
3507     'custnum' => $self->custnum,
3508   } ) ) {
3509     $total_unapplied += $cust_pay->unapplied;
3510   }
3511   sprintf( "%.2f", $total_unapplied );
3512 }
3513
3514 =item balance
3515
3516 Returns the balance for this customer (total_owed minus total_credited
3517 minus total_unapplied_payments).
3518
3519 =cut
3520
3521 sub balance {
3522   my $self = shift;
3523   sprintf( "%.2f",
3524     $self->total_owed - $self->total_credited - $self->total_unapplied_payments
3525   );
3526 }
3527
3528 =item balance_date TIME
3529
3530 Returns the balance for this customer, only considering invoices with date
3531 earlier than TIME (total_owed_date minus total_credited minus
3532 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
3533 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
3534 functions.
3535
3536 =cut
3537
3538 sub balance_date {
3539   my $self = shift;
3540   my $time = shift;
3541   sprintf( "%.2f",
3542     $self->total_owed_date($time)
3543       - $self->total_credited
3544       - $self->total_unapplied_payments
3545   );
3546 }
3547
3548 =item in_transit_payments
3549
3550 Returns the total of requests for payments for this customer pending in
3551 batches in transit to the bank.  See L<FS::pay_batch> and L<FS::cust_pay_batch>
3552
3553 =cut
3554
3555 sub in_transit_payments {
3556   my $self = shift;
3557   my $in_transit_payments = 0;
3558   foreach my $pay_batch ( qsearch('pay_batch', {
3559     'status' => 'I',
3560   } ) ) {
3561     foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
3562       'batchnum' => $pay_batch->batchnum,
3563       'custnum' => $self->custnum,
3564     } ) ) {
3565       $in_transit_payments += $cust_pay_batch->amount;
3566     }
3567   }
3568   sprintf( "%.2f", $in_transit_payments );
3569 }
3570
3571 =item paydate_monthyear
3572
3573 Returns a two-element list consisting of the month and year of this customer's
3574 paydate (credit card expiration date for CARD customers)
3575
3576 =cut
3577
3578 sub paydate_monthyear {
3579   my $self = shift;
3580   if ( $self->paydate  =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3581     ( $2, $1 );
3582   } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3583     ( $1, $3 );
3584   } else {
3585     ('', '');
3586   }
3587 }
3588
3589 =item invoicing_list [ ARRAYREF ]
3590
3591 If an arguement is given, sets these email addresses as invoice recipients
3592 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
3593 (except as warnings), so use check_invoicing_list first.
3594
3595 Returns a list of email addresses (with svcnum entries expanded).
3596
3597 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
3598 check it without disturbing anything by passing nothing.
3599
3600 This interface may change in the future.
3601
3602 =cut
3603
3604 sub invoicing_list {
3605   my( $self, $arrayref ) = @_;
3606
3607   if ( $arrayref ) {
3608     my @cust_main_invoice;
3609     if ( $self->custnum ) {
3610       @cust_main_invoice =
3611         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3612     } else {
3613       @cust_main_invoice = ();
3614     }
3615     foreach my $cust_main_invoice ( @cust_main_invoice ) {
3616       #warn $cust_main_invoice->destnum;
3617       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3618         #warn $cust_main_invoice->destnum;
3619         my $error = $cust_main_invoice->delete;
3620         warn $error if $error;
3621       }
3622     }
3623     if ( $self->custnum ) {
3624       @cust_main_invoice =
3625         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3626     } else {
3627       @cust_main_invoice = ();
3628     }
3629     my %seen = map { $_->address => 1 } @cust_main_invoice;
3630     foreach my $address ( @{$arrayref} ) {
3631       next if exists $seen{$address} && $seen{$address};
3632       $seen{$address} = 1;
3633       my $cust_main_invoice = new FS::cust_main_invoice ( {
3634         'custnum' => $self->custnum,
3635         'dest'    => $address,
3636       } );
3637       my $error = $cust_main_invoice->insert;
3638       warn $error if $error;
3639     }
3640   }
3641
3642   if ( $self->custnum ) {
3643     map { $_->address }
3644       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3645   } else {
3646     ();
3647   }
3648
3649 }
3650
3651 =item check_invoicing_list ARRAYREF
3652
3653 Checks these arguements as valid input for the invoicing_list method.  If there
3654 is an error, returns the error, otherwise returns false.
3655
3656 =cut
3657
3658 sub check_invoicing_list {
3659   my( $self, $arrayref ) = @_;
3660   foreach my $address ( @{$arrayref} ) {
3661
3662     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3663       return 'Can\'t add FAX invoice destination with a blank FAX number.';
3664     }
3665
3666     my $cust_main_invoice = new FS::cust_main_invoice ( {
3667       'custnum' => $self->custnum,
3668       'dest'    => $address,
3669     } );
3670     my $error = $self->custnum
3671                 ? $cust_main_invoice->check
3672                 : $cust_main_invoice->checkdest
3673     ;
3674     return $error if $error;
3675   }
3676   '';
3677 }
3678
3679 =item set_default_invoicing_list
3680
3681 Sets the invoicing list to all accounts associated with this customer,
3682 overwriting any previous invoicing list.
3683
3684 =cut
3685
3686 sub set_default_invoicing_list {
3687   my $self = shift;
3688   $self->invoicing_list($self->all_emails);
3689 }
3690
3691 =item all_emails
3692
3693 Returns the email addresses of all accounts provisioned for this customer.
3694
3695 =cut
3696
3697 sub all_emails {
3698   my $self = shift;
3699   my %list;
3700   foreach my $cust_pkg ( $self->all_pkgs ) {
3701     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3702     my @svc_acct =
3703       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3704         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3705           @cust_svc;
3706     $list{$_}=1 foreach map { $_->email } @svc_acct;
3707   }
3708   keys %list;
3709 }
3710
3711 =item invoicing_list_addpost
3712
3713 Adds postal invoicing to this customer.  If this customer is already configured
3714 to receive postal invoices, does nothing.
3715
3716 =cut
3717
3718 sub invoicing_list_addpost {
3719   my $self = shift;
3720   return if grep { $_ eq 'POST' } $self->invoicing_list;
3721   my @invoicing_list = $self->invoicing_list;
3722   push @invoicing_list, 'POST';
3723   $self->invoicing_list(\@invoicing_list);
3724 }
3725
3726 =item invoicing_list_emailonly
3727
3728 Returns the list of email invoice recipients (invoicing_list without non-email
3729 destinations such as POST and FAX).
3730
3731 =cut
3732
3733 sub invoicing_list_emailonly {
3734   my $self = shift;
3735   warn "$me invoicing_list_emailonly called"
3736     if $DEBUG;
3737   grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3738 }
3739
3740 =item invoicing_list_emailonly_scalar
3741
3742 Returns the list of email invoice recipients (invoicing_list without non-email
3743 destinations such as POST and FAX) as a comma-separated scalar.
3744
3745 =cut
3746
3747 sub invoicing_list_emailonly_scalar {
3748   my $self = shift;
3749   warn "$me invoicing_list_emailonly_scalar called"
3750     if $DEBUG;
3751   join(', ', $self->invoicing_list_emailonly);
3752 }
3753
3754 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3755
3756 Returns an array of customers referred by this customer (referral_custnum set
3757 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
3758 customers referred by customers referred by this customer and so on, inclusive.
3759 The default behavior is DEPTH 1 (no recursion).
3760
3761 =cut
3762
3763 sub referral_cust_main {
3764   my $self = shift;
3765   my $depth = @_ ? shift : 1;
3766   my $exclude = @_ ? shift : {};
3767
3768   my @cust_main =
3769     map { $exclude->{$_->custnum}++; $_; }
3770       grep { ! $exclude->{ $_->custnum } }
3771         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3772
3773   if ( $depth > 1 ) {
3774     push @cust_main,
3775       map { $_->referral_cust_main($depth-1, $exclude) }
3776         @cust_main;
3777   }
3778
3779   @cust_main;
3780 }
3781
3782 =item referral_cust_main_ncancelled
3783
3784 Same as referral_cust_main, except only returns customers with uncancelled
3785 packages.
3786
3787 =cut
3788
3789 sub referral_cust_main_ncancelled {
3790   my $self = shift;
3791   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3792 }
3793
3794 =item referral_cust_pkg [ DEPTH ]
3795
3796 Like referral_cust_main, except returns a flat list of all unsuspended (and
3797 uncancelled) packages for each customer.  The number of items in this list may
3798 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3799
3800 =cut
3801
3802 sub referral_cust_pkg {
3803   my $self = shift;
3804   my $depth = @_ ? shift : 1;
3805
3806   map { $_->unsuspended_pkgs }
3807     grep { $_->unsuspended_pkgs }
3808       $self->referral_cust_main($depth);
3809 }
3810
3811 =item referring_cust_main
3812
3813 Returns the single cust_main record for the customer who referred this customer
3814 (referral_custnum), or false.
3815
3816 =cut
3817
3818 sub referring_cust_main {
3819   my $self = shift;
3820   return '' unless $self->referral_custnum;
3821   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3822 }
3823
3824 =item credit AMOUNT, REASON
3825
3826 Applies a credit to this customer.  If there is an error, returns the error,
3827 otherwise returns false.
3828
3829 =cut
3830
3831 sub credit {
3832   my( $self, $amount, $reason ) = @_;
3833   my $cust_credit = new FS::cust_credit {
3834     'custnum' => $self->custnum,
3835     'amount'  => $amount,
3836     'reason'  => $reason,
3837   };
3838   $cust_credit->insert;
3839 }
3840
3841 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3842
3843 Creates a one-time charge for this customer.  If there is an error, returns
3844 the error, otherwise returns false.
3845
3846 =cut
3847
3848 sub charge {
3849   my $self = shift;
3850   my ( $amount, $pkg, $comment, $taxclass, $additional );
3851   if ( ref( $_[0] ) ) {
3852     $amount     = $_[0]->{amount};
3853     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3854     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
3855                                            : '$'. sprintf("%.2f",$amount);
3856     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3857     $additional = $_[0]->{additional};
3858   }else{
3859     $amount     = shift;
3860     $pkg        = @_ ? shift : 'One-time charge';
3861     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
3862     $taxclass   = @_ ? shift : '';
3863     $additional = [];
3864   }
3865
3866   local $SIG{HUP} = 'IGNORE';
3867   local $SIG{INT} = 'IGNORE';
3868   local $SIG{QUIT} = 'IGNORE';
3869   local $SIG{TERM} = 'IGNORE';
3870   local $SIG{TSTP} = 'IGNORE';
3871   local $SIG{PIPE} = 'IGNORE';
3872
3873   my $oldAutoCommit = $FS::UID::AutoCommit;
3874   local $FS::UID::AutoCommit = 0;
3875   my $dbh = dbh;
3876
3877   my $part_pkg = new FS::part_pkg ( {
3878     'pkg'      => $pkg,
3879     'comment'  => $comment,
3880     'plan'     => 'flat',
3881     'freq'     => 0,
3882     'disabled' => 'Y',
3883     'taxclass' => $taxclass,
3884   } );
3885
3886   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3887                         ( 0 .. @$additional - 1 )
3888                   ),
3889                   'additional_count' => scalar(@$additional),
3890                   'setup_fee' => $amount,
3891                 );
3892
3893   my $error = $part_pkg->insert( options => \%options );
3894   if ( $error ) {
3895     $dbh->rollback if $oldAutoCommit;
3896     return $error;
3897   }
3898
3899   my $pkgpart = $part_pkg->pkgpart;
3900   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3901   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3902     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3903     $error = $type_pkgs->insert;
3904     if ( $error ) {
3905       $dbh->rollback if $oldAutoCommit;
3906       return $error;
3907     }
3908   }
3909
3910   my $cust_pkg = new FS::cust_pkg ( {
3911     'custnum' => $self->custnum,
3912     'pkgpart' => $pkgpart,
3913   } );
3914
3915   $error = $cust_pkg->insert;
3916   if ( $error ) {
3917     $dbh->rollback if $oldAutoCommit;
3918     return $error;
3919   }
3920
3921   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3922   '';
3923
3924 }
3925
3926 =item cust_bill
3927
3928 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3929
3930 =cut
3931
3932 sub cust_bill {
3933   my $self = shift;
3934   sort { $a->_date <=> $b->_date }
3935     qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3936 }
3937
3938 =item open_cust_bill
3939
3940 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3941 customer.
3942
3943 =cut
3944
3945 sub open_cust_bill {
3946   my $self = shift;
3947   grep { $_->owed > 0 } $self->cust_bill;
3948 }
3949
3950 =item cust_credit
3951
3952 Returns all the credits (see L<FS::cust_credit>) for this customer.
3953
3954 =cut
3955
3956 sub cust_credit {
3957   my $self = shift;
3958   sort { $a->_date <=> $b->_date }
3959     qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3960 }
3961
3962 =item cust_pay
3963
3964 Returns all the payments (see L<FS::cust_pay>) for this customer.
3965
3966 =cut
3967
3968 sub cust_pay {
3969   my $self = shift;
3970   sort { $a->_date <=> $b->_date }
3971     qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3972 }
3973
3974 =item cust_pay_void
3975
3976 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3977
3978 =cut
3979
3980 sub cust_pay_void {
3981   my $self = shift;
3982   sort { $a->_date <=> $b->_date }
3983     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3984 }
3985
3986
3987 =item cust_refund
3988
3989 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3990
3991 =cut
3992
3993 sub cust_refund {
3994   my $self = shift;
3995   sort { $a->_date <=> $b->_date }
3996     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3997 }
3998
3999 =item name
4000
4001 Returns a name string for this customer, either "Company (Last, First)" or
4002 "Last, First".
4003
4004 =cut
4005
4006 sub name {
4007   my $self = shift;
4008   my $name = $self->contact;
4009   $name = $self->company. " ($name)" if $self->company;
4010   $name;
4011 }
4012
4013 =item ship_name
4014
4015 Returns a name string for this (service/shipping) contact, either
4016 "Company (Last, First)" or "Last, First".
4017
4018 =cut
4019
4020 sub ship_name {
4021   my $self = shift;
4022   if ( $self->get('ship_last') ) {
4023     my $name = $self->ship_contact;
4024     $name = $self->ship_company. " ($name)" if $self->ship_company;
4025     $name;
4026   } else {
4027     $self->name;
4028   }
4029 }
4030
4031 =item contact
4032
4033 Returns this customer's full (billing) contact name only, "Last, First"
4034
4035 =cut
4036
4037 sub contact {
4038   my $self = shift;
4039   $self->get('last'). ', '. $self->first;
4040 }
4041
4042 =item ship_contact
4043
4044 Returns this customer's full (shipping) contact name only, "Last, First"
4045
4046 =cut
4047
4048 sub ship_contact {
4049   my $self = shift;
4050   $self->get('ship_last')
4051     ? $self->get('ship_last'). ', '. $self->ship_first
4052     : $self->contact;
4053 }
4054
4055 =item country_full
4056
4057 Returns this customer's full country name
4058
4059 =cut
4060
4061 sub country_full {
4062   my $self = shift;
4063   code2country($self->country);
4064 }
4065
4066 =item cust_status
4067
4068 =item status
4069
4070 Returns a status string for this customer, currently:
4071
4072 =over 4
4073
4074 =item prospect - No packages have ever been ordered
4075
4076 =item active - One or more recurring packages is active
4077
4078 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4079
4080 =item suspended - All non-cancelled recurring packages are suspended
4081
4082 =item cancelled - All recurring packages are cancelled
4083
4084 =back
4085
4086 =cut
4087
4088 sub status { shift->cust_status(@_); }
4089
4090 sub cust_status {
4091   my $self = shift;
4092   for my $status (qw( prospect active inactive suspended cancelled )) {
4093     my $method = $status.'_sql';
4094     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4095     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4096     $sth->execute( ($self->custnum) x $numnum )
4097       or die "Error executing 'SELECT $sql': ". $sth->errstr;
4098     return $status if $sth->fetchrow_arrayref->[0];
4099   }
4100 }
4101
4102 =item ucfirst_cust_status
4103
4104 =item ucfirst_status
4105
4106 Returns the status with the first character capitalized.
4107
4108 =cut
4109
4110 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4111
4112 sub ucfirst_cust_status {
4113   my $self = shift;
4114   ucfirst($self->cust_status);
4115 }
4116
4117 =item statuscolor
4118
4119 Returns a hex triplet color string for this customer's status.
4120
4121 =cut
4122
4123 use vars qw(%statuscolor);
4124 %statuscolor = (
4125   'prospect'  => '7e0079', #'000000', #black?  naw, purple
4126   'active'    => '00CC00', #green
4127   'inactive'  => '0000CC', #blue
4128   'suspended' => 'FF9900', #yellow
4129   'cancelled' => 'FF0000', #red
4130 );
4131
4132 sub statuscolor { shift->cust_statuscolor(@_); }
4133
4134 sub cust_statuscolor {
4135   my $self = shift;
4136   $statuscolor{$self->cust_status};
4137 }
4138
4139 =back
4140
4141 =head1 CLASS METHODS
4142
4143 =over 4
4144
4145 =item prospect_sql
4146
4147 Returns an SQL expression identifying prospective cust_main records (customers
4148 with no packages ever ordered)
4149
4150 =cut
4151
4152 use vars qw($select_count_pkgs);
4153 $select_count_pkgs =
4154   "SELECT COUNT(*) FROM cust_pkg
4155     WHERE cust_pkg.custnum = cust_main.custnum";
4156
4157 sub select_count_pkgs_sql {
4158   $select_count_pkgs;
4159 }
4160
4161 sub prospect_sql { "
4162   0 = ( $select_count_pkgs )
4163 "; }
4164
4165 =item active_sql
4166
4167 Returns an SQL expression identifying active cust_main records (customers with
4168 no active recurring packages, but otherwise unsuspended/uncancelled).
4169
4170 =cut
4171
4172 sub active_sql { "
4173   0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
4174       )
4175 "; }
4176
4177 =item inactive_sql
4178
4179 Returns an SQL expression identifying inactive cust_main records (customers with
4180 active recurring packages).
4181
4182 =cut
4183
4184 sub inactive_sql { "
4185   0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4186   AND
4187   0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
4188 "; }
4189
4190 =item susp_sql
4191 =item suspended_sql
4192
4193 Returns an SQL expression identifying suspended cust_main records.
4194
4195 =cut
4196
4197
4198 sub suspended_sql { susp_sql(@_); }
4199 sub susp_sql { "
4200     0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
4201     AND
4202     0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4203 "; }
4204
4205 =item cancel_sql
4206 =item cancelled_sql
4207
4208 Returns an SQL expression identifying cancelled cust_main records.
4209
4210 =cut
4211
4212 sub cancelled_sql { cancel_sql(@_); }
4213 sub cancel_sql {
4214
4215   my $recurring_sql = FS::cust_pkg->recurring_sql;
4216   #my $recurring_sql = "
4217   #  '0' != ( select freq from part_pkg
4218   #             where cust_pkg.pkgpart = part_pkg.pkgpart )
4219   #";
4220
4221   "
4222     0 < ( $select_count_pkgs )
4223     AND 0 = ( $select_count_pkgs AND $recurring_sql
4224                   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4225             )
4226   ";
4227 }
4228
4229 =item uncancel_sql
4230 =item uncancelled_sql
4231
4232 Returns an SQL expression identifying un-cancelled cust_main records.
4233
4234 =cut
4235
4236 sub uncancelled_sql { uncancel_sql(@_); }
4237 sub uncancel_sql { "
4238   ( 0 < ( $select_count_pkgs
4239                    AND ( cust_pkg.cancel IS NULL
4240                          OR cust_pkg.cancel = 0
4241                        )
4242         )
4243     OR 0 = ( $select_count_pkgs )
4244   )
4245 "; }
4246
4247 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
4248
4249 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
4250 records.  Currently, I<first>, I<last> and/or I<company> may be specified (the
4251 appropriate ship_ field is also searched).
4252
4253 Additional options are the same as FS::Record::qsearch
4254
4255 =cut
4256
4257 sub fuzzy_search {
4258   my( $self, $fuzzy, $hash, @opt) = @_;
4259   #$self
4260   $hash ||= {};
4261   my @cust_main = ();
4262
4263   check_and_rebuild_fuzzyfiles();
4264   foreach my $field ( keys %$fuzzy ) {
4265
4266     my $all = $self->all_X($field);
4267     next unless scalar(@$all);
4268
4269     my %match = ();
4270     $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
4271
4272     my @fcust = ();
4273     foreach ( keys %match ) {
4274       push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
4275       push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
4276     }
4277     my %fsaw = ();
4278     push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
4279   }
4280
4281   # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
4282   my %saw = ();
4283   @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
4284
4285   @cust_main;
4286
4287 }
4288
4289 =item masked FIELD
4290
4291 Returns a masked version of the named field
4292
4293 =cut
4294
4295 sub masked {
4296 my ($self,$field) = @_;
4297
4298 # Show last four
4299
4300 'x'x(length($self->getfield($field))-4).
4301   substr($self->getfield($field), (length($self->getfield($field))-4));
4302
4303 }
4304
4305 =back
4306
4307 =head1 SUBROUTINES
4308
4309 =over 4
4310
4311 =item smart_search OPTION => VALUE ...
4312
4313 Accepts the following options: I<search>, the string to search for.  The string
4314 will be searched for as a customer number, phone number, name or company name,
4315 as an exact, or, in some cases, a substring or fuzzy match (see the source code
4316 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
4317 skip fuzzy matching when an exact match is found.
4318
4319 Any additional options are treated as an additional qualifier on the search
4320 (i.e. I<agentnum>).
4321
4322 Returns a (possibly empty) array of FS::cust_main objects.
4323
4324 =cut
4325
4326 sub smart_search {
4327   my %options = @_;
4328
4329   #here is the agent virtualization
4330   my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
4331
4332   my @cust_main = ();
4333
4334   my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
4335   my $search = delete $options{'search'};
4336   ( my $alphanum_search = $search ) =~ s/\W//g;
4337
4338   if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
4339
4340     #false laziness w/Record::ut_phone
4341     my $phonen = "$1-$2-$3";
4342     $phonen .= " x$4" if $4;
4343
4344     push @cust_main, qsearch( {
4345       'table'   => 'cust_main',
4346       'hashref' => { %options },
4347       'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4348                      ' ( '.
4349                          join(' OR ', map "$_ = '$phonen'",
4350                                           qw( daytime night fax
4351                                               ship_daytime ship_night ship_fax )
4352                              ).
4353                      ' ) '.
4354                      " AND $agentnums_sql", #agent virtualization
4355     } );
4356
4357     unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
4358       #try looking for matches with extensions unless one was specified
4359
4360       push @cust_main, qsearch( {
4361         'table'   => 'cust_main',
4362         'hashref' => { %options },
4363         'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4364                        ' ( '.
4365                            join(' OR ', map "$_ LIKE '$phonen\%'",
4366                                             qw( daytime night
4367                                                 ship_daytime ship_night )
4368                                ).
4369                        ' ) '.
4370                        " AND $agentnums_sql", #agent virtualization
4371       } );
4372
4373     }
4374
4375   } elsif ( $search =~ /^\s*(\d+)\s*$/ ) { # customer # search
4376
4377     push @cust_main, qsearch( {
4378       'table'     => 'cust_main',
4379       'hashref'   => { 'custnum' => $1, %options },
4380       'extra_sql' => " AND $agentnums_sql", #agent virtualization
4381     } );
4382
4383   } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
4384
4385     my($company, $last, $first) = ( $1, $2, $3 );
4386
4387     # "Company (Last, First)"
4388     #this is probably something a browser remembered,
4389     #so just do an exact search
4390
4391     foreach my $prefix ( '', 'ship_' ) {
4392       push @cust_main, qsearch( {
4393         'table'     => 'cust_main',
4394         'hashref'   => { $prefix.'first'   => $first,
4395                          $prefix.'last'    => $last,
4396                          $prefix.'company' => $company,
4397                          %options,
4398                        },
4399         'extra_sql' => " AND $agentnums_sql",
4400       } );
4401     }
4402
4403   } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
4404                                               # try (ship_){last,company}
4405
4406     my $value = lc($1);
4407
4408     # # remove "(Last, First)" in "Company (Last, First)", otherwise the
4409     # # full strings the browser remembers won't work
4410     # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
4411
4412     use Lingua::EN::NameParse;
4413     my $NameParse = new Lingua::EN::NameParse(
4414              auto_clean     => 1,
4415              allow_reversed => 1,
4416     );
4417
4418     my($last, $first) = ( '', '' );
4419     #maybe disable this too and just rely on NameParse?
4420     if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
4421
4422       ($last, $first) = ( $1, $2 );
4423
4424     #} elsif  ( $value =~ /^(.+)\s+(.+)$/ ) {
4425     } elsif ( ! $NameParse->parse($value) ) {
4426
4427       my %name = $NameParse->components;
4428       $first = $name{'given_name_1'};
4429       $last  = $name{'surname_1'};
4430
4431     }
4432
4433     if ( $first && $last ) {
4434
4435       my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
4436
4437       #exact
4438       my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4439       $sql .= "
4440         (     ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
4441            OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
4442         )";
4443
4444       push @cust_main, qsearch( {
4445         'table'     => 'cust_main',
4446         'hashref'   => \%options,
4447         'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4448       } );
4449
4450       # or it just be something that was typed in... (try that in a sec)
4451
4452     }
4453
4454     my $q_value = dbh->quote($value);
4455
4456     #exact
4457     my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4458     $sql .= " (    LOWER(last)         = $q_value
4459                 OR LOWER(company)      = $q_value
4460                 OR LOWER(ship_last)    = $q_value
4461                 OR LOWER(ship_company) = $q_value
4462               )";
4463
4464     push @cust_main, qsearch( {
4465       'table'     => 'cust_main',
4466       'hashref'   => \%options,
4467       'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4468     } );
4469
4470     #always do substring & fuzzy,
4471     #getting complains searches are not returning enough
4472     unless ( @cust_main && $skip_fuzzy ) {  #no exact match, trying substring/fuzzy
4473
4474       #still some false laziness w/ search/cust_main.cgi
4475
4476       #substring
4477
4478       my @hashrefs = (
4479         { 'company'      => { op=>'ILIKE', value=>"%$value%" }, },
4480         { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
4481       );
4482
4483       if ( $first && $last ) {
4484
4485         push @hashrefs,
4486           { 'first'        => { op=>'ILIKE', value=>"%$first%" },
4487             'last'         => { op=>'ILIKE', value=>"%$last%" },
4488           },
4489           { 'ship_first'   => { op=>'ILIKE', value=>"%$first%" },
4490             'ship_last'    => { op=>'ILIKE', value=>"%$last%" },
4491           },
4492         ;
4493
4494       } else {
4495
4496         push @hashrefs,
4497           { 'last'         => { op=>'ILIKE', value=>"%$value%" }, },
4498           { 'ship_last'    => { op=>'ILIKE', value=>"%$value%" }, },
4499         ;
4500       }
4501
4502       foreach my $hashref ( @hashrefs ) {
4503
4504         push @cust_main, qsearch( {
4505           'table'     => 'cust_main',
4506           'hashref'   => { %$hashref,
4507                            %options,
4508                          },
4509           'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
4510         } );
4511
4512       }
4513
4514       #fuzzy
4515       my @fuzopts = (
4516         \%options,                #hashref
4517         '',                       #select
4518         " AND $agentnums_sql",    #extra_sql  #agent virtualization
4519       );
4520
4521       if ( $first && $last ) {
4522         push @cust_main, FS::cust_main->fuzzy_search(
4523           { 'last'   => $last,    #fuzzy hashref
4524             'first'  => $first }, #
4525           @fuzopts
4526         );
4527       }
4528       foreach my $field ( 'last', 'company' ) {
4529         push @cust_main,
4530           FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
4531       }
4532
4533     }
4534
4535     #eliminate duplicates
4536     my %saw = ();
4537     @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
4538
4539   }
4540
4541   @cust_main;
4542
4543 }
4544
4545 =item check_and_rebuild_fuzzyfiles
4546
4547 =cut
4548
4549 use vars qw(@fuzzyfields);
4550 @fuzzyfields = ( 'last', 'first', 'company' );
4551
4552 sub check_and_rebuild_fuzzyfiles {
4553   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4554   rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
4555 }
4556
4557 =item rebuild_fuzzyfiles
4558
4559 =cut
4560
4561 sub rebuild_fuzzyfiles {
4562
4563   use Fcntl qw(:flock);
4564
4565   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4566   mkdir $dir, 0700 unless -d $dir;
4567
4568   foreach my $fuzzy ( @fuzzyfields ) {
4569
4570     open(LOCK,">>$dir/cust_main.$fuzzy")
4571       or die "can't open $dir/cust_main.$fuzzy: $!";
4572     flock(LOCK,LOCK_EX)
4573       or die "can't lock $dir/cust_main.$fuzzy: $!";
4574
4575     open (CACHE,">$dir/cust_main.$fuzzy.tmp")
4576       or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
4577
4578     foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
4579       my $sth = dbh->prepare("SELECT $field FROM cust_main".
4580                              " WHERE $field != '' AND $field IS NOT NULL");
4581       $sth->execute or die $sth->errstr;
4582
4583       while ( my $row = $sth->fetchrow_arrayref ) {
4584         print CACHE $row->[0]. "\n";
4585       }
4586
4587     }
4588
4589     close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
4590
4591     rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
4592     close LOCK;
4593   }
4594
4595 }
4596
4597 =item all_X
4598
4599 =cut
4600
4601 sub all_X {
4602   my( $self, $field ) = @_;
4603   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4604   open(CACHE,"<$dir/cust_main.$field")
4605     or die "can't open $dir/cust_main.$field: $!";
4606   my @array = map { chomp; $_; } <CACHE>;
4607   close CACHE;
4608   \@array;
4609 }
4610
4611 =item append_fuzzyfiles LASTNAME COMPANY
4612
4613 =cut
4614
4615 sub append_fuzzyfiles {
4616   #my( $first, $last, $company ) = @_;
4617
4618   &check_and_rebuild_fuzzyfiles;
4619
4620   use Fcntl qw(:flock);
4621
4622   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4623
4624   foreach my $field (qw( first last company )) {
4625     my $value = shift;
4626
4627     if ( $value ) {
4628
4629       open(CACHE,">>$dir/cust_main.$field")
4630         or die "can't open $dir/cust_main.$field: $!";
4631       flock(CACHE,LOCK_EX)
4632         or die "can't lock $dir/cust_main.$field: $!";
4633
4634       print CACHE "$value\n";
4635
4636       flock(CACHE,LOCK_UN)
4637         or die "can't unlock $dir/cust_main.$field: $!";
4638       close CACHE;
4639     }
4640
4641   }
4642
4643   1;
4644 }
4645
4646 =item batch_import
4647
4648 =cut
4649
4650 sub batch_import {
4651   my $param = shift;
4652   #warn join('-',keys %$param);
4653   my $fh = $param->{filehandle};
4654   my $agentnum = $param->{agentnum};
4655
4656   my $refnum = $param->{refnum};
4657   my $pkgpart = $param->{pkgpart};
4658
4659   #my @fields = @{$param->{fields}};
4660   my $format = $param->{'format'};
4661   my @fields;
4662   my $payby;
4663   if ( $format eq 'simple' ) {
4664     @fields = qw( cust_pkg.setup dayphone first last
4665                   address1 address2 city state zip comments );
4666     $payby = 'BILL';
4667   } elsif ( $format eq 'extended' ) {
4668     @fields = qw( agent_custid refnum
4669                   last first address1 address2 city state zip country
4670                   daytime night
4671                   ship_last ship_first ship_address1 ship_address2
4672                   ship_city ship_state ship_zip ship_country
4673                   payinfo paycvv paydate
4674                   invoicing_list
4675                   cust_pkg.pkgpart
4676                   svc_acct.username svc_acct._password
4677                 );
4678     $payby = 'BILL';
4679   } else {
4680     die "unknown format $format";
4681   }
4682
4683   eval "use Text::CSV_XS;";
4684   die $@ if $@;
4685
4686   my $csv = new Text::CSV_XS;
4687   #warn $csv;
4688   #warn $fh;
4689
4690   my $imported = 0;
4691   #my $columns;
4692
4693   local $SIG{HUP} = 'IGNORE';
4694   local $SIG{INT} = 'IGNORE';
4695   local $SIG{QUIT} = 'IGNORE';
4696   local $SIG{TERM} = 'IGNORE';
4697   local $SIG{TSTP} = 'IGNORE';
4698   local $SIG{PIPE} = 'IGNORE';
4699
4700   my $oldAutoCommit = $FS::UID::AutoCommit;
4701   local $FS::UID::AutoCommit = 0;
4702   my $dbh = dbh;
4703
4704   #while ( $columns = $csv->getline($fh) ) {
4705   my $line;
4706   while ( defined($line=<$fh>) ) {
4707
4708     $csv->parse($line) or do {
4709       $dbh->rollback if $oldAutoCommit;
4710       return "can't parse: ". $csv->error_input();
4711     };
4712
4713     my @columns = $csv->fields();
4714     #warn join('-',@columns);
4715
4716     my %cust_main = (
4717       agentnum => $agentnum,
4718       refnum   => $refnum,
4719       country  => $conf->config('countrydefault') || 'US',
4720       payby    => $payby, #default
4721       paydate  => '12/2037', #default
4722     );
4723     my $billtime = time;
4724     my %cust_pkg = ( pkgpart => $pkgpart );
4725     my %svc_acct = ();
4726     foreach my $field ( @fields ) {
4727
4728       if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|expire|cancel)$/ ) {
4729
4730         #$cust_pkg{$1} = str2time( shift @$columns );
4731         if ( $1 eq 'pkgpart' ) {
4732           $cust_pkg{$1} = shift @columns;
4733         } elsif ( $1 eq 'setup' ) {
4734           $billtime = str2time(shift @columns);
4735         } else {
4736           $cust_pkg{$1} = str2time( shift @columns );
4737         }
4738
4739       } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
4740
4741         $svc_acct{$1} = shift @columns;
4742
4743       } else {
4744
4745         #refnum interception
4746         if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
4747
4748           my $referral = $columns[0];
4749           my %hash = ( 'referral' => $referral,
4750                        'agentnum' => $agentnum,
4751                        'disabled' => '',
4752                      );
4753
4754           my $part_referral = qsearchs('part_referral', \%hash )
4755                               || new FS::part_referral \%hash;
4756
4757           unless ( $part_referral->refnum ) {
4758             my $error = $part_referral->insert;
4759             if ( $error ) {
4760               $dbh->rollback if $oldAutoCommit;
4761               return "can't auto-insert advertising source: $referral: $error";
4762             }
4763           }
4764
4765           $columns[0] = $part_referral->refnum;
4766         }
4767
4768         #$cust_main{$field} = shift @$columns;
4769         $cust_main{$field} = shift @columns;
4770       }
4771     }
4772
4773     $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
4774
4775     my $invoicing_list = $cust_main{'invoicing_list'}
4776                            ? [ delete $cust_main{'invoicing_list'} ]
4777                            : [];
4778
4779     my $cust_main = new FS::cust_main ( \%cust_main );
4780
4781     use Tie::RefHash;
4782     tie my %hash, 'Tie::RefHash'; #this part is important
4783
4784     if ( $cust_pkg{'pkgpart'} ) {
4785       my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
4786
4787       my @svc_acct = ();
4788       if ( $svc_acct{'username'} ) {
4789         my $part_pkg = $cust_pkg->part_pkg;
4790         unless ( $part_pkg ) {
4791           $dbh->rollback if $oldAutoCommit;
4792           return "unknown pkgnum ". $cust_pkg{'pkgpart'};
4793         }
4794         $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
4795         push @svc_acct, new FS::svc_acct ( \%svc_acct )
4796       }
4797
4798       $hash{$cust_pkg} = \@svc_acct;
4799     }
4800
4801     my $error = $cust_main->insert( \%hash, $invoicing_list );
4802
4803     if ( $error ) {
4804       $dbh->rollback if $oldAutoCommit;
4805       return "can't insert customer for $line: $error";
4806     }
4807
4808     if ( $format eq 'simple' ) {
4809
4810       #false laziness w/bill.cgi
4811       $error = $cust_main->bill( 'time' => $billtime );
4812       if ( $error ) {
4813         $dbh->rollback if $oldAutoCommit;
4814         return "can't bill customer for $line: $error";
4815       }
4816
4817       $cust_main->apply_payments_and_credits;
4818
4819       $error = $cust_main->collect();
4820       if ( $error ) {
4821         $dbh->rollback if $oldAutoCommit;
4822         return "can't collect customer for $line: $error";
4823       }
4824
4825     }
4826
4827     $imported++;
4828   }
4829
4830   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4831
4832   return "Empty file!" unless $imported;
4833
4834   ''; #no error
4835
4836 }
4837
4838 =item batch_charge
4839
4840 =cut
4841
4842 sub batch_charge {
4843   my $param = shift;
4844   #warn join('-',keys %$param);
4845   my $fh = $param->{filehandle};
4846   my @fields = @{$param->{fields}};
4847
4848   eval "use Text::CSV_XS;";
4849   die $@ if $@;
4850
4851   my $csv = new Text::CSV_XS;
4852   #warn $csv;
4853   #warn $fh;
4854
4855   my $imported = 0;
4856   #my $columns;
4857
4858   local $SIG{HUP} = 'IGNORE';
4859   local $SIG{INT} = 'IGNORE';
4860   local $SIG{QUIT} = 'IGNORE';
4861   local $SIG{TERM} = 'IGNORE';
4862   local $SIG{TSTP} = 'IGNORE';
4863   local $SIG{PIPE} = 'IGNORE';
4864
4865   my $oldAutoCommit = $FS::UID::AutoCommit;
4866   local $FS::UID::AutoCommit = 0;
4867   my $dbh = dbh;
4868
4869   #while ( $columns = $csv->getline($fh) ) {
4870   my $line;
4871   while ( defined($line=<$fh>) ) {
4872
4873     $csv->parse($line) or do {
4874       $dbh->rollback if $oldAutoCommit;
4875       return "can't parse: ". $csv->error_input();
4876     };
4877
4878     my @columns = $csv->fields();
4879     #warn join('-',@columns);
4880
4881     my %row = ();
4882     foreach my $field ( @fields ) {
4883       $row{$field} = shift @columns;
4884     }
4885
4886     my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
4887     unless ( $cust_main ) {
4888       $dbh->rollback if $oldAutoCommit;
4889       return "unknown custnum $row{'custnum'}";
4890     }
4891
4892     if ( $row{'amount'} > 0 ) {
4893       my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4894       if ( $error ) {
4895         $dbh->rollback if $oldAutoCommit;
4896         return $error;
4897       }
4898       $imported++;
4899     } elsif ( $row{'amount'} < 0 ) {
4900       my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4901                                       $row{'pkg'}                         );
4902       if ( $error ) {
4903         $dbh->rollback if $oldAutoCommit;
4904         return $error;
4905       }
4906       $imported++;
4907     } else {
4908       #hmm?
4909     }
4910
4911   }
4912
4913   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4914
4915   return "Empty file!" unless $imported;
4916
4917   ''; #no error
4918
4919 }
4920
4921 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4922
4923 Sends a templated email notification to the customer (see L<Text::Template>).
4924
4925 OPTIONS is a hash and may include
4926
4927 I<from> - the email sender (default is invoice_from)
4928
4929 I<to> - comma-separated scalar or arrayref of recipients
4930    (default is invoicing_list)
4931
4932 I<subject> - The subject line of the sent email notification
4933    (default is "Notice from company_name")
4934
4935 I<extra_fields> - a hashref of name/value pairs which will be substituted
4936    into the template
4937
4938 The following variables are vavailable in the template.
4939
4940 I<$first> - the customer first name
4941 I<$last> - the customer last name
4942 I<$company> - the customer company
4943 I<$payby> - a description of the method of payment for the customer
4944             # would be nice to use FS::payby::shortname
4945 I<$payinfo> - the account information used to collect for this customer
4946 I<$expdate> - the expiration of the customer payment in seconds from epoch
4947
4948 =cut
4949
4950 sub notify {
4951   my ($customer, $template, %options) = @_;
4952
4953   return unless $conf->exists($template);
4954
4955   my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
4956   $from = $options{from} if exists($options{from});
4957
4958   my $to = join(',', $customer->invoicing_list_emailonly);
4959   $to = $options{to} if exists($options{to});
4960
4961   my $subject = "Notice from " . $conf->config('company_name')
4962     if $conf->exists('company_name');
4963   $subject = $options{subject} if exists($options{subject});
4964
4965   my $notify_template = new Text::Template (TYPE => 'ARRAY',
4966                                             SOURCE => [ map "$_\n",
4967                                               $conf->config($template)]
4968                                            )
4969     or die "can't create new Text::Template object: Text::Template::ERROR";
4970   $notify_template->compile()
4971     or die "can't compile template: Text::Template::ERROR";
4972
4973   my $paydate = $customer->paydate;
4974   $FS::notify_template::_template::first = $customer->first;
4975   $FS::notify_template::_template::last = $customer->last;
4976   $FS::notify_template::_template::company = $customer->company;
4977   $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
4978   my $payby = $customer->payby;
4979   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4980   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4981
4982   #credit cards expire at the end of the month/year of their exp date
4983   if ($payby eq 'CARD' || $payby eq 'DCRD') {
4984     $FS::notify_template::_template::payby = 'credit card';
4985     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4986     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4987     $expire_time--;
4988   }elsif ($payby eq 'COMP') {
4989     $FS::notify_template::_template::payby = 'complimentary account';
4990   }else{
4991     $FS::notify_template::_template::payby = 'current method';
4992   }
4993   $FS::notify_template::_template::expdate = $expire_time;
4994
4995   for (keys %{$options{extra_fields}}){
4996     no strict "refs";
4997     ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4998   }
4999
5000   send_email(from => $from,
5001              to => $to,
5002              subject => $subject,
5003              body => $notify_template->fill_in( PACKAGE =>
5004                                                 'FS::notify_template::_template'                                              ),
5005             );
5006
5007 }
5008
5009 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5010
5011 Generates a templated notification to the customer (see L<Text::Template>).
5012
5013 OPTIONS is a hash and may include
5014
5015 I<extra_fields> - a hashref of name/value pairs which will be substituted
5016    into the template.  These values may override values mentioned below
5017    and those from the customer record.
5018
5019 The following variables are available in the template instead of or in addition
5020 to the fields of the customer record.
5021
5022 I<$payby> - a description of the method of payment for the customer
5023             # would be nice to use FS::payby::shortname
5024 I<$payinfo> - the masked account information used to collect for this customer
5025 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5026 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress
5027
5028 =cut
5029
5030 sub generate_letter {
5031   my ($self, $template, %options) = @_;
5032
5033   return unless $conf->exists($template);
5034
5035   my $letter_template = new Text::Template
5036                         ( TYPE       => 'ARRAY',
5037                           SOURCE     => [ map "$_\n", $conf->config($template)],
5038                           DELIMITERS => [ '[@--', '--@]' ],
5039                         )
5040     or die "can't create new Text::Template object: Text::Template::ERROR";
5041
5042   $letter_template->compile()
5043     or die "can't compile template: Text::Template::ERROR";
5044
5045   my %letter_data = map { $_ => $self->$_ } $self->fields;
5046   $letter_data{payinfo} = $self->mask_payinfo;
5047
5048   my $paydate = $self->paydate;
5049   my $payby = $self->payby;
5050   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5051   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5052
5053   #credit cards expire at the end of the month/year of their exp date
5054   if ($payby eq 'CARD' || $payby eq 'DCRD') {
5055     $letter_data{payby} = 'credit card';
5056     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5057     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5058     $expire_time--;
5059   }elsif ($payby eq 'COMP') {
5060     $letter_data{payby} = 'complimentary account';
5061   }else{
5062     $letter_data{payby} = 'current method';
5063   }
5064   $letter_data{expdate} = $expire_time;
5065
5066   for (keys %{$options{extra_fields}}){
5067     $letter_data{$_} = $options{extra_fields}->{$_};
5068   }
5069
5070   unless(exists($letter_data{returnaddress})){
5071     my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5072                                                   $self->_agent_template)
5073                      );
5074
5075     $letter_data{returnaddress} = length($retadd) ? $retadd : '~';
5076   }
5077
5078   $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5079
5080   my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
5081   my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5082                            DIR      => $dir,
5083                            SUFFIX   => '.tex',
5084                            UNLINK   => 0,
5085                          ) or die "can't open temp file: $!\n";
5086
5087   $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5088   close $fh;
5089   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5090   return $1;
5091 }
5092
5093 =item print_ps TEMPLATE
5094
5095 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5096
5097 =cut
5098
5099 sub print_ps {
5100   my $self = shift;
5101   my $file = $self->generate_letter(@_);
5102   FS::Misc::generate_ps($file);
5103 }
5104
5105 =item print TEMPLATE
5106
5107 Prints the filled in template.
5108
5109 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5110
5111 =cut
5112
5113 sub queueable_print {
5114   my %opt = @_;
5115
5116   my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5117     or die "invalid customer number: " . $opt{custvnum};
5118
5119   my $error = $self->print( $opt{template} );
5120   die $error if $error;
5121 }
5122
5123 sub print {
5124   my ($self, $template) = (shift, shift);
5125   do_print [ $self->print_ps($template) ];
5126 }
5127
5128 sub agent_template {
5129   my $self = shift;
5130   $self->_agent_plandata('agent_templatename');
5131 }
5132
5133 sub agent_invoice_from {
5134   my $self = shift;
5135   $self->_agent_plandata('agent_invoice_from');
5136 }
5137
5138 sub _agent_plandata {
5139   my( $self, $option ) = @_;
5140
5141   my $part_bill_event = qsearchs( 'part_bill_event',
5142     {
5143       'payby'     => $self->payby,
5144       'plan'      => 'send_agent',
5145       'plandata'  => { 'op'    => '~',
5146                        'value' => "(^|\n)agentnum ".
5147                                    '([0-9]*, )*'.
5148                                   $self->agentnum.
5149                                    '(, [0-9]*)*'.
5150                                   "(\n|\$)",
5151                      },
5152     },
5153     '',
5154     'ORDER BY seconds LIMIT 1'
5155   );
5156
5157   return '' unless $part_bill_event;
5158
5159   if ( $part_bill_event->plandata =~ /^$option (.*)$/m ) {
5160     return $1;
5161   } else {
5162     warn "can't parse part_bill_event eventpart#". $part_bill_event->eventpart.
5163          " plandata for $option";
5164     return '';
5165   }
5166
5167 }
5168
5169 =back
5170
5171 =head1 BUGS
5172
5173 The delete method.
5174
5175 The delete method should possibly take an FS::cust_main object reference
5176 instead of a scalar customer number.
5177
5178 Bill and collect options should probably be passed as references instead of a
5179 list.
5180
5181 There should probably be a configuration file with a list of allowed credit
5182 card types.
5183
5184 No multiple currency support (probably a larger project than just this module).
5185
5186 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5187
5188 Birthdates rely on negative epoch values.
5189
5190 The payby for card/check batches is broken.  With mixed batching, bad
5191 things will happen.
5192
5193 =head1 SEE ALSO
5194
5195 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5196 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5197 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
5198
5199 =cut
5200
5201 1;
5202