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