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