FS/FS/cust_main.pm

   1 package FS::cust_main;
   2
   3 require 5.006;
   4 use strict;
   5 use vars qw( @ISA @EXPORT_OK $DEBUG $me $conf @encrypted_fields
   6              $import $skip_fuzzyfiles $ignore_expired_card @paytypes);
   7 use vars qw( $realtime_bop_decline_quiet ); #ugh
   8 use Safe;
   9 use Carp;
  10 use Exporter;
  11 use Time::Local qw(timelocal_nocheck);
  12 use Data::Dumper;
  13 use Tie::IxHash;
  14 use Digest::MD5 qw(md5_base64);
  15 use Date::Format;
  16 use Date::Parse;
  17 #use Date::Manip;
  18 use String::Approx qw(amatch);
  19 use Business::CreditCard 0.28;
  20 use Locale::Country;
  21 use Data::Dumper;
  22 use FS::UID qw( getotaker dbh driver_name );
  23 use FS::Record qw( qsearchs qsearch dbdef );
  24 use FS::Misc qw( send_email generate_ps do_print );
  25 use FS::Msgcat qw(gettext);
  26 use FS::cust_pkg;
  27 use FS::cust_svc;
  28 use FS::cust_bill;
  29 use FS::cust_bill_pkg;
  30 use FS::cust_pay;
  31 use FS::cust_pay_void;
  32 use FS::cust_pay_batch;
  33 use FS::cust_credit;
  34 use FS::cust_refund;
  35 use FS::part_referral;
  36 use FS::cust_main_county;
  37 use FS::agent;
  38 use FS::cust_main_invoice;
  39 use FS::cust_credit_bill;
  40 use FS::cust_bill_pay;
  41 use FS::prepay_credit;
  42 use FS::queue;
  43 use FS::part_pkg;
  44 use FS::part_event;
  45 use FS::part_event_condition;
  46 #use FS::cust_event;
  47 use FS::cust_tax_exempt;
  48 use FS::cust_tax_exempt_pkg;
  49 use FS::type_pkgs;
  50 use FS::payment_gateway;
  51 use FS::agent_payment_gateway;
  52 use FS::banned_pay;
  53 use FS::payinfo_Mixin;
  54 use FS::TicketSystem;
  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       return $error;
 355     }
 356     $self->invoicing_list( $invoicing_list );
 357   }
 358
 359   if (    $conf->config('cust_main-skeleton_tables')
 360        && $conf->config('cust_main-skeleton_custnum') ) {
 361
 362     warn "  inserting skeleton records\n"
 363       if $DEBUG > 1;
 364
 365     my $error = $self->start_copy_skel;
 366     if ( $error ) {
 367       $dbh->rollback if $oldAutoCommit;
 368       return $error;
 369     }
 370
 371   }
 372
 373   warn "  ordering packages\n"
 374     if $DEBUG > 1;
 375
 376   $error = $self->order_pkgs($cust_pkgs, \$seconds, %options);
 377   if ( $error ) {
 378     $dbh->rollback if $oldAutoCommit;
 379     return $error;
 380   }
 381
 382   if ( $seconds ) {
 383     $dbh->rollback if $oldAutoCommit;
 384     return "No svc_acct record to apply pre-paid time";
 385   }
 386
 387   if ( $amount ) {
 388     warn "  inserting initial $payby payment of $amount\n"
 389       if $DEBUG > 1;
 390     $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
 391     if ( $error ) {
 392       $dbh->rollback if $oldAutoCommit;
 393       return "inserting payment (transaction rolled back): $error";
 394     }
 395   }
 396
 397   unless ( $import || $skip_fuzzyfiles ) {
 398     warn "  queueing fuzzyfiles update\n"
 399       if $DEBUG > 1;
 400     $error = $self->queue_fuzzyfiles_update;
 401     if ( $error ) {
 402       $dbh->rollback if $oldAutoCommit;
 403       return "updating fuzzy search cache: $error";
 404     }
 405   }
 406
 407   warn "  insert complete; committing transaction\n"
 408     if $DEBUG > 1;
 409
 410   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 411   '';
 412
 413 }
 414
 415 sub start_copy_skel {
 416   my $self = shift;
 417
 418   #'mg_user_preference' => {},
 419   #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
 420   #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
 421   #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
 422   #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
 423   my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
 424   die $@ if $@;
 425
 426   _copy_skel( 'cust_main',                                 #tablename
 427               $conf->config('cust_main-skeleton_custnum'), #sourceid
 428               $self->custnum,                              #destid
 429               @tables,                                     #child tables
 430             );
 431 }
 432
 433 #recursive subroutine, not a method
 434 sub _copy_skel {
 435   my( $table, $sourceid, $destid, %child_tables ) = @_;
 436
 437   my $primary_key;
 438   if ( $table =~ /^(\w+)\.(\w+)$/ ) {
 439     ( $table, $primary_key ) = ( $1, $2 );
 440   } else {
 441     my $dbdef_table = dbdef->table($table);
 442     $primary_key = $dbdef_table->primary_key
 443       or return "$table has no primary key".
 444                 " (or do you need to run dbdef-create?)";
 445   }
 446
 447   warn "  _copy_skel: $table.$primary_key $sourceid to $destid for ".
 448        join (', ', keys %child_tables). "\n"
 449     if $DEBUG > 2;
 450
 451   foreach my $child_table_def ( keys %child_tables ) {
 452
 453     my $child_table;
 454     my $child_pkey = '';
 455     if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
 456       ( $child_table, $child_pkey ) = ( $1, $2 );
 457     } else {
 458       $child_table = $child_table_def;
 459
 460       $child_pkey = dbdef->table($child_table)->primary_key;
 461       #  or return "$table has no primary key".
 462       #            " (or do you need to run dbdef-create?)\n";
 463     }
 464
 465     my $sequence = '';
 466     if ( keys %{ $child_tables{$child_table_def} } ) {
 467
 468       return "$child_table has no primary key".
 469              " (run dbdef-create or try specifying it?)\n"
 470         unless $child_pkey;
 471
 472       #false laziness w/Record::insert and only works on Pg
 473       #refactor the proper last-inserted-id stuff out of Record::insert if this
 474       # ever gets use for anything besides a quick kludge for one customer
 475       my $default = dbdef->table($child_table)->column($child_pkey)->default;
 476       $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
 477         or return "can't parse $child_table.$child_pkey default value ".
 478                   " for sequence name: $default";
 479       $sequence = $1;
 480
 481     }
 482
 483     my @sel_columns = grep { $_ ne $primary_key }
 484                            dbdef->table($child_table)->columns;
 485     my $sel_columns = join(', ', @sel_columns );
 486
 487     my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
 488     my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
 489     my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
 490
 491     my $sel_st = "SELECT $sel_columns FROM $child_table".
 492                  " WHERE $primary_key = $sourceid";
 493     warn "    $sel_st\n"
 494       if $DEBUG > 2;
 495     my $sel_sth = dbh->prepare( $sel_st )
 496       or return dbh->errstr;
 497
 498     $sel_sth->execute or return $sel_sth->errstr;
 499
 500     while ( my $row = $sel_sth->fetchrow_hashref ) {
 501
 502       warn "    selected row: ".
 503            join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
 504         if $DEBUG > 2;
 505
 506       my $statement =
 507         "INSERT INTO $child_table $ins_columns VALUES $placeholders";
 508       my $ins_sth =dbh->prepare($statement)
 509           or return dbh->errstr;
 510       my @param = ( $destid, map $row->{$_}, @ins_columns );
 511       warn "    $statement: [ ". join(', ', @param). " ]\n"
 512         if $DEBUG > 2;
 513       $ins_sth->execute( @param )
 514         or return $ins_sth->errstr;
 515
 516       #next unless keys %{ $child_tables{$child_table} };
 517       next unless $sequence;
 518
 519       #another section of that laziness
 520       my $seq_sql = "SELECT currval('$sequence')";
 521       my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
 522       $seq_sth->execute or return $seq_sth->errstr;
 523       my $insertid = $seq_sth->fetchrow_arrayref->[0];
 524
 525       # don't drink soap!  recurse!  recurse!  okay!
 526       my $error =
 527         _copy_skel( $child_table_def,
 528                     $row->{$child_pkey}, #sourceid
 529                     $insertid, #destid
 530                     %{ $child_tables{$child_table_def} },
 531                   );
 532       return $error if $error;
 533
 534     }
 535
 536   }
 537
 538   return '';
 539
 540 }
 541
 542 =item order_pkgs HASHREF, [ SECONDSREF, [ , OPTION => VALUE ... ] ]
 543
 544 Like the insert method on an existing record, this method orders a package
 545 and included services atomicaly.  Pass a Tie::RefHash data structure to this
 546 method containing FS::cust_pkg and FS::svc_I<tablename> objects.  There should
 547 be a better explanation of this, but until then, here's an example:
 548
 549   use Tie::RefHash;
 550   tie %hash, 'Tie::RefHash'; #this part is important
 551   %hash = (
 552     $cust_pkg => [ $svc_acct ],
 553     ...
 554   );
 555   $cust_main->order_pkgs( \%hash, \'0', 'noexport'=>1 );
 556
 557 Services can be new, in which case they are inserted, or existing unaudited
 558 services, in which case they are linked to the newly-created package.
 559
 560 Currently available options are: I<depend_jobnum> and I<noexport>.
 561
 562 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
 563 on the supplied jobnum (they will not run until the specific job completes).
 564 This can be used to defer provisioning until some action completes (such
 565 as running the customer's credit card successfully).
 566
 567 The I<noexport> option is deprecated.  If I<noexport> is set true, no
 568 provisioning jobs (exports) are scheduled.  (You can schedule them later with
 569 the B<reexport> method for each cust_pkg object.  Using the B<reexport> method
 570 on the cust_main object is not recommended, as existing services will also be
 571 reexported.)
 572
 573 =cut
 574
 575 sub order_pkgs {
 576   my $self = shift;
 577   my $cust_pkgs = shift;
 578   my $seconds = shift;
 579   my %options = @_;
 580   my %svc_options = ();
 581   $svc_options{'depend_jobnum'} = $options{'depend_jobnum'}
 582     if exists $options{'depend_jobnum'};
 583   warn "$me order_pkgs called with options ".
 584        join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
 585     if $DEBUG;
 586
 587   local $SIG{HUP} = 'IGNORE';
 588   local $SIG{INT} = 'IGNORE';
 589   local $SIG{QUIT} = 'IGNORE';
 590   local $SIG{TERM} = 'IGNORE';
 591   local $SIG{TSTP} = 'IGNORE';
 592   local $SIG{PIPE} = 'IGNORE';
 593
 594   my $oldAutoCommit = $FS::UID::AutoCommit;
 595   local $FS::UID::AutoCommit = 0;
 596   my $dbh = dbh;
 597
 598   local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
 599
 600   foreach my $cust_pkg ( keys %$cust_pkgs ) {
 601     $cust_pkg->custnum( $self->custnum );
 602     my $error = $cust_pkg->insert;
 603     if ( $error ) {
 604       $dbh->rollback if $oldAutoCommit;
 605       return "inserting cust_pkg (transaction rolled back): $error";
 606     }
 607     foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
 608       if ( $svc_something->svcnum ) {
 609         my $old_cust_svc = $svc_something->cust_svc;
 610         my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
 611         $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
 612         $error = $new_cust_svc->replace($old_cust_svc);
 613       } else {
 614         $svc_something->pkgnum( $cust_pkg->pkgnum );
 615         if ( $seconds && $$seconds && $svc_something->isa('FS::svc_acct') ) {
 616           $svc_something->seconds( $svc_something->seconds + $$seconds );
 617           $$seconds = 0;
 618         }
 619         $error = $svc_something->insert(%svc_options);
 620       }
 621       if ( $error ) {
 622         $dbh->rollback if $oldAutoCommit;
 623         #return "inserting svc_ (transaction rolled back): $error";
 624         return $error;
 625       }
 626     }
 627   }
 628
 629   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 630   ''; #no error
 631 }
 632
 633 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
 634
 635 Recharges this (existing) customer with the specified prepaid card (see
 636 L<FS::prepay_credit>), specified either by I<identifier> or as an
 637 FS::prepay_credit object.  If there is an error, returns the error, otherwise
 638 returns false.
 639
 640 Optionally, four scalar references can be passed as well.  They will have their
 641 values filled in with the amount, number of seconds, and number of upload and
 642 download bytes applied by this prepaid
 643 card.
 644
 645 =cut
 646
 647 sub recharge_prepay {
 648   my( $self, $prepay_credit, $amountref, $secondsref,
 649       $upbytesref, $downbytesref, $totalbytesref ) = @_;
 650
 651   local $SIG{HUP} = 'IGNORE';
 652   local $SIG{INT} = 'IGNORE';
 653   local $SIG{QUIT} = 'IGNORE';
 654   local $SIG{TERM} = 'IGNORE';
 655   local $SIG{TSTP} = 'IGNORE';
 656   local $SIG{PIPE} = 'IGNORE';
 657
 658   my $oldAutoCommit = $FS::UID::AutoCommit;
 659   local $FS::UID::AutoCommit = 0;
 660   my $dbh = dbh;
 661
 662   my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
 663
 664   my $error = $self->get_prepay($prepay_credit, \$amount,
 665                                 \$seconds, \$upbytes, \$downbytes, \$totalbytes)
 666            || $self->increment_seconds($seconds)
 667            || $self->increment_upbytes($upbytes)
 668            || $self->increment_downbytes($downbytes)
 669            || $self->increment_totalbytes($totalbytes)
 670            || $self->insert_cust_pay_prepay( $amount,
 671                                              ref($prepay_credit)
 672                                                ? $prepay_credit->identifier
 673                                                : $prepay_credit
 674                                            );
 675
 676   if ( $error ) {
 677     $dbh->rollback if $oldAutoCommit;
 678     return $error;
 679   }
 680
 681   if ( defined($amountref)  ) { $$amountref  = $amount;  }
 682   if ( defined($secondsref) ) { $$secondsref = $seconds; }
 683   if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
 684   if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
 685   if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
 686
 687   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 688   '';
 689
 690 }
 691
 692 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ , AMOUNTREF, SECONDSREF
 693
 694 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
 695 specified either by I<identifier> or as an FS::prepay_credit object.
 696
 697 References to I<amount> and I<seconds> scalars should be passed as arguments
 698 and will be incremented by the values of the prepaid card.
 699
 700 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
 701 check or set this customer's I<agentnum>.
 702
 703 If there is an error, returns the error, otherwise returns false.
 704
 705 =cut
 706
 707
 708 sub get_prepay {
 709   my( $self, $prepay_credit, $amountref, $secondsref,
 710       $upref, $downref, $totalref) = @_;
 711
 712   local $SIG{HUP} = 'IGNORE';
 713   local $SIG{INT} = 'IGNORE';
 714   local $SIG{QUIT} = 'IGNORE';
 715   local $SIG{TERM} = 'IGNORE';
 716   local $SIG{TSTP} = 'IGNORE';
 717   local $SIG{PIPE} = 'IGNORE';
 718
 719   my $oldAutoCommit = $FS::UID::AutoCommit;
 720   local $FS::UID::AutoCommit = 0;
 721   my $dbh = dbh;
 722
 723   unless ( ref($prepay_credit) ) {
 724
 725     my $identifier = $prepay_credit;
 726
 727     $prepay_credit = qsearchs(
 728       'prepay_credit',
 729       { 'identifier' => $prepay_credit },
 730       '',
 731       'FOR UPDATE'
 732     );
 733
 734     unless ( $prepay_credit ) {
 735       $dbh->rollback if $oldAutoCommit;
 736       return "Invalid prepaid card: ". $identifier;
 737     }
 738
 739   }
 740
 741   if ( $prepay_credit->agentnum ) {
 742     if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
 743       $dbh->rollback if $oldAutoCommit;
 744       return "prepaid card not valid for agent ". $self->agentnum;
 745     }
 746     $self->agentnum($prepay_credit->agentnum);
 747   }
 748
 749   my $error = $prepay_credit->delete;
 750   if ( $error ) {
 751     $dbh->rollback if $oldAutoCommit;
 752     return "removing prepay_credit (transaction rolled back): $error";
 753   }
 754
 755   $$amountref  += $prepay_credit->amount;
 756   $$secondsref += $prepay_credit->seconds;
 757   $$upref      += $prepay_credit->upbytes;
 758   $$downref    += $prepay_credit->downbytes;
 759   $$totalref   += $prepay_credit->totalbytes;
 760
 761   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 762   '';
 763
 764 }
 765
 766 =item increment_upbytes SECONDS
 767
 768 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 769 the specified number of upbytes.  If there is an error, returns the error,
 770 otherwise returns false.
 771
 772 =cut
 773
 774 sub increment_upbytes {
 775   _increment_column( shift, 'upbytes', @_);
 776 }
 777
 778 =item increment_downbytes SECONDS
 779
 780 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 781 the specified number of downbytes.  If there is an error, returns the error,
 782 otherwise returns false.
 783
 784 =cut
 785
 786 sub increment_downbytes {
 787   _increment_column( shift, 'downbytes', @_);
 788 }
 789
 790 =item increment_totalbytes SECONDS
 791
 792 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 793 the specified number of totalbytes.  If there is an error, returns the error,
 794 otherwise returns false.
 795
 796 =cut
 797
 798 sub increment_totalbytes {
 799   _increment_column( shift, 'totalbytes', @_);
 800 }
 801
 802 =item increment_seconds SECONDS
 803
 804 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 805 the specified number of seconds.  If there is an error, returns the error,
 806 otherwise returns false.
 807
 808 =cut
 809
 810 sub increment_seconds {
 811   _increment_column( shift, 'seconds', @_);
 812 }
 813
 814 =item _increment_column AMOUNT
 815
 816 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 817 the specified number of seconds or bytes.  If there is an error, returns
 818 the error, otherwise returns false.
 819
 820 =cut
 821
 822 sub _increment_column {
 823   my( $self, $column, $amount ) = @_;
 824   warn "$me increment_column called: $column, $amount\n"
 825     if $DEBUG;
 826
 827   return '' unless $amount;
 828
 829   my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
 830                       $self->ncancelled_pkgs;
 831
 832   if ( ! @cust_pkg ) {
 833     return 'No packages with primary or single services found'.
 834            ' to apply pre-paid time';
 835   } elsif ( scalar(@cust_pkg) > 1 ) {
 836     #maybe have a way to specify the package/account?
 837     return 'Multiple packages found to apply pre-paid time';
 838   }
 839
 840   my $cust_pkg = $cust_pkg[0];
 841   warn "  found package pkgnum ". $cust_pkg->pkgnum. "\n"
 842     if $DEBUG > 1;
 843
 844   my @cust_svc =
 845     $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
 846
 847   if ( ! @cust_svc ) {
 848     return 'No account found to apply pre-paid time';
 849   } elsif ( scalar(@cust_svc) > 1 ) {
 850     return 'Multiple accounts found to apply pre-paid time';
 851   }
 852
 853   my $svc_acct = $cust_svc[0]->svc_x;
 854   warn "  found service svcnum ". $svc_acct->pkgnum.
 855        ' ('. $svc_acct->email. ")\n"
 856     if $DEBUG > 1;
 857
 858   $column = "increment_$column";
 859   $svc_acct->$column($amount);
 860
 861 }
 862
 863 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
 864
 865 Inserts a prepayment in the specified amount for this customer.  An optional
 866 second argument can specify the prepayment identifier for tracking purposes.
 867 If there is an error, returns the error, otherwise returns false.
 868
 869 =cut
 870
 871 sub insert_cust_pay_prepay {
 872   shift->insert_cust_pay('PREP', @_);
 873 }
 874
 875 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
 876
 877 Inserts a cash payment in the specified amount for this customer.  An optional
 878 second argument can specify the payment identifier for tracking purposes.
 879 If there is an error, returns the error, otherwise returns false.
 880
 881 =cut
 882
 883 sub insert_cust_pay_cash {
 884   shift->insert_cust_pay('CASH', @_);
 885 }
 886
 887 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
 888
 889 Inserts a Western Union payment in the specified amount for this customer.  An
 890 optional second argument can specify the prepayment identifier for tracking
 891 purposes.  If there is an error, returns the error, otherwise returns false.
 892
 893 =cut
 894
 895 sub insert_cust_pay_west {
 896   shift->insert_cust_pay('WEST', @_);
 897 }
 898
 899 sub insert_cust_pay {
 900   my( $self, $payby, $amount ) = splice(@_, 0, 3);
 901   my $payinfo = scalar(@_) ? shift : '';
 902
 903   my $cust_pay = new FS::cust_pay {
 904     'custnum' => $self->custnum,
 905     'paid'    => sprintf('%.2f', $amount),
 906     #'_date'   => #date the prepaid card was purchased???
 907     'payby'   => $payby,
 908     'payinfo' => $payinfo,
 909   };
 910   $cust_pay->insert;
 911
 912 }
 913
 914 =item reexport
 915
 916 This method is deprecated.  See the I<depend_jobnum> option to the insert and
 917 order_pkgs methods for a better way to defer provisioning.
 918
 919 Re-schedules all exports by calling the B<reexport> method of all associated
 920 packages (see L<FS::cust_pkg>).  If there is an error, returns the error;
 921 otherwise returns false.
 922
 923 =cut
 924
 925 sub reexport {
 926   my $self = shift;
 927
 928   carp "WARNING: FS::cust_main::reexport is deprectated; ".
 929        "use the depend_jobnum option to insert or order_pkgs to delay export";
 930
 931   local $SIG{HUP} = 'IGNORE';
 932   local $SIG{INT} = 'IGNORE';
 933   local $SIG{QUIT} = 'IGNORE';
 934   local $SIG{TERM} = 'IGNORE';
 935   local $SIG{TSTP} = 'IGNORE';
 936   local $SIG{PIPE} = 'IGNORE';
 937
 938   my $oldAutoCommit = $FS::UID::AutoCommit;
 939   local $FS::UID::AutoCommit = 0;
 940   my $dbh = dbh;
 941
 942   foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
 943     my $error = $cust_pkg->reexport;
 944     if ( $error ) {
 945       $dbh->rollback if $oldAutoCommit;
 946       return $error;
 947     }
 948   }
 949
 950   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 951   '';
 952
 953 }
 954
 955 =item delete NEW_CUSTNUM
 956
 957 This deletes the customer.  If there is an error, returns the error, otherwise
 958 returns false.
 959
 960 This will completely remove all traces of the customer record.  This is not
 961 what you want when a customer cancels service; for that, cancel all of the
 962 customer's packages (see L</cancel>).
 963
 964 If the customer has any uncancelled packages, you need to pass a new (valid)
 965 customer number for those packages to be transferred to.  Cancelled packages
 966 will be deleted.  Did I mention that this is NOT what you want when a customer
 967 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
 968
 969 You can't delete a customer with invoices (see L<FS::cust_bill>),
 970 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
 971 refunds (see L<FS::cust_refund>).
 972
 973 =cut
 974
 975 sub delete {
 976   my $self = shift;
 977
 978   local $SIG{HUP} = 'IGNORE';
 979   local $SIG{INT} = 'IGNORE';
 980   local $SIG{QUIT} = 'IGNORE';
 981   local $SIG{TERM} = 'IGNORE';
 982   local $SIG{TSTP} = 'IGNORE';
 983   local $SIG{PIPE} = 'IGNORE';
 984
 985   my $oldAutoCommit = $FS::UID::AutoCommit;
 986   local $FS::UID::AutoCommit = 0;
 987   my $dbh = dbh;
 988
 989   if ( $self->cust_bill ) {
 990     $dbh->rollback if $oldAutoCommit;
 991     return "Can't delete a customer with invoices";
 992   }
 993   if ( $self->cust_credit ) {
 994     $dbh->rollback if $oldAutoCommit;
 995     return "Can't delete a customer with credits";
 996   }
 997   if ( $self->cust_pay ) {
 998     $dbh->rollback if $oldAutoCommit;
 999     return "Can't delete a customer with payments";
1000   }
1001   if ( $self->cust_refund ) {
1002     $dbh->rollback if $oldAutoCommit;
1003     return "Can't delete a customer with refunds";
1004   }
1005
1006   my @cust_pkg = $self->ncancelled_pkgs;
1007   if ( @cust_pkg ) {
1008     my $new_custnum = shift;
1009     unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1010       $dbh->rollback if $oldAutoCommit;
1011       return "Invalid new customer number: $new_custnum";
1012     }
1013     foreach my $cust_pkg ( @cust_pkg ) {
1014       my %hash = $cust_pkg->hash;
1015       $hash{'custnum'} = $new_custnum;
1016       my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1017       my $error = $new_cust_pkg->replace($cust_pkg,
1018                                          options => { $cust_pkg->options },
1019                                         );
1020       if ( $error ) {
1021         $dbh->rollback if $oldAutoCommit;
1022         return $error;
1023       }
1024     }
1025   }
1026   my @cancelled_cust_pkg = $self->all_pkgs;
1027   foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1028     my $error = $cust_pkg->delete;
1029     if ( $error ) {
1030       $dbh->rollback if $oldAutoCommit;
1031       return $error;
1032     }
1033   }
1034
1035   foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1036     qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1037   ) {
1038     my $error = $cust_main_invoice->delete;
1039     if ( $error ) {
1040       $dbh->rollback if $oldAutoCommit;
1041       return $error;
1042     }
1043   }
1044
1045   my $error = $self->SUPER::delete;
1046   if ( $error ) {
1047     $dbh->rollback if $oldAutoCommit;
1048     return $error;
1049   }
1050
1051   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1052   '';
1053
1054 }
1055
1056 =item replace OLD_RECORD [ INVOICING_LIST_ARYREF ]
1057
1058 Replaces the OLD_RECORD with this one in the database.  If there is an error,
1059 returns the error, otherwise returns false.
1060
1061 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1062 be set as the invoicing list (see L<"invoicing_list">).  Errors return as
1063 expected and rollback the entire transaction; it is not necessary to call
1064 check_invoicing_list first.  Here's an example:
1065
1066   $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1067
1068 =cut
1069
1070 sub replace {
1071   my $self = shift;
1072   my $old = shift;
1073   my @param = @_;
1074   warn "$me replace called\n"
1075     if $DEBUG;
1076
1077   local $SIG{HUP} = 'IGNORE';
1078   local $SIG{INT} = 'IGNORE';
1079   local $SIG{QUIT} = 'IGNORE';
1080   local $SIG{TERM} = 'IGNORE';
1081   local $SIG{TSTP} = 'IGNORE';
1082   local $SIG{PIPE} = 'IGNORE';
1083
1084   # We absolutely have to have an old vs. new record to make this work.
1085   if (!defined($old)) {
1086     $old = qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
1087   }
1088
1089   my $curuser = $FS::CurrentUser::CurrentUser;
1090   if (    $self->payby eq 'COMP'
1091        && $self->payby ne $old->payby
1092        && ! $curuser->access_right('Complimentary customer')
1093      )
1094   {
1095     return "You are not permitted to create complimentary accounts.";
1096   }
1097
1098   local($ignore_expired_card) = 1
1099     if $old->payby  =~ /^(CARD|DCRD)$/
1100     && $self->payby =~ /^(CARD|DCRD)$/
1101     && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1102
1103   my $oldAutoCommit = $FS::UID::AutoCommit;
1104   local $FS::UID::AutoCommit = 0;
1105   my $dbh = dbh;
1106
1107   my $error = $self->SUPER::replace($old);
1108
1109   if ( $error ) {
1110     $dbh->rollback if $oldAutoCommit;
1111     return $error;
1112   }
1113
1114   if ( @param ) { # INVOICING_LIST_ARYREF
1115     my $invoicing_list = shift @param;
1116     $error = $self->check_invoicing_list( $invoicing_list );
1117     if ( $error ) {
1118       $dbh->rollback if $oldAutoCommit;
1119       return $error;
1120     }
1121     $self->invoicing_list( $invoicing_list );
1122   }
1123
1124   if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1125        grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1126     # card/check/lec info has changed, want to retry realtime_ invoice events
1127     my $error = $self->retry_realtime;
1128     if ( $error ) {
1129       $dbh->rollback if $oldAutoCommit;
1130       return $error;
1131     }
1132   }
1133
1134   unless ( $import || $skip_fuzzyfiles ) {
1135     $error = $self->queue_fuzzyfiles_update;
1136     if ( $error ) {
1137       $dbh->rollback if $oldAutoCommit;
1138       return "updating fuzzy search cache: $error";
1139     }
1140   }
1141
1142   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1143   '';
1144
1145 }
1146
1147 =item queue_fuzzyfiles_update
1148
1149 Used by insert & replace to update the fuzzy search cache
1150
1151 =cut
1152
1153 sub queue_fuzzyfiles_update {
1154   my $self = shift;
1155
1156   local $SIG{HUP} = 'IGNORE';
1157   local $SIG{INT} = 'IGNORE';
1158   local $SIG{QUIT} = 'IGNORE';
1159   local $SIG{TERM} = 'IGNORE';
1160   local $SIG{TSTP} = 'IGNORE';
1161   local $SIG{PIPE} = 'IGNORE';
1162
1163   my $oldAutoCommit = $FS::UID::AutoCommit;
1164   local $FS::UID::AutoCommit = 0;
1165   my $dbh = dbh;
1166
1167   my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1168   my $error = $queue->insert( map $self->getfield($_),
1169                                   qw(first last company)
1170                             );
1171   if ( $error ) {
1172     $dbh->rollback if $oldAutoCommit;
1173     return "queueing job (transaction rolled back): $error";
1174   }
1175
1176   if ( $self->ship_last ) {
1177     $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1178     $error = $queue->insert( map $self->getfield("ship_$_"),
1179                                  qw(first last company)
1180                            );
1181     if ( $error ) {
1182       $dbh->rollback if $oldAutoCommit;
1183       return "queueing job (transaction rolled back): $error";
1184     }
1185   }
1186
1187   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1188   '';
1189
1190 }
1191
1192 =item check
1193
1194 Checks all fields to make sure this is a valid customer record.  If there is
1195 an error, returns the error, otherwise returns false.  Called by the insert
1196 and replace methods.
1197
1198 =cut
1199
1200 sub check {
1201   my $self = shift;
1202
1203   warn "$me check BEFORE: \n". $self->_dump
1204     if $DEBUG > 2;
1205
1206   my $error =
1207     $self->ut_numbern('custnum')
1208     || $self->ut_number('agentnum')
1209     || $self->ut_textn('agent_custid')
1210     || $self->ut_number('refnum')
1211     || $self->ut_name('last')
1212     || $self->ut_name('first')
1213     || $self->ut_snumbern('birthdate')
1214     || $self->ut_snumbern('signupdate')
1215     || $self->ut_textn('company')
1216     || $self->ut_text('address1')
1217     || $self->ut_textn('address2')
1218     || $self->ut_text('city')
1219     || $self->ut_textn('county')
1220     || $self->ut_textn('state')
1221     || $self->ut_country('country')
1222     || $self->ut_anything('comments')
1223     || $self->ut_numbern('referral_custnum')
1224     || $self->ut_textn('stateid')
1225     || $self->ut_textn('stateid_state')
1226     || $self->ut_textn('invoice_terms')
1227   ;
1228   #barf.  need message catalogs.  i18n.  etc.
1229   $error .= "Please select an advertising source."
1230     if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1231   return $error if $error;
1232
1233   return "Unknown agent"
1234     unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1235
1236   return "Unknown refnum"
1237     unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1238
1239   return "Unknown referring custnum: ". $self->referral_custnum
1240     unless ! $self->referral_custnum
1241            || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1242
1243   if ( $self->ss eq '' ) {
1244     $self->ss('');
1245   } else {
1246     my $ss = $self->ss;
1247     $ss =~ s/\D//g;
1248     $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1249       or return "Illegal social security number: ". $self->ss;
1250     $self->ss("$1-$2-$3");
1251   }
1252
1253
1254 # bad idea to disable, causes billing to fail because of no tax rates later
1255 #  unless ( $import ) {
1256     unless ( qsearch('cust_main_county', {
1257       'country' => $self->country,
1258       'state'   => '',
1259      } ) ) {
1260       return "Unknown state/county/country: ".
1261         $self->state. "/". $self->county. "/". $self->country
1262         unless qsearch('cust_main_county',{
1263           'state'   => $self->state,
1264           'county'  => $self->county,
1265           'country' => $self->country,
1266         } );
1267     }
1268 #  }
1269
1270   $error =
1271     $self->ut_phonen('daytime', $self->country)
1272     || $self->ut_phonen('night', $self->country)
1273     || $self->ut_phonen('fax', $self->country)
1274     || $self->ut_zip('zip', $self->country)
1275   ;
1276   return $error if $error;
1277
1278   if ( $conf->exists('cust_main-require_phone')
1279        && ! length($self->daytime) && ! length($self->night)
1280      ) {
1281
1282     my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1283                           ? 'Day Phone'
1284                           : FS::Msgcat::_gettext('daytime');
1285     my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1286                         ? 'Night Phone'
1287                         : FS::Msgcat::_gettext('night');
1288
1289     return "$daytime_label or $night_label is required"
1290
1291   }
1292
1293   my @addfields = qw(
1294     last first company address1 address2 city county state zip
1295     country daytime night fax
1296   );
1297
1298   if ( defined $self->dbdef_table->column('ship_last') ) {
1299     if ( scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1300                        @addfields )
1301          && scalar ( grep { $self->getfield("ship_$_") ne '' } @addfields )
1302        )
1303     {
1304       my $error =
1305         $self->ut_name('ship_last')
1306         || $self->ut_name('ship_first')
1307         || $self->ut_textn('ship_company')
1308         || $self->ut_text('ship_address1')
1309         || $self->ut_textn('ship_address2')
1310         || $self->ut_text('ship_city')
1311         || $self->ut_textn('ship_county')
1312         || $self->ut_textn('ship_state')
1313         || $self->ut_country('ship_country')
1314       ;
1315       return $error if $error;
1316
1317       #false laziness with above
1318       unless ( qsearchs('cust_main_county', {
1319         'country' => $self->ship_country,
1320         'state'   => '',
1321        } ) ) {
1322         return "Unknown ship_state/ship_county/ship_country: ".
1323           $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1324           unless qsearch('cust_main_county',{
1325             'state'   => $self->ship_state,
1326             'county'  => $self->ship_county,
1327             'country' => $self->ship_country,
1328           } );
1329       }
1330       #eofalse
1331
1332       $error =
1333         $self->ut_phonen('ship_daytime', $self->ship_country)
1334         || $self->ut_phonen('ship_night', $self->ship_country)
1335         || $self->ut_phonen('ship_fax', $self->ship_country)
1336         || $self->ut_zip('ship_zip', $self->ship_country)
1337       ;
1338       return $error if $error;
1339
1340     } else { # ship_ info eq billing info, so don't store dup info in database
1341       $self->setfield("ship_$_", '')
1342         foreach qw( last first company address1 address2 city county state zip
1343                     country daytime night fax );
1344     }
1345   }
1346
1347   #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1348   #  or return "Illegal payby: ". $self->payby;
1349   #$self->payby($1);
1350   FS::payby->can_payby($self->table, $self->payby)
1351     or return "Illegal payby: ". $self->payby;
1352
1353   $error =    $self->ut_numbern('paystart_month')
1354            || $self->ut_numbern('paystart_year')
1355            || $self->ut_numbern('payissue')
1356            || $self->ut_textn('paytype')
1357   ;
1358   return $error if $error;
1359
1360   if ( $self->payip eq '' ) {
1361     $self->payip('');
1362   } else {
1363     $error = $self->ut_ip('payip');
1364     return $error if $error;
1365   }
1366
1367   # If it is encrypted and the private key is not availaible then we can't
1368   # check the credit card.
1369
1370   my $check_payinfo = 1;
1371
1372   if ($self->is_encrypted($self->payinfo)) {
1373     $check_payinfo = 0;
1374   }
1375
1376   if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1377
1378     my $payinfo = $self->payinfo;
1379     $payinfo =~ s/\D//g;
1380     $payinfo =~ /^(\d{13,16})$/
1381       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1382     $payinfo = $1;
1383     $self->payinfo($payinfo);
1384     validate($payinfo)
1385       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1386
1387     return gettext('unknown_card_type')
1388       if cardtype($self->payinfo) eq "Unknown";
1389
1390     my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1391     if ( $ban ) {
1392       return 'Banned credit card: banned on '.
1393              time2str('%a %h %o at %r', $ban->_date).
1394              ' by '. $ban->otaker.
1395              ' (ban# '. $ban->bannum. ')';
1396     }
1397
1398     if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1399       if ( cardtype($self->payinfo) eq 'American Express card' ) {
1400         $self->paycvv =~ /^(\d{4})$/
1401           or return "CVV2 (CID) for American Express cards is four digits.";
1402         $self->paycvv($1);
1403       } else {
1404         $self->paycvv =~ /^(\d{3})$/
1405           or return "CVV2 (CVC2/CID) is three digits.";
1406         $self->paycvv($1);
1407       }
1408     } else {
1409       $self->paycvv('');
1410     }
1411
1412     my $cardtype = cardtype($payinfo);
1413     if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1414
1415       return "Start date or issue number is required for $cardtype cards"
1416         unless $self->paystart_month && $self->paystart_year or $self->payissue;
1417
1418       return "Start month must be between 1 and 12"
1419         if $self->paystart_month
1420            and $self->paystart_month < 1 || $self->paystart_month > 12;
1421
1422       return "Start year must be 1990 or later"
1423         if $self->paystart_year
1424            and $self->paystart_year < 1990;
1425
1426       return "Issue number must be beween 1 and 99"
1427         if $self->payissue
1428           and $self->payissue < 1 || $self->payissue > 99;
1429
1430     } else {
1431       $self->paystart_month('');
1432       $self->paystart_year('');
1433       $self->payissue('');
1434     }
1435
1436   } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1437
1438     my $payinfo = $self->payinfo;
1439     $payinfo =~ s/[^\d\@]//g;
1440     if ( $conf->exists('echeck-nonus') ) {
1441       $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1442       $payinfo = "$1\@$2";
1443     } else {
1444       $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1445       $payinfo = "$1\@$2";
1446     }
1447     $self->payinfo($payinfo);
1448     $self->paycvv('');
1449
1450     my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1451     if ( $ban ) {
1452       return 'Banned ACH account: banned on '.
1453              time2str('%a %h %o at %r', $ban->_date).
1454              ' by '. $ban->otaker.
1455              ' (ban# '. $ban->bannum. ')';
1456     }
1457
1458   } elsif ( $self->payby eq 'LECB' ) {
1459
1460     my $payinfo = $self->payinfo;
1461     $payinfo =~ s/\D//g;
1462     $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1463     $payinfo = $1;
1464     $self->payinfo($payinfo);
1465     $self->paycvv('');
1466
1467   } elsif ( $self->payby eq 'BILL' ) {
1468
1469     $error = $self->ut_textn('payinfo');
1470     return "Illegal P.O. number: ". $self->payinfo if $error;
1471     $self->paycvv('');
1472
1473   } elsif ( $self->payby eq 'COMP' ) {
1474
1475     my $curuser = $FS::CurrentUser::CurrentUser;
1476     if (    ! $self->custnum
1477          && ! $curuser->access_right('Complimentary customer')
1478        )
1479     {
1480       return "You are not permitted to create complimentary accounts."
1481     }
1482
1483     $error = $self->ut_textn('payinfo');
1484     return "Illegal comp account issuer: ". $self->payinfo if $error;
1485     $self->paycvv('');
1486
1487   } elsif ( $self->payby eq 'PREPAY' ) {
1488
1489     my $payinfo = $self->payinfo;
1490     $payinfo =~ s/\W//g; #anything else would just confuse things
1491     $self->payinfo($payinfo);
1492     $error = $self->ut_alpha('payinfo');
1493     return "Illegal prepayment identifier: ". $self->payinfo if $error;
1494     return "Unknown prepayment identifier"
1495       unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1496     $self->paycvv('');
1497
1498   }
1499
1500   if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1501     return "Expiration date required"
1502       unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1503     $self->paydate('');
1504   } else {
1505     my( $m, $y );
1506     if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1507       ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1508     } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1509       ( $m, $y ) = ( $3, "20$2" );
1510     } else {
1511       return "Illegal expiration date: ". $self->paydate;
1512     }
1513     $self->paydate("$y-$m-01");
1514     my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1515     return gettext('expired_card')
1516       if !$import
1517       && !$ignore_expired_card
1518       && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1519   }
1520
1521   if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1522        ( ! $conf->exists('require_cardname')
1523          || $self->payby !~ /^(CARD|DCRD)$/  )
1524   ) {
1525     $self->payname( $self->first. " ". $self->getfield('last') );
1526   } else {
1527     $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1528       or return gettext('illegal_name'). " payname: ". $self->payname;
1529     $self->payname($1);
1530   }
1531
1532   foreach my $flag (qw( tax spool_cdr )) {
1533     $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1534     $self->$flag($1);
1535   }
1536
1537   $self->otaker(getotaker) unless $self->otaker;
1538
1539   warn "$me check AFTER: \n". $self->_dump
1540     if $DEBUG > 2;
1541
1542   $self->SUPER::check;
1543 }
1544
1545 =item all_pkgs
1546
1547 Returns all packages (see L<FS::cust_pkg>) for this customer.
1548
1549 =cut
1550
1551 sub all_pkgs {
1552   my $self = shift;
1553
1554   return $self->num_pkgs unless wantarray;
1555
1556   my @cust_pkg = ();
1557   if ( $self->{'_pkgnum'} ) {
1558     @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1559   } else {
1560     @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1561   }
1562
1563   sort sort_packages @cust_pkg;
1564 }
1565
1566 =item cust_pkg
1567
1568 Synonym for B<all_pkgs>.
1569
1570 =cut
1571
1572 sub cust_pkg {
1573   shift->all_pkgs(@_);
1574 }
1575
1576 =item ncancelled_pkgs
1577
1578 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1579
1580 =cut
1581
1582 sub ncancelled_pkgs {
1583   my $self = shift;
1584
1585   return $self->num_ncancelled_pkgs unless wantarray;
1586
1587   my @cust_pkg = ();
1588   if ( $self->{'_pkgnum'} ) {
1589
1590     warn "$me ncancelled_pkgs: returning cached objects"
1591       if $DEBUG > 1;
1592
1593     @cust_pkg = grep { ! $_->getfield('cancel') }
1594                 values %{ $self->{'_pkgnum'}->cache };
1595
1596   } else {
1597
1598     warn "$me ncancelled_pkgs: searching for packages with custnum ".
1599          $self->custnum. "\n"
1600       if $DEBUG > 1;
1601
1602     @cust_pkg =
1603       qsearch( 'cust_pkg', {
1604                              'custnum' => $self->custnum,
1605                              'cancel'  => '',
1606                            });
1607     push @cust_pkg,
1608       qsearch( 'cust_pkg', {
1609                              'custnum' => $self->custnum,
1610                              'cancel'  => 0,
1611                            });
1612   }
1613
1614   sort sort_packages @cust_pkg;
1615
1616 }
1617
1618 # This should be generalized to use config options to determine order.
1619 sub sort_packages {
1620   if ( $a->get('cancel') and $b->get('cancel') ) {
1621     $a->pkgnum <=> $b->pkgnum;
1622   } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1623     return -1 if $b->get('cancel');
1624     return  1 if $a->get('cancel');
1625     return 0;
1626   } else {
1627     $a->pkgnum <=> $b->pkgnum;
1628   }
1629 }
1630
1631 =item suspended_pkgs
1632
1633 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1634
1635 =cut
1636
1637 sub suspended_pkgs {
1638   my $self = shift;
1639   grep { $_->susp } $self->ncancelled_pkgs;
1640 }
1641
1642 =item unflagged_suspended_pkgs
1643
1644 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1645 customer (thouse packages without the `manual_flag' set).
1646
1647 =cut
1648
1649 sub unflagged_suspended_pkgs {
1650   my $self = shift;
1651   return $self->suspended_pkgs
1652     unless dbdef->table('cust_pkg')->column('manual_flag');
1653   grep { ! $_->manual_flag } $self->suspended_pkgs;
1654 }
1655
1656 =item unsuspended_pkgs
1657
1658 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1659 this customer.
1660
1661 =cut
1662
1663 sub unsuspended_pkgs {
1664   my $self = shift;
1665   grep { ! $_->susp } $self->ncancelled_pkgs;
1666 }
1667
1668 =item num_cancelled_pkgs
1669
1670 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1671 customer.
1672
1673 =cut
1674
1675 sub num_cancelled_pkgs {
1676   shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1677 }
1678
1679 sub num_ncancelled_pkgs {
1680   shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1681 }
1682
1683 sub num_pkgs {
1684   my( $self ) = shift;
1685   my $sql = scalar(@_) ? shift : '';
1686   $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1687   my $sth = dbh->prepare(
1688     "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1689   ) or die dbh->errstr;
1690   $sth->execute($self->custnum) or die $sth->errstr;
1691   $sth->fetchrow_arrayref->[0];
1692 }
1693
1694 =item unsuspend
1695
1696 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1697 and L<FS::cust_pkg>) for this customer.  Always returns a list: an empty list
1698 on success or a list of errors.
1699
1700 =cut
1701
1702 sub unsuspend {
1703   my $self = shift;
1704   grep { $_->unsuspend } $self->suspended_pkgs;
1705 }
1706
1707 =item suspend
1708
1709 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1710
1711 Returns a list: an empty list on success or a list of errors.
1712
1713 =cut
1714
1715 sub suspend {
1716   my $self = shift;
1717   grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1718 }
1719
1720 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1721
1722 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1723 PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref instead
1724 of a list of pkgparts; the hashref has the following keys:
1725
1726 =over 4
1727
1728 =item pkgparts - listref of pkgparts
1729
1730 =item (other options are passed to the suspend method)
1731
1732 =back
1733
1734
1735 Returns a list: an empty list on success or a list of errors.
1736
1737 =cut
1738
1739 sub suspend_if_pkgpart {
1740   my $self = shift;
1741   my (@pkgparts, %opt);
1742   if (ref($_[0]) eq 'HASH'){
1743     @pkgparts = @{$_[0]{pkgparts}};
1744     %opt      = %{$_[0]};
1745   }else{
1746     @pkgparts = @_;
1747   }
1748   grep { $_->suspend(%opt) }
1749     grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1750       $self->unsuspended_pkgs;
1751 }
1752
1753 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1754
1755 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1756 given PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref
1757 instead of a list of pkgparts; the hashref has the following keys:
1758
1759 =over 4
1760
1761 =item pkgparts - listref of pkgparts
1762
1763 =item (other options are passed to the suspend method)
1764
1765 =back
1766
1767 Returns a list: an empty list on success or a list of errors.
1768
1769 =cut
1770
1771 sub suspend_unless_pkgpart {
1772   my $self = shift;
1773   my (@pkgparts, %opt);
1774   if (ref($_[0]) eq 'HASH'){
1775     @pkgparts = @{$_[0]{pkgparts}};
1776     %opt      = %{$_[0]};
1777   }else{
1778     @pkgparts = @_;
1779   }
1780   grep { $_->suspend(%opt) }
1781     grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1782       $self->unsuspended_pkgs;
1783 }
1784
1785 =item cancel [ OPTION => VALUE ... ]
1786
1787 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1788
1789 Available options are:
1790
1791 =over 4
1792
1793 =item quiet - can be set true to supress email cancellation notices.
1794
1795 =item reason - can be set to a cancellation reason (see L<FS:reason>), either a reasonnum of an existing reason, or passing a hashref will create a new reason.  The hashref should have the following keys: typenum - Reason type (see L<FS::reason_type>, reason - Text of the new reason.
1796
1797 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
1798
1799 =back
1800
1801 Always returns a list: an empty list on success or a list of errors.
1802
1803 =cut
1804
1805 sub cancel {
1806   my( $self, %opt ) = @_;
1807
1808   warn "$me cancel called on customer ". $self->custnum. " with options ".
1809        join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
1810     if $DEBUG;
1811
1812   return ( 'access denied' )
1813     unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
1814
1815   if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1816
1817     #should try decryption (we might have the private key)
1818     # and if not maybe queue a job for the server that does?
1819     return ( "Can't (yet) ban encrypted credit cards" )
1820       if $self->is_encrypted($self->payinfo);
1821
1822     my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1823     my $error = $ban->insert;
1824     return ( $error ) if $error;
1825
1826   }
1827
1828   my @pkgs = $self->ncancelled_pkgs;
1829
1830   warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
1831        scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
1832     if $DEBUG;
1833
1834   grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
1835 }
1836
1837 sub _banned_pay_hashref {
1838   my $self = shift;
1839
1840   my %payby2ban = (
1841     'CARD' => 'CARD',
1842     'DCRD' => 'CARD',
1843     'CHEK' => 'CHEK',
1844     'DCHK' => 'CHEK'
1845   );
1846
1847   {
1848     'payby'   => $payby2ban{$self->payby},
1849     'payinfo' => md5_base64($self->payinfo),
1850     #don't ever *search* on reason! #'reason'  =>
1851   };
1852 }
1853
1854 =item notes
1855
1856 Returns all notes (see L<FS::cust_main_note>) for this customer.
1857
1858 =cut
1859
1860 sub notes {
1861   my $self = shift;
1862   #order by?
1863   qsearch( 'cust_main_note',
1864            { 'custnum' => $self->custnum },
1865            '',
1866            'ORDER BY _DATE DESC'
1867          );
1868 }
1869
1870 =item agent
1871
1872 Returns the agent (see L<FS::agent>) for this customer.
1873
1874 =cut
1875
1876 sub agent {
1877   my $self = shift;
1878   qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1879 }
1880
1881 =item bill_and_collect
1882
1883 Cancels and suspends any packages due, generates bills, applies payments and
1884 cred
1885
1886 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
1887
1888 Options are passed as name-value pairs.  Currently available options are:
1889
1890 =over 4
1891
1892 =item time
1893
1894 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:
1895
1896  use Date::Parse;
1897  ...
1898  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1899
1900 =item invoice_time
1901
1902 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.
1903
1904 =item check_freq
1905
1906 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1907
1908 =item resetup
1909
1910 If set true, re-charges setup fees.
1911
1912 =item debug
1913
1914 Debugging level.  Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
1915
1916 =back
1917
1918 =cut
1919
1920 sub bill_and_collect {
1921   my( $self, %options ) = @_;
1922
1923   ###
1924   # cancel packages
1925   ###
1926
1927   #$^T not $options{time} because freeside-daily -d is for pre-printing invoices
1928   foreach my $cust_pkg (
1929     grep { $_->expire && $_->expire <= $^T } $self->ncancelled_pkgs
1930   ) {
1931     my $error = $cust_pkg->cancel;
1932     warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
1933          " for custnum ". $self->custnum. ": $error"
1934       if $error;
1935   }
1936
1937   ###
1938   # suspend packages
1939   ###
1940
1941   #$^T not $options{time} because freeside-daily -d is for pre-printing invoices
1942   foreach my $cust_pkg (
1943     grep { (    $_->part_pkg->is_prepaid && $_->bill && $_->bill < $^T
1944              || $_->adjourn && $_->adjourn <= $^T
1945            )
1946            && ! $_->susp
1947          }
1948          $self->ncancelled_pkgs
1949   ) {
1950     my $error = $cust_pkg->suspend;
1951     warn "Error suspending package ". $cust_pkg->pkgnum.
1952          " for custnum ". $self->custnum. ": $error"
1953       if $error;
1954   }
1955
1956   ###
1957   # bill and collect
1958   ###
1959
1960   my $error = $self->bill( %options );
1961   warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
1962
1963   $self->apply_payments_and_credits;
1964
1965   $error = $self->collect( %options );
1966   warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
1967
1968 }
1969
1970 =item bill OPTIONS
1971
1972 Generates invoices (see L<FS::cust_bill>) for this customer.  Usually used in
1973 conjunction with the collect method by calling B<bill_and_collect>.
1974
1975 If there is an error, returns the error, otherwise returns false.
1976
1977 Options are passed as name-value pairs.  Currently available options are:
1978
1979 =over 4
1980
1981 =item resetup
1982
1983 If set true, re-charges setup fees.
1984
1985 =item time
1986
1987 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:
1988
1989  use Date::Parse;
1990  ...
1991  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1992
1993 =item pkg_list
1994
1995 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
1996
1997  $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
1998
1999 =item invoice_time
2000
2001 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.
2002
2003 =back
2004
2005 =cut
2006
2007 sub bill {
2008   my( $self, %options ) = @_;
2009   return '' if $self->payby eq 'COMP';
2010   warn "$me bill customer ". $self->custnum. "\n"
2011     if $DEBUG;
2012
2013   my $time = $options{'time'} || time;
2014
2015   my $error;
2016
2017   #put below somehow?
2018   local $SIG{HUP} = 'IGNORE';
2019   local $SIG{INT} = 'IGNORE';
2020   local $SIG{QUIT} = 'IGNORE';
2021   local $SIG{TERM} = 'IGNORE';
2022   local $SIG{TSTP} = 'IGNORE';
2023   local $SIG{PIPE} = 'IGNORE';
2024
2025   my $oldAutoCommit = $FS::UID::AutoCommit;
2026   local $FS::UID::AutoCommit = 0;
2027   my $dbh = dbh;
2028
2029   $self->select_for_update; #mutex
2030
2031   #create a new invoice
2032   #(we'll remove it later if it doesn't actually need to be generated [contains
2033   # no line items] and we're inside a transaciton so nothing else will see it)
2034   my $cust_bill = new FS::cust_bill ( {
2035     'custnum' => $self->custnum,
2036     '_date'   => ( $options{'invoice_time'} || $time ),
2037     #'charged' => $charged,
2038     'charged' => 0,
2039   } );
2040   $error = $cust_bill->insert;
2041   if ( $error ) {
2042     $dbh->rollback if $oldAutoCommit;
2043     return "can't create invoice for customer #". $self->custnum. ": $error";
2044   }
2045   my $invnum = $cust_bill->invnum;
2046
2047   ###
2048   # find the packages which are due for billing, find out how much they are
2049   # & generate invoice database.
2050   ###
2051
2052   my( $total_setup, $total_recur ) = ( 0, 0 );
2053   my %tax;
2054   my @precommit_hooks = ();
2055
2056   foreach my $cust_pkg (
2057     qsearch('cust_pkg', { 'custnum' => $self->custnum } )
2058   ) {
2059
2060     #NO!! next if $cust_pkg->cancel;
2061     next if $cust_pkg->getfield('cancel');
2062
2063     warn "  bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2064
2065     #? to avoid use of uninitialized value errors... ?
2066     $cust_pkg->setfield('bill', '')
2067       unless defined($cust_pkg->bill);
2068
2069     my $part_pkg = $cust_pkg->part_pkg;
2070
2071     my %hash = $cust_pkg->hash;
2072     my $old_cust_pkg = new FS::cust_pkg \%hash;
2073
2074     my @details = ();
2075
2076     ###
2077     # bill setup
2078     ###
2079
2080     my $setup = 0;
2081     if ( ! $cust_pkg->setup &&
2082          (
2083            ( $conf->exists('disable_setup_suspended_pkgs') &&
2084             ! $cust_pkg->getfield('susp')
2085           ) || ! $conf->exists('disable_setup_suspended_pkgs')
2086          )
2087       || $options{'resetup'}
2088     ) {
2089
2090       warn "    bill setup\n" if $DEBUG > 1;
2091
2092       $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2093       if ( $@ ) {
2094         $dbh->rollback if $oldAutoCommit;
2095         return "$@ running calc_setup for $cust_pkg\n";
2096       }
2097
2098       $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
2099     }
2100
2101     ###
2102     # bill recurring fee
2103     ###
2104
2105     my $recur = 0;
2106     my $sdate;
2107     if ( $part_pkg->getfield('freq') ne '0' &&
2108          ! $cust_pkg->getfield('susp') &&
2109          ( $cust_pkg->getfield('bill') || 0 ) <= $time
2110     ) {
2111
2112       # XXX should this be a package event?  probably.  events are called
2113       # at collection time at the moment, though...
2114       if ( $part_pkg->can('reset_usage') ) {
2115         warn "    resetting usage counters" if $DEBUG > 1;
2116         $part_pkg->reset_usage($cust_pkg);
2117       }
2118
2119       warn "    bill recur\n" if $DEBUG > 1;
2120
2121       # XXX shared with $recur_prog
2122       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2123
2124       #over two params!  lets at least switch to a hashref for the rest...
2125       my %param = ( 'precommit_hooks' => \@precommit_hooks, );
2126
2127       $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2128       if ( $@ ) {
2129         $dbh->rollback if $oldAutoCommit;
2130         return "$@ running calc_recur for $cust_pkg\n";
2131       }
2132
2133       #change this bit to use Date::Manip? CAREFUL with timezones (see
2134       # mailing list archive)
2135       my ($sec,$min,$hour,$mday,$mon,$year) =
2136         (localtime($sdate) )[0,1,2,3,4,5];
2137
2138       #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
2139       # only for figuring next bill date, nothing else, so, reset $sdate again
2140       # here
2141       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2142       $cust_pkg->last_bill($sdate)
2143         if $cust_pkg->dbdef_table->column('last_bill');
2144
2145       if ( $part_pkg->freq =~ /^\d+$/ ) {
2146         $mon += $part_pkg->freq;
2147         until ( $mon < 12 ) { $mon -= 12; $year++; }
2148       } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
2149         my $weeks = $1;
2150         $mday += $weeks * 7;
2151       } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
2152         my $days = $1;
2153         $mday += $days;
2154       } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
2155         my $hours = $1;
2156         $hour += $hours;
2157       } else {
2158         $dbh->rollback if $oldAutoCommit;
2159         return "unparsable frequency: ". $part_pkg->freq;
2160       }
2161       $cust_pkg->setfield('bill',
2162         timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
2163     }
2164
2165     warn "\$setup is undefined" unless defined($setup);
2166     warn "\$recur is undefined" unless defined($recur);
2167     warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2168
2169     ###
2170     # If $cust_pkg has been modified, update it and create cust_bill_pkg records
2171     ###
2172
2173     if ( $cust_pkg->modified ) {  # hmmm.. and if the options are modified?
2174
2175       warn "  package ". $cust_pkg->pkgnum. " modified; updating\n"
2176         if $DEBUG >1;
2177
2178       $error=$cust_pkg->replace($old_cust_pkg,
2179                                 options => { $cust_pkg->options },
2180                                );
2181       if ( $error ) { #just in case
2182         $dbh->rollback if $oldAutoCommit;
2183         return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
2184       }
2185
2186       $setup = sprintf( "%.2f", $setup );
2187       $recur = sprintf( "%.2f", $recur );
2188       if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2189         $dbh->rollback if $oldAutoCommit;
2190         return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2191       }
2192       if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2193         $dbh->rollback if $oldAutoCommit;
2194         return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2195       }
2196
2197       if ( $setup != 0 || $recur != 0 ) {
2198
2199         warn "    charges (setup=$setup, recur=$recur); adding line items\n"
2200           if $DEBUG > 1;
2201         my $cust_bill_pkg = new FS::cust_bill_pkg ({
2202           'invnum'  => $invnum,
2203           'pkgnum'  => $cust_pkg->pkgnum,
2204           'setup'   => $setup,
2205           'recur'   => $recur,
2206           'sdate'   => $sdate,
2207           'edate'   => $cust_pkg->bill,
2208           'details' => \@details,
2209         });
2210         $error = $cust_bill_pkg->insert;
2211         if ( $error ) {
2212           $dbh->rollback if $oldAutoCommit;
2213           return "can't create invoice line item for invoice #$invnum: $error";
2214         }
2215         $total_setup += $setup;
2216         $total_recur += $recur;
2217
2218         ###
2219         # handle taxes
2220         ###
2221
2222         unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2223
2224           my $prefix =
2225             ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2226             ? 'ship_'
2227             : '';
2228           my %taxhash = map { $_ => $self->get("$prefix$_") }
2229                             qw( state county country );
2230
2231           $taxhash{'taxclass'} = $part_pkg->taxclass;
2232
2233           my @taxes = qsearch( 'cust_main_county', \%taxhash );
2234
2235           unless ( @taxes ) {
2236             $taxhash{'taxclass'} = '';
2237             @taxes =  qsearch( 'cust_main_county', \%taxhash );
2238           }
2239
2240           #one more try at a whole-country tax rate
2241           unless ( @taxes ) {
2242             $taxhash{$_} = '' foreach qw( state county );
2243             @taxes =  qsearch( 'cust_main_county', \%taxhash );
2244           }
2245
2246           # maybe eliminate this entirely, along with all the 0% records
2247           unless ( @taxes ) {
2248             $dbh->rollback if $oldAutoCommit;
2249             return
2250               "fatal: can't find tax rate for state/county/country/taxclass ".
2251               join('/', ( map $self->get("$prefix$_"),
2252                               qw(state county country)
2253                         ),
2254                         $part_pkg->taxclass ). "\n";
2255           }
2256
2257           foreach my $tax ( @taxes ) {
2258
2259             my $taxable_charged = 0;
2260             $taxable_charged += $setup
2261               unless $part_pkg->setuptax =~ /^Y$/i
2262                   || $tax->setuptax =~ /^Y$/i;
2263             $taxable_charged += $recur
2264               unless $part_pkg->recurtax =~ /^Y$/i
2265                   || $tax->recurtax =~ /^Y$/i;
2266             next unless $taxable_charged;
2267
2268             if ( $tax->exempt_amount && $tax->exempt_amount > 0 ) {
2269               #my ($mon,$year) = (localtime($sdate) )[4,5];
2270               my ($mon,$year) = (localtime( $sdate || $cust_bill->_date ) )[4,5];
2271               $mon++;
2272               my $freq = $part_pkg->freq || 1;
2273               if ( $freq !~ /(\d+)$/ ) {
2274                 $dbh->rollback if $oldAutoCommit;
2275                 return "daily/weekly package definitions not (yet?)".
2276                        " compatible with monthly tax exemptions";
2277               }
2278               my $taxable_per_month =
2279                 sprintf("%.2f", $taxable_charged / $freq );
2280
2281               #call the whole thing off if this customer has any old
2282               #exemption records...
2283               my @cust_tax_exempt =
2284                 qsearch( 'cust_tax_exempt' => { custnum=> $self->custnum } );
2285               if ( @cust_tax_exempt ) {
2286                 $dbh->rollback if $oldAutoCommit;
2287                 return
2288                   'this customer still has old-style tax exemption records; '.
2289                   'run bin/fs-migrate-cust_tax_exempt?';
2290               }
2291
2292               foreach my $which_month ( 1 .. $freq ) {
2293
2294                 #maintain the new exemption table now
2295                 my $sql = "
2296                   SELECT SUM(amount)
2297                     FROM cust_tax_exempt_pkg
2298                       LEFT JOIN cust_bill_pkg USING ( billpkgnum )
2299                       LEFT JOIN cust_bill     USING ( invnum     )
2300                     WHERE custnum = ?
2301                       AND taxnum  = ?
2302                       AND year    = ?
2303                       AND month   = ?
2304                 ";
2305                 my $sth = dbh->prepare($sql) or do {
2306                   $dbh->rollback if $oldAutoCommit;
2307                   return "fatal: can't lookup exising exemption: ". dbh->errstr;
2308                 };
2309                 $sth->execute(
2310                   $self->custnum,
2311                   $tax->taxnum,
2312                   1900+$year,
2313                   $mon,
2314                 ) or do {
2315                   $dbh->rollback if $oldAutoCommit;
2316                   return "fatal: can't lookup exising exemption: ". dbh->errstr;
2317                 };
2318                 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
2319
2320                 my $remaining_exemption =
2321                   $tax->exempt_amount - $existing_exemption;
2322                 if ( $remaining_exemption > 0 ) {
2323                   my $addl = $remaining_exemption > $taxable_per_month
2324                     ? $taxable_per_month
2325                     : $remaining_exemption;
2326                   $taxable_charged -= $addl;
2327
2328                   my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg ( {
2329                     'billpkgnum' => $cust_bill_pkg->billpkgnum,
2330                     'taxnum'     => $tax->taxnum,
2331                     'year'       => 1900+$year,
2332                     'month'      => $mon,
2333                     'amount'     => sprintf("%.2f", $addl ),
2334                   } );
2335                   $error = $cust_tax_exempt_pkg->insert;
2336                   if ( $error ) {
2337                     $dbh->rollback if $oldAutoCommit;
2338                     return "fatal: can't insert cust_tax_exempt_pkg: $error";
2339                   }
2340                 } # if $remaining_exemption > 0
2341
2342                 #++
2343                 $mon++;
2344                 #until ( $mon < 12 ) { $mon -= 12; $year++; }
2345                 until ( $mon < 13 ) { $mon -= 12; $year++; }
2346
2347               } #foreach $which_month
2348
2349             } #if $tax->exempt_amount
2350
2351             $taxable_charged = sprintf( "%.2f", $taxable_charged);
2352
2353             #$tax += $taxable_charged * $cust_main_county->tax / 100
2354             $tax{ $tax->taxname || 'Tax' } +=
2355               $taxable_charged * $tax->tax / 100
2356
2357           } #foreach my $tax ( @taxes )
2358
2359         } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2360
2361       } #if $setup != 0 || $recur != 0
2362
2363     } #if $cust_pkg->modified
2364
2365   } #foreach my $cust_pkg
2366
2367   unless ( $cust_bill->cust_bill_pkg ) {
2368     $cust_bill->delete; #don't create an invoice w/o line items
2369
2370    # XXX this seems to be broken
2371    #( DBD::Pg::st execute failed: ERROR:  syntax error at or near "hcb" )
2372 #   # get rid of our fake history too, waste of unecessary space
2373 #    my $h_cleanup_query = q{
2374 #      DELETE FROM h_cust_bill hcb
2375 #       WHERE hcb.invnum = ?
2376 #      AND NOT EXISTS ( SELECT 1 FROM cust_bill cb where cb.invnum = hcb.invnum )
2377 #    };
2378 #    my $h_sth = $dbh->prepare($h_cleanup_query);
2379 #    $h_sth->execute($invnum);
2380
2381     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2382     return '';
2383   }
2384
2385   my $charged = sprintf( "%.2f", $total_setup + $total_recur );
2386
2387   foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2388     my $tax = sprintf("%.2f", $tax{$taxname} );
2389     $charged = sprintf( "%.2f", $charged+$tax );
2390
2391     my $cust_bill_pkg = new FS::cust_bill_pkg ({
2392       'invnum'   => $invnum,
2393       'pkgnum'   => 0,
2394       'setup'    => $tax,
2395       'recur'    => 0,
2396       'sdate'    => '',
2397       'edate'    => '',
2398       'itemdesc' => $taxname,
2399     });
2400     $error = $cust_bill_pkg->insert;
2401     if ( $error ) {
2402       $dbh->rollback if $oldAutoCommit;
2403       return "can't create invoice line item for invoice #$invnum: $error";
2404     }
2405     $total_setup += $tax;
2406
2407   }
2408
2409   $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2410   $error = $cust_bill->replace;
2411   if ( $error ) {
2412     $dbh->rollback if $oldAutoCommit;
2413     return "can't update charged for invoice #$invnum: $error";
2414   }
2415
2416   foreach my $hook ( @precommit_hooks ) {
2417     eval {
2418       &{$hook}; #($self) ?
2419     };
2420     if ( $@ ) {
2421       $dbh->rollback if $oldAutoCommit;
2422       return "$@ running precommit hook $hook\n";
2423     }
2424   }
2425
2426   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2427   ''; #no error
2428 }
2429
2430 =item collect OPTIONS
2431
2432 (Attempt to) collect money for this customer's outstanding invoices (see
2433 L<FS::cust_bill>).  Usually used after the bill method.
2434
2435 Actions are now triggered by billing events; see L<FS::part_event> and the
2436 billing events web interface.  Old-style invoice events (see
2437 L<FS::part_bill_event>) have been deprecated.
2438
2439 If there is an error, returns the error, otherwise returns false.
2440
2441 Options are passed as name-value pairs.
2442
2443 Currently available options are:
2444
2445 =over 4
2446
2447 =item invoice_time
2448
2449 Use this time when deciding when to print invoices and 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> for conversion functions.
2450
2451 =item retry
2452
2453 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
2454
2455 =item quiet
2456
2457 set true to surpress email card/ACH decline notices.
2458
2459 =item check_freq
2460
2461 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2462
2463 =item payby
2464
2465 allows for one time override of normal customer billing method
2466
2467 =item debug
2468
2469 Debugging level.  Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
2470
2471
2472 =back
2473
2474 =cut
2475
2476 sub collect {
2477   my( $self, %options ) = @_;
2478   my $invoice_time = $options{'invoice_time'} || time;
2479
2480   #put below somehow?
2481   local $SIG{HUP} = 'IGNORE';
2482   local $SIG{INT} = 'IGNORE';
2483   local $SIG{QUIT} = 'IGNORE';
2484   local $SIG{TERM} = 'IGNORE';
2485   local $SIG{TSTP} = 'IGNORE';
2486   local $SIG{PIPE} = 'IGNORE';
2487
2488   my $oldAutoCommit = $FS::UID::AutoCommit;
2489   local $FS::UID::AutoCommit = 0;
2490   my $dbh = dbh;
2491
2492   $self->select_for_update; #mutex
2493
2494   if ( $DEBUG ) {
2495     my $balance = $self->balance;
2496     warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2497   }
2498
2499   if ( exists($options{'retry_card'}) ) {
2500     carp 'retry_card option passed to collect is deprecated; use retry';
2501     $options{'retry'} ||= $options{'retry_card'};
2502   }
2503   if ( exists($options{'retry'}) && $options{'retry'} ) {
2504     my $error = $self->retry_realtime;
2505     if ( $error ) {
2506       $dbh->rollback if $oldAutoCommit;
2507       return $error;
2508     }
2509   }
2510
2511   # false laziness w/pay_batch::import_results
2512
2513   my $due_cust_event = $self->due_cust_event(
2514     'debug'      => ( $options{'debug'} || 0 ),
2515     'time'       => $invoice_time,
2516     'check_freq' => $options{'check_freq'},
2517   );
2518   unless( ref($due_cust_event) ) {
2519     $dbh->rollback if $oldAutoCommit;
2520     return $due_cust_event;
2521   }
2522
2523   foreach my $cust_event ( @$due_cust_event ) {
2524
2525     #XXX lock event
2526
2527     #re-eval event conditions (a previous event could have changed things)
2528     unless ( $cust_event->test_conditions( 'time' => $invoice_time ) ) {
2529       #don't leave stray "new/locked" records around
2530       my $error = $cust_event->delete;
2531       if ( $error ) {
2532         #gah, even with transactions
2533         $dbh->commit if $oldAutoCommit; #well.
2534         return $error;
2535       }
2536       next;
2537     }
2538
2539     {
2540       local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2541       warn "  running cust_event ". $cust_event->eventnum. "\n"
2542         if $DEBUG > 1;
2543
2544
2545       #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2546       if ( my $error = $cust_event->do_event() ) {
2547         #XXX wtf is this?  figure out a proper dealio with return value
2548         #from do_event
2549           # gah, even with transactions.
2550           $dbh->commit if $oldAutoCommit; #well.
2551           return $error;
2552         }
2553     }
2554
2555   }
2556
2557   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2558   '';
2559
2560 }
2561
2562 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2563
2564 Inserts database records for and returns an ordered listref of new events due
2565 for this customer, as FS::cust_event objects (see L<FS::cust_event>).  If no
2566 events are due, an empty listref is returned.  If there is an error, returns a
2567 scalar error message.
2568
2569 To actually run the events, call each event's test_condition method, and if
2570 still true, call the event's do_event method.
2571
2572 Options are passed as a hashref or as a list of name-value pairs.  Available
2573 options are:
2574
2575 =over 4
2576
2577 =item check_freq
2578
2579 Search only for events of this check frequency (how often events of this type are checked); currently "1d" (daily, the default) and "1m" (monthly) are recognized.
2580
2581 =item time
2582
2583 "Current time" for the events.
2584
2585 =item debug
2586
2587 Debugging level.  Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), 3 (more information), or 4 (include full search queries)
2588
2589 =item eventtable
2590
2591 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2592
2593 =item objects
2594
2595 Explicitly pass the objects to be tested (typically used with eventtable).
2596
2597 =back
2598
2599 =cut
2600
2601 sub due_cust_event {
2602   my $self = shift;
2603   my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2604
2605   #???
2606   #my $DEBUG = $opt{'debug'}
2607   local($DEBUG) = $opt{'debug'}
2608     if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
2609
2610   warn "$me due_cust_event called with options ".
2611        join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2612     if $DEBUG;
2613
2614   $opt{'time'} ||= time;
2615
2616   local $SIG{HUP} = 'IGNORE';
2617   local $SIG{INT} = 'IGNORE';
2618   local $SIG{QUIT} = 'IGNORE';
2619   local $SIG{TERM} = 'IGNORE';
2620   local $SIG{TSTP} = 'IGNORE';
2621   local $SIG{PIPE} = 'IGNORE';
2622
2623   my $oldAutoCommit = $FS::UID::AutoCommit;
2624   local $FS::UID::AutoCommit = 0;
2625   my $dbh = dbh;
2626
2627   $self->select_for_update; #mutex
2628
2629   ###
2630   # 1: find possible events (initial search)
2631   ###
2632
2633   my @cust_event = ();
2634
2635   my @eventtable = $opt{'eventtable'}
2636                      ? ( $opt{'eventtable'} )
2637                      : FS::part_event->eventtables_runorder;
2638
2639   foreach my $eventtable ( @eventtable ) {
2640
2641     my @objects;
2642     if ( $opt{'objects'} ) {
2643
2644       @objects = @{ $opt{'objects'} };
2645
2646     } else {
2647
2648       #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
2649       @objects = ( $eventtable eq 'cust_main' )
2650                    ? ( $self )
2651                    : ( $self->$eventtable() );
2652
2653     }
2654
2655     my @e_cust_event = ();
2656
2657     my $cross = "CROSS JOIN $eventtable";
2658     $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2659       unless $eventtable eq 'cust_main';
2660
2661     foreach my $object ( @objects ) {
2662
2663       #this first search uses the condition_sql magic for optimization.
2664       #the more possible events we can eliminate in this step the better
2665
2666       my $cross_where = '';
2667       my $pkey = $object->primary_key;
2668       $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2669
2670       my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2671       my $extra_sql =
2672         FS::part_event_condition->where_conditions_sql( $eventtable,
2673                                                         'time'=>$opt{'time'}
2674                                                       );
2675       my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2676
2677       $extra_sql = "AND $extra_sql" if $extra_sql;
2678
2679       #here is the agent virtualization
2680       $extra_sql .= " AND (    part_event.agentnum IS NULL
2681                             OR part_event.agentnum = ". $self->agentnum. ' )';
2682
2683       $extra_sql .= " $order";
2684
2685       warn "searching for events for $eventtable ". $object->$pkey. "\n"
2686         if $opt{'debug'} > 2;
2687       my @part_event = qsearch( {
2688         'debug'     => ( $opt{'debug'} > 3 ? 1 : 0 ),
2689         'select'    => 'part_event.*',
2690         'table'     => 'part_event',
2691         'addl_from' => "$cross $join",
2692         'hashref'   => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
2693                          'eventtable' => $eventtable,
2694                          'disabled'   => '',
2695                        },
2696         'extra_sql' => "AND $cross_where $extra_sql",
2697       } );
2698
2699       if ( $DEBUG > 2 ) {
2700         my $pkey = $object->primary_key;
2701         warn "      ". scalar(@part_event).
2702              " possible events found for $eventtable ". $object->$pkey(). "\n";
2703       }
2704
2705       push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
2706
2707     }
2708
2709     warn "    ". scalar(@e_cust_event).
2710          " subtotal possible cust events found for $eventtable\n"
2711       if $DEBUG > 1;
2712
2713     push @cust_event, @e_cust_event;
2714
2715   }
2716
2717   warn "  ". scalar(@cust_event).
2718        " total possible cust events found in initial search\n"
2719     if $DEBUG; # > 1;
2720
2721   ##
2722   # 2: test conditions
2723   ##
2724
2725   my %unsat = ();
2726
2727   @cust_event = grep $_->test_conditions( 'time'          => $opt{'time'},
2728                                           'stats_hashref' => \%unsat ),
2729                      @cust_event;
2730
2731   warn "  ". scalar(@cust_event). " cust events left satisfying conditions\n"
2732     if $DEBUG; # > 1;
2733
2734   warn "    invalid conditions not eliminated with condition_sql:\n".
2735        join('', map "      $_: ".$unsat{$_}."\n", keys %unsat )
2736     if $DEBUG; # > 1;
2737
2738   ##
2739   # 3: insert
2740   ##
2741
2742   foreach my $cust_event ( @cust_event ) {
2743
2744     my $error = $cust_event->insert();
2745     if ( $error ) {
2746       $dbh->rollback if $oldAutoCommit;
2747       return $error;
2748     }
2749
2750   }
2751
2752   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2753
2754   ##
2755   # 4: return
2756   ##
2757
2758   warn "  returning events: ". Dumper(@cust_event). "\n"
2759     if $DEBUG > 2;
2760
2761   \@cust_event;
2762
2763 }
2764
2765 =item retry_realtime
2766
2767 Schedules realtime / batch  credit card / electronic check / LEC billing
2768 events for for retry.  Useful if card information has changed or manual
2769 retry is desired.  The 'collect' method must be called to actually retry
2770 the transaction.
2771
2772 Implementation details: For either this customer, or for each of this
2773 customer's open invoices, changes the status of the first "done" (with
2774 statustext error) realtime processing event to "failed".
2775
2776 =cut
2777
2778 sub retry_realtime {
2779   my $self = shift;
2780
2781   local $SIG{HUP} = 'IGNORE';
2782   local $SIG{INT} = 'IGNORE';
2783   local $SIG{QUIT} = 'IGNORE';
2784   local $SIG{TERM} = 'IGNORE';
2785   local $SIG{TSTP} = 'IGNORE';
2786   local $SIG{PIPE} = 'IGNORE';
2787
2788   my $oldAutoCommit = $FS::UID::AutoCommit;
2789   local $FS::UID::AutoCommit = 0;
2790   my $dbh = dbh;
2791
2792   #a little false laziness w/due_cust_event (not too bad, really)
2793
2794   my $join = FS::part_event_condition->join_conditions_sql;
2795   my $order = FS::part_event_condition->order_conditions_sql;
2796   my $mine =
2797   '( '
2798    . join ( ' OR ' , map {
2799     "( part_event.eventtable = " . dbh->quote($_)
2800     . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
2801    } FS::part_event->eventtables)
2802    . ') ';
2803
2804   #here is the agent virtualization
2805   my $agent_virt = " (    part_event.agentnum IS NULL
2806                        OR part_event.agentnum = ". $self->agentnum. ' )';
2807
2808   #XXX this shouldn't be hardcoded, actions should declare it...
2809   my @realtime_events = qw(
2810     cust_bill_realtime_card
2811     cust_bill_realtime_check
2812     cust_bill_realtime_lec
2813     cust_bill_batch
2814   );
2815
2816   my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
2817                                                   @realtime_events
2818                                      ).
2819                           ' ) ';
2820
2821   my @cust_event = qsearchs({
2822     'table'     => 'cust_event',
2823     'select'    => 'cust_event.*',
2824     'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
2825     'hashref'   => { 'status' => 'done' },
2826     'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
2827                    " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
2828   });
2829
2830   my %seen_invnum = ();
2831   foreach my $cust_event (@cust_event) {
2832
2833     #max one for the customer, one for each open invoice
2834     my $cust_X = $cust_event->cust_X;
2835     next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
2836                           ? $cust_X->invnum
2837                           : 0
2838                         }++
2839          or $cust_event->part_event->eventtable eq 'cust_bill'
2840             && ! $cust_X->owed;
2841
2842     my $error = $cust_event->retry;
2843     if ( $error ) {
2844       $dbh->rollback if $oldAutoCommit;
2845       return "error scheduling event for retry: $error";
2846     }
2847
2848   }
2849
2850   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2851   '';
2852
2853 }
2854
2855 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2856
2857 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2858 via a Business::OnlinePayment realtime gateway.  See
2859 L<http://420.am/business-onlinepayment> for supported gateways.
2860
2861 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2862
2863 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>
2864
2865 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2866 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
2867 if set, will override the value from the customer record.
2868
2869 I<description> is a free-text field passed to the gateway.  It defaults to
2870 "Internet services".
2871
2872 If an I<invnum> is specified, this payment (if successful) is applied to the
2873 specified invoice.  If you don't specify an I<invnum> you might want to
2874 call the B<apply_payments> method.
2875
2876 I<quiet> can be set true to surpress email decline notices.
2877
2878 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
2879 resulting paynum, if any.
2880
2881 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2882
2883 =cut
2884
2885 sub realtime_bop {
2886   my( $self, $method, $amount, %options ) = @_;
2887   if ( $DEBUG ) {
2888     warn "$me realtime_bop: $method $amount\n";
2889     warn "  $_ => $options{$_}\n" foreach keys %options;
2890   }
2891
2892   $options{'description'} ||= 'Internet services';
2893
2894   return $self->fake_bop($method, $amount, %options) if $options{'fake'};
2895
2896   eval "use Business::OnlinePayment";
2897   die $@ if $@;
2898
2899   my $payinfo = exists($options{'payinfo'})
2900                   ? $options{'payinfo'}
2901                   : $self->payinfo;
2902
2903   my %method2payby = (
2904     'CC'     => 'CARD',
2905     'ECHECK' => 'CHEK',
2906     'LEC'    => 'LECB',
2907   );
2908
2909   ###
2910   # check for banned credit card/ACH
2911   ###
2912
2913   my $ban = qsearchs('banned_pay', {
2914     'payby'   => $method2payby{$method},
2915     'payinfo' => md5_base64($payinfo),
2916   } );
2917   return "Banned credit card" if $ban;
2918
2919   ###
2920   # select a gateway
2921   ###
2922
2923   my $taxclass = '';
2924   if ( $options{'invnum'} ) {
2925     my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2926     die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2927     my @taxclasses =
2928       map  { $_->part_pkg->taxclass }
2929       grep { $_ }
2930       map  { $_->cust_pkg }
2931       $cust_bill->cust_bill_pkg;
2932     unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2933                                                            #different taxclasses
2934       $taxclass = $taxclasses[0];
2935     }
2936   }
2937
2938   #look for an agent gateway override first
2939   my $cardtype;
2940   if ( $method eq 'CC' ) {
2941     $cardtype = cardtype($payinfo);
2942   } elsif ( $method eq 'ECHECK' ) {
2943     $cardtype = 'ACH';
2944   } else {
2945     $cardtype = $method;
2946   }
2947
2948   my $override =
2949        qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2950                                            cardtype => $cardtype,
2951                                            taxclass => $taxclass,       } )
2952     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2953                                            cardtype => '',
2954                                            taxclass => $taxclass,       } )
2955     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2956                                            cardtype => $cardtype,
2957                                            taxclass => '',              } )
2958     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2959                                            cardtype => '',
2960                                            taxclass => '',              } );
2961
2962   my $payment_gateway = '';
2963   my( $processor, $login, $password, $action, @bop_options );
2964   if ( $override ) { #use a payment gateway override
2965
2966     $payment_gateway = $override->payment_gateway;
2967
2968     $processor   = $payment_gateway->gateway_module;
2969     $login       = $payment_gateway->gateway_username;
2970     $password    = $payment_gateway->gateway_password;
2971     $action      = $payment_gateway->gateway_action;
2972     @bop_options = $payment_gateway->options;
2973
2974   } else { #use the standard settings from the config
2975
2976     ( $processor, $login, $password, $action, @bop_options ) =
2977       $self->default_payment_gateway($method);
2978
2979   }
2980
2981   ###
2982   # massage data
2983   ###
2984
2985   my $address = exists($options{'address1'})
2986                     ? $options{'address1'}
2987                     : $self->address1;
2988   my $address2 = exists($options{'address2'})
2989                     ? $options{'address2'}
2990                     : $self->address2;
2991   $address .= ", ". $address2 if length($address2);
2992
2993   my $o_payname = exists($options{'payname'})
2994                     ? $options{'payname'}
2995                     : $self->payname;
2996   my($payname, $payfirst, $paylast);
2997   if ( $o_payname && $method ne 'ECHECK' ) {
2998     ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2999       or return "Illegal payname $payname";
3000     ($payfirst, $paylast) = ($1, $2);
3001   } else {
3002     $payfirst = $self->getfield('first');
3003     $paylast = $self->getfield('last');
3004     $payname =  "$payfirst $paylast";
3005   }
3006
3007   my @invoicing_list = $self->invoicing_list_emailonly;
3008   if ( $conf->exists('emailinvoiceautoalways')
3009        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3010        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3011     push @invoicing_list, $self->all_emails;
3012   }
3013
3014   my $email = ($conf->exists('business-onlinepayment-email-override'))
3015               ? $conf->config('business-onlinepayment-email-override')
3016               : $invoicing_list[0];
3017
3018   my %content = ();
3019
3020   my $payip = exists($options{'payip'})
3021                 ? $options{'payip'}
3022                 : $self->payip;
3023   $content{customer_ip} = $payip
3024     if length($payip);
3025
3026   $content{invoice_number} = $options{'invnum'}
3027     if exists($options{'invnum'}) && length($options{'invnum'});
3028
3029   my $paydate = '';
3030   if ( $method eq 'CC' ) {
3031
3032     $content{card_number} = $payinfo;
3033     $paydate = exists($options{'paydate'})
3034                     ? $options{'paydate'}
3035                     : $self->paydate;
3036     $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3037     $content{expiration} = "$2/$1";
3038
3039     my $paycvv = exists($options{'paycvv'})
3040                    ? $options{'paycvv'}
3041                    : $self->paycvv;
3042     $content{cvv2} = $self->paycvv
3043       if length($paycvv);
3044
3045     my $paystart_month = exists($options{'paystart_month'})
3046                            ? $options{'paystart_month'}
3047                            : $self->paystart_month;
3048
3049     my $paystart_year  = exists($options{'paystart_year'})
3050                            ? $options{'paystart_year'}
3051                            : $self->paystart_year;
3052
3053     $content{card_start} = "$paystart_month/$paystart_year"
3054       if $paystart_month && $paystart_year;
3055
3056     my $payissue       = exists($options{'payissue'})
3057                            ? $options{'payissue'}
3058                            : $self->payissue;
3059     $content{issue_number} = $payissue if $payissue;
3060
3061     $content{recurring_billing} = 'YES'
3062       if qsearch('cust_pay', { 'custnum' => $self->custnum,
3063                                'payby'   => 'CARD',
3064                                'payinfo' => $payinfo,
3065                              } )
3066       || qsearch('cust_pay', { 'custnum' => $self->custnum,
3067                                'payby'   => 'CARD',
3068                                'paymask' => $self->mask_payinfo('CARD', $payinfo),
3069                              } );
3070
3071
3072   } elsif ( $method eq 'ECHECK' ) {
3073     ( $content{account_number}, $content{routing_code} ) =
3074       split('@', $payinfo);
3075     $content{bank_name} = $o_payname;
3076     $content{bank_state} = exists($options{'paystate'})
3077                              ? $options{'paystate'}
3078                              : $self->getfield('paystate');
3079     $content{account_type} = exists($options{'paytype'})
3080                                ? uc($options{'paytype'}) || 'CHECKING'
3081                                : uc($self->getfield('paytype')) || 'CHECKING';
3082     $content{account_name} = $payname;
3083     $content{customer_org} = $self->company ? 'B' : 'I';
3084     $content{state_id}       = exists($options{'stateid'})
3085                                  ? $options{'stateid'}
3086                                  : $self->getfield('stateid');
3087     $content{state_id_state} = exists($options{'stateid_state'})
3088                                  ? $options{'stateid_state'}
3089                                  : $self->getfield('stateid_state');
3090     $content{customer_ssn} = exists($options{'ss'})
3091                                ? $options{'ss'}
3092                                : $self->ss;
3093   } elsif ( $method eq 'LEC' ) {
3094     $content{phone} = $payinfo;
3095   }
3096
3097   ###
3098   # run transaction(s)
3099   ###
3100
3101   my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3102
3103   my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3104   $transaction->content(
3105     'type'           => $method,
3106     'login'          => $login,
3107     'password'       => $password,
3108     'action'         => $action1,
3109     'description'    => $options{'description'},
3110     'amount'         => $amount,
3111     #'invoice_number' => $options{'invnum'},
3112     'customer_id'    => $self->custnum,
3113     'last_name'      => $paylast,
3114     'first_name'     => $payfirst,
3115     'name'           => $payname,
3116     'address'        => $address,
3117     'city'           => ( exists($options{'city'})
3118                             ? $options{'city'}
3119                             : $self->city          ),
3120     'state'          => ( exists($options{'state'})
3121                             ? $options{'state'}
3122                             : $self->state          ),
3123     'zip'            => ( exists($options{'zip'})
3124                             ? $options{'zip'}
3125                             : $self->zip          ),
3126     'country'        => ( exists($options{'country'})
3127                             ? $options{'country'}
3128                             : $self->country          ),
3129     'referer'        => 'http://cleanwhisker.420.am/',
3130     'email'          => $email,
3131     'phone'          => $self->daytime || $self->night,
3132     %content, #after
3133   );
3134   $transaction->submit();
3135
3136   if ( $transaction->is_success() && $action2 ) {
3137     my $auth = $transaction->authorization;
3138     my $ordernum = $transaction->can('order_number')
3139                    ? $transaction->order_number
3140                    : '';
3141
3142     my $capture =
3143       new Business::OnlinePayment( $processor, @bop_options );
3144
3145     my %capture = (
3146       %content,
3147       type           => $method,
3148       action         => $action2,
3149       login          => $login,
3150       password       => $password,
3151       order_number   => $ordernum,
3152       amount         => $amount,
3153       authorization  => $auth,
3154       description    => $options{'description'},
3155     );
3156
3157     foreach my $field (qw( authorization_source_code returned_ACI
3158                            transaction_identifier validation_code
3159                            transaction_sequence_num local_transaction_date
3160                            local_transaction_time AVS_result_code          )) {
3161       $capture{$field} = $transaction->$field() if $transaction->can($field);
3162     }
3163
3164     $capture->content( %capture );
3165
3166     $capture->submit();
3167
3168     unless ( $capture->is_success ) {
3169       my $e = "Authorization successful but capture failed, custnum #".
3170               $self->custnum. ': '.  $capture->result_code.
3171               ": ". $capture->error_message;
3172       warn $e;
3173       return $e;
3174     }
3175
3176   }
3177
3178   ###
3179   # remove paycvv after initial transaction
3180   ###
3181
3182   #false laziness w/misc/process/payment.cgi - check both to make sure working
3183   # correctly
3184   if ( defined $self->dbdef_table->column('paycvv')
3185        && length($self->paycvv)
3186        && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3187   ) {
3188     my $error = $self->remove_cvv;
3189     if ( $error ) {
3190       warn "WARNING: error removing cvv: $error\n";
3191     }
3192   }
3193
3194   ###
3195   # result handling
3196   ###
3197
3198   if ( $transaction->is_success() ) {
3199
3200     my %method2payby = (
3201       'CC'     => 'CARD',
3202       'ECHECK' => 'CHEK',
3203       'LEC'    => 'LECB',
3204     );
3205
3206     my $paybatch = '';
3207     if ( $payment_gateway ) { # agent override
3208       $paybatch = $payment_gateway->gatewaynum. '-';
3209     }
3210
3211     $paybatch .= "$processor:". $transaction->authorization;
3212
3213     $paybatch .= ':'. $transaction->order_number
3214       if $transaction->can('order_number')
3215       && length($transaction->order_number);
3216
3217     my $cust_pay = new FS::cust_pay ( {
3218        'custnum'  => $self->custnum,
3219        'invnum'   => $options{'invnum'},
3220        'paid'     => $amount,
3221        '_date'    => '',
3222        'payby'    => $method2payby{$method},
3223        'payinfo'  => $payinfo,
3224        'paybatch' => $paybatch,
3225        'paydate'  => $paydate,
3226     } );
3227     $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
3228
3229     my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3230
3231     if ( $error ) {
3232       $cust_pay->invnum(''); #try again with no specific invnum
3233       my $error2 = $cust_pay->insert( $options{'manual'} ?
3234                                       ( 'manual' => 1 ) : ()
3235                                     );
3236       if ( $error2 ) {
3237         # gah, even with transactions.
3238         my $e = 'WARNING: Card/ACH debited but database not updated - '.
3239                 "error inserting payment ($processor): $error2".
3240                 " (previously tried insert with invnum #$options{'invnum'}" .
3241                 ": $error )";
3242         warn $e;
3243         return $e;
3244       }
3245     }
3246
3247     if ( $options{'paynum_ref'} ) {
3248       ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3249     }
3250
3251     return ''; #no error
3252
3253   } else {
3254
3255     my $perror = "$processor error: ". $transaction->error_message;
3256
3257     unless ( $transaction->error_message ) {
3258
3259       my $t_response;
3260       if ( $transaction->can('response_page') ) {
3261         $t_response = {
3262                         'page'    => ( $transaction->can('response_page')
3263                                          ? $transaction->response_page
3264                                          : ''
3265                                      ),
3266                         'code'    => ( $transaction->can('response_code')
3267                                          ? $transaction->response_code
3268                                          : ''
3269                                      ),
3270                         'headers' => ( $transaction->can('response_headers')
3271                                          ? $transaction->response_headers
3272                                          : ''
3273                                      ),
3274                       };
3275       } else {
3276         $t_response .=
3277           "No additional debugging information available for $processor";
3278       }
3279
3280       $perror .= "No error_message returned from $processor -- ".
3281                  ( ref($t_response) ? Dumper($t_response) : $t_response );
3282
3283     }
3284
3285     if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
3286          && $conf->exists('emaildecline')
3287          && grep { $_ ne 'POST' } $self->invoicing_list
3288          && ! grep { $transaction->error_message =~ /$_/ }
3289                    $conf->config('emaildecline-exclude')
3290     ) {
3291       my @templ = $conf->config('declinetemplate');
3292       my $template = new Text::Template (
3293         TYPE   => 'ARRAY',
3294         SOURCE => [ map "$_\n", @templ ],
3295       ) or return "($perror) can't create template: $Text::Template::ERROR";
3296       $template->compile()
3297         or return "($perror) can't compile template: $Text::Template::ERROR";
3298
3299       my $templ_hash = { error => $transaction->error_message };
3300
3301       my $error = send_email(
3302         'from'    => $conf->config('invoice_from'),
3303         'to'      => [ grep { $_ ne 'POST' } $self->invoicing_list ],
3304         'subject' => 'Your payment could not be processed',
3305         'body'    => [ $template->fill_in(HASH => $templ_hash) ],
3306       );
3307
3308       $perror .= " (also received error sending decline notification: $error)"
3309         if $error;
3310
3311     }
3312
3313     return $perror;
3314   }
3315
3316 }
3317
3318 =item fake_bop
3319
3320 =cut
3321
3322 sub fake_bop {
3323   my( $self, $method, $amount, %options ) = @_;
3324
3325   if ( $options{'fake_failure'} ) {
3326      return "Error: No error; test failure requested with fake_failure";
3327   }
3328
3329   my %method2payby = (
3330     'CC'     => 'CARD',
3331     'ECHECK' => 'CHEK',
3332     'LEC'    => 'LECB',
3333   );
3334
3335   #my $paybatch = '';
3336   #if ( $payment_gateway ) { # agent override
3337   #  $paybatch = $payment_gateway->gatewaynum. '-';
3338   #}
3339   #
3340   #$paybatch .= "$processor:". $transaction->authorization;
3341   #
3342   #$paybatch .= ':'. $transaction->order_number
3343   #  if $transaction->can('order_number')
3344   #  && length($transaction->order_number);
3345
3346   my $paybatch = 'FakeProcessor:54:32';
3347
3348   my $cust_pay = new FS::cust_pay ( {
3349      'custnum'  => $self->custnum,
3350      'invnum'   => $options{'invnum'},
3351      'paid'     => $amount,
3352      '_date'    => '',
3353      'payby'    => $method2payby{$method},
3354      #'payinfo'  => $payinfo,
3355      'payinfo'  => '4111111111111111',
3356      'paybatch' => $paybatch,
3357      #'paydate'  => $paydate,
3358      'paydate'  => '2012-05-01',
3359   } );
3360   $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
3361
3362   my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3363
3364   if ( $error ) {
3365     $cust_pay->invnum(''); #try again with no specific invnum
3366     my $error2 = $cust_pay->insert( $options{'manual'} ?
3367                                     ( 'manual' => 1 ) : ()
3368                                   );
3369     if ( $error2 ) {
3370       # gah, even with transactions.
3371       my $e = 'WARNING: Card/ACH debited but database not updated - '.
3372               "error inserting (fake!) payment: $error2".
3373               " (previously tried insert with invnum #$options{'invnum'}" .
3374               ": $error )";
3375       warn $e;
3376       return $e;
3377     }
3378   }
3379
3380   if ( $options{'paynum_ref'} ) {
3381     ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3382   }
3383
3384   return ''; #no error
3385
3386 }
3387
3388 =item default_payment_gateway
3389
3390 =cut
3391
3392 sub default_payment_gateway {
3393   my( $self, $method ) = @_;
3394
3395   die "Real-time processing not enabled\n"
3396     unless $conf->exists('business-onlinepayment');
3397
3398   #load up config
3399   my $bop_config = 'business-onlinepayment';
3400   $bop_config .= '-ach'
3401     if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
3402   my ( $processor, $login, $password, $action, @bop_options ) =
3403     $conf->config($bop_config);
3404   $action ||= 'normal authorization';
3405   pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3406   die "No real-time processor is enabled - ".
3407       "did you set the business-onlinepayment configuration value?\n"
3408     unless $processor;
3409
3410   ( $processor, $login, $password, $action, @bop_options )
3411 }
3412
3413 =item remove_cvv
3414
3415 Removes the I<paycvv> field from the database directly.
3416
3417 If there is an error, returns the error, otherwise returns false.
3418
3419 =cut
3420
3421 sub remove_cvv {
3422   my $self = shift;
3423   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3424     or return dbh->errstr;
3425   $sth->execute($self->custnum)
3426     or return $sth->errstr;
3427   $self->paycvv('');
3428   '';
3429 }
3430
3431 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3432
3433 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3434 via a Business::OnlinePayment realtime gateway.  See
3435 L<http://420.am/business-onlinepayment> for supported gateways.
3436
3437 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3438
3439 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3440
3441 Most gateways require a reference to an original payment transaction to refund,
3442 so you probably need to specify a I<paynum>.
3443
3444 I<amount> defaults to the original amount of the payment if not specified.
3445
3446 I<reason> specifies a reason for the refund.
3447
3448 I<paydate> specifies the expiration date for a credit card overriding the
3449 value from the customer record or the payment record. Specified as yyyy-mm-dd
3450
3451 Implementation note: If I<amount> is unspecified or equal to the amount of the
3452 orignal payment, first an attempt is made to "void" the transaction via
3453 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3454 the normal attempt is made to "refund" ("credit") the transaction via the
3455 gateway is attempted.
3456
3457 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3458 #I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
3459 #if set, will override the value from the customer record.
3460
3461 #If an I<invnum> is specified, this payment (if successful) is applied to the
3462 #specified invoice.  If you don't specify an I<invnum> you might want to
3463 #call the B<apply_payments> method.
3464
3465 =cut
3466
3467 #some false laziness w/realtime_bop, not enough to make it worth merging
3468 #but some useful small subs should be pulled out
3469 sub realtime_refund_bop {
3470   my( $self, $method, %options ) = @_;
3471   if ( $DEBUG ) {
3472     warn "$me realtime_refund_bop: $method refund\n";
3473     warn "  $_ => $options{$_}\n" foreach keys %options;
3474   }
3475
3476   eval "use Business::OnlinePayment";
3477   die $@ if $@;
3478
3479   ###
3480   # look up the original payment and optionally a gateway for that payment
3481   ###
3482
3483   my $cust_pay = '';
3484   my $amount = $options{'amount'};
3485
3486   my( $processor, $login, $password, @bop_options ) ;
3487   my( $auth, $order_number ) = ( '', '', '' );
3488
3489   if ( $options{'paynum'} ) {
3490
3491     warn "  paynum: $options{paynum}\n" if $DEBUG > 1;
3492     $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3493       or return "Unknown paynum $options{'paynum'}";
3494     $amount ||= $cust_pay->paid;
3495
3496     $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3497       or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3498                 $cust_pay->paybatch;
3499     my $gatewaynum = '';
3500     ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3501
3502     if ( $gatewaynum ) { #gateway for the payment to be refunded
3503
3504       my $payment_gateway =
3505         qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3506       die "payment gateway $gatewaynum not found"
3507         unless $payment_gateway;
3508
3509       $processor   = $payment_gateway->gateway_module;
3510       $login       = $payment_gateway->gateway_username;
3511       $password    = $payment_gateway->gateway_password;
3512       @bop_options = $payment_gateway->options;
3513
3514     } else { #try the default gateway
3515
3516       my( $conf_processor, $unused_action );
3517       ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3518         $self->default_payment_gateway($method);
3519
3520       return "processor of payment $options{'paynum'} $processor does not".
3521              " match default processor $conf_processor"
3522         unless $processor eq $conf_processor;
3523
3524     }
3525
3526
3527   } else { # didn't specify a paynum, so look for agent gateway overrides
3528            # like a normal transaction
3529
3530     my $cardtype;
3531     if ( $method eq 'CC' ) {
3532       $cardtype = cardtype($self->payinfo);
3533     } elsif ( $method eq 'ECHECK' ) {
3534       $cardtype = 'ACH';
3535     } else {
3536       $cardtype = $method;
3537     }
3538     my $override =
3539            qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3540                                                cardtype => $cardtype,
3541                                                taxclass => '',              } )
3542         || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3543                                                cardtype => '',
3544                                                taxclass => '',              } );
3545
3546     if ( $override ) { #use a payment gateway override
3547
3548       my $payment_gateway = $override->payment_gateway;
3549
3550       $processor   = $payment_gateway->gateway_module;
3551       $login       = $payment_gateway->gateway_username;
3552       $password    = $payment_gateway->gateway_password;
3553       #$action      = $payment_gateway->gateway_action;
3554       @bop_options = $payment_gateway->options;
3555
3556     } else { #use the standard settings from the config
3557
3558       my $unused_action;
3559       ( $processor, $login, $password, $unused_action, @bop_options ) =
3560         $self->default_payment_gateway($method);
3561
3562     }
3563
3564   }
3565   return "neither amount nor paynum specified" unless $amount;
3566
3567   my %content = (
3568     'type'           => $method,
3569     'login'          => $login,
3570     'password'       => $password,
3571     'order_number'   => $order_number,
3572     'amount'         => $amount,
3573     'referer'        => 'http://cleanwhisker.420.am/',
3574   );
3575   $content{authorization} = $auth
3576     if length($auth); #echeck/ACH transactions have an order # but no auth
3577                       #(at least with authorize.net)
3578
3579   my $disable_void_after;
3580   if ($conf->exists('disable_void_after')
3581       && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3582     $disable_void_after = $1;
3583   }
3584
3585   #first try void if applicable
3586   if ( $cust_pay && $cust_pay->paid == $amount
3587     && (
3588       ( not defined($disable_void_after) )
3589       || ( time < ($cust_pay->_date + $disable_void_after ) )
3590     )
3591   ) {
3592     warn "  attempting void\n" if $DEBUG > 1;
3593     my $void = new Business::OnlinePayment( $processor, @bop_options );
3594     $void->content( 'action' => 'void', %content );
3595     $void->submit();
3596     if ( $void->is_success ) {
3597       my $error = $cust_pay->void($options{'reason'});
3598       if ( $error ) {
3599         # gah, even with transactions.
3600         my $e = 'WARNING: Card/ACH voided but database not updated - '.
3601                 "error voiding payment: $error";
3602         warn $e;
3603         return $e;
3604       }
3605       warn "  void successful\n" if $DEBUG > 1;
3606       return '';
3607     }
3608   }
3609
3610   warn "  void unsuccessful, trying refund\n"
3611     if $DEBUG > 1;
3612
3613   #massage data
3614   my $address = $self->address1;
3615   $address .= ", ". $self->address2 if $self->address2;
3616
3617   my($payname, $payfirst, $paylast);
3618   if ( $self->payname && $method ne 'ECHECK' ) {
3619     $payname = $self->payname;
3620     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3621       or return "Illegal payname $payname";
3622     ($payfirst, $paylast) = ($1, $2);
3623   } else {
3624     $payfirst = $self->getfield('first');
3625     $paylast = $self->getfield('last');
3626     $payname =  "$payfirst $paylast";
3627   }
3628
3629   my @invoicing_list = $self->invoicing_list_emailonly;
3630   if ( $conf->exists('emailinvoiceautoalways')
3631        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3632        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3633     push @invoicing_list, $self->all_emails;
3634   }
3635
3636   my $email = ($conf->exists('business-onlinepayment-email-override'))
3637               ? $conf->config('business-onlinepayment-email-override')
3638               : $invoicing_list[0];
3639
3640   my $payip = exists($options{'payip'})
3641                 ? $options{'payip'}
3642                 : $self->payip;
3643   $content{customer_ip} = $payip
3644     if length($payip);
3645
3646   my $payinfo = '';
3647   if ( $method eq 'CC' ) {
3648
3649     if ( $cust_pay ) {
3650       $content{card_number} = $payinfo = $cust_pay->payinfo;
3651       (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
3652         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
3653         ($content{expiration} = "$2/$1");  # where available
3654     } else {
3655       $content{card_number} = $payinfo = $self->payinfo;
3656       (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
3657         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3658       $content{expiration} = "$2/$1";
3659     }
3660
3661   } elsif ( $method eq 'ECHECK' ) {
3662
3663     if ( $cust_pay ) {
3664       $payinfo = $cust_pay->payinfo;
3665     } else {
3666       $payinfo = $self->payinfo;
3667     }
3668     ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
3669     $content{bank_name} = $self->payname;
3670     $content{account_type} = 'CHECKING';
3671     $content{account_name} = $payname;
3672     $content{customer_org} = $self->company ? 'B' : 'I';
3673     $content{customer_ssn} = $self->ss;
3674   } elsif ( $method eq 'LEC' ) {
3675     $content{phone} = $payinfo = $self->payinfo;
3676   }
3677
3678   #then try refund
3679   my $refund = new Business::OnlinePayment( $processor, @bop_options );
3680   my %sub_content = $refund->content(
3681     'action'         => 'credit',
3682     'customer_id'    => $self->custnum,
3683     'last_name'      => $paylast,
3684     'first_name'     => $payfirst,
3685     'name'           => $payname,
3686     'address'        => $address,
3687     'city'           => $self->city,
3688     'state'          => $self->state,
3689     'zip'            => $self->zip,
3690     'country'        => $self->country,
3691     'email'          => $email,
3692     'phone'          => $self->daytime || $self->night,
3693     %content, #after
3694   );
3695   warn join('', map { "  $_ => $sub_content{$_}\n" } keys %sub_content )
3696     if $DEBUG > 1;
3697   $refund->submit();
3698
3699   return "$processor error: ". $refund->error_message
3700     unless $refund->is_success();
3701
3702   my %method2payby = (
3703     'CC'     => 'CARD',
3704     'ECHECK' => 'CHEK',
3705     'LEC'    => 'LECB',
3706   );
3707
3708   my $paybatch = "$processor:". $refund->authorization;
3709   $paybatch .= ':'. $refund->order_number
3710     if $refund->can('order_number') && $refund->order_number;
3711
3712   while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3713     my @cust_bill_pay = $cust_pay->cust_bill_pay;
3714     last unless @cust_bill_pay;
3715     my $cust_bill_pay = pop @cust_bill_pay;
3716     my $error = $cust_bill_pay->delete;
3717     last if $error;
3718   }
3719
3720   my $cust_refund = new FS::cust_refund ( {
3721     'custnum'  => $self->custnum,
3722     'paynum'   => $options{'paynum'},
3723     'refund'   => $amount,
3724     '_date'    => '',
3725     'payby'    => $method2payby{$method},
3726     'payinfo'  => $payinfo,
3727     'paybatch' => $paybatch,
3728     'reason'   => $options{'reason'} || 'card or ACH refund',
3729   } );
3730   my $error = $cust_refund->insert;
3731   if ( $error ) {
3732     $cust_refund->paynum(''); #try again with no specific paynum
3733     my $error2 = $cust_refund->insert;
3734     if ( $error2 ) {
3735       # gah, even with transactions.
3736       my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3737               "error inserting refund ($processor): $error2".
3738               " (previously tried insert with paynum #$options{'paynum'}" .
3739               ": $error )";
3740       warn $e;
3741       return $e;
3742     }
3743   }
3744
3745   ''; #no error
3746
3747 }
3748
3749 =item batch_card OPTION => VALUE...
3750
3751 Adds a payment for this invoice to the pending credit card batch (see
3752 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
3753 runs the payment using a realtime gateway.
3754
3755 =cut
3756
3757 sub batch_card {
3758   my ($self, %options) = @_;
3759
3760   my $amount;
3761   if (exists($options{amount})) {
3762     $amount = $options{amount};
3763   }else{
3764     $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
3765   }
3766   return '' unless $amount > 0;
3767
3768   my $invnum = delete $options{invnum};
3769   my $payby = $options{invnum} || $self->payby;  #dubious
3770
3771   if ($options{'realtime'}) {
3772     return $self->realtime_bop( FS::payby->payby2bop($self->payby),
3773                                 $amount,
3774                                 %options,
3775                               );
3776   }
3777
3778   my $oldAutoCommit = $FS::UID::AutoCommit;
3779   local $FS::UID::AutoCommit = 0;
3780   my $dbh = dbh;
3781
3782   $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
3783     or return "Cannot lock pay_batch: " . $dbh->errstr;
3784
3785   my %pay_batch = (
3786     'status' => 'O',
3787     'payby'  => FS::payby->payby2payment($payby),
3788   );
3789
3790   my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
3791
3792   unless ( $pay_batch ) {
3793     $pay_batch = new FS::pay_batch \%pay_batch;
3794     my $error = $pay_batch->insert;
3795     if ( $error ) {
3796       $dbh->rollback if $oldAutoCommit;
3797       die "error creating new batch: $error\n";
3798     }
3799   }
3800
3801   my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
3802       'batchnum' => $pay_batch->batchnum,
3803       'custnum'  => $self->custnum,
3804   } );
3805
3806   foreach (qw( address1 address2 city state zip country payby payinfo paydate
3807                payname )) {
3808     $options{$_} = '' unless exists($options{$_});
3809   }
3810
3811   my $cust_pay_batch = new FS::cust_pay_batch ( {
3812     'batchnum' => $pay_batch->batchnum,
3813     'invnum'   => $invnum || 0,                    # is there a better value?
3814                                                    # this field should be
3815                                                    # removed...
3816                                                    # cust_bill_pay_batch now
3817     'custnum'  => $self->custnum,
3818     'last'     => $self->getfield('last'),
3819     'first'    => $self->getfield('first'),
3820     'address1' => $options{address1} || $self->address1,
3821     'address2' => $options{address2} || $self->address2,
3822     'city'     => $options{city}     || $self->city,
3823     'state'    => $options{state}    || $self->state,
3824     'zip'      => $options{zip}      || $self->zip,
3825     'country'  => $options{country}  || $self->country,
3826     'payby'    => $options{payby}    || $self->payby,
3827     'payinfo'  => $options{payinfo}  || $self->payinfo,
3828     'exp'      => $options{paydate}  || $self->paydate,
3829     'payname'  => $options{payname}  || $self->payname,
3830     'amount'   => $amount,                         # consolidating
3831   } );
3832
3833   $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
3834     if $old_cust_pay_batch;
3835
3836   my $error;
3837   if ($old_cust_pay_batch) {
3838     $error = $cust_pay_batch->replace($old_cust_pay_batch)
3839   } else {
3840     $error = $cust_pay_batch->insert;
3841   }
3842
3843   if ( $error ) {
3844     $dbh->rollback if $oldAutoCommit;
3845     die $error;
3846   }
3847
3848   my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
3849   foreach my $cust_bill ($self->open_cust_bill) {
3850     #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
3851     my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
3852       'invnum' => $cust_bill->invnum,
3853       'paybatchnum' => $cust_pay_batch->paybatchnum,
3854       'amount' => $cust_bill->owed,
3855       '_date' => time,
3856     };
3857     if ($unapplied >= $cust_bill_pay_batch->amount){
3858       $unapplied -= $cust_bill_pay_batch->amount;
3859       next;
3860     }else{
3861       $cust_bill_pay_batch->amount(sprintf ( "%.2f",
3862                                    $cust_bill_pay_batch->amount - $unapplied ));      $unapplied = 0;
3863     }
3864     $error = $cust_bill_pay_batch->insert;
3865     if ( $error ) {
3866       $dbh->rollback if $oldAutoCommit;
3867       die $error;
3868     }
3869   }
3870
3871   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3872   '';
3873 }
3874
3875 =item total_owed
3876
3877 Returns the total owed for this customer on all invoices
3878 (see L<FS::cust_bill/owed>).
3879
3880 =cut
3881
3882 sub total_owed {
3883   my $self = shift;
3884   $self->total_owed_date(2145859200); #12/31/2037
3885 }
3886
3887 =item total_owed_date TIME
3888
3889 Returns the total owed for this customer on all invoices with date earlier than
3890 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
3891 see L<Time::Local> and L<Date::Parse> for conversion functions.
3892
3893 =cut
3894
3895 sub total_owed_date {
3896   my $self = shift;
3897   my $time = shift;
3898   my $total_bill = 0;
3899   foreach my $cust_bill (
3900     grep { $_->_date <= $time }
3901       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3902   ) {
3903     $total_bill += $cust_bill->owed;
3904   }
3905   sprintf( "%.2f", $total_bill );
3906 }
3907
3908 =item apply_payments_and_credits
3909
3910 Applies unapplied payments and credits.
3911
3912 In most cases, this new method should be used in place of sequential
3913 apply_payments and apply_credits methods.
3914
3915 If there is an error, returns the error, otherwise returns false.
3916
3917 =cut
3918
3919 sub apply_payments_and_credits {
3920   my $self = shift;
3921
3922   local $SIG{HUP} = 'IGNORE';
3923   local $SIG{INT} = 'IGNORE';
3924   local $SIG{QUIT} = 'IGNORE';
3925   local $SIG{TERM} = 'IGNORE';
3926   local $SIG{TSTP} = 'IGNORE';
3927   local $SIG{PIPE} = 'IGNORE';
3928
3929   my $oldAutoCommit = $FS::UID::AutoCommit;
3930   local $FS::UID::AutoCommit = 0;
3931   my $dbh = dbh;
3932
3933   $self->select_for_update; #mutex
3934
3935   foreach my $cust_bill ( $self->open_cust_bill ) {
3936     my $error = $cust_bill->apply_payments_and_credits;
3937     if ( $error ) {
3938       $dbh->rollback if $oldAutoCommit;
3939       return "Error applying: $error";
3940     }
3941   }
3942
3943   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3944   ''; #no error
3945
3946 }
3947
3948 =item apply_credits OPTION => VALUE ...
3949
3950 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3951 to outstanding invoice balances in chronological order (or reverse
3952 chronological order if the I<order> option is set to B<newest>) and returns the
3953 value of any remaining unapplied credits available for refund (see
3954 L<FS::cust_refund>).
3955
3956 Dies if there is an error.
3957
3958 =cut
3959
3960 sub apply_credits {
3961   my $self = shift;
3962   my %opt = @_;
3963
3964   local $SIG{HUP} = 'IGNORE';
3965   local $SIG{INT} = 'IGNORE';
3966   local $SIG{QUIT} = 'IGNORE';
3967   local $SIG{TERM} = 'IGNORE';
3968   local $SIG{TSTP} = 'IGNORE';
3969   local $SIG{PIPE} = 'IGNORE';
3970
3971   my $oldAutoCommit = $FS::UID::AutoCommit;
3972   local $FS::UID::AutoCommit = 0;
3973   my $dbh = dbh;
3974
3975   $self->select_for_update; #mutex
3976
3977   unless ( $self->total_credited ) {
3978     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3979     return 0;
3980   }
3981
3982   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3983       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3984
3985   my @invoices = $self->open_cust_bill;
3986   @invoices = sort { $b->_date <=> $a->_date } @invoices
3987     if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3988
3989   my $credit;
3990   foreach my $cust_bill ( @invoices ) {
3991     my $amount;
3992
3993     if ( !defined($credit) || $credit->credited == 0) {
3994       $credit = pop @credits or last;
3995     }
3996
3997     if ($cust_bill->owed >= $credit->credited) {
3998       $amount=$credit->credited;
3999     }else{
4000       $amount=$cust_bill->owed;
4001     }
4002
4003     my $cust_credit_bill = new FS::cust_credit_bill ( {
4004       'crednum' => $credit->crednum,
4005       'invnum'  => $cust_bill->invnum,
4006       'amount'  => $amount,
4007     } );
4008     my $error = $cust_credit_bill->insert;
4009     if ( $error ) {
4010       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4011       die $error;
4012     }
4013
4014     redo if ($cust_bill->owed > 0);
4015
4016   }
4017
4018   my $total_credited = $self->total_credited;
4019
4020   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4021
4022   return $total_credited;
4023 }
4024
4025 =item apply_payments
4026
4027 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
4028 to outstanding invoice balances in chronological order.
4029
4030  #and returns the value of any remaining unapplied payments.
4031
4032 Dies if there is an error.
4033
4034 =cut
4035
4036 sub apply_payments {
4037   my $self = shift;
4038
4039   local $SIG{HUP} = 'IGNORE';
4040   local $SIG{INT} = 'IGNORE';
4041   local $SIG{QUIT} = 'IGNORE';
4042   local $SIG{TERM} = 'IGNORE';
4043   local $SIG{TSTP} = 'IGNORE';
4044   local $SIG{PIPE} = 'IGNORE';
4045
4046   my $oldAutoCommit = $FS::UID::AutoCommit;
4047   local $FS::UID::AutoCommit = 0;
4048   my $dbh = dbh;
4049
4050   $self->select_for_update; #mutex
4051
4052   #return 0 unless
4053
4054   my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
4055       qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
4056
4057   my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
4058       qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
4059
4060   my $payment;
4061
4062   foreach my $cust_bill ( @invoices ) {
4063     my $amount;
4064
4065     if ( !defined($payment) || $payment->unapplied == 0 ) {
4066       $payment = pop @payments or last;
4067     }
4068
4069     if ( $cust_bill->owed >= $payment->unapplied ) {
4070       $amount = $payment->unapplied;
4071     } else {
4072       $amount = $cust_bill->owed;
4073     }
4074
4075     my $cust_bill_pay = new FS::cust_bill_pay ( {
4076       'paynum' => $payment->paynum,
4077       'invnum' => $cust_bill->invnum,
4078       'amount' => $amount,
4079     } );
4080     my $error = $cust_bill_pay->insert;
4081     if ( $error ) {
4082       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4083       die $error;
4084     }
4085
4086     redo if ( $cust_bill->owed > 0);
4087
4088   }
4089
4090   my $total_unapplied_payments = $self->total_unapplied_payments;
4091
4092   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4093
4094   return $total_unapplied_payments;
4095 }
4096
4097 =item total_credited
4098
4099 Returns the total outstanding credit (see L<FS::cust_credit>) for this
4100 customer.  See L<FS::cust_credit/credited>.
4101
4102 =cut
4103
4104 sub total_credited {
4105   my $self = shift;
4106   my $total_credit = 0;
4107   foreach my $cust_credit ( qsearch('cust_credit', {
4108     'custnum' => $self->custnum,
4109   } ) ) {
4110     $total_credit += $cust_credit->credited;
4111   }
4112   sprintf( "%.2f", $total_credit );
4113 }
4114
4115 =item total_unapplied_payments
4116
4117 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
4118 See L<FS::cust_pay/unapplied>.
4119
4120 =cut
4121
4122 sub total_unapplied_payments {
4123   my $self = shift;
4124   my $total_unapplied = 0;
4125   foreach my $cust_pay ( qsearch('cust_pay', {
4126     'custnum' => $self->custnum,
4127   } ) ) {
4128     $total_unapplied += $cust_pay->unapplied;
4129   }
4130   sprintf( "%.2f", $total_unapplied );
4131 }
4132
4133 =item total_unapplied_refunds
4134
4135 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
4136 customer.  See L<FS::cust_refund/unapplied>.
4137
4138 =cut
4139
4140 sub total_unapplied_refunds {
4141   my $self = shift;
4142   my $total_unapplied = 0;
4143   foreach my $cust_refund ( qsearch('cust_refund', {
4144     'custnum' => $self->custnum,
4145   } ) ) {
4146     $total_unapplied += $cust_refund->unapplied;
4147   }
4148   sprintf( "%.2f", $total_unapplied );
4149 }
4150
4151 =item balance
4152
4153 Returns the balance for this customer (total_owed plus total_unrefunded, minus
4154 total_credited minus total_unapplied_payments).
4155
4156 =cut
4157
4158 sub balance {
4159   my $self = shift;
4160   sprintf( "%.2f",
4161       $self->total_owed
4162     + $self->total_unapplied_refunds
4163     - $self->total_credited
4164     - $self->total_unapplied_payments
4165   );
4166 }
4167
4168 =item balance_date TIME
4169
4170 Returns the balance for this customer, only considering invoices with date
4171 earlier than TIME (total_owed_date minus total_credited minus
4172 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
4173 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
4174 functions.
4175
4176 =cut
4177
4178 sub balance_date {
4179   my $self = shift;
4180   my $time = shift;
4181   sprintf( "%.2f",
4182         $self->total_owed_date($time)
4183       + $self->total_unapplied_refunds
4184       - $self->total_credited
4185       - $self->total_unapplied_payments
4186   );
4187 }
4188
4189 =item in_transit_payments
4190
4191 Returns the total of requests for payments for this customer pending in
4192 batches in transit to the bank.  See L<FS::pay_batch> and L<FS::cust_pay_batch>
4193
4194 =cut
4195
4196 sub in_transit_payments {
4197   my $self = shift;
4198   my $in_transit_payments = 0;
4199   foreach my $pay_batch ( qsearch('pay_batch', {
4200     'status' => 'I',
4201   } ) ) {
4202     foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
4203       'batchnum' => $pay_batch->batchnum,
4204       'custnum' => $self->custnum,
4205     } ) ) {
4206       $in_transit_payments += $cust_pay_batch->amount;
4207     }
4208   }
4209   sprintf( "%.2f", $in_transit_payments );
4210 }
4211
4212 =item paydate_monthyear
4213
4214 Returns a two-element list consisting of the month and year of this customer's
4215 paydate (credit card expiration date for CARD customers)
4216
4217 =cut
4218
4219 sub paydate_monthyear {
4220   my $self = shift;
4221   if ( $self->paydate  =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
4222     ( $2, $1 );
4223   } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
4224     ( $1, $3 );
4225   } else {
4226     ('', '');
4227   }
4228 }
4229
4230 =item invoicing_list [ ARRAYREF ]
4231
4232 If an arguement is given, sets these email addresses as invoice recipients
4233 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
4234 (except as warnings), so use check_invoicing_list first.
4235
4236 Returns a list of email addresses (with svcnum entries expanded).
4237
4238 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
4239 check it without disturbing anything by passing nothing.
4240
4241 This interface may change in the future.
4242
4243 =cut
4244
4245 sub invoicing_list {
4246   my( $self, $arrayref ) = @_;
4247
4248   if ( $arrayref ) {
4249     my @cust_main_invoice;
4250     if ( $self->custnum ) {
4251       @cust_main_invoice =
4252         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4253     } else {
4254       @cust_main_invoice = ();
4255     }
4256     foreach my $cust_main_invoice ( @cust_main_invoice ) {
4257       #warn $cust_main_invoice->destnum;
4258       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
4259         #warn $cust_main_invoice->destnum;
4260         my $error = $cust_main_invoice->delete;
4261         warn $error if $error;
4262       }
4263     }
4264     if ( $self->custnum ) {
4265       @cust_main_invoice =
4266         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4267     } else {
4268       @cust_main_invoice = ();
4269     }
4270     my %seen = map { $_->address => 1 } @cust_main_invoice;
4271     foreach my $address ( @{$arrayref} ) {
4272       next if exists $seen{$address} && $seen{$address};
4273       $seen{$address} = 1;
4274       my $cust_main_invoice = new FS::cust_main_invoice ( {
4275         'custnum' => $self->custnum,
4276         'dest'    => $address,
4277       } );
4278       my $error = $cust_main_invoice->insert;
4279       warn $error if $error;
4280     }
4281   }
4282
4283   if ( $self->custnum ) {
4284     map { $_->address }
4285       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4286   } else {
4287     ();
4288   }
4289
4290 }
4291
4292 =item check_invoicing_list ARRAYREF
4293
4294 Checks these arguements as valid input for the invoicing_list method.  If there
4295 is an error, returns the error, otherwise returns false.
4296
4297 =cut
4298
4299 sub check_invoicing_list {
4300   my( $self, $arrayref ) = @_;
4301
4302   foreach my $address ( @$arrayref ) {
4303
4304     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
4305       return 'Can\'t add FAX invoice destination with a blank FAX number.';
4306     }
4307
4308     my $cust_main_invoice = new FS::cust_main_invoice ( {
4309       'custnum' => $self->custnum,
4310       'dest'    => $address,
4311     } );
4312     my $error = $self->custnum
4313                 ? $cust_main_invoice->check
4314                 : $cust_main_invoice->checkdest
4315     ;
4316     return $error if $error;
4317
4318   }
4319
4320   return "Email address required"
4321     if $conf->exists('cust_main-require_invoicing_list_email')
4322     && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
4323
4324   '';
4325 }
4326
4327 =item set_default_invoicing_list
4328
4329 Sets the invoicing list to all accounts associated with this customer,
4330 overwriting any previous invoicing list.
4331
4332 =cut
4333
4334 sub set_default_invoicing_list {
4335   my $self = shift;
4336   $self->invoicing_list($self->all_emails);
4337 }
4338
4339 =item all_emails
4340
4341 Returns the email addresses of all accounts provisioned for this customer.
4342
4343 =cut
4344
4345 sub all_emails {
4346   my $self = shift;
4347   my %list;
4348   foreach my $cust_pkg ( $self->all_pkgs ) {
4349     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
4350     my @svc_acct =
4351       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4352         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4353           @cust_svc;
4354     $list{$_}=1 foreach map { $_->email } @svc_acct;
4355   }
4356   keys %list;
4357 }
4358
4359 =item invoicing_list_addpost
4360
4361 Adds postal invoicing to this customer.  If this customer is already configured
4362 to receive postal invoices, does nothing.
4363
4364 =cut
4365
4366 sub invoicing_list_addpost {
4367   my $self = shift;
4368   return if grep { $_ eq 'POST' } $self->invoicing_list;
4369   my @invoicing_list = $self->invoicing_list;
4370   push @invoicing_list, 'POST';
4371   $self->invoicing_list(\@invoicing_list);
4372 }
4373
4374 =item invoicing_list_emailonly
4375
4376 Returns the list of email invoice recipients (invoicing_list without non-email
4377 destinations such as POST and FAX).
4378
4379 =cut
4380
4381 sub invoicing_list_emailonly {
4382   my $self = shift;
4383   warn "$me invoicing_list_emailonly called"
4384     if $DEBUG;
4385   grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
4386 }
4387
4388 =item invoicing_list_emailonly_scalar
4389
4390 Returns the list of email invoice recipients (invoicing_list without non-email
4391 destinations such as POST and FAX) as a comma-separated scalar.
4392
4393 =cut
4394
4395 sub invoicing_list_emailonly_scalar {
4396   my $self = shift;
4397   warn "$me invoicing_list_emailonly_scalar called"
4398     if $DEBUG;
4399   join(', ', $self->invoicing_list_emailonly);
4400 }
4401
4402 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
4403
4404 Returns an array of customers referred by this customer (referral_custnum set
4405 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
4406 customers referred by customers referred by this customer and so on, inclusive.
4407 The default behavior is DEPTH 1 (no recursion).
4408
4409 =cut
4410
4411 sub referral_cust_main {
4412   my $self = shift;
4413   my $depth = @_ ? shift : 1;
4414   my $exclude = @_ ? shift : {};
4415
4416   my @cust_main =
4417     map { $exclude->{$_->custnum}++; $_; }
4418       grep { ! $exclude->{ $_->custnum } }
4419         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4420
4421   if ( $depth > 1 ) {
4422     push @cust_main,
4423       map { $_->referral_cust_main($depth-1, $exclude) }
4424         @cust_main;
4425   }
4426
4427   @cust_main;
4428 }
4429
4430 =item referral_cust_main_ncancelled
4431
4432 Same as referral_cust_main, except only returns customers with uncancelled
4433 packages.
4434
4435 =cut
4436
4437 sub referral_cust_main_ncancelled {
4438   my $self = shift;
4439   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4440 }
4441
4442 =item referral_cust_pkg [ DEPTH ]
4443
4444 Like referral_cust_main, except returns a flat list of all unsuspended (and
4445 uncancelled) packages for each customer.  The number of items in this list may
4446 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4447
4448 =cut
4449
4450 sub referral_cust_pkg {
4451   my $self = shift;
4452   my $depth = @_ ? shift : 1;
4453
4454   map { $_->unsuspended_pkgs }
4455     grep { $_->unsuspended_pkgs }
4456       $self->referral_cust_main($depth);
4457 }
4458
4459 =item referring_cust_main
4460
4461 Returns the single cust_main record for the customer who referred this customer
4462 (referral_custnum), or false.
4463
4464 =cut
4465
4466 sub referring_cust_main {
4467   my $self = shift;
4468   return '' unless $self->referral_custnum;
4469   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4470 }
4471
4472 =item credit AMOUNT, REASON
4473
4474 Applies a credit to this customer.  If there is an error, returns the error,
4475 otherwise returns false.
4476
4477 =cut
4478
4479 sub credit {
4480   my( $self, $amount, $reason ) = @_;
4481   my $cust_credit = new FS::cust_credit {
4482     'custnum' => $self->custnum,
4483     'amount'  => $amount,
4484     'reason'  => $reason,
4485   };
4486   $cust_credit->insert;
4487 }
4488
4489 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4490
4491 Creates a one-time charge for this customer.  If there is an error, returns
4492 the error, otherwise returns false.
4493
4494 =cut
4495
4496 sub charge {
4497   my $self = shift;
4498   my ( $amount, $pkg, $comment, $taxclass, $additional );
4499   if ( ref( $_[0] ) ) {
4500     $amount     = $_[0]->{amount};
4501     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4502     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
4503                                            : '$'. sprintf("%.2f",$amount);
4504     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4505     $additional = $_[0]->{additional};
4506   }else{
4507     $amount     = shift;
4508     $pkg        = @_ ? shift : 'One-time charge';
4509     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
4510     $taxclass   = @_ ? shift : '';
4511     $additional = [];
4512   }
4513
4514   local $SIG{HUP} = 'IGNORE';
4515   local $SIG{INT} = 'IGNORE';
4516   local $SIG{QUIT} = 'IGNORE';
4517   local $SIG{TERM} = 'IGNORE';
4518   local $SIG{TSTP} = 'IGNORE';
4519   local $SIG{PIPE} = 'IGNORE';
4520
4521   my $oldAutoCommit = $FS::UID::AutoCommit;
4522   local $FS::UID::AutoCommit = 0;
4523   my $dbh = dbh;
4524
4525   my $part_pkg = new FS::part_pkg ( {
4526     'pkg'      => $pkg,
4527     'comment'  => $comment,
4528     'plan'     => 'flat',
4529     'freq'     => 0,
4530     'disabled' => 'Y',
4531     'taxclass' => $taxclass,
4532   } );
4533
4534   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4535                         ( 0 .. @$additional - 1 )
4536                   ),
4537                   'additional_count' => scalar(@$additional),
4538                   'setup_fee' => $amount,
4539                 );
4540
4541   my $error = $part_pkg->insert( options => \%options );
4542   if ( $error ) {
4543     $dbh->rollback if $oldAutoCommit;
4544     return $error;
4545   }
4546
4547   my $pkgpart = $part_pkg->pkgpart;
4548   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
4549   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
4550     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
4551     $error = $type_pkgs->insert;
4552     if ( $error ) {
4553       $dbh->rollback if $oldAutoCommit;
4554       return $error;
4555     }
4556   }
4557
4558   my $cust_pkg = new FS::cust_pkg ( {
4559     'custnum' => $self->custnum,
4560     'pkgpart' => $pkgpart,
4561   } );
4562
4563   $error = $cust_pkg->insert;
4564   if ( $error ) {
4565     $dbh->rollback if $oldAutoCommit;
4566     return $error;
4567   }
4568
4569   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4570   '';
4571
4572 }
4573
4574 =item cust_bill
4575
4576 Returns all the invoices (see L<FS::cust_bill>) for this customer.
4577
4578 =cut
4579
4580 sub cust_bill {
4581   my $self = shift;
4582   sort { $a->_date <=> $b->_date }
4583     qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4584 }
4585
4586 =item open_cust_bill
4587
4588 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
4589 customer.
4590
4591 =cut
4592
4593 sub open_cust_bill {
4594   my $self = shift;
4595   grep { $_->owed > 0 } $self->cust_bill;
4596 }
4597
4598 =item cust_credit
4599
4600 Returns all the credits (see L<FS::cust_credit>) for this customer.
4601
4602 =cut
4603
4604 sub cust_credit {
4605   my $self = shift;
4606   sort { $a->_date <=> $b->_date }
4607     qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
4608 }
4609
4610 =item cust_pay
4611
4612 Returns all the payments (see L<FS::cust_pay>) for this customer.
4613
4614 =cut
4615
4616 sub cust_pay {
4617   my $self = shift;
4618   sort { $a->_date <=> $b->_date }
4619     qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
4620 }
4621
4622 =item cust_pay_void
4623
4624 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4625
4626 =cut
4627
4628 sub cust_pay_void {
4629   my $self = shift;
4630   sort { $a->_date <=> $b->_date }
4631     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4632 }
4633
4634 =item cust_pay_batch
4635
4636 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
4637
4638 =cut
4639
4640 sub cust_pay_batch {
4641   my $self = shift;
4642   sort { $a->_date <=> $b->_date }
4643     qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
4644 }
4645
4646 =item cust_refund
4647
4648 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4649
4650 =cut
4651
4652 sub cust_refund {
4653   my $self = shift;
4654   sort { $a->_date <=> $b->_date }
4655     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4656 }
4657
4658 =item name
4659
4660 Returns a name string for this customer, either "Company (Last, First)" or
4661 "Last, First".
4662
4663 =cut
4664
4665 sub name {
4666   my $self = shift;
4667   my $name = $self->contact;
4668   $name = $self->company. " ($name)" if $self->company;
4669   $name;
4670 }
4671
4672 =item ship_name
4673
4674 Returns a name string for this (service/shipping) contact, either
4675 "Company (Last, First)" or "Last, First".
4676
4677 =cut
4678
4679 sub ship_name {
4680   my $self = shift;
4681   if ( $self->get('ship_last') ) {
4682     my $name = $self->ship_contact;
4683     $name = $self->ship_company. " ($name)" if $self->ship_company;
4684     $name;
4685   } else {
4686     $self->name;
4687   }
4688 }
4689
4690 =item contact
4691
4692 Returns this customer's full (billing) contact name only, "Last, First"
4693
4694 =cut
4695
4696 sub contact {
4697   my $self = shift;
4698   $self->get('last'). ', '. $self->first;
4699 }
4700
4701 =item ship_contact
4702
4703 Returns this customer's full (shipping) contact name only, "Last, First"
4704
4705 =cut
4706
4707 sub ship_contact {
4708   my $self = shift;
4709   $self->get('ship_last')
4710     ? $self->get('ship_last'). ', '. $self->ship_first
4711     : $self->contact;
4712 }
4713
4714 =item country_full
4715
4716 Returns this customer's full country name
4717
4718 =cut
4719
4720 sub country_full {
4721   my $self = shift;
4722   code2country($self->country);
4723 }
4724
4725 =item cust_status
4726
4727 =item status
4728
4729 Returns a status string for this customer, currently:
4730
4731 =over 4
4732
4733 =item prospect - No packages have ever been ordered
4734
4735 =item active - One or more recurring packages is active
4736
4737 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4738
4739 =item suspended - All non-cancelled recurring packages are suspended
4740
4741 =item cancelled - All recurring packages are cancelled
4742
4743 =back
4744
4745 =cut
4746
4747 sub status { shift->cust_status(@_); }
4748
4749 sub cust_status {
4750   my $self = shift;
4751   for my $status (qw( prospect active inactive suspended cancelled )) {
4752     my $method = $status.'_sql';
4753     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4754     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4755     $sth->execute( ($self->custnum) x $numnum )
4756       or die "Error executing 'SELECT $sql': ". $sth->errstr;
4757     return $status if $sth->fetchrow_arrayref->[0];
4758   }
4759 }
4760
4761 =item ucfirst_cust_status
4762
4763 =item ucfirst_status
4764
4765 Returns the status with the first character capitalized.
4766
4767 =cut
4768
4769 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4770
4771 sub ucfirst_cust_status {
4772   my $self = shift;
4773   ucfirst($self->cust_status);
4774 }
4775
4776 =item statuscolor
4777
4778 Returns a hex triplet color string for this customer's status.
4779
4780 =cut
4781
4782 use vars qw(%statuscolor);
4783 tie my %statuscolor, 'Tie::IxHash',
4784   'prospect'  => '7e0079', #'000000', #black?  naw, purple
4785   'active'    => '00CC00', #green
4786   'inactive'  => '0000CC', #blue
4787   'suspended' => 'FF9900', #yellow
4788   'cancelled' => 'FF0000', #red
4789 ;
4790
4791 sub statuscolor { shift->cust_statuscolor(@_); }
4792
4793 sub cust_statuscolor {
4794   my $self = shift;
4795   $statuscolor{$self->cust_status};
4796 }
4797
4798 =item tickets
4799
4800 Returns an array of hashes representing the customer's RT tickets.
4801
4802 =cut
4803
4804 sub tickets {
4805   my $self = shift;
4806
4807   my $num = $conf->config('cust_main-max_tickets') || 10;
4808   my @tickets = ();
4809
4810   unless ( $conf->config('ticket_system-custom_priority_field') ) {
4811
4812     @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4813
4814   } else {
4815
4816     foreach my $priority (
4817       $conf->config('ticket_system-custom_priority_field-values'), ''
4818     ) {
4819       last if scalar(@tickets) >= $num;
4820       push @tickets,
4821         @{ FS::TicketSystem->customer_tickets( $self->custnum,
4822                                                $num - scalar(@tickets),
4823                                                $priority,
4824                                              )
4825          };
4826     }
4827   }
4828   (@tickets);
4829 }
4830
4831 # Return services representing svc_accts in customer support packages
4832 sub support_services {
4833   my $self = shift;
4834   my %packages = map { $_ => 1 } $conf->config('support_packages');
4835
4836   grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4837     grep { $_->part_svc->svcdb eq 'svc_acct' }
4838     map { $_->cust_svc }
4839     grep { exists $packages{ $_->pkgpart } }
4840     $self->ncancelled_pkgs;
4841
4842 }
4843
4844 =back
4845
4846 =head1 CLASS METHODS
4847
4848 =over 4
4849
4850 =item statuses
4851
4852 Class method that returns the list of possible status strings for customers
4853 (see L<the status method|/status>).  For example:
4854
4855   @statuses = FS::cust_main->statuses();
4856
4857 =cut
4858
4859 sub statuses {
4860   #my $self = shift; #could be class...
4861   keys %statuscolor;
4862 }
4863
4864 =item prospect_sql
4865
4866 Returns an SQL expression identifying prospective cust_main records (customers
4867 with no packages ever ordered)
4868
4869 =cut
4870
4871 use vars qw($select_count_pkgs);
4872 $select_count_pkgs =
4873   "SELECT COUNT(*) FROM cust_pkg
4874     WHERE cust_pkg.custnum = cust_main.custnum";
4875
4876 sub select_count_pkgs_sql {
4877   $select_count_pkgs;
4878 }
4879
4880 sub prospect_sql { "
4881   0 = ( $select_count_pkgs )
4882 "; }
4883
4884 =item active_sql
4885
4886 Returns an SQL expression identifying active cust_main records (customers with
4887 no active recurring packages, but otherwise unsuspended/uncancelled).
4888
4889 =cut
4890
4891 sub active_sql { "
4892   0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
4893       )
4894 "; }
4895
4896 =item inactive_sql
4897
4898 Returns an SQL expression identifying inactive cust_main records (customers with
4899 active recurring packages).
4900
4901 =cut
4902
4903 sub inactive_sql { "
4904   0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4905   AND
4906   0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
4907 "; }
4908
4909 =item susp_sql
4910 =item suspended_sql
4911
4912 Returns an SQL expression identifying suspended cust_main records.
4913
4914 =cut
4915
4916
4917 sub suspended_sql { susp_sql(@_); }
4918 sub susp_sql { "
4919     0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
4920     AND
4921     0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4922 "; }
4923
4924 =item cancel_sql
4925 =item cancelled_sql
4926
4927 Returns an SQL expression identifying cancelled cust_main records.
4928
4929 =cut
4930
4931 sub cancelled_sql { cancel_sql(@_); }
4932 sub cancel_sql {
4933
4934   my $recurring_sql = FS::cust_pkg->recurring_sql;
4935   #my $recurring_sql = "
4936   #  '0' != ( select freq from part_pkg
4937   #             where cust_pkg.pkgpart = part_pkg.pkgpart )
4938   #";
4939
4940   "
4941     0 < ( $select_count_pkgs )
4942     AND 0 = ( $select_count_pkgs AND $recurring_sql
4943                   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4944             )
4945   ";
4946 }
4947
4948 =item uncancel_sql
4949 =item uncancelled_sql
4950
4951 Returns an SQL expression identifying un-cancelled cust_main records.
4952
4953 =cut
4954
4955 sub uncancelled_sql { uncancel_sql(@_); }
4956 sub uncancel_sql { "
4957   ( 0 < ( $select_count_pkgs
4958                    AND ( cust_pkg.cancel IS NULL
4959                          OR cust_pkg.cancel = 0
4960                        )
4961         )
4962     OR 0 = ( $select_count_pkgs )
4963   )
4964 "; }
4965
4966 =item balance_sql
4967
4968 Returns an SQL fragment to retreive the balance.
4969
4970 =cut
4971
4972 sub balance_sql { "
4973     COALESCE( ( SELECT SUM(charged) FROM cust_bill
4974                   WHERE cust_bill.custnum   = cust_main.custnum ), 0)
4975   - COALESCE( ( SELECT SUM(paid)    FROM cust_pay
4976                   WHERE cust_pay.custnum    = cust_main.custnum ), 0)
4977   - COALESCE( ( SELECT SUM(amount)  FROM cust_credit
4978                   WHERE cust_credit.custnum = cust_main.custnum ), 0)
4979   + COALESCE( ( SELECT SUM(refund)  FROM cust_refund
4980                    WHERE cust_refund.custnum = cust_main.custnum ), 0)
4981 "; }
4982
4983 =item balance_date_sql TIME
4984
4985 Returns an SQL fragment to retreive the balance for this customer, only
4986 considering invoices with date earlier than TIME. (total_owed_date minus total_credited minus
4987 total_unapplied_payments).  TIME is specified as an SQL fragment or a numeric
4988 UNIX timestamp; see L<perlfunc/"time">).  Also see L<Time::Local> and
4989 L<Date::Parse> for conversion functions.
4990
4991 =cut
4992
4993 sub balance_date_sql {
4994   my( $class, $time ) = @_;
4995
4996   my $owed_sql         = FS::cust_bill->owed_sql;
4997   my $unapp_refund_sql = FS::cust_refund->unapplied_sql;
4998   #my $unapp_credit_sql = FS::cust_credit->unapplied_sql;
4999   my $unapp_credit_sql = FS::cust_credit->credited_sql;
5000   my $unapp_pay_sql    = FS::cust_pay->unapplied_sql;
5001
5002   "
5003       COALESCE( ( SELECT SUM($owed_sql) FROM cust_bill
5004                     WHERE cust_bill.custnum   = cust_main.custnum
5005                       AND cust_bill._date    <= $time             )
5006                 ,0
5007               )
5008     + COALESCE( ( SELECT SUM($unapp_refund_sql) FROM cust_refund
5009                     WHERE cust_refund.custnum = cust_main.custnum )
5010                 ,0
5011               )
5012     - COALESCE( ( SELECT SUM($unapp_credit_sql) FROM cust_credit
5013                     WHERE cust_credit.custnum = cust_main.custnum )
5014                 ,0
5015               )
5016     - COALESCE( ( SELECT SUM($unapp_pay_sql) FROM cust_pay
5017                     WHERE cust_pay.custnum = cust_main.custnum )
5018                 ,0
5019               )
5020
5021   ";
5022
5023 }
5024
5025 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
5026
5027 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
5028 records.  Currently, I<first>, I<last> and/or I<company> may be specified (the
5029 appropriate ship_ field is also searched).
5030
5031 Additional options are the same as FS::Record::qsearch
5032
5033 =cut
5034
5035 sub fuzzy_search {
5036   my( $self, $fuzzy, $hash, @opt) = @_;
5037   #$self
5038   $hash ||= {};
5039   my @cust_main = ();
5040
5041   check_and_rebuild_fuzzyfiles();
5042   foreach my $field ( keys %$fuzzy ) {
5043
5044     my $all = $self->all_X($field);
5045     next unless scalar(@$all);
5046
5047     my %match = ();
5048     $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
5049
5050     my @fcust = ();
5051     foreach ( keys %match ) {
5052       push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
5053       push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
5054     }
5055     my %fsaw = ();
5056     push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
5057   }
5058
5059   # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
5060   my %saw = ();
5061   @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
5062
5063   @cust_main;
5064
5065 }
5066
5067 =item masked FIELD
5068
5069 Returns a masked version of the named field
5070
5071 =cut
5072
5073 sub masked {
5074 my ($self,$field) = @_;
5075
5076 # Show last four
5077
5078 'x'x(length($self->getfield($field))-4).
5079   substr($self->getfield($field), (length($self->getfield($field))-4));
5080
5081 }
5082
5083 =back
5084
5085 =head1 SUBROUTINES
5086
5087 =over 4
5088
5089 =item smart_search OPTION => VALUE ...
5090
5091 Accepts the following options: I<search>, the string to search for.  The string
5092 will be searched for as a customer number, phone number, name or company name,
5093 as an exact, or, in some cases, a substring or fuzzy match (see the source code
5094 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
5095 skip fuzzy matching when an exact match is found.
5096
5097 Any additional options are treated as an additional qualifier on the search
5098 (i.e. I<agentnum>).
5099
5100 Returns a (possibly empty) array of FS::cust_main objects.
5101
5102 =cut
5103
5104 sub smart_search {
5105   my %options = @_;
5106
5107   #here is the agent virtualization
5108   my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
5109
5110   my @cust_main = ();
5111
5112   my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
5113   my $search = delete $options{'search'};
5114   ( my $alphanum_search = $search ) =~ s/\W//g;
5115
5116   if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
5117
5118     #false laziness w/Record::ut_phone
5119     my $phonen = "$1-$2-$3";
5120     $phonen .= " x$4" if $4;
5121
5122     push @cust_main, qsearch( {
5123       'table'   => 'cust_main',
5124       'hashref' => { %options },
5125       'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5126                      ' ( '.
5127                          join(' OR ', map "$_ = '$phonen'",
5128                                           qw( daytime night fax
5129                                               ship_daytime ship_night ship_fax )
5130                              ).
5131                      ' ) '.
5132                      " AND $agentnums_sql", #agent virtualization
5133     } );
5134
5135     unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
5136       #try looking for matches with extensions unless one was specified
5137
5138       push @cust_main, qsearch( {
5139         'table'   => 'cust_main',
5140         'hashref' => { %options },
5141         'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5142                        ' ( '.
5143                            join(' OR ', map "$_ LIKE '$phonen\%'",
5144                                             qw( daytime night
5145                                                 ship_daytime ship_night )
5146                                ).
5147                        ' ) '.
5148                        " AND $agentnums_sql", #agent virtualization
5149       } );
5150
5151     }
5152
5153   } elsif ( $search =~ /^\s*(\d+)\s*$/ ) { # customer # search
5154
5155     push @cust_main, qsearch( {
5156       'table'     => 'cust_main',
5157       'hashref'   => { 'custnum' => $1, %options },
5158       'extra_sql' => " AND $agentnums_sql", #agent virtualization
5159     } );
5160
5161   } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
5162
5163     my($company, $last, $first) = ( $1, $2, $3 );
5164
5165     # "Company (Last, First)"
5166     #this is probably something a browser remembered,
5167     #so just do an exact search
5168
5169     foreach my $prefix ( '', 'ship_' ) {
5170       push @cust_main, qsearch( {
5171         'table'     => 'cust_main',
5172         'hashref'   => { $prefix.'first'   => $first,
5173                          $prefix.'last'    => $last,
5174                          $prefix.'company' => $company,
5175                          %options,
5176                        },
5177         'extra_sql' => " AND $agentnums_sql",
5178       } );
5179     }
5180
5181   } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
5182                                               # try (ship_){last,company}
5183
5184     my $value = lc($1);
5185
5186     # # remove "(Last, First)" in "Company (Last, First)", otherwise the
5187     # # full strings the browser remembers won't work
5188     # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
5189
5190     use Lingua::EN::NameParse;
5191     my $NameParse = new Lingua::EN::NameParse(
5192              auto_clean     => 1,
5193              allow_reversed => 1,
5194     );
5195
5196     my($last, $first) = ( '', '' );
5197     #maybe disable this too and just rely on NameParse?
5198     if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
5199
5200       ($last, $first) = ( $1, $2 );
5201
5202     #} elsif  ( $value =~ /^(.+)\s+(.+)$/ ) {
5203     } elsif ( ! $NameParse->parse($value) ) {
5204
5205       my %name = $NameParse->components;
5206       $first = $name{'given_name_1'};
5207       $last  = $name{'surname_1'};
5208
5209     }
5210
5211     if ( $first && $last ) {
5212
5213       my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
5214
5215       #exact
5216       my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5217       $sql .= "
5218         (     ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
5219            OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
5220         )";
5221
5222       push @cust_main, qsearch( {
5223         'table'     => 'cust_main',
5224         'hashref'   => \%options,
5225         'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5226       } );
5227
5228       # or it just be something that was typed in... (try that in a sec)
5229
5230     }
5231
5232     my $q_value = dbh->quote($value);
5233
5234     #exact
5235     my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5236     $sql .= " (    LOWER(last)         = $q_value
5237                 OR LOWER(company)      = $q_value
5238                 OR LOWER(ship_last)    = $q_value
5239                 OR LOWER(ship_company) = $q_value
5240               )";
5241
5242     push @cust_main, qsearch( {
5243       'table'     => 'cust_main',
5244       'hashref'   => \%options,
5245       'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5246     } );
5247
5248     #no exact match, trying substring/fuzzy
5249     #always do substring & fuzzy (unless they're explicity config'ed off)
5250     #getting complaints searches are not returning enough
5251     unless ( @cust_main  && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
5252
5253       #still some false laziness w/ search/cust_main.cgi
5254
5255       #substring
5256
5257       my @hashrefs = (
5258         { 'company'      => { op=>'ILIKE', value=>"%$value%" }, },
5259         { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
5260       );
5261
5262       if ( $first && $last ) {
5263
5264         push @hashrefs,
5265           { 'first'        => { op=>'ILIKE', value=>"%$first%" },
5266             'last'         => { op=>'ILIKE', value=>"%$last%" },
5267           },
5268           { 'ship_first'   => { op=>'ILIKE', value=>"%$first%" },
5269             'ship_last'    => { op=>'ILIKE', value=>"%$last%" },
5270           },
5271         ;
5272
5273       } else {
5274
5275         push @hashrefs,
5276           { 'last'         => { op=>'ILIKE', value=>"%$value%" }, },
5277           { 'ship_last'    => { op=>'ILIKE', value=>"%$value%" }, },
5278         ;
5279       }
5280
5281       foreach my $hashref ( @hashrefs ) {
5282
5283         push @cust_main, qsearch( {
5284           'table'     => 'cust_main',
5285           'hashref'   => { %$hashref,
5286                            %options,
5287                          },
5288           'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
5289         } );
5290
5291       }
5292
5293       #fuzzy
5294       my @fuzopts = (
5295         \%options,                #hashref
5296         '',                       #select
5297         " AND $agentnums_sql",    #extra_sql  #agent virtualization
5298       );
5299
5300       if ( $first && $last ) {
5301         push @cust_main, FS::cust_main->fuzzy_search(
5302           { 'last'   => $last,    #fuzzy hashref
5303             'first'  => $first }, #
5304           @fuzopts
5305         );
5306       }
5307       foreach my $field ( 'last', 'company' ) {
5308         push @cust_main,
5309           FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
5310       }
5311
5312     }
5313
5314     #eliminate duplicates
5315     my %saw = ();
5316     @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5317
5318   }
5319
5320   @cust_main;
5321
5322 }
5323
5324 =item check_and_rebuild_fuzzyfiles
5325
5326 =cut
5327
5328 use vars qw(@fuzzyfields);
5329 @fuzzyfields = ( 'last', 'first', 'company' );
5330
5331 sub check_and_rebuild_fuzzyfiles {
5332   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5333   rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
5334 }
5335
5336 =item rebuild_fuzzyfiles
5337
5338 =cut
5339
5340 sub rebuild_fuzzyfiles {
5341
5342   use Fcntl qw(:flock);
5343
5344   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5345   mkdir $dir, 0700 unless -d $dir;
5346
5347   foreach my $fuzzy ( @fuzzyfields ) {
5348
5349     open(LOCK,">>$dir/cust_main.$fuzzy")
5350       or die "can't open $dir/cust_main.$fuzzy: $!";
5351     flock(LOCK,LOCK_EX)
5352       or die "can't lock $dir/cust_main.$fuzzy: $!";
5353
5354     open (CACHE,">$dir/cust_main.$fuzzy.tmp")
5355       or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
5356
5357     foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
5358       my $sth = dbh->prepare("SELECT $field FROM cust_main".
5359                              " WHERE $field != '' AND $field IS NOT NULL");
5360       $sth->execute or die $sth->errstr;
5361
5362       while ( my $row = $sth->fetchrow_arrayref ) {
5363         print CACHE $row->[0]. "\n";
5364       }
5365
5366     }
5367
5368     close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
5369
5370     rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
5371     close LOCK;
5372   }
5373
5374 }
5375
5376 =item all_X
5377
5378 =cut
5379
5380 sub all_X {
5381   my( $self, $field ) = @_;
5382   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5383   open(CACHE,"<$dir/cust_main.$field")
5384     or die "can't open $dir/cust_main.$field: $!";
5385   my @array = map { chomp; $_; } <CACHE>;
5386   close CACHE;
5387   \@array;
5388 }
5389
5390 =item append_fuzzyfiles LASTNAME COMPANY
5391
5392 =cut
5393
5394 sub append_fuzzyfiles {
5395   #my( $first, $last, $company ) = @_;
5396
5397   &check_and_rebuild_fuzzyfiles;
5398
5399   use Fcntl qw(:flock);
5400
5401   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5402
5403   foreach my $field (qw( first last company )) {
5404     my $value = shift;
5405
5406     if ( $value ) {
5407
5408       open(CACHE,">>$dir/cust_main.$field")
5409         or die "can't open $dir/cust_main.$field: $!";
5410       flock(CACHE,LOCK_EX)
5411         or die "can't lock $dir/cust_main.$field: $!";
5412
5413       print CACHE "$value\n";
5414
5415       flock(CACHE,LOCK_UN)
5416         or die "can't unlock $dir/cust_main.$field: $!";
5417       close CACHE;
5418     }
5419
5420   }
5421
5422   1;
5423 }
5424
5425 =item batch_import
5426
5427 =cut
5428
5429 sub batch_import {
5430   my $param = shift;
5431   #warn join('-',keys %$param);
5432   my $fh = $param->{filehandle};
5433   my $agentnum = $param->{agentnum};
5434
5435   my $refnum = $param->{refnum};
5436   my $pkgpart = $param->{pkgpart};
5437
5438   #my @fields = @{$param->{fields}};
5439   my $format = $param->{'format'};
5440   my @fields;
5441   my $payby;
5442   if ( $format eq 'simple' ) {
5443     @fields = qw( cust_pkg.setup dayphone first last
5444                   address1 address2 city state zip comments );
5445     $payby = 'BILL';
5446   } elsif ( $format eq 'extended' ) {
5447     @fields = qw( agent_custid refnum
5448                   last first address1 address2 city state zip country
5449                   daytime night
5450                   ship_last ship_first ship_address1 ship_address2
5451                   ship_city ship_state ship_zip ship_country
5452                   payinfo paycvv paydate
5453                   invoicing_list
5454                   cust_pkg.pkgpart
5455                   svc_acct.username svc_acct._password
5456                 );
5457     $payby = 'BILL';
5458   } else {
5459     die "unknown format $format";
5460   }
5461
5462   eval "use Text::CSV_XS;";
5463   die $@ if $@;
5464
5465   my $csv = new Text::CSV_XS;
5466   #warn $csv;
5467   #warn $fh;
5468
5469   my $imported = 0;
5470   #my $columns;
5471
5472   local $SIG{HUP} = 'IGNORE';
5473   local $SIG{INT} = 'IGNORE';
5474   local $SIG{QUIT} = 'IGNORE';
5475   local $SIG{TERM} = 'IGNORE';
5476   local $SIG{TSTP} = 'IGNORE';
5477   local $SIG{PIPE} = 'IGNORE';
5478
5479   my $oldAutoCommit = $FS::UID::AutoCommit;
5480   local $FS::UID::AutoCommit = 0;
5481   my $dbh = dbh;
5482
5483   #while ( $columns = $csv->getline($fh) ) {
5484   my $line;
5485   while ( defined($line=<$fh>) ) {
5486
5487     $csv->parse($line) or do {
5488       $dbh->rollback if $oldAutoCommit;
5489       return "can't parse: ". $csv->error_input();
5490     };
5491
5492     my @columns = $csv->fields();
5493     #warn join('-',@columns);
5494
5495     my %cust_main = (
5496       agentnum => $agentnum,
5497       refnum   => $refnum,
5498       country  => $conf->config('countrydefault') || 'US',
5499       payby    => $payby, #default
5500       paydate  => '12/2037', #default
5501     );
5502     my $billtime = time;
5503     my %cust_pkg = ( pkgpart => $pkgpart );
5504     my %svc_acct = ();
5505     foreach my $field ( @fields ) {
5506
5507       if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
5508
5509         #$cust_pkg{$1} = str2time( shift @$columns );
5510         if ( $1 eq 'pkgpart' ) {
5511           $cust_pkg{$1} = shift @columns;
5512         } elsif ( $1 eq 'setup' ) {
5513           $billtime = str2time(shift @columns);
5514         } else {
5515           $cust_pkg{$1} = str2time( shift @columns );
5516         }
5517
5518       } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
5519
5520         $svc_acct{$1} = shift @columns;
5521
5522       } else {
5523
5524         #refnum interception
5525         if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
5526
5527           my $referral = $columns[0];
5528           my %hash = ( 'referral' => $referral,
5529                        'agentnum' => $agentnum,
5530                        'disabled' => '',
5531                      );
5532
5533           my $part_referral = qsearchs('part_referral', \%hash )
5534                               || new FS::part_referral \%hash;
5535
5536           unless ( $part_referral->refnum ) {
5537             my $error = $part_referral->insert;
5538             if ( $error ) {
5539               $dbh->rollback if $oldAutoCommit;
5540               return "can't auto-insert advertising source: $referral: $error";
5541             }
5542           }
5543
5544           $columns[0] = $part_referral->refnum;
5545         }
5546
5547         #$cust_main{$field} = shift @$columns;
5548         $cust_main{$field} = shift @columns;
5549       }
5550     }
5551
5552     $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
5553
5554     my $invoicing_list = $cust_main{'invoicing_list'}
5555                            ? [ delete $cust_main{'invoicing_list'} ]
5556                            : [];
5557
5558     my $cust_main = new FS::cust_main ( \%cust_main );
5559
5560     use Tie::RefHash;
5561     tie my %hash, 'Tie::RefHash'; #this part is important
5562
5563     if ( $cust_pkg{'pkgpart'} ) {
5564       my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
5565
5566       my @svc_acct = ();
5567       if ( $svc_acct{'username'} ) {
5568         my $part_pkg = $cust_pkg->part_pkg;
5569         unless ( $part_pkg ) {
5570           $dbh->rollback if $oldAutoCommit;
5571           return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
5572         }
5573         $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
5574         push @svc_acct, new FS::svc_acct ( \%svc_acct )
5575       }
5576
5577       $hash{$cust_pkg} = \@svc_acct;
5578     }
5579
5580     my $error = $cust_main->insert( \%hash, $invoicing_list );
5581
5582     if ( $error ) {
5583       $dbh->rollback if $oldAutoCommit;
5584       return "can't insert customer for $line: $error";
5585     }
5586
5587     if ( $format eq 'simple' ) {
5588
5589       #false laziness w/bill.cgi
5590       $error = $cust_main->bill( 'time' => $billtime );
5591       if ( $error ) {
5592         $dbh->rollback if $oldAutoCommit;
5593         return "can't bill customer for $line: $error";
5594       }
5595
5596       $error = $cust_main->apply_payments_and_credits;
5597       if ( $error ) {
5598         $dbh->rollback if $oldAutoCommit;
5599         return "can't bill customer for $line: $error";
5600       }
5601
5602       $error = $cust_main->collect();
5603       if ( $error ) {
5604         $dbh->rollback if $oldAutoCommit;
5605         return "can't collect customer for $line: $error";
5606       }
5607
5608     }
5609
5610     $imported++;
5611   }
5612
5613   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5614
5615   return "Empty file!" unless $imported;
5616
5617   ''; #no error
5618
5619 }
5620
5621 =item batch_charge
5622
5623 =cut
5624
5625 sub batch_charge {
5626   my $param = shift;
5627   #warn join('-',keys %$param);
5628   my $fh = $param->{filehandle};
5629   my @fields = @{$param->{fields}};
5630
5631   eval "use Text::CSV_XS;";
5632   die $@ if $@;
5633
5634   my $csv = new Text::CSV_XS;
5635   #warn $csv;
5636   #warn $fh;
5637
5638   my $imported = 0;
5639   #my $columns;
5640
5641   local $SIG{HUP} = 'IGNORE';
5642   local $SIG{INT} = 'IGNORE';
5643   local $SIG{QUIT} = 'IGNORE';
5644   local $SIG{TERM} = 'IGNORE';
5645   local $SIG{TSTP} = 'IGNORE';
5646   local $SIG{PIPE} = 'IGNORE';
5647
5648   my $oldAutoCommit = $FS::UID::AutoCommit;
5649   local $FS::UID::AutoCommit = 0;
5650   my $dbh = dbh;
5651
5652   #while ( $columns = $csv->getline($fh) ) {
5653   my $line;
5654   while ( defined($line=<$fh>) ) {
5655
5656     $csv->parse($line) or do {
5657       $dbh->rollback if $oldAutoCommit;
5658       return "can't parse: ". $csv->error_input();
5659     };
5660
5661     my @columns = $csv->fields();
5662     #warn join('-',@columns);
5663
5664     my %row = ();
5665     foreach my $field ( @fields ) {
5666       $row{$field} = shift @columns;
5667     }
5668
5669     my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
5670     unless ( $cust_main ) {
5671       $dbh->rollback if $oldAutoCommit;
5672       return "unknown custnum $row{'custnum'}";
5673     }
5674
5675     if ( $row{'amount'} > 0 ) {
5676       my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
5677       if ( $error ) {
5678         $dbh->rollback if $oldAutoCommit;
5679         return $error;
5680       }
5681       $imported++;
5682     } elsif ( $row{'amount'} < 0 ) {
5683       my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
5684                                       $row{'pkg'}                         );
5685       if ( $error ) {
5686         $dbh->rollback if $oldAutoCommit;
5687         return $error;
5688       }
5689       $imported++;
5690     } else {
5691       #hmm?
5692     }
5693
5694   }
5695
5696   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5697
5698   return "Empty file!" unless $imported;
5699
5700   ''; #no error
5701
5702 }
5703
5704 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5705
5706 Sends a templated email notification to the customer (see L<Text::Template>).
5707
5708 OPTIONS is a hash and may include
5709
5710 I<from> - the email sender (default is invoice_from)
5711
5712 I<to> - comma-separated scalar or arrayref of recipients
5713    (default is invoicing_list)
5714
5715 I<subject> - The subject line of the sent email notification
5716    (default is "Notice from company_name")
5717
5718 I<extra_fields> - a hashref of name/value pairs which will be substituted
5719    into the template
5720
5721 The following variables are vavailable in the template.
5722
5723 I<$first> - the customer first name
5724 I<$last> - the customer last name
5725 I<$company> - the customer company
5726 I<$payby> - a description of the method of payment for the customer
5727             # would be nice to use FS::payby::shortname
5728 I<$payinfo> - the account information used to collect for this customer
5729 I<$expdate> - the expiration of the customer payment in seconds from epoch
5730
5731 =cut
5732
5733 sub notify {
5734   my ($customer, $template, %options) = @_;
5735
5736   return unless $conf->exists($template);
5737
5738   my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
5739   $from = $options{from} if exists($options{from});
5740
5741   my $to = join(',', $customer->invoicing_list_emailonly);
5742   $to = $options{to} if exists($options{to});
5743
5744   my $subject = "Notice from " . $conf->config('company_name')
5745     if $conf->exists('company_name');
5746   $subject = $options{subject} if exists($options{subject});
5747
5748   my $notify_template = new Text::Template (TYPE => 'ARRAY',
5749                                             SOURCE => [ map "$_\n",
5750                                               $conf->config($template)]
5751                                            )
5752     or die "can't create new Text::Template object: Text::Template::ERROR";
5753   $notify_template->compile()
5754     or die "can't compile template: Text::Template::ERROR";
5755
5756   $FS::notify_template::_template::company_name = $conf->config('company_name');
5757   $FS::notify_template::_template::company_address =
5758     join("\n", $conf->config('company_address') ). "\n";
5759
5760   my $paydate = $customer->paydate;
5761   $FS::notify_template::_template::first = $customer->first;
5762   $FS::notify_template::_template::last = $customer->last;
5763   $FS::notify_template::_template::company = $customer->company;
5764   $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
5765   my $payby = $customer->payby;
5766   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5767   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5768
5769   #credit cards expire at the end of the month/year of their exp date
5770   if ($payby eq 'CARD' || $payby eq 'DCRD') {
5771     $FS::notify_template::_template::payby = 'credit card';
5772     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5773     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5774     $expire_time--;
5775   }elsif ($payby eq 'COMP') {
5776     $FS::notify_template::_template::payby = 'complimentary account';
5777   }else{
5778     $FS::notify_template::_template::payby = 'current method';
5779   }
5780   $FS::notify_template::_template::expdate = $expire_time;
5781
5782   for (keys %{$options{extra_fields}}){
5783     no strict "refs";
5784     ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5785   }
5786
5787   send_email(from => $from,
5788              to => $to,
5789              subject => $subject,
5790              body => $notify_template->fill_in( PACKAGE =>
5791                                                 'FS::notify_template::_template'                                              ),
5792             );
5793
5794 }
5795
5796 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5797
5798 Generates a templated notification to the customer (see L<Text::Template>).
5799
5800 OPTIONS is a hash and may include
5801
5802 I<extra_fields> - a hashref of name/value pairs which will be substituted
5803    into the template.  These values may override values mentioned below
5804    and those from the customer record.
5805
5806 The following variables are available in the template instead of or in addition
5807 to the fields of the customer record.
5808
5809 I<$payby> - a description of the method of payment for the customer
5810             # would be nice to use FS::payby::shortname
5811 I<$payinfo> - the masked account information used to collect for this customer
5812 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5813 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
5814
5815 =cut
5816
5817 sub generate_letter {
5818   my ($self, $template, %options) = @_;
5819
5820   return unless $conf->exists($template);
5821
5822   my $letter_template = new Text::Template
5823                         ( TYPE       => 'ARRAY',
5824                           SOURCE     => [ map "$_\n", $conf->config($template)],
5825                           DELIMITERS => [ '[@--', '--@]' ],
5826                         )
5827     or die "can't create new Text::Template object: Text::Template::ERROR";
5828
5829   $letter_template->compile()
5830     or die "can't compile template: Text::Template::ERROR";
5831
5832   my %letter_data = map { $_ => $self->$_ } $self->fields;
5833   $letter_data{payinfo} = $self->mask_payinfo;
5834
5835   #my $paydate = $self->paydate || '2037-12';
5836   my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12';
5837
5838   my $payby = $self->payby;
5839   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5840   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5841
5842   #credit cards expire at the end of the month/year of their exp date
5843   if ($payby eq 'CARD' || $payby eq 'DCRD') {
5844     $letter_data{payby} = 'credit card';
5845     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5846     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5847     $expire_time--;
5848   }elsif ($payby eq 'COMP') {
5849     $letter_data{payby} = 'complimentary account';
5850   }else{
5851     $letter_data{payby} = 'current method';
5852   }
5853   $letter_data{expdate} = $expire_time;
5854
5855   for (keys %{$options{extra_fields}}){
5856     $letter_data{$_} = $options{extra_fields}->{$_};
5857   }
5858
5859   unless(exists($letter_data{returnaddress})){
5860     my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5861                                                   $self->agent_template)
5862                      );
5863     if ( length($retadd) ) {
5864       $letter_data{returnaddress} = $retadd;
5865     } elsif ( grep /\S/, $conf->config('company_address') ) {
5866       $letter_data{returnaddress} =
5867         join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
5868                           $conf->config('company_address')
5869         );
5870     } else {
5871       $letter_data{returnaddress} = '~';
5872     }
5873   }
5874
5875   $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5876
5877   $letter_data{company_name} = $conf->config('company_name');
5878
5879   my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
5880   my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5881                            DIR      => $dir,
5882                            SUFFIX   => '.tex',
5883                            UNLINK   => 0,
5884                          ) or die "can't open temp file: $!\n";
5885
5886   $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5887   close $fh;
5888   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5889   return $1;
5890 }
5891
5892 =item print_ps TEMPLATE
5893
5894 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5895
5896 =cut
5897
5898 sub print_ps {
5899   my $self = shift;
5900   my $file = $self->generate_letter(@_);
5901   FS::Misc::generate_ps($file);
5902 }
5903
5904 =item print TEMPLATE
5905
5906 Prints the filled in template.
5907
5908 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5909
5910 =cut
5911
5912 sub queueable_print {
5913   my %opt = @_;
5914
5915   my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5916     or die "invalid customer number: " . $opt{custvnum};
5917
5918   my $error = $self->print( $opt{template} );
5919   die $error if $error;
5920 }
5921
5922 sub print {
5923   my ($self, $template) = (shift, shift);
5924   do_print [ $self->print_ps($template) ];
5925 }
5926
5927 sub agent_template {
5928   my $self = shift;
5929   $self->_agent_plandata('agent_templatename');
5930 }
5931
5932 sub agent_invoice_from {
5933   my $self = shift;
5934   $self->_agent_plandata('agent_invoice_from');
5935 }
5936
5937 sub _agent_plandata {
5938   my( $self, $option ) = @_;
5939
5940   #yuck.  this whole thing needs to be reconciled better with 1.9's idea of
5941   #agent-specific Conf
5942
5943   use FS::part_event::Condition;
5944
5945   my $agentnum = $self->agentnum;
5946
5947   my $regexp = '';
5948   if ( driver_name =~ /^Pg/i ) {
5949     $regexp = '~';
5950   } elsif ( driver_name =~ /^mysql/i ) {
5951     $regexp = 'REGEXP';
5952   } else {
5953     die "don't know how to use regular expressions in ". driver_name. " databases";
5954   }
5955
5956   my $part_event_option =
5957     qsearchs({
5958       'select'    => 'part_event_option.*',
5959       'table'     => 'part_event_option',
5960       'addl_from' => q{
5961         LEFT JOIN part_event USING ( eventpart )
5962         LEFT JOIN part_event_option AS peo_agentnum
5963           ON ( part_event.eventpart = peo_agentnum.eventpart
5964                AND peo_agentnum.optionname = 'agentnum'
5965                AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
5966              )
5967         LEFT JOIN part_event_option AS peo_cust_bill_age
5968           ON ( part_event.eventpart = peo_cust_bill_age.eventpart
5969                AND peo_cust_bill_age.optionname = 'cust_bill_age'
5970              )
5971       },
5972       #'hashref'   => { 'optionname' => $option },
5973       #'hashref'   => { 'part_event_option.optionname' => $option },
5974       'extra_sql' =>
5975         " WHERE part_event_option.optionname = ". dbh->quote($option).
5976         " AND action = 'cust_bill_send_agent' ".
5977         " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5978         " AND peo_agentnum.optionname = 'agentnum' ".
5979         " AND agentnum IS NULL OR agentnum = $agentnum ".
5980         " ORDER BY
5981            CASE WHEN peo_cust_bill_age.optionname != 'cust_bill_age'
5982            THEN -1
5983            ELSE ". FS::part_event::Condition->age2seconds_sql('peo_cust_bill_age.optionvalue').
5984         " END
5985           , part_event.weight".
5986         " LIMIT 1"
5987     });
5988
5989   unless ( $part_event_option ) {
5990     return $self->agent->invoice_template || ''
5991       if $option eq 'agent_templatename';
5992     return '';
5993   }
5994
5995   $part_event_option->optionvalue;
5996
5997 }
5998
5999 sub queued_bill {
6000   ## actual sub, not a method, designed to be called from the queue.
6001   ## sets up the customer, and calls the bill_and_collect
6002   my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
6003   my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
6004       $cust_main->bill_and_collect(
6005         %args,
6006       );
6007 }
6008
6009 =back
6010
6011 =head1 BUGS
6012
6013 The delete method.
6014
6015 The delete method should possibly take an FS::cust_main object reference
6016 instead of a scalar customer number.
6017
6018 Bill and collect options should probably be passed as references instead of a
6019 list.
6020
6021 There should probably be a configuration file with a list of allowed credit
6022 card types.
6023
6024 No multiple currency support (probably a larger project than just this module).
6025
6026 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
6027
6028 Birthdates rely on negative epoch values.
6029
6030 The payby for card/check batches is broken.  With mixed batching, bad
6031 things will happen.
6032
6033 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
6034
6035 =head1 SEE ALSO
6036
6037 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
6038 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
6039 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
6040
6041 =cut
6042
6043 1;
6044