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 Scalar::Util qw( blessed );
  12 use Time::Local qw(timelocal);
  13 use Data::Dumper;
  14 use Tie::IxHash;
  15 use Digest::MD5 qw(md5_base64);
  16 use Date::Format;
  17 #use Date::Manip;
  18 use File::Temp qw( tempfile );
  19 use String::Approx qw(amatch);
  20 use Business::CreditCard 0.28;
  21 use Locale::Country;
  22 use FS::UID qw( getotaker dbh driver_name );
  23 use FS::Record qw( qsearchs qsearch dbdef );
  24 use FS::Misc qw( generate_email send_email generate_ps do_print );
  25 use FS::Msgcat qw(gettext);
  26 use FS::payby;
  27 use FS::cust_pkg;
  28 use FS::cust_svc;
  29 use FS::cust_bill;
  30 use FS::cust_bill_pkg;
  31 use FS::cust_bill_pkg_display;
  32 use FS::cust_bill_pkg_tax_location;
  33 use FS::cust_bill_pkg_tax_rate_location;
  34 use FS::cust_pay;
  35 use FS::cust_pay_pending;
  36 use FS::cust_pay_void;
  37 use FS::cust_pay_batch;
  38 use FS::cust_credit;
  39 use FS::cust_refund;
  40 use FS::part_referral;
  41 use FS::cust_main_county;
  42 use FS::cust_location;
  43 use FS::tax_rate;
  44 use FS::tax_rate_location;
  45 use FS::cust_tax_location;
  46 use FS::part_pkg_taxrate;
  47 use FS::agent;
  48 use FS::cust_main_invoice;
  49 use FS::cust_credit_bill;
  50 use FS::cust_bill_pay;
  51 use FS::prepay_credit;
  52 use FS::queue;
  53 use FS::part_pkg;
  54 use FS::part_event;
  55 use FS::part_event_condition;
  56 #use FS::cust_event;
  57 use FS::type_pkgs;
  58 use FS::payment_gateway;
  59 use FS::agent_payment_gateway;
  60 use FS::banned_pay;
  61 use FS::payinfo_Mixin;
  62 use FS::TicketSystem;
  63
  64 @ISA = qw( FS::payinfo_Mixin FS::Record );
  65
  66 @EXPORT_OK = qw( smart_search );
  67
  68 $realtime_bop_decline_quiet = 0;
  69
  70 # 1 is mostly method/subroutine entry and options
  71 # 2 traces progress of some operations
  72 # 3 is even more information including possibly sensitive data
  73 $DEBUG = 0;
  74 $me = '[FS::cust_main]';
  75
  76 $import = 0;
  77 $skip_fuzzyfiles = 0;
  78 $ignore_expired_card = 0;
  79
  80 @encrypted_fields = ('payinfo', 'paycvv');
  81 sub nohistory_fields { ('paycvv'); }
  82
  83 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
  84
  85 #ask FS::UID to run this stuff for us later
  86 #$FS::UID::callback{'FS::cust_main'} = sub {
  87 install_callback FS::UID sub {
  88   $conf = new FS::Conf;
  89   #yes, need it for stuff below (prolly should be cached)
  90 };
  91
  92 sub _cache {
  93   my $self = shift;
  94   my ( $hashref, $cache ) = @_;
  95   if ( exists $hashref->{'pkgnum'} ) {
  96     #@{ $self->{'_pkgnum'} } = ();
  97     my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
  98     $self->{'_pkgnum'} = $subcache;
  99     #push @{ $self->{'_pkgnum'} },
 100     FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
 101   }
 102 }
 103
 104 =head1 NAME
 105
 106 FS::cust_main - Object methods for cust_main records
 107
 108 =head1 SYNOPSIS
 109
 110   use FS::cust_main;
 111
 112   $record = new FS::cust_main \%hash;
 113   $record = new FS::cust_main { 'column' => 'value' };
 114
 115   $error = $record->insert;
 116
 117   $error = $new_record->replace($old_record);
 118
 119   $error = $record->delete;
 120
 121   $error = $record->check;
 122
 123   @cust_pkg = $record->all_pkgs;
 124
 125   @cust_pkg = $record->ncancelled_pkgs;
 126
 127   @cust_pkg = $record->suspended_pkgs;
 128
 129   $error = $record->bill;
 130   $error = $record->bill %options;
 131   $error = $record->bill 'time' => $time;
 132
 133   $error = $record->collect;
 134   $error = $record->collect %options;
 135   $error = $record->collect 'invoice_time'   => $time,
 136                           ;
 137
 138 =head1 DESCRIPTION
 139
 140 An FS::cust_main object represents a customer.  FS::cust_main inherits from
 141 FS::Record.  The following fields are currently supported:
 142
 143 =over 4
 144
 145 =item custnum
 146
 147 Primary key (assigned automatically for new customers)
 148
 149 =item agentnum
 150
 151 Agent (see L<FS::agent>)
 152
 153 =item refnum
 154
 155 Advertising source (see L<FS::part_referral>)
 156
 157 =item first
 158
 159 First name
 160
 161 =item last
 162
 163 Last name
 164
 165 =item ss
 166
 167 Cocial security number (optional)
 168
 169 =item company
 170
 171 (optional)
 172
 173 =item address1
 174
 175 =item address2
 176
 177 (optional)
 178
 179 =item city
 180
 181 =item county
 182
 183 (optional, see L<FS::cust_main_county>)
 184
 185 =item state
 186
 187 (see L<FS::cust_main_county>)
 188
 189 =item zip
 190
 191 =item country
 192
 193 (see L<FS::cust_main_county>)
 194
 195 =item daytime
 196
 197 phone (optional)
 198
 199 =item night
 200
 201 phone (optional)
 202
 203 =item fax
 204
 205 phone (optional)
 206
 207 =item ship_first
 208
 209 Shipping first name
 210
 211 =item ship_last
 212
 213 Shipping last name
 214
 215 =item ship_company
 216
 217 (optional)
 218
 219 =item ship_address1
 220
 221 =item ship_address2
 222
 223 (optional)
 224
 225 =item ship_city
 226
 227 =item ship_county
 228
 229 (optional, see L<FS::cust_main_county>)
 230
 231 =item ship_state
 232
 233 (see L<FS::cust_main_county>)
 234
 235 =item ship_zip
 236
 237 =item ship_country
 238
 239 (see L<FS::cust_main_county>)
 240
 241 =item ship_daytime
 242
 243 phone (optional)
 244
 245 =item ship_night
 246
 247 phone (optional)
 248
 249 =item ship_fax
 250
 251 phone (optional)
 252
 253 =item payby
 254
 255 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
 256
 257 =item payinfo
 258
 259 Payment Information (See L<FS::payinfo_Mixin> for data format)
 260
 261 =item paymask
 262
 263 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
 264
 265 =item paycvv
 266
 267 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
 268
 269 =item paydate
 270
 271 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
 272
 273 =item paystart_month
 274
 275 Start date month (maestro/solo cards only)
 276
 277 =item paystart_year
 278
 279 Start date year (maestro/solo cards only)
 280
 281 =item payissue
 282
 283 Issue number (maestro/solo cards only)
 284
 285 =item payname
 286
 287 Name on card or billing name
 288
 289 =item payip
 290
 291 IP address from which payment information was received
 292
 293 =item tax
 294
 295 Tax exempt, empty or `Y'
 296
 297 =item otaker
 298
 299 Order taker (assigned automatically, see L<FS::UID>)
 300
 301 =item comments
 302
 303 Comments (optional)
 304
 305 =item referral_custnum
 306
 307 Referring customer number
 308
 309 =item spool_cdr
 310
 311 Enable individual CDR spooling, empty or `Y'
 312
 313 =item dundate
 314
 315 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
 316
 317 =item squelch_cdr
 318
 319 Discourage individual CDR printing, empty or `Y'
 320
 321 =back
 322
 323 =head1 METHODS
 324
 325 =over 4
 326
 327 =item new HASHREF
 328
 329 Creates a new customer.  To add the customer to the database, see L<"insert">.
 330
 331 Note that this stores the hash reference, not a distinct copy of the hash it
 332 points to.  You can ask the object for a copy with the I<hash> method.
 333
 334 =cut
 335
 336 sub table { 'cust_main'; }
 337
 338 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
 339
 340 Adds this customer to the database.  If there is an error, returns the error,
 341 otherwise returns false.
 342
 343 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
 344 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
 345 are inserted atomicly, or the transaction is rolled back.  Passing an empty
 346 hash reference is equivalent to not supplying this parameter.  There should be
 347 a better explanation of this, but until then, here's an example:
 348
 349   use Tie::RefHash;
 350   tie %hash, 'Tie::RefHash'; #this part is important
 351   %hash = (
 352     $cust_pkg => [ $svc_acct ],
 353     ...
 354   );
 355   $cust_main->insert( \%hash );
 356
 357 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
 358 be set as the invoicing list (see L<"invoicing_list">).  Errors return as
 359 expected and rollback the entire transaction; it is not necessary to call
 360 check_invoicing_list first.  The invoicing_list is set after the records in the
 361 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
 362 invoicing_list destination to the newly-created svc_acct.  Here's an example:
 363
 364   $cust_main->insert( {}, [ $email, 'POST' ] );
 365
 366 Currently available options are: I<depend_jobnum> and I<noexport>.
 367
 368 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
 369 on the supplied jobnum (they will not run until the specific job completes).
 370 This can be used to defer provisioning until some action completes (such
 371 as running the customer's credit card successfully).
 372
 373 The I<noexport> option is deprecated.  If I<noexport> is set true, no
 374 provisioning jobs (exports) are scheduled.  (You can schedule them later with
 375 the B<reexport> method.)
 376
 377 =cut
 378
 379 sub insert {
 380   my $self = shift;
 381   my $cust_pkgs = @_ ? shift : {};
 382   my $invoicing_list = @_ ? shift : '';
 383   my %options = @_;
 384   warn "$me insert called with options ".
 385        join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
 386     if $DEBUG;
 387
 388   local $SIG{HUP} = 'IGNORE';
 389   local $SIG{INT} = 'IGNORE';
 390   local $SIG{QUIT} = 'IGNORE';
 391   local $SIG{TERM} = 'IGNORE';
 392   local $SIG{TSTP} = 'IGNORE';
 393   local $SIG{PIPE} = 'IGNORE';
 394
 395   my $oldAutoCommit = $FS::UID::AutoCommit;
 396   local $FS::UID::AutoCommit = 0;
 397   my $dbh = dbh;
 398
 399   my $prepay_identifier = '';
 400   my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
 401   my $payby = '';
 402   if ( $self->payby eq 'PREPAY' ) {
 403
 404     $self->payby('BILL');
 405     $prepay_identifier = $self->payinfo;
 406     $self->payinfo('');
 407
 408     warn "  looking up prepaid card $prepay_identifier\n"
 409       if $DEBUG > 1;
 410
 411     my $error = $self->get_prepay( $prepay_identifier,
 412                                    'amount_ref'     => \$amount,
 413                                    'seconds_ref'    => \$seconds,
 414                                    'upbytes_ref'    => \$upbytes,
 415                                    'downbytes_ref'  => \$downbytes,
 416                                    'totalbytes_ref' => \$totalbytes,
 417                                  );
 418     if ( $error ) {
 419       $dbh->rollback if $oldAutoCommit;
 420       #return "error applying prepaid card (transaction rolled back): $error";
 421       return $error;
 422     }
 423
 424     $payby = 'PREP' if $amount;
 425
 426   } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
 427
 428     $payby = $1;
 429     $self->payby('BILL');
 430     $amount = $self->paid;
 431
 432   }
 433
 434   warn "  inserting $self\n"
 435     if $DEBUG > 1;
 436
 437   $self->signupdate(time) unless $self->signupdate;
 438
 439   $self->auto_agent_custid()
 440     if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
 441
 442   my $error = $self->SUPER::insert;
 443   if ( $error ) {
 444     $dbh->rollback if $oldAutoCommit;
 445     #return "inserting cust_main record (transaction rolled back): $error";
 446     return $error;
 447   }
 448
 449   warn "  setting invoicing list\n"
 450     if $DEBUG > 1;
 451
 452   if ( $invoicing_list ) {
 453     $error = $self->check_invoicing_list( $invoicing_list );
 454     if ( $error ) {
 455       $dbh->rollback if $oldAutoCommit;
 456       #return "checking invoicing_list (transaction rolled back): $error";
 457       return $error;
 458     }
 459     $self->invoicing_list( $invoicing_list );
 460   }
 461
 462   if (    $conf->config('cust_main-skeleton_tables')
 463        && $conf->config('cust_main-skeleton_custnum') ) {
 464
 465     warn "  inserting skeleton records\n"
 466       if $DEBUG > 1;
 467
 468     my $error = $self->start_copy_skel;
 469     if ( $error ) {
 470       $dbh->rollback if $oldAutoCommit;
 471       return $error;
 472     }
 473
 474   }
 475
 476   warn "  ordering packages\n"
 477     if $DEBUG > 1;
 478
 479   $error = $self->order_pkgs( $cust_pkgs,
 480                               %options,
 481                               'seconds_ref'    => \$seconds,
 482                               'upbytes_ref'    => \$upbytes,
 483                               'downbytes_ref'  => \$downbytes,
 484                               'totalbytes_ref' => \$totalbytes,
 485                             );
 486   if ( $error ) {
 487     $dbh->rollback if $oldAutoCommit;
 488     return $error;
 489   }
 490
 491   if ( $seconds ) {
 492     $dbh->rollback if $oldAutoCommit;
 493     return "No svc_acct record to apply pre-paid time";
 494   }
 495   if ( $upbytes || $downbytes || $totalbytes ) {
 496     $dbh->rollback if $oldAutoCommit;
 497     return "No svc_acct record to apply pre-paid data";
 498   }
 499
 500   if ( $amount ) {
 501     warn "  inserting initial $payby payment of $amount\n"
 502       if $DEBUG > 1;
 503     $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
 504     if ( $error ) {
 505       $dbh->rollback if $oldAutoCommit;
 506       return "inserting payment (transaction rolled back): $error";
 507     }
 508   }
 509
 510   unless ( $import || $skip_fuzzyfiles ) {
 511     warn "  queueing fuzzyfiles update\n"
 512       if $DEBUG > 1;
 513     $error = $self->queue_fuzzyfiles_update;
 514     if ( $error ) {
 515       $dbh->rollback if $oldAutoCommit;
 516       return "updating fuzzy search cache: $error";
 517     }
 518   }
 519
 520   warn "  insert complete; committing transaction\n"
 521     if $DEBUG > 1;
 522
 523   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 524   '';
 525
 526 }
 527
 528 use File::CounterFile;
 529 sub auto_agent_custid {
 530   my $self = shift;
 531
 532   my $format = $conf->config('cust_main-auto_agent_custid');
 533   my $agent_custid;
 534   if ( $format eq '1YMMXXXXXXXX' ) {
 535
 536     my $counter = new File::CounterFile 'cust_main.agent_custid';
 537     $counter->lock;
 538
 539     my $ym = 100000000000 + time2str('%y%m00000000', time);
 540     if ( $ym > $counter->value ) {
 541       $counter->{'value'} = $agent_custid = $ym;
 542       $counter->{'updated'} = 1;
 543     } else {
 544       $agent_custid = $counter->inc;
 545     }
 546
 547     $counter->unlock;
 548
 549   } else {
 550     die "Unknown cust_main-auto_agent_custid format: $format";
 551   }
 552
 553   $self->agent_custid($agent_custid);
 554
 555 }
 556
 557 sub start_copy_skel {
 558   my $self = shift;
 559
 560   #'mg_user_preference' => {},
 561   #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
 562   #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
 563   #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
 564   #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
 565   my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
 566   die $@ if $@;
 567
 568   _copy_skel( 'cust_main',                                 #tablename
 569               $conf->config('cust_main-skeleton_custnum'), #sourceid
 570               $self->custnum,                              #destid
 571               @tables,                                     #child tables
 572             );
 573 }
 574
 575 #recursive subroutine, not a method
 576 sub _copy_skel {
 577   my( $table, $sourceid, $destid, %child_tables ) = @_;
 578
 579   my $primary_key;
 580   if ( $table =~ /^(\w+)\.(\w+)$/ ) {
 581     ( $table, $primary_key ) = ( $1, $2 );
 582   } else {
 583     my $dbdef_table = dbdef->table($table);
 584     $primary_key = $dbdef_table->primary_key
 585       or return "$table has no primary key".
 586                 " (or do you need to run dbdef-create?)";
 587   }
 588
 589   warn "  _copy_skel: $table.$primary_key $sourceid to $destid for ".
 590        join (', ', keys %child_tables). "\n"
 591     if $DEBUG > 2;
 592
 593   foreach my $child_table_def ( keys %child_tables ) {
 594
 595     my $child_table;
 596     my $child_pkey = '';
 597     if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
 598       ( $child_table, $child_pkey ) = ( $1, $2 );
 599     } else {
 600       $child_table = $child_table_def;
 601
 602       $child_pkey = dbdef->table($child_table)->primary_key;
 603       #  or return "$table has no primary key".
 604       #            " (or do you need to run dbdef-create?)\n";
 605     }
 606
 607     my $sequence = '';
 608     if ( keys %{ $child_tables{$child_table_def} } ) {
 609
 610       return "$child_table has no primary key".
 611              " (run dbdef-create or try specifying it?)\n"
 612         unless $child_pkey;
 613
 614       #false laziness w/Record::insert and only works on Pg
 615       #refactor the proper last-inserted-id stuff out of Record::insert if this
 616       # ever gets use for anything besides a quick kludge for one customer
 617       my $default = dbdef->table($child_table)->column($child_pkey)->default;
 618       $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
 619         or return "can't parse $child_table.$child_pkey default value ".
 620                   " for sequence name: $default";
 621       $sequence = $1;
 622
 623     }
 624
 625     my @sel_columns = grep { $_ ne $primary_key }
 626                            dbdef->table($child_table)->columns;
 627     my $sel_columns = join(', ', @sel_columns );
 628
 629     my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
 630     my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
 631     my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
 632
 633     my $sel_st = "SELECT $sel_columns FROM $child_table".
 634                  " WHERE $primary_key = $sourceid";
 635     warn "    $sel_st\n"
 636       if $DEBUG > 2;
 637     my $sel_sth = dbh->prepare( $sel_st )
 638       or return dbh->errstr;
 639
 640     $sel_sth->execute or return $sel_sth->errstr;
 641
 642     while ( my $row = $sel_sth->fetchrow_hashref ) {
 643
 644       warn "    selected row: ".
 645            join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
 646         if $DEBUG > 2;
 647
 648       my $statement =
 649         "INSERT INTO $child_table $ins_columns VALUES $placeholders";
 650       my $ins_sth =dbh->prepare($statement)
 651           or return dbh->errstr;
 652       my @param = ( $destid, map $row->{$_}, @ins_columns );
 653       warn "    $statement: [ ". join(', ', @param). " ]\n"
 654         if $DEBUG > 2;
 655       $ins_sth->execute( @param )
 656         or return $ins_sth->errstr;
 657
 658       #next unless keys %{ $child_tables{$child_table} };
 659       next unless $sequence;
 660
 661       #another section of that laziness
 662       my $seq_sql = "SELECT currval('$sequence')";
 663       my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
 664       $seq_sth->execute or return $seq_sth->errstr;
 665       my $insertid = $seq_sth->fetchrow_arrayref->[0];
 666
 667       # don't drink soap!  recurse!  recurse!  okay!
 668       my $error =
 669         _copy_skel( $child_table_def,
 670                     $row->{$child_pkey}, #sourceid
 671                     $insertid, #destid
 672                     %{ $child_tables{$child_table_def} },
 673                   );
 674       return $error if $error;
 675
 676     }
 677
 678   }
 679
 680   return '';
 681
 682 }
 683
 684 =item order_pkg HASHREF | OPTION => VALUE ...
 685
 686 Orders a single package.
 687
 688 Options may be passed as a list of key/value pairs or as a hash reference.
 689 Options are:
 690
 691 =over 4
 692
 693 =item cust_pkg
 694
 695 FS::cust_pkg object
 696
 697 =item cust_location
 698
 699 Optional FS::cust_location object
 700
 701 =item svcs
 702
 703 Optional arryaref of FS::svc_* service objects.
 704
 705 =item depend_jobnum
 706
 707 If this option is set to a job queue jobnum (see L<FS::queue>), all provisioning
 708 jobs will have a dependancy on the supplied job (they will not run until the
 709 specific job completes).  This can be used to defer provisioning until some
 710 action completes (such as running the customer's credit card successfully).
 711
 712 =item ticket_subject
 713
 714 Optional subject for a ticket created and attached to this customer
 715
 716 =item ticket_subject
 717
 718 Optional queue name for ticket additions
 719
 720 =back
 721
 722 =cut
 723
 724 sub order_pkg {
 725   my $self = shift;
 726   my $opt = ref($_[0]) ? shift : { @_ };
 727
 728   warn "$me order_pkg called with options ".
 729        join(', ', map { "$_: $opt->{$_}" } keys %$opt ). "\n"
 730     if $DEBUG;
 731
 732   my $cust_pkg = $opt->{'cust_pkg'};
 733   my $svcs     = $opt->{'svcs'} || [];
 734
 735   my %svc_options = ();
 736   $svc_options{'depend_jobnum'} = $opt->{'depend_jobnum'}
 737     if exists($opt->{'depend_jobnum'}) && $opt->{'depend_jobnum'};
 738
 739   my %insert_params = map { $opt->{$_} ? ( $_ => $opt->{$_} ) : () }
 740                           qw( ticket_subject ticket_queue );
 741
 742   local $SIG{HUP} = 'IGNORE';
 743   local $SIG{INT} = 'IGNORE';
 744   local $SIG{QUIT} = 'IGNORE';
 745   local $SIG{TERM} = 'IGNORE';
 746   local $SIG{TSTP} = 'IGNORE';
 747   local $SIG{PIPE} = 'IGNORE';
 748
 749   my $oldAutoCommit = $FS::UID::AutoCommit;
 750   local $FS::UID::AutoCommit = 0;
 751   my $dbh = dbh;
 752
 753   if ( $opt->{'cust_location'} &&
 754        ( ! $cust_pkg->locationnum || $cust_pkg->locationnum == -1 ) ) {
 755     my $error = $opt->{'cust_location'}->insert;
 756     if ( $error ) {
 757       $dbh->rollback if $oldAutoCommit;
 758       return "inserting cust_location (transaction rolled back): $error";
 759     }
 760     $cust_pkg->locationnum($opt->{'cust_location'}->locationnum);
 761   }
 762
 763   $cust_pkg->custnum( $self->custnum );
 764
 765   my $error = $cust_pkg->insert( %insert_params );
 766   if ( $error ) {
 767     $dbh->rollback if $oldAutoCommit;
 768     return "inserting cust_pkg (transaction rolled back): $error";
 769   }
 770
 771   foreach my $svc_something ( @{ $opt->{'svcs'} } ) {
 772     if ( $svc_something->svcnum ) {
 773       my $old_cust_svc = $svc_something->cust_svc;
 774       my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
 775       $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
 776       $error = $new_cust_svc->replace($old_cust_svc);
 777     } else {
 778       $svc_something->pkgnum( $cust_pkg->pkgnum );
 779       if ( $svc_something->isa('FS::svc_acct') ) {
 780         foreach ( grep { $opt->{$_.'_ref'} && ${ $opt->{$_.'_ref'} } }
 781                        qw( seconds upbytes downbytes totalbytes )      ) {
 782           $svc_something->$_( $svc_something->$_() + ${ $opt->{$_.'_ref'} } );
 783           ${ $opt->{$_.'_ref'} } = 0;
 784         }
 785       }
 786       $error = $svc_something->insert(%svc_options);
 787     }
 788     if ( $error ) {
 789       $dbh->rollback if $oldAutoCommit;
 790       return "inserting svc_ (transaction rolled back): $error";
 791     }
 792   }
 793
 794   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 795   ''; #no error
 796
 797 }
 798
 799 #deprecated #=item order_pkgs HASHREF [ , SECONDSREF ] [ , OPTION => VALUE ... ]
 800 =item order_pkgs HASHREF [ , OPTION => VALUE ... ]
 801
 802 Like the insert method on an existing record, this method orders multiple
 803 packages and included services atomicaly.  Pass a Tie::RefHash data structure
 804 to this method containing FS::cust_pkg and FS::svc_I<tablename> objects.
 805 There should be a better explanation of this, but until then, here's an
 806 example:
 807
 808   use Tie::RefHash;
 809   tie %hash, 'Tie::RefHash'; #this part is important
 810   %hash = (
 811     $cust_pkg => [ $svc_acct ],
 812     ...
 813   );
 814   $cust_main->order_pkgs( \%hash, 'noexport'=>1 );
 815
 816 Services can be new, in which case they are inserted, or existing unaudited
 817 services, in which case they are linked to the newly-created package.
 818
 819 Currently available options are: I<depend_jobnum>, I<noexport>, I<seconds_ref>,
 820 I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>.
 821
 822 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
 823 on the supplied jobnum (they will not run until the specific job completes).
 824 This can be used to defer provisioning until some action completes (such
 825 as running the customer's credit card successfully).
 826
 827 The I<noexport> option is deprecated.  If I<noexport> is set true, no
 828 provisioning jobs (exports) are scheduled.  (You can schedule them later with
 829 the B<reexport> method for each cust_pkg object.  Using the B<reexport> method
 830 on the cust_main object is not recommended, as existing services will also be
 831 reexported.)
 832
 833 If I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, or I<totalbytes_ref> is
 834 provided, the scalars (provided by references) will be incremented by the
 835 values of the prepaid card.`
 836
 837 =cut
 838
 839 sub order_pkgs {
 840   my $self = shift;
 841   my $cust_pkgs = shift;
 842   my $seconds_ref = ref($_[0]) ? shift : ''; #deprecated
 843   my %options = @_;
 844   $seconds_ref ||= $options{'seconds_ref'};
 845
 846   warn "$me order_pkgs called with options ".
 847        join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
 848     if $DEBUG;
 849
 850   local $SIG{HUP} = 'IGNORE';
 851   local $SIG{INT} = 'IGNORE';
 852   local $SIG{QUIT} = 'IGNORE';
 853   local $SIG{TERM} = 'IGNORE';
 854   local $SIG{TSTP} = 'IGNORE';
 855   local $SIG{PIPE} = 'IGNORE';
 856
 857   my $oldAutoCommit = $FS::UID::AutoCommit;
 858   local $FS::UID::AutoCommit = 0;
 859   my $dbh = dbh;
 860
 861   local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
 862
 863   foreach my $cust_pkg ( keys %$cust_pkgs ) {
 864
 865     my $error = $self->order_pkg(
 866       'cust_pkg'     => $cust_pkg,
 867       'svcs'         => $cust_pkgs->{$cust_pkg},
 868       'seconds_ref'  => $seconds_ref,
 869       map { $_ => $options{$_} } qw( upbytes_ref downbytes_ref totalbytes_ref
 870                                      depend_jobnum
 871                                    )
 872     );
 873     if ( $error ) {
 874       $dbh->rollback if $oldAutoCommit;
 875       return $error;
 876     }
 877
 878   }
 879
 880   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 881   ''; #no error
 882 }
 883
 884 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
 885
 886 Recharges this (existing) customer with the specified prepaid card (see
 887 L<FS::prepay_credit>), specified either by I<identifier> or as an
 888 FS::prepay_credit object.  If there is an error, returns the error, otherwise
 889 returns false.
 890
 891 Optionally, five scalar references can be passed as well.  They will have their
 892 values filled in with the amount, number of seconds, and number of upload,
 893 download, and total bytes applied by this prepaid card.
 894
 895 =cut
 896
 897 #the ref bullshit here should be refactored like get_prepay.  MyAccount.pm is
 898 #the only place that uses these args
 899 sub recharge_prepay {
 900   my( $self, $prepay_credit, $amountref, $secondsref,
 901       $upbytesref, $downbytesref, $totalbytesref ) = @_;
 902
 903   local $SIG{HUP} = 'IGNORE';
 904   local $SIG{INT} = 'IGNORE';
 905   local $SIG{QUIT} = 'IGNORE';
 906   local $SIG{TERM} = 'IGNORE';
 907   local $SIG{TSTP} = 'IGNORE';
 908   local $SIG{PIPE} = 'IGNORE';
 909
 910   my $oldAutoCommit = $FS::UID::AutoCommit;
 911   local $FS::UID::AutoCommit = 0;
 912   my $dbh = dbh;
 913
 914   my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
 915
 916   my $error = $self->get_prepay( $prepay_credit,
 917                                  'amount_ref'     => \$amount,
 918                                  'seconds_ref'    => \$seconds,
 919                                  'upbytes_ref'    => \$upbytes,
 920                                  'downbytes_ref'  => \$downbytes,
 921                                  'totalbytes_ref' => \$totalbytes,
 922                                )
 923            || $self->increment_seconds($seconds)
 924            || $self->increment_upbytes($upbytes)
 925            || $self->increment_downbytes($downbytes)
 926            || $self->increment_totalbytes($totalbytes)
 927            || $self->insert_cust_pay_prepay( $amount,
 928                                              ref($prepay_credit)
 929                                                ? $prepay_credit->identifier
 930                                                : $prepay_credit
 931                                            );
 932
 933   if ( $error ) {
 934     $dbh->rollback if $oldAutoCommit;
 935     return $error;
 936   }
 937
 938   if ( defined($amountref)  ) { $$amountref  = $amount;  }
 939   if ( defined($secondsref) ) { $$secondsref = $seconds; }
 940   if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
 941   if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
 942   if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
 943
 944   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 945   '';
 946
 947 }
 948
 949 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
 950
 951 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
 952 specified either by I<identifier> or as an FS::prepay_credit object.
 953
 954 Available options are: I<amount_ref>, I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>.  The scalars (provided by references) will be
 955 incremented by the values of the prepaid card.
 956
 957 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
 958 check or set this customer's I<agentnum>.
 959
 960 If there is an error, returns the error, otherwise returns false.
 961
 962 =cut
 963
 964
 965 sub get_prepay {
 966   my( $self, $prepay_credit, %opt ) = @_;
 967
 968   local $SIG{HUP} = 'IGNORE';
 969   local $SIG{INT} = 'IGNORE';
 970   local $SIG{QUIT} = 'IGNORE';
 971   local $SIG{TERM} = 'IGNORE';
 972   local $SIG{TSTP} = 'IGNORE';
 973   local $SIG{PIPE} = 'IGNORE';
 974
 975   my $oldAutoCommit = $FS::UID::AutoCommit;
 976   local $FS::UID::AutoCommit = 0;
 977   my $dbh = dbh;
 978
 979   unless ( ref($prepay_credit) ) {
 980
 981     my $identifier = $prepay_credit;
 982
 983     $prepay_credit = qsearchs(
 984       'prepay_credit',
 985       { 'identifier' => $prepay_credit },
 986       '',
 987       'FOR UPDATE'
 988     );
 989
 990     unless ( $prepay_credit ) {
 991       $dbh->rollback if $oldAutoCommit;
 992       return "Invalid prepaid card: ". $identifier;
 993     }
 994
 995   }
 996
 997   if ( $prepay_credit->agentnum ) {
 998     if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
 999       $dbh->rollback if $oldAutoCommit;
1000       return "prepaid card not valid for agent ". $self->agentnum;
1001     }
1002     $self->agentnum($prepay_credit->agentnum);
1003   }
1004
1005   my $error = $prepay_credit->delete;
1006   if ( $error ) {
1007     $dbh->rollback if $oldAutoCommit;
1008     return "removing prepay_credit (transaction rolled back): $error";
1009   }
1010
1011   ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
1012     for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
1013
1014   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1015   '';
1016
1017 }
1018
1019 =item increment_upbytes SECONDS
1020
1021 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1022 the specified number of upbytes.  If there is an error, returns the error,
1023 otherwise returns false.
1024
1025 =cut
1026
1027 sub increment_upbytes {
1028   _increment_column( shift, 'upbytes', @_);
1029 }
1030
1031 =item increment_downbytes SECONDS
1032
1033 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1034 the specified number of downbytes.  If there is an error, returns the error,
1035 otherwise returns false.
1036
1037 =cut
1038
1039 sub increment_downbytes {
1040   _increment_column( shift, 'downbytes', @_);
1041 }
1042
1043 =item increment_totalbytes SECONDS
1044
1045 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1046 the specified number of totalbytes.  If there is an error, returns the error,
1047 otherwise returns false.
1048
1049 =cut
1050
1051 sub increment_totalbytes {
1052   _increment_column( shift, 'totalbytes', @_);
1053 }
1054
1055 =item increment_seconds SECONDS
1056
1057 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1058 the specified number of seconds.  If there is an error, returns the error,
1059 otherwise returns false.
1060
1061 =cut
1062
1063 sub increment_seconds {
1064   _increment_column( shift, 'seconds', @_);
1065 }
1066
1067 =item _increment_column AMOUNT
1068
1069 Updates this customer's single or primary account (see L<FS::svc_acct>) by
1070 the specified number of seconds or bytes.  If there is an error, returns
1071 the error, otherwise returns false.
1072
1073 =cut
1074
1075 sub _increment_column {
1076   my( $self, $column, $amount ) = @_;
1077   warn "$me increment_column called: $column, $amount\n"
1078     if $DEBUG;
1079
1080   return '' unless $amount;
1081
1082   my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
1083                       $self->ncancelled_pkgs;
1084
1085   if ( ! @cust_pkg ) {
1086     return 'No packages with primary or single services found'.
1087            ' to apply pre-paid time';
1088   } elsif ( scalar(@cust_pkg) > 1 ) {
1089     #maybe have a way to specify the package/account?
1090     return 'Multiple packages found to apply pre-paid time';
1091   }
1092
1093   my $cust_pkg = $cust_pkg[0];
1094   warn "  found package pkgnum ". $cust_pkg->pkgnum. "\n"
1095     if $DEBUG > 1;
1096
1097   my @cust_svc =
1098     $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
1099
1100   if ( ! @cust_svc ) {
1101     return 'No account found to apply pre-paid time';
1102   } elsif ( scalar(@cust_svc) > 1 ) {
1103     return 'Multiple accounts found to apply pre-paid time';
1104   }
1105
1106   my $svc_acct = $cust_svc[0]->svc_x;
1107   warn "  found service svcnum ". $svc_acct->pkgnum.
1108        ' ('. $svc_acct->email. ")\n"
1109     if $DEBUG > 1;
1110
1111   $column = "increment_$column";
1112   $svc_acct->$column($amount);
1113
1114 }
1115
1116 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
1117
1118 Inserts a prepayment in the specified amount for this customer.  An optional
1119 second argument can specify the prepayment identifier for tracking purposes.
1120 If there is an error, returns the error, otherwise returns false.
1121
1122 =cut
1123
1124 sub insert_cust_pay_prepay {
1125   shift->insert_cust_pay('PREP', @_);
1126 }
1127
1128 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
1129
1130 Inserts a cash payment in the specified amount for this customer.  An optional
1131 second argument can specify the payment identifier for tracking purposes.
1132 If there is an error, returns the error, otherwise returns false.
1133
1134 =cut
1135
1136 sub insert_cust_pay_cash {
1137   shift->insert_cust_pay('CASH', @_);
1138 }
1139
1140 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
1141
1142 Inserts a Western Union payment in the specified amount for this customer.  An
1143 optional second argument can specify the prepayment identifier for tracking
1144 purposes.  If there is an error, returns the error, otherwise returns false.
1145
1146 =cut
1147
1148 sub insert_cust_pay_west {
1149   shift->insert_cust_pay('WEST', @_);
1150 }
1151
1152 sub insert_cust_pay {
1153   my( $self, $payby, $amount ) = splice(@_, 0, 3);
1154   my $payinfo = scalar(@_) ? shift : '';
1155
1156   my $cust_pay = new FS::cust_pay {
1157     'custnum' => $self->custnum,
1158     'paid'    => sprintf('%.2f', $amount),
1159     #'_date'   => #date the prepaid card was purchased???
1160     'payby'   => $payby,
1161     'payinfo' => $payinfo,
1162   };
1163   $cust_pay->insert;
1164
1165 }
1166
1167 =item reexport
1168
1169 This method is deprecated.  See the I<depend_jobnum> option to the insert and
1170 order_pkgs methods for a better way to defer provisioning.
1171
1172 Re-schedules all exports by calling the B<reexport> method of all associated
1173 packages (see L<FS::cust_pkg>).  If there is an error, returns the error;
1174 otherwise returns false.
1175
1176 =cut
1177
1178 sub reexport {
1179   my $self = shift;
1180
1181   carp "WARNING: FS::cust_main::reexport is deprectated; ".
1182        "use the depend_jobnum option to insert or order_pkgs to delay export";
1183
1184   local $SIG{HUP} = 'IGNORE';
1185   local $SIG{INT} = 'IGNORE';
1186   local $SIG{QUIT} = 'IGNORE';
1187   local $SIG{TERM} = 'IGNORE';
1188   local $SIG{TSTP} = 'IGNORE';
1189   local $SIG{PIPE} = 'IGNORE';
1190
1191   my $oldAutoCommit = $FS::UID::AutoCommit;
1192   local $FS::UID::AutoCommit = 0;
1193   my $dbh = dbh;
1194
1195   foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1196     my $error = $cust_pkg->reexport;
1197     if ( $error ) {
1198       $dbh->rollback if $oldAutoCommit;
1199       return $error;
1200     }
1201   }
1202
1203   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1204   '';
1205
1206 }
1207
1208 =item delete NEW_CUSTNUM
1209
1210 This deletes the customer.  If there is an error, returns the error, otherwise
1211 returns false.
1212
1213 This will completely remove all traces of the customer record.  This is not
1214 what you want when a customer cancels service; for that, cancel all of the
1215 customer's packages (see L</cancel>).
1216
1217 If the customer has any uncancelled packages, you need to pass a new (valid)
1218 customer number for those packages to be transferred to.  Cancelled packages
1219 will be deleted.  Did I mention that this is NOT what you want when a customer
1220 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
1221
1222 You can't delete a customer with invoices (see L<FS::cust_bill>),
1223 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
1224 refunds (see L<FS::cust_refund>).
1225
1226 =cut
1227
1228 sub delete {
1229   my $self = shift;
1230
1231   local $SIG{HUP} = 'IGNORE';
1232   local $SIG{INT} = 'IGNORE';
1233   local $SIG{QUIT} = 'IGNORE';
1234   local $SIG{TERM} = 'IGNORE';
1235   local $SIG{TSTP} = 'IGNORE';
1236   local $SIG{PIPE} = 'IGNORE';
1237
1238   my $oldAutoCommit = $FS::UID::AutoCommit;
1239   local $FS::UID::AutoCommit = 0;
1240   my $dbh = dbh;
1241
1242   if ( $self->cust_bill ) {
1243     $dbh->rollback if $oldAutoCommit;
1244     return "Can't delete a customer with invoices";
1245   }
1246   if ( $self->cust_credit ) {
1247     $dbh->rollback if $oldAutoCommit;
1248     return "Can't delete a customer with credits";
1249   }
1250   if ( $self->cust_pay ) {
1251     $dbh->rollback if $oldAutoCommit;
1252     return "Can't delete a customer with payments";
1253   }
1254   if ( $self->cust_refund ) {
1255     $dbh->rollback if $oldAutoCommit;
1256     return "Can't delete a customer with refunds";
1257   }
1258
1259   my @cust_pkg = $self->ncancelled_pkgs;
1260   if ( @cust_pkg ) {
1261     my $new_custnum = shift;
1262     unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1263       $dbh->rollback if $oldAutoCommit;
1264       return "Invalid new customer number: $new_custnum";
1265     }
1266     foreach my $cust_pkg ( @cust_pkg ) {
1267       my %hash = $cust_pkg->hash;
1268       $hash{'custnum'} = $new_custnum;
1269       my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1270       my $error = $new_cust_pkg->replace($cust_pkg,
1271                                          options => { $cust_pkg->options },
1272                                         );
1273       if ( $error ) {
1274         $dbh->rollback if $oldAutoCommit;
1275         return $error;
1276       }
1277     }
1278   }
1279   my @cancelled_cust_pkg = $self->all_pkgs;
1280   foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1281     my $error = $cust_pkg->delete;
1282     if ( $error ) {
1283       $dbh->rollback if $oldAutoCommit;
1284       return $error;
1285     }
1286   }
1287
1288   foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1289     qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1290   ) {
1291     my $error = $cust_main_invoice->delete;
1292     if ( $error ) {
1293       $dbh->rollback if $oldAutoCommit;
1294       return $error;
1295     }
1296   }
1297
1298   my $error = $self->SUPER::delete;
1299   if ( $error ) {
1300     $dbh->rollback if $oldAutoCommit;
1301     return $error;
1302   }
1303
1304   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1305   '';
1306
1307 }
1308
1309 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ]
1310
1311 Replaces the OLD_RECORD with this one in the database.  If there is an error,
1312 returns the error, otherwise returns false.
1313
1314 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1315 be set as the invoicing list (see L<"invoicing_list">).  Errors return as
1316 expected and rollback the entire transaction; it is not necessary to call
1317 check_invoicing_list first.  Here's an example:
1318
1319   $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1320
1321 =cut
1322
1323 sub replace {
1324   my $self = shift;
1325
1326   my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1327               ? shift
1328               : $self->replace_old;
1329
1330   my @param = @_;
1331
1332   warn "$me replace called\n"
1333     if $DEBUG;
1334
1335   my $curuser = $FS::CurrentUser::CurrentUser;
1336   if (    $self->payby eq 'COMP'
1337        && $self->payby ne $old->payby
1338        && ! $curuser->access_right('Complimentary customer')
1339      )
1340   {
1341     return "You are not permitted to create complimentary accounts.";
1342   }
1343
1344   local($ignore_expired_card) = 1
1345     if $old->payby  =~ /^(CARD|DCRD)$/
1346     && $self->payby =~ /^(CARD|DCRD)$/
1347     && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1348
1349   local $SIG{HUP} = 'IGNORE';
1350   local $SIG{INT} = 'IGNORE';
1351   local $SIG{QUIT} = 'IGNORE';
1352   local $SIG{TERM} = 'IGNORE';
1353   local $SIG{TSTP} = 'IGNORE';
1354   local $SIG{PIPE} = 'IGNORE';
1355
1356   my $oldAutoCommit = $FS::UID::AutoCommit;
1357   local $FS::UID::AutoCommit = 0;
1358   my $dbh = dbh;
1359
1360   my $error = $self->SUPER::replace($old);
1361
1362   if ( $error ) {
1363     $dbh->rollback if $oldAutoCommit;
1364     return $error;
1365   }
1366
1367   if ( @param ) { # INVOICING_LIST_ARYREF
1368     my $invoicing_list = shift @param;
1369     $error = $self->check_invoicing_list( $invoicing_list );
1370     if ( $error ) {
1371       $dbh->rollback if $oldAutoCommit;
1372       return $error;
1373     }
1374     $self->invoicing_list( $invoicing_list );
1375   }
1376
1377   if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1378        grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1379     # card/check/lec info has changed, want to retry realtime_ invoice events
1380     my $error = $self->retry_realtime;
1381     if ( $error ) {
1382       $dbh->rollback if $oldAutoCommit;
1383       return $error;
1384     }
1385   }
1386
1387   unless ( $import || $skip_fuzzyfiles ) {
1388     $error = $self->queue_fuzzyfiles_update;
1389     if ( $error ) {
1390       $dbh->rollback if $oldAutoCommit;
1391       return "updating fuzzy search cache: $error";
1392     }
1393   }
1394
1395   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1396   '';
1397
1398 }
1399
1400 =item queue_fuzzyfiles_update
1401
1402 Used by insert & replace to update the fuzzy search cache
1403
1404 =cut
1405
1406 sub queue_fuzzyfiles_update {
1407   my $self = shift;
1408
1409   local $SIG{HUP} = 'IGNORE';
1410   local $SIG{INT} = 'IGNORE';
1411   local $SIG{QUIT} = 'IGNORE';
1412   local $SIG{TERM} = 'IGNORE';
1413   local $SIG{TSTP} = 'IGNORE';
1414   local $SIG{PIPE} = 'IGNORE';
1415
1416   my $oldAutoCommit = $FS::UID::AutoCommit;
1417   local $FS::UID::AutoCommit = 0;
1418   my $dbh = dbh;
1419
1420   my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1421   my $error = $queue->insert( map $self->getfield($_),
1422                                   qw(first last company)
1423                             );
1424   if ( $error ) {
1425     $dbh->rollback if $oldAutoCommit;
1426     return "queueing job (transaction rolled back): $error";
1427   }
1428
1429   if ( $self->ship_last ) {
1430     $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1431     $error = $queue->insert( map $self->getfield("ship_$_"),
1432                                  qw(first last company)
1433                            );
1434     if ( $error ) {
1435       $dbh->rollback if $oldAutoCommit;
1436       return "queueing job (transaction rolled back): $error";
1437     }
1438   }
1439
1440   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1441   '';
1442
1443 }
1444
1445 =item check
1446
1447 Checks all fields to make sure this is a valid customer record.  If there is
1448 an error, returns the error, otherwise returns false.  Called by the insert
1449 and replace methods.
1450
1451 =cut
1452
1453 sub check {
1454   my $self = shift;
1455
1456   warn "$me check BEFORE: \n". $self->_dump
1457     if $DEBUG > 2;
1458
1459   my $error =
1460     $self->ut_numbern('custnum')
1461     || $self->ut_number('agentnum')
1462     || $self->ut_textn('agent_custid')
1463     || $self->ut_number('refnum')
1464     || $self->ut_textn('custbatch')
1465     || $self->ut_name('last')
1466     || $self->ut_name('first')
1467     || $self->ut_snumbern('birthdate')
1468     || $self->ut_snumbern('signupdate')
1469     || $self->ut_textn('company')
1470     || $self->ut_text('address1')
1471     || $self->ut_textn('address2')
1472     || $self->ut_text('city')
1473     || $self->ut_textn('county')
1474     || $self->ut_textn('state')
1475     || $self->ut_country('country')
1476     || $self->ut_anything('comments')
1477     || $self->ut_numbern('referral_custnum')
1478     || $self->ut_textn('stateid')
1479     || $self->ut_textn('stateid_state')
1480     || $self->ut_textn('invoice_terms')
1481     || $self->ut_alphan('geocode')
1482   ;
1483
1484   #barf.  need message catalogs.  i18n.  etc.
1485   $error .= "Please select an advertising source."
1486     if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1487   return $error if $error;
1488
1489   return "Unknown agent"
1490     unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1491
1492   return "Unknown refnum"
1493     unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1494
1495   return "Unknown referring custnum: ". $self->referral_custnum
1496     unless ! $self->referral_custnum
1497            || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1498
1499   if ( $self->ss eq '' ) {
1500     $self->ss('');
1501   } else {
1502     my $ss = $self->ss;
1503     $ss =~ s/\D//g;
1504     $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1505       or return "Illegal social security number: ". $self->ss;
1506     $self->ss("$1-$2-$3");
1507   }
1508
1509
1510 # bad idea to disable, causes billing to fail because of no tax rates later
1511 #  unless ( $import ) {
1512     unless ( qsearch('cust_main_county', {
1513       'country' => $self->country,
1514       'state'   => '',
1515      } ) ) {
1516       return "Unknown state/county/country: ".
1517         $self->state. "/". $self->county. "/". $self->country
1518         unless qsearch('cust_main_county',{
1519           'state'   => $self->state,
1520           'county'  => $self->county,
1521           'country' => $self->country,
1522         } );
1523     }
1524 #  }
1525
1526   $error =
1527     $self->ut_phonen('daytime', $self->country)
1528     || $self->ut_phonen('night', $self->country)
1529     || $self->ut_phonen('fax', $self->country)
1530     || $self->ut_zip('zip', $self->country)
1531   ;
1532   return $error if $error;
1533
1534   if ( $conf->exists('cust_main-require_phone')
1535        && ! length($self->daytime) && ! length($self->night)
1536      ) {
1537
1538     my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1539                           ? 'Day Phone'
1540                           : FS::Msgcat::_gettext('daytime');
1541     my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1542                         ? 'Night Phone'
1543                         : FS::Msgcat::_gettext('night');
1544
1545     return "$daytime_label or $night_label is required"
1546
1547   }
1548
1549   if ( $self->has_ship_address
1550        && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1551                         $self->addr_fields )
1552      )
1553   {
1554     my $error =
1555       $self->ut_name('ship_last')
1556       || $self->ut_name('ship_first')
1557       || $self->ut_textn('ship_company')
1558       || $self->ut_text('ship_address1')
1559       || $self->ut_textn('ship_address2')
1560       || $self->ut_text('ship_city')
1561       || $self->ut_textn('ship_county')
1562       || $self->ut_textn('ship_state')
1563       || $self->ut_country('ship_country')
1564     ;
1565     return $error if $error;
1566
1567     #false laziness with above
1568     unless ( qsearchs('cust_main_county', {
1569       'country' => $self->ship_country,
1570       'state'   => '',
1571      } ) ) {
1572       return "Unknown ship_state/ship_county/ship_country: ".
1573         $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1574         unless qsearch('cust_main_county',{
1575           'state'   => $self->ship_state,
1576           'county'  => $self->ship_county,
1577           'country' => $self->ship_country,
1578         } );
1579     }
1580     #eofalse
1581
1582     $error =
1583       $self->ut_phonen('ship_daytime', $self->ship_country)
1584       || $self->ut_phonen('ship_night', $self->ship_country)
1585       || $self->ut_phonen('ship_fax', $self->ship_country)
1586       || $self->ut_zip('ship_zip', $self->ship_country)
1587     ;
1588     return $error if $error;
1589
1590     return "Unit # is required."
1591       if $self->ship_address2 =~ /^\s*$/
1592       && $conf->exists('cust_main-require_address2');
1593
1594   } else { # ship_ info eq billing info, so don't store dup info in database
1595
1596     $self->setfield("ship_$_", '')
1597       foreach $self->addr_fields;
1598
1599     return "Unit # is required."
1600       if $self->address2 =~ /^\s*$/
1601       && $conf->exists('cust_main-require_address2');
1602
1603   }
1604
1605   #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1606   #  or return "Illegal payby: ". $self->payby;
1607   #$self->payby($1);
1608   FS::payby->can_payby($self->table, $self->payby)
1609     or return "Illegal payby: ". $self->payby;
1610
1611   $error =    $self->ut_numbern('paystart_month')
1612            || $self->ut_numbern('paystart_year')
1613            || $self->ut_numbern('payissue')
1614            || $self->ut_textn('paytype')
1615   ;
1616   return $error if $error;
1617
1618   if ( $self->payip eq '' ) {
1619     $self->payip('');
1620   } else {
1621     $error = $self->ut_ip('payip');
1622     return $error if $error;
1623   }
1624
1625   # If it is encrypted and the private key is not availaible then we can't
1626   # check the credit card.
1627
1628   my $check_payinfo = 1;
1629
1630   if ($self->is_encrypted($self->payinfo)) {
1631     $check_payinfo = 0;
1632   }
1633
1634   if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1635
1636     my $payinfo = $self->payinfo;
1637     $payinfo =~ s/\D//g;
1638     $payinfo =~ /^(\d{13,16})$/
1639       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1640     $payinfo = $1;
1641     $self->payinfo($payinfo);
1642     validate($payinfo)
1643       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1644
1645     return gettext('unknown_card_type')
1646       if cardtype($self->payinfo) eq "Unknown";
1647
1648     my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1649     if ( $ban ) {
1650       return 'Banned credit card: banned on '.
1651              time2str('%a %h %o at %r', $ban->_date).
1652              ' by '. $ban->otaker.
1653              ' (ban# '. $ban->bannum. ')';
1654     }
1655
1656     if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1657       if ( cardtype($self->payinfo) eq 'American Express card' ) {
1658         $self->paycvv =~ /^(\d{4})$/
1659           or return "CVV2 (CID) for American Express cards is four digits.";
1660         $self->paycvv($1);
1661       } else {
1662         $self->paycvv =~ /^(\d{3})$/
1663           or return "CVV2 (CVC2/CID) is three digits.";
1664         $self->paycvv($1);
1665       }
1666     } else {
1667       $self->paycvv('');
1668     }
1669
1670     my $cardtype = cardtype($payinfo);
1671     if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1672
1673       return "Start date or issue number is required for $cardtype cards"
1674         unless $self->paystart_month && $self->paystart_year or $self->payissue;
1675
1676       return "Start month must be between 1 and 12"
1677         if $self->paystart_month
1678            and $self->paystart_month < 1 || $self->paystart_month > 12;
1679
1680       return "Start year must be 1990 or later"
1681         if $self->paystart_year
1682            and $self->paystart_year < 1990;
1683
1684       return "Issue number must be beween 1 and 99"
1685         if $self->payissue
1686           and $self->payissue < 1 || $self->payissue > 99;
1687
1688     } else {
1689       $self->paystart_month('');
1690       $self->paystart_year('');
1691       $self->payissue('');
1692     }
1693
1694   } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1695
1696     my $payinfo = $self->payinfo;
1697     $payinfo =~ s/[^\d\@]//g;
1698     if ( $conf->exists('echeck-nonus') ) {
1699       $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1700       $payinfo = "$1\@$2";
1701     } else {
1702       $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1703       $payinfo = "$1\@$2";
1704     }
1705     $self->payinfo($payinfo);
1706     $self->paycvv('');
1707
1708     my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1709     if ( $ban ) {
1710       return 'Banned ACH account: banned on '.
1711              time2str('%a %h %o at %r', $ban->_date).
1712              ' by '. $ban->otaker.
1713              ' (ban# '. $ban->bannum. ')';
1714     }
1715
1716   } elsif ( $self->payby eq 'LECB' ) {
1717
1718     my $payinfo = $self->payinfo;
1719     $payinfo =~ s/\D//g;
1720     $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1721     $payinfo = $1;
1722     $self->payinfo($payinfo);
1723     $self->paycvv('');
1724
1725   } elsif ( $self->payby eq 'BILL' ) {
1726
1727     $error = $self->ut_textn('payinfo');
1728     return "Illegal P.O. number: ". $self->payinfo if $error;
1729     $self->paycvv('');
1730
1731   } elsif ( $self->payby eq 'COMP' ) {
1732
1733     my $curuser = $FS::CurrentUser::CurrentUser;
1734     if (    ! $self->custnum
1735          && ! $curuser->access_right('Complimentary customer')
1736        )
1737     {
1738       return "You are not permitted to create complimentary accounts."
1739     }
1740
1741     $error = $self->ut_textn('payinfo');
1742     return "Illegal comp account issuer: ". $self->payinfo if $error;
1743     $self->paycvv('');
1744
1745   } elsif ( $self->payby eq 'PREPAY' ) {
1746
1747     my $payinfo = $self->payinfo;
1748     $payinfo =~ s/\W//g; #anything else would just confuse things
1749     $self->payinfo($payinfo);
1750     $error = $self->ut_alpha('payinfo');
1751     return "Illegal prepayment identifier: ". $self->payinfo if $error;
1752     return "Unknown prepayment identifier"
1753       unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1754     $self->paycvv('');
1755
1756   }
1757
1758   if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1759     return "Expiration date required"
1760       unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1761     $self->paydate('');
1762   } else {
1763     my( $m, $y );
1764     if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1765       ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1766     } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1767       ( $m, $y ) = ( $3, "20$2" );
1768     } else {
1769       return "Illegal expiration date: ". $self->paydate;
1770     }
1771     $self->paydate("$y-$m-01");
1772     my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1773     return gettext('expired_card')
1774       if !$import
1775       && !$ignore_expired_card
1776       && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1777   }
1778
1779   if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1780        ( ! $conf->exists('require_cardname')
1781          || $self->payby !~ /^(CARD|DCRD)$/  )
1782   ) {
1783     $self->payname( $self->first. " ". $self->getfield('last') );
1784   } else {
1785     $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1786       or return gettext('illegal_name'). " payname: ". $self->payname;
1787     $self->payname($1);
1788   }
1789
1790   foreach my $flag (qw( tax spool_cdr squelch_cdr archived )) {
1791     $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1792     $self->$flag($1);
1793   }
1794
1795   $self->otaker(getotaker) unless $self->otaker;
1796
1797   warn "$me check AFTER: \n". $self->_dump
1798     if $DEBUG > 2;
1799
1800   $self->SUPER::check;
1801 }
1802
1803 =item addr_fields
1804
1805 Returns a list of fields which have ship_ duplicates.
1806
1807 =cut
1808
1809 sub addr_fields {
1810   qw( last first company
1811       address1 address2 city county state zip country
1812       daytime night fax
1813     );
1814 }
1815
1816 =item has_ship_address
1817
1818 Returns true if this customer record has a separate shipping address.
1819
1820 =cut
1821
1822 sub has_ship_address {
1823   my $self = shift;
1824   scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1825 }
1826
1827 =item all_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1828
1829 Returns all packages (see L<FS::cust_pkg>) for this customer.
1830
1831 =cut
1832
1833 sub all_pkgs {
1834   my $self = shift;
1835   my $extra_qsearch = ref($_[0]) ? shift : {};
1836
1837   return $self->num_pkgs unless wantarray || keys(%$extra_qsearch);
1838
1839   my @cust_pkg = ();
1840   if ( $self->{'_pkgnum'} ) {
1841     @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1842   } else {
1843     @cust_pkg = $self->_cust_pkg($extra_qsearch);
1844   }
1845
1846   sort sort_packages @cust_pkg;
1847 }
1848
1849 =item cust_pkg
1850
1851 Synonym for B<all_pkgs>.
1852
1853 =cut
1854
1855 sub cust_pkg {
1856   shift->all_pkgs(@_);
1857 }
1858
1859 =item cust_location
1860
1861 Returns all locations (see L<FS::cust_location>) for this customer.
1862
1863 =cut
1864
1865 sub cust_location {
1866   my $self = shift;
1867   qsearch('cust_location', { 'custnum' => $self->custnum } );
1868 }
1869
1870 =item ncancelled_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1871
1872 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1873
1874 =cut
1875
1876 sub ncancelled_pkgs {
1877   my $self = shift;
1878   my $extra_qsearch = ref($_[0]) ? shift : {};
1879
1880   return $self->num_ncancelled_pkgs unless wantarray;
1881
1882   my @cust_pkg = ();
1883   if ( $self->{'_pkgnum'} ) {
1884
1885     warn "$me ncancelled_pkgs: returning cached objects"
1886       if $DEBUG > 1;
1887
1888     @cust_pkg = grep { ! $_->getfield('cancel') }
1889                 values %{ $self->{'_pkgnum'}->cache };
1890
1891   } else {
1892
1893     warn "$me ncancelled_pkgs: searching for packages with custnum ".
1894          $self->custnum. "\n"
1895       if $DEBUG > 1;
1896
1897     $extra_qsearch->{'extra_sql'} .= ' AND ( cancel IS NULL OR cancel = 0 ) ';
1898
1899     @cust_pkg = $self->_cust_pkg($extra_qsearch);
1900
1901   }
1902
1903   sort sort_packages @cust_pkg;
1904
1905 }
1906
1907 sub _cust_pkg {
1908   my $self = shift;
1909   my $extra_qsearch = ref($_[0]) ? shift : {};
1910
1911   $extra_qsearch->{'select'} ||= '*';
1912   $extra_qsearch->{'select'} .=
1913    ',( SELECT COUNT(*) FROM cust_svc WHERE cust_pkg.pkgnum = cust_svc.pkgnum )
1914      AS _num_cust_svc';
1915
1916   map {
1917         $_->{'_num_cust_svc'} = $_->get('_num_cust_svc');
1918         $_;
1919       }
1920   qsearch({
1921     %$extra_qsearch,
1922     'table'   => 'cust_pkg',
1923     'hashref' => { 'custnum' => $self->custnum },
1924   });
1925
1926 }
1927
1928 # This should be generalized to use config options to determine order.
1929 sub sort_packages {
1930
1931   if ( $a->get('cancel') xor $b->get('cancel') ) {
1932     return -1 if $b->get('cancel');
1933     return  1 if $a->get('cancel');
1934     #shouldn't get here...
1935     return 0;
1936   } else {
1937     my $a_num_cust_svc = $a->num_cust_svc;
1938     my $b_num_cust_svc = $b->num_cust_svc;
1939     return 0  if !$a_num_cust_svc && !$b_num_cust_svc;
1940     return -1 if  $a_num_cust_svc && !$b_num_cust_svc;
1941     return 1  if !$a_num_cust_svc &&  $b_num_cust_svc;
1942     my @a_cust_svc = $a->cust_svc;
1943     my @b_cust_svc = $b->cust_svc;
1944     $a_cust_svc[0]->svc_x->label cmp $b_cust_svc[0]->svc_x->label;
1945   }
1946
1947 }
1948
1949 =item suspended_pkgs
1950
1951 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1952
1953 =cut
1954
1955 sub suspended_pkgs {
1956   my $self = shift;
1957   grep { $_->susp } $self->ncancelled_pkgs;
1958 }
1959
1960 =item unflagged_suspended_pkgs
1961
1962 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1963 customer (thouse packages without the `manual_flag' set).
1964
1965 =cut
1966
1967 sub unflagged_suspended_pkgs {
1968   my $self = shift;
1969   return $self->suspended_pkgs
1970     unless dbdef->table('cust_pkg')->column('manual_flag');
1971   grep { ! $_->manual_flag } $self->suspended_pkgs;
1972 }
1973
1974 =item unsuspended_pkgs
1975
1976 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1977 this customer.
1978
1979 =cut
1980
1981 sub unsuspended_pkgs {
1982   my $self = shift;
1983   grep { ! $_->susp } $self->ncancelled_pkgs;
1984 }
1985
1986 =item num_cancelled_pkgs
1987
1988 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1989 customer.
1990
1991 =cut
1992
1993 sub num_cancelled_pkgs {
1994   shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1995 }
1996
1997 sub num_ncancelled_pkgs {
1998   shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1999 }
2000
2001 sub num_pkgs {
2002   my( $self ) = shift;
2003   my $sql = scalar(@_) ? shift : '';
2004   $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
2005   my $sth = dbh->prepare(
2006     "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
2007   ) or die dbh->errstr;
2008   $sth->execute($self->custnum) or die $sth->errstr;
2009   $sth->fetchrow_arrayref->[0];
2010 }
2011
2012 =item unsuspend
2013
2014 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2015 and L<FS::cust_pkg>) for this customer.  Always returns a list: an empty list
2016 on success or a list of errors.
2017
2018 =cut
2019
2020 sub unsuspend {
2021   my $self = shift;
2022   grep { $_->unsuspend } $self->suspended_pkgs;
2023 }
2024
2025 =item suspend
2026
2027 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2028
2029 Returns a list: an empty list on success or a list of errors.
2030
2031 =cut
2032
2033 sub suspend {
2034   my $self = shift;
2035   grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2036 }
2037
2038 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2039
2040 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2041 PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref instead
2042 of a list of pkgparts; the hashref has the following keys:
2043
2044 =over 4
2045
2046 =item pkgparts - listref of pkgparts
2047
2048 =item (other options are passed to the suspend method)
2049
2050 =back
2051
2052
2053 Returns a list: an empty list on success or a list of errors.
2054
2055 =cut
2056
2057 sub suspend_if_pkgpart {
2058   my $self = shift;
2059   my (@pkgparts, %opt);
2060   if (ref($_[0]) eq 'HASH'){
2061     @pkgparts = @{$_[0]{pkgparts}};
2062     %opt      = %{$_[0]};
2063   }else{
2064     @pkgparts = @_;
2065   }
2066   grep { $_->suspend(%opt) }
2067     grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2068       $self->unsuspended_pkgs;
2069 }
2070
2071 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2072
2073 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2074 given PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref
2075 instead of a list of pkgparts; the hashref has the following keys:
2076
2077 =over 4
2078
2079 =item pkgparts - listref of pkgparts
2080
2081 =item (other options are passed to the suspend method)
2082
2083 =back
2084
2085 Returns a list: an empty list on success or a list of errors.
2086
2087 =cut
2088
2089 sub suspend_unless_pkgpart {
2090   my $self = shift;
2091   my (@pkgparts, %opt);
2092   if (ref($_[0]) eq 'HASH'){
2093     @pkgparts = @{$_[0]{pkgparts}};
2094     %opt      = %{$_[0]};
2095   }else{
2096     @pkgparts = @_;
2097   }
2098   grep { $_->suspend(%opt) }
2099     grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2100       $self->unsuspended_pkgs;
2101 }
2102
2103 =item cancel [ OPTION => VALUE ... ]
2104
2105 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2106
2107 Available options are:
2108
2109 =over 4
2110
2111 =item quiet - can be set true to supress email cancellation notices.
2112
2113 =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.
2114
2115 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2116
2117 =back
2118
2119 Always returns a list: an empty list on success or a list of errors.
2120
2121 =cut
2122
2123 sub cancel {
2124   my( $self, %opt ) = @_;
2125
2126   warn "$me cancel called on customer ". $self->custnum. " with options ".
2127        join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2128     if $DEBUG;
2129
2130   return ( 'access denied' )
2131     unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2132
2133   if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2134
2135     #should try decryption (we might have the private key)
2136     # and if not maybe queue a job for the server that does?
2137     return ( "Can't (yet) ban encrypted credit cards" )
2138       if $self->is_encrypted($self->payinfo);
2139
2140     my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2141     my $error = $ban->insert;
2142     return ( $error ) if $error;
2143
2144   }
2145
2146   my @pkgs = $self->ncancelled_pkgs;
2147
2148   warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2149        scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2150     if $DEBUG;
2151
2152   grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2153 }
2154
2155 sub _banned_pay_hashref {
2156   my $self = shift;
2157
2158   my %payby2ban = (
2159     'CARD' => 'CARD',
2160     'DCRD' => 'CARD',
2161     'CHEK' => 'CHEK',
2162     'DCHK' => 'CHEK'
2163   );
2164
2165   {
2166     'payby'   => $payby2ban{$self->payby},
2167     'payinfo' => md5_base64($self->payinfo),
2168     #don't ever *search* on reason! #'reason'  =>
2169   };
2170 }
2171
2172 =item notes
2173
2174 Returns all notes (see L<FS::cust_main_note>) for this customer.
2175
2176 =cut
2177
2178 sub notes {
2179   my $self = shift;
2180   #order by?
2181   qsearch( 'cust_main_note',
2182            { 'custnum' => $self->custnum },
2183            '',
2184            'ORDER BY _DATE DESC'
2185          );
2186 }
2187
2188 =item agent
2189
2190 Returns the agent (see L<FS::agent>) for this customer.
2191
2192 =cut
2193
2194 sub agent {
2195   my $self = shift;
2196   qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2197 }
2198
2199 =item bill_and_collect
2200
2201 Cancels and suspends any packages due, generates bills, applies payments and
2202 cred
2203
2204 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
2205
2206 Options are passed as name-value pairs.  Currently available options are:
2207
2208 =over 4
2209
2210 =item time
2211
2212 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:
2213
2214  use Date::Parse;
2215  ...
2216  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2217
2218 =item invoice_time
2219
2220 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.
2221
2222 =item check_freq
2223
2224 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2225
2226 =item resetup
2227
2228 If set true, re-charges setup fees.
2229
2230 =item debug
2231
2232 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)
2233
2234 =back
2235
2236 =cut
2237
2238 sub bill_and_collect {
2239   my( $self, %options ) = @_;
2240
2241   #$options{actual_time} not $options{time} because freeside-daily -d is for
2242   #pre-printing invoices
2243   $self->cancel_expired_pkgs( $options{actual_time} );
2244   $self->suspend_adjourned_pkgs( $options{actual_time} );
2245
2246   my $error = $self->bill( %options );
2247   warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
2248
2249   $self->apply_payments_and_credits;
2250
2251   unless ( $conf->exists('cancelled_cust-noevents')
2252            && ! $self->num_ncancelled_pkgs
2253   ) {
2254
2255     $error = $self->collect( %options );
2256     warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
2257
2258   }
2259
2260 }
2261
2262 sub cancel_expired_pkgs {
2263   my ( $self, $time ) = @_;
2264
2265   my @cancel_pkgs = grep { $_->expire && $_->expire <= $time }
2266                          $self->ncancelled_pkgs;
2267
2268   foreach my $cust_pkg ( @cancel_pkgs ) {
2269     my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2270     my $error = $cust_pkg->cancel($cpr ? ( 'reason'        => $cpr->reasonnum,
2271                                            'reason_otaker' => $cpr->otaker
2272                                          )
2273                                        : ()
2274                                  );
2275     warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
2276          " for custnum ". $self->custnum. ": $error"
2277       if $error;
2278   }
2279
2280 }
2281
2282 sub suspend_adjourned_pkgs {
2283   my ( $self, $time ) = @_;
2284
2285   my @susp_pkgs =
2286     grep { ! $_->susp
2287            && (    (    $_->part_pkg->is_prepaid
2288                      && $_->bill
2289                      && $_->bill < $time
2290                    )
2291                 || (    $_->adjourn
2292                     && $_->adjourn <= $time
2293                   )
2294               )
2295          }
2296          $self->ncancelled_pkgs;
2297
2298   foreach my $cust_pkg ( @susp_pkgs ) {
2299     my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2300       if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2301     my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2302                                             'reason_otaker' => $cpr->otaker
2303                                           )
2304                                         : ()
2305                                   );
2306
2307     warn "Error suspending package ". $cust_pkg->pkgnum.
2308          " for custnum ". $self->custnum. ": $error"
2309       if $error;
2310   }
2311
2312 }
2313
2314 =item bill OPTIONS
2315
2316 Generates invoices (see L<FS::cust_bill>) for this customer.  Usually used in
2317 conjunction with the collect method by calling B<bill_and_collect>.
2318
2319 If there is an error, returns the error, otherwise returns false.
2320
2321 Options are passed as name-value pairs.  Currently available options are:
2322
2323 =over 4
2324
2325 =item resetup
2326
2327 If set true, re-charges setup fees.
2328
2329 =item time
2330
2331 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:
2332
2333  use Date::Parse;
2334  ...
2335  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2336
2337 =item pkg_list
2338
2339 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2340
2341  $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2342
2343 =item invoice_time
2344
2345 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.
2346
2347 =back
2348
2349 =cut
2350
2351 sub bill {
2352   my( $self, %options ) = @_;
2353   return '' if $self->payby eq 'COMP';
2354   warn "$me bill customer ". $self->custnum. "\n"
2355     if $DEBUG;
2356
2357   my $time = $options{'time'} || time;
2358   my $invoice_time = $options{'invoice_time'} || $time;
2359
2360   #put below somehow?
2361   local $SIG{HUP} = 'IGNORE';
2362   local $SIG{INT} = 'IGNORE';
2363   local $SIG{QUIT} = 'IGNORE';
2364   local $SIG{TERM} = 'IGNORE';
2365   local $SIG{TSTP} = 'IGNORE';
2366   local $SIG{PIPE} = 'IGNORE';
2367
2368   my $oldAutoCommit = $FS::UID::AutoCommit;
2369   local $FS::UID::AutoCommit = 0;
2370   my $dbh = dbh;
2371
2372   $self->select_for_update; #mutex
2373
2374   my @cust_bill_pkg = ();
2375
2376   ###
2377   # find the packages which are due for billing, find out how much they are
2378   # & generate invoice database.
2379   ###
2380
2381   my( $total_setup, $total_recur, $postal_charge ) = ( 0, 0, 0 );
2382   my %taxlisthash;
2383   my @precommit_hooks = ();
2384
2385   my @cust_pkgs = qsearch('cust_pkg', { 'custnum' => $self->custnum } );
2386   foreach my $cust_pkg (@cust_pkgs) {
2387
2388     #NO!! next if $cust_pkg->cancel;
2389     next if $cust_pkg->getfield('cancel');
2390
2391     warn "  bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2392
2393     #? to avoid use of uninitialized value errors... ?
2394     $cust_pkg->setfield('bill', '')
2395       unless defined($cust_pkg->bill);
2396
2397     #my $part_pkg = $cust_pkg->part_pkg;
2398
2399     my $real_pkgpart = $cust_pkg->pkgpart;
2400     my %hash = $cust_pkg->hash;
2401
2402     foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2403
2404       $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2405
2406       my $error =
2407         $self->_make_lines( 'part_pkg'            => $part_pkg,
2408                             'cust_pkg'            => $cust_pkg,
2409                             'precommit_hooks'     => \@precommit_hooks,
2410                             'line_items'          => \@cust_bill_pkg,
2411                             'setup'               => \$total_setup,
2412                             'recur'               => \$total_recur,
2413                             'tax_matrix'          => \%taxlisthash,
2414                             'time'                => $time,
2415                             'options'             => \%options,
2416                           );
2417       if ($error) {
2418         $dbh->rollback if $oldAutoCommit;
2419         return $error;
2420       }
2421
2422     } #foreach my $part_pkg
2423
2424   } #foreach my $cust_pkg
2425
2426   unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2427     #but do commit any package date cycling that happened
2428     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2429     return '';
2430   }
2431
2432   if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
2433          !$conf->exists('postal_invoice-recurring_only')
2434      )
2435   {
2436
2437     my $postal_pkg = $self->charge_postal_fee();
2438     if ( $postal_pkg && !ref( $postal_pkg ) ) {
2439
2440       $dbh->rollback if $oldAutoCommit;
2441       return "can't charge postal invoice fee for customer ".
2442         $self->custnum. ": $postal_pkg";
2443
2444     } elsif ( $postal_pkg ) {
2445
2446       foreach my $part_pkg ( $postal_pkg->part_pkg->self_and_bill_linked ) {
2447         my $error =
2448           $self->_make_lines( 'part_pkg'            => $part_pkg,
2449                               'cust_pkg'            => $postal_pkg,
2450                               'precommit_hooks'     => \@precommit_hooks,
2451                               'line_items'          => \@cust_bill_pkg,
2452                               'setup'               => \$total_setup,
2453                               'recur'               => \$total_recur,
2454                               'tax_matrix'          => \%taxlisthash,
2455                               'time'                => $time,
2456                               'options'             => \%options,
2457                             );
2458         if ($error) {
2459           $dbh->rollback if $oldAutoCommit;
2460           return $error;
2461         }
2462       }
2463
2464     }
2465
2466   }
2467
2468   warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2469
2470   # keys are tax names (as printed on invoices / itemdesc )
2471   # values are listrefs of taxlisthash keys (internal identifiers)
2472   my %taxname = ();
2473
2474   # keys are taxlisthash keys (internal identifiers)
2475   # values are (cumulative) amounts
2476   my %tax = ();
2477
2478   # keys are taxlisthash keys (internal identifiers)
2479   # values are listrefs of cust_bill_pkg_tax_location hashrefs
2480   my %tax_location = ();
2481
2482   # keys are taxlisthash keys (internal identifiers)
2483   # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
2484   my %tax_rate_location = ();
2485
2486   foreach my $tax ( keys %taxlisthash ) {
2487     my $tax_object = shift @{ $taxlisthash{$tax} };
2488     warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2489     warn " ". join('/', @{ $taxlisthash{$tax} } ). "\n" if $DEBUG > 2;
2490     my $hashref_or_error =
2491       $tax_object->taxline( $taxlisthash{$tax},
2492                             'custnum'      => $self->custnum,
2493                             'invoice_time' => $invoice_time
2494                           );
2495     unless ( ref($hashref_or_error) ) {
2496       $dbh->rollback if $oldAutoCommit;
2497       return $hashref_or_error;
2498     }
2499     unshift @{ $taxlisthash{$tax} }, $tax_object;
2500
2501     my $name   = $hashref_or_error->{'name'};
2502     my $amount = $hashref_or_error->{'amount'};
2503
2504     #warn "adding $amount as $name\n";
2505     $taxname{ $name } ||= [];
2506     push @{ $taxname{ $name } }, $tax;
2507
2508     $tax{ $tax } += $amount;
2509
2510     $tax_location{ $tax } ||= [];
2511     if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
2512       push @{ $tax_location{ $tax }  },
2513         {
2514           'taxnum'      => $tax_object->taxnum,
2515           'taxtype'     => ref($tax_object),
2516           'pkgnum'      => $tax_object->get('pkgnum'),
2517           'locationnum' => $tax_object->get('locationnum'),
2518           'amount'      => sprintf('%.2f', $amount ),
2519         };
2520     }
2521
2522     $tax_rate_location{ $tax } ||= [];
2523     if ( ref($tax_object) eq 'FS::tax_rate' ) {
2524       my $taxratelocationnum =
2525         $tax_object->tax_rate_location->taxratelocationnum;
2526       push @{ $tax_rate_location{ $tax }  },
2527         {
2528           'taxnum'             => $tax_object->taxnum,
2529           'taxtype'            => ref($tax_object),
2530           'amount'             => sprintf('%.2f', $amount ),
2531           'locationtaxid'      => $tax_object->location,
2532           'taxratelocationnum' => $taxratelocationnum,
2533         };
2534     }
2535
2536   }
2537
2538   #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
2539   my %packagemap = map { $_->pkgnum => $_ } @cust_bill_pkg;
2540   foreach my $tax ( keys %taxlisthash ) {
2541     foreach ( @{ $taxlisthash{$tax} }[1 ... scalar(@{ $taxlisthash{$tax} })] ) {
2542       next unless ref($_) eq 'FS::cust_bill_pkg';
2543
2544       push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
2545         splice( @{ $_->_cust_tax_exempt_pkg } );
2546     }
2547   }
2548
2549   #consolidate and create tax line items
2550   warn "consolidating and generating...\n" if $DEBUG > 2;
2551   foreach my $taxname ( keys %taxname ) {
2552     my $tax = 0;
2553     my %seen = ();
2554     my @cust_bill_pkg_tax_location = ();
2555     my @cust_bill_pkg_tax_rate_location = ();
2556     warn "adding $taxname\n" if $DEBUG > 1;
2557     foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2558       next if $seen{$taxitem}++;
2559       warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2560       $tax += $tax{$taxitem};
2561       push @cust_bill_pkg_tax_location,
2562         map { new FS::cust_bill_pkg_tax_location $_ }
2563             @{ $tax_location{ $taxitem } };
2564       push @cust_bill_pkg_tax_rate_location,
2565         map { new FS::cust_bill_pkg_tax_rate_location $_ }
2566             @{ $tax_rate_location{ $taxitem } };
2567     }
2568     next unless $tax;
2569
2570     $tax = sprintf('%.2f', $tax );
2571     $total_setup = sprintf('%.2f', $total_setup+$tax );
2572
2573     push @cust_bill_pkg, new FS::cust_bill_pkg {
2574       'pkgnum'   => 0,
2575       'setup'    => $tax,
2576       'recur'    => 0,
2577       'sdate'    => '',
2578       'edate'    => '',
2579       'itemdesc' => $taxname,
2580       'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2581       'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
2582     };
2583
2584   }
2585
2586   my $charged = sprintf('%.2f', $total_setup + $total_recur );
2587
2588   #create the new invoice
2589   my $cust_bill = new FS::cust_bill ( {
2590     'custnum' => $self->custnum,
2591     '_date'   => ( $invoice_time ),
2592     'charged' => $charged,
2593   } );
2594   my $error = $cust_bill->insert;
2595   if ( $error ) {
2596     $dbh->rollback if $oldAutoCommit;
2597     return "can't create invoice for customer #". $self->custnum. ": $error";
2598   }
2599
2600   foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2601     $cust_bill_pkg->invnum($cust_bill->invnum);
2602     my $error = $cust_bill_pkg->insert;
2603     if ( $error ) {
2604       $dbh->rollback if $oldAutoCommit;
2605       return "can't create invoice line item: $error";
2606     }
2607   }
2608
2609
2610   foreach my $hook ( @precommit_hooks ) {
2611     eval {
2612       &{$hook}; #($self) ?
2613     };
2614     if ( $@ ) {
2615       $dbh->rollback if $oldAutoCommit;
2616       return "$@ running precommit hook $hook\n";
2617     }
2618   }
2619
2620   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2621   ''; #no error
2622 }
2623
2624
2625 sub _make_lines {
2626   my ($self, %params) = @_;
2627
2628   my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
2629   my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
2630   my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
2631   my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
2632   my $total_setup = $params{setup} or die "no setup accumulator specified";
2633   my $total_recur = $params{recur} or die "no recur accumulator specified";
2634   my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
2635   my $time = $params{'time'} or die "no time specified";
2636   my (%options) = %{$params{options}};
2637
2638   my $dbh = dbh;
2639   my $real_pkgpart = $cust_pkg->pkgpart;
2640   my %hash = $cust_pkg->hash;
2641   my $old_cust_pkg = new FS::cust_pkg \%hash;
2642
2643   my @details = ();
2644
2645   my $lineitems = 0;
2646
2647   $cust_pkg->pkgpart($part_pkg->pkgpart);
2648
2649   ###
2650   # bill setup
2651   ###
2652
2653   my $setup = 0;
2654   my $unitsetup = 0;
2655   if ( ! $cust_pkg->setup &&
2656        (
2657          ( $conf->exists('disable_setup_suspended_pkgs') &&
2658           ! $cust_pkg->getfield('susp')
2659         ) || ! $conf->exists('disable_setup_suspended_pkgs')
2660        )
2661     || $options{'resetup'}
2662   ) {
2663
2664     warn "    bill setup\n" if $DEBUG > 1;
2665     $lineitems++;
2666
2667     $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2668     return "$@ running calc_setup for $cust_pkg\n"
2669       if $@;
2670
2671     $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
2672
2673     $cust_pkg->setfield('setup', $time)
2674       unless $cust_pkg->setup;
2675           #do need it, but it won't get written to the db
2676           #|| $cust_pkg->pkgpart != $real_pkgpart;
2677
2678   }
2679
2680   ###
2681   # bill recurring fee
2682   ###
2683
2684   #XXX unit stuff here too
2685   my $recur = 0;
2686   my $unitrecur = 0;
2687   my $sdate;
2688   if ( ! $cust_pkg->getfield('susp') and
2689            ( $part_pkg->getfield('freq') ne '0' &&
2690              ( $cust_pkg->getfield('bill') || 0 ) <= $time
2691            )
2692         || ( $part_pkg->plan eq 'voip_cdr'
2693               && $part_pkg->option('bill_every_call')
2694            )
2695   ) {
2696
2697     # XXX should this be a package event?  probably.  events are called
2698     # at collection time at the moment, though...
2699     $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
2700       if $part_pkg->can('reset_usage');
2701       #don't want to reset usage just cause we want a line item??
2702       #&& $part_pkg->pkgpart == $real_pkgpart;
2703
2704     warn "    bill recur\n" if $DEBUG > 1;
2705     $lineitems++;
2706
2707     # XXX shared with $recur_prog
2708     $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2709
2710     #over two params!  lets at least switch to a hashref for the rest...
2711     my $increment_next_bill = ( $part_pkg->freq ne '0'
2712                                 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
2713                               );
2714     my %param = ( 'precommit_hooks'     => $precommit_hooks,
2715                   'increment_next_bill' => $increment_next_bill,
2716                 );
2717
2718     $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2719     return "$@ running calc_recur for $cust_pkg\n"
2720       if ( $@ );
2721
2722     if ( $increment_next_bill ) {
2723
2724       my $next_bill = $part_pkg->add_freq($sdate);
2725       return "unparsable frequency: ". $part_pkg->freq
2726         if $next_bill == -1;
2727
2728       #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
2729       # only for figuring next bill date, nothing else, so, reset $sdate again
2730       # here
2731       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2732       #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
2733       $cust_pkg->last_bill($sdate);
2734
2735       $cust_pkg->setfield('bill', $next_bill );
2736
2737     }
2738
2739   }
2740
2741   warn "\$setup is undefined" unless defined($setup);
2742   warn "\$recur is undefined" unless defined($recur);
2743   warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2744
2745   ###
2746   # If there's line items, create em cust_bill_pkg records
2747   # If $cust_pkg has been modified, update it (if we're a real pkgpart)
2748   ###
2749
2750   if ( $lineitems ) {
2751
2752     if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
2753       # hmm.. and if just the options are modified in some weird price plan?
2754
2755       warn "  package ". $cust_pkg->pkgnum. " modified; updating\n"
2756         if $DEBUG >1;
2757
2758       my $error = $cust_pkg->replace( $old_cust_pkg,
2759                                       'options' => { $cust_pkg->options },
2760                                     );
2761       return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
2762         if $error; #just in case
2763     }
2764
2765     $setup = sprintf( "%.2f", $setup );
2766     $recur = sprintf( "%.2f", $recur );
2767     if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2768       return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2769     }
2770     if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2771       return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2772     }
2773
2774     if ( $setup != 0 || $recur != 0 ) {
2775
2776       warn "    charges (setup=$setup, recur=$recur); adding line items\n"
2777         if $DEBUG > 1;
2778
2779       my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
2780       if ( $DEBUG > 1 ) {
2781         warn "      adding customer package invoice detail: $_\n"
2782           foreach @cust_pkg_detail;
2783       }
2784       push @details, @cust_pkg_detail;
2785
2786       my $cust_bill_pkg = new FS::cust_bill_pkg {
2787         'pkgnum'    => $cust_pkg->pkgnum,
2788         'setup'     => $setup,
2789         'unitsetup' => $unitsetup,
2790         'recur'     => $recur,
2791         'unitrecur' => $unitrecur,
2792         'quantity'  => $cust_pkg->quantity,
2793         'details'   => \@details,
2794       };
2795
2796       if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
2797         $cust_bill_pkg->sdate( $hash{last_bill} );
2798         $cust_bill_pkg->edate( $sdate - 86399   ); #60s*60m*24h-1
2799       } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
2800         $cust_bill_pkg->sdate( $sdate );
2801         $cust_bill_pkg->edate( $cust_pkg->bill );
2802       }
2803
2804       $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
2805         unless $part_pkg->pkgpart == $real_pkgpart;
2806
2807       $$total_setup += $setup;
2808       $$total_recur += $recur;
2809
2810       ###
2811       # handle taxes
2812       ###
2813
2814       my $error =
2815         $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time});
2816       return $error if $error;
2817
2818       push @$cust_bill_pkgs, $cust_bill_pkg;
2819
2820     } #if $setup != 0 || $recur != 0
2821
2822   } #if $line_items
2823
2824   '';
2825
2826 }
2827
2828 sub _handle_taxes {
2829   my $self = shift;
2830   my $part_pkg = shift;
2831   my $taxlisthash = shift;
2832   my $cust_bill_pkg = shift;
2833   my $cust_pkg = shift;
2834   my $invoice_time = shift;
2835
2836   my %cust_bill_pkg = ();
2837   my %taxes = ();
2838
2839   my @classes;
2840   #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
2841   push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
2842   push @classes, 'setup' if $cust_bill_pkg->setup;
2843   push @classes, 'recur' if $cust_bill_pkg->recur;
2844
2845   if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
2846
2847     if ( $conf->exists('enable_taxproducts')
2848          && ( scalar($part_pkg->part_pkg_taxoverride)
2849               || $part_pkg->has_taxproduct
2850             )
2851        )
2852     {
2853
2854       if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
2855         return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
2856       }
2857
2858       foreach my $class (@classes) {
2859         my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
2860         return $err_or_ref unless ref($err_or_ref);
2861         $taxes{$class} = $err_or_ref;
2862       }
2863
2864       unless (exists $taxes{''}) {
2865         my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
2866         return $err_or_ref unless ref($err_or_ref);
2867         $taxes{''} = $err_or_ref;
2868       }
2869
2870     } else {
2871
2872       my @loc_keys = qw( state county country );
2873       my %taxhash;
2874       if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
2875         my $cust_location = $cust_pkg->cust_location;
2876         %taxhash = map { $_ => $cust_location->$_()    } @loc_keys;
2877       } else {
2878         my $prefix =
2879           ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2880           ? 'ship_'
2881           : '';
2882         %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
2883       }
2884
2885       $taxhash{'taxclass'} = $part_pkg->taxclass;
2886
2887       my @taxes = qsearch( 'cust_main_county', \%taxhash );
2888
2889       my %taxhash_elim = %taxhash;
2890
2891       my @elim = qw( taxclass county state );
2892       while ( !scalar(@taxes) && scalar(@elim) ) {
2893         $taxhash_elim{ shift(@elim) } = '';
2894         @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
2895       }
2896
2897       if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
2898         foreach (@taxes) {
2899           $_->set('pkgnum',      $cust_pkg->pkgnum );
2900           $_->set('locationnum', $cust_pkg->locationnum );
2901         }
2902       }
2903
2904       $taxes{''} = [ @taxes ];
2905       $taxes{'setup'} = [ @taxes ];
2906       $taxes{'recur'} = [ @taxes ];
2907       $taxes{$_} = [ @taxes ] foreach (@classes);
2908
2909       # maybe eliminate this entirely, along with all the 0% records
2910       unless ( @taxes ) {
2911         return
2912           "fatal: can't find tax rate for state/county/country/taxclass ".
2913           join('/', map $taxhash{$_}, qw(state county country taxclass) );
2914       }
2915
2916     } #if $conf->exists('enable_taxproducts') ...
2917
2918   }
2919
2920   my @display = ();
2921   if ( $conf->exists('separate_usage') ) {
2922     my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
2923     my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
2924     push @display, new FS::cust_bill_pkg_display { type    => 'S' };
2925     push @display, new FS::cust_bill_pkg_display { type    => 'R' };
2926     push @display, new FS::cust_bill_pkg_display { type    => 'U',
2927                                                    section => $section
2928                                                  };
2929     if ($section && $summary) {
2930       $display[2]->post_total('Y');
2931       push @display, new FS::cust_bill_pkg_display { type    => 'U',
2932                                                      summary => 'Y',
2933                                                    }
2934     }
2935   }
2936   $cust_bill_pkg->set('display', \@display);
2937
2938   my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
2939   foreach my $key (keys %tax_cust_bill_pkg) {
2940     my @taxes = @{ $taxes{$key} || [] };
2941     my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
2942
2943     my %localtaxlisthash = ();
2944     foreach my $tax ( @taxes ) {
2945
2946       my $taxname = ref( $tax ). ' '. $tax->taxnum;
2947 #      $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
2948 #                  ' locationnum'. $cust_pkg->locationnum
2949 #        if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
2950
2951       $taxlisthash->{ $taxname } ||= [ $tax ];
2952       push @{ $taxlisthash->{ $taxname  } }, $tax_cust_bill_pkg;
2953
2954       $localtaxlisthash{ $taxname } ||= [ $tax ];
2955       push @{ $localtaxlisthash{ $taxname  } }, $tax_cust_bill_pkg;
2956
2957     }
2958
2959     warn "finding taxed taxes...\n" if $DEBUG > 2;
2960     foreach my $tax ( keys %localtaxlisthash ) {
2961       my $tax_object = shift @{ $localtaxlisthash{$tax} };
2962       warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
2963         if $DEBUG > 2;
2964       next unless $tax_object->can('tax_on_tax');
2965
2966       foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
2967         my $totname = ref( $tot ). ' '. $tot->taxnum;
2968
2969         warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
2970           if $DEBUG > 2;
2971         next unless exists( $localtaxlisthash{ $totname } ); # only increase
2972                                                              # existing taxes
2973         warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
2974         my $hashref_or_error =
2975           $tax_object->taxline( $localtaxlisthash{$tax},
2976                                 'custnum'      => $self->custnum,
2977                                 'invoice_time' => $invoice_time,
2978                               );
2979         return $hashref_or_error
2980           unless ref($hashref_or_error);
2981
2982         $taxlisthash->{ $totname } ||= [ $tot ];
2983         push @{ $taxlisthash->{ $totname  } }, $hashref_or_error->{amount};
2984
2985       }
2986     }
2987
2988   }
2989
2990   '';
2991 }
2992
2993 sub _gather_taxes {
2994   my $self = shift;
2995   my $part_pkg = shift;
2996   my $class = shift;
2997
2998   my @taxes = ();
2999   my $geocode = $self->geocode('cch');
3000
3001   my @taxclassnums = map { $_->taxclassnum }
3002                      $part_pkg->part_pkg_taxoverride($class);
3003
3004   unless (@taxclassnums) {
3005     @taxclassnums = map { $_->taxclassnum }
3006                     $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3007   }
3008   warn "Found taxclassnum values of ". join(',', @taxclassnums)
3009     if $DEBUG;
3010
3011   my $extra_sql =
3012     "AND (".
3013     join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3014
3015   @taxes = qsearch({ 'table' => 'tax_rate',
3016                      'hashref' => { 'geocode' => $geocode, },
3017                      'extra_sql' => $extra_sql,
3018                   })
3019     if scalar(@taxclassnums);
3020
3021   warn "Found taxes ".
3022        join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3023    if $DEBUG;
3024
3025   [ @taxes ];
3026
3027 }
3028
3029 =item collect OPTIONS
3030
3031 (Attempt to) collect money for this customer's outstanding invoices (see
3032 L<FS::cust_bill>).  Usually used after the bill method.
3033
3034 Actions are now triggered by billing events; see L<FS::part_event> and the
3035 billing events web interface.  Old-style invoice events (see
3036 L<FS::part_bill_event>) have been deprecated.
3037
3038 If there is an error, returns the error, otherwise returns false.
3039
3040 Options are passed as name-value pairs.
3041
3042 Currently available options are:
3043
3044 =over 4
3045
3046 =item invoice_time
3047
3048 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.
3049
3050 =item retry
3051
3052 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3053
3054 =item quiet
3055
3056 set true to surpress email card/ACH decline notices.
3057
3058 =item check_freq
3059
3060 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3061
3062 =item payby
3063
3064 allows for one time override of normal customer billing method
3065
3066 =item debug
3067
3068 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)
3069
3070
3071 =back
3072
3073 =cut
3074
3075 sub collect {
3076   my( $self, %options ) = @_;
3077   my $invoice_time = $options{'invoice_time'} || time;
3078
3079   #put below somehow?
3080   local $SIG{HUP} = 'IGNORE';
3081   local $SIG{INT} = 'IGNORE';
3082   local $SIG{QUIT} = 'IGNORE';
3083   local $SIG{TERM} = 'IGNORE';
3084   local $SIG{TSTP} = 'IGNORE';
3085   local $SIG{PIPE} = 'IGNORE';
3086
3087   my $oldAutoCommit = $FS::UID::AutoCommit;
3088   local $FS::UID::AutoCommit = 0;
3089   my $dbh = dbh;
3090
3091   $self->select_for_update; #mutex
3092
3093   if ( $DEBUG ) {
3094     my $balance = $self->balance;
3095     warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3096   }
3097
3098   if ( exists($options{'retry_card'}) ) {
3099     carp 'retry_card option passed to collect is deprecated; use retry';
3100     $options{'retry'} ||= $options{'retry_card'};
3101   }
3102   if ( exists($options{'retry'}) && $options{'retry'} ) {
3103     my $error = $self->retry_realtime;
3104     if ( $error ) {
3105       $dbh->rollback if $oldAutoCommit;
3106       return $error;
3107     }
3108   }
3109
3110   # false laziness w/pay_batch::import_results
3111
3112   my $due_cust_event = $self->due_cust_event(
3113     'debug'      => ( $options{'debug'} || 0 ),
3114     'time'       => $invoice_time,
3115     'check_freq' => $options{'check_freq'},
3116   );
3117   unless( ref($due_cust_event) ) {
3118     $dbh->rollback if $oldAutoCommit;
3119     return $due_cust_event;
3120   }
3121
3122   foreach my $cust_event ( @$due_cust_event ) {
3123
3124     #XXX lock event
3125
3126     #re-eval event conditions (a previous event could have changed things)
3127     unless ( $cust_event->test_conditions( 'time' => $invoice_time ) ) {
3128       #don't leave stray "new/locked" records around
3129       my $error = $cust_event->delete;
3130       if ( $error ) {
3131         #gah, even with transactions
3132         $dbh->commit if $oldAutoCommit; #well.
3133         return $error;
3134       }
3135       next;
3136     }
3137
3138     {
3139       local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3140       warn "  running cust_event ". $cust_event->eventnum. "\n"
3141         if $DEBUG > 1;
3142
3143
3144       #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3145       if ( my $error = $cust_event->do_event() ) {
3146         #XXX wtf is this?  figure out a proper dealio with return value
3147         #from do_event
3148           # gah, even with transactions.
3149           $dbh->commit if $oldAutoCommit; #well.
3150           return $error;
3151         }
3152     }
3153
3154   }
3155
3156   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3157   '';
3158
3159 }
3160
3161 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3162
3163 Inserts database records for and returns an ordered listref of new events due
3164 for this customer, as FS::cust_event objects (see L<FS::cust_event>).  If no
3165 events are due, an empty listref is returned.  If there is an error, returns a
3166 scalar error message.
3167
3168 To actually run the events, call each event's test_condition method, and if
3169 still true, call the event's do_event method.
3170
3171 Options are passed as a hashref or as a list of name-value pairs.  Available
3172 options are:
3173
3174 =over 4
3175
3176 =item check_freq
3177
3178 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.
3179
3180 =item time
3181
3182 "Current time" for the events.
3183
3184 =item debug
3185
3186 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)
3187
3188 =item eventtable
3189
3190 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3191
3192 =item objects
3193
3194 Explicitly pass the objects to be tested (typically used with eventtable).
3195
3196 =item testonly
3197
3198 Set to true to return the objects, but not actually insert them into the
3199 database.
3200
3201 =back
3202
3203 =cut
3204
3205 sub due_cust_event {
3206   my $self = shift;
3207   my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3208
3209   #???
3210   #my $DEBUG = $opt{'debug'}
3211   local($DEBUG) = $opt{'debug'}
3212     if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3213
3214   warn "$me due_cust_event called with options ".
3215        join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3216     if $DEBUG;
3217
3218   $opt{'time'} ||= time;
3219
3220   local $SIG{HUP} = 'IGNORE';
3221   local $SIG{INT} = 'IGNORE';
3222   local $SIG{QUIT} = 'IGNORE';
3223   local $SIG{TERM} = 'IGNORE';
3224   local $SIG{TSTP} = 'IGNORE';
3225   local $SIG{PIPE} = 'IGNORE';
3226
3227   my $oldAutoCommit = $FS::UID::AutoCommit;
3228   local $FS::UID::AutoCommit = 0;
3229   my $dbh = dbh;
3230
3231   $self->select_for_update #mutex
3232     unless $opt{testonly};
3233
3234   ###
3235   # 1: find possible events (initial search)
3236   ###
3237
3238   my @cust_event = ();
3239
3240   my @eventtable = $opt{'eventtable'}
3241                      ? ( $opt{'eventtable'} )
3242                      : FS::part_event->eventtables_runorder;
3243
3244   foreach my $eventtable ( @eventtable ) {
3245
3246     my @objects;
3247     if ( $opt{'objects'} ) {
3248
3249       @objects = @{ $opt{'objects'} };
3250
3251     } else {
3252
3253       #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3254       @objects = ( $eventtable eq 'cust_main' )
3255                    ? ( $self )
3256                    : ( $self->$eventtable() );
3257
3258     }
3259
3260     my @e_cust_event = ();
3261
3262     my $cross = "CROSS JOIN $eventtable";
3263     $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3264       unless $eventtable eq 'cust_main';
3265
3266     foreach my $object ( @objects ) {
3267
3268       #this first search uses the condition_sql magic for optimization.
3269       #the more possible events we can eliminate in this step the better
3270
3271       my $cross_where = '';
3272       my $pkey = $object->primary_key;
3273       $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3274
3275       my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3276       my $extra_sql =
3277         FS::part_event_condition->where_conditions_sql( $eventtable,
3278                                                         'time'=>$opt{'time'}
3279                                                       );
3280       my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3281
3282       $extra_sql = "AND $extra_sql" if $extra_sql;
3283
3284       #here is the agent virtualization
3285       $extra_sql .= " AND (    part_event.agentnum IS NULL
3286                             OR part_event.agentnum = ". $self->agentnum. ' )';
3287
3288       $extra_sql .= " $order";
3289
3290       warn "searching for events for $eventtable ". $object->$pkey. "\n"
3291         if $opt{'debug'} > 2;
3292       my @part_event = qsearch( {
3293         'debug'     => ( $opt{'debug'} > 3 ? 1 : 0 ),
3294         'select'    => 'part_event.*',
3295         'table'     => 'part_event',
3296         'addl_from' => "$cross $join",
3297         'hashref'   => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3298                          'eventtable' => $eventtable,
3299                          'disabled'   => '',
3300                        },
3301         'extra_sql' => "AND $cross_where $extra_sql",
3302       } );
3303
3304       if ( $DEBUG > 2 ) {
3305         my $pkey = $object->primary_key;
3306         warn "      ". scalar(@part_event).
3307              " possible events found for $eventtable ". $object->$pkey(). "\n";
3308       }
3309
3310       push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3311
3312     }
3313
3314     warn "    ". scalar(@e_cust_event).
3315          " subtotal possible cust events found for $eventtable\n"
3316       if $DEBUG > 1;
3317
3318     push @cust_event, @e_cust_event;
3319
3320   }
3321
3322   warn "  ". scalar(@cust_event).
3323        " total possible cust events found in initial search\n"
3324     if $DEBUG; # > 1;
3325
3326   ##
3327   # 2: test conditions
3328   ##
3329
3330   my %unsat = ();
3331
3332   @cust_event = grep $_->test_conditions( 'time'          => $opt{'time'},
3333                                           'stats_hashref' => \%unsat ),
3334                      @cust_event;
3335
3336   warn "  ". scalar(@cust_event). " cust events left satisfying conditions\n"
3337     if $DEBUG; # > 1;
3338
3339   warn "    invalid conditions not eliminated with condition_sql:\n".
3340        join('', map "      $_: ".$unsat{$_}."\n", keys %unsat )
3341     if $DEBUG; # > 1;
3342
3343   ##
3344   # 3: insert
3345   ##
3346
3347   unless( $opt{testonly} ) {
3348     foreach my $cust_event ( @cust_event ) {
3349
3350       my $error = $cust_event->insert();
3351       if ( $error ) {
3352         $dbh->rollback if $oldAutoCommit;
3353         return $error;
3354       }
3355
3356     }
3357   }
3358
3359   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3360
3361   ##
3362   # 4: return
3363   ##
3364
3365   warn "  returning events: ". Dumper(@cust_event). "\n"
3366     if $DEBUG > 2;
3367
3368   \@cust_event;
3369
3370 }
3371
3372 =item retry_realtime
3373
3374 Schedules realtime / batch  credit card / electronic check / LEC billing
3375 events for for retry.  Useful if card information has changed or manual
3376 retry is desired.  The 'collect' method must be called to actually retry
3377 the transaction.
3378
3379 Implementation details: For either this customer, or for each of this
3380 customer's open invoices, changes the status of the first "done" (with
3381 statustext error) realtime processing event to "failed".
3382
3383 =cut
3384
3385 sub retry_realtime {
3386   my $self = shift;
3387
3388   local $SIG{HUP} = 'IGNORE';
3389   local $SIG{INT} = 'IGNORE';
3390   local $SIG{QUIT} = 'IGNORE';
3391   local $SIG{TERM} = 'IGNORE';
3392   local $SIG{TSTP} = 'IGNORE';
3393   local $SIG{PIPE} = 'IGNORE';
3394
3395   my $oldAutoCommit = $FS::UID::AutoCommit;
3396   local $FS::UID::AutoCommit = 0;
3397   my $dbh = dbh;
3398
3399   #a little false laziness w/due_cust_event (not too bad, really)
3400
3401   my $join = FS::part_event_condition->join_conditions_sql;
3402   my $order = FS::part_event_condition->order_conditions_sql;
3403   my $mine =
3404   '( '
3405    . join ( ' OR ' , map {
3406     "( part_event.eventtable = " . dbh->quote($_)
3407     . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
3408    } FS::part_event->eventtables)
3409    . ') ';
3410
3411   #here is the agent virtualization
3412   my $agent_virt = " (    part_event.agentnum IS NULL
3413                        OR part_event.agentnum = ". $self->agentnum. ' )';
3414
3415   #XXX this shouldn't be hardcoded, actions should declare it...
3416   my @realtime_events = qw(
3417     cust_bill_realtime_card
3418     cust_bill_realtime_check
3419     cust_bill_realtime_lec
3420     cust_bill_batch
3421   );
3422
3423   my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
3424                                                   @realtime_events
3425                                      ).
3426                           ' ) ';
3427
3428   my @cust_event = qsearchs({
3429     'table'     => 'cust_event',
3430     'select'    => 'cust_event.*',
3431     'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
3432     'hashref'   => { 'status' => 'done' },
3433     'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
3434                    " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
3435   });
3436
3437   my %seen_invnum = ();
3438   foreach my $cust_event (@cust_event) {
3439
3440     #max one for the customer, one for each open invoice
3441     my $cust_X = $cust_event->cust_X;
3442     next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
3443                           ? $cust_X->invnum
3444                           : 0
3445                         }++
3446          or $cust_event->part_event->eventtable eq 'cust_bill'
3447             && ! $cust_X->owed;
3448
3449     my $error = $cust_event->retry;
3450     if ( $error ) {
3451       $dbh->rollback if $oldAutoCommit;
3452       return "error scheduling event for retry: $error";
3453     }
3454
3455   }
3456
3457   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3458   '';
3459
3460 }
3461
3462 # some horrid false laziness here to avoid refactor fallout
3463 # eventually realtime realtime_bop and realtime_refund_bop should go
3464 # away and be replaced by _new_realtime_bop and _new_realtime_refund_bop
3465
3466 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
3467
3468 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
3469 via a Business::OnlinePayment realtime gateway.  See
3470 L<http://420.am/business-onlinepayment> for supported gateways.
3471
3472 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3473
3474 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
3475
3476 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3477 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
3478 if set, will override the value from the customer record.
3479
3480 I<description> is a free-text field passed to the gateway.  It defaults to
3481 "Internet services".
3482
3483 If an I<invnum> is specified, this payment (if successful) is applied to the
3484 specified invoice.  If you don't specify an I<invnum> you might want to
3485 call the B<apply_payments> method.
3486
3487 I<quiet> can be set true to surpress email decline notices.
3488
3489 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
3490 resulting paynum, if any.
3491
3492 I<payunique> is a unique identifier for this payment.
3493
3494 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
3495
3496 =cut
3497
3498 sub realtime_bop {
3499   my $self = shift;
3500
3501   return $self->_new_realtime_bop(@_)
3502     if $self->_new_bop_required();
3503
3504   my( $method, $amount, %options ) = @_;
3505   if ( $DEBUG ) {
3506     warn "$me realtime_bop: $method $amount\n";
3507     warn "  $_ => $options{$_}\n" foreach keys %options;
3508   }
3509
3510   $options{'description'} ||= 'Internet services';
3511
3512   return $self->fake_bop($method, $amount, %options) if $options{'fake'};
3513
3514   eval "use Business::OnlinePayment";
3515   die $@ if $@;
3516
3517   my $payinfo = exists($options{'payinfo'})
3518                   ? $options{'payinfo'}
3519                   : $self->payinfo;
3520
3521   my %method2payby = (
3522     'CC'     => 'CARD',
3523     'ECHECK' => 'CHEK',
3524     'LEC'    => 'LECB',
3525   );
3526
3527   ###
3528   # check for banned credit card/ACH
3529   ###
3530
3531   my $ban = qsearchs('banned_pay', {
3532     'payby'   => $method2payby{$method},
3533     'payinfo' => md5_base64($payinfo),
3534   } );
3535   return "Banned credit card" if $ban;
3536
3537   ###
3538   # set taxclass and trans_is_recur based on invnum if there is one
3539   ###
3540
3541   my $taxclass = '';
3542   my $trans_is_recur = 0;
3543   if ( $options{'invnum'} ) {
3544
3545     my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
3546     die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
3547
3548     my @part_pkg =
3549       map  { $_->part_pkg }
3550       grep { $_ }
3551       map  { $_->cust_pkg }
3552       $cust_bill->cust_bill_pkg;
3553
3554     my @taxclasses = map $_->taxclass, @part_pkg;
3555     $taxclass = $taxclasses[0]
3556       unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
3557                                                         #different taxclasses
3558     $trans_is_recur = 1
3559       if grep { $_->freq ne '0' } @part_pkg;
3560
3561   }
3562
3563   ###
3564   # select a gateway
3565   ###
3566
3567   #look for an agent gateway override first
3568   my $cardtype;
3569   if ( $method eq 'CC' ) {
3570     $cardtype = cardtype($payinfo);
3571   } elsif ( $method eq 'ECHECK' ) {
3572     $cardtype = 'ACH';
3573   } else {
3574     $cardtype = $method;
3575   }
3576
3577   my $override =
3578        qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3579                                            cardtype => $cardtype,
3580                                            taxclass => $taxclass,       } )
3581     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3582                                            cardtype => '',
3583                                            taxclass => $taxclass,       } )
3584     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3585                                            cardtype => $cardtype,
3586                                            taxclass => '',              } )
3587     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3588                                            cardtype => '',
3589                                            taxclass => '',              } );
3590
3591   my $payment_gateway = '';
3592   my( $processor, $login, $password, $action, @bop_options );
3593   if ( $override ) { #use a payment gateway override
3594
3595     $payment_gateway = $override->payment_gateway;
3596
3597     $processor   = $payment_gateway->gateway_module;
3598     $login       = $payment_gateway->gateway_username;
3599     $password    = $payment_gateway->gateway_password;
3600     $action      = $payment_gateway->gateway_action;
3601     @bop_options = $payment_gateway->options;
3602
3603   } else { #use the standard settings from the config
3604
3605     ( $processor, $login, $password, $action, @bop_options ) =
3606       $self->default_payment_gateway($method);
3607
3608   }
3609
3610   ###
3611   # massage data
3612   ###
3613
3614   my $address = exists($options{'address1'})
3615                     ? $options{'address1'}
3616                     : $self->address1;
3617   my $address2 = exists($options{'address2'})
3618                     ? $options{'address2'}
3619                     : $self->address2;
3620   $address .= ", ". $address2 if length($address2);
3621
3622   my $o_payname = exists($options{'payname'})
3623                     ? $options{'payname'}
3624                     : $self->payname;
3625   my($payname, $payfirst, $paylast);
3626   if ( $o_payname && $method ne 'ECHECK' ) {
3627     ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3628       or return "Illegal payname $payname";
3629     ($payfirst, $paylast) = ($1, $2);
3630   } else {
3631     $payfirst = $self->getfield('first');
3632     $paylast = $self->getfield('last');
3633     $payname =  "$payfirst $paylast";
3634   }
3635
3636   my @invoicing_list = $self->invoicing_list_emailonly;
3637   if ( $conf->exists('emailinvoiceautoalways')
3638        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3639        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3640     push @invoicing_list, $self->all_emails;
3641   }
3642
3643   my $email = ($conf->exists('business-onlinepayment-email-override'))
3644               ? $conf->config('business-onlinepayment-email-override')
3645               : $invoicing_list[0];
3646
3647   my %content = ();
3648
3649   my $payip = exists($options{'payip'})
3650                 ? $options{'payip'}
3651                 : $self->payip;
3652   $content{customer_ip} = $payip
3653     if length($payip);
3654
3655   $content{invoice_number} = $options{'invnum'}
3656     if exists($options{'invnum'}) && length($options{'invnum'});
3657
3658   $content{email_customer} =
3659     (    $conf->exists('business-onlinepayment-email_customer')
3660       || $conf->exists('business-onlinepayment-email-override') );
3661
3662   my $paydate = '';
3663   if ( $method eq 'CC' ) {
3664
3665     $content{card_number} = $payinfo;
3666     $paydate = exists($options{'paydate'})
3667                     ? $options{'paydate'}
3668                     : $self->paydate;
3669     $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3670     $content{expiration} = "$2/$1";
3671
3672     my $paycvv = exists($options{'paycvv'})
3673                    ? $options{'paycvv'}
3674                    : $self->paycvv;
3675     $content{cvv2} = $paycvv
3676       if length($paycvv);
3677
3678     my $paystart_month = exists($options{'paystart_month'})
3679                            ? $options{'paystart_month'}
3680                            : $self->paystart_month;
3681
3682     my $paystart_year  = exists($options{'paystart_year'})
3683                            ? $options{'paystart_year'}
3684                            : $self->paystart_year;
3685
3686     $content{card_start} = "$paystart_month/$paystart_year"
3687       if $paystart_month && $paystart_year;
3688
3689     my $payissue       = exists($options{'payissue'})
3690                            ? $options{'payissue'}
3691                            : $self->payissue;
3692     $content{issue_number} = $payissue if $payissue;
3693
3694     if ( $self->_bop_recurring_billing( 'payinfo'        => $payinfo,
3695                                         'trans_is_recur' => $trans_is_recur,
3696                                       )
3697        )
3698     {
3699       $content{recurring_billing} = 'YES';
3700       $content{acct_code} = 'rebill'
3701         if $conf->exists('credit_card-recurring_billing_acct_code');
3702     }
3703
3704   } elsif ( $method eq 'ECHECK' ) {
3705     ( $content{account_number}, $content{routing_code} ) =
3706       split('@', $payinfo);
3707     $content{bank_name} = $o_payname;
3708     $content{bank_state} = exists($options{'paystate'})
3709                              ? $options{'paystate'}
3710                              : $self->getfield('paystate');
3711     $content{account_type} = exists($options{'paytype'})
3712                                ? uc($options{'paytype'}) || 'CHECKING'
3713                                : uc($self->getfield('paytype')) || 'CHECKING';
3714     $content{account_name} = $payname;
3715     $content{customer_org} = $self->company ? 'B' : 'I';
3716     $content{state_id}       = exists($options{'stateid'})
3717                                  ? $options{'stateid'}
3718                                  : $self->getfield('stateid');
3719     $content{state_id_state} = exists($options{'stateid_state'})
3720                                  ? $options{'stateid_state'}
3721                                  : $self->getfield('stateid_state');
3722     $content{customer_ssn} = exists($options{'ss'})
3723                                ? $options{'ss'}
3724                                : $self->ss;
3725   } elsif ( $method eq 'LEC' ) {
3726     $content{phone} = $payinfo;
3727   }
3728
3729   ###
3730   # run transaction(s)
3731   ###
3732
3733   my $balance = exists( $options{'balance'} )
3734                   ? $options{'balance'}
3735                   : $self->balance;
3736
3737   $self->select_for_update; #mutex ... just until we get our pending record in
3738
3739   #the checks here are intended to catch concurrent payments
3740   #double-form-submission prevention is taken care of in cust_pay_pending::check
3741
3742   #check the balance
3743   return "The customer's balance has changed; $method transaction aborted."
3744     if $self->balance < $balance;
3745     #&& $self->balance < $amount; #might as well anyway?
3746
3747   #also check and make sure there aren't *other* pending payments for this cust
3748
3749   my @pending = qsearch('cust_pay_pending', {
3750     'custnum' => $self->custnum,
3751     'status'  => { op=>'!=', value=>'done' }
3752   });
3753   return "A payment is already being processed for this customer (".
3754          join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
3755          "); $method transaction aborted."
3756     if scalar(@pending);
3757
3758   #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
3759
3760   my $cust_pay_pending = new FS::cust_pay_pending {
3761     'custnum'           => $self->custnum,
3762     #'invnum'            => $options{'invnum'},
3763     'paid'              => $amount,
3764     '_date'             => '',
3765     'payby'             => $method2payby{$method},
3766     'payinfo'           => $payinfo,
3767     'paydate'           => $paydate,
3768     'recurring_billing' => $content{recurring_billing},
3769     'status'            => 'new',
3770     'gatewaynum'        => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
3771   };
3772   $cust_pay_pending->payunique( $options{payunique} )
3773     if defined($options{payunique}) && length($options{payunique});
3774   my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
3775   return $cpp_new_err if $cpp_new_err;
3776
3777   my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3778
3779   my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3780   $transaction->content(
3781     'type'           => $method,
3782     'login'          => $login,
3783     'password'       => $password,
3784     'action'         => $action1,
3785     'description'    => $options{'description'},
3786     'amount'         => $amount,
3787     #'invoice_number' => $options{'invnum'},
3788     'customer_id'    => $self->custnum,
3789     'last_name'      => $paylast,
3790     'first_name'     => $payfirst,
3791     'name'           => $payname,
3792     'address'        => $address,
3793     'city'           => ( exists($options{'city'})
3794                             ? $options{'city'}
3795                             : $self->city          ),
3796     'state'          => ( exists($options{'state'})
3797                             ? $options{'state'}
3798                             : $self->state          ),
3799     'zip'            => ( exists($options{'zip'})
3800                             ? $options{'zip'}
3801                             : $self->zip          ),
3802     'country'        => ( exists($options{'country'})
3803                             ? $options{'country'}
3804                             : $self->country          ),
3805     'referer'        => 'http://cleanwhisker.420.am/', #XXX fix referer :/
3806     'email'          => $email,
3807     'phone'          => $self->daytime || $self->night,
3808     %content, #after
3809   );
3810
3811   $cust_pay_pending->status('pending');
3812   my $cpp_pending_err = $cust_pay_pending->replace;
3813   return $cpp_pending_err if $cpp_pending_err;
3814
3815   #config?
3816   my $BOP_TESTING = 0;
3817   my $BOP_TESTING_SUCCESS = 1;
3818
3819   unless ( $BOP_TESTING ) {
3820     $transaction->submit();
3821   } else {
3822     if ( $BOP_TESTING_SUCCESS ) {
3823       $transaction->is_success(1);
3824       $transaction->authorization('fake auth');
3825     } else {
3826       $transaction->is_success(0);
3827       $transaction->error_message('fake failure');
3828     }
3829   }
3830
3831   if ( $transaction->is_success() && $action2 ) {
3832
3833     $cust_pay_pending->status('authorized');
3834     my $cpp_authorized_err = $cust_pay_pending->replace;
3835     return $cpp_authorized_err if $cpp_authorized_err;
3836
3837     my $auth = $transaction->authorization;
3838     my $ordernum = $transaction->can('order_number')
3839                    ? $transaction->order_number
3840                    : '';
3841
3842     my $capture =
3843       new Business::OnlinePayment( $processor, @bop_options );
3844
3845     my %capture = (
3846       %content,
3847       type           => $method,
3848       action         => $action2,
3849       login          => $login,
3850       password       => $password,
3851       order_number   => $ordernum,
3852       amount         => $amount,
3853       authorization  => $auth,
3854       description    => $options{'description'},
3855     );
3856
3857     foreach my $field (qw( authorization_source_code returned_ACI
3858                            transaction_identifier validation_code
3859                            transaction_sequence_num local_transaction_date
3860                            local_transaction_time AVS_result_code          )) {
3861       $capture{$field} = $transaction->$field() if $transaction->can($field);
3862     }
3863
3864     $capture->content( %capture );
3865
3866     $capture->submit();
3867
3868     unless ( $capture->is_success ) {
3869       my $e = "Authorization successful but capture failed, custnum #".
3870               $self->custnum. ': '.  $capture->result_code.
3871               ": ". $capture->error_message;
3872       warn $e;
3873       return $e;
3874     }
3875
3876   }
3877
3878   $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
3879   my $cpp_captured_err = $cust_pay_pending->replace;
3880   return $cpp_captured_err if $cpp_captured_err;
3881
3882   ###
3883   # remove paycvv after initial transaction
3884   ###
3885
3886   #false laziness w/misc/process/payment.cgi - check both to make sure working
3887   # correctly
3888   if ( defined $self->dbdef_table->column('paycvv')
3889        && length($self->paycvv)
3890        && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3891   ) {
3892     my $error = $self->remove_cvv;
3893     if ( $error ) {
3894       warn "WARNING: error removing cvv: $error\n";
3895     }
3896   }
3897
3898   ###
3899   # result handling
3900   ###
3901
3902   if ( $transaction->is_success() ) {
3903
3904     my $paybatch = '';
3905     if ( $payment_gateway ) { # agent override
3906       $paybatch = $payment_gateway->gatewaynum. '-';
3907     }
3908
3909     $paybatch .= "$processor:". $transaction->authorization;
3910
3911     $paybatch .= ':'. $transaction->order_number
3912       if $transaction->can('order_number')
3913       && length($transaction->order_number);
3914
3915     my $cust_pay = new FS::cust_pay ( {
3916        'custnum'  => $self->custnum,
3917        'invnum'   => $options{'invnum'},
3918        'paid'     => $amount,
3919        '_date'    => '',
3920        'payby'    => $method2payby{$method},
3921        'payinfo'  => $payinfo,
3922        'paybatch' => $paybatch,
3923        'paydate'  => $paydate,
3924     } );
3925     #doesn't hurt to know, even though the dup check is in cust_pay_pending now
3926     $cust_pay->payunique( $options{payunique} )
3927       if defined($options{payunique}) && length($options{payunique});
3928
3929     my $oldAutoCommit = $FS::UID::AutoCommit;
3930     local $FS::UID::AutoCommit = 0;
3931     my $dbh = dbh;
3932
3933     #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
3934
3935     my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3936
3937     if ( $error ) {
3938       $cust_pay->invnum(''); #try again with no specific invnum
3939       my $error2 = $cust_pay->insert( $options{'manual'} ?
3940                                       ( 'manual' => 1 ) : ()
3941                                     );
3942       if ( $error2 ) {
3943         # gah.  but at least we have a record of the state we had to abort in
3944         # from cust_pay_pending now.
3945         my $e = "WARNING: $method captured but payment not recorded - ".
3946                 "error inserting payment ($processor): $error2".
3947                 " (previously tried insert with invnum #$options{'invnum'}" .
3948                 ": $error ) - pending payment saved as paypendingnum ".
3949                 $cust_pay_pending->paypendingnum. "\n";
3950         warn $e;
3951         return $e;
3952       }
3953     }
3954
3955     if ( $options{'paynum_ref'} ) {
3956       ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3957     }
3958
3959     $cust_pay_pending->status('done');
3960     $cust_pay_pending->statustext('captured');
3961     $cust_pay_pending->paynum($cust_pay->paynum);
3962     my $cpp_done_err = $cust_pay_pending->replace;
3963
3964     if ( $cpp_done_err ) {
3965
3966       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3967       my $e = "WARNING: $method captured but payment not recorded - ".
3968               "error updating status for paypendingnum ".
3969               $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3970       warn $e;
3971       return $e;
3972
3973     } else {
3974
3975       $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3976       return ''; #no error
3977
3978     }
3979
3980   } else {
3981
3982     my $perror = "$processor error: ". $transaction->error_message;
3983
3984     unless ( $transaction->error_message ) {
3985
3986       my $t_response;
3987       if ( $transaction->can('response_page') ) {
3988         $t_response = {
3989                         'page'    => ( $transaction->can('response_page')
3990                                          ? $transaction->response_page
3991                                          : ''
3992                                      ),
3993                         'code'    => ( $transaction->can('response_code')
3994                                          ? $transaction->response_code
3995                                          : ''
3996                                      ),
3997                         'headers' => ( $transaction->can('response_headers')
3998                                          ? $transaction->response_headers
3999                                          : ''
4000                                      ),
4001                       };
4002       } else {
4003         $t_response .=
4004           "No additional debugging information available for $processor";
4005       }
4006
4007       $perror .= "No error_message returned from $processor -- ".
4008                  ( ref($t_response) ? Dumper($t_response) : $t_response );
4009
4010     }
4011
4012     if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4013          && $conf->exists('emaildecline')
4014          && grep { $_ ne 'POST' } $self->invoicing_list
4015          && ! grep { $transaction->error_message =~ /$_/ }
4016                    $conf->config('emaildecline-exclude')
4017     ) {
4018       my @templ = $conf->config('declinetemplate');
4019       my $template = new Text::Template (
4020         TYPE   => 'ARRAY',
4021         SOURCE => [ map "$_\n", @templ ],
4022       ) or return "($perror) can't create template: $Text::Template::ERROR";
4023       $template->compile()
4024         or return "($perror) can't compile template: $Text::Template::ERROR";
4025
4026       my $templ_hash = { error => $transaction->error_message };
4027
4028       my $error = send_email(
4029         'from'    => $conf->config('invoice_from', $self->agentnum ),
4030         'to'      => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4031         'subject' => 'Your payment could not be processed',
4032         'body'    => [ $template->fill_in(HASH => $templ_hash) ],
4033       );
4034
4035       $perror .= " (also received error sending decline notification: $error)"
4036         if $error;
4037
4038     }
4039
4040     $cust_pay_pending->status('done');
4041     $cust_pay_pending->statustext("declined: $perror");
4042     my $cpp_done_err = $cust_pay_pending->replace;
4043     if ( $cpp_done_err ) {
4044       my $e = "WARNING: $method declined but pending payment not resolved - ".
4045               "error updating status for paypendingnum ".
4046               $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4047       warn $e;
4048       $perror = "$e ($perror)";
4049     }
4050
4051     return $perror;
4052   }
4053
4054 }
4055
4056 sub _bop_recurring_billing {
4057   my( $self, %opt ) = @_;
4058
4059   my $method = $conf->config('credit_card-recurring_billing_flag');
4060
4061   if ( $method eq 'transaction_is_recur' ) {
4062
4063     return 1 if $opt{'trans_is_recur'};
4064
4065   } else {
4066
4067     my %hash = ( 'custnum' => $self->custnum,
4068                  'payby'   => 'CARD',
4069                );
4070
4071     return 1
4072       if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4073       || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4074                                                                $opt{'payinfo'} )
4075                              } );
4076
4077   }
4078
4079   return 0;
4080
4081 }
4082
4083
4084 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4085
4086 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4087 via a Business::OnlinePayment realtime gateway.  See
4088 L<http://420.am/business-onlinepayment> for supported gateways.
4089
4090 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4091
4092 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4093
4094 Most gateways require a reference to an original payment transaction to refund,
4095 so you probably need to specify a I<paynum>.
4096
4097 I<amount> defaults to the original amount of the payment if not specified.
4098
4099 I<reason> specifies a reason for the refund.
4100
4101 I<paydate> specifies the expiration date for a credit card overriding the
4102 value from the customer record or the payment record. Specified as yyyy-mm-dd
4103
4104 Implementation note: If I<amount> is unspecified or equal to the amount of the
4105 orignal payment, first an attempt is made to "void" the transaction via
4106 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4107 the normal attempt is made to "refund" ("credit") the transaction via the
4108 gateway is attempted.
4109
4110 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4111 #I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
4112 #if set, will override the value from the customer record.
4113
4114 #If an I<invnum> is specified, this payment (if successful) is applied to the
4115 #specified invoice.  If you don't specify an I<invnum> you might want to
4116 #call the B<apply_payments> method.
4117
4118 =cut
4119
4120 #some false laziness w/realtime_bop, not enough to make it worth merging
4121 #but some useful small subs should be pulled out
4122 sub realtime_refund_bop {
4123   my $self = shift;
4124
4125   return $self->_new_realtime_refund_bop(@_)
4126     if $self->_new_bop_required();
4127
4128   my( $method, %options ) = @_;
4129   if ( $DEBUG ) {
4130     warn "$me realtime_refund_bop: $method refund\n";
4131     warn "  $_ => $options{$_}\n" foreach keys %options;
4132   }
4133
4134   eval "use Business::OnlinePayment";
4135   die $@ if $@;
4136
4137   ###
4138   # look up the original payment and optionally a gateway for that payment
4139   ###
4140
4141   my $cust_pay = '';
4142   my $amount = $options{'amount'};
4143
4144   my( $processor, $login, $password, @bop_options ) ;
4145   my( $auth, $order_number ) = ( '', '', '' );
4146
4147   if ( $options{'paynum'} ) {
4148
4149     warn "  paynum: $options{paynum}\n" if $DEBUG > 1;
4150     $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4151       or return "Unknown paynum $options{'paynum'}";
4152     $amount ||= $cust_pay->paid;
4153
4154     $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4155       or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4156                 $cust_pay->paybatch;
4157     my $gatewaynum = '';
4158     ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4159
4160     if ( $gatewaynum ) { #gateway for the payment to be refunded
4161
4162       my $payment_gateway =
4163         qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4164       die "payment gateway $gatewaynum not found"
4165         unless $payment_gateway;
4166
4167       $processor   = $payment_gateway->gateway_module;
4168       $login       = $payment_gateway->gateway_username;
4169       $password    = $payment_gateway->gateway_password;
4170       @bop_options = $payment_gateway->options;
4171
4172     } else { #try the default gateway
4173
4174       my( $conf_processor, $unused_action );
4175       ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4176         $self->default_payment_gateway($method);
4177
4178       return "processor of payment $options{'paynum'} $processor does not".
4179              " match default processor $conf_processor"
4180         unless $processor eq $conf_processor;
4181
4182     }
4183
4184
4185   } else { # didn't specify a paynum, so look for agent gateway overrides
4186            # like a normal transaction
4187
4188     my $cardtype;
4189     if ( $method eq 'CC' ) {
4190       $cardtype = cardtype($self->payinfo);
4191     } elsif ( $method eq 'ECHECK' ) {
4192       $cardtype = 'ACH';
4193     } else {
4194       $cardtype = $method;
4195     }
4196     my $override =
4197            qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4198                                                cardtype => $cardtype,
4199                                                taxclass => '',              } )
4200         || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4201                                                cardtype => '',
4202                                                taxclass => '',              } );
4203
4204     if ( $override ) { #use a payment gateway override
4205
4206       my $payment_gateway = $override->payment_gateway;
4207
4208       $processor   = $payment_gateway->gateway_module;
4209       $login       = $payment_gateway->gateway_username;
4210       $password    = $payment_gateway->gateway_password;
4211       #$action      = $payment_gateway->gateway_action;
4212       @bop_options = $payment_gateway->options;
4213
4214     } else { #use the standard settings from the config
4215
4216       my $unused_action;
4217       ( $processor, $login, $password, $unused_action, @bop_options ) =
4218         $self->default_payment_gateway($method);
4219
4220     }
4221
4222   }
4223   return "neither amount nor paynum specified" unless $amount;
4224
4225   my %content = (
4226     'type'           => $method,
4227     'login'          => $login,
4228     'password'       => $password,
4229     'order_number'   => $order_number,
4230     'amount'         => $amount,
4231     'referer'        => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4232   );
4233   $content{authorization} = $auth
4234     if length($auth); #echeck/ACH transactions have an order # but no auth
4235                       #(at least with authorize.net)
4236
4237   my $disable_void_after;
4238   if ($conf->exists('disable_void_after')
4239       && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4240     $disable_void_after = $1;
4241   }
4242
4243   #first try void if applicable
4244   if ( $cust_pay && $cust_pay->paid == $amount
4245     && (
4246       ( not defined($disable_void_after) )
4247       || ( time < ($cust_pay->_date + $disable_void_after ) )
4248     )
4249   ) {
4250     warn "  attempting void\n" if $DEBUG > 1;
4251     my $void = new Business::OnlinePayment( $processor, @bop_options );
4252     $void->content( 'action' => 'void', %content );
4253     $void->submit();
4254     if ( $void->is_success ) {
4255       my $error = $cust_pay->void($options{'reason'});
4256       if ( $error ) {
4257         # gah, even with transactions.
4258         my $e = 'WARNING: Card/ACH voided but database not updated - '.
4259                 "error voiding payment: $error";
4260         warn $e;
4261         return $e;
4262       }
4263       warn "  void successful\n" if $DEBUG > 1;
4264       return '';
4265     }
4266   }
4267
4268   warn "  void unsuccessful, trying refund\n"
4269     if $DEBUG > 1;
4270
4271   #massage data
4272   my $address = $self->address1;
4273   $address .= ", ". $self->address2 if $self->address2;
4274
4275   my($payname, $payfirst, $paylast);
4276   if ( $self->payname && $method ne 'ECHECK' ) {
4277     $payname = $self->payname;
4278     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4279       or return "Illegal payname $payname";
4280     ($payfirst, $paylast) = ($1, $2);
4281   } else {
4282     $payfirst = $self->getfield('first');
4283     $paylast = $self->getfield('last');
4284     $payname =  "$payfirst $paylast";
4285   }
4286
4287   my @invoicing_list = $self->invoicing_list_emailonly;
4288   if ( $conf->exists('emailinvoiceautoalways')
4289        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4290        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4291     push @invoicing_list, $self->all_emails;
4292   }
4293
4294   my $email = ($conf->exists('business-onlinepayment-email-override'))
4295               ? $conf->config('business-onlinepayment-email-override')
4296               : $invoicing_list[0];
4297
4298   my $payip = exists($options{'payip'})
4299                 ? $options{'payip'}
4300                 : $self->payip;
4301   $content{customer_ip} = $payip
4302     if length($payip);
4303
4304   my $payinfo = '';
4305   if ( $method eq 'CC' ) {
4306
4307     if ( $cust_pay ) {
4308       $content{card_number} = $payinfo = $cust_pay->payinfo;
4309       (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4310         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4311         ($content{expiration} = "$2/$1");  # where available
4312     } else {
4313       $content{card_number} = $payinfo = $self->payinfo;
4314       (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4315         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4316       $content{expiration} = "$2/$1";
4317     }
4318
4319   } elsif ( $method eq 'ECHECK' ) {
4320
4321     if ( $cust_pay ) {
4322       $payinfo = $cust_pay->payinfo;
4323     } else {
4324       $payinfo = $self->payinfo;
4325     }
4326     ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4327     $content{bank_name} = $self->payname;
4328     $content{account_type} = 'CHECKING';
4329     $content{account_name} = $payname;
4330     $content{customer_org} = $self->company ? 'B' : 'I';
4331     $content{customer_ssn} = $self->ss;
4332   } elsif ( $method eq 'LEC' ) {
4333     $content{phone} = $payinfo = $self->payinfo;
4334   }
4335
4336   #then try refund
4337   my $refund = new Business::OnlinePayment( $processor, @bop_options );
4338   my %sub_content = $refund->content(
4339     'action'         => 'credit',
4340     'customer_id'    => $self->custnum,
4341     'last_name'      => $paylast,
4342     'first_name'     => $payfirst,
4343     'name'           => $payname,
4344     'address'        => $address,
4345     'city'           => $self->city,
4346     'state'          => $self->state,
4347     'zip'            => $self->zip,
4348     'country'        => $self->country,
4349     'email'          => $email,
4350     'phone'          => $self->daytime || $self->night,
4351     %content, #after
4352   );
4353   warn join('', map { "  $_ => $sub_content{$_}\n" } keys %sub_content )
4354     if $DEBUG > 1;
4355   $refund->submit();
4356
4357   return "$processor error: ". $refund->error_message
4358     unless $refund->is_success();
4359
4360   my %method2payby = (
4361     'CC'     => 'CARD',
4362     'ECHECK' => 'CHEK',
4363     'LEC'    => 'LECB',
4364   );
4365
4366   my $paybatch = "$processor:". $refund->authorization;
4367   $paybatch .= ':'. $refund->order_number
4368     if $refund->can('order_number') && $refund->order_number;
4369
4370   while ( $cust_pay && $cust_pay->unapplied < $amount ) {
4371     my @cust_bill_pay = $cust_pay->cust_bill_pay;
4372     last unless @cust_bill_pay;
4373     my $cust_bill_pay = pop @cust_bill_pay;
4374     my $error = $cust_bill_pay->delete;
4375     last if $error;
4376   }
4377
4378   my $cust_refund = new FS::cust_refund ( {
4379     'custnum'  => $self->custnum,
4380     'paynum'   => $options{'paynum'},
4381     'refund'   => $amount,
4382     '_date'    => '',
4383     'payby'    => $method2payby{$method},
4384     'payinfo'  => $payinfo,
4385     'paybatch' => $paybatch,
4386     'reason'   => $options{'reason'} || 'card or ACH refund',
4387   } );
4388   my $error = $cust_refund->insert;
4389   if ( $error ) {
4390     $cust_refund->paynum(''); #try again with no specific paynum
4391     my $error2 = $cust_refund->insert;
4392     if ( $error2 ) {
4393       # gah, even with transactions.
4394       my $e = 'WARNING: Card/ACH refunded but database not updated - '.
4395               "error inserting refund ($processor): $error2".
4396               " (previously tried insert with paynum #$options{'paynum'}" .
4397               ": $error )";
4398       warn $e;
4399       return $e;
4400     }
4401   }
4402
4403   ''; #no error
4404
4405 }
4406
4407 # does the configuration indicate the new bop routines are required?
4408
4409 sub _new_bop_required {
4410   my $self = shift;
4411
4412   my $botpp = 'Business::OnlineThirdPartyPayment';
4413
4414   return 1
4415     if ( $conf->config('business-onlinepayment-namespace') eq $botpp ||
4416          scalar( grep { $_->gateway_namespace eq $botpp }
4417                  qsearch( 'payment_gateway', { 'disabled' => '' } )
4418                )
4419        )
4420   ;
4421
4422   '';
4423 }
4424
4425
4426 =item realtime_collect [ OPTION => VALUE ... ]
4427
4428 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4429 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
4430 gateway.  See L<http://420.am/business-onlinepayment> and
4431 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
4432
4433 On failure returns an error message.
4434
4435 Returns false or a hashref upon success.  The hashref contains keys popup_url reference, and collectitems.  The first is a URL to which a browser should be redirected for completion of collection.  The second is a reference id for the transaction suitable for the end user.  The collectitems is a reference to a list of name value pairs suitable for assigning to a html form and posted to popup_url.
4436
4437 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
4438
4439 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>.  If none is specified
4440 then it is deduced from the customer record.
4441
4442 If no I<amount> is specified, then the customer balance is used.
4443
4444 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4445 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
4446 if set, will override the value from the customer record.
4447
4448 I<description> is a free-text field passed to the gateway.  It defaults to
4449 "Internet services".
4450
4451 If an I<invnum> is specified, this payment (if successful) is applied to the
4452 specified invoice.  If you don't specify an I<invnum> you might want to
4453 call the B<apply_payments> method.
4454
4455 I<quiet> can be set true to surpress email decline notices.
4456
4457 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
4458 resulting paynum, if any.
4459
4460 I<payunique> is a unique identifier for this payment.
4461
4462 I<session_id> is a session identifier associated with this payment.
4463
4464 I<depend_jobnum> allows payment capture to unlock export jobs
4465
4466 =cut
4467
4468 sub realtime_collect {
4469   my( $self, %options ) = @_;
4470
4471   if ( $DEBUG ) {
4472     warn "$me realtime_collect:\n";
4473     warn "  $_ => $options{$_}\n" foreach keys %options;
4474   }
4475
4476   $options{amount} = $self->balance unless exists( $options{amount} );
4477   $options{method} = FS::payby->payby2bop($self->payby)
4478     unless exists( $options{method} );
4479
4480   return $self->realtime_bop({%options});
4481
4482 }
4483
4484 =item _realtime_bop { [ ARG => VALUE ... ] }
4485
4486 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4487 via a Business::OnlinePayment realtime gateway.  See
4488 L<http://420.am/business-onlinepayment> for supported gateways.
4489
4490 Required arguments in the hashref are I<method>, and I<amount>
4491
4492 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4493
4494 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
4495
4496 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4497 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
4498 if set, will override the value from the customer record.
4499
4500 I<description> is a free-text field passed to the gateway.  It defaults to
4501 "Internet services".
4502
4503 If an I<invnum> is specified, this payment (if successful) is applied to the
4504 specified invoice.  If you don't specify an I<invnum> you might want to
4505 call the B<apply_payments> method.
4506
4507 I<quiet> can be set true to surpress email decline notices.
4508
4509 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
4510 resulting paynum, if any.
4511
4512 I<payunique> is a unique identifier for this payment.
4513
4514 I<session_id> is a session identifier associated with this payment.
4515
4516 I<depend_jobnum> allows payment capture to unlock export jobs
4517
4518 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
4519
4520 =cut
4521
4522 # some helper routines
4523 sub _payment_gateway {
4524   my ($self, $options) = @_;
4525
4526   $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
4527     unless exists($options->{payment_gateway});
4528
4529   $options->{payment_gateway};
4530 }
4531
4532 sub _bop_auth {
4533   my ($self, $options) = @_;
4534
4535   (
4536     'login'    => $options->{payment_gateway}->gateway_username,
4537     'password' => $options->{payment_gateway}->gateway_password,
4538   );
4539 }
4540
4541 sub _bop_options {
4542   my ($self, $options) = @_;
4543
4544   $options->{payment_gateway}->gatewaynum
4545     ? $options->{payment_gateway}->options
4546     : @{ $options->{payment_gateway}->get('options') };
4547 }
4548
4549 sub _bop_defaults {
4550   my ($self, $options) = @_;
4551
4552   $options->{description} ||= 'Internet services';
4553   $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
4554   $options->{invnum} ||= '';
4555   $options->{payname} = $self->payname unless exists( $options->{payname} );
4556 }
4557
4558 sub _bop_content {
4559   my ($self, $options) = @_;
4560   my %content = ();
4561
4562   $content{address} = exists($options->{'address1'})
4563                         ? $options->{'address1'}
4564                         : $self->address1;
4565   my $address2 = exists($options->{'address2'})
4566                    ? $options->{'address2'}
4567                    : $self->address2;
4568   $content{address} .= ", ". $address2 if length($address2);
4569
4570   my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
4571   $content{customer_ip} = $payip if length($payip);
4572
4573   $content{invoice_number} = $options->{'invnum'}
4574     if exists($options->{'invnum'}) && length($options->{'invnum'});
4575
4576   $content{email_customer} =
4577     (    $conf->exists('business-onlinepayment-email_customer')
4578       || $conf->exists('business-onlinepayment-email-override') );
4579
4580   $content{payfirst} = $self->getfield('first');
4581   $content{paylast} = $self->getfield('last');
4582
4583   $content{account_name} = "$content{payfirst} $content{paylast}"
4584     if $options->{method} eq 'ECHECK';
4585
4586   $content{name} = $options->{payname};
4587   $content{name} = $content{account_name} if exists($content{account_name});
4588
4589   $content{city} = exists($options->{city})
4590                      ? $options->{city}
4591                      : $self->city;
4592   $content{state} = exists($options->{state})
4593                       ? $options->{state}
4594                       : $self->state;
4595   $content{zip} = exists($options->{zip})
4596                     ? $options->{'zip'}
4597                     : $self->zip;
4598   $content{country} = exists($options->{country})
4599                         ? $options->{country}
4600                         : $self->country;
4601   $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
4602   $content{phone} = $self->daytime || $self->night;
4603
4604   (%content);
4605 }
4606
4607 my %bop_method2payby = (
4608   'CC'     => 'CARD',
4609   'ECHECK' => 'CHEK',
4610   'LEC'    => 'LECB',
4611 );
4612
4613 sub _new_realtime_bop {
4614   my $self = shift;
4615
4616   my %options = ();
4617   if (ref($_[0]) eq 'HASH') {
4618     %options = %{$_[0]};
4619   } else {
4620     my ( $method, $amount ) = ( shift, shift );
4621     %options = @_;
4622     $options{method} = $method;
4623     $options{amount} = $amount;
4624   }
4625
4626   if ( $DEBUG ) {
4627     warn "$me realtime_bop (new): $options{method} $options{amount}\n";
4628     warn "  $_ => $options{$_}\n" foreach keys %options;
4629   }
4630
4631   return $self->fake_bop(%options) if $options{'fake'};
4632
4633   $self->_bop_defaults(\%options);
4634
4635   ###
4636   # set trans_is_recur based on invnum if there is one
4637   ###
4638
4639   my $trans_is_recur = 0;
4640   if ( $options{'invnum'} ) {
4641
4642     my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4643     die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4644
4645     my @part_pkg =
4646       map  { $_->part_pkg }
4647       grep { $_ }
4648       map  { $_->cust_pkg }
4649       $cust_bill->cust_bill_pkg;
4650
4651     $trans_is_recur = 1
4652       if grep { $_->freq ne '0' } @part_pkg;
4653
4654   }
4655
4656   ###
4657   # select a gateway
4658   ###
4659
4660   my $payment_gateway =  $self->_payment_gateway( \%options );
4661   my $namespace = $payment_gateway->gateway_namespace;
4662
4663   eval "use $namespace";
4664   die $@ if $@;
4665
4666   ###
4667   # check for banned credit card/ACH
4668   ###
4669
4670   my $ban = qsearchs('banned_pay', {
4671     'payby'   => $bop_method2payby{$options{method}},
4672     'payinfo' => md5_base64($options{payinfo}),
4673   } );
4674   return "Banned credit card" if $ban;
4675
4676   ###
4677   # massage data
4678   ###
4679
4680   my (%bop_content) = $self->_bop_content(\%options);
4681
4682   if ( $options{method} ne 'ECHECK' ) {
4683     $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4684       or return "Illegal payname $options{payname}";
4685     ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
4686   }
4687
4688   my @invoicing_list = $self->invoicing_list_emailonly;
4689   if ( $conf->exists('emailinvoiceautoalways')
4690        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4691        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4692     push @invoicing_list, $self->all_emails;
4693   }
4694
4695   my $email = ($conf->exists('business-onlinepayment-email-override'))
4696               ? $conf->config('business-onlinepayment-email-override')
4697               : $invoicing_list[0];
4698
4699   my $paydate = '';
4700   my %content = ();
4701   if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
4702
4703     $content{card_number} = $options{payinfo};
4704     $paydate = exists($options{'paydate'})
4705                     ? $options{'paydate'}
4706                     : $self->paydate;
4707     $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4708     $content{expiration} = "$2/$1";
4709
4710     my $paycvv = exists($options{'paycvv'})
4711                    ? $options{'paycvv'}
4712                    : $self->paycvv;
4713     $content{cvv2} = $paycvv
4714       if length($paycvv);
4715
4716     my $paystart_month = exists($options{'paystart_month'})
4717                            ? $options{'paystart_month'}
4718                            : $self->paystart_month;
4719
4720     my $paystart_year  = exists($options{'paystart_year'})
4721                            ? $options{'paystart_year'}
4722                            : $self->paystart_year;
4723
4724     $content{card_start} = "$paystart_month/$paystart_year"
4725       if $paystart_month && $paystart_year;
4726
4727     my $payissue       = exists($options{'payissue'})
4728                            ? $options{'payissue'}
4729                            : $self->payissue;
4730     $content{issue_number} = $payissue if $payissue;
4731
4732     if ( $self->_bop_recurring_billing( 'payinfo'        => $options{'payinfo'},
4733                                         'trans_is_recur' => $trans_is_recur,
4734                                       )
4735        )
4736     {
4737       $content{recurring_billing} = 'YES';
4738       $content{acct_code} = 'rebill'
4739         if $conf->exists('credit_card-recurring_billing_acct_code');
4740     }
4741
4742   } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
4743     ( $content{account_number}, $content{routing_code} ) =
4744       split('@', $options{payinfo});
4745     $content{bank_name} = $options{payname};
4746     $content{bank_state} = exists($options{'paystate'})
4747                              ? $options{'paystate'}
4748                              : $self->getfield('paystate');
4749     $content{account_type} = exists($options{'paytype'})
4750                                ? uc($options{'paytype'}) || 'CHECKING'
4751                                : uc($self->getfield('paytype')) || 'CHECKING';
4752     $content{customer_org} = $self->company ? 'B' : 'I';
4753     $content{state_id}       = exists($options{'stateid'})
4754                                  ? $options{'stateid'}
4755                                  : $self->getfield('stateid');
4756     $content{state_id_state} = exists($options{'stateid_state'})
4757                                  ? $options{'stateid_state'}
4758                                  : $self->getfield('stateid_state');
4759     $content{customer_ssn} = exists($options{'ss'})
4760                                ? $options{'ss'}
4761                                : $self->ss;
4762   } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
4763     $content{phone} = $options{payinfo};
4764   } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
4765     #move along
4766   } else {
4767     #die an evil death
4768   }
4769
4770   ###
4771   # run transaction(s)
4772   ###
4773
4774   my $balance = exists( $options{'balance'} )
4775                   ? $options{'balance'}
4776                   : $self->balance;
4777
4778   $self->select_for_update; #mutex ... just until we get our pending record in
4779
4780   #the checks here are intended to catch concurrent payments
4781   #double-form-submission prevention is taken care of in cust_pay_pending::check
4782
4783   #check the balance
4784   return "The customer's balance has changed; $options{method} transaction aborted."
4785     if $self->balance < $balance;
4786     #&& $self->balance < $options{amount}; #might as well anyway?
4787
4788   #also check and make sure there aren't *other* pending payments for this cust
4789
4790   my @pending = qsearch('cust_pay_pending', {
4791     'custnum' => $self->custnum,
4792     'status'  => { op=>'!=', value=>'done' }
4793   });
4794   return "A payment is already being processed for this customer (".
4795          join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4796          "); $options{method} transaction aborted."
4797     if scalar(@pending);
4798
4799   #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4800
4801   my $cust_pay_pending = new FS::cust_pay_pending {
4802     'custnum'           => $self->custnum,
4803     #'invnum'            => $options{'invnum'},
4804     'paid'              => $options{amount},
4805     '_date'             => '',
4806     'payby'             => $bop_method2payby{$options{method}},
4807     'payinfo'           => $options{payinfo},
4808     'paydate'           => $paydate,
4809     'recurring_billing' => $content{recurring_billing},
4810     'status'            => 'new',
4811     'gatewaynum'        => $payment_gateway->gatewaynum || '',
4812     'session_id'        => $options{session_id} || '',
4813     'jobnum'            => $options{depend_jobnum} || '',
4814   };
4815   $cust_pay_pending->payunique( $options{payunique} )
4816     if defined($options{payunique}) && length($options{payunique});
4817   my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4818   return $cpp_new_err if $cpp_new_err;
4819
4820   my( $action1, $action2 ) =
4821     split( /\s*\,\s*/, $payment_gateway->gateway_action );
4822
4823   my $transaction = new $namespace( $payment_gateway->gateway_module,
4824                                     $self->_bop_options(\%options),
4825                                   );
4826
4827   $transaction->content(
4828     'type'           => $options{method},
4829     $self->_bop_auth(\%options),
4830     'action'         => $action1,
4831     'description'    => $options{'description'},
4832     'amount'         => $options{amount},
4833     #'invoice_number' => $options{'invnum'},
4834     'customer_id'    => $self->custnum,
4835     %bop_content,
4836     'reference'      => $cust_pay_pending->paypendingnum, #for now
4837     'email'          => $email,
4838     %content, #after
4839   );
4840
4841   $cust_pay_pending->status('pending');
4842   my $cpp_pending_err = $cust_pay_pending->replace;
4843   return $cpp_pending_err if $cpp_pending_err;
4844
4845   #config?
4846   my $BOP_TESTING = 0;
4847   my $BOP_TESTING_SUCCESS = 1;
4848
4849   unless ( $BOP_TESTING ) {
4850     $transaction->submit();
4851   } else {
4852     if ( $BOP_TESTING_SUCCESS ) {
4853       $transaction->is_success(1);
4854       $transaction->authorization('fake auth');
4855     } else {
4856       $transaction->is_success(0);
4857       $transaction->error_message('fake failure');
4858     }
4859   }
4860
4861   if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
4862
4863     return { reference => $cust_pay_pending->paypendingnum,
4864              map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
4865
4866   } elsif ( $transaction->is_success() && $action2 ) {
4867
4868     $cust_pay_pending->status('authorized');
4869     my $cpp_authorized_err = $cust_pay_pending->replace;
4870     return $cpp_authorized_err if $cpp_authorized_err;
4871
4872     my $auth = $transaction->authorization;
4873     my $ordernum = $transaction->can('order_number')
4874                    ? $transaction->order_number
4875                    : '';
4876
4877     my $capture =
4878       new Business::OnlinePayment( $payment_gateway->gateway_module,
4879                                    $self->_bop_options(\%options),
4880                                  );
4881
4882     my %capture = (
4883       %content,
4884       type           => $options{method},
4885       action         => $action2,
4886       $self->_bop_auth(\%options),
4887       order_number   => $ordernum,
4888       amount         => $options{amount},
4889       authorization  => $auth,
4890       description    => $options{'description'},
4891     );
4892
4893     foreach my $field (qw( authorization_source_code returned_ACI
4894                            transaction_identifier validation_code
4895                            transaction_sequence_num local_transaction_date
4896                            local_transaction_time AVS_result_code          )) {
4897       $capture{$field} = $transaction->$field() if $transaction->can($field);
4898     }
4899
4900     $capture->content( %capture );
4901
4902     $capture->submit();
4903
4904     unless ( $capture->is_success ) {
4905       my $e = "Authorization successful but capture failed, custnum #".
4906               $self->custnum. ': '.  $capture->result_code.
4907               ": ". $capture->error_message;
4908       warn $e;
4909       return $e;
4910     }
4911
4912   }
4913
4914   ###
4915   # remove paycvv after initial transaction
4916   ###
4917
4918   #false laziness w/misc/process/payment.cgi - check both to make sure working
4919   # correctly
4920   if ( defined $self->dbdef_table->column('paycvv')
4921        && length($self->paycvv)
4922        && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
4923   ) {
4924     my $error = $self->remove_cvv;
4925     if ( $error ) {
4926       warn "WARNING: error removing cvv: $error\n";
4927     }
4928   }
4929
4930   ###
4931   # result handling
4932   ###
4933
4934   $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
4935
4936 }
4937
4938 =item fake_bop
4939
4940 =cut
4941
4942 sub fake_bop {
4943   my $self = shift;
4944
4945   my %options = ();
4946   if (ref($_[0]) eq 'HASH') {
4947     %options = %{$_[0]};
4948   } else {
4949     my ( $method, $amount ) = ( shift, shift );
4950     %options = @_;
4951     $options{method} = $method;
4952     $options{amount} = $amount;
4953   }
4954
4955   if ( $options{'fake_failure'} ) {
4956      return "Error: No error; test failure requested with fake_failure";
4957   }
4958
4959   #my $paybatch = '';
4960   #if ( $payment_gateway->gatewaynum ) { # agent override
4961   #  $paybatch = $payment_gateway->gatewaynum. '-';
4962   #}
4963   #
4964   #$paybatch .= "$processor:". $transaction->authorization;
4965   #
4966   #$paybatch .= ':'. $transaction->order_number
4967   #  if $transaction->can('order_number')
4968   #  && length($transaction->order_number);
4969
4970   my $paybatch = 'FakeProcessor:54:32';
4971
4972   my $cust_pay = new FS::cust_pay ( {
4973      'custnum'  => $self->custnum,
4974      'invnum'   => $options{'invnum'},
4975      'paid'     => $options{amount},
4976      '_date'    => '',
4977      'payby'    => $bop_method2payby{$options{method}},
4978      #'payinfo'  => $payinfo,
4979      'payinfo'  => '4111111111111111',
4980      'paybatch' => $paybatch,
4981      #'paydate'  => $paydate,
4982      'paydate'  => '2012-05-01',
4983   } );
4984   $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
4985
4986   my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4987
4988   if ( $error ) {
4989     $cust_pay->invnum(''); #try again with no specific invnum
4990     my $error2 = $cust_pay->insert( $options{'manual'} ?
4991                                     ( 'manual' => 1 ) : ()
4992                                   );
4993     if ( $error2 ) {
4994       # gah, even with transactions.
4995       my $e = 'WARNING: Card/ACH debited but database not updated - '.
4996               "error inserting (fake!) payment: $error2".
4997               " (previously tried insert with invnum #$options{'invnum'}" .
4998               ": $error )";
4999       warn $e;
5000       return $e;
5001     }
5002   }
5003
5004   if ( $options{'paynum_ref'} ) {
5005     ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5006   }
5007
5008   return ''; #no error
5009
5010 }
5011
5012
5013 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5014 #
5015 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5016 # phone bill transaction.
5017
5018 sub _realtime_bop_result {
5019   my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5020   if ( $DEBUG ) {
5021     warn "$me _realtime_bop_result: pending transaction ".
5022       $cust_pay_pending->paypendingnum. "\n";
5023     warn "  $_ => $options{$_}\n" foreach keys %options;
5024   }
5025
5026   my $payment_gateway = $options{payment_gateway}
5027     or return "no payment gateway in arguments to _realtime_bop_result";
5028
5029   $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5030   my $cpp_captured_err = $cust_pay_pending->replace;
5031   return $cpp_captured_err if $cpp_captured_err;
5032
5033   if ( $transaction->is_success() ) {
5034
5035     my $paybatch = '';
5036     if ( $payment_gateway->gatewaynum ) { # agent override
5037       $paybatch = $payment_gateway->gatewaynum. '-';
5038     }
5039
5040     $paybatch .= $payment_gateway->gateway_module. ":".
5041       $transaction->authorization;
5042
5043     $paybatch .= ':'. $transaction->order_number
5044       if $transaction->can('order_number')
5045       && length($transaction->order_number);
5046
5047     my $cust_pay = new FS::cust_pay ( {
5048        'custnum'  => $self->custnum,
5049        'invnum'   => $options{'invnum'},
5050        'paid'     => $cust_pay_pending->paid,
5051        '_date'    => '',
5052        'payby'    => $cust_pay_pending->payby,
5053        #'payinfo'  => $payinfo,
5054        'paybatch' => $paybatch,
5055        'paydate'  => $cust_pay_pending->paydate,
5056     } );
5057     #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5058     $cust_pay->payunique( $options{payunique} )
5059       if defined($options{payunique}) && length($options{payunique});
5060
5061     my $oldAutoCommit = $FS::UID::AutoCommit;
5062     local $FS::UID::AutoCommit = 0;
5063     my $dbh = dbh;
5064
5065     #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5066
5067     my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5068
5069     if ( $error ) {
5070       $cust_pay->invnum(''); #try again with no specific invnum
5071       my $error2 = $cust_pay->insert( $options{'manual'} ?
5072                                       ( 'manual' => 1 ) : ()
5073                                     );
5074       if ( $error2 ) {
5075         # gah.  but at least we have a record of the state we had to abort in
5076         # from cust_pay_pending now.
5077         my $e = "WARNING: $options{method} captured but payment not recorded -".
5078                 " error inserting payment (". $payment_gateway->gateway_module.
5079                 "): $error2".
5080                 " (previously tried insert with invnum #$options{'invnum'}" .
5081                 ": $error ) - pending payment saved as paypendingnum ".
5082                 $cust_pay_pending->paypendingnum. "\n";
5083         warn $e;
5084         return $e;
5085       }
5086     }
5087
5088     my $jobnum = $cust_pay_pending->jobnum;
5089     if ( $jobnum ) {
5090        my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5091
5092        unless ( $placeholder ) {
5093          $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5094          my $e = "WARNING: $options{method} captured but job $jobnum not ".
5095              "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5096          warn $e;
5097          return $e;
5098        }
5099
5100        $error = $placeholder->delete;
5101
5102        if ( $error ) {
5103          $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5104          my $e = "WARNING: $options{method} captured but could not delete ".
5105               "job $jobnum for paypendingnum ".
5106               $cust_pay_pending->paypendingnum. ": $error\n";
5107          warn $e;
5108          return $e;
5109        }
5110
5111     }
5112
5113     if ( $options{'paynum_ref'} ) {
5114       ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5115     }
5116
5117     $cust_pay_pending->status('done');
5118     $cust_pay_pending->statustext('captured');
5119     $cust_pay_pending->paynum($cust_pay->paynum);
5120     my $cpp_done_err = $cust_pay_pending->replace;
5121
5122     if ( $cpp_done_err ) {
5123
5124       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5125       my $e = "WARNING: $options{method} captured but payment not recorded - ".
5126               "error updating status for paypendingnum ".
5127               $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5128       warn $e;
5129       return $e;
5130
5131     } else {
5132
5133       $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5134       return ''; #no error
5135
5136     }
5137
5138   } else {
5139
5140     my $perror = $payment_gateway->gateway_module. " error: ".
5141       $transaction->error_message;
5142
5143     my $jobnum = $cust_pay_pending->jobnum;
5144     if ( $jobnum ) {
5145        my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5146
5147        if ( $placeholder ) {
5148          my $error = $placeholder->depended_delete;
5149          $error ||= $placeholder->delete;
5150          warn "error removing provisioning jobs after declined paypendingnum ".
5151            $cust_pay_pending->paypendingnum. "\n";
5152        } else {
5153          my $e = "error finding job $jobnum for declined paypendingnum ".
5154               $cust_pay_pending->paypendingnum. "\n";
5155          warn $e;
5156        }
5157
5158     }
5159
5160     unless ( $transaction->error_message ) {
5161
5162       my $t_response;
5163       if ( $transaction->can('response_page') ) {
5164         $t_response = {
5165                         'page'    => ( $transaction->can('response_page')
5166                                          ? $transaction->response_page
5167                                          : ''
5168                                      ),
5169                         'code'    => ( $transaction->can('response_code')
5170                                          ? $transaction->response_code
5171                                          : ''
5172                                      ),
5173                         'headers' => ( $transaction->can('response_headers')
5174                                          ? $transaction->response_headers
5175                                          : ''
5176                                      ),
5177                       };
5178       } else {
5179         $t_response .=
5180           "No additional debugging information available for ".
5181             $payment_gateway->gateway_module;
5182       }
5183
5184       $perror .= "No error_message returned from ".
5185                    $payment_gateway->gateway_module. " -- ".
5186                  ( ref($t_response) ? Dumper($t_response) : $t_response );
5187
5188     }
5189
5190     if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5191          && $conf->exists('emaildecline')
5192          && grep { $_ ne 'POST' } $self->invoicing_list
5193          && ! grep { $transaction->error_message =~ /$_/ }
5194                    $conf->config('emaildecline-exclude')
5195     ) {
5196       my @templ = $conf->config('declinetemplate');
5197       my $template = new Text::Template (
5198         TYPE   => 'ARRAY',
5199         SOURCE => [ map "$_\n", @templ ],
5200       ) or return "($perror) can't create template: $Text::Template::ERROR";
5201       $template->compile()
5202         or return "($perror) can't compile template: $Text::Template::ERROR";
5203
5204       my $templ_hash = { error => $transaction->error_message };
5205
5206       my $error = send_email(
5207         'from'    => $conf->config('invoice_from', $self->agentnum ),
5208         'to'      => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5209         'subject' => 'Your payment could not be processed',
5210         'body'    => [ $template->fill_in(HASH => $templ_hash) ],
5211       );
5212
5213       $perror .= " (also received error sending decline notification: $error)"
5214         if $error;
5215
5216     }
5217
5218     $cust_pay_pending->status('done');
5219     $cust_pay_pending->statustext("declined: $perror");
5220     my $cpp_done_err = $cust_pay_pending->replace;
5221     if ( $cpp_done_err ) {
5222       my $e = "WARNING: $options{method} declined but pending payment not ".
5223               "resolved - error updating status for paypendingnum ".
5224               $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5225       warn $e;
5226       $perror = "$e ($perror)";
5227     }
5228
5229     return $perror;
5230   }
5231
5232 }
5233
5234 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5235
5236 Verifies successful third party processing of a realtime credit card,
5237 ACH (electronic check) or phone bill transaction via a
5238 Business::OnlineThirdPartyPayment realtime gateway.  See
5239 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5240
5241 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5242
5243 The additional options I<payname>, I<city>, I<state>,
5244 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
5245 if set, will override the value from the customer record.
5246
5247 I<description> is a free-text field passed to the gateway.  It defaults to
5248 "Internet services".
5249
5250 If an I<invnum> is specified, this payment (if successful) is applied to the
5251 specified invoice.  If you don't specify an I<invnum> you might want to
5252 call the B<apply_payments> method.
5253
5254 I<quiet> can be set true to surpress email decline notices.
5255
5256 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
5257 resulting paynum, if any.
5258
5259 I<payunique> is a unique identifier for this payment.
5260
5261 Returns a hashref containing elements bill_error (which will be undefined
5262 upon success) and session_id of any associated session.
5263
5264 =cut
5265
5266 sub realtime_botpp_capture {
5267   my( $self, $cust_pay_pending, %options ) = @_;
5268   if ( $DEBUG ) {
5269     warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5270     warn "  $_ => $options{$_}\n" foreach keys %options;
5271   }
5272
5273   eval "use Business::OnlineThirdPartyPayment";
5274   die $@ if $@;
5275
5276   ###
5277   # select the gateway
5278   ###
5279
5280   my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5281
5282   my $payment_gateway = $cust_pay_pending->gatewaynum
5283     ? qsearchs( 'payment_gateway',
5284                 { gatewaynum => $cust_pay_pending->gatewaynum }
5285               )
5286     : $self->agent->payment_gateway( 'method' => $method,
5287                                      # 'invnum'  => $cust_pay_pending->invnum,
5288                                      # 'payinfo' => $cust_pay_pending->payinfo,
5289                                    );
5290
5291   $options{payment_gateway} = $payment_gateway; # for the helper subs
5292
5293   ###
5294   # massage data
5295   ###
5296
5297   my @invoicing_list = $self->invoicing_list_emailonly;
5298   if ( $conf->exists('emailinvoiceautoalways')
5299        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5300        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5301     push @invoicing_list, $self->all_emails;
5302   }
5303
5304   my $email = ($conf->exists('business-onlinepayment-email-override'))
5305               ? $conf->config('business-onlinepayment-email-override')
5306               : $invoicing_list[0];
5307
5308   my %content = ();
5309
5310   $content{email_customer} =
5311     (    $conf->exists('business-onlinepayment-email_customer')
5312       || $conf->exists('business-onlinepayment-email-override') );
5313
5314   ###
5315   # run transaction(s)
5316   ###
5317
5318   my $transaction =
5319     new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5320                                            $self->_bop_options(\%options),
5321                                          );
5322
5323   $transaction->reference({ %options });
5324
5325   $transaction->content(
5326     'type'           => $method,
5327     $self->_bop_auth(\%options),
5328     'action'         => 'Post Authorization',
5329     'description'    => $options{'description'},
5330     'amount'         => $cust_pay_pending->paid,
5331     #'invoice_number' => $options{'invnum'},
5332     'customer_id'    => $self->custnum,
5333     'referer'        => 'http://cleanwhisker.420.am/',
5334     'reference'      => $cust_pay_pending->paypendingnum,
5335     'email'          => $email,
5336     'phone'          => $self->daytime || $self->night,
5337     %content, #after
5338     # plus whatever is required for bogus capture avoidance
5339   );
5340
5341   $transaction->submit();
5342
5343   my $error =
5344     $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5345
5346   {
5347     bill_error => $error,
5348     session_id => $cust_pay_pending->session_id,
5349   }
5350
5351 }
5352
5353 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
5354
5355 =cut
5356
5357 sub default_payment_gateway {
5358   my( $self, $method ) = @_;
5359
5360   die "Real-time processing not enabled\n"
5361     unless $conf->exists('business-onlinepayment');
5362
5363   #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
5364
5365   #load up config
5366   my $bop_config = 'business-onlinepayment';
5367   $bop_config .= '-ach'
5368     if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
5369   my ( $processor, $login, $password, $action, @bop_options ) =
5370     $conf->config($bop_config);
5371   $action ||= 'normal authorization';
5372   pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
5373   die "No real-time processor is enabled - ".
5374       "did you set the business-onlinepayment configuration value?\n"
5375     unless $processor;
5376
5377   ( $processor, $login, $password, $action, @bop_options )
5378 }
5379
5380 =item remove_cvv
5381
5382 Removes the I<paycvv> field from the database directly.
5383
5384 If there is an error, returns the error, otherwise returns false.
5385
5386 =cut
5387
5388 sub remove_cvv {
5389   my $self = shift;
5390   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
5391     or return dbh->errstr;
5392   $sth->execute($self->custnum)
5393     or return $sth->errstr;
5394   $self->paycvv('');
5395   '';
5396 }
5397
5398 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
5399
5400 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
5401 via a Business::OnlinePayment realtime gateway.  See
5402 L<http://420.am/business-onlinepayment> for supported gateways.
5403
5404 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5405
5406 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
5407
5408 Most gateways require a reference to an original payment transaction to refund,
5409 so you probably need to specify a I<paynum>.
5410
5411 I<amount> defaults to the original amount of the payment if not specified.
5412
5413 I<reason> specifies a reason for the refund.
5414
5415 I<paydate> specifies the expiration date for a credit card overriding the
5416 value from the customer record or the payment record. Specified as yyyy-mm-dd
5417
5418 Implementation note: If I<amount> is unspecified or equal to the amount of the
5419 orignal payment, first an attempt is made to "void" the transaction via
5420 the gateway (to cancel a not-yet settled transaction) and then if that fails,
5421 the normal attempt is made to "refund" ("credit") the transaction via the
5422 gateway is attempted.
5423
5424 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5425 #I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
5426 #if set, will override the value from the customer record.
5427
5428 #If an I<invnum> is specified, this payment (if successful) is applied to the
5429 #specified invoice.  If you don't specify an I<invnum> you might want to
5430 #call the B<apply_payments> method.
5431
5432 =cut
5433
5434 #some false laziness w/realtime_bop, not enough to make it worth merging
5435 #but some useful small subs should be pulled out
5436 sub _new_realtime_refund_bop {
5437   my $self = shift;
5438
5439   my %options = ();
5440   if (ref($_[0]) ne 'HASH') {
5441     %options = %{$_[0]};
5442   } else {
5443     my $method = shift;
5444     %options = @_;
5445     $options{method} = $method;
5446   }
5447
5448   if ( $DEBUG ) {
5449     warn "$me realtime_refund_bop (new): $options{method} refund\n";
5450     warn "  $_ => $options{$_}\n" foreach keys %options;
5451   }
5452
5453   ###
5454   # look up the original payment and optionally a gateway for that payment
5455   ###
5456
5457   my $cust_pay = '';
5458   my $amount = $options{'amount'};
5459
5460   my( $processor, $login, $password, @bop_options, $namespace ) ;
5461   my( $auth, $order_number ) = ( '', '', '' );
5462
5463   if ( $options{'paynum'} ) {
5464
5465     warn "  paynum: $options{paynum}\n" if $DEBUG > 1;
5466     $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
5467       or return "Unknown paynum $options{'paynum'}";
5468     $amount ||= $cust_pay->paid;
5469
5470     $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
5471       or return "Can't parse paybatch for paynum $options{'paynum'}: ".
5472                 $cust_pay->paybatch;
5473     my $gatewaynum = '';
5474     ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
5475
5476     if ( $gatewaynum ) { #gateway for the payment to be refunded
5477
5478       my $payment_gateway =
5479         qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
5480       die "payment gateway $gatewaynum not found"
5481         unless $payment_gateway;
5482
5483       $processor   = $payment_gateway->gateway_module;
5484       $login       = $payment_gateway->gateway_username;
5485       $password    = $payment_gateway->gateway_password;
5486       $namespace   = $payment_gateway->gateway_namespace;
5487       @bop_options = $payment_gateway->options;
5488
5489     } else { #try the default gateway
5490
5491       my $conf_processor;
5492       my $payment_gateway =
5493         $self->agent->payment_gateway('method' => $options{method});
5494
5495       ( $conf_processor, $login, $password, $namespace ) =
5496         map { my $method = "gateway_$_"; $payment_gateway->$method }
5497           qw( module username password namespace );
5498
5499       @bop_options = $payment_gateway->gatewaynum
5500                        ? $payment_gateway->options
5501                        : @{ $payment_gateway->get('options') };
5502
5503       return "processor of payment $options{'paynum'} $processor does not".
5504              " match default processor $conf_processor"
5505         unless $processor eq $conf_processor;
5506
5507     }
5508
5509
5510   } else { # didn't specify a paynum, so look for agent gateway overrides
5511            # like a normal transaction
5512
5513     my $payment_gateway =
5514       $self->agent->payment_gateway( 'method'  => $options{method},
5515                                      #'payinfo' => $payinfo,
5516                                    );
5517     my( $processor, $login, $password, $namespace ) =
5518       map { my $method = "gateway_$_"; $payment_gateway->$method }
5519         qw( module username password namespace );
5520
5521     my @bop_options = $payment_gateway->gatewaynum
5522                         ? $payment_gateway->options
5523                         : @{ $payment_gateway->get('options') };
5524
5525   }
5526   return "neither amount nor paynum specified" unless $amount;
5527
5528   eval "use $namespace";
5529   die $@ if $@;
5530
5531   my %content = (
5532     'type'           => $options{method},
5533     'login'          => $login,
5534     'password'       => $password,
5535     'order_number'   => $order_number,
5536     'amount'         => $amount,
5537     'referer'        => 'http://cleanwhisker.420.am/', #XXX fix referer :/
5538   );
5539   $content{authorization} = $auth
5540     if length($auth); #echeck/ACH transactions have an order # but no auth
5541                       #(at least with authorize.net)
5542
5543   my $disable_void_after;
5544   if ($conf->exists('disable_void_after')
5545       && $conf->config('disable_void_after') =~ /^(\d+)$/) {
5546     $disable_void_after = $1;
5547   }
5548
5549   #first try void if applicable
5550   if ( $cust_pay && $cust_pay->paid == $amount
5551     && (
5552       ( not defined($disable_void_after) )
5553       || ( time < ($cust_pay->_date + $disable_void_after ) )
5554     )
5555   ) {
5556     warn "  attempting void\n" if $DEBUG > 1;
5557     my $void = new Business::OnlinePayment( $processor, @bop_options );
5558     $void->content( 'action' => 'void', %content );
5559     $void->submit();
5560     if ( $void->is_success ) {
5561       my $error = $cust_pay->void($options{'reason'});
5562       if ( $error ) {
5563         # gah, even with transactions.
5564         my $e = 'WARNING: Card/ACH voided but database not updated - '.
5565                 "error voiding payment: $error";
5566         warn $e;
5567         return $e;
5568       }
5569       warn "  void successful\n" if $DEBUG > 1;
5570       return '';
5571     }
5572   }
5573
5574   warn "  void unsuccessful, trying refund\n"
5575     if $DEBUG > 1;
5576
5577   #massage data
5578   my $address = $self->address1;
5579   $address .= ", ". $self->address2 if $self->address2;
5580
5581   my($payname, $payfirst, $paylast);
5582   if ( $self->payname && $options{method} ne 'ECHECK' ) {
5583     $payname = $self->payname;
5584     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5585       or return "Illegal payname $payname";
5586     ($payfirst, $paylast) = ($1, $2);
5587   } else {
5588     $payfirst = $self->getfield('first');
5589     $paylast = $self->getfield('last');
5590     $payname =  "$payfirst $paylast";
5591   }
5592
5593   my @invoicing_list = $self->invoicing_list_emailonly;
5594   if ( $conf->exists('emailinvoiceautoalways')
5595        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5596        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5597     push @invoicing_list, $self->all_emails;
5598   }
5599
5600   my $email = ($conf->exists('business-onlinepayment-email-override'))
5601               ? $conf->config('business-onlinepayment-email-override')
5602               : $invoicing_list[0];
5603
5604   my $payip = exists($options{'payip'})
5605                 ? $options{'payip'}
5606                 : $self->payip;
5607   $content{customer_ip} = $payip
5608     if length($payip);
5609
5610   my $payinfo = '';
5611   if ( $options{method} eq 'CC' ) {
5612
5613     if ( $cust_pay ) {
5614       $content{card_number} = $payinfo = $cust_pay->payinfo;
5615       (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
5616         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
5617         ($content{expiration} = "$2/$1");  # where available
5618     } else {
5619       $content{card_number} = $payinfo = $self->payinfo;
5620       (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
5621         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5622       $content{expiration} = "$2/$1";
5623     }
5624
5625   } elsif ( $options{method} eq 'ECHECK' ) {
5626
5627     if ( $cust_pay ) {
5628       $payinfo = $cust_pay->payinfo;
5629     } else {
5630       $payinfo = $self->payinfo;
5631     }
5632     ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
5633     $content{bank_name} = $self->payname;
5634     $content{account_type} = 'CHECKING';
5635     $content{account_name} = $payname;
5636     $content{customer_org} = $self->company ? 'B' : 'I';
5637     $content{customer_ssn} = $self->ss;
5638   } elsif ( $options{method} eq 'LEC' ) {
5639     $content{phone} = $payinfo = $self->payinfo;
5640   }
5641
5642   #then try refund
5643   my $refund = new Business::OnlinePayment( $processor, @bop_options );
5644   my %sub_content = $refund->content(
5645     'action'         => 'credit',
5646     'customer_id'    => $self->custnum,
5647     'last_name'      => $paylast,
5648     'first_name'     => $payfirst,
5649     'name'           => $payname,
5650     'address'        => $address,
5651     'city'           => $self->city,
5652     'state'          => $self->state,
5653     'zip'            => $self->zip,
5654     'country'        => $self->country,
5655     'email'          => $email,
5656     'phone'          => $self->daytime || $self->night,
5657     %content, #after
5658   );
5659   warn join('', map { "  $_ => $sub_content{$_}\n" } keys %sub_content )
5660     if $DEBUG > 1;
5661   $refund->submit();
5662
5663   return "$processor error: ". $refund->error_message
5664     unless $refund->is_success();
5665
5666   my $paybatch = "$processor:". $refund->authorization;
5667   $paybatch .= ':'. $refund->order_number
5668     if $refund->can('order_number') && $refund->order_number;
5669
5670   while ( $cust_pay && $cust_pay->unapplied < $amount ) {
5671     my @cust_bill_pay = $cust_pay->cust_bill_pay;
5672     last unless @cust_bill_pay;
5673     my $cust_bill_pay = pop @cust_bill_pay;
5674     my $error = $cust_bill_pay->delete;
5675     last if $error;
5676   }
5677
5678   my $cust_refund = new FS::cust_refund ( {
5679     'custnum'  => $self->custnum,
5680     'paynum'   => $options{'paynum'},
5681     'refund'   => $amount,
5682     '_date'    => '',
5683     'payby'    => $bop_method2payby{$options{method}},
5684     'payinfo'  => $payinfo,
5685     'paybatch' => $paybatch,
5686     'reason'   => $options{'reason'} || 'card or ACH refund',
5687   } );
5688   my $error = $cust_refund->insert;
5689   if ( $error ) {
5690     $cust_refund->paynum(''); #try again with no specific paynum
5691     my $error2 = $cust_refund->insert;
5692     if ( $error2 ) {
5693       # gah, even with transactions.
5694       my $e = 'WARNING: Card/ACH refunded but database not updated - '.
5695               "error inserting refund ($processor): $error2".
5696               " (previously tried insert with paynum #$options{'paynum'}" .
5697               ": $error )";
5698       warn $e;
5699       return $e;
5700     }
5701   }
5702
5703   ''; #no error
5704
5705 }
5706
5707 =item batch_card OPTION => VALUE...
5708
5709 Adds a payment for this invoice to the pending credit card batch (see
5710 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
5711 runs the payment using a realtime gateway.
5712
5713 =cut
5714
5715 sub batch_card {
5716   my ($self, %options) = @_;
5717
5718   my $amount;
5719   if (exists($options{amount})) {
5720     $amount = $options{amount};
5721   }else{
5722     $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
5723   }
5724   return '' unless $amount > 0;
5725
5726   my $invnum = delete $options{invnum};
5727   my $payby = $options{invnum} || $self->payby;  #dubious
5728
5729   if ($options{'realtime'}) {
5730     return $self->realtime_bop( FS::payby->payby2bop($self->payby),
5731                                 $amount,
5732                                 %options,
5733                               );
5734   }
5735
5736   my $oldAutoCommit = $FS::UID::AutoCommit;
5737   local $FS::UID::AutoCommit = 0;
5738   my $dbh = dbh;
5739
5740   #this needs to handle mysql as well as Pg, like svc_acct.pm
5741   #(make it into a common function if folks need to do batching with mysql)
5742   $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
5743     or return "Cannot lock pay_batch: " . $dbh->errstr;
5744
5745   my %pay_batch = (
5746     'status' => 'O',
5747     'payby'  => FS::payby->payby2payment($payby),
5748   );
5749
5750   my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
5751
5752   unless ( $pay_batch ) {
5753     $pay_batch = new FS::pay_batch \%pay_batch;
5754     my $error = $pay_batch->insert;
5755     if ( $error ) {
5756       $dbh->rollback if $oldAutoCommit;
5757       die "error creating new batch: $error\n";
5758     }
5759   }
5760
5761   my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
5762       'batchnum' => $pay_batch->batchnum,
5763       'custnum'  => $self->custnum,
5764   } );
5765
5766   foreach (qw( address1 address2 city state zip country payby payinfo paydate
5767                payname )) {
5768     $options{$_} = '' unless exists($options{$_});
5769   }
5770
5771   my $cust_pay_batch = new FS::cust_pay_batch ( {
5772     'batchnum' => $pay_batch->batchnum,
5773     'invnum'   => $invnum || 0,                    # is there a better value?
5774                                                    # this field should be
5775                                                    # removed...
5776                                                    # cust_bill_pay_batch now
5777     'custnum'  => $self->custnum,
5778     'last'     => $self->getfield('last'),
5779     'first'    => $self->getfield('first'),
5780     'address1' => $options{address1} || $self->address1,
5781     'address2' => $options{address2} || $self->address2,
5782     'city'     => $options{city}     || $self->city,
5783     'state'    => $options{state}    || $self->state,
5784     'zip'      => $options{zip}      || $self->zip,
5785     'country'  => $options{country}  || $self->country,
5786     'payby'    => $options{payby}    || $self->payby,
5787     'payinfo'  => $options{payinfo}  || $self->payinfo,
5788     'exp'      => $options{paydate}  || $self->paydate,
5789     'payname'  => $options{payname}  || $self->payname,
5790     'amount'   => $amount,                         # consolidating
5791   } );
5792
5793   $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
5794     if $old_cust_pay_batch;
5795
5796   my $error;
5797   if ($old_cust_pay_batch) {
5798     $error = $cust_pay_batch->replace($old_cust_pay_batch)
5799   } else {
5800     $error = $cust_pay_batch->insert;
5801   }
5802
5803   if ( $error ) {
5804     $dbh->rollback if $oldAutoCommit;
5805     die $error;
5806   }
5807
5808   my $unapplied =   $self->total_unapplied_credits
5809                   + $self->total_unapplied_payments
5810                   + $self->in_transit_payments;
5811   foreach my $cust_bill ($self->open_cust_bill) {
5812     #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
5813     my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
5814       'invnum' => $cust_bill->invnum,
5815       'paybatchnum' => $cust_pay_batch->paybatchnum,
5816       'amount' => $cust_bill->owed,
5817       '_date' => time,
5818     };
5819     if ($unapplied >= $cust_bill_pay_batch->amount){
5820       $unapplied -= $cust_bill_pay_batch->amount;
5821       next;
5822     }else{
5823       $cust_bill_pay_batch->amount(sprintf ( "%.2f",
5824                                    $cust_bill_pay_batch->amount - $unapplied ));      $unapplied = 0;
5825     }
5826     $error = $cust_bill_pay_batch->insert;
5827     if ( $error ) {
5828       $dbh->rollback if $oldAutoCommit;
5829       die $error;
5830     }
5831   }
5832
5833   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5834   '';
5835 }
5836
5837 =item apply_payments_and_credits
5838
5839 Applies unapplied payments and credits.
5840
5841 In most cases, this new method should be used in place of sequential
5842 apply_payments and apply_credits methods.
5843
5844 If there is an error, returns the error, otherwise returns false.
5845
5846 =cut
5847
5848 sub apply_payments_and_credits {
5849   my $self = shift;
5850
5851   local $SIG{HUP} = 'IGNORE';
5852   local $SIG{INT} = 'IGNORE';
5853   local $SIG{QUIT} = 'IGNORE';
5854   local $SIG{TERM} = 'IGNORE';
5855   local $SIG{TSTP} = 'IGNORE';
5856   local $SIG{PIPE} = 'IGNORE';
5857
5858   my $oldAutoCommit = $FS::UID::AutoCommit;
5859   local $FS::UID::AutoCommit = 0;
5860   my $dbh = dbh;
5861
5862   $self->select_for_update; #mutex
5863
5864   foreach my $cust_bill ( $self->open_cust_bill ) {
5865     my $error = $cust_bill->apply_payments_and_credits;
5866     if ( $error ) {
5867       $dbh->rollback if $oldAutoCommit;
5868       return "Error applying: $error";
5869     }
5870   }
5871
5872   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5873   ''; #no error
5874
5875 }
5876
5877 =item apply_credits OPTION => VALUE ...
5878
5879 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
5880 to outstanding invoice balances in chronological order (or reverse
5881 chronological order if the I<order> option is set to B<newest>) and returns the
5882 value of any remaining unapplied credits available for refund (see
5883 L<FS::cust_refund>).
5884
5885 Dies if there is an error.
5886
5887 =cut
5888
5889 sub apply_credits {
5890   my $self = shift;
5891   my %opt = @_;
5892
5893   local $SIG{HUP} = 'IGNORE';
5894   local $SIG{INT} = 'IGNORE';
5895   local $SIG{QUIT} = 'IGNORE';
5896   local $SIG{TERM} = 'IGNORE';
5897   local $SIG{TSTP} = 'IGNORE';
5898   local $SIG{PIPE} = 'IGNORE';
5899
5900   my $oldAutoCommit = $FS::UID::AutoCommit;
5901   local $FS::UID::AutoCommit = 0;
5902   my $dbh = dbh;
5903
5904   $self->select_for_update; #mutex
5905
5906   unless ( $self->total_unapplied_credits ) {
5907     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5908     return 0;
5909   }
5910
5911   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
5912       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
5913
5914   my @invoices = $self->open_cust_bill;
5915   @invoices = sort { $b->_date <=> $a->_date } @invoices
5916     if defined($opt{'order'}) && $opt{'order'} eq 'newest';
5917
5918   my $credit;
5919   foreach my $cust_bill ( @invoices ) {
5920     my $amount;
5921
5922     if ( !defined($credit) || $credit->credited == 0) {
5923       $credit = pop @credits or last;
5924     }
5925
5926     if ($cust_bill->owed >= $credit->credited) {
5927       $amount=$credit->credited;
5928     }else{
5929       $amount=$cust_bill->owed;
5930     }
5931
5932     my $cust_credit_bill = new FS::cust_credit_bill ( {
5933       'crednum' => $credit->crednum,
5934       'invnum'  => $cust_bill->invnum,
5935       'amount'  => $amount,
5936     } );
5937     my $error = $cust_credit_bill->insert;
5938     if ( $error ) {
5939       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5940       die $error;
5941     }
5942
5943     redo if ($cust_bill->owed > 0);
5944
5945   }
5946
5947   my $total_unapplied_credits = $self->total_unapplied_credits;
5948
5949   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5950
5951   return $total_unapplied_credits;
5952 }
5953
5954 =item apply_payments
5955
5956 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
5957 to outstanding invoice balances in chronological order.
5958
5959  #and returns the value of any remaining unapplied payments.
5960
5961 Dies if there is an error.
5962
5963 =cut
5964
5965 sub apply_payments {
5966   my $self = shift;
5967
5968   local $SIG{HUP} = 'IGNORE';
5969   local $SIG{INT} = 'IGNORE';
5970   local $SIG{QUIT} = 'IGNORE';
5971   local $SIG{TERM} = 'IGNORE';
5972   local $SIG{TSTP} = 'IGNORE';
5973   local $SIG{PIPE} = 'IGNORE';
5974
5975   my $oldAutoCommit = $FS::UID::AutoCommit;
5976   local $FS::UID::AutoCommit = 0;
5977   my $dbh = dbh;
5978
5979   $self->select_for_update; #mutex
5980
5981   #return 0 unless
5982
5983   my @payments = sort { $b->_date <=> $a->_date }
5984                  grep { $_->unapplied > 0 }
5985                  $self->cust_pay;
5986
5987   my @invoices = sort { $a->_date <=> $b->_date}
5988                  grep { $_->owed > 0 }
5989                  $self->cust_bill;
5990
5991   my $payment;
5992
5993   foreach my $cust_bill ( @invoices ) {
5994     my $amount;
5995
5996     if ( !defined($payment) || $payment->unapplied == 0 ) {
5997       $payment = pop @payments or last;
5998     }
5999
6000     if ( $cust_bill->owed >= $payment->unapplied ) {
6001       $amount = $payment->unapplied;
6002     } else {
6003       $amount = $cust_bill->owed;
6004     }
6005
6006     my $cust_bill_pay = new FS::cust_bill_pay ( {
6007       'paynum' => $payment->paynum,
6008       'invnum' => $cust_bill->invnum,
6009       'amount' => $amount,
6010     } );
6011     my $error = $cust_bill_pay->insert;
6012     if ( $error ) {
6013       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6014       die $error;
6015     }
6016
6017     redo if ( $cust_bill->owed > 0);
6018
6019   }
6020
6021   my $total_unapplied_payments = $self->total_unapplied_payments;
6022
6023   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6024
6025   return $total_unapplied_payments;
6026 }
6027
6028 =item total_owed
6029
6030 Returns the total owed for this customer on all invoices
6031 (see L<FS::cust_bill/owed>).
6032
6033 =cut
6034
6035 sub total_owed {
6036   my $self = shift;
6037   $self->total_owed_date(2145859200); #12/31/2037
6038 }
6039
6040 =item total_owed_date TIME
6041
6042 Returns the total owed for this customer on all invoices with date earlier than
6043 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
6044 see L<Time::Local> and L<Date::Parse> for conversion functions.
6045
6046 =cut
6047
6048 sub total_owed_date {
6049   my $self = shift;
6050   my $time = shift;
6051   my $total_bill = 0;
6052   foreach my $cust_bill (
6053     grep { $_->_date <= $time }
6054       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6055   ) {
6056     $total_bill += $cust_bill->owed;
6057   }
6058   sprintf( "%.2f", $total_bill );
6059 }
6060
6061 =item total_paid
6062
6063 Returns the total amount of all payments.
6064
6065 =cut
6066
6067 sub total_paid {
6068   my $self = shift;
6069   my $total = 0;
6070   $total += $_->paid foreach $self->cust_pay;
6071   sprintf( "%.2f", $total );
6072 }
6073
6074 =item total_unapplied_credits
6075
6076 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6077 customer.  See L<FS::cust_credit/credited>.
6078
6079 =item total_credited
6080
6081 Old name for total_unapplied_credits.  Don't use.
6082
6083 =cut
6084
6085 sub total_credited {
6086   #carp "total_credited deprecated, use total_unapplied_credits";
6087   shift->total_unapplied_credits(@_);
6088 }
6089
6090 sub total_unapplied_credits {
6091   my $self = shift;
6092   my $total_credit = 0;
6093   $total_credit += $_->credited foreach $self->cust_credit;
6094   sprintf( "%.2f", $total_credit );
6095 }
6096
6097 =item total_unapplied_payments
6098
6099 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6100 See L<FS::cust_pay/unapplied>.
6101
6102 =cut
6103
6104 sub total_unapplied_payments {
6105   my $self = shift;
6106   my $total_unapplied = 0;
6107   $total_unapplied += $_->unapplied foreach $self->cust_pay;
6108   sprintf( "%.2f", $total_unapplied );
6109 }
6110
6111 =item total_unapplied_refunds
6112
6113 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6114 customer.  See L<FS::cust_refund/unapplied>.
6115
6116 =cut
6117
6118 sub total_unapplied_refunds {
6119   my $self = shift;
6120   my $total_unapplied = 0;
6121   $total_unapplied += $_->unapplied foreach $self->cust_refund;
6122   sprintf( "%.2f", $total_unapplied );
6123 }
6124
6125 =item balance
6126
6127 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6128 total_unapplied_credits minus total_unapplied_payments).
6129
6130 =cut
6131
6132 sub balance {
6133   my $self = shift;
6134   sprintf( "%.2f",
6135       $self->total_owed
6136     + $self->total_unapplied_refunds
6137     - $self->total_unapplied_credits
6138     - $self->total_unapplied_payments
6139   );
6140 }
6141
6142 =item balance_date TIME
6143
6144 Returns the balance for this customer, only considering invoices with date
6145 earlier than TIME (total_owed_date minus total_credited minus
6146 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
6147 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
6148 functions.
6149
6150 =cut
6151
6152 sub balance_date {
6153   my $self = shift;
6154   my $time = shift;
6155   sprintf( "%.2f",
6156         $self->total_owed_date($time)
6157       + $self->total_unapplied_refunds
6158       - $self->total_unapplied_credits
6159       - $self->total_unapplied_payments
6160   );
6161 }
6162
6163 =item in_transit_payments
6164
6165 Returns the total of requests for payments for this customer pending in
6166 batches in transit to the bank.  See L<FS::pay_batch> and L<FS::cust_pay_batch>
6167
6168 =cut
6169
6170 sub in_transit_payments {
6171   my $self = shift;
6172   my $in_transit_payments = 0;
6173   foreach my $pay_batch ( qsearch('pay_batch', {
6174     'status' => 'I',
6175   } ) ) {
6176     foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
6177       'batchnum' => $pay_batch->batchnum,
6178       'custnum' => $self->custnum,
6179     } ) ) {
6180       $in_transit_payments += $cust_pay_batch->amount;
6181     }
6182   }
6183   sprintf( "%.2f", $in_transit_payments );
6184 }
6185
6186 =item payment_info
6187
6188 Returns a hash of useful information for making a payment.
6189
6190 =over 4
6191
6192 =item balance
6193
6194 Current balance.
6195
6196 =item payby
6197
6198 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
6199 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
6200 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
6201
6202 =back
6203
6204 For credit card transactions:
6205
6206 =over 4
6207
6208 =item card_type 1
6209
6210 =item payname
6211
6212 Exact name on card
6213
6214 =back
6215
6216 For electronic check transactions:
6217
6218 =over 4
6219
6220 =item stateid_state
6221
6222 =back
6223
6224 =cut
6225
6226 sub payment_info {
6227   my $self = shift;
6228
6229   my %return = ();
6230
6231   $return{balance} = $self->balance;
6232
6233   $return{payname} = $self->payname
6234                      || ( $self->first. ' '. $self->get('last') );
6235
6236   $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
6237
6238   $return{payby} = $self->payby;
6239   $return{stateid_state} = $self->stateid_state;
6240
6241   if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
6242     $return{card_type} = cardtype($self->payinfo);
6243     $return{payinfo} = $self->paymask;
6244
6245     @return{'month', 'year'} = $self->paydate_monthyear;
6246
6247   }
6248
6249   if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
6250     my ($payinfo1, $payinfo2) = split '@', $self->paymask;
6251     $return{payinfo1} = $payinfo1;
6252     $return{payinfo2} = $payinfo2;
6253     $return{paytype}  = $self->paytype;
6254     $return{paystate} = $self->paystate;
6255
6256   }
6257
6258   #doubleclick protection
6259   my $_date = time;
6260   $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
6261
6262   %return;
6263
6264 }
6265
6266 =item paydate_monthyear
6267
6268 Returns a two-element list consisting of the month and year of this customer's
6269 paydate (credit card expiration date for CARD customers)
6270
6271 =cut
6272
6273 sub paydate_monthyear {
6274   my $self = shift;
6275   if ( $self->paydate  =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
6276     ( $2, $1 );
6277   } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
6278     ( $1, $3 );
6279   } else {
6280     ('', '');
6281   }
6282 }
6283
6284 =item invoicing_list [ ARRAYREF ]
6285
6286 If an arguement is given, sets these email addresses as invoice recipients
6287 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
6288 (except as warnings), so use check_invoicing_list first.
6289
6290 Returns a list of email addresses (with svcnum entries expanded).
6291
6292 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
6293 check it without disturbing anything by passing nothing.
6294
6295 This interface may change in the future.
6296
6297 =cut
6298
6299 sub invoicing_list {
6300   my( $self, $arrayref ) = @_;
6301
6302   if ( $arrayref ) {
6303     my @cust_main_invoice;
6304     if ( $self->custnum ) {
6305       @cust_main_invoice =
6306         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6307     } else {
6308       @cust_main_invoice = ();
6309     }
6310     foreach my $cust_main_invoice ( @cust_main_invoice ) {
6311       #warn $cust_main_invoice->destnum;
6312       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
6313         #warn $cust_main_invoice->destnum;
6314         my $error = $cust_main_invoice->delete;
6315         warn $error if $error;
6316       }
6317     }
6318     if ( $self->custnum ) {
6319       @cust_main_invoice =
6320         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6321     } else {
6322       @cust_main_invoice = ();
6323     }
6324     my %seen = map { $_->address => 1 } @cust_main_invoice;
6325     foreach my $address ( @{$arrayref} ) {
6326       next if exists $seen{$address} && $seen{$address};
6327       $seen{$address} = 1;
6328       my $cust_main_invoice = new FS::cust_main_invoice ( {
6329         'custnum' => $self->custnum,
6330         'dest'    => $address,
6331       } );
6332       my $error = $cust_main_invoice->insert;
6333       warn $error if $error;
6334     }
6335   }
6336
6337   if ( $self->custnum ) {
6338     map { $_->address }
6339       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6340   } else {
6341     ();
6342   }
6343
6344 }
6345
6346 =item check_invoicing_list ARRAYREF
6347
6348 Checks these arguements as valid input for the invoicing_list method.  If there
6349 is an error, returns the error, otherwise returns false.
6350
6351 =cut
6352
6353 sub check_invoicing_list {
6354   my( $self, $arrayref ) = @_;
6355
6356   foreach my $address ( @$arrayref ) {
6357
6358     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
6359       return 'Can\'t add FAX invoice destination with a blank FAX number.';
6360     }
6361
6362     my $cust_main_invoice = new FS::cust_main_invoice ( {
6363       'custnum' => $self->custnum,
6364       'dest'    => $address,
6365     } );
6366     my $error = $self->custnum
6367                 ? $cust_main_invoice->check
6368                 : $cust_main_invoice->checkdest
6369     ;
6370     return $error if $error;
6371
6372   }
6373
6374   return "Email address required"
6375     if $conf->exists('cust_main-require_invoicing_list_email')
6376     && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
6377
6378   '';
6379 }
6380
6381 =item set_default_invoicing_list
6382
6383 Sets the invoicing list to all accounts associated with this customer,
6384 overwriting any previous invoicing list.
6385
6386 =cut
6387
6388 sub set_default_invoicing_list {
6389   my $self = shift;
6390   $self->invoicing_list($self->all_emails);
6391 }
6392
6393 =item all_emails
6394
6395 Returns the email addresses of all accounts provisioned for this customer.
6396
6397 =cut
6398
6399 sub all_emails {
6400   my $self = shift;
6401   my %list;
6402   foreach my $cust_pkg ( $self->all_pkgs ) {
6403     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
6404     my @svc_acct =
6405       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6406         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
6407           @cust_svc;
6408     $list{$_}=1 foreach map { $_->email } @svc_acct;
6409   }
6410   keys %list;
6411 }
6412
6413 =item invoicing_list_addpost
6414
6415 Adds postal invoicing to this customer.  If this customer is already configured
6416 to receive postal invoices, does nothing.
6417
6418 =cut
6419
6420 sub invoicing_list_addpost {
6421   my $self = shift;
6422   return if grep { $_ eq 'POST' } $self->invoicing_list;
6423   my @invoicing_list = $self->invoicing_list;
6424   push @invoicing_list, 'POST';
6425   $self->invoicing_list(\@invoicing_list);
6426 }
6427
6428 =item invoicing_list_emailonly
6429
6430 Returns the list of email invoice recipients (invoicing_list without non-email
6431 destinations such as POST and FAX).
6432
6433 =cut
6434
6435 sub invoicing_list_emailonly {
6436   my $self = shift;
6437   warn "$me invoicing_list_emailonly called"
6438     if $DEBUG;
6439   grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
6440 }
6441
6442 =item invoicing_list_emailonly_scalar
6443
6444 Returns the list of email invoice recipients (invoicing_list without non-email
6445 destinations such as POST and FAX) as a comma-separated scalar.
6446
6447 =cut
6448
6449 sub invoicing_list_emailonly_scalar {
6450   my $self = shift;
6451   warn "$me invoicing_list_emailonly_scalar called"
6452     if $DEBUG;
6453   join(', ', $self->invoicing_list_emailonly);
6454 }
6455
6456 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
6457
6458 Returns an array of customers referred by this customer (referral_custnum set
6459 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
6460 customers referred by customers referred by this customer and so on, inclusive.
6461 The default behavior is DEPTH 1 (no recursion).
6462
6463 =cut
6464
6465 sub referral_cust_main {
6466   my $self = shift;
6467   my $depth = @_ ? shift : 1;
6468   my $exclude = @_ ? shift : {};
6469
6470   my @cust_main =
6471     map { $exclude->{$_->custnum}++; $_; }
6472       grep { ! $exclude->{ $_->custnum } }
6473         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
6474
6475   if ( $depth > 1 ) {
6476     push @cust_main,
6477       map { $_->referral_cust_main($depth-1, $exclude) }
6478         @cust_main;
6479   }
6480
6481   @cust_main;
6482 }
6483
6484 =item referral_cust_main_ncancelled
6485
6486 Same as referral_cust_main, except only returns customers with uncancelled
6487 packages.
6488
6489 =cut
6490
6491 sub referral_cust_main_ncancelled {
6492   my $self = shift;
6493   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
6494 }
6495
6496 =item referral_cust_pkg [ DEPTH ]
6497
6498 Like referral_cust_main, except returns a flat list of all unsuspended (and
6499 uncancelled) packages for each customer.  The number of items in this list may
6500 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
6501
6502 =cut
6503
6504 sub referral_cust_pkg {
6505   my $self = shift;
6506   my $depth = @_ ? shift : 1;
6507
6508   map { $_->unsuspended_pkgs }
6509     grep { $_->unsuspended_pkgs }
6510       $self->referral_cust_main($depth);
6511 }
6512
6513 =item referring_cust_main
6514
6515 Returns the single cust_main record for the customer who referred this customer
6516 (referral_custnum), or false.
6517
6518 =cut
6519
6520 sub referring_cust_main {
6521   my $self = shift;
6522   return '' unless $self->referral_custnum;
6523   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
6524 }
6525
6526 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
6527
6528 Applies a credit to this customer.  If there is an error, returns the error,
6529 otherwise returns false.
6530
6531 REASON can be a text string, an FS::reason object, or a scalar reference to
6532 a reasonnum.  If a text string, it will be automatically inserted as a new
6533 reason, and a 'reason_type' option must be passed to indicate the
6534 FS::reason_type for the new reason.
6535
6536 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
6537
6538 Any other options are passed to FS::cust_credit::insert.
6539
6540 =cut
6541
6542 sub credit {
6543   my( $self, $amount, $reason, %options ) = @_;
6544
6545   my $cust_credit = new FS::cust_credit {
6546     'custnum' => $self->custnum,
6547     'amount'  => $amount,
6548   };
6549
6550   if ( ref($reason) ) {
6551
6552     if ( ref($reason) eq 'SCALAR' ) {
6553       $cust_credit->reasonnum( $$reason );
6554     } else {
6555       $cust_credit->reasonnum( $reason->reasonnum );
6556     }
6557
6558   } else {
6559     $cust_credit->set('reason', $reason)
6560   }
6561
6562   $cust_credit->addlinfo( delete $options{'addlinfo'} )
6563     if exists($options{'addlinfo'});
6564
6565   $cust_credit->insert(%options);
6566
6567 }
6568
6569 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
6570
6571 Creates a one-time charge for this customer.  If there is an error, returns
6572 the error, otherwise returns false.
6573
6574 =cut
6575
6576 sub charge {
6577   my $self = shift;
6578   my ( $amount, $quantity, $pkg, $comment, $classnum, $additional );
6579   my ( $setuptax, $taxclass );   #internal taxes
6580   my ( $taxproduct, $override ); #vendor (CCH) taxes
6581   if ( ref( $_[0] ) ) {
6582     $amount     = $_[0]->{amount};
6583     $quantity   = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
6584     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
6585     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
6586                                            : '$'. sprintf("%.2f",$amount);
6587     $setuptax   = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
6588     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
6589     $classnum   = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
6590     $additional = $_[0]->{additional};
6591     $taxproduct = $_[0]->{taxproductnum};
6592     $override   = { '' => $_[0]->{tax_override} };
6593   }else{
6594     $amount     = shift;
6595     $quantity   = 1;
6596     $pkg        = @_ ? shift : 'One-time charge';
6597     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
6598     $setuptax   = '';
6599     $taxclass   = @_ ? shift : '';
6600     $additional = [];
6601   }
6602
6603   local $SIG{HUP} = 'IGNORE';
6604   local $SIG{INT} = 'IGNORE';
6605   local $SIG{QUIT} = 'IGNORE';
6606   local $SIG{TERM} = 'IGNORE';
6607   local $SIG{TSTP} = 'IGNORE';
6608   local $SIG{PIPE} = 'IGNORE';
6609
6610   my $oldAutoCommit = $FS::UID::AutoCommit;
6611   local $FS::UID::AutoCommit = 0;
6612   my $dbh = dbh;
6613
6614   my $part_pkg = new FS::part_pkg ( {
6615     'pkg'           => $pkg,
6616     'comment'       => $comment,
6617     'plan'          => 'flat',
6618     'freq'          => 0,
6619     'disabled'      => 'Y',
6620     'classnum'      => $classnum ? $classnum : '',
6621     'setuptax'      => $setuptax,
6622     'taxclass'      => $taxclass,
6623     'taxproductnum' => $taxproduct,
6624   } );
6625
6626   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
6627                         ( 0 .. @$additional - 1 )
6628                   ),
6629                   'additional_count' => scalar(@$additional),
6630                   'setup_fee' => $amount,
6631                 );
6632
6633   my $error = $part_pkg->insert( options       => \%options,
6634                                  tax_overrides => $override,
6635                                );
6636   if ( $error ) {
6637     $dbh->rollback if $oldAutoCommit;
6638     return $error;
6639   }
6640
6641   my $pkgpart = $part_pkg->pkgpart;
6642   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
6643   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
6644     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
6645     $error = $type_pkgs->insert;
6646     if ( $error ) {
6647       $dbh->rollback if $oldAutoCommit;
6648       return $error;
6649     }
6650   }
6651
6652   my $cust_pkg = new FS::cust_pkg ( {
6653     'custnum'  => $self->custnum,
6654     'pkgpart'  => $pkgpart,
6655     'quantity' => $quantity,
6656   } );
6657
6658   $error = $cust_pkg->insert;
6659   if ( $error ) {
6660     $dbh->rollback if $oldAutoCommit;
6661     return $error;
6662   }
6663
6664   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6665   '';
6666
6667 }
6668
6669 #=item charge_postal_fee
6670 #
6671 #Applies a one time charge this customer.  If there is an error,
6672 #returns the error, returns the cust_pkg charge object or false
6673 #if there was no charge.
6674 #
6675 #=cut
6676 #
6677 # This should be a customer event.  For that to work requires that bill
6678 # also be a customer event.
6679
6680 sub charge_postal_fee {
6681   my $self = shift;
6682
6683   my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
6684   return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
6685
6686   my $cust_pkg = new FS::cust_pkg ( {
6687     'custnum'  => $self->custnum,
6688     'pkgpart'  => $pkgpart,
6689     'quantity' => 1,
6690   } );
6691
6692   my $error = $cust_pkg->insert;
6693   $error ? $error : $cust_pkg;
6694 }
6695
6696 =item cust_bill
6697
6698 Returns all the invoices (see L<FS::cust_bill>) for this customer.
6699
6700 =cut
6701
6702 sub cust_bill {
6703   my $self = shift;
6704   sort { $a->_date <=> $b->_date }
6705     qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6706 }
6707
6708 =item open_cust_bill
6709
6710 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
6711 customer.
6712
6713 =cut
6714
6715 sub open_cust_bill {
6716   my $self = shift;
6717   grep { $_->owed > 0 } $self->cust_bill;
6718 }
6719
6720 =item cust_credit
6721
6722 Returns all the credits (see L<FS::cust_credit>) for this customer.
6723
6724 =cut
6725
6726 sub cust_credit {
6727   my $self = shift;
6728   sort { $a->_date <=> $b->_date }
6729     qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
6730 }
6731
6732 =item cust_pay
6733
6734 Returns all the payments (see L<FS::cust_pay>) for this customer.
6735
6736 =cut
6737
6738 sub cust_pay {
6739   my $self = shift;
6740   sort { $a->_date <=> $b->_date }
6741     qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
6742 }
6743
6744 =item cust_pay_void
6745
6746 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
6747
6748 =cut
6749
6750 sub cust_pay_void {
6751   my $self = shift;
6752   sort { $a->_date <=> $b->_date }
6753     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
6754 }
6755
6756 =item cust_pay_batch
6757
6758 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
6759
6760 =cut
6761
6762 sub cust_pay_batch {
6763   my $self = shift;
6764   sort { $a->paybatchnum <=> $b->paybatchnum }
6765     qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
6766 }
6767
6768 =item cust_pay_pending
6769
6770 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
6771 (without status "done").
6772
6773 =cut
6774
6775 sub cust_pay_pending {
6776   my $self = shift;
6777   return $self->num_cust_pay_pending unless wantarray;
6778   sort { $a->_date <=> $b->_date }
6779     qsearch( 'cust_pay_pending', {
6780                                    'custnum' => $self->custnum,
6781                                    'status'  => { op=>'!=', value=>'done' },
6782                                  },
6783            );
6784 }
6785
6786 =item num_cust_pay_pending
6787
6788 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
6789 customer (without status "done").  Also called automatically when the
6790 cust_pay_pending method is used in a scalar context.
6791
6792 =cut
6793
6794 sub num_cust_pay_pending {
6795   my $self = shift;
6796   my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
6797             "   WHERE custnum = ? AND status != 'done' ";
6798   my $sth = dbh->prepare($sql) or die dbh->errstr;
6799   $sth->execute($self->custnum) or die $sth->errstr;
6800   $sth->fetchrow_arrayref->[0];
6801 }
6802
6803 =item cust_refund
6804
6805 Returns all the refunds (see L<FS::cust_refund>) for this customer.
6806
6807 =cut
6808
6809 sub cust_refund {
6810   my $self = shift;
6811   sort { $a->_date <=> $b->_date }
6812     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
6813 }
6814
6815 =item display_custnum
6816
6817 Returns the displayed customer number for this customer: agent_custid if
6818 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
6819
6820 =cut
6821
6822 sub display_custnum {
6823   my $self = shift;
6824   if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
6825     return $self->agent_custid;
6826   } else {
6827     return $self->custnum;
6828   }
6829 }
6830
6831 =item name
6832
6833 Returns a name string for this customer, either "Company (Last, First)" or
6834 "Last, First".
6835
6836 =cut
6837
6838 sub name {
6839   my $self = shift;
6840   my $name = $self->contact;
6841   $name = $self->company. " ($name)" if $self->company;
6842   $name;
6843 }
6844
6845 =item ship_name
6846
6847 Returns a name string for this (service/shipping) contact, either
6848 "Company (Last, First)" or "Last, First".
6849
6850 =cut
6851
6852 sub ship_name {
6853   my $self = shift;
6854   if ( $self->get('ship_last') ) {
6855     my $name = $self->ship_contact;
6856     $name = $self->ship_company. " ($name)" if $self->ship_company;
6857     $name;
6858   } else {
6859     $self->name;
6860   }
6861 }
6862
6863 =item name_short
6864
6865 Returns a name string for this customer, either "Company" or "First Last".
6866
6867 =cut
6868
6869 sub name_short {
6870   my $self = shift;
6871   $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
6872 }
6873
6874 =item ship_name_short
6875
6876 Returns a name string for this (service/shipping) contact, either "Company"
6877 or "First Last".
6878
6879 =cut
6880
6881 sub ship_name_short {
6882   my $self = shift;
6883   if ( $self->get('ship_last') ) {
6884     $self->ship_company !~ /^\s*$/
6885       ? $self->ship_company
6886       : $self->ship_contact_firstlast;
6887   } else {
6888     $self->name_company_or_firstlast;
6889   }
6890 }
6891
6892 =item contact
6893
6894 Returns this customer's full (billing) contact name only, "Last, First"
6895
6896 =cut
6897
6898 sub contact {
6899   my $self = shift;
6900   $self->get('last'). ', '. $self->first;
6901 }
6902
6903 =item ship_contact
6904
6905 Returns this customer's full (shipping) contact name only, "Last, First"
6906
6907 =cut
6908
6909 sub ship_contact {
6910   my $self = shift;
6911   $self->get('ship_last')
6912     ? $self->get('ship_last'). ', '. $self->ship_first
6913     : $self->contact;
6914 }
6915
6916 =item contact_firstlast
6917
6918 Returns this customers full (billing) contact name only, "First Last".
6919
6920 =cut
6921
6922 sub contact_firstlast {
6923   my $self = shift;
6924   $self->first. ' '. $self->get('last');
6925 }
6926
6927 =item ship_contact_firstlast
6928
6929 Returns this customer's full (shipping) contact name only, "First Last".
6930
6931 =cut
6932
6933 sub ship_contact_firstlast {
6934   my $self = shift;
6935   $self->get('ship_last')
6936     ? $self->first. ' '. $self->get('ship_last')
6937     : $self->contact_firstlast;
6938 }
6939
6940 =item country_full
6941
6942 Returns this customer's full country name
6943
6944 =cut
6945
6946 sub country_full {
6947   my $self = shift;
6948   code2country($self->country);
6949 }
6950
6951 =item geocode DATA_VENDOR
6952
6953 Returns a value for the customer location as encoded by DATA_VENDOR.
6954 Currently this only makes sense for "CCH" as DATA_VENDOR.
6955
6956 =cut
6957
6958 sub geocode {
6959   my ($self, $data_vendor) = (shift, shift);  #always cch for now
6960
6961   my $geocode = $self->get('geocode');  #XXX only one data_vendor for geocode
6962   return $geocode if $geocode;
6963
6964   my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
6965                ? 'ship_'
6966                : '';
6967
6968   my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
6969     if $self->country eq 'US';
6970
6971   #CCH specific location stuff
6972   my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
6973
6974   my @cust_tax_location =
6975     qsearch( {
6976                'table'     => 'cust_tax_location',
6977                'hashref'   => { 'zip' => $zip, 'data_vendor' => $data_vendor },
6978                'extra_sql' => $extra_sql,
6979                'order_by'  => 'ORDER BY plus4hi',#overlapping with distinct ends
6980              }
6981            );
6982   $geocode = $cust_tax_location[0]->geocode
6983     if scalar(@cust_tax_location);
6984
6985   $geocode;
6986 }
6987
6988 =item cust_status
6989
6990 =item status
6991
6992 Returns a status string for this customer, currently:
6993
6994 =over 4
6995
6996 =item prospect - No packages have ever been ordered
6997
6998 =item active - One or more recurring packages is active
6999
7000 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
7001
7002 =item suspended - All non-cancelled recurring packages are suspended
7003
7004 =item cancelled - All recurring packages are cancelled
7005
7006 =back
7007
7008 =cut
7009
7010 sub status { shift->cust_status(@_); }
7011
7012 sub cust_status {
7013   my $self = shift;
7014   for my $status (qw( prospect active inactive suspended cancelled )) {
7015     my $method = $status.'_sql';
7016     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
7017     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
7018     $sth->execute( ($self->custnum) x $numnum )
7019       or die "Error executing 'SELECT $sql': ". $sth->errstr;
7020     return $status if $sth->fetchrow_arrayref->[0];
7021   }
7022 }
7023
7024 =item ucfirst_cust_status
7025
7026 =item ucfirst_status
7027
7028 Returns the status with the first character capitalized.
7029
7030 =cut
7031
7032 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
7033
7034 sub ucfirst_cust_status {
7035   my $self = shift;
7036   ucfirst($self->cust_status);
7037 }
7038
7039 =item statuscolor
7040
7041 Returns a hex triplet color string for this customer's status.
7042
7043 =cut
7044
7045 use vars qw(%statuscolor);
7046 tie %statuscolor, 'Tie::IxHash',
7047   'prospect'  => '7e0079', #'000000', #black?  naw, purple
7048   'active'    => '00CC00', #green
7049   'inactive'  => '0000CC', #blue
7050   'suspended' => 'FF9900', #yellow
7051   'cancelled' => 'FF0000', #red
7052 ;
7053
7054 sub statuscolor { shift->cust_statuscolor(@_); }
7055
7056 sub cust_statuscolor {
7057   my $self = shift;
7058   $statuscolor{$self->cust_status};
7059 }
7060
7061 =item tickets
7062
7063 Returns an array of hashes representing the customer's RT tickets.
7064
7065 =cut
7066
7067 sub tickets {
7068   my $self = shift;
7069
7070   my $num = $conf->config('cust_main-max_tickets') || 10;
7071   my @tickets = ();
7072
7073   if ( $conf->config('ticket_system') ) {
7074     unless ( $conf->config('ticket_system-custom_priority_field') ) {
7075
7076       @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
7077
7078     } else {
7079
7080       foreach my $priority (
7081         $conf->config('ticket_system-custom_priority_field-values'), ''
7082       ) {
7083         last if scalar(@tickets) >= $num;
7084         push @tickets,
7085           @{ FS::TicketSystem->customer_tickets( $self->custnum,
7086                                                  $num - scalar(@tickets),
7087                                                  $priority,
7088                                                )
7089            };
7090       }
7091     }
7092   }
7093   (@tickets);
7094 }
7095
7096 # Return services representing svc_accts in customer support packages
7097 sub support_services {
7098   my $self = shift;
7099   my %packages = map { $_ => 1 } $conf->config('support_packages');
7100
7101   grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
7102     grep { $_->part_svc->svcdb eq 'svc_acct' }
7103     map { $_->cust_svc }
7104     grep { exists $packages{ $_->pkgpart } }
7105     $self->ncancelled_pkgs;
7106
7107 }
7108
7109 =back
7110
7111 =head1 CLASS METHODS
7112
7113 =over 4
7114
7115 =item statuses
7116
7117 Class method that returns the list of possible status strings for customers
7118 (see L<the status method|/status>).  For example:
7119
7120   @statuses = FS::cust_main->statuses();
7121
7122 =cut
7123
7124 sub statuses {
7125   #my $self = shift; #could be class...
7126   keys %statuscolor;
7127 }
7128
7129 =item prospect_sql
7130
7131 Returns an SQL expression identifying prospective cust_main records (customers
7132 with no packages ever ordered)
7133
7134 =cut
7135
7136 use vars qw($select_count_pkgs);
7137 $select_count_pkgs =
7138   "SELECT COUNT(*) FROM cust_pkg
7139     WHERE cust_pkg.custnum = cust_main.custnum";
7140
7141 sub select_count_pkgs_sql {
7142   $select_count_pkgs;
7143 }
7144
7145 sub prospect_sql { "
7146   0 = ( $select_count_pkgs )
7147 "; }
7148
7149 =item active_sql
7150
7151 Returns an SQL expression identifying active cust_main records (customers with
7152 active recurring packages).
7153
7154 =cut
7155
7156 sub active_sql { "
7157   0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
7158       )
7159 "; }
7160
7161 =item inactive_sql
7162
7163 Returns an SQL expression identifying inactive cust_main records (customers with
7164 no active recurring packages, but otherwise unsuspended/uncancelled).
7165
7166 =cut
7167
7168 sub inactive_sql { "
7169   0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
7170   AND
7171   0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7172 "; }
7173
7174 =item susp_sql
7175 =item suspended_sql
7176
7177 Returns an SQL expression identifying suspended cust_main records.
7178
7179 =cut
7180
7181
7182 sub suspended_sql { susp_sql(@_); }
7183 sub susp_sql { "
7184     0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
7185     AND
7186     0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
7187 "; }
7188
7189 =item cancel_sql
7190 =item cancelled_sql
7191
7192 Returns an SQL expression identifying cancelled cust_main records.
7193
7194 =cut
7195
7196 sub cancelled_sql { cancel_sql(@_); }
7197 sub cancel_sql {
7198
7199   my $recurring_sql = FS::cust_pkg->recurring_sql;
7200   my $cancelled_sql = FS::cust_pkg->cancelled_sql;
7201
7202   "
7203         0 < ( $select_count_pkgs )
7204     AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql   )
7205     AND 0 = ( $select_count_pkgs AND $recurring_sql
7206                   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
7207             )
7208     AND 0 = (  $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7209   ";
7210
7211 }
7212
7213 =item uncancel_sql
7214 =item uncancelled_sql
7215
7216 Returns an SQL expression identifying un-cancelled cust_main records.
7217
7218 =cut
7219
7220 sub uncancelled_sql { uncancel_sql(@_); }
7221 sub uncancel_sql { "
7222   ( 0 < ( $select_count_pkgs
7223                    AND ( cust_pkg.cancel IS NULL
7224                          OR cust_pkg.cancel = 0
7225                        )
7226         )
7227     OR 0 = ( $select_count_pkgs )
7228   )
7229 "; }
7230
7231 =item balance_sql
7232
7233 Returns an SQL fragment to retreive the balance.
7234
7235 =cut
7236
7237 sub balance_sql { "
7238     ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
7239         WHERE cust_bill.custnum   = cust_main.custnum     )
7240   - ( SELECT COALESCE( SUM(paid),    0 ) FROM cust_pay
7241         WHERE cust_pay.custnum    = cust_main.custnum     )
7242   - ( SELECT COALESCE( SUM(amount),  0 ) FROM cust_credit
7243         WHERE cust_credit.custnum = cust_main.custnum     )
7244   + ( SELECT COALESCE( SUM(refund),  0 ) FROM cust_refund
7245         WHERE cust_refund.custnum = cust_main.custnum     )
7246 "; }
7247
7248 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7249
7250 Returns an SQL fragment to retreive the balance for this customer, only
7251 considering invoices with date earlier than START_TIME, and optionally not
7252 later than END_TIME (total_owed_date minus total_unapplied_credits minus
7253 total_unapplied_payments).
7254
7255 Times are specified as SQL fragments or numeric
7256 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
7257 L<Date::Parse> for conversion functions.  The empty string can be passed
7258 to disable that time constraint completely.
7259
7260 Available options are:
7261
7262 =over 4
7263
7264 =item unapplied_date
7265
7266 set to true to disregard unapplied credits, payments and refunds outside the specified time period - by default the time period restriction only applies to invoices (useful for reporting, probably a bad idea for event triggering)
7267
7268 =item total
7269
7270 (unused.  obsolete?)
7271 set to true to remove all customer comparison clauses, for totals
7272
7273 =item where
7274
7275 (unused.  obsolete?)
7276 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
7277
7278 =item join
7279
7280 (unused.  obsolete?)
7281 JOIN clause (typically used with the total option)
7282
7283 =back
7284
7285 =cut
7286
7287 sub balance_date_sql {
7288   my( $class, $start, $end, %opt ) = @_;
7289
7290   my $owed         = FS::cust_bill->owed_sql;
7291   my $unapp_refund = FS::cust_refund->unapplied_sql;
7292   my $unapp_credit = FS::cust_credit->unapplied_sql;
7293   my $unapp_pay    = FS::cust_pay->unapplied_sql;
7294
7295   my $j = $opt{'join'} || '';
7296
7297   my $owed_wh   = $class->_money_table_where( 'cust_bill',   $start,$end,%opt );
7298   my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
7299   my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
7300   my $pay_wh    = $class->_money_table_where( 'cust_pay',    $start,$end,%opt );
7301
7302   "   ( SELECT COALESCE(SUM($owed),         0) FROM cust_bill   $j $owed_wh   )
7303     + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
7304     - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
7305     - ( SELECT COALESCE(SUM($unapp_pay),    0) FROM cust_pay    $j $pay_wh    )
7306   ";
7307
7308 }
7309
7310 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
7311
7312 Helper method for balance_date_sql; name (and usage) subject to change
7313 (suggestions welcome).
7314
7315 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
7316 cust_refund, cust_credit or cust_pay).
7317
7318 If TABLE is "cust_bill" or the unapplied_date option is true, only
7319 considers records with date earlier than START_TIME, and optionally not
7320 later than END_TIME .
7321
7322 =cut
7323
7324 sub _money_table_where {
7325   my( $class, $table, $start, $end, %opt ) = @_;
7326
7327   my @where = ();
7328   push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
7329   if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
7330     push @where, "$table._date <= $start" if defined($start) && length($start);
7331     push @where, "$table._date >  $end"   if defined($end)   && length($end);
7332   }
7333   push @where, @{$opt{'where'}} if $opt{'where'};
7334   my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
7335
7336   $where;
7337
7338 }
7339
7340 =item search_sql HASHREF
7341
7342 (Class method)
7343
7344 Returns a qsearch hash expression to search for parameters specified in HREF.
7345 Valid parameters are
7346
7347 =over 4
7348
7349 =item agentnum
7350
7351 =item status
7352
7353 =item cancelled_pkgs
7354
7355 bool
7356
7357 =item signupdate
7358
7359 listref of start date, end date
7360
7361 =item payby
7362
7363 listref
7364
7365 =item current_balance
7366
7367 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
7368
7369 =item cust_fields
7370
7371 =item flattened_pkgs
7372
7373 bool
7374
7375 =back
7376
7377 =cut
7378
7379 sub search_sql {
7380   my ($class, $params) = @_;
7381
7382   my $dbh = dbh;
7383
7384   my @where = ();
7385   my $orderby;
7386
7387   ##
7388   # parse agent
7389   ##
7390
7391   if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
7392     push @where,
7393       "cust_main.agentnum = $1";
7394   }
7395
7396   ##
7397   # parse status
7398   ##
7399
7400   #prospect active inactive suspended cancelled
7401   if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
7402     my $method = $params->{'status'}. '_sql';
7403     #push @where, $class->$method();
7404     push @where, FS::cust_main->$method();
7405   }
7406
7407   ##
7408   # parse cancelled package checkbox
7409   ##
7410
7411   my $pkgwhere = "";
7412
7413   $pkgwhere .= "AND (cancel = 0 or cancel is null)"
7414     unless $params->{'cancelled_pkgs'};
7415
7416   ##
7417   # dates
7418   ##
7419
7420   foreach my $field (qw( signupdate )) {
7421
7422     next unless exists($params->{$field});
7423
7424     my($beginning, $ending) = @{$params->{$field}};
7425
7426     push @where,
7427       "cust_main.$field IS NOT NULL",
7428       "cust_main.$field >= $beginning",
7429       "cust_main.$field <= $ending";
7430
7431     $orderby ||= "ORDER BY cust_main.$field";
7432
7433   }
7434
7435   ###
7436   # payby
7437   ###
7438
7439   my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
7440   if ( @payby ) {
7441     push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
7442   }
7443
7444   ##
7445   # amounts
7446   ##
7447
7448   #my $balance_sql = $class->balance_sql();
7449   my $balance_sql = FS::cust_main->balance_sql();
7450
7451   push @where, map { s/current_balance/$balance_sql/; $_ }
7452                    @{ $params->{'current_balance'} };
7453
7454   ##
7455   # custbatch
7456   ##
7457
7458   if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
7459     push @where,
7460       "cust_main.custbatch = '$1'";
7461   }
7462
7463   ##
7464   # setup queries, subs, etc. for the search
7465   ##
7466
7467   $orderby ||= 'ORDER BY custnum';
7468
7469   # here is the agent virtualization
7470   push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
7471
7472   my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
7473
7474   my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum  ) ';
7475
7476   my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
7477
7478   my $select = join(', ',
7479                  'cust_main.custnum',
7480                  FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
7481                );
7482
7483   my(@extra_headers) = ();
7484   my(@extra_fields)  = ();
7485
7486   if ($params->{'flattened_pkgs'}) {
7487
7488     if ($dbh->{Driver}->{Name} eq 'Pg') {
7489
7490       $select .= ", array_to_string(array(select pkg from cust_pkg left join part_pkg using ( pkgpart ) where cust_main.custnum = cust_pkg.custnum $pkgwhere),'|') as magic";
7491
7492     }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
7493       $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
7494       $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
7495     }else{
7496       warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
7497            "omitting packing information from report.";
7498     }
7499
7500     my $header_query = "SELECT COUNT(cust_pkg.custnum = cust_main.custnum) AS count FROM cust_main $addl_from $extra_sql $pkgwhere group by cust_main.custnum order by count desc limit 1";
7501
7502     my $sth = dbh->prepare($header_query) or die dbh->errstr;
7503     $sth->execute() or die $sth->errstr;
7504     my $headerrow = $sth->fetchrow_arrayref;
7505     my $headercount = $headerrow ? $headerrow->[0] : 0;
7506     while($headercount) {
7507       unshift @extra_headers, "Package ". $headercount;
7508       unshift @extra_fields, eval q!sub {my $c = shift;
7509                                          my @a = split '\|', $c->magic;
7510                                          my $p = $a[!.--$headercount. q!];
7511                                          $p;
7512                                         };!;
7513     }
7514
7515   }
7516
7517   my $sql_query = {
7518     'table'         => 'cust_main',
7519     'select'        => $select,
7520     'hashref'       => {},
7521     'extra_sql'     => $extra_sql,
7522     'order_by'      => $orderby,
7523     'count_query'   => $count_query,
7524     'extra_headers' => \@extra_headers,
7525     'extra_fields'  => \@extra_fields,
7526   };
7527
7528 }
7529
7530 =item email_search_sql HASHREF
7531
7532 (Class method)
7533
7534 Emails a notice to the specified customers.
7535
7536 Valid parameters are those of the L<search_sql> method, plus the following:
7537
7538 =over 4
7539
7540 =item from
7541
7542 From: address
7543
7544 =item subject
7545
7546 Email Subject:
7547
7548 =item html_body
7549
7550 HTML body
7551
7552 =item text_body
7553
7554 Text body
7555
7556 =item job
7557
7558 Optional job queue job for status updates.
7559
7560 =back
7561
7562 Returns an error message, or false for success.
7563
7564 If an error occurs during any email, stops the enture send and returns that
7565 error.  Presumably if you're getting SMTP errors aborting is better than
7566 retrying everything.
7567
7568 =cut
7569
7570 sub email_search_sql {
7571   my($class, $params) = @_;
7572
7573   my $from = delete $params->{from};
7574   my $subject = delete $params->{subject};
7575   my $html_body = delete $params->{html_body};
7576   my $text_body = delete $params->{text_body};
7577
7578   my $job = delete $params->{'job'};
7579
7580   my $sql_query = $class->search_sql($params);
7581
7582   my $count_query   = delete($sql_query->{'count_query'});
7583   my $count_sth = dbh->prepare($count_query)
7584     or die "Error preparing $count_query: ". dbh->errstr;
7585   $count_sth->execute
7586     or die "Error executing $count_query: ". $count_sth->errstr;
7587   my $count_arrayref = $count_sth->fetchrow_arrayref;
7588   my $num_cust = $count_arrayref->[0];
7589
7590   #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
7591   #my @extra_fields  = @{ delete($sql_query->{'extra_fields'})  };
7592
7593
7594   my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
7595
7596   #eventually order+limit magic to reduce memory use?
7597   foreach my $cust_main ( qsearch($sql_query) ) {
7598
7599     my $to = $cust_main->invoicing_list_emailonly_scalar;
7600     next unless $to;
7601
7602     my $error = send_email(
7603       generate_email(
7604         'from'      => $from,
7605         'to'        => $to,
7606         'subject'   => $subject,
7607         'html_body' => $html_body,
7608         'text_body' => $text_body,
7609       )
7610     );
7611     return $error if $error;
7612
7613     if ( $job ) { #progressbar foo
7614       $num++;
7615       if ( time - $min_sec > $last ) {
7616         my $error = $job->update_statustext(
7617           int( 100 * $num / $num_cust )
7618         );
7619         die $error if $error;
7620         $last = time;
7621       }
7622     }
7623
7624   }
7625
7626   return '';
7627 }
7628
7629 use Storable qw(thaw);
7630 use Data::Dumper;
7631 use MIME::Base64;
7632 sub process_email_search_sql {
7633   my $job = shift;
7634   #warn "$me process_re_X $method for job $job\n" if $DEBUG;
7635
7636   my $param = thaw(decode_base64(shift));
7637   warn Dumper($param) if $DEBUG;
7638
7639   $param->{'job'} = $job;
7640
7641   my $error = FS::cust_main->email_search_sql( $param );
7642   die $error if $error;
7643
7644 }
7645
7646 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
7647
7648 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
7649 records.  Currently, I<first>, I<last> and/or I<company> may be specified (the
7650 appropriate ship_ field is also searched).
7651
7652 Additional options are the same as FS::Record::qsearch
7653
7654 =cut
7655
7656 sub fuzzy_search {
7657   my( $self, $fuzzy, $hash, @opt) = @_;
7658   #$self
7659   $hash ||= {};
7660   my @cust_main = ();
7661
7662   check_and_rebuild_fuzzyfiles();
7663   foreach my $field ( keys %$fuzzy ) {
7664
7665     my $all = $self->all_X($field);
7666     next unless scalar(@$all);
7667
7668     my %match = ();
7669     $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
7670
7671     my @fcust = ();
7672     foreach ( keys %match ) {
7673       push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
7674       push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
7675     }
7676     my %fsaw = ();
7677     push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
7678   }
7679
7680   # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
7681   my %saw = ();
7682   @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
7683
7684   @cust_main;
7685
7686 }
7687
7688 =item masked FIELD
7689
7690 Returns a masked version of the named field
7691
7692 =cut
7693
7694 sub masked {
7695 my ($self,$field) = @_;
7696
7697 # Show last four
7698
7699 'x'x(length($self->getfield($field))-4).
7700   substr($self->getfield($field), (length($self->getfield($field))-4));
7701
7702 }
7703
7704 =back
7705
7706 =head1 SUBROUTINES
7707
7708 =over 4
7709
7710 =item smart_search OPTION => VALUE ...
7711
7712 Accepts the following options: I<search>, the string to search for.  The string
7713 will be searched for as a customer number, phone number, name or company name,
7714 as an exact, or, in some cases, a substring or fuzzy match (see the source code
7715 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
7716 skip fuzzy matching when an exact match is found.
7717
7718 Any additional options are treated as an additional qualifier on the search
7719 (i.e. I<agentnum>).
7720
7721 Returns a (possibly empty) array of FS::cust_main objects.
7722
7723 =cut
7724
7725 sub smart_search {
7726   my %options = @_;
7727
7728   #here is the agent virtualization
7729   my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
7730
7731   my @cust_main = ();
7732
7733   my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
7734   my $search = delete $options{'search'};
7735   ( my $alphanum_search = $search ) =~ s/\W//g;
7736
7737   if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
7738
7739     #false laziness w/Record::ut_phone
7740     my $phonen = "$1-$2-$3";
7741     $phonen .= " x$4" if $4;
7742
7743     push @cust_main, qsearch( {
7744       'table'   => 'cust_main',
7745       'hashref' => { %options },
7746       'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
7747                      ' ( '.
7748                          join(' OR ', map "$_ = '$phonen'",
7749                                           qw( daytime night fax
7750                                               ship_daytime ship_night ship_fax )
7751                              ).
7752                      ' ) '.
7753                      " AND $agentnums_sql", #agent virtualization
7754     } );
7755
7756     unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
7757       #try looking for matches with extensions unless one was specified
7758
7759       push @cust_main, qsearch( {
7760         'table'   => 'cust_main',
7761         'hashref' => { %options },
7762         'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
7763                        ' ( '.
7764                            join(' OR ', map "$_ LIKE '$phonen\%'",
7765                                             qw( daytime night
7766                                                 ship_daytime ship_night )
7767                                ).
7768                        ' ) '.
7769                        " AND $agentnums_sql", #agent virtualization
7770       } );
7771
7772     }
7773
7774   # custnum search (also try agent_custid), with some tweaking options if your
7775   # legacy cust "numbers" have letters
7776   }
7777
7778   if ( $search =~ /^\s*(\d+)\s*$/
7779             || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
7780                  && $search =~ /^\s*(\w\w?\d+)\s*$/
7781                )
7782           )
7783   {
7784
7785     my $num = $1;
7786
7787     if ( $num <= 2147483647 ) { #need a bigint custnum?  wow.
7788       push @cust_main, qsearch( {
7789         'table'     => 'cust_main',
7790         'hashref'   => { 'custnum' => $num, %options },
7791         'extra_sql' => " AND $agentnums_sql", #agent virtualization
7792       } );
7793     }
7794
7795     push @cust_main, qsearch( {
7796       'table'     => 'cust_main',
7797       'hashref'   => { 'agent_custid' => $num, %options },
7798       'extra_sql' => " AND $agentnums_sql", #agent virtualization
7799     } );
7800
7801   } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
7802
7803     my($company, $last, $first) = ( $1, $2, $3 );
7804
7805     # "Company (Last, First)"
7806     #this is probably something a browser remembered,
7807     #so just do an exact search
7808
7809     foreach my $prefix ( '', 'ship_' ) {
7810       push @cust_main, qsearch( {
7811         'table'     => 'cust_main',
7812         'hashref'   => { $prefix.'first'   => $first,
7813                          $prefix.'last'    => $last,
7814                          $prefix.'company' => $company,
7815                          %options,
7816                        },
7817         'extra_sql' => " AND $agentnums_sql",
7818       } );
7819     }
7820
7821   } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
7822                                               # try (ship_){last,company}
7823
7824     my $value = lc($1);
7825
7826     # # remove "(Last, First)" in "Company (Last, First)", otherwise the
7827     # # full strings the browser remembers won't work
7828     # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
7829
7830     use Lingua::EN::NameParse;
7831     my $NameParse = new Lingua::EN::NameParse(
7832              auto_clean     => 1,
7833              allow_reversed => 1,
7834     );
7835
7836     my($last, $first) = ( '', '' );
7837     #maybe disable this too and just rely on NameParse?
7838     if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
7839
7840       ($last, $first) = ( $1, $2 );
7841
7842     #} elsif  ( $value =~ /^(.+)\s+(.+)$/ ) {
7843     } elsif ( ! $NameParse->parse($value) ) {
7844
7845       my %name = $NameParse->components;
7846       $first = $name{'given_name_1'};
7847       $last  = $name{'surname_1'};
7848
7849     }
7850
7851     if ( $first && $last ) {
7852
7853       my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
7854
7855       #exact
7856       my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
7857       $sql .= "
7858         (     ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
7859            OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
7860         )";
7861
7862       push @cust_main, qsearch( {
7863         'table'     => 'cust_main',
7864         'hashref'   => \%options,
7865         'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
7866       } );
7867
7868       # or it just be something that was typed in... (try that in a sec)
7869
7870     }
7871
7872     my $q_value = dbh->quote($value);
7873
7874     #exact
7875     my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
7876     $sql .= " (    LOWER(last)         = $q_value
7877                 OR LOWER(company)      = $q_value
7878                 OR LOWER(ship_last)    = $q_value
7879                 OR LOWER(ship_company) = $q_value
7880               )";
7881
7882     push @cust_main, qsearch( {
7883       'table'     => 'cust_main',
7884       'hashref'   => \%options,
7885       'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
7886     } );
7887
7888     #no exact match, trying substring/fuzzy
7889     #always do substring & fuzzy (unless they're explicity config'ed off)
7890     #getting complaints searches are not returning enough
7891     unless ( @cust_main  && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
7892
7893       #still some false laziness w/search_sql (was search/cust_main.cgi)
7894
7895       #substring
7896
7897       my @hashrefs = (
7898         { 'company'      => { op=>'ILIKE', value=>"%$value%" }, },
7899         { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
7900       );
7901
7902       if ( $first && $last ) {
7903
7904         push @hashrefs,
7905           { 'first'        => { op=>'ILIKE', value=>"%$first%" },
7906             'last'         => { op=>'ILIKE', value=>"%$last%" },
7907           },
7908           { 'ship_first'   => { op=>'ILIKE', value=>"%$first%" },
7909             'ship_last'    => { op=>'ILIKE', value=>"%$last%" },
7910           },
7911         ;
7912
7913       } else {
7914
7915         push @hashrefs,
7916           { 'last'         => { op=>'ILIKE', value=>"%$value%" }, },
7917           { 'ship_last'    => { op=>'ILIKE', value=>"%$value%" }, },
7918         ;
7919       }
7920
7921       foreach my $hashref ( @hashrefs ) {
7922
7923         push @cust_main, qsearch( {
7924           'table'     => 'cust_main',
7925           'hashref'   => { %$hashref,
7926                            %options,
7927                          },
7928           'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
7929         } );
7930
7931       }
7932
7933       #fuzzy
7934       my @fuzopts = (
7935         \%options,                #hashref
7936         '',                       #select
7937         " AND $agentnums_sql",    #extra_sql  #agent virtualization
7938       );
7939
7940       if ( $first && $last ) {
7941         push @cust_main, FS::cust_main->fuzzy_search(
7942           { 'last'   => $last,    #fuzzy hashref
7943             'first'  => $first }, #
7944           @fuzopts
7945         );
7946       }
7947       foreach my $field ( 'last', 'company' ) {
7948         push @cust_main,
7949           FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
7950       }
7951
7952     }
7953
7954     #eliminate duplicates
7955     my %saw = ();
7956     @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
7957
7958   }
7959
7960   @cust_main;
7961
7962 }
7963
7964 =item email_search
7965
7966 Accepts the following options: I<email>, the email address to search for.  The
7967 email address will be searched for as an email invoice destination and as an
7968 svc_acct account.
7969
7970 #Any additional options are treated as an additional qualifier on the search
7971 #(i.e. I<agentnum>).
7972
7973 Returns a (possibly empty) array of FS::cust_main objects (but usually just
7974 none or one).
7975
7976 =cut
7977
7978 sub email_search {
7979   my %options = @_;
7980
7981   local($DEBUG) = 1;
7982
7983   my $email = delete $options{'email'};
7984
7985   #we're only being used by RT at the moment... no agent virtualization yet
7986   #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
7987
7988   my @cust_main = ();
7989
7990   if ( $email =~ /([^@]+)\@([^@]+)/ ) {
7991
7992     my ( $user, $domain ) = ( $1, $2 );
7993
7994     warn "$me smart_search: searching for $user in domain $domain"
7995       if $DEBUG;
7996
7997     push @cust_main,
7998       map $_->cust_main,
7999           qsearch( {
8000                      'table'     => 'cust_main_invoice',
8001                      'hashref'   => { 'dest' => $email },
8002                    }
8003                  );
8004
8005     push @cust_main,
8006       map  $_->cust_main,
8007       grep $_,
8008       map  $_->cust_svc->cust_pkg,
8009           qsearch( {
8010                      'table'     => 'svc_acct',
8011                      'hashref'   => { 'username' => $user, },
8012                      'extra_sql' =>
8013                        'AND ( SELECT domain FROM svc_domain
8014                                 WHERE svc_acct.domsvc = svc_domain.svcnum
8015                             ) = '. dbh->quote($domain),
8016                    }
8017                  );
8018   }
8019
8020   my %saw = ();
8021   @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8022
8023   warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
8024     if $DEBUG;
8025
8026   @cust_main;
8027
8028 }
8029
8030 =item check_and_rebuild_fuzzyfiles
8031
8032 =cut
8033
8034 use vars qw(@fuzzyfields);
8035 @fuzzyfields = ( 'last', 'first', 'company' );
8036
8037 sub check_and_rebuild_fuzzyfiles {
8038   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8039   rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
8040 }
8041
8042 =item rebuild_fuzzyfiles
8043
8044 =cut
8045
8046 sub rebuild_fuzzyfiles {
8047
8048   use Fcntl qw(:flock);
8049
8050   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8051   mkdir $dir, 0700 unless -d $dir;
8052
8053   foreach my $fuzzy ( @fuzzyfields ) {
8054
8055     open(LOCK,">>$dir/cust_main.$fuzzy")
8056       or die "can't open $dir/cust_main.$fuzzy: $!";
8057     flock(LOCK,LOCK_EX)
8058       or die "can't lock $dir/cust_main.$fuzzy: $!";
8059
8060     open (CACHE,">$dir/cust_main.$fuzzy.tmp")
8061       or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
8062
8063     foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
8064       my $sth = dbh->prepare("SELECT $field FROM cust_main".
8065                              " WHERE $field != '' AND $field IS NOT NULL");
8066       $sth->execute or die $sth->errstr;
8067
8068       while ( my $row = $sth->fetchrow_arrayref ) {
8069         print CACHE $row->[0]. "\n";
8070       }
8071
8072     }
8073
8074     close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
8075
8076     rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
8077     close LOCK;
8078   }
8079
8080 }
8081
8082 =item all_X
8083
8084 =cut
8085
8086 sub all_X {
8087   my( $self, $field ) = @_;
8088   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8089   open(CACHE,"<$dir/cust_main.$field")
8090     or die "can't open $dir/cust_main.$field: $!";
8091   my @array = map { chomp; $_; } <CACHE>;
8092   close CACHE;
8093   \@array;
8094 }
8095
8096 =item append_fuzzyfiles LASTNAME COMPANY
8097
8098 =cut
8099
8100 sub append_fuzzyfiles {
8101   #my( $first, $last, $company ) = @_;
8102
8103   &check_and_rebuild_fuzzyfiles;
8104
8105   use Fcntl qw(:flock);
8106
8107   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8108
8109   foreach my $field (qw( first last company )) {
8110     my $value = shift;
8111
8112     if ( $value ) {
8113
8114       open(CACHE,">>$dir/cust_main.$field")
8115         or die "can't open $dir/cust_main.$field: $!";
8116       flock(CACHE,LOCK_EX)
8117         or die "can't lock $dir/cust_main.$field: $!";
8118
8119       print CACHE "$value\n";
8120
8121       flock(CACHE,LOCK_UN)
8122         or die "can't unlock $dir/cust_main.$field: $!";
8123       close CACHE;
8124     }
8125
8126   }
8127
8128   1;
8129 }
8130
8131 =item batch_charge
8132
8133 =cut
8134
8135 sub batch_charge {
8136   my $param = shift;
8137   #warn join('-',keys %$param);
8138   my $fh = $param->{filehandle};
8139   my @fields = @{$param->{fields}};
8140
8141   eval "use Text::CSV_XS;";
8142   die $@ if $@;
8143
8144   my $csv = new Text::CSV_XS;
8145   #warn $csv;
8146   #warn $fh;
8147
8148   my $imported = 0;
8149   #my $columns;
8150
8151   local $SIG{HUP} = 'IGNORE';
8152   local $SIG{INT} = 'IGNORE';
8153   local $SIG{QUIT} = 'IGNORE';
8154   local $SIG{TERM} = 'IGNORE';
8155   local $SIG{TSTP} = 'IGNORE';
8156   local $SIG{PIPE} = 'IGNORE';
8157
8158   my $oldAutoCommit = $FS::UID::AutoCommit;
8159   local $FS::UID::AutoCommit = 0;
8160   my $dbh = dbh;
8161
8162   #while ( $columns = $csv->getline($fh) ) {
8163   my $line;
8164   while ( defined($line=<$fh>) ) {
8165
8166     $csv->parse($line) or do {
8167       $dbh->rollback if $oldAutoCommit;
8168       return "can't parse: ". $csv->error_input();
8169     };
8170
8171     my @columns = $csv->fields();
8172     #warn join('-',@columns);
8173
8174     my %row = ();
8175     foreach my $field ( @fields ) {
8176       $row{$field} = shift @columns;
8177     }
8178
8179     my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
8180     unless ( $cust_main ) {
8181       $dbh->rollback if $oldAutoCommit;
8182       return "unknown custnum $row{'custnum'}";
8183     }
8184
8185     if ( $row{'amount'} > 0 ) {
8186       my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
8187       if ( $error ) {
8188         $dbh->rollback if $oldAutoCommit;
8189         return $error;
8190       }
8191       $imported++;
8192     } elsif ( $row{'amount'} < 0 ) {
8193       my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
8194                                       $row{'pkg'}                         );
8195       if ( $error ) {
8196         $dbh->rollback if $oldAutoCommit;
8197         return $error;
8198       }
8199       $imported++;
8200     } else {
8201       #hmm?
8202     }
8203
8204   }
8205
8206   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
8207
8208   return "Empty file!" unless $imported;
8209
8210   ''; #no error
8211
8212 }
8213
8214 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
8215
8216 Sends a templated email notification to the customer (see L<Text::Template>).
8217
8218 OPTIONS is a hash and may include
8219
8220 I<from> - the email sender (default is invoice_from)
8221
8222 I<to> - comma-separated scalar or arrayref of recipients
8223    (default is invoicing_list)
8224
8225 I<subject> - The subject line of the sent email notification
8226    (default is "Notice from company_name")
8227
8228 I<extra_fields> - a hashref of name/value pairs which will be substituted
8229    into the template
8230
8231 The following variables are vavailable in the template.
8232
8233 I<$first> - the customer first name
8234 I<$last> - the customer last name
8235 I<$company> - the customer company
8236 I<$payby> - a description of the method of payment for the customer
8237             # would be nice to use FS::payby::shortname
8238 I<$payinfo> - the account information used to collect for this customer
8239 I<$expdate> - the expiration of the customer payment in seconds from epoch
8240
8241 =cut
8242
8243 sub notify {
8244   my ($self, $template, %options) = @_;
8245
8246   return unless $conf->exists($template);
8247
8248   my $from = $conf->config('invoice_from', $self->agentnum)
8249     if $conf->exists('invoice_from', $self->agentnum);
8250   $from = $options{from} if exists($options{from});
8251
8252   my $to = join(',', $self->invoicing_list_emailonly);
8253   $to = $options{to} if exists($options{to});
8254
8255   my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
8256     if $conf->exists('company_name', $self->agentnum);
8257   $subject = $options{subject} if exists($options{subject});
8258
8259   my $notify_template = new Text::Template (TYPE => 'ARRAY',
8260                                             SOURCE => [ map "$_\n",
8261                                               $conf->config($template)]
8262                                            )
8263     or die "can't create new Text::Template object: Text::Template::ERROR";
8264   $notify_template->compile()
8265     or die "can't compile template: Text::Template::ERROR";
8266
8267   $FS::notify_template::_template::company_name =
8268     $conf->config('company_name', $self->agentnum);
8269   $FS::notify_template::_template::company_address =
8270     join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
8271
8272   my $paydate = $self->paydate || '2037-12-31';
8273   $FS::notify_template::_template::first = $self->first;
8274   $FS::notify_template::_template::last = $self->last;
8275   $FS::notify_template::_template::company = $self->company;
8276   $FS::notify_template::_template::payinfo = $self->mask_payinfo;
8277   my $payby = $self->payby;
8278   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
8279   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
8280
8281   #credit cards expire at the end of the month/year of their exp date
8282   if ($payby eq 'CARD' || $payby eq 'DCRD') {
8283     $FS::notify_template::_template::payby = 'credit card';
8284     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
8285     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
8286     $expire_time--;
8287   }elsif ($payby eq 'COMP') {
8288     $FS::notify_template::_template::payby = 'complimentary account';
8289   }else{
8290     $FS::notify_template::_template::payby = 'current method';
8291   }
8292   $FS::notify_template::_template::expdate = $expire_time;
8293
8294   for (keys %{$options{extra_fields}}){
8295     no strict "refs";
8296     ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
8297   }
8298
8299   send_email(from => $from,
8300              to => $to,
8301              subject => $subject,
8302              body => $notify_template->fill_in( PACKAGE =>
8303                                                 'FS::notify_template::_template'                                              ),
8304             );
8305
8306 }
8307
8308 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
8309
8310 Generates a templated notification to the customer (see L<Text::Template>).
8311
8312 OPTIONS is a hash and may include
8313
8314 I<extra_fields> - a hashref of name/value pairs which will be substituted
8315    into the template.  These values may override values mentioned below
8316    and those from the customer record.
8317
8318 The following variables are available in the template instead of or in addition
8319 to the fields of the customer record.
8320
8321 I<$payby> - a description of the method of payment for the customer
8322             # would be nice to use FS::payby::shortname
8323 I<$payinfo> - the masked account information used to collect for this customer
8324 I<$expdate> - the expiration of the customer payment method in seconds from epoch
8325 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
8326
8327 =cut
8328
8329 sub generate_letter {
8330   my ($self, $template, %options) = @_;
8331
8332   return unless $conf->exists($template);
8333
8334   my $letter_template = new Text::Template
8335                         ( TYPE       => 'ARRAY',
8336                           SOURCE     => [ map "$_\n", $conf->config($template)],
8337                           DELIMITERS => [ '[@--', '--@]' ],
8338                         )
8339     or die "can't create new Text::Template object: Text::Template::ERROR";
8340
8341   $letter_template->compile()
8342     or die "can't compile template: Text::Template::ERROR";
8343
8344   my %letter_data = map { $_ => $self->$_ } $self->fields;
8345   $letter_data{payinfo} = $self->mask_payinfo;
8346
8347   #my $paydate = $self->paydate || '2037-12-31';
8348   my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
8349
8350   my $payby = $self->payby;
8351   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
8352   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
8353
8354   #credit cards expire at the end of the month/year of their exp date
8355   if ($payby eq 'CARD' || $payby eq 'DCRD') {
8356     $letter_data{payby} = 'credit card';
8357     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
8358     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
8359     $expire_time--;
8360   }elsif ($payby eq 'COMP') {
8361     $letter_data{payby} = 'complimentary account';
8362   }else{
8363     $letter_data{payby} = 'current method';
8364   }
8365   $letter_data{expdate} = $expire_time;
8366
8367   for (keys %{$options{extra_fields}}){
8368     $letter_data{$_} = $options{extra_fields}->{$_};
8369   }
8370
8371   unless(exists($letter_data{returnaddress})){
8372     my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
8373                                                   $self->agent_template)
8374                      );
8375     if ( length($retadd) ) {
8376       $letter_data{returnaddress} = $retadd;
8377     } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
8378       $letter_data{returnaddress} =
8379         join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
8380                           $conf->config('company_address', $self->agentnum)
8381         );
8382     } else {
8383       $letter_data{returnaddress} = '~';
8384     }
8385   }
8386
8387   $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
8388
8389   $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
8390
8391   my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
8392   my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
8393                            DIR      => $dir,
8394                            SUFFIX   => '.tex',
8395                            UNLINK   => 0,
8396                          ) or die "can't open temp file: $!\n";
8397
8398   $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
8399   close $fh;
8400   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
8401   return $1;
8402 }
8403
8404 =item print_ps TEMPLATE
8405
8406 Returns an postscript letter filled in from TEMPLATE, as a scalar.
8407
8408 =cut
8409
8410 sub print_ps {
8411   my $self = shift;
8412   my $file = $self->generate_letter(@_);
8413   FS::Misc::generate_ps($file);
8414 }
8415
8416 =item print TEMPLATE
8417
8418 Prints the filled in template.
8419
8420 TEMPLATE is the name of a L<Text::Template> to fill in and print.
8421
8422 =cut
8423
8424 sub queueable_print {
8425   my %opt = @_;
8426
8427   my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
8428     or die "invalid customer number: " . $opt{custvnum};
8429
8430   my $error = $self->print( $opt{template} );
8431   die $error if $error;
8432 }
8433
8434 sub print {
8435   my ($self, $template) = (shift, shift);
8436   do_print [ $self->print_ps($template) ];
8437 }
8438
8439 #these three subs should just go away once agent stuff is all config overrides
8440
8441 sub agent_template {
8442   my $self = shift;
8443   $self->_agent_plandata('agent_templatename');
8444 }
8445
8446 sub agent_invoice_from {
8447   my $self = shift;
8448   $self->_agent_plandata('agent_invoice_from');
8449 }
8450
8451 sub _agent_plandata {
8452   my( $self, $option ) = @_;
8453
8454   #yuck.  this whole thing needs to be reconciled better with 1.9's idea of
8455   #agent-specific Conf
8456
8457   use FS::part_event::Condition;
8458
8459   my $agentnum = $self->agentnum;
8460
8461   my $regexp = '';
8462   if ( driver_name =~ /^Pg/i ) {
8463     $regexp = '~';
8464   } elsif ( driver_name =~ /^mysql/i ) {
8465     $regexp = 'REGEXP';
8466   } else {
8467     die "don't know how to use regular expressions in ". driver_name. " databases";
8468   }
8469
8470   my $part_event_option =
8471     qsearchs({
8472       'select'    => 'part_event_option.*',
8473       'table'     => 'part_event_option',
8474       'addl_from' => q{
8475         LEFT JOIN part_event USING ( eventpart )
8476         LEFT JOIN part_event_option AS peo_agentnum
8477           ON ( part_event.eventpart = peo_agentnum.eventpart
8478                AND peo_agentnum.optionname = 'agentnum'
8479                AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
8480              )
8481         LEFT JOIN part_event_condition
8482           ON ( part_event.eventpart = part_event_condition.eventpart
8483                AND part_event_condition.conditionname = 'cust_bill_age'
8484              )
8485         LEFT JOIN part_event_condition_option
8486           ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
8487                AND part_event_condition_option.optionname = 'age'
8488              )
8489       },
8490       #'hashref'   => { 'optionname' => $option },
8491       #'hashref'   => { 'part_event_option.optionname' => $option },
8492       'extra_sql' =>
8493         " WHERE part_event_option.optionname = ". dbh->quote($option).
8494         " AND action = 'cust_bill_send_agent' ".
8495         " AND ( disabled IS NULL OR disabled != 'Y' ) ".
8496         " AND peo_agentnum.optionname = 'agentnum' ".
8497         " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
8498         " ORDER BY
8499            CASE WHEN part_event_condition_option.optionname IS NULL
8500            THEN -1
8501            ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
8502         " END
8503           , part_event.weight".
8504         " LIMIT 1"
8505     });
8506
8507   unless ( $part_event_option ) {
8508     return $self->agent->invoice_template || ''
8509       if $option eq 'agent_templatename';
8510     return '';
8511   }
8512
8513   $part_event_option->optionvalue;
8514
8515 }
8516
8517 sub queued_bill {
8518   ## actual sub, not a method, designed to be called from the queue.
8519   ## sets up the customer, and calls the bill_and_collect
8520   my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
8521   my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
8522       $cust_main->bill_and_collect(
8523         %args,
8524       );
8525 }
8526
8527 sub _upgrade_data { #class method
8528   my ($class, %opts) = @_;
8529
8530   my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
8531   my $sth = dbh->prepare($sql) or die dbh->errstr;
8532   $sth->execute or die $sth->errstr;
8533
8534 }
8535
8536 =back
8537
8538 =head1 BUGS
8539
8540 The delete method.
8541
8542 The delete method should possibly take an FS::cust_main object reference
8543 instead of a scalar customer number.
8544
8545 Bill and collect options should probably be passed as references instead of a
8546 list.
8547
8548 There should probably be a configuration file with a list of allowed credit
8549 card types.
8550
8551 No multiple currency support (probably a larger project than just this module).
8552
8553 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
8554
8555 Birthdates rely on negative epoch values.
8556
8557 The payby for card/check batches is broken.  With mixed batching, bad
8558 things will happen.
8559
8560 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
8561
8562 =head1 SEE ALSO
8563
8564 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
8565 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
8566 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
8567
8568 =cut
8569
8570 1;
8571