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