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 );
  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, $sql ) = @_;
1685   $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1686   my $sth = dbh->prepare(
1687     "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1688   ) or die dbh->errstr;
1689   $sth->execute($self->custnum) or die $sth->errstr;
1690   $sth->fetchrow_arrayref->[0];
1691 }
1692
1693 =item unsuspend
1694
1695 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1696 and L<FS::cust_pkg>) for this customer.  Always returns a list: an empty list
1697 on success or a list of errors.
1698
1699 =cut
1700
1701 sub unsuspend {
1702   my $self = shift;
1703   grep { $_->unsuspend } $self->suspended_pkgs;
1704 }
1705
1706 =item suspend
1707
1708 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1709
1710 Returns a list: an empty list on success or a list of errors.
1711
1712 =cut
1713
1714 sub suspend {
1715   my $self = shift;
1716   grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1717 }
1718
1719 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1720
1721 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1722 PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref instead
1723 of a list of pkgparts; the hashref has the following keys:
1724
1725 =over 4
1726
1727 =item pkgparts - listref of pkgparts
1728
1729 =item (other options are passed to the suspend method)
1730
1731 =back
1732
1733
1734 Returns a list: an empty list on success or a list of errors.
1735
1736 =cut
1737
1738 sub suspend_if_pkgpart {
1739   my $self = shift;
1740   my (@pkgparts, %opt);
1741   if (ref($_[0]) eq 'HASH'){
1742     @pkgparts = @{$_[0]{pkgparts}};
1743     %opt      = %{$_[0]};
1744   }else{
1745     @pkgparts = @_;
1746   }
1747   grep { $_->suspend(%opt) }
1748     grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1749       $self->unsuspended_pkgs;
1750 }
1751
1752 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1753
1754 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1755 given PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref
1756 instead of a list of pkgparts; the hashref has the following keys:
1757
1758 =over 4
1759
1760 =item pkgparts - listref of pkgparts
1761
1762 =item (other options are passed to the suspend method)
1763
1764 =back
1765
1766 Returns a list: an empty list on success or a list of errors.
1767
1768 =cut
1769
1770 sub suspend_unless_pkgpart {
1771   my $self = shift;
1772   my (@pkgparts, %opt);
1773   if (ref($_[0]) eq 'HASH'){
1774     @pkgparts = @{$_[0]{pkgparts}};
1775     %opt      = %{$_[0]};
1776   }else{
1777     @pkgparts = @_;
1778   }
1779   grep { $_->suspend(%opt) }
1780     grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1781       $self->unsuspended_pkgs;
1782 }
1783
1784 =item cancel [ OPTION => VALUE ... ]
1785
1786 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1787
1788 Available options are:
1789
1790 =over 4
1791
1792 =item quiet - can be set true to supress email cancellation notices.
1793
1794 =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.
1795
1796 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
1797
1798 =back
1799
1800 Always returns a list: an empty list on success or a list of errors.
1801
1802 =cut
1803
1804 sub cancel {
1805   my( $self, %opt ) = @_;
1806
1807   warn "$me cancel called on customer ". $self->custnum. " with options ".
1808        join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
1809     if $DEBUG;
1810
1811   return ( 'access denied' )
1812     unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
1813
1814   if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1815
1816     #should try decryption (we might have the private key)
1817     # and if not maybe queue a job for the server that does?
1818     return ( "Can't (yet) ban encrypted credit cards" )
1819       if $self->is_encrypted($self->payinfo);
1820
1821     my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1822     my $error = $ban->insert;
1823     return ( $error ) if $error;
1824
1825   }
1826
1827   my @pkgs = $self->ncancelled_pkgs;
1828
1829   warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
1830        scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
1831     if $DEBUG;
1832
1833   grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
1834 }
1835
1836 sub _banned_pay_hashref {
1837   my $self = shift;
1838
1839   my %payby2ban = (
1840     'CARD' => 'CARD',
1841     'DCRD' => 'CARD',
1842     'CHEK' => 'CHEK',
1843     'DCHK' => 'CHEK'
1844   );
1845
1846   {
1847     'payby'   => $payby2ban{$self->payby},
1848     'payinfo' => md5_base64($self->payinfo),
1849     #don't ever *search* on reason! #'reason'  =>
1850   };
1851 }
1852
1853 =item notes
1854
1855 Returns all notes (see L<FS::cust_main_note>) for this customer.
1856
1857 =cut
1858
1859 sub notes {
1860   my $self = shift;
1861   #order by?
1862   qsearch( 'cust_main_note',
1863            { 'custnum' => $self->custnum },
1864            '',
1865            'ORDER BY _DATE DESC'
1866          );
1867 }
1868
1869 =item agent
1870
1871 Returns the agent (see L<FS::agent>) for this customer.
1872
1873 =cut
1874
1875 sub agent {
1876   my $self = shift;
1877   qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1878 }
1879
1880 =item bill_and_collect
1881
1882 Cancels and suspends any packages due, generates bills, applies payments and
1883 cred
1884
1885 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
1886
1887 Options are passed as name-value pairs.  Currently available options are:
1888
1889 =over 4
1890
1891 =item time
1892
1893 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:
1894
1895  use Date::Parse;
1896  ...
1897  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1898
1899 =item invoice_time
1900
1901 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.
1902
1903 =item check_freq
1904
1905 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1906
1907 =item resetup
1908
1909 If set true, re-charges setup fees.
1910
1911 =item debug
1912
1913 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)
1914
1915 =back
1916
1917 =cut
1918
1919 sub bill_and_collect {
1920   my( $self, %options ) = @_;
1921
1922   ###
1923   # cancel packages
1924   ###
1925
1926   #$^T not $options{time} because freeside-daily -d is for pre-printing invoices
1927   foreach my $cust_pkg (
1928     grep { $_->expire && $_->expire <= $^T } $self->ncancelled_pkgs
1929   ) {
1930     my $error = $cust_pkg->cancel;
1931     warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
1932          " for custnum ". $self->custnum. ": $error"
1933       if $error;
1934   }
1935
1936   ###
1937   # suspend packages
1938   ###
1939
1940   #$^T not $options{time} because freeside-daily -d is for pre-printing invoices
1941   foreach my $cust_pkg (
1942     grep { (    $_->part_pkg->is_prepaid && $_->bill && $_->bill < $^T
1943              || $_->adjourn && $_->adjourn <= $^T
1944            )
1945            && ! $_->susp
1946          }
1947          $self->ncancelled_pkgs
1948   ) {
1949     my $error = $cust_pkg->suspend;
1950     warn "Error suspending package ". $cust_pkg->pkgnum.
1951          " for custnum ". $self->custnum. ": $error"
1952       if $error;
1953   }
1954
1955   ###
1956   # bill and collect
1957   ###
1958
1959   my $error = $self->bill( %options );
1960   warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
1961
1962   $self->apply_payments_and_credits;
1963
1964   $error = $self->collect( %options );
1965   warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
1966
1967 }
1968
1969 =item bill OPTIONS
1970
1971 Generates invoices (see L<FS::cust_bill>) for this customer.  Usually used in
1972 conjunction with the collect method by calling B<bill_and_collect>.
1973
1974 If there is an error, returns the error, otherwise returns false.
1975
1976 Options are passed as name-value pairs.  Currently available options are:
1977
1978 =over 4
1979
1980 =item resetup
1981
1982 If set true, re-charges setup fees.
1983
1984 =item time
1985
1986 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:
1987
1988  use Date::Parse;
1989  ...
1990  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1991
1992 =item pkg_list
1993
1994 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
1995
1996  $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
1997
1998 =item invoice_time
1999
2000 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.
2001
2002 =back
2003
2004 =cut
2005
2006 sub bill {
2007   my( $self, %options ) = @_;
2008   return '' if $self->payby eq 'COMP';
2009   warn "$me bill customer ". $self->custnum. "\n"
2010     if $DEBUG;
2011
2012   my $time = $options{'time'} || time;
2013
2014   my $error;
2015
2016   #put below somehow?
2017   local $SIG{HUP} = 'IGNORE';
2018   local $SIG{INT} = 'IGNORE';
2019   local $SIG{QUIT} = 'IGNORE';
2020   local $SIG{TERM} = 'IGNORE';
2021   local $SIG{TSTP} = 'IGNORE';
2022   local $SIG{PIPE} = 'IGNORE';
2023
2024   my $oldAutoCommit = $FS::UID::AutoCommit;
2025   local $FS::UID::AutoCommit = 0;
2026   my $dbh = dbh;
2027
2028   $self->select_for_update; #mutex
2029
2030   #create a new invoice
2031   #(we'll remove it later if it doesn't actually need to be generated [contains
2032   # no line items] and we're inside a transaciton so nothing else will see it)
2033   my $cust_bill = new FS::cust_bill ( {
2034     'custnum' => $self->custnum,
2035     '_date'   => ( $options{'invoice_time'} || $time ),
2036     #'charged' => $charged,
2037     'charged' => 0,
2038   } );
2039   $error = $cust_bill->insert;
2040   if ( $error ) {
2041     $dbh->rollback if $oldAutoCommit;
2042     return "can't create invoice for customer #". $self->custnum. ": $error";
2043   }
2044   my $invnum = $cust_bill->invnum;
2045
2046   ###
2047   # find the packages which are due for billing, find out how much they are
2048   # & generate invoice database.
2049   ###
2050
2051   my( $total_setup, $total_recur ) = ( 0, 0 );
2052   my %tax;
2053   my @precommit_hooks = ();
2054
2055   foreach my $cust_pkg (
2056     qsearch('cust_pkg', { 'custnum' => $self->custnum } )
2057   ) {
2058
2059     #NO!! next if $cust_pkg->cancel;
2060     next if $cust_pkg->getfield('cancel');
2061
2062     warn "  bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2063
2064     #? to avoid use of uninitialized value errors... ?
2065     $cust_pkg->setfield('bill', '')
2066       unless defined($cust_pkg->bill);
2067
2068     my $part_pkg = $cust_pkg->part_pkg;
2069
2070     my %hash = $cust_pkg->hash;
2071     my $old_cust_pkg = new FS::cust_pkg \%hash;
2072
2073     my @details = ();
2074
2075     ###
2076     # bill setup
2077     ###
2078
2079     my $setup = 0;
2080     if ( ! $cust_pkg->setup &&
2081          (
2082            ( $conf->exists('disable_setup_suspended_pkgs') &&
2083             ! $cust_pkg->getfield('susp')
2084           ) || ! $conf->exists('disable_setup_suspended_pkgs')
2085          )
2086       || $options{'resetup'}
2087     ) {
2088
2089       warn "    bill setup\n" if $DEBUG > 1;
2090
2091       $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2092       if ( $@ ) {
2093         $dbh->rollback if $oldAutoCommit;
2094         return "$@ running calc_setup for $cust_pkg\n";
2095       }
2096
2097       $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
2098     }
2099
2100     ###
2101     # bill recurring fee
2102     ###
2103
2104     my $recur = 0;
2105     my $sdate;
2106     if ( $part_pkg->getfield('freq') ne '0' &&
2107          ! $cust_pkg->getfield('susp') &&
2108          ( $cust_pkg->getfield('bill') || 0 ) <= $time
2109     ) {
2110
2111       # XXX should this be a package event?  probably.  events are called
2112       # at collection time at the moment, though...
2113       if ( $part_pkg->can('reset_usage') ) {
2114         warn "    resetting usage counters" if $DEBUG > 1;
2115         $part_pkg->reset_usage($cust_pkg);
2116       }
2117
2118       warn "    bill recur\n" if $DEBUG > 1;
2119
2120       # XXX shared with $recur_prog
2121       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2122
2123       #over two params!  lets at least switch to a hashref for the rest...
2124       my %param = ( 'precommit_hooks' => \@precommit_hooks, );
2125
2126       $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2127       if ( $@ ) {
2128         $dbh->rollback if $oldAutoCommit;
2129         return "$@ running calc_recur for $cust_pkg\n";
2130       }
2131
2132       #change this bit to use Date::Manip? CAREFUL with timezones (see
2133       # mailing list archive)
2134       my ($sec,$min,$hour,$mday,$mon,$year) =
2135         (localtime($sdate) )[0,1,2,3,4,5];
2136
2137       #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
2138       # only for figuring next bill date, nothing else, so, reset $sdate again
2139       # here
2140       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2141       $cust_pkg->last_bill($sdate)
2142         if $cust_pkg->dbdef_table->column('last_bill');
2143
2144       if ( $part_pkg->freq =~ /^\d+$/ ) {
2145         $mon += $part_pkg->freq;
2146         until ( $mon < 12 ) { $mon -= 12; $year++; }
2147       } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
2148         my $weeks = $1;
2149         $mday += $weeks * 7;
2150       } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
2151         my $days = $1;
2152         $mday += $days;
2153       } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
2154         my $hours = $1;
2155         $hour += $hours;
2156       } else {
2157         $dbh->rollback if $oldAutoCommit;
2158         return "unparsable frequency: ". $part_pkg->freq;
2159       }
2160       $cust_pkg->setfield('bill',
2161         timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
2162     }
2163
2164     warn "\$setup is undefined" unless defined($setup);
2165     warn "\$recur is undefined" unless defined($recur);
2166     warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2167
2168     ###
2169     # If $cust_pkg has been modified, update it and create cust_bill_pkg records
2170     ###
2171
2172     if ( $cust_pkg->modified ) {  # hmmm.. and if the options are modified?
2173
2174       warn "  package ". $cust_pkg->pkgnum. " modified; updating\n"
2175         if $DEBUG >1;
2176
2177       $error=$cust_pkg->replace($old_cust_pkg,
2178                                 options => { $cust_pkg->options },
2179                                );
2180       if ( $error ) { #just in case
2181         $dbh->rollback if $oldAutoCommit;
2182         return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
2183       }
2184
2185       $setup = sprintf( "%.2f", $setup );
2186       $recur = sprintf( "%.2f", $recur );
2187       if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2188         $dbh->rollback if $oldAutoCommit;
2189         return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2190       }
2191       if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2192         $dbh->rollback if $oldAutoCommit;
2193         return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2194       }
2195
2196       if ( $setup != 0 || $recur != 0 ) {
2197
2198         warn "    charges (setup=$setup, recur=$recur); adding line items\n"
2199           if $DEBUG > 1;
2200         my $cust_bill_pkg = new FS::cust_bill_pkg ({
2201           'invnum'  => $invnum,
2202           'pkgnum'  => $cust_pkg->pkgnum,
2203           'setup'   => $setup,
2204           'recur'   => $recur,
2205           'sdate'   => $sdate,
2206           'edate'   => $cust_pkg->bill,
2207           'details' => \@details,
2208         });
2209         $error = $cust_bill_pkg->insert;
2210         if ( $error ) {
2211           $dbh->rollback if $oldAutoCommit;
2212           return "can't create invoice line item for invoice #$invnum: $error";
2213         }
2214         $total_setup += $setup;
2215         $total_recur += $recur;
2216
2217         ###
2218         # handle taxes
2219         ###
2220
2221         unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2222
2223           my $prefix =
2224             ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2225             ? 'ship_'
2226             : '';
2227           my %taxhash = map { $_ => $self->get("$prefix$_") }
2228                             qw( state county country );
2229
2230           $taxhash{'taxclass'} = $part_pkg->taxclass;
2231
2232           my @taxes = qsearch( 'cust_main_county', \%taxhash );
2233
2234           unless ( @taxes ) {
2235             $taxhash{'taxclass'} = '';
2236             @taxes =  qsearch( 'cust_main_county', \%taxhash );
2237           }
2238
2239           #one more try at a whole-country tax rate
2240           unless ( @taxes ) {
2241             $taxhash{$_} = '' foreach qw( state county );
2242             @taxes =  qsearch( 'cust_main_county', \%taxhash );
2243           }
2244
2245           # maybe eliminate this entirely, along with all the 0% records
2246           unless ( @taxes ) {
2247             $dbh->rollback if $oldAutoCommit;
2248             return
2249               "fatal: can't find tax rate for state/county/country/taxclass ".
2250               join('/', ( map $self->get("$prefix$_"),
2251                               qw(state county country)
2252                         ),
2253                         $part_pkg->taxclass ). "\n";
2254           }
2255
2256           foreach my $tax ( @taxes ) {
2257
2258             my $taxable_charged = 0;
2259             $taxable_charged += $setup
2260               unless $part_pkg->setuptax =~ /^Y$/i
2261                   || $tax->setuptax =~ /^Y$/i;
2262             $taxable_charged += $recur
2263               unless $part_pkg->recurtax =~ /^Y$/i
2264                   || $tax->recurtax =~ /^Y$/i;
2265             next unless $taxable_charged;
2266
2267             if ( $tax->exempt_amount && $tax->exempt_amount > 0 ) {
2268               #my ($mon,$year) = (localtime($sdate) )[4,5];
2269               my ($mon,$year) = (localtime( $sdate || $cust_bill->_date ) )[4,5];
2270               $mon++;
2271               my $freq = $part_pkg->freq || 1;
2272               if ( $freq !~ /(\d+)$/ ) {
2273                 $dbh->rollback if $oldAutoCommit;
2274                 return "daily/weekly package definitions not (yet?)".
2275                        " compatible with monthly tax exemptions";
2276               }
2277               my $taxable_per_month =
2278                 sprintf("%.2f", $taxable_charged / $freq );
2279
2280               #call the whole thing off if this customer has any old
2281               #exemption records...
2282               my @cust_tax_exempt =
2283                 qsearch( 'cust_tax_exempt' => { custnum=> $self->custnum } );
2284               if ( @cust_tax_exempt ) {
2285                 $dbh->rollback if $oldAutoCommit;
2286                 return
2287                   'this customer still has old-style tax exemption records; '.
2288                   'run bin/fs-migrate-cust_tax_exempt?';
2289               }
2290
2291               foreach my $which_month ( 1 .. $freq ) {
2292
2293                 #maintain the new exemption table now
2294                 my $sql = "
2295                   SELECT SUM(amount)
2296                     FROM cust_tax_exempt_pkg
2297                       LEFT JOIN cust_bill_pkg USING ( billpkgnum )
2298                       LEFT JOIN cust_bill     USING ( invnum     )
2299                     WHERE custnum = ?
2300                       AND taxnum  = ?
2301                       AND year    = ?
2302                       AND month   = ?
2303                 ";
2304                 my $sth = dbh->prepare($sql) or do {
2305                   $dbh->rollback if $oldAutoCommit;
2306                   return "fatal: can't lookup exising exemption: ". dbh->errstr;
2307                 };
2308                 $sth->execute(
2309                   $self->custnum,
2310                   $tax->taxnum,
2311                   1900+$year,
2312                   $mon,
2313                 ) or do {
2314                   $dbh->rollback if $oldAutoCommit;
2315                   return "fatal: can't lookup exising exemption: ". dbh->errstr;
2316                 };
2317                 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
2318
2319                 my $remaining_exemption =
2320                   $tax->exempt_amount - $existing_exemption;
2321                 if ( $remaining_exemption > 0 ) {
2322                   my $addl = $remaining_exemption > $taxable_per_month
2323                     ? $taxable_per_month
2324                     : $remaining_exemption;
2325                   $taxable_charged -= $addl;
2326
2327                   my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg ( {
2328                     'billpkgnum' => $cust_bill_pkg->billpkgnum,
2329                     'taxnum'     => $tax->taxnum,
2330                     'year'       => 1900+$year,
2331                     'month'      => $mon,
2332                     'amount'     => sprintf("%.2f", $addl ),
2333                   } );
2334                   $error = $cust_tax_exempt_pkg->insert;
2335                   if ( $error ) {
2336                     $dbh->rollback if $oldAutoCommit;
2337                     return "fatal: can't insert cust_tax_exempt_pkg: $error";
2338                   }
2339                 } # if $remaining_exemption > 0
2340
2341                 #++
2342                 $mon++;
2343                 #until ( $mon < 12 ) { $mon -= 12; $year++; }
2344                 until ( $mon < 13 ) { $mon -= 12; $year++; }
2345
2346               } #foreach $which_month
2347
2348             } #if $tax->exempt_amount
2349
2350             $taxable_charged = sprintf( "%.2f", $taxable_charged);
2351
2352             #$tax += $taxable_charged * $cust_main_county->tax / 100
2353             $tax{ $tax->taxname || 'Tax' } +=
2354               $taxable_charged * $tax->tax / 100
2355
2356           } #foreach my $tax ( @taxes )
2357
2358         } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2359
2360       } #if $setup != 0 || $recur != 0
2361
2362     } #if $cust_pkg->modified
2363
2364   } #foreach my $cust_pkg
2365
2366   unless ( $cust_bill->cust_bill_pkg ) {
2367     $cust_bill->delete; #don't create an invoice w/o line items
2368
2369    # XXX this seems to be broken
2370    #( DBD::Pg::st execute failed: ERROR:  syntax error at or near "hcb" )
2371 #   # get rid of our fake history too, waste of unecessary space
2372 #    my $h_cleanup_query = q{
2373 #      DELETE FROM h_cust_bill hcb
2374 #       WHERE hcb.invnum = ?
2375 #      AND NOT EXISTS ( SELECT 1 FROM cust_bill cb where cb.invnum = hcb.invnum )
2376 #    };
2377 #    my $h_sth = $dbh->prepare($h_cleanup_query);
2378 #    $h_sth->execute($invnum);
2379
2380     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2381     return '';
2382   }
2383
2384   my $charged = sprintf( "%.2f", $total_setup + $total_recur );
2385
2386   foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2387     my $tax = sprintf("%.2f", $tax{$taxname} );
2388     $charged = sprintf( "%.2f", $charged+$tax );
2389
2390     my $cust_bill_pkg = new FS::cust_bill_pkg ({
2391       'invnum'   => $invnum,
2392       'pkgnum'   => 0,
2393       'setup'    => $tax,
2394       'recur'    => 0,
2395       'sdate'    => '',
2396       'edate'    => '',
2397       'itemdesc' => $taxname,
2398     });
2399     $error = $cust_bill_pkg->insert;
2400     if ( $error ) {
2401       $dbh->rollback if $oldAutoCommit;
2402       return "can't create invoice line item for invoice #$invnum: $error";
2403     }
2404     $total_setup += $tax;
2405
2406   }
2407
2408   $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2409   $error = $cust_bill->replace;
2410   if ( $error ) {
2411     $dbh->rollback if $oldAutoCommit;
2412     return "can't update charged for invoice #$invnum: $error";
2413   }
2414
2415   foreach my $hook ( @precommit_hooks ) {
2416     eval {
2417       &{$hook}; #($self) ?
2418     };
2419     if ( $@ ) {
2420       $dbh->rollback if $oldAutoCommit;
2421       return "$@ running precommit hook $hook\n";
2422     }
2423   }
2424
2425   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2426   ''; #no error
2427 }
2428
2429 =item collect OPTIONS
2430
2431 (Attempt to) collect money for this customer's outstanding invoices (see
2432 L<FS::cust_bill>).  Usually used after the bill method.
2433
2434 Actions are now triggered by billing events; see L<FS::part_event> and the
2435 billing events web interface.  Old-style invoice events (see
2436 L<FS::part_bill_event>) have been deprecated.
2437
2438 If there is an error, returns the error, otherwise returns false.
2439
2440 Options are passed as name-value pairs.
2441
2442 Currently available options are:
2443
2444 =over 4
2445
2446 =item invoice_time
2447
2448 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.
2449
2450 =item retry
2451
2452 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
2453
2454 =item quiet
2455
2456 set true to surpress email card/ACH decline notices.
2457
2458 =item check_freq
2459
2460 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2461
2462 =item payby
2463
2464 allows for one time override of normal customer billing method
2465
2466 =item debug
2467
2468 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)
2469
2470
2471 =back
2472
2473 =cut
2474
2475 sub collect {
2476   my( $self, %options ) = @_;
2477   my $invoice_time = $options{'invoice_time'} || time;
2478
2479   #put below somehow?
2480   local $SIG{HUP} = 'IGNORE';
2481   local $SIG{INT} = 'IGNORE';
2482   local $SIG{QUIT} = 'IGNORE';
2483   local $SIG{TERM} = 'IGNORE';
2484   local $SIG{TSTP} = 'IGNORE';
2485   local $SIG{PIPE} = 'IGNORE';
2486
2487   my $oldAutoCommit = $FS::UID::AutoCommit;
2488   local $FS::UID::AutoCommit = 0;
2489   my $dbh = dbh;
2490
2491   $self->select_for_update; #mutex
2492
2493   if ( $DEBUG ) {
2494     my $balance = $self->balance;
2495     warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2496   }
2497
2498   if ( exists($options{'retry_card'}) ) {
2499     carp 'retry_card option passed to collect is deprecated; use retry';
2500     $options{'retry'} ||= $options{'retry_card'};
2501   }
2502   if ( exists($options{'retry'}) && $options{'retry'} ) {
2503     my $error = $self->retry_realtime;
2504     if ( $error ) {
2505       $dbh->rollback if $oldAutoCommit;
2506       return $error;
2507     }
2508   }
2509
2510   # false laziness w/pay_batch::import_results
2511
2512   my $due_cust_event = $self->due_cust_event(
2513     'debug'      => ( $options{'debug'} || 0 ),
2514     'time'       => $invoice_time,
2515     'check_freq' => $options{'check_freq'},
2516   );
2517   unless( ref($due_cust_event) ) {
2518     $dbh->rollback if $oldAutoCommit;
2519     return $due_cust_event;
2520   }
2521
2522   foreach my $cust_event ( @$due_cust_event ) {
2523
2524     #XXX lock event
2525
2526     #re-eval event conditions (a previous event could have changed things)
2527     unless ( $cust_event->test_conditions( 'time' => $invoice_time ) ) {
2528       #don't leave stray "new/locked" records around
2529       my $error = $cust_event->delete;
2530       if ( $error ) {
2531         #gah, even with transactions
2532         $dbh->commit if $oldAutoCommit; #well.
2533         return $error;
2534       }
2535       next;
2536     }
2537
2538     {
2539       local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2540       warn "  running cust_event ". $cust_event->eventnum. "\n"
2541         if $DEBUG > 1;
2542
2543
2544       #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2545       if ( my $error = $cust_event->do_event() ) {
2546         #XXX wtf is this?  figure out a proper dealio with return value
2547         #from do_event
2548           # gah, even with transactions.
2549           $dbh->commit if $oldAutoCommit; #well.
2550           return $error;
2551         }
2552     }
2553
2554   }
2555
2556   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2557   '';
2558
2559 }
2560
2561 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2562
2563 Inserts database records for and returns an ordered listref of new events due
2564 for this customer, as FS::cust_event objects (see L<FS::cust_event>).  If no
2565 events are due, an empty listref is returned.  If there is an error, returns a
2566 scalar error message.
2567
2568 To actually run the events, call each event's test_condition method, and if
2569 still true, call the event's do_event method.
2570
2571 Options are passed as a hashref or as a list of name-value pairs.  Available
2572 options are:
2573
2574 =over 4
2575
2576 =item check_freq
2577
2578 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.
2579
2580 =item time
2581
2582 "Current time" for the events.
2583
2584 =item debug
2585
2586 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)
2587
2588 =item eventtable
2589
2590 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2591
2592 =item objects
2593
2594 Explicitly pass the objects to be tested (typically used with eventtable).
2595
2596 =back
2597
2598 =cut
2599
2600 sub due_cust_event {
2601   my $self = shift;
2602   my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2603
2604   #???
2605   #my $DEBUG = $opt{'debug'}
2606   local($DEBUG) = $opt{'debug'}
2607     if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
2608
2609   warn "$me due_cust_event called with options ".
2610        join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2611     if $DEBUG;
2612
2613   $opt{'time'} ||= time;
2614
2615   local $SIG{HUP} = 'IGNORE';
2616   local $SIG{INT} = 'IGNORE';
2617   local $SIG{QUIT} = 'IGNORE';
2618   local $SIG{TERM} = 'IGNORE';
2619   local $SIG{TSTP} = 'IGNORE';
2620   local $SIG{PIPE} = 'IGNORE';
2621
2622   my $oldAutoCommit = $FS::UID::AutoCommit;
2623   local $FS::UID::AutoCommit = 0;
2624   my $dbh = dbh;
2625
2626   $self->select_for_update; #mutex
2627
2628   ###
2629   # 1: find possible events (initial search)
2630   ###
2631
2632   my @cust_event = ();
2633
2634   my @eventtable = $opt{'eventtable'}
2635                      ? ( $opt{'eventtable'} )
2636                      : FS::part_event->eventtables_runorder;
2637
2638   foreach my $eventtable ( @eventtable ) {
2639
2640     my @objects;
2641     if ( $opt{'objects'} ) {
2642
2643       @objects = @{ $opt{'objects'} };
2644
2645     } else {
2646
2647       #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
2648       @objects = ( $eventtable eq 'cust_main' )
2649                    ? ( $self )
2650                    : ( $self->$eventtable() );
2651
2652     }
2653
2654     my @e_cust_event = ();
2655
2656     my $cross = "CROSS JOIN $eventtable";
2657     $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2658       unless $eventtable eq 'cust_main';
2659
2660     foreach my $object ( @objects ) {
2661
2662       #this first search uses the condition_sql magic for optimization.
2663       #the more possible events we can eliminate in this step the better
2664
2665       my $cross_where = '';
2666       my $pkey = $object->primary_key;
2667       $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2668
2669       my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2670       my $extra_sql =
2671         FS::part_event_condition->where_conditions_sql( $eventtable,
2672                                                         'time'=>$opt{'time'}
2673                                                       );
2674       my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2675
2676       $extra_sql = "AND $extra_sql" if $extra_sql;
2677
2678       #here is the agent virtualization
2679       $extra_sql .= " AND (    part_event.agentnum IS NULL
2680                             OR part_event.agentnum = ". $self->agentnum. ' )';
2681
2682       $extra_sql .= " $order";
2683
2684       warn "searching for events for $eventtable ". $object->$pkey. "\n"
2685         if $opt{'debug'} > 2;
2686       my @part_event = qsearch( {
2687         'debug'     => ( $opt{'debug'} > 3 ? 1 : 0 ),
2688         'select'    => 'part_event.*',
2689         'table'     => 'part_event',
2690         'addl_from' => "$cross $join",
2691         'hashref'   => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
2692                          'eventtable' => $eventtable,
2693                          'disabled'   => '',
2694                        },
2695         'extra_sql' => "AND $cross_where $extra_sql",
2696       } );
2697
2698       if ( $DEBUG > 2 ) {
2699         my $pkey = $object->primary_key;
2700         warn "      ". scalar(@part_event).
2701              " possible events found for $eventtable ". $object->$pkey(). "\n";
2702       }
2703
2704       push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
2705
2706     }
2707
2708     warn "    ". scalar(@e_cust_event).
2709          " subtotal possible cust events found for $eventtable\n"
2710       if $DEBUG > 1;
2711
2712     push @cust_event, @e_cust_event;
2713
2714   }
2715
2716   warn "  ". scalar(@cust_event).
2717        " total possible cust events found in initial search\n"
2718     if $DEBUG; # > 1;
2719
2720   ##
2721   # 2: test conditions
2722   ##
2723
2724   my %unsat = ();
2725
2726   @cust_event = grep $_->test_conditions( 'time'          => $opt{'time'},
2727                                           'stats_hashref' => \%unsat ),
2728                      @cust_event;
2729
2730   warn "  ". scalar(@cust_event). " cust events left satisfying conditions\n"
2731     if $DEBUG; # > 1;
2732
2733   warn "    invalid conditions not eliminated with condition_sql:\n".
2734        join('', map "      $_: ".$unsat{$_}."\n", keys %unsat )
2735     if $DEBUG; # > 1;
2736
2737   ##
2738   # 3: insert
2739   ##
2740
2741   foreach my $cust_event ( @cust_event ) {
2742
2743     my $error = $cust_event->insert();
2744     if ( $error ) {
2745       $dbh->rollback if $oldAutoCommit;
2746       return $error;
2747     }
2748
2749   }
2750
2751   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2752
2753   ##
2754   # 4: return
2755   ##
2756
2757   warn "  returning events: ". Dumper(@cust_event). "\n"
2758     if $DEBUG > 2;
2759
2760   \@cust_event;
2761
2762 }
2763
2764 =item retry_realtime
2765
2766 Schedules realtime / batch  credit card / electronic check / LEC billing
2767 events for for retry.  Useful if card information has changed or manual
2768 retry is desired.  The 'collect' method must be called to actually retry
2769 the transaction.
2770
2771 Implementation details: For either this customer, or for each of this
2772 customer's open invoices, changes the status of the first "done" (with
2773 statustext error) realtime processing event to "failed".
2774
2775 =cut
2776
2777 sub retry_realtime {
2778   my $self = shift;
2779
2780   local $SIG{HUP} = 'IGNORE';
2781   local $SIG{INT} = 'IGNORE';
2782   local $SIG{QUIT} = 'IGNORE';
2783   local $SIG{TERM} = 'IGNORE';
2784   local $SIG{TSTP} = 'IGNORE';
2785   local $SIG{PIPE} = 'IGNORE';
2786
2787   my $oldAutoCommit = $FS::UID::AutoCommit;
2788   local $FS::UID::AutoCommit = 0;
2789   my $dbh = dbh;
2790
2791   #a little false laziness w/due_cust_event (not too bad, really)
2792
2793   my $join = FS::part_event_condition->join_conditions_sql;
2794   my $order = FS::part_event_condition->order_conditions_sql;
2795   my $mine =
2796   '( '
2797    . join ( ' OR ' , map {
2798     "( part_event.eventtable = " . dbh->quote($_)
2799     . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
2800    } FS::part_event->eventtables)
2801    . ') ';
2802
2803   #here is the agent virtualization
2804   my $agent_virt = " (    part_event.agentnum IS NULL
2805                        OR part_event.agentnum = ". $self->agentnum. ' )';
2806
2807   #XXX this shouldn't be hardcoded, actions should declare it...
2808   my @realtime_events = qw(
2809     cust_bill_realtime_card
2810     cust_bill_realtime_check
2811     cust_bill_realtime_lec
2812     cust_bill_batch
2813   );
2814
2815   my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
2816                                                   @realtime_events
2817                                      ).
2818                           ' ) ';
2819
2820   my @cust_event = qsearchs({
2821     'table'     => 'cust_event',
2822     'select'    => 'cust_event.*',
2823     'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
2824     'hashref'   => { 'status' => 'done' },
2825     'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
2826                    " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
2827   });
2828
2829   my %seen_invnum = ();
2830   foreach my $cust_event (@cust_event) {
2831
2832     #max one for the customer, one for each open invoice
2833     my $cust_X = $cust_event->cust_X;
2834     next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
2835                           ? $cust_X->invnum
2836                           : 0
2837                         }++
2838          or $cust_event->part_event->eventtable eq 'cust_bill'
2839             && ! $cust_X->owed;
2840
2841     my $error = $cust_event->retry;
2842     if ( $error ) {
2843       $dbh->rollback if $oldAutoCommit;
2844       return "error scheduling event for retry: $error";
2845     }
2846
2847   }
2848
2849   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2850   '';
2851
2852 }
2853
2854 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2855
2856 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2857 via a Business::OnlinePayment realtime gateway.  See
2858 L<http://420.am/business-onlinepayment> for supported gateways.
2859
2860 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2861
2862 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>
2863
2864 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2865 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
2866 if set, will override the value from the customer record.
2867
2868 I<description> is a free-text field passed to the gateway.  It defaults to
2869 "Internet services".
2870
2871 If an I<invnum> is specified, this payment (if successful) is applied to the
2872 specified invoice.  If you don't specify an I<invnum> you might want to
2873 call the B<apply_payments> method.
2874
2875 I<quiet> can be set true to surpress email decline notices.
2876
2877 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
2878 resulting paynum, if any.
2879
2880 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2881
2882 =cut
2883
2884 sub realtime_bop {
2885   my( $self, $method, $amount, %options ) = @_;
2886   if ( $DEBUG ) {
2887     warn "$me realtime_bop: $method $amount\n";
2888     warn "  $_ => $options{$_}\n" foreach keys %options;
2889   }
2890
2891   $options{'description'} ||= 'Internet services';
2892
2893   eval "use Business::OnlinePayment";
2894   die $@ if $@;
2895
2896   my $payinfo = exists($options{'payinfo'})
2897                   ? $options{'payinfo'}
2898                   : $self->payinfo;
2899
2900   my %method2payby = (
2901     'CC'     => 'CARD',
2902     'ECHECK' => 'CHEK',
2903     'LEC'    => 'LECB',
2904   );
2905
2906   ###
2907   # check for banned credit card/ACH
2908   ###
2909
2910   my $ban = qsearchs('banned_pay', {
2911     'payby'   => $method2payby{$method},
2912     'payinfo' => md5_base64($payinfo),
2913   } );
2914   return "Banned credit card" if $ban;
2915
2916   ###
2917   # select a gateway
2918   ###
2919
2920   my $taxclass = '';
2921   if ( $options{'invnum'} ) {
2922     my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2923     die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2924     my @taxclasses =
2925       map  { $_->part_pkg->taxclass }
2926       grep { $_ }
2927       map  { $_->cust_pkg }
2928       $cust_bill->cust_bill_pkg;
2929     unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2930                                                            #different taxclasses
2931       $taxclass = $taxclasses[0];
2932     }
2933   }
2934
2935   #look for an agent gateway override first
2936   my $cardtype;
2937   if ( $method eq 'CC' ) {
2938     $cardtype = cardtype($payinfo);
2939   } elsif ( $method eq 'ECHECK' ) {
2940     $cardtype = 'ACH';
2941   } else {
2942     $cardtype = $method;
2943   }
2944
2945   my $override =
2946        qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2947                                            cardtype => $cardtype,
2948                                            taxclass => $taxclass,       } )
2949     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2950                                            cardtype => '',
2951                                            taxclass => $taxclass,       } )
2952     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2953                                            cardtype => $cardtype,
2954                                            taxclass => '',              } )
2955     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2956                                            cardtype => '',
2957                                            taxclass => '',              } );
2958
2959   my $payment_gateway = '';
2960   my( $processor, $login, $password, $action, @bop_options );
2961   if ( $override ) { #use a payment gateway override
2962
2963     $payment_gateway = $override->payment_gateway;
2964
2965     $processor   = $payment_gateway->gateway_module;
2966     $login       = $payment_gateway->gateway_username;
2967     $password    = $payment_gateway->gateway_password;
2968     $action      = $payment_gateway->gateway_action;
2969     @bop_options = $payment_gateway->options;
2970
2971   } else { #use the standard settings from the config
2972
2973     ( $processor, $login, $password, $action, @bop_options ) =
2974       $self->default_payment_gateway($method);
2975
2976   }
2977
2978   ###
2979   # massage data
2980   ###
2981
2982   my $address = exists($options{'address1'})
2983                     ? $options{'address1'}
2984                     : $self->address1;
2985   my $address2 = exists($options{'address2'})
2986                     ? $options{'address2'}
2987                     : $self->address2;
2988   $address .= ", ". $address2 if length($address2);
2989
2990   my $o_payname = exists($options{'payname'})
2991                     ? $options{'payname'}
2992                     : $self->payname;
2993   my($payname, $payfirst, $paylast);
2994   if ( $o_payname && $method ne 'ECHECK' ) {
2995     ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2996       or return "Illegal payname $payname";
2997     ($payfirst, $paylast) = ($1, $2);
2998   } else {
2999     $payfirst = $self->getfield('first');
3000     $paylast = $self->getfield('last');
3001     $payname =  "$payfirst $paylast";
3002   }
3003
3004   my @invoicing_list = $self->invoicing_list_emailonly;
3005   if ( $conf->exists('emailinvoiceautoalways')
3006        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3007        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3008     push @invoicing_list, $self->all_emails;
3009   }
3010
3011   my $email = ($conf->exists('business-onlinepayment-email-override'))
3012               ? $conf->config('business-onlinepayment-email-override')
3013               : $invoicing_list[0];
3014
3015   my %content = ();
3016
3017   my $payip = exists($options{'payip'})
3018                 ? $options{'payip'}
3019                 : $self->payip;
3020   $content{customer_ip} = $payip
3021     if length($payip);
3022
3023   $content{invoice_number} = $options{'invnum'}
3024     if exists($options{'invnum'}) && length($options{'invnum'});
3025
3026   my $paydate = '';
3027   if ( $method eq 'CC' ) {
3028
3029     $content{card_number} = $payinfo;
3030     $paydate = exists($options{'paydate'})
3031                     ? $options{'paydate'}
3032                     : $self->paydate;
3033     $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3034     $content{expiration} = "$2/$1";
3035
3036     my $paycvv = exists($options{'paycvv'})
3037                    ? $options{'paycvv'}
3038                    : $self->paycvv;
3039     $content{cvv2} = $self->paycvv
3040       if length($paycvv);
3041
3042     my $paystart_month = exists($options{'paystart_month'})
3043                            ? $options{'paystart_month'}
3044                            : $self->paystart_month;
3045
3046     my $paystart_year  = exists($options{'paystart_year'})
3047                            ? $options{'paystart_year'}
3048                            : $self->paystart_year;
3049
3050     $content{card_start} = "$paystart_month/$paystart_year"
3051       if $paystart_month && $paystart_year;
3052
3053     my $payissue       = exists($options{'payissue'})
3054                            ? $options{'payissue'}
3055                            : $self->payissue;
3056     $content{issue_number} = $payissue if $payissue;
3057
3058     $content{recurring_billing} = 'YES'
3059       if qsearch('cust_pay', { 'custnum' => $self->custnum,
3060                                'payby'   => 'CARD',
3061                                'payinfo' => $payinfo,
3062                              } )
3063       || qsearch('cust_pay', { 'custnum' => $self->custnum,
3064                                'payby'   => 'CARD',
3065                                'paymask' => $self->mask_payinfo('CARD', $payinfo),
3066                              } );
3067
3068
3069   } elsif ( $method eq 'ECHECK' ) {
3070     ( $content{account_number}, $content{routing_code} ) =
3071       split('@', $payinfo);
3072     $content{bank_name} = $o_payname;
3073     $content{bank_state} = exists($options{'paystate'})
3074                              ? $options{'paystate'}
3075                              : $self->getfield('paystate');
3076     $content{account_type} = exists($options{'paytype'})
3077                                ? uc($options{'paytype'}) || 'CHECKING'
3078                                : uc($self->getfield('paytype')) || 'CHECKING';
3079     $content{account_name} = $payname;
3080     $content{customer_org} = $self->company ? 'B' : 'I';
3081     $content{state_id}       = exists($options{'stateid'})
3082                                  ? $options{'stateid'}
3083                                  : $self->getfield('stateid');
3084     $content{state_id_state} = exists($options{'stateid_state'})
3085                                  ? $options{'stateid_state'}
3086                                  : $self->getfield('stateid_state');
3087     $content{customer_ssn} = exists($options{'ss'})
3088                                ? $options{'ss'}
3089                                : $self->ss;
3090   } elsif ( $method eq 'LEC' ) {
3091     $content{phone} = $payinfo;
3092   }
3093
3094   ###
3095   # run transaction(s)
3096   ###
3097
3098   my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3099
3100   my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3101   $transaction->content(
3102     'type'           => $method,
3103     'login'          => $login,
3104     'password'       => $password,
3105     'action'         => $action1,
3106     'description'    => $options{'description'},
3107     'amount'         => $amount,
3108     #'invoice_number' => $options{'invnum'},
3109     'customer_id'    => $self->custnum,
3110     'last_name'      => $paylast,
3111     'first_name'     => $payfirst,
3112     'name'           => $payname,
3113     'address'        => $address,
3114     'city'           => ( exists($options{'city'})
3115                             ? $options{'city'}
3116                             : $self->city          ),
3117     'state'          => ( exists($options{'state'})
3118                             ? $options{'state'}
3119                             : $self->state          ),
3120     'zip'            => ( exists($options{'zip'})
3121                             ? $options{'zip'}
3122                             : $self->zip          ),
3123     'country'        => ( exists($options{'country'})
3124                             ? $options{'country'}
3125                             : $self->country          ),
3126     'referer'        => 'http://cleanwhisker.420.am/',
3127     'email'          => $email,
3128     'phone'          => $self->daytime || $self->night,
3129     %content, #after
3130   );
3131   $transaction->submit();
3132
3133   if ( $transaction->is_success() && $action2 ) {
3134     my $auth = $transaction->authorization;
3135     my $ordernum = $transaction->can('order_number')
3136                    ? $transaction->order_number
3137                    : '';
3138
3139     my $capture =
3140       new Business::OnlinePayment( $processor, @bop_options );
3141
3142     my %capture = (
3143       %content,
3144       type           => $method,
3145       action         => $action2,
3146       login          => $login,
3147       password       => $password,
3148       order_number   => $ordernum,
3149       amount         => $amount,
3150       authorization  => $auth,
3151       description    => $options{'description'},
3152     );
3153
3154     foreach my $field (qw( authorization_source_code returned_ACI
3155                            transaction_identifier validation_code
3156                            transaction_sequence_num local_transaction_date
3157                            local_transaction_time AVS_result_code          )) {
3158       $capture{$field} = $transaction->$field() if $transaction->can($field);
3159     }
3160
3161     $capture->content( %capture );
3162
3163     $capture->submit();
3164
3165     unless ( $capture->is_success ) {
3166       my $e = "Authorization successful but capture failed, custnum #".
3167               $self->custnum. ': '.  $capture->result_code.
3168               ": ". $capture->error_message;
3169       warn $e;
3170       return $e;
3171     }
3172
3173   }
3174
3175   ###
3176   # remove paycvv after initial transaction
3177   ###
3178
3179   #false laziness w/misc/process/payment.cgi - check both to make sure working
3180   # correctly
3181   if ( defined $self->dbdef_table->column('paycvv')
3182        && length($self->paycvv)
3183        && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3184   ) {
3185     my $error = $self->remove_cvv;
3186     if ( $error ) {
3187       warn "WARNING: error removing cvv: $error\n";
3188     }
3189   }
3190
3191   ###
3192   # result handling
3193   ###
3194
3195   if ( $transaction->is_success() ) {
3196
3197     my %method2payby = (
3198       'CC'     => 'CARD',
3199       'ECHECK' => 'CHEK',
3200       'LEC'    => 'LECB',
3201     );
3202
3203     my $paybatch = '';
3204     if ( $payment_gateway ) { # agent override
3205       $paybatch = $payment_gateway->gatewaynum. '-';
3206     }
3207
3208     $paybatch .= "$processor:". $transaction->authorization;
3209
3210     $paybatch .= ':'. $transaction->order_number
3211       if $transaction->can('order_number')
3212       && length($transaction->order_number);
3213
3214     my $cust_pay = new FS::cust_pay ( {
3215        'custnum'  => $self->custnum,
3216        'invnum'   => $options{'invnum'},
3217        'paid'     => $amount,
3218        '_date'     => '',
3219        'payby'    => $method2payby{$method},
3220        'payinfo'  => $payinfo,
3221        'paybatch' => $paybatch,
3222        'paydate'  => $paydate,
3223     } );
3224     $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
3225
3226     my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3227
3228     if ( $error ) {
3229       $cust_pay->invnum(''); #try again with no specific invnum
3230       my $error2 = $cust_pay->insert( $options{'manual'} ?
3231                                       ( 'manual' => 1 ) : ()
3232                                     );
3233       if ( $error2 ) {
3234         # gah, even with transactions.
3235         my $e = 'WARNING: Card/ACH debited but database not updated - '.
3236                 "error inserting payment ($processor): $error2".
3237                 " (previously tried insert with invnum #$options{'invnum'}" .
3238                 ": $error )";
3239         warn $e;
3240         return $e;
3241       }
3242     }
3243
3244     if ( $options{'paynum_ref'} ) {
3245       ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3246     }
3247
3248     return ''; #no error
3249
3250   } else {
3251
3252     my $perror = "$processor error: ". $transaction->error_message;
3253
3254     unless ( $transaction->error_message ) {
3255
3256       my $t_response;
3257       if ( $transaction->can('response_page') ) {
3258         $t_response = {
3259                         'page'    => ( $transaction->can('response_page')
3260                                          ? $transaction->response_page
3261                                          : ''
3262                                      ),
3263                         'code'    => ( $transaction->can('response_code')
3264                                          ? $transaction->response_code
3265                                          : ''
3266                                      ),
3267                         'headers' => ( $transaction->can('response_headers')
3268                                          ? $transaction->response_headers
3269                                          : ''
3270                                      ),
3271                       };
3272       } else {
3273         $t_response .=
3274           "No additional debugging information available for $processor";
3275       }
3276
3277       $perror .= "No error_message returned from $processor -- ".
3278                  ( ref($t_response) ? Dumper($t_response) : $t_response );
3279
3280     }
3281
3282     if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
3283          && $conf->exists('emaildecline')
3284          && grep { $_ ne 'POST' } $self->invoicing_list
3285          && ! grep { $transaction->error_message =~ /$_/ }
3286                    $conf->config('emaildecline-exclude')
3287     ) {
3288       my @templ = $conf->config('declinetemplate');
3289       my $template = new Text::Template (
3290         TYPE   => 'ARRAY',
3291         SOURCE => [ map "$_\n", @templ ],
3292       ) or return "($perror) can't create template: $Text::Template::ERROR";
3293       $template->compile()
3294         or return "($perror) can't compile template: $Text::Template::ERROR";
3295
3296       my $templ_hash = { error => $transaction->error_message };
3297
3298       my $error = send_email(
3299         'from'    => $conf->config('invoice_from'),
3300         'to'      => [ grep { $_ ne 'POST' } $self->invoicing_list ],
3301         'subject' => 'Your payment could not be processed',
3302         'body'    => [ $template->fill_in(HASH => $templ_hash) ],
3303       );
3304
3305       $perror .= " (also received error sending decline notification: $error)"
3306         if $error;
3307
3308     }
3309
3310     return $perror;
3311   }
3312
3313 }
3314
3315 =item default_payment_gateway
3316
3317 =cut
3318
3319 sub default_payment_gateway {
3320   my( $self, $method ) = @_;
3321
3322   die "Real-time processing not enabled\n"
3323     unless $conf->exists('business-onlinepayment');
3324
3325   #load up config
3326   my $bop_config = 'business-onlinepayment';
3327   $bop_config .= '-ach'
3328     if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
3329   my ( $processor, $login, $password, $action, @bop_options ) =
3330     $conf->config($bop_config);
3331   $action ||= 'normal authorization';
3332   pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3333   die "No real-time processor is enabled - ".
3334       "did you set the business-onlinepayment configuration value?\n"
3335     unless $processor;
3336
3337   ( $processor, $login, $password, $action, @bop_options )
3338 }
3339
3340 =item remove_cvv
3341
3342 Removes the I<paycvv> field from the database directly.
3343
3344 If there is an error, returns the error, otherwise returns false.
3345
3346 =cut
3347
3348 sub remove_cvv {
3349   my $self = shift;
3350   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3351     or return dbh->errstr;
3352   $sth->execute($self->custnum)
3353     or return $sth->errstr;
3354   $self->paycvv('');
3355   '';
3356 }
3357
3358 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3359
3360 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3361 via a Business::OnlinePayment realtime gateway.  See
3362 L<http://420.am/business-onlinepayment> for supported gateways.
3363
3364 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3365
3366 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3367
3368 Most gateways require a reference to an original payment transaction to refund,
3369 so you probably need to specify a I<paynum>.
3370
3371 I<amount> defaults to the original amount of the payment if not specified.
3372
3373 I<reason> specifies a reason for the refund.
3374
3375 I<paydate> specifies the expiration date for a credit card overriding the
3376 value from the customer record or the payment record. Specified as yyyy-mm-dd
3377
3378 Implementation note: If I<amount> is unspecified or equal to the amount of the
3379 orignal payment, first an attempt is made to "void" the transaction via
3380 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3381 the normal attempt is made to "refund" ("credit") the transaction via the
3382 gateway is attempted.
3383
3384 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3385 #I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
3386 #if set, will override the value from the customer record.
3387
3388 #If an I<invnum> is specified, this payment (if successful) is applied to the
3389 #specified invoice.  If you don't specify an I<invnum> you might want to
3390 #call the B<apply_payments> method.
3391
3392 =cut
3393
3394 #some false laziness w/realtime_bop, not enough to make it worth merging
3395 #but some useful small subs should be pulled out
3396 sub realtime_refund_bop {
3397   my( $self, $method, %options ) = @_;
3398   if ( $DEBUG ) {
3399     warn "$me realtime_refund_bop: $method refund\n";
3400     warn "  $_ => $options{$_}\n" foreach keys %options;
3401   }
3402
3403   eval "use Business::OnlinePayment";
3404   die $@ if $@;
3405
3406   ###
3407   # look up the original payment and optionally a gateway for that payment
3408   ###
3409
3410   my $cust_pay = '';
3411   my $amount = $options{'amount'};
3412
3413   my( $processor, $login, $password, @bop_options ) ;
3414   my( $auth, $order_number ) = ( '', '', '' );
3415
3416   if ( $options{'paynum'} ) {
3417
3418     warn "  paynum: $options{paynum}\n" if $DEBUG > 1;
3419     $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3420       or return "Unknown paynum $options{'paynum'}";
3421     $amount ||= $cust_pay->paid;
3422
3423     $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3424       or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3425                 $cust_pay->paybatch;
3426     my $gatewaynum = '';
3427     ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3428
3429     if ( $gatewaynum ) { #gateway for the payment to be refunded
3430
3431       my $payment_gateway =
3432         qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3433       die "payment gateway $gatewaynum not found"
3434         unless $payment_gateway;
3435
3436       $processor   = $payment_gateway->gateway_module;
3437       $login       = $payment_gateway->gateway_username;
3438       $password    = $payment_gateway->gateway_password;
3439       @bop_options = $payment_gateway->options;
3440
3441     } else { #try the default gateway
3442
3443       my( $conf_processor, $unused_action );
3444       ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3445         $self->default_payment_gateway($method);
3446
3447       return "processor of payment $options{'paynum'} $processor does not".
3448              " match default processor $conf_processor"
3449         unless $processor eq $conf_processor;
3450
3451     }
3452
3453
3454   } else { # didn't specify a paynum, so look for agent gateway overrides
3455            # like a normal transaction
3456
3457     my $cardtype;
3458     if ( $method eq 'CC' ) {
3459       $cardtype = cardtype($self->payinfo);
3460     } elsif ( $method eq 'ECHECK' ) {
3461       $cardtype = 'ACH';
3462     } else {
3463       $cardtype = $method;
3464     }
3465     my $override =
3466            qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3467                                                cardtype => $cardtype,
3468                                                taxclass => '',              } )
3469         || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3470                                                cardtype => '',
3471                                                taxclass => '',              } );
3472
3473     if ( $override ) { #use a payment gateway override
3474
3475       my $payment_gateway = $override->payment_gateway;
3476
3477       $processor   = $payment_gateway->gateway_module;
3478       $login       = $payment_gateway->gateway_username;
3479       $password    = $payment_gateway->gateway_password;
3480       #$action      = $payment_gateway->gateway_action;
3481       @bop_options = $payment_gateway->options;
3482
3483     } else { #use the standard settings from the config
3484
3485       my $unused_action;
3486       ( $processor, $login, $password, $unused_action, @bop_options ) =
3487         $self->default_payment_gateway($method);
3488
3489     }
3490
3491   }
3492   return "neither amount nor paynum specified" unless $amount;
3493
3494   my %content = (
3495     'type'           => $method,
3496     'login'          => $login,
3497     'password'       => $password,
3498     'order_number'   => $order_number,
3499     'amount'         => $amount,
3500     'referer'        => 'http://cleanwhisker.420.am/',
3501   );
3502   $content{authorization} = $auth
3503     if length($auth); #echeck/ACH transactions have an order # but no auth
3504                       #(at least with authorize.net)
3505
3506   my $disable_void_after;
3507   if ($conf->exists('disable_void_after')
3508       && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3509     $disable_void_after = $1;
3510   }
3511
3512   #first try void if applicable
3513   if ( $cust_pay && $cust_pay->paid == $amount
3514     && (
3515       ( not defined($disable_void_after) )
3516       || ( time < ($cust_pay->_date + $disable_void_after ) )
3517     )
3518   ) {
3519     warn "  attempting void\n" if $DEBUG > 1;
3520     my $void = new Business::OnlinePayment( $processor, @bop_options );
3521     $void->content( 'action' => 'void', %content );
3522     $void->submit();
3523     if ( $void->is_success ) {
3524       my $error = $cust_pay->void($options{'reason'});
3525       if ( $error ) {
3526         # gah, even with transactions.
3527         my $e = 'WARNING: Card/ACH voided but database not updated - '.
3528                 "error voiding payment: $error";
3529         warn $e;
3530         return $e;
3531       }
3532       warn "  void successful\n" if $DEBUG > 1;
3533       return '';
3534     }
3535   }
3536
3537   warn "  void unsuccessful, trying refund\n"
3538     if $DEBUG > 1;
3539
3540   #massage data
3541   my $address = $self->address1;
3542   $address .= ", ". $self->address2 if $self->address2;
3543
3544   my($payname, $payfirst, $paylast);
3545   if ( $self->payname && $method ne 'ECHECK' ) {
3546     $payname = $self->payname;
3547     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3548       or return "Illegal payname $payname";
3549     ($payfirst, $paylast) = ($1, $2);
3550   } else {
3551     $payfirst = $self->getfield('first');
3552     $paylast = $self->getfield('last');
3553     $payname =  "$payfirst $paylast";
3554   }
3555
3556   my @invoicing_list = $self->invoicing_list_emailonly;
3557   if ( $conf->exists('emailinvoiceautoalways')
3558        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3559        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3560     push @invoicing_list, $self->all_emails;
3561   }
3562
3563   my $email = ($conf->exists('business-onlinepayment-email-override'))
3564               ? $conf->config('business-onlinepayment-email-override')
3565               : $invoicing_list[0];
3566
3567   my $payip = exists($options{'payip'})
3568                 ? $options{'payip'}
3569                 : $self->payip;
3570   $content{customer_ip} = $payip
3571     if length($payip);
3572
3573   my $payinfo = '';
3574   if ( $method eq 'CC' ) {
3575
3576     if ( $cust_pay ) {
3577       $content{card_number} = $payinfo = $cust_pay->payinfo;
3578       (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
3579         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
3580         ($content{expiration} = "$2/$1");  # where available
3581     } else {
3582       $content{card_number} = $payinfo = $self->payinfo;
3583       (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
3584         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3585       $content{expiration} = "$2/$1";
3586     }
3587
3588   } elsif ( $method eq 'ECHECK' ) {
3589
3590     if ( $cust_pay ) {
3591       $payinfo = $cust_pay->payinfo;
3592     } else {
3593       $payinfo = $self->payinfo;
3594     }
3595     ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
3596     $content{bank_name} = $self->payname;
3597     $content{account_type} = 'CHECKING';
3598     $content{account_name} = $payname;
3599     $content{customer_org} = $self->company ? 'B' : 'I';
3600     $content{customer_ssn} = $self->ss;
3601   } elsif ( $method eq 'LEC' ) {
3602     $content{phone} = $payinfo = $self->payinfo;
3603   }
3604
3605   #then try refund
3606   my $refund = new Business::OnlinePayment( $processor, @bop_options );
3607   my %sub_content = $refund->content(
3608     'action'         => 'credit',
3609     'customer_id'    => $self->custnum,
3610     'last_name'      => $paylast,
3611     'first_name'     => $payfirst,
3612     'name'           => $payname,
3613     'address'        => $address,
3614     'city'           => $self->city,
3615     'state'          => $self->state,
3616     'zip'            => $self->zip,
3617     'country'        => $self->country,
3618     'email'          => $email,
3619     'phone'          => $self->daytime || $self->night,
3620     %content, #after
3621   );
3622   warn join('', map { "  $_ => $sub_content{$_}\n" } keys %sub_content )
3623     if $DEBUG > 1;
3624   $refund->submit();
3625
3626   return "$processor error: ". $refund->error_message
3627     unless $refund->is_success();
3628
3629   my %method2payby = (
3630     'CC'     => 'CARD',
3631     'ECHECK' => 'CHEK',
3632     'LEC'    => 'LECB',
3633   );
3634
3635   my $paybatch = "$processor:". $refund->authorization;
3636   $paybatch .= ':'. $refund->order_number
3637     if $refund->can('order_number') && $refund->order_number;
3638
3639   while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3640     my @cust_bill_pay = $cust_pay->cust_bill_pay;
3641     last unless @cust_bill_pay;
3642     my $cust_bill_pay = pop @cust_bill_pay;
3643     my $error = $cust_bill_pay->delete;
3644     last if $error;
3645   }
3646
3647   my $cust_refund = new FS::cust_refund ( {
3648     'custnum'  => $self->custnum,
3649     'paynum'   => $options{'paynum'},
3650     'refund'   => $amount,
3651     '_date'    => '',
3652     'payby'    => $method2payby{$method},
3653     'payinfo'  => $payinfo,
3654     'paybatch' => $paybatch,
3655     'reason'   => $options{'reason'} || 'card or ACH refund',
3656   } );
3657   my $error = $cust_refund->insert;
3658   if ( $error ) {
3659     $cust_refund->paynum(''); #try again with no specific paynum
3660     my $error2 = $cust_refund->insert;
3661     if ( $error2 ) {
3662       # gah, even with transactions.
3663       my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3664               "error inserting refund ($processor): $error2".
3665               " (previously tried insert with paynum #$options{'paynum'}" .
3666               ": $error )";
3667       warn $e;
3668       return $e;
3669     }
3670   }
3671
3672   ''; #no error
3673
3674 }
3675
3676 =item batch_card OPTION => VALUE...
3677
3678 Adds a payment for this invoice to the pending credit card batch (see
3679 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
3680 runs the payment using a realtime gateway.
3681
3682 =cut
3683
3684 sub batch_card {
3685   my ($self, %options) = @_;
3686
3687   my $amount;
3688   if (exists($options{amount})) {
3689     $amount = $options{amount};
3690   }else{
3691     $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
3692   }
3693   return '' unless $amount > 0;
3694
3695   my $invnum = delete $options{invnum};
3696   my $payby = $options{invnum} || $self->payby;  #dubious
3697
3698   if ($options{'realtime'}) {
3699     return $self->realtime_bop( FS::payby->payby2bop($self->payby),
3700                                 $amount,
3701                                 %options,
3702                               );
3703   }
3704
3705   my $oldAutoCommit = $FS::UID::AutoCommit;
3706   local $FS::UID::AutoCommit = 0;
3707   my $dbh = dbh;
3708
3709   $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
3710     or return "Cannot lock pay_batch: " . $dbh->errstr;
3711
3712   my %pay_batch = (
3713     'status' => 'O',
3714     'payby'  => FS::payby->payby2payment($payby),
3715   );
3716
3717   my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
3718
3719   unless ( $pay_batch ) {
3720     $pay_batch = new FS::pay_batch \%pay_batch;
3721     my $error = $pay_batch->insert;
3722     if ( $error ) {
3723       $dbh->rollback if $oldAutoCommit;
3724       die "error creating new batch: $error\n";
3725     }
3726   }
3727
3728   my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
3729       'batchnum' => $pay_batch->batchnum,
3730       'custnum'  => $self->custnum,
3731   } );
3732
3733   foreach (qw( address1 address2 city state zip country payby payinfo paydate
3734                payname )) {
3735     $options{$_} = '' unless exists($options{$_});
3736   }
3737
3738   my $cust_pay_batch = new FS::cust_pay_batch ( {
3739     'batchnum' => $pay_batch->batchnum,
3740     'invnum'   => $invnum || 0,                    # is there a better value?
3741                                                    # this field should be
3742                                                    # removed...
3743                                                    # cust_bill_pay_batch now
3744     'custnum'  => $self->custnum,
3745     'last'     => $self->getfield('last'),
3746     'first'    => $self->getfield('first'),
3747     'address1' => $options{address1} || $self->address1,
3748     'address2' => $options{address2} || $self->address2,
3749     'city'     => $options{city}     || $self->city,
3750     'state'    => $options{state}    || $self->state,
3751     'zip'      => $options{zip}      || $self->zip,
3752     'country'  => $options{country}  || $self->country,
3753     'payby'    => $options{payby}    || $self->payby,
3754     'payinfo'  => $options{payinfo}  || $self->payinfo,
3755     'exp'      => $options{paydate}  || $self->paydate,
3756     'payname'  => $options{payname}  || $self->payname,
3757     'amount'   => $amount,                         # consolidating
3758   } );
3759
3760   $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
3761     if $old_cust_pay_batch;
3762
3763   my $error;
3764   if ($old_cust_pay_batch) {
3765     $error = $cust_pay_batch->replace($old_cust_pay_batch)
3766   } else {
3767     $error = $cust_pay_batch->insert;
3768   }
3769
3770   if ( $error ) {
3771     $dbh->rollback if $oldAutoCommit;
3772     die $error;
3773   }
3774
3775   my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
3776   foreach my $cust_bill ($self->open_cust_bill) {
3777     #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
3778     my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
3779       'invnum' => $cust_bill->invnum,
3780       'paybatchnum' => $cust_pay_batch->paybatchnum,
3781       'amount' => $cust_bill->owed,
3782       '_date' => time,
3783     };
3784     if ($unapplied >= $cust_bill_pay_batch->amount){
3785       $unapplied -= $cust_bill_pay_batch->amount;
3786       next;
3787     }else{
3788       $cust_bill_pay_batch->amount(sprintf ( "%.2f",
3789                                    $cust_bill_pay_batch->amount - $unapplied ));      $unapplied = 0;
3790     }
3791     $error = $cust_bill_pay_batch->insert;
3792     if ( $error ) {
3793       $dbh->rollback if $oldAutoCommit;
3794       die $error;
3795     }
3796   }
3797
3798   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3799   '';
3800 }
3801
3802 =item total_owed
3803
3804 Returns the total owed for this customer on all invoices
3805 (see L<FS::cust_bill/owed>).
3806
3807 =cut
3808
3809 sub total_owed {
3810   my $self = shift;
3811   $self->total_owed_date(2145859200); #12/31/2037
3812 }
3813
3814 =item total_owed_date TIME
3815
3816 Returns the total owed for this customer on all invoices with date earlier than
3817 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
3818 see L<Time::Local> and L<Date::Parse> for conversion functions.
3819
3820 =cut
3821
3822 sub total_owed_date {
3823   my $self = shift;
3824   my $time = shift;
3825   my $total_bill = 0;
3826   foreach my $cust_bill (
3827     grep { $_->_date <= $time }
3828       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3829   ) {
3830     $total_bill += $cust_bill->owed;
3831   }
3832   sprintf( "%.2f", $total_bill );
3833 }
3834
3835 =item apply_payments_and_credits
3836
3837 Applies unapplied payments and credits.
3838
3839 In most cases, this new method should be used in place of sequential
3840 apply_payments and apply_credits methods.
3841
3842 If there is an error, returns the error, otherwise returns false.
3843
3844 =cut
3845
3846 sub apply_payments_and_credits {
3847   my $self = shift;
3848
3849   local $SIG{HUP} = 'IGNORE';
3850   local $SIG{INT} = 'IGNORE';
3851   local $SIG{QUIT} = 'IGNORE';
3852   local $SIG{TERM} = 'IGNORE';
3853   local $SIG{TSTP} = 'IGNORE';
3854   local $SIG{PIPE} = 'IGNORE';
3855
3856   my $oldAutoCommit = $FS::UID::AutoCommit;
3857   local $FS::UID::AutoCommit = 0;
3858   my $dbh = dbh;
3859
3860   $self->select_for_update; #mutex
3861
3862   foreach my $cust_bill ( $self->open_cust_bill ) {
3863     my $error = $cust_bill->apply_payments_and_credits;
3864     if ( $error ) {
3865       $dbh->rollback if $oldAutoCommit;
3866       return "Error applying: $error";
3867     }
3868   }
3869
3870   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3871   ''; #no error
3872
3873 }
3874
3875 =item apply_credits OPTION => VALUE ...
3876
3877 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3878 to outstanding invoice balances in chronological order (or reverse
3879 chronological order if the I<order> option is set to B<newest>) and returns the
3880 value of any remaining unapplied credits available for refund (see
3881 L<FS::cust_refund>).
3882
3883 Dies if there is an error.
3884
3885 =cut
3886
3887 sub apply_credits {
3888   my $self = shift;
3889   my %opt = @_;
3890
3891   local $SIG{HUP} = 'IGNORE';
3892   local $SIG{INT} = 'IGNORE';
3893   local $SIG{QUIT} = 'IGNORE';
3894   local $SIG{TERM} = 'IGNORE';
3895   local $SIG{TSTP} = 'IGNORE';
3896   local $SIG{PIPE} = 'IGNORE';
3897
3898   my $oldAutoCommit = $FS::UID::AutoCommit;
3899   local $FS::UID::AutoCommit = 0;
3900   my $dbh = dbh;
3901
3902   $self->select_for_update; #mutex
3903
3904   unless ( $self->total_credited ) {
3905     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3906     return 0;
3907   }
3908
3909   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3910       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3911
3912   my @invoices = $self->open_cust_bill;
3913   @invoices = sort { $b->_date <=> $a->_date } @invoices
3914     if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3915
3916   my $credit;
3917   foreach my $cust_bill ( @invoices ) {
3918     my $amount;
3919
3920     if ( !defined($credit) || $credit->credited == 0) {
3921       $credit = pop @credits or last;
3922     }
3923
3924     if ($cust_bill->owed >= $credit->credited) {
3925       $amount=$credit->credited;
3926     }else{
3927       $amount=$cust_bill->owed;
3928     }
3929
3930     my $cust_credit_bill = new FS::cust_credit_bill ( {
3931       'crednum' => $credit->crednum,
3932       'invnum'  => $cust_bill->invnum,
3933       'amount'  => $amount,
3934     } );
3935     my $error = $cust_credit_bill->insert;
3936     if ( $error ) {
3937       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3938       die $error;
3939     }
3940
3941     redo if ($cust_bill->owed > 0);
3942
3943   }
3944
3945   my $total_credited = $self->total_credited;
3946
3947   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3948
3949   return $total_credited;
3950 }
3951
3952 =item apply_payments
3953
3954 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3955 to outstanding invoice balances in chronological order.
3956
3957  #and returns the value of any remaining unapplied payments.
3958
3959 Dies if there is an error.
3960
3961 =cut
3962
3963 sub apply_payments {
3964   my $self = shift;
3965
3966   local $SIG{HUP} = 'IGNORE';
3967   local $SIG{INT} = 'IGNORE';
3968   local $SIG{QUIT} = 'IGNORE';
3969   local $SIG{TERM} = 'IGNORE';
3970   local $SIG{TSTP} = 'IGNORE';
3971   local $SIG{PIPE} = 'IGNORE';
3972
3973   my $oldAutoCommit = $FS::UID::AutoCommit;
3974   local $FS::UID::AutoCommit = 0;
3975   my $dbh = dbh;
3976
3977   $self->select_for_update; #mutex
3978
3979   #return 0 unless
3980
3981   my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
3982       qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
3983
3984   my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
3985       qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
3986
3987   my $payment;
3988
3989   foreach my $cust_bill ( @invoices ) {
3990     my $amount;
3991
3992     if ( !defined($payment) || $payment->unapplied == 0 ) {
3993       $payment = pop @payments or last;
3994     }
3995
3996     if ( $cust_bill->owed >= $payment->unapplied ) {
3997       $amount = $payment->unapplied;
3998     } else {
3999       $amount = $cust_bill->owed;
4000     }
4001
4002     my $cust_bill_pay = new FS::cust_bill_pay ( {
4003       'paynum' => $payment->paynum,
4004       'invnum' => $cust_bill->invnum,
4005       'amount' => $amount,
4006     } );
4007     my $error = $cust_bill_pay->insert;
4008     if ( $error ) {
4009       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4010       die $error;
4011     }
4012
4013     redo if ( $cust_bill->owed > 0);
4014
4015   }
4016
4017   my $total_unapplied_payments = $self->total_unapplied_payments;
4018
4019   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4020
4021   return $total_unapplied_payments;
4022 }
4023
4024 =item total_credited
4025
4026 Returns the total outstanding credit (see L<FS::cust_credit>) for this
4027 customer.  See L<FS::cust_credit/credited>.
4028
4029 =cut
4030
4031 sub total_credited {
4032   my $self = shift;
4033   my $total_credit = 0;
4034   foreach my $cust_credit ( qsearch('cust_credit', {
4035     'custnum' => $self->custnum,
4036   } ) ) {
4037     $total_credit += $cust_credit->credited;
4038   }
4039   sprintf( "%.2f", $total_credit );
4040 }
4041
4042 =item total_unapplied_payments
4043
4044 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
4045 See L<FS::cust_pay/unapplied>.
4046
4047 =cut
4048
4049 sub total_unapplied_payments {
4050   my $self = shift;
4051   my $total_unapplied = 0;
4052   foreach my $cust_pay ( qsearch('cust_pay', {
4053     'custnum' => $self->custnum,
4054   } ) ) {
4055     $total_unapplied += $cust_pay->unapplied;
4056   }
4057   sprintf( "%.2f", $total_unapplied );
4058 }
4059
4060 =item total_unapplied_refunds
4061
4062 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
4063 customer.  See L<FS::cust_refund/unapplied>.
4064
4065 =cut
4066
4067 sub total_unapplied_refunds {
4068   my $self = shift;
4069   my $total_unapplied = 0;
4070   foreach my $cust_refund ( qsearch('cust_refund', {
4071     'custnum' => $self->custnum,
4072   } ) ) {
4073     $total_unapplied += $cust_refund->unapplied;
4074   }
4075   sprintf( "%.2f", $total_unapplied );
4076 }
4077
4078 =item balance
4079
4080 Returns the balance for this customer (total_owed plus total_unrefunded, minus
4081 total_credited minus total_unapplied_payments).
4082
4083 =cut
4084
4085 sub balance {
4086   my $self = shift;
4087   sprintf( "%.2f",
4088       $self->total_owed
4089     + $self->total_unapplied_refunds
4090     - $self->total_credited
4091     - $self->total_unapplied_payments
4092   );
4093 }
4094
4095 =item balance_date TIME
4096
4097 Returns the balance for this customer, only considering invoices with date
4098 earlier than TIME (total_owed_date minus total_credited minus
4099 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
4100 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
4101 functions.
4102
4103 =cut
4104
4105 sub balance_date {
4106   my $self = shift;
4107   my $time = shift;
4108   sprintf( "%.2f",
4109         $self->total_owed_date($time)
4110       + $self->total_unapplied_refunds
4111       - $self->total_credited
4112       - $self->total_unapplied_payments
4113   );
4114 }
4115
4116 =item in_transit_payments
4117
4118 Returns the total of requests for payments for this customer pending in
4119 batches in transit to the bank.  See L<FS::pay_batch> and L<FS::cust_pay_batch>
4120
4121 =cut
4122
4123 sub in_transit_payments {
4124   my $self = shift;
4125   my $in_transit_payments = 0;
4126   foreach my $pay_batch ( qsearch('pay_batch', {
4127     'status' => 'I',
4128   } ) ) {
4129     foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
4130       'batchnum' => $pay_batch->batchnum,
4131       'custnum' => $self->custnum,
4132     } ) ) {
4133       $in_transit_payments += $cust_pay_batch->amount;
4134     }
4135   }
4136   sprintf( "%.2f", $in_transit_payments );
4137 }
4138
4139 =item paydate_monthyear
4140
4141 Returns a two-element list consisting of the month and year of this customer's
4142 paydate (credit card expiration date for CARD customers)
4143
4144 =cut
4145
4146 sub paydate_monthyear {
4147   my $self = shift;
4148   if ( $self->paydate  =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
4149     ( $2, $1 );
4150   } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
4151     ( $1, $3 );
4152   } else {
4153     ('', '');
4154   }
4155 }
4156
4157 =item invoicing_list [ ARRAYREF ]
4158
4159 If an arguement is given, sets these email addresses as invoice recipients
4160 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
4161 (except as warnings), so use check_invoicing_list first.
4162
4163 Returns a list of email addresses (with svcnum entries expanded).
4164
4165 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
4166 check it without disturbing anything by passing nothing.
4167
4168 This interface may change in the future.
4169
4170 =cut
4171
4172 sub invoicing_list {
4173   my( $self, $arrayref ) = @_;
4174
4175   if ( $arrayref ) {
4176     my @cust_main_invoice;
4177     if ( $self->custnum ) {
4178       @cust_main_invoice =
4179         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4180     } else {
4181       @cust_main_invoice = ();
4182     }
4183     foreach my $cust_main_invoice ( @cust_main_invoice ) {
4184       #warn $cust_main_invoice->destnum;
4185       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
4186         #warn $cust_main_invoice->destnum;
4187         my $error = $cust_main_invoice->delete;
4188         warn $error if $error;
4189       }
4190     }
4191     if ( $self->custnum ) {
4192       @cust_main_invoice =
4193         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4194     } else {
4195       @cust_main_invoice = ();
4196     }
4197     my %seen = map { $_->address => 1 } @cust_main_invoice;
4198     foreach my $address ( @{$arrayref} ) {
4199       next if exists $seen{$address} && $seen{$address};
4200       $seen{$address} = 1;
4201       my $cust_main_invoice = new FS::cust_main_invoice ( {
4202         'custnum' => $self->custnum,
4203         'dest'    => $address,
4204       } );
4205       my $error = $cust_main_invoice->insert;
4206       warn $error if $error;
4207     }
4208   }
4209
4210   if ( $self->custnum ) {
4211     map { $_->address }
4212       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4213   } else {
4214     ();
4215   }
4216
4217 }
4218
4219 =item check_invoicing_list ARRAYREF
4220
4221 Checks these arguements as valid input for the invoicing_list method.  If there
4222 is an error, returns the error, otherwise returns false.
4223
4224 =cut
4225
4226 sub check_invoicing_list {
4227   my( $self, $arrayref ) = @_;
4228
4229   foreach my $address ( @$arrayref ) {
4230
4231     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
4232       return 'Can\'t add FAX invoice destination with a blank FAX number.';
4233     }
4234
4235     my $cust_main_invoice = new FS::cust_main_invoice ( {
4236       'custnum' => $self->custnum,
4237       'dest'    => $address,
4238     } );
4239     my $error = $self->custnum
4240                 ? $cust_main_invoice->check
4241                 : $cust_main_invoice->checkdest
4242     ;
4243     return $error if $error;
4244
4245   }
4246
4247   return "Email address required"
4248     if $conf->exists('cust_main-require_invoicing_list_email')
4249     && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
4250
4251   '';
4252 }
4253
4254 =item set_default_invoicing_list
4255
4256 Sets the invoicing list to all accounts associated with this customer,
4257 overwriting any previous invoicing list.
4258
4259 =cut
4260
4261 sub set_default_invoicing_list {
4262   my $self = shift;
4263   $self->invoicing_list($self->all_emails);
4264 }
4265
4266 =item all_emails
4267
4268 Returns the email addresses of all accounts provisioned for this customer.
4269
4270 =cut
4271
4272 sub all_emails {
4273   my $self = shift;
4274   my %list;
4275   foreach my $cust_pkg ( $self->all_pkgs ) {
4276     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
4277     my @svc_acct =
4278       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4279         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4280           @cust_svc;
4281     $list{$_}=1 foreach map { $_->email } @svc_acct;
4282   }
4283   keys %list;
4284 }
4285
4286 =item invoicing_list_addpost
4287
4288 Adds postal invoicing to this customer.  If this customer is already configured
4289 to receive postal invoices, does nothing.
4290
4291 =cut
4292
4293 sub invoicing_list_addpost {
4294   my $self = shift;
4295   return if grep { $_ eq 'POST' } $self->invoicing_list;
4296   my @invoicing_list = $self->invoicing_list;
4297   push @invoicing_list, 'POST';
4298   $self->invoicing_list(\@invoicing_list);
4299 }
4300
4301 =item invoicing_list_emailonly
4302
4303 Returns the list of email invoice recipients (invoicing_list without non-email
4304 destinations such as POST and FAX).
4305
4306 =cut
4307
4308 sub invoicing_list_emailonly {
4309   my $self = shift;
4310   warn "$me invoicing_list_emailonly called"
4311     if $DEBUG;
4312   grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
4313 }
4314
4315 =item invoicing_list_emailonly_scalar
4316
4317 Returns the list of email invoice recipients (invoicing_list without non-email
4318 destinations such as POST and FAX) as a comma-separated scalar.
4319
4320 =cut
4321
4322 sub invoicing_list_emailonly_scalar {
4323   my $self = shift;
4324   warn "$me invoicing_list_emailonly_scalar called"
4325     if $DEBUG;
4326   join(', ', $self->invoicing_list_emailonly);
4327 }
4328
4329 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
4330
4331 Returns an array of customers referred by this customer (referral_custnum set
4332 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
4333 customers referred by customers referred by this customer and so on, inclusive.
4334 The default behavior is DEPTH 1 (no recursion).
4335
4336 =cut
4337
4338 sub referral_cust_main {
4339   my $self = shift;
4340   my $depth = @_ ? shift : 1;
4341   my $exclude = @_ ? shift : {};
4342
4343   my @cust_main =
4344     map { $exclude->{$_->custnum}++; $_; }
4345       grep { ! $exclude->{ $_->custnum } }
4346         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4347
4348   if ( $depth > 1 ) {
4349     push @cust_main,
4350       map { $_->referral_cust_main($depth-1, $exclude) }
4351         @cust_main;
4352   }
4353
4354   @cust_main;
4355 }
4356
4357 =item referral_cust_main_ncancelled
4358
4359 Same as referral_cust_main, except only returns customers with uncancelled
4360 packages.
4361
4362 =cut
4363
4364 sub referral_cust_main_ncancelled {
4365   my $self = shift;
4366   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4367 }
4368
4369 =item referral_cust_pkg [ DEPTH ]
4370
4371 Like referral_cust_main, except returns a flat list of all unsuspended (and
4372 uncancelled) packages for each customer.  The number of items in this list may
4373 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4374
4375 =cut
4376
4377 sub referral_cust_pkg {
4378   my $self = shift;
4379   my $depth = @_ ? shift : 1;
4380
4381   map { $_->unsuspended_pkgs }
4382     grep { $_->unsuspended_pkgs }
4383       $self->referral_cust_main($depth);
4384 }
4385
4386 =item referring_cust_main
4387
4388 Returns the single cust_main record for the customer who referred this customer
4389 (referral_custnum), or false.
4390
4391 =cut
4392
4393 sub referring_cust_main {
4394   my $self = shift;
4395   return '' unless $self->referral_custnum;
4396   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4397 }
4398
4399 =item credit AMOUNT, REASON
4400
4401 Applies a credit to this customer.  If there is an error, returns the error,
4402 otherwise returns false.
4403
4404 =cut
4405
4406 sub credit {
4407   my( $self, $amount, $reason ) = @_;
4408   my $cust_credit = new FS::cust_credit {
4409     'custnum' => $self->custnum,
4410     'amount'  => $amount,
4411     'reason'  => $reason,
4412   };
4413   $cust_credit->insert;
4414 }
4415
4416 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4417
4418 Creates a one-time charge for this customer.  If there is an error, returns
4419 the error, otherwise returns false.
4420
4421 =cut
4422
4423 sub charge {
4424   my $self = shift;
4425   my ( $amount, $pkg, $comment, $taxclass, $additional );
4426   if ( ref( $_[0] ) ) {
4427     $amount     = $_[0]->{amount};
4428     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4429     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
4430                                            : '$'. sprintf("%.2f",$amount);
4431     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4432     $additional = $_[0]->{additional};
4433   }else{
4434     $amount     = shift;
4435     $pkg        = @_ ? shift : 'One-time charge';
4436     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
4437     $taxclass   = @_ ? shift : '';
4438     $additional = [];
4439   }
4440
4441   local $SIG{HUP} = 'IGNORE';
4442   local $SIG{INT} = 'IGNORE';
4443   local $SIG{QUIT} = 'IGNORE';
4444   local $SIG{TERM} = 'IGNORE';
4445   local $SIG{TSTP} = 'IGNORE';
4446   local $SIG{PIPE} = 'IGNORE';
4447
4448   my $oldAutoCommit = $FS::UID::AutoCommit;
4449   local $FS::UID::AutoCommit = 0;
4450   my $dbh = dbh;
4451
4452   my $part_pkg = new FS::part_pkg ( {
4453     'pkg'      => $pkg,
4454     'comment'  => $comment,
4455     'plan'     => 'flat',
4456     'freq'     => 0,
4457     'disabled' => 'Y',
4458     'taxclass' => $taxclass,
4459   } );
4460
4461   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4462                         ( 0 .. @$additional - 1 )
4463                   ),
4464                   'additional_count' => scalar(@$additional),
4465                   'setup_fee' => $amount,
4466                 );
4467
4468   my $error = $part_pkg->insert( options => \%options );
4469   if ( $error ) {
4470     $dbh->rollback if $oldAutoCommit;
4471     return $error;
4472   }
4473
4474   my $pkgpart = $part_pkg->pkgpart;
4475   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
4476   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
4477     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
4478     $error = $type_pkgs->insert;
4479     if ( $error ) {
4480       $dbh->rollback if $oldAutoCommit;
4481       return $error;
4482     }
4483   }
4484
4485   my $cust_pkg = new FS::cust_pkg ( {
4486     'custnum' => $self->custnum,
4487     'pkgpart' => $pkgpart,
4488   } );
4489
4490   $error = $cust_pkg->insert;
4491   if ( $error ) {
4492     $dbh->rollback if $oldAutoCommit;
4493     return $error;
4494   }
4495
4496   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4497   '';
4498
4499 }
4500
4501 =item cust_bill
4502
4503 Returns all the invoices (see L<FS::cust_bill>) for this customer.
4504
4505 =cut
4506
4507 sub cust_bill {
4508   my $self = shift;
4509   sort { $a->_date <=> $b->_date }
4510     qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4511 }
4512
4513 =item open_cust_bill
4514
4515 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
4516 customer.
4517
4518 =cut
4519
4520 sub open_cust_bill {
4521   my $self = shift;
4522   grep { $_->owed > 0 } $self->cust_bill;
4523 }
4524
4525 =item cust_credit
4526
4527 Returns all the credits (see L<FS::cust_credit>) for this customer.
4528
4529 =cut
4530
4531 sub cust_credit {
4532   my $self = shift;
4533   sort { $a->_date <=> $b->_date }
4534     qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
4535 }
4536
4537 =item cust_pay
4538
4539 Returns all the payments (see L<FS::cust_pay>) for this customer.
4540
4541 =cut
4542
4543 sub cust_pay {
4544   my $self = shift;
4545   sort { $a->_date <=> $b->_date }
4546     qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
4547 }
4548
4549 =item cust_pay_void
4550
4551 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4552
4553 =cut
4554
4555 sub cust_pay_void {
4556   my $self = shift;
4557   sort { $a->_date <=> $b->_date }
4558     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4559 }
4560
4561 =item cust_pay_batch
4562
4563 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
4564
4565 =cut
4566
4567 sub cust_pay_batch {
4568   my $self = shift;
4569   sort { $a->_date <=> $b->_date }
4570     qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
4571 }
4572
4573 =item cust_refund
4574
4575 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4576
4577 =cut
4578
4579 sub cust_refund {
4580   my $self = shift;
4581   sort { $a->_date <=> $b->_date }
4582     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4583 }
4584
4585 =item name
4586
4587 Returns a name string for this customer, either "Company (Last, First)" or
4588 "Last, First".
4589
4590 =cut
4591
4592 sub name {
4593   my $self = shift;
4594   my $name = $self->contact;
4595   $name = $self->company. " ($name)" if $self->company;
4596   $name;
4597 }
4598
4599 =item ship_name
4600
4601 Returns a name string for this (service/shipping) contact, either
4602 "Company (Last, First)" or "Last, First".
4603
4604 =cut
4605
4606 sub ship_name {
4607   my $self = shift;
4608   if ( $self->get('ship_last') ) {
4609     my $name = $self->ship_contact;
4610     $name = $self->ship_company. " ($name)" if $self->ship_company;
4611     $name;
4612   } else {
4613     $self->name;
4614   }
4615 }
4616
4617 =item contact
4618
4619 Returns this customer's full (billing) contact name only, "Last, First"
4620
4621 =cut
4622
4623 sub contact {
4624   my $self = shift;
4625   $self->get('last'). ', '. $self->first;
4626 }
4627
4628 =item ship_contact
4629
4630 Returns this customer's full (shipping) contact name only, "Last, First"
4631
4632 =cut
4633
4634 sub ship_contact {
4635   my $self = shift;
4636   $self->get('ship_last')
4637     ? $self->get('ship_last'). ', '. $self->ship_first
4638     : $self->contact;
4639 }
4640
4641 =item country_full
4642
4643 Returns this customer's full country name
4644
4645 =cut
4646
4647 sub country_full {
4648   my $self = shift;
4649   code2country($self->country);
4650 }
4651
4652 =item cust_status
4653
4654 =item status
4655
4656 Returns a status string for this customer, currently:
4657
4658 =over 4
4659
4660 =item prospect - No packages have ever been ordered
4661
4662 =item active - One or more recurring packages is active
4663
4664 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4665
4666 =item suspended - All non-cancelled recurring packages are suspended
4667
4668 =item cancelled - All recurring packages are cancelled
4669
4670 =back
4671
4672 =cut
4673
4674 sub status { shift->cust_status(@_); }
4675
4676 sub cust_status {
4677   my $self = shift;
4678   for my $status (qw( prospect active inactive suspended cancelled )) {
4679     my $method = $status.'_sql';
4680     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4681     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4682     $sth->execute( ($self->custnum) x $numnum )
4683       or die "Error executing 'SELECT $sql': ". $sth->errstr;
4684     return $status if $sth->fetchrow_arrayref->[0];
4685   }
4686 }
4687
4688 =item ucfirst_cust_status
4689
4690 =item ucfirst_status
4691
4692 Returns the status with the first character capitalized.
4693
4694 =cut
4695
4696 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4697
4698 sub ucfirst_cust_status {
4699   my $self = shift;
4700   ucfirst($self->cust_status);
4701 }
4702
4703 =item statuscolor
4704
4705 Returns a hex triplet color string for this customer's status.
4706
4707 =cut
4708
4709 use vars qw(%statuscolor);
4710 tie my %statuscolor, 'Tie::IxHash',
4711   'prospect'  => '7e0079', #'000000', #black?  naw, purple
4712   'active'    => '00CC00', #green
4713   'inactive'  => '0000CC', #blue
4714   'suspended' => 'FF9900', #yellow
4715   'cancelled' => 'FF0000', #red
4716 ;
4717
4718 sub statuscolor { shift->cust_statuscolor(@_); }
4719
4720 sub cust_statuscolor {
4721   my $self = shift;
4722   $statuscolor{$self->cust_status};
4723 }
4724
4725 =item tickets
4726
4727 Returns an array of hashes representing the customer's RT tickets.
4728
4729 =cut
4730
4731 sub tickets {
4732   my $self = shift;
4733
4734   my $num = $conf->config('cust_main-max_tickets') || 10;
4735   my @tickets = ();
4736
4737   unless ( $conf->config('ticket_system-custom_priority_field') ) {
4738
4739     @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4740
4741   } else {
4742
4743     foreach my $priority (
4744       $conf->config('ticket_system-custom_priority_field-values'), ''
4745     ) {
4746       last if scalar(@tickets) >= $num;
4747       push @tickets,
4748         @{ FS::TicketSystem->customer_tickets( $self->custnum,
4749                                                $num - scalar(@tickets),
4750                                                $priority,
4751                                              )
4752          };
4753     }
4754   }
4755   (@tickets);
4756 }
4757
4758 # Return services representing svc_accts in customer support packages
4759 sub support_services {
4760   my $self = shift;
4761   my %packages = map { $_ => 1 } $conf->config('support_packages');
4762
4763   grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4764     grep { $_->part_svc->svcdb eq 'svc_acct' }
4765     map { $_->cust_svc }
4766     grep { exists $packages{ $_->pkgpart } }
4767     $self->ncancelled_pkgs;
4768
4769 }
4770
4771 =back
4772
4773 =head1 CLASS METHODS
4774
4775 =over 4
4776
4777 =item statuses
4778
4779 Class method that returns the list of possible status strings for customers
4780 (see L<the status method|/status>).  For example:
4781
4782   @statuses = FS::cust_main->statuses();
4783
4784 =cut
4785
4786 sub statuses {
4787   #my $self = shift; #could be class...
4788   keys %statuscolor;
4789 }
4790
4791 =item prospect_sql
4792
4793 Returns an SQL expression identifying prospective cust_main records (customers
4794 with no packages ever ordered)
4795
4796 =cut
4797
4798 use vars qw($select_count_pkgs);
4799 $select_count_pkgs =
4800   "SELECT COUNT(*) FROM cust_pkg
4801     WHERE cust_pkg.custnum = cust_main.custnum";
4802
4803 sub select_count_pkgs_sql {
4804   $select_count_pkgs;
4805 }
4806
4807 sub prospect_sql { "
4808   0 = ( $select_count_pkgs )
4809 "; }
4810
4811 =item active_sql
4812
4813 Returns an SQL expression identifying active cust_main records (customers with
4814 no active recurring packages, but otherwise unsuspended/uncancelled).
4815
4816 =cut
4817
4818 sub active_sql { "
4819   0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
4820       )
4821 "; }
4822
4823 =item inactive_sql
4824
4825 Returns an SQL expression identifying inactive cust_main records (customers with
4826 active recurring packages).
4827
4828 =cut
4829
4830 sub inactive_sql { "
4831   0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4832   AND
4833   0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
4834 "; }
4835
4836 =item susp_sql
4837 =item suspended_sql
4838
4839 Returns an SQL expression identifying suspended cust_main records.
4840
4841 =cut
4842
4843
4844 sub suspended_sql { susp_sql(@_); }
4845 sub susp_sql { "
4846     0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
4847     AND
4848     0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4849 "; }
4850
4851 =item cancel_sql
4852 =item cancelled_sql
4853
4854 Returns an SQL expression identifying cancelled cust_main records.
4855
4856 =cut
4857
4858 sub cancelled_sql { cancel_sql(@_); }
4859 sub cancel_sql {
4860
4861   my $recurring_sql = FS::cust_pkg->recurring_sql;
4862   #my $recurring_sql = "
4863   #  '0' != ( select freq from part_pkg
4864   #             where cust_pkg.pkgpart = part_pkg.pkgpart )
4865   #";
4866
4867   "
4868     0 < ( $select_count_pkgs )
4869     AND 0 = ( $select_count_pkgs AND $recurring_sql
4870                   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4871             )
4872   ";
4873 }
4874
4875 =item uncancel_sql
4876 =item uncancelled_sql
4877
4878 Returns an SQL expression identifying un-cancelled cust_main records.
4879
4880 =cut
4881
4882 sub uncancelled_sql { uncancel_sql(@_); }
4883 sub uncancel_sql { "
4884   ( 0 < ( $select_count_pkgs
4885                    AND ( cust_pkg.cancel IS NULL
4886                          OR cust_pkg.cancel = 0
4887                        )
4888         )
4889     OR 0 = ( $select_count_pkgs )
4890   )
4891 "; }
4892
4893 =item balance_sql
4894
4895 Returns an SQL fragment to retreive the balance.
4896
4897 =cut
4898
4899 sub balance_sql { "
4900     COALESCE( ( SELECT SUM(charged) FROM cust_bill
4901                   WHERE cust_bill.custnum   = cust_main.custnum ), 0)
4902   - COALESCE( ( SELECT SUM(paid)    FROM cust_pay
4903                   WHERE cust_pay.custnum    = cust_main.custnum ), 0)
4904   - COALESCE( ( SELECT SUM(amount)  FROM cust_credit
4905                   WHERE cust_credit.custnum = cust_main.custnum ), 0)
4906   + COALESCE( ( SELECT SUM(refund)  FROM cust_refund
4907                    WHERE cust_refund.custnum = cust_main.custnum ), 0)
4908 "; }
4909
4910 =item balance_date_sql TIME
4911
4912 Returns an SQL fragment to retreive the balance for this customer, only
4913 considering invoices with date earlier than TIME. (total_owed_date minus total_credited minus
4914 total_unapplied_payments).  TIME is specified as an SQL fragment or a numeric
4915 UNIX timestamp; see L<perlfunc/"time">).  Also see L<Time::Local> and
4916 L<Date::Parse> for conversion functions.
4917
4918 =cut
4919
4920 sub balance_date_sql {
4921   my( $class, $time ) = @_;
4922
4923   my $owed_sql         = FS::cust_bill->owed_sql;
4924   my $unapp_refund_sql = FS::cust_refund->unapplied_sql;
4925   #my $unapp_credit_sql = FS::cust_credit->unapplied_sql;
4926   my $unapp_credit_sql = FS::cust_credit->credited_sql;
4927   my $unapp_pay_sql    = FS::cust_pay->unapplied_sql;
4928
4929   "
4930       COALESCE( ( SELECT SUM($owed_sql) FROM cust_bill
4931                     WHERE cust_bill.custnum   = cust_main.custnum
4932                       AND cust_bill._date    <= $time             )
4933                 ,0
4934               )
4935     + COALESCE( ( SELECT SUM($unapp_refund_sql) FROM cust_refund
4936                     WHERE cust_refund.custnum = cust_main.custnum )
4937                 ,0
4938               )
4939     - COALESCE( ( SELECT SUM($unapp_credit_sql) FROM cust_credit
4940                     WHERE cust_credit.custnum = cust_main.custnum )
4941                 ,0
4942               )
4943     - COALESCE( ( SELECT SUM($unapp_pay_sql) FROM cust_pay
4944                     WHERE cust_pay.custnum = cust_main.custnum )
4945                 ,0
4946               )
4947
4948   ";
4949
4950 }
4951
4952 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
4953
4954 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
4955 records.  Currently, I<first>, I<last> and/or I<company> may be specified (the
4956 appropriate ship_ field is also searched).
4957
4958 Additional options are the same as FS::Record::qsearch
4959
4960 =cut
4961
4962 sub fuzzy_search {
4963   my( $self, $fuzzy, $hash, @opt) = @_;
4964   #$self
4965   $hash ||= {};
4966   my @cust_main = ();
4967
4968   check_and_rebuild_fuzzyfiles();
4969   foreach my $field ( keys %$fuzzy ) {
4970
4971     my $all = $self->all_X($field);
4972     next unless scalar(@$all);
4973
4974     my %match = ();
4975     $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
4976
4977     my @fcust = ();
4978     foreach ( keys %match ) {
4979       push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
4980       push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
4981     }
4982     my %fsaw = ();
4983     push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
4984   }
4985
4986   # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
4987   my %saw = ();
4988   @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
4989
4990   @cust_main;
4991
4992 }
4993
4994 =item masked FIELD
4995
4996 Returns a masked version of the named field
4997
4998 =cut
4999
5000 sub masked {
5001 my ($self,$field) = @_;
5002
5003 # Show last four
5004
5005 'x'x(length($self->getfield($field))-4).
5006   substr($self->getfield($field), (length($self->getfield($field))-4));
5007
5008 }
5009
5010 =back
5011
5012 =head1 SUBROUTINES
5013
5014 =over 4
5015
5016 =item smart_search OPTION => VALUE ...
5017
5018 Accepts the following options: I<search>, the string to search for.  The string
5019 will be searched for as a customer number, phone number, name or company name,
5020 as an exact, or, in some cases, a substring or fuzzy match (see the source code
5021 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
5022 skip fuzzy matching when an exact match is found.
5023
5024 Any additional options are treated as an additional qualifier on the search
5025 (i.e. I<agentnum>).
5026
5027 Returns a (possibly empty) array of FS::cust_main objects.
5028
5029 =cut
5030
5031 sub smart_search {
5032   my %options = @_;
5033
5034   #here is the agent virtualization
5035   my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
5036
5037   my @cust_main = ();
5038
5039   my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
5040   my $search = delete $options{'search'};
5041   ( my $alphanum_search = $search ) =~ s/\W//g;
5042
5043   if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
5044
5045     #false laziness w/Record::ut_phone
5046     my $phonen = "$1-$2-$3";
5047     $phonen .= " x$4" if $4;
5048
5049     push @cust_main, qsearch( {
5050       'table'   => 'cust_main',
5051       'hashref' => { %options },
5052       'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5053                      ' ( '.
5054                          join(' OR ', map "$_ = '$phonen'",
5055                                           qw( daytime night fax
5056                                               ship_daytime ship_night ship_fax )
5057                              ).
5058                      ' ) '.
5059                      " AND $agentnums_sql", #agent virtualization
5060     } );
5061
5062     unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
5063       #try looking for matches with extensions unless one was specified
5064
5065       push @cust_main, qsearch( {
5066         'table'   => 'cust_main',
5067         'hashref' => { %options },
5068         'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5069                        ' ( '.
5070                            join(' OR ', map "$_ LIKE '$phonen\%'",
5071                                             qw( daytime night
5072                                                 ship_daytime ship_night )
5073                                ).
5074                        ' ) '.
5075                        " AND $agentnums_sql", #agent virtualization
5076       } );
5077
5078     }
5079
5080   } elsif ( $search =~ /^\s*(\d+)\s*$/ ) { # customer # search
5081
5082     push @cust_main, qsearch( {
5083       'table'     => 'cust_main',
5084       'hashref'   => { 'custnum' => $1, %options },
5085       'extra_sql' => " AND $agentnums_sql", #agent virtualization
5086     } );
5087
5088   } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
5089
5090     my($company, $last, $first) = ( $1, $2, $3 );
5091
5092     # "Company (Last, First)"
5093     #this is probably something a browser remembered,
5094     #so just do an exact search
5095
5096     foreach my $prefix ( '', 'ship_' ) {
5097       push @cust_main, qsearch( {
5098         'table'     => 'cust_main',
5099         'hashref'   => { $prefix.'first'   => $first,
5100                          $prefix.'last'    => $last,
5101                          $prefix.'company' => $company,
5102                          %options,
5103                        },
5104         'extra_sql' => " AND $agentnums_sql",
5105       } );
5106     }
5107
5108   } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
5109                                               # try (ship_){last,company}
5110
5111     my $value = lc($1);
5112
5113     # # remove "(Last, First)" in "Company (Last, First)", otherwise the
5114     # # full strings the browser remembers won't work
5115     # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
5116
5117     use Lingua::EN::NameParse;
5118     my $NameParse = new Lingua::EN::NameParse(
5119              auto_clean     => 1,
5120              allow_reversed => 1,
5121     );
5122
5123     my($last, $first) = ( '', '' );
5124     #maybe disable this too and just rely on NameParse?
5125     if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
5126
5127       ($last, $first) = ( $1, $2 );
5128
5129     #} elsif  ( $value =~ /^(.+)\s+(.+)$/ ) {
5130     } elsif ( ! $NameParse->parse($value) ) {
5131
5132       my %name = $NameParse->components;
5133       $first = $name{'given_name_1'};
5134       $last  = $name{'surname_1'};
5135
5136     }
5137
5138     if ( $first && $last ) {
5139
5140       my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
5141
5142       #exact
5143       my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5144       $sql .= "
5145         (     ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
5146            OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
5147         )";
5148
5149       push @cust_main, qsearch( {
5150         'table'     => 'cust_main',
5151         'hashref'   => \%options,
5152         'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5153       } );
5154
5155       # or it just be something that was typed in... (try that in a sec)
5156
5157     }
5158
5159     my $q_value = dbh->quote($value);
5160
5161     #exact
5162     my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5163     $sql .= " (    LOWER(last)         = $q_value
5164                 OR LOWER(company)      = $q_value
5165                 OR LOWER(ship_last)    = $q_value
5166                 OR LOWER(ship_company) = $q_value
5167               )";
5168
5169     push @cust_main, qsearch( {
5170       'table'     => 'cust_main',
5171       'hashref'   => \%options,
5172       'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5173     } );
5174
5175     #no exact match, trying substring/fuzzy
5176     #always do substring & fuzzy (unless they're explicity config'ed off)
5177     #getting complaints searches are not returning enough
5178     unless ( @cust_main  && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
5179
5180       #still some false laziness w/ search/cust_main.cgi
5181
5182       #substring
5183
5184       my @hashrefs = (
5185         { 'company'      => { op=>'ILIKE', value=>"%$value%" }, },
5186         { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
5187       );
5188
5189       if ( $first && $last ) {
5190
5191         push @hashrefs,
5192           { 'first'        => { op=>'ILIKE', value=>"%$first%" },
5193             'last'         => { op=>'ILIKE', value=>"%$last%" },
5194           },
5195           { 'ship_first'   => { op=>'ILIKE', value=>"%$first%" },
5196             'ship_last'    => { op=>'ILIKE', value=>"%$last%" },
5197           },
5198         ;
5199
5200       } else {
5201
5202         push @hashrefs,
5203           { 'last'         => { op=>'ILIKE', value=>"%$value%" }, },
5204           { 'ship_last'    => { op=>'ILIKE', value=>"%$value%" }, },
5205         ;
5206       }
5207
5208       foreach my $hashref ( @hashrefs ) {
5209
5210         push @cust_main, qsearch( {
5211           'table'     => 'cust_main',
5212           'hashref'   => { %$hashref,
5213                            %options,
5214                          },
5215           'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
5216         } );
5217
5218       }
5219
5220       #fuzzy
5221       my @fuzopts = (
5222         \%options,                #hashref
5223         '',                       #select
5224         " AND $agentnums_sql",    #extra_sql  #agent virtualization
5225       );
5226
5227       if ( $first && $last ) {
5228         push @cust_main, FS::cust_main->fuzzy_search(
5229           { 'last'   => $last,    #fuzzy hashref
5230             'first'  => $first }, #
5231           @fuzopts
5232         );
5233       }
5234       foreach my $field ( 'last', 'company' ) {
5235         push @cust_main,
5236           FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
5237       }
5238
5239     }
5240
5241     #eliminate duplicates
5242     my %saw = ();
5243     @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5244
5245   }
5246
5247   @cust_main;
5248
5249 }
5250
5251 =item check_and_rebuild_fuzzyfiles
5252
5253 =cut
5254
5255 use vars qw(@fuzzyfields);
5256 @fuzzyfields = ( 'last', 'first', 'company' );
5257
5258 sub check_and_rebuild_fuzzyfiles {
5259   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5260   rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
5261 }
5262
5263 =item rebuild_fuzzyfiles
5264
5265 =cut
5266
5267 sub rebuild_fuzzyfiles {
5268
5269   use Fcntl qw(:flock);
5270
5271   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5272   mkdir $dir, 0700 unless -d $dir;
5273
5274   foreach my $fuzzy ( @fuzzyfields ) {
5275
5276     open(LOCK,">>$dir/cust_main.$fuzzy")
5277       or die "can't open $dir/cust_main.$fuzzy: $!";
5278     flock(LOCK,LOCK_EX)
5279       or die "can't lock $dir/cust_main.$fuzzy: $!";
5280
5281     open (CACHE,">$dir/cust_main.$fuzzy.tmp")
5282       or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
5283
5284     foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
5285       my $sth = dbh->prepare("SELECT $field FROM cust_main".
5286                              " WHERE $field != '' AND $field IS NOT NULL");
5287       $sth->execute or die $sth->errstr;
5288
5289       while ( my $row = $sth->fetchrow_arrayref ) {
5290         print CACHE $row->[0]. "\n";
5291       }
5292
5293     }
5294
5295     close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
5296
5297     rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
5298     close LOCK;
5299   }
5300
5301 }
5302
5303 =item all_X
5304
5305 =cut
5306
5307 sub all_X {
5308   my( $self, $field ) = @_;
5309   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5310   open(CACHE,"<$dir/cust_main.$field")
5311     or die "can't open $dir/cust_main.$field: $!";
5312   my @array = map { chomp; $_; } <CACHE>;
5313   close CACHE;
5314   \@array;
5315 }
5316
5317 =item append_fuzzyfiles LASTNAME COMPANY
5318
5319 =cut
5320
5321 sub append_fuzzyfiles {
5322   #my( $first, $last, $company ) = @_;
5323
5324   &check_and_rebuild_fuzzyfiles;
5325
5326   use Fcntl qw(:flock);
5327
5328   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5329
5330   foreach my $field (qw( first last company )) {
5331     my $value = shift;
5332
5333     if ( $value ) {
5334
5335       open(CACHE,">>$dir/cust_main.$field")
5336         or die "can't open $dir/cust_main.$field: $!";
5337       flock(CACHE,LOCK_EX)
5338         or die "can't lock $dir/cust_main.$field: $!";
5339
5340       print CACHE "$value\n";
5341
5342       flock(CACHE,LOCK_UN)
5343         or die "can't unlock $dir/cust_main.$field: $!";
5344       close CACHE;
5345     }
5346
5347   }
5348
5349   1;
5350 }
5351
5352 =item batch_import
5353
5354 =cut
5355
5356 sub batch_import {
5357   my $param = shift;
5358   #warn join('-',keys %$param);
5359   my $fh = $param->{filehandle};
5360   my $agentnum = $param->{agentnum};
5361
5362   my $refnum = $param->{refnum};
5363   my $pkgpart = $param->{pkgpart};
5364
5365   #my @fields = @{$param->{fields}};
5366   my $format = $param->{'format'};
5367   my @fields;
5368   my $payby;
5369   if ( $format eq 'simple' ) {
5370     @fields = qw( cust_pkg.setup dayphone first last
5371                   address1 address2 city state zip comments );
5372     $payby = 'BILL';
5373   } elsif ( $format eq 'extended' ) {
5374     @fields = qw( agent_custid refnum
5375                   last first address1 address2 city state zip country
5376                   daytime night
5377                   ship_last ship_first ship_address1 ship_address2
5378                   ship_city ship_state ship_zip ship_country
5379                   payinfo paycvv paydate
5380                   invoicing_list
5381                   cust_pkg.pkgpart
5382                   svc_acct.username svc_acct._password
5383                 );
5384     $payby = 'BILL';
5385   } else {
5386     die "unknown format $format";
5387   }
5388
5389   eval "use Text::CSV_XS;";
5390   die $@ if $@;
5391
5392   my $csv = new Text::CSV_XS;
5393   #warn $csv;
5394   #warn $fh;
5395
5396   my $imported = 0;
5397   #my $columns;
5398
5399   local $SIG{HUP} = 'IGNORE';
5400   local $SIG{INT} = 'IGNORE';
5401   local $SIG{QUIT} = 'IGNORE';
5402   local $SIG{TERM} = 'IGNORE';
5403   local $SIG{TSTP} = 'IGNORE';
5404   local $SIG{PIPE} = 'IGNORE';
5405
5406   my $oldAutoCommit = $FS::UID::AutoCommit;
5407   local $FS::UID::AutoCommit = 0;
5408   my $dbh = dbh;
5409
5410   #while ( $columns = $csv->getline($fh) ) {
5411   my $line;
5412   while ( defined($line=<$fh>) ) {
5413
5414     $csv->parse($line) or do {
5415       $dbh->rollback if $oldAutoCommit;
5416       return "can't parse: ". $csv->error_input();
5417     };
5418
5419     my @columns = $csv->fields();
5420     #warn join('-',@columns);
5421
5422     my %cust_main = (
5423       agentnum => $agentnum,
5424       refnum   => $refnum,
5425       country  => $conf->config('countrydefault') || 'US',
5426       payby    => $payby, #default
5427       paydate  => '12/2037', #default
5428     );
5429     my $billtime = time;
5430     my %cust_pkg = ( pkgpart => $pkgpart );
5431     my %svc_acct = ();
5432     foreach my $field ( @fields ) {
5433
5434       if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
5435
5436         #$cust_pkg{$1} = str2time( shift @$columns );
5437         if ( $1 eq 'pkgpart' ) {
5438           $cust_pkg{$1} = shift @columns;
5439         } elsif ( $1 eq 'setup' ) {
5440           $billtime = str2time(shift @columns);
5441         } else {
5442           $cust_pkg{$1} = str2time( shift @columns );
5443         }
5444
5445       } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
5446
5447         $svc_acct{$1} = shift @columns;
5448
5449       } else {
5450
5451         #refnum interception
5452         if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
5453
5454           my $referral = $columns[0];
5455           my %hash = ( 'referral' => $referral,
5456                        'agentnum' => $agentnum,
5457                        'disabled' => '',
5458                      );
5459
5460           my $part_referral = qsearchs('part_referral', \%hash )
5461                               || new FS::part_referral \%hash;
5462
5463           unless ( $part_referral->refnum ) {
5464             my $error = $part_referral->insert;
5465             if ( $error ) {
5466               $dbh->rollback if $oldAutoCommit;
5467               return "can't auto-insert advertising source: $referral: $error";
5468             }
5469           }
5470
5471           $columns[0] = $part_referral->refnum;
5472         }
5473
5474         #$cust_main{$field} = shift @$columns;
5475         $cust_main{$field} = shift @columns;
5476       }
5477     }
5478
5479     $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
5480
5481     my $invoicing_list = $cust_main{'invoicing_list'}
5482                            ? [ delete $cust_main{'invoicing_list'} ]
5483                            : [];
5484
5485     my $cust_main = new FS::cust_main ( \%cust_main );
5486
5487     use Tie::RefHash;
5488     tie my %hash, 'Tie::RefHash'; #this part is important
5489
5490     if ( $cust_pkg{'pkgpart'} ) {
5491       my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
5492
5493       my @svc_acct = ();
5494       if ( $svc_acct{'username'} ) {
5495         my $part_pkg = $cust_pkg->part_pkg;
5496         unless ( $part_pkg ) {
5497           $dbh->rollback if $oldAutoCommit;
5498           return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
5499         }
5500         $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
5501         push @svc_acct, new FS::svc_acct ( \%svc_acct )
5502       }
5503
5504       $hash{$cust_pkg} = \@svc_acct;
5505     }
5506
5507     my $error = $cust_main->insert( \%hash, $invoicing_list );
5508
5509     if ( $error ) {
5510       $dbh->rollback if $oldAutoCommit;
5511       return "can't insert customer for $line: $error";
5512     }
5513
5514     if ( $format eq 'simple' ) {
5515
5516       #false laziness w/bill.cgi
5517       $error = $cust_main->bill( 'time' => $billtime );
5518       if ( $error ) {
5519         $dbh->rollback if $oldAutoCommit;
5520         return "can't bill customer for $line: $error";
5521       }
5522
5523       $error = $cust_main->apply_payments_and_credits;
5524       if ( $error ) {
5525         $dbh->rollback if $oldAutoCommit;
5526         return "can't bill customer for $line: $error";
5527       }
5528
5529       $error = $cust_main->collect();
5530       if ( $error ) {
5531         $dbh->rollback if $oldAutoCommit;
5532         return "can't collect customer for $line: $error";
5533       }
5534
5535     }
5536
5537     $imported++;
5538   }
5539
5540   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5541
5542   return "Empty file!" unless $imported;
5543
5544   ''; #no error
5545
5546 }
5547
5548 =item batch_charge
5549
5550 =cut
5551
5552 sub batch_charge {
5553   my $param = shift;
5554   #warn join('-',keys %$param);
5555   my $fh = $param->{filehandle};
5556   my @fields = @{$param->{fields}};
5557
5558   eval "use Text::CSV_XS;";
5559   die $@ if $@;
5560
5561   my $csv = new Text::CSV_XS;
5562   #warn $csv;
5563   #warn $fh;
5564
5565   my $imported = 0;
5566   #my $columns;
5567
5568   local $SIG{HUP} = 'IGNORE';
5569   local $SIG{INT} = 'IGNORE';
5570   local $SIG{QUIT} = 'IGNORE';
5571   local $SIG{TERM} = 'IGNORE';
5572   local $SIG{TSTP} = 'IGNORE';
5573   local $SIG{PIPE} = 'IGNORE';
5574
5575   my $oldAutoCommit = $FS::UID::AutoCommit;
5576   local $FS::UID::AutoCommit = 0;
5577   my $dbh = dbh;
5578
5579   #while ( $columns = $csv->getline($fh) ) {
5580   my $line;
5581   while ( defined($line=<$fh>) ) {
5582
5583     $csv->parse($line) or do {
5584       $dbh->rollback if $oldAutoCommit;
5585       return "can't parse: ". $csv->error_input();
5586     };
5587
5588     my @columns = $csv->fields();
5589     #warn join('-',@columns);
5590
5591     my %row = ();
5592     foreach my $field ( @fields ) {
5593       $row{$field} = shift @columns;
5594     }
5595
5596     my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
5597     unless ( $cust_main ) {
5598       $dbh->rollback if $oldAutoCommit;
5599       return "unknown custnum $row{'custnum'}";
5600     }
5601
5602     if ( $row{'amount'} > 0 ) {
5603       my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
5604       if ( $error ) {
5605         $dbh->rollback if $oldAutoCommit;
5606         return $error;
5607       }
5608       $imported++;
5609     } elsif ( $row{'amount'} < 0 ) {
5610       my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
5611                                       $row{'pkg'}                         );
5612       if ( $error ) {
5613         $dbh->rollback if $oldAutoCommit;
5614         return $error;
5615       }
5616       $imported++;
5617     } else {
5618       #hmm?
5619     }
5620
5621   }
5622
5623   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5624
5625   return "Empty file!" unless $imported;
5626
5627   ''; #no error
5628
5629 }
5630
5631 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5632
5633 Sends a templated email notification to the customer (see L<Text::Template>).
5634
5635 OPTIONS is a hash and may include
5636
5637 I<from> - the email sender (default is invoice_from)
5638
5639 I<to> - comma-separated scalar or arrayref of recipients
5640    (default is invoicing_list)
5641
5642 I<subject> - The subject line of the sent email notification
5643    (default is "Notice from company_name")
5644
5645 I<extra_fields> - a hashref of name/value pairs which will be substituted
5646    into the template
5647
5648 The following variables are vavailable in the template.
5649
5650 I<$first> - the customer first name
5651 I<$last> - the customer last name
5652 I<$company> - the customer company
5653 I<$payby> - a description of the method of payment for the customer
5654             # would be nice to use FS::payby::shortname
5655 I<$payinfo> - the account information used to collect for this customer
5656 I<$expdate> - the expiration of the customer payment in seconds from epoch
5657
5658 =cut
5659
5660 sub notify {
5661   my ($customer, $template, %options) = @_;
5662
5663   return unless $conf->exists($template);
5664
5665   my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
5666   $from = $options{from} if exists($options{from});
5667
5668   my $to = join(',', $customer->invoicing_list_emailonly);
5669   $to = $options{to} if exists($options{to});
5670
5671   my $subject = "Notice from " . $conf->config('company_name')
5672     if $conf->exists('company_name');
5673   $subject = $options{subject} if exists($options{subject});
5674
5675   my $notify_template = new Text::Template (TYPE => 'ARRAY',
5676                                             SOURCE => [ map "$_\n",
5677                                               $conf->config($template)]
5678                                            )
5679     or die "can't create new Text::Template object: Text::Template::ERROR";
5680   $notify_template->compile()
5681     or die "can't compile template: Text::Template::ERROR";
5682
5683   my $paydate = $customer->paydate;
5684   $FS::notify_template::_template::first = $customer->first;
5685   $FS::notify_template::_template::last = $customer->last;
5686   $FS::notify_template::_template::company = $customer->company;
5687   $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
5688   my $payby = $customer->payby;
5689   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5690   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5691
5692   #credit cards expire at the end of the month/year of their exp date
5693   if ($payby eq 'CARD' || $payby eq 'DCRD') {
5694     $FS::notify_template::_template::payby = 'credit card';
5695     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5696     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5697     $expire_time--;
5698   }elsif ($payby eq 'COMP') {
5699     $FS::notify_template::_template::payby = 'complimentary account';
5700   }else{
5701     $FS::notify_template::_template::payby = 'current method';
5702   }
5703   $FS::notify_template::_template::expdate = $expire_time;
5704
5705   for (keys %{$options{extra_fields}}){
5706     no strict "refs";
5707     ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5708   }
5709
5710   send_email(from => $from,
5711              to => $to,
5712              subject => $subject,
5713              body => $notify_template->fill_in( PACKAGE =>
5714                                                 'FS::notify_template::_template'                                              ),
5715             );
5716
5717 }
5718
5719 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5720
5721 Generates a templated notification to the customer (see L<Text::Template>).
5722
5723 OPTIONS is a hash and may include
5724
5725 I<extra_fields> - a hashref of name/value pairs which will be substituted
5726    into the template.  These values may override values mentioned below
5727    and those from the customer record.
5728
5729 The following variables are available in the template instead of or in addition
5730 to the fields of the customer record.
5731
5732 I<$payby> - a description of the method of payment for the customer
5733             # would be nice to use FS::payby::shortname
5734 I<$payinfo> - the masked account information used to collect for this customer
5735 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5736 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress
5737
5738 =cut
5739
5740 sub generate_letter {
5741   my ($self, $template, %options) = @_;
5742
5743   return unless $conf->exists($template);
5744
5745   my $letter_template = new Text::Template
5746                         ( TYPE       => 'ARRAY',
5747                           SOURCE     => [ map "$_\n", $conf->config($template)],
5748                           DELIMITERS => [ '[@--', '--@]' ],
5749                         )
5750     or die "can't create new Text::Template object: Text::Template::ERROR";
5751
5752   $letter_template->compile()
5753     or die "can't compile template: Text::Template::ERROR";
5754
5755   my %letter_data = map { $_ => $self->$_ } $self->fields;
5756   $letter_data{payinfo} = $self->mask_payinfo;
5757
5758   #my $paydate = $self->paydate || '2037-12';
5759   my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12';
5760
5761   my $payby = $self->payby;
5762   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5763   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5764
5765   #credit cards expire at the end of the month/year of their exp date
5766   if ($payby eq 'CARD' || $payby eq 'DCRD') {
5767     $letter_data{payby} = 'credit card';
5768     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5769     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5770     $expire_time--;
5771   }elsif ($payby eq 'COMP') {
5772     $letter_data{payby} = 'complimentary account';
5773   }else{
5774     $letter_data{payby} = 'current method';
5775   }
5776   $letter_data{expdate} = $expire_time;
5777
5778   for (keys %{$options{extra_fields}}){
5779     $letter_data{$_} = $options{extra_fields}->{$_};
5780   }
5781
5782   unless(exists($letter_data{returnaddress})){
5783     my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5784                                                   $self->agent_template)
5785                      );
5786
5787     $letter_data{returnaddress} = length($retadd) ? $retadd : '~';
5788   }
5789
5790   $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5791
5792   my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
5793   my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5794                            DIR      => $dir,
5795                            SUFFIX   => '.tex',
5796                            UNLINK   => 0,
5797                          ) or die "can't open temp file: $!\n";
5798
5799   $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5800   close $fh;
5801   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5802   return $1;
5803 }
5804
5805 =item print_ps TEMPLATE
5806
5807 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5808
5809 =cut
5810
5811 sub print_ps {
5812   my $self = shift;
5813   my $file = $self->generate_letter(@_);
5814   FS::Misc::generate_ps($file);
5815 }
5816
5817 =item print TEMPLATE
5818
5819 Prints the filled in template.
5820
5821 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5822
5823 =cut
5824
5825 sub queueable_print {
5826   my %opt = @_;
5827
5828   my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5829     or die "invalid customer number: " . $opt{custvnum};
5830
5831   my $error = $self->print( $opt{template} );
5832   die $error if $error;
5833 }
5834
5835 sub print {
5836   my ($self, $template) = (shift, shift);
5837   do_print [ $self->print_ps($template) ];
5838 }
5839
5840 sub agent_template {
5841   my $self = shift;
5842   $self->_agent_plandata('agent_templatename');
5843 }
5844
5845 sub agent_invoice_from {
5846   my $self = shift;
5847   $self->_agent_plandata('agent_invoice_from');
5848 }
5849
5850 sub _agent_plandata {
5851   my( $self, $option ) = @_;
5852
5853   #yuck.  this whole thing needs to be reconciled better with 1.9's idea of
5854   #agent-specific Conf
5855
5856   my $agentnum = $self->agentnum;
5857
5858   my $part_event_option =
5859     qsearchs({
5860       'select'    => 'part_event_option.*',
5861       'table'     => 'part_event_option',
5862       'addl_from' => q{
5863         LEFT JOIN part_event USING ( eventpart )
5864         LEFT JOIN part_event_option AS peo_agentnum
5865           ON ( part_event.eventpart = peo_agentnum.eventpart
5866                AND peo_agentnum.optionname = 'agentnum'
5867                AND peo_agentnum.optionvalue ~ '(^|,)}. $agentnum. q{(,|$)'
5868              )
5869         LEFT JOIN part_event_option AS peo_cust_bill_age
5870           ON ( part_event.eventpart = peo_cust_bill_age.eventpart
5871                AND peo_cust_bill_age.optionname = 'cust_bill_age'
5872              )
5873       },
5874       #'hashref'   => { 'optionname' => $option },
5875       #'hashref'   => { 'part_event_option.optionname' => $option },
5876       'extra_sql' =>
5877         " WHERE part_event_option.optionname = ". dbh->quote($option).
5878         " AND action = 'cust_bill_send_agent' ".
5879         " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5880         " AND peo_agentnum.optionname = 'agentnum' ".
5881         " AND agentnum IS NULL OR agentnum = $agentnum ".
5882         " ORDER BY
5883            CASE WHEN peo_cust_bill_age.optionname != 'cust_bill_age'
5884            THEN -1
5885            ELSE EXTRACT( EPOCH FROM
5886                            REPLACE( peo_cust_bill_age.optionvalue,
5887                                     'm',
5888                                     'mon'
5889                                   )::interval
5890                        )
5891           END
5892           , part_event.weight".
5893         " LIMIT 1"
5894     });
5895
5896   unless ( $part_event_option ) {
5897     return $self->agent->invoice_template || ''
5898       if $option eq 'agent_templatename';
5899     return '';
5900   }
5901
5902   $part_event_option->optionvalue;
5903
5904 }
5905
5906 sub queued_bill {
5907   ## actual sub, not a method, designed to be called from the queue.
5908   ## sets up the customer, and calls the bill_and_collect
5909   my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5910   my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5911       $cust_main->bill_and_collect(
5912         %args,
5913       );
5914 }
5915
5916 =back
5917
5918 =head1 BUGS
5919
5920 The delete method.
5921
5922 The delete method should possibly take an FS::cust_main object reference
5923 instead of a scalar customer number.
5924
5925 Bill and collect options should probably be passed as references instead of a
5926 list.
5927
5928 There should probably be a configuration file with a list of allowed credit
5929 card types.
5930
5931 No multiple currency support (probably a larger project than just this module).
5932
5933 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5934
5935 Birthdates rely on negative epoch values.
5936
5937 The payby for card/check batches is broken.  With mixed batching, bad
5938 things will happen.
5939
5940 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5941
5942 =head1 SEE ALSO
5943
5944 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5945 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5946 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
5947
5948 =cut
5949
5950 1;
5951