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} && $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} && $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} && $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} && $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} && $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 keys %unsat && $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   return "Amount must be greater than 0" unless $amount > 0;
4000
4001   unless ( $options{'description'} ) {
4002     if ( $conf->exists('business-onlinepayment-description') ) {
4003       my $dtempl = $conf->config('business-onlinepayment-description');
4004
4005       my $agent = $self->agent->agent;
4006       #$pkgs... not here
4007       $options{'description'} = eval qq("$dtempl");
4008     } else {
4009       $options{'description'} = 'Internet services';
4010     }
4011   }
4012
4013   return $self->fake_bop($method, $amount, %options) if $options{'fake'};
4014
4015   eval "use Business::OnlinePayment";
4016   die $@ if $@;
4017
4018   my $payinfo = exists($options{'payinfo'})
4019                   ? $options{'payinfo'}
4020                   : $self->payinfo;
4021
4022   my %method2payby = (
4023     'CC'     => 'CARD',
4024     'ECHECK' => 'CHEK',
4025     'LEC'    => 'LECB',
4026   );
4027
4028   ###
4029   # check for banned credit card/ACH
4030   ###
4031
4032   my $ban = qsearchs('banned_pay', {
4033     'payby'   => $method2payby{$method},
4034     'payinfo' => md5_base64($payinfo),
4035   } );
4036   return "Banned credit card" if $ban;
4037
4038   ###
4039   # set taxclass and trans_is_recur based on invnum if there is one
4040   ###
4041
4042   my $taxclass = '';
4043   my $trans_is_recur = 0;
4044   if ( $options{'invnum'} ) {
4045
4046     my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
4047     die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
4048
4049     my @part_pkg =
4050       map  { $_->part_pkg }
4051       grep { $_ }
4052       map  { $_->cust_pkg }
4053       $cust_bill->cust_bill_pkg;
4054
4055     my @taxclasses = map $_->taxclass, @part_pkg;
4056     $taxclass = $taxclasses[0]
4057       unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
4058                                                         #different taxclasses
4059     $trans_is_recur = 1
4060       if grep { $_->freq ne '0' } @part_pkg;
4061
4062   }
4063
4064   ###
4065   # select a gateway
4066   ###
4067
4068   #look for an agent gateway override first
4069   my $cardtype;
4070   if ( $method eq 'CC' ) {
4071     $cardtype = cardtype($payinfo);
4072   } elsif ( $method eq 'ECHECK' ) {
4073     $cardtype = 'ACH';
4074   } else {
4075     $cardtype = $method;
4076   }
4077
4078   my $override =
4079        qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4080                                            cardtype => $cardtype,
4081                                            taxclass => $taxclass,       } )
4082     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4083                                            cardtype => '',
4084                                            taxclass => $taxclass,       } )
4085     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4086                                            cardtype => $cardtype,
4087                                            taxclass => '',              } )
4088     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4089                                            cardtype => '',
4090                                            taxclass => '',              } );
4091
4092   my $payment_gateway = '';
4093   my( $processor, $login, $password, $action, @bop_options );
4094   if ( $override ) { #use a payment gateway override
4095
4096     $payment_gateway = $override->payment_gateway;
4097
4098     $processor   = $payment_gateway->gateway_module;
4099     $login       = $payment_gateway->gateway_username;
4100     $password    = $payment_gateway->gateway_password;
4101     $action      = $payment_gateway->gateway_action;
4102     @bop_options = $payment_gateway->options;
4103
4104   } else { #use the standard settings from the config
4105
4106     ( $processor, $login, $password, $action, @bop_options ) =
4107       $self->default_payment_gateway($method);
4108
4109   }
4110
4111   ###
4112   # massage data
4113   ###
4114
4115   my $address = exists($options{'address1'})
4116                     ? $options{'address1'}
4117                     : $self->address1;
4118   my $address2 = exists($options{'address2'})
4119                     ? $options{'address2'}
4120                     : $self->address2;
4121   $address .= ", ". $address2 if length($address2);
4122
4123   my $o_payname = exists($options{'payname'})
4124                     ? $options{'payname'}
4125                     : $self->payname;
4126   my($payname, $payfirst, $paylast);
4127   if ( $o_payname && $method ne 'ECHECK' ) {
4128     ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4129       or return "Illegal payname $payname";
4130     ($payfirst, $paylast) = ($1, $2);
4131   } else {
4132     $payfirst = $self->getfield('first');
4133     $paylast = $self->getfield('last');
4134     $payname =  "$payfirst $paylast";
4135   }
4136
4137   my @invoicing_list = $self->invoicing_list_emailonly;
4138   if ( $conf->exists('emailinvoiceautoalways')
4139        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4140        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4141     push @invoicing_list, $self->all_emails;
4142   }
4143
4144   my $email = ($conf->exists('business-onlinepayment-email-override'))
4145               ? $conf->config('business-onlinepayment-email-override')
4146               : $invoicing_list[0];
4147
4148   my %content = ();
4149
4150   my $payip = exists($options{'payip'})
4151                 ? $options{'payip'}
4152                 : $self->payip;
4153   $content{customer_ip} = $payip
4154     if length($payip);
4155
4156   $content{invoice_number} = $options{'invnum'}
4157     if exists($options{'invnum'}) && length($options{'invnum'});
4158
4159   $content{email_customer} =
4160     (    $conf->exists('business-onlinepayment-email_customer')
4161       || $conf->exists('business-onlinepayment-email-override') );
4162
4163   my $paydate = '';
4164   if ( $method eq 'CC' ) {
4165
4166     $content{card_number} = $payinfo;
4167     $paydate = exists($options{'paydate'})
4168                     ? $options{'paydate'}
4169                     : $self->paydate;
4170     $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4171     $content{expiration} = "$2/$1";
4172
4173     my $paycvv = exists($options{'paycvv'})
4174                    ? $options{'paycvv'}
4175                    : $self->paycvv;
4176     $content{cvv2} = $paycvv
4177       if length($paycvv);
4178
4179     my $paystart_month = exists($options{'paystart_month'})
4180                            ? $options{'paystart_month'}
4181                            : $self->paystart_month;
4182
4183     my $paystart_year  = exists($options{'paystart_year'})
4184                            ? $options{'paystart_year'}
4185                            : $self->paystart_year;
4186
4187     $content{card_start} = "$paystart_month/$paystart_year"
4188       if $paystart_month && $paystart_year;
4189
4190     my $payissue       = exists($options{'payissue'})
4191                            ? $options{'payissue'}
4192                            : $self->payissue;
4193     $content{issue_number} = $payissue if $payissue;
4194
4195     if ( $self->_bop_recurring_billing( 'payinfo'        => $payinfo,
4196                                         'trans_is_recur' => $trans_is_recur,
4197                                       )
4198        )
4199     {
4200       $content{recurring_billing} = 'YES';
4201       $content{acct_code} = 'rebill'
4202         if $conf->exists('credit_card-recurring_billing_acct_code');
4203     }
4204
4205   } elsif ( $method eq 'ECHECK' ) {
4206     ( $content{account_number}, $content{routing_code} ) =
4207       split('@', $payinfo);
4208     $content{bank_name} = $o_payname;
4209     $content{bank_state} = exists($options{'paystate'})
4210                              ? $options{'paystate'}
4211                              : $self->getfield('paystate');
4212     $content{account_type} = exists($options{'paytype'})
4213                                ? uc($options{'paytype'}) || 'CHECKING'
4214                                : uc($self->getfield('paytype')) || 'CHECKING';
4215     $content{account_name} = $payname;
4216     $content{customer_org} = $self->company ? 'B' : 'I';
4217     $content{state_id}       = exists($options{'stateid'})
4218                                  ? $options{'stateid'}
4219                                  : $self->getfield('stateid');
4220     $content{state_id_state} = exists($options{'stateid_state'})
4221                                  ? $options{'stateid_state'}
4222                                  : $self->getfield('stateid_state');
4223     $content{customer_ssn} = exists($options{'ss'})
4224                                ? $options{'ss'}
4225                                : $self->ss;
4226   } elsif ( $method eq 'LEC' ) {
4227     $content{phone} = $payinfo;
4228   }
4229
4230   ###
4231   # run transaction(s)
4232   ###
4233
4234   my $balance = exists( $options{'balance'} )
4235                   ? $options{'balance'}
4236                   : $self->balance;
4237
4238   $self->select_for_update; #mutex ... just until we get our pending record in
4239
4240   #the checks here are intended to catch concurrent payments
4241   #double-form-submission prevention is taken care of in cust_pay_pending::check
4242
4243   #check the balance
4244   return "The customer's balance has changed; $method transaction aborted."
4245     if $self->balance < $balance;
4246     #&& $self->balance < $amount; #might as well anyway?
4247
4248   #also check and make sure there aren't *other* pending payments for this cust
4249
4250   my @pending = qsearch('cust_pay_pending', {
4251     'custnum' => $self->custnum,
4252     'status'  => { op=>'!=', value=>'done' }
4253   });
4254   return "A payment is already being processed for this customer (".
4255          join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4256          "); $method transaction aborted."
4257     if scalar(@pending);
4258
4259   #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4260
4261   my $cust_pay_pending = new FS::cust_pay_pending {
4262     'custnum'           => $self->custnum,
4263     #'invnum'            => $options{'invnum'},
4264     'paid'              => $amount,
4265     '_date'             => '',
4266     'payby'             => $method2payby{$method},
4267     'payinfo'           => $payinfo,
4268     'paydate'           => $paydate,
4269     'recurring_billing' => $content{recurring_billing},
4270     'pkgnum'            => $options{'pkgnum'},
4271     'status'            => 'new',
4272     'gatewaynum'        => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
4273   };
4274   $cust_pay_pending->payunique( $options{payunique} )
4275     if defined($options{payunique}) && length($options{payunique});
4276   my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4277   return $cpp_new_err if $cpp_new_err;
4278
4279   my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
4280
4281   my $transaction = new Business::OnlinePayment( $processor, @bop_options );
4282   $transaction->content(
4283     'type'           => $method,
4284     'login'          => $login,
4285     'password'       => $password,
4286     'action'         => $action1,
4287     'description'    => $options{'description'},
4288     'amount'         => $amount,
4289     #'invoice_number' => $options{'invnum'},
4290     'customer_id'    => $self->custnum,
4291     'last_name'      => $paylast,
4292     'first_name'     => $payfirst,
4293     'name'           => $payname,
4294     'address'        => $address,
4295     'city'           => ( exists($options{'city'})
4296                             ? $options{'city'}
4297                             : $self->city          ),
4298     'state'          => ( exists($options{'state'})
4299                             ? $options{'state'}
4300                             : $self->state          ),
4301     'zip'            => ( exists($options{'zip'})
4302                             ? $options{'zip'}
4303                             : $self->zip          ),
4304     'country'        => ( exists($options{'country'})
4305                             ? $options{'country'}
4306                             : $self->country          ),
4307     'referer'        => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4308     'email'          => $email,
4309     'phone'          => $self->daytime || $self->night,
4310     %content, #after
4311   );
4312
4313   $cust_pay_pending->status('pending');
4314   my $cpp_pending_err = $cust_pay_pending->replace;
4315   return $cpp_pending_err if $cpp_pending_err;
4316
4317   #config?
4318   my $BOP_TESTING = 0;
4319   my $BOP_TESTING_SUCCESS = 1;
4320
4321   unless ( $BOP_TESTING ) {
4322     $transaction->submit();
4323   } else {
4324     if ( $BOP_TESTING_SUCCESS ) {
4325       $transaction->is_success(1);
4326       $transaction->authorization('fake auth');
4327     } else {
4328       $transaction->is_success(0);
4329       $transaction->error_message('fake failure');
4330     }
4331   }
4332
4333   if ( $transaction->is_success() && $action2 ) {
4334
4335     $cust_pay_pending->status('authorized');
4336     my $cpp_authorized_err = $cust_pay_pending->replace;
4337     return $cpp_authorized_err if $cpp_authorized_err;
4338
4339     my $auth = $transaction->authorization;
4340     my $ordernum = $transaction->can('order_number')
4341                    ? $transaction->order_number
4342                    : '';
4343
4344     my $capture =
4345       new Business::OnlinePayment( $processor, @bop_options );
4346
4347     my %capture = (
4348       %content,
4349       type           => $method,
4350       action         => $action2,
4351       login          => $login,
4352       password       => $password,
4353       order_number   => $ordernum,
4354       amount         => $amount,
4355       authorization  => $auth,
4356       description    => $options{'description'},
4357     );
4358
4359     foreach my $field (qw( authorization_source_code returned_ACI
4360                            transaction_identifier validation_code
4361                            transaction_sequence_num local_transaction_date
4362                            local_transaction_time AVS_result_code          )) {
4363       $capture{$field} = $transaction->$field() if $transaction->can($field);
4364     }
4365
4366     $capture->content( %capture );
4367
4368     $capture->submit();
4369
4370     unless ( $capture->is_success ) {
4371       my $e = "Authorization successful but capture failed, custnum #".
4372               $self->custnum. ': '.  $capture->result_code.
4373               ": ". $capture->error_message;
4374       warn $e;
4375       return $e;
4376     }
4377
4378   }
4379
4380   $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4381   my $cpp_captured_err = $cust_pay_pending->replace;
4382   return $cpp_captured_err if $cpp_captured_err;
4383
4384   ###
4385   # remove paycvv after initial transaction
4386   ###
4387
4388   #false laziness w/misc/process/payment.cgi - check both to make sure working
4389   # correctly
4390   if ( defined $self->dbdef_table->column('paycvv')
4391        && length($self->paycvv)
4392        && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
4393   ) {
4394     my $error = $self->remove_cvv;
4395     if ( $error ) {
4396       warn "WARNING: error removing cvv: $error\n";
4397     }
4398   }
4399
4400   ###
4401   # result handling
4402   ###
4403
4404   if ( $transaction->is_success() ) {
4405
4406     my $paybatch = '';
4407     if ( $payment_gateway ) { # agent override
4408       $paybatch = $payment_gateway->gatewaynum. '-';
4409     }
4410
4411     $paybatch .= "$processor:". $transaction->authorization;
4412
4413     $paybatch .= ':'. $transaction->order_number
4414       if $transaction->can('order_number')
4415       && length($transaction->order_number);
4416
4417     my $cust_pay = new FS::cust_pay ( {
4418        'custnum'  => $self->custnum,
4419        'invnum'   => $options{'invnum'},
4420        'paid'     => $amount,
4421        '_date'    => '',
4422        'payby'    => $method2payby{$method},
4423        'payinfo'  => $payinfo,
4424        'paybatch' => $paybatch,
4425        'paydate'  => $paydate,
4426        'pkgnum'   => $options{'pkgnum'},
4427     } );
4428     #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4429     $cust_pay->payunique( $options{payunique} )
4430       if defined($options{payunique}) && length($options{payunique});
4431
4432     my $oldAutoCommit = $FS::UID::AutoCommit;
4433     local $FS::UID::AutoCommit = 0;
4434     my $dbh = dbh;
4435
4436     #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4437
4438     my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4439
4440     if ( $error ) {
4441       $cust_pay->invnum(''); #try again with no specific invnum
4442       my $error2 = $cust_pay->insert( $options{'manual'} ?
4443                                       ( 'manual' => 1 ) : ()
4444                                     );
4445       if ( $error2 ) {
4446         # gah.  but at least we have a record of the state we had to abort in
4447         # from cust_pay_pending now.
4448         my $e = "WARNING: $method captured but payment not recorded - ".
4449                 "error inserting payment ($processor): $error2".
4450                 " (previously tried insert with invnum #$options{'invnum'}" .
4451                 ": $error ) - pending payment saved as paypendingnum ".
4452                 $cust_pay_pending->paypendingnum. "\n";
4453         warn $e;
4454         return $e;
4455       }
4456     }
4457
4458     if ( $options{'paynum_ref'} ) {
4459       ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4460     }
4461
4462     $cust_pay_pending->status('done');
4463     $cust_pay_pending->statustext('captured');
4464     $cust_pay_pending->paynum($cust_pay->paynum);
4465     my $cpp_done_err = $cust_pay_pending->replace;
4466
4467     if ( $cpp_done_err ) {
4468
4469       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4470       my $e = "WARNING: $method captured but payment not recorded - ".
4471               "error updating status for paypendingnum ".
4472               $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4473       warn $e;
4474       return $e;
4475
4476     } else {
4477
4478       $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4479
4480       if ( $options{'apply'} ) {
4481         my $apply_error = $self->apply_payments_and_credits;
4482         if ( $apply_error ) {
4483           warn "WARNING: error applying payment: $apply_error\n";
4484           #but we still should return no error cause the payment otherwise went
4485           #through...
4486         }
4487       }
4488
4489       return ''; #no error
4490
4491     }
4492
4493   } else {
4494
4495     my $perror = "$processor error: ". $transaction->error_message;
4496
4497     unless ( $transaction->error_message ) {
4498
4499       my $t_response;
4500       if ( $transaction->can('response_page') ) {
4501         $t_response = {
4502                         'page'    => ( $transaction->can('response_page')
4503                                          ? $transaction->response_page
4504                                          : ''
4505                                      ),
4506                         'code'    => ( $transaction->can('response_code')
4507                                          ? $transaction->response_code
4508                                          : ''
4509                                      ),
4510                         'headers' => ( $transaction->can('response_headers')
4511                                          ? $transaction->response_headers
4512                                          : ''
4513                                      ),
4514                       };
4515       } else {
4516         $t_response .=
4517           "No additional debugging information available for $processor";
4518       }
4519
4520       $perror .= "No error_message returned from $processor -- ".
4521                  ( ref($t_response) ? Dumper($t_response) : $t_response );
4522
4523     }
4524
4525     if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4526          && $conf->exists('emaildecline')
4527          && grep { $_ ne 'POST' } $self->invoicing_list
4528          && ! grep { $transaction->error_message =~ /$_/ }
4529                    $conf->config('emaildecline-exclude')
4530     ) {
4531       my @templ = $conf->config('declinetemplate');
4532       my $template = new Text::Template (
4533         TYPE   => 'ARRAY',
4534         SOURCE => [ map "$_\n", @templ ],
4535       ) or return "($perror) can't create template: $Text::Template::ERROR";
4536       $template->compile()
4537         or return "($perror) can't compile template: $Text::Template::ERROR";
4538
4539       my $templ_hash = {
4540         'company_name'    =>
4541           scalar( $conf->config('company_name', $self->agentnum ) ),
4542         'company_address' =>
4543           join("\n", $conf->config('company_address', $self->agentnum ) ),
4544         'error'           => $transaction->error_message,
4545       };
4546
4547       my $error = send_email(
4548         'from'    => $conf->config('invoice_from', $self->agentnum ),
4549         'to'      => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4550         'subject' => 'Your payment could not be processed',
4551         'body'    => [ $template->fill_in(HASH => $templ_hash) ],
4552       );
4553
4554       $perror .= " (also received error sending decline notification: $error)"
4555         if $error;
4556
4557     }
4558
4559     $cust_pay_pending->status('done');
4560     $cust_pay_pending->statustext("declined: $perror");
4561     my $cpp_done_err = $cust_pay_pending->replace;
4562     if ( $cpp_done_err ) {
4563       my $e = "WARNING: $method declined but pending payment not resolved - ".
4564               "error updating status for paypendingnum ".
4565               $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4566       warn $e;
4567       $perror = "$e ($perror)";
4568     }
4569
4570     return $perror;
4571   }
4572
4573 }
4574
4575 sub _bop_recurring_billing {
4576   my( $self, %opt ) = @_;
4577
4578   my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
4579
4580   if ( defined($method) && $method eq 'transaction_is_recur' ) {
4581
4582     return 1 if $opt{'trans_is_recur'};
4583
4584   } else {
4585
4586     my %hash = ( 'custnum' => $self->custnum,
4587                  'payby'   => 'CARD',
4588                );
4589
4590     return 1
4591       if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4592       || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4593                                                                $opt{'payinfo'} )
4594                              } );
4595
4596   }
4597
4598   return 0;
4599
4600 }
4601
4602
4603 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4604
4605 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4606 via a Business::OnlinePayment realtime gateway.  See
4607 L<http://420.am/business-onlinepayment> for supported gateways.
4608
4609 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4610
4611 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4612
4613 Most gateways require a reference to an original payment transaction to refund,
4614 so you probably need to specify a I<paynum>.
4615
4616 I<amount> defaults to the original amount of the payment if not specified.
4617
4618 I<reason> specifies a reason for the refund.
4619
4620 I<paydate> specifies the expiration date for a credit card overriding the
4621 value from the customer record or the payment record. Specified as yyyy-mm-dd
4622
4623 Implementation note: If I<amount> is unspecified or equal to the amount of the
4624 orignal payment, first an attempt is made to "void" the transaction via
4625 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4626 the normal attempt is made to "refund" ("credit") the transaction via the
4627 gateway is attempted.
4628
4629 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4630 #I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
4631 #if set, will override the value from the customer record.
4632
4633 #If an I<invnum> is specified, this payment (if successful) is applied to the
4634 #specified invoice.  If you don't specify an I<invnum> you might want to
4635 #call the B<apply_payments> method.
4636
4637 =cut
4638
4639 #some false laziness w/realtime_bop, not enough to make it worth merging
4640 #but some useful small subs should be pulled out
4641 sub realtime_refund_bop {
4642   my $self = shift;
4643
4644   return $self->_new_realtime_refund_bop(@_)
4645     if $self->_new_bop_required();
4646
4647   my( $method, %options ) = @_;
4648   if ( $DEBUG ) {
4649     warn "$me realtime_refund_bop: $method refund\n";
4650     warn "  $_ => $options{$_}\n" foreach keys %options;
4651   }
4652
4653   eval "use Business::OnlinePayment";
4654   die $@ if $@;
4655
4656   ###
4657   # look up the original payment and optionally a gateway for that payment
4658   ###
4659
4660   my $cust_pay = '';
4661   my $amount = $options{'amount'};
4662
4663   my( $processor, $login, $password, @bop_options ) ;
4664   my( $auth, $order_number ) = ( '', '', '' );
4665
4666   if ( $options{'paynum'} ) {
4667
4668     warn "  paynum: $options{paynum}\n" if $DEBUG > 1;
4669     $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4670       or return "Unknown paynum $options{'paynum'}";
4671     $amount ||= $cust_pay->paid;
4672
4673     $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4674       or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4675                 $cust_pay->paybatch;
4676     my $gatewaynum = '';
4677     ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4678
4679     if ( $gatewaynum ) { #gateway for the payment to be refunded
4680
4681       my $payment_gateway =
4682         qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4683       die "payment gateway $gatewaynum not found"
4684         unless $payment_gateway;
4685
4686       $processor   = $payment_gateway->gateway_module;
4687       $login       = $payment_gateway->gateway_username;
4688       $password    = $payment_gateway->gateway_password;
4689       @bop_options = $payment_gateway->options;
4690
4691     } else { #try the default gateway
4692
4693       my( $conf_processor, $unused_action );
4694       ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4695         $self->default_payment_gateway($method);
4696
4697       return "processor of payment $options{'paynum'} $processor does not".
4698              " match default processor $conf_processor"
4699         unless $processor eq $conf_processor;
4700
4701     }
4702
4703
4704   } else { # didn't specify a paynum, so look for agent gateway overrides
4705            # like a normal transaction
4706
4707     my $cardtype;
4708     if ( $method eq 'CC' ) {
4709       $cardtype = cardtype($self->payinfo);
4710     } elsif ( $method eq 'ECHECK' ) {
4711       $cardtype = 'ACH';
4712     } else {
4713       $cardtype = $method;
4714     }
4715     my $override =
4716            qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4717                                                cardtype => $cardtype,
4718                                                taxclass => '',              } )
4719         || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4720                                                cardtype => '',
4721                                                taxclass => '',              } );
4722
4723     if ( $override ) { #use a payment gateway override
4724
4725       my $payment_gateway = $override->payment_gateway;
4726
4727       $processor   = $payment_gateway->gateway_module;
4728       $login       = $payment_gateway->gateway_username;
4729       $password    = $payment_gateway->gateway_password;
4730       #$action      = $payment_gateway->gateway_action;
4731       @bop_options = $payment_gateway->options;
4732
4733     } else { #use the standard settings from the config
4734
4735       my $unused_action;
4736       ( $processor, $login, $password, $unused_action, @bop_options ) =
4737         $self->default_payment_gateway($method);
4738
4739     }
4740
4741   }
4742   return "neither amount nor paynum specified" unless $amount;
4743
4744   my %content = (
4745     'type'           => $method,
4746     'login'          => $login,
4747     'password'       => $password,
4748     'order_number'   => $order_number,
4749     'amount'         => $amount,
4750     'referer'        => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4751   );
4752   $content{authorization} = $auth
4753     if length($auth); #echeck/ACH transactions have an order # but no auth
4754                       #(at least with authorize.net)
4755
4756   my $disable_void_after;
4757   if ($conf->exists('disable_void_after')
4758       && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4759     $disable_void_after = $1;
4760   }
4761
4762   #first try void if applicable
4763   if ( $cust_pay && $cust_pay->paid == $amount
4764     && (
4765       ( not defined($disable_void_after) )
4766       || ( time < ($cust_pay->_date + $disable_void_after ) )
4767     )
4768   ) {
4769     warn "  attempting void\n" if $DEBUG > 1;
4770     my $void = new Business::OnlinePayment( $processor, @bop_options );
4771     if ( $void->can('info') ) {
4772       if ( $cust_pay->payby eq 'CARD'
4773            && $void->info('CC_void_requires_card') )
4774       {
4775         $content{'card_number'} = $cust_pay->payinfo
4776       } elsif ( $cust_pay->payby eq 'CHEK'
4777                 && $void->info('ECHECK_void_requires_account') )
4778       {
4779         ( $content{'account_number'}, $content{'routing_code'} ) =
4780           split('@', $cust_pay->payinfo);
4781         $content{'name'} = $self->get('first'). ' '. $self->get('last');
4782       }
4783     }
4784     $void->content( 'action' => 'void', %content );
4785     $void->submit();
4786     if ( $void->is_success ) {
4787       my $error = $cust_pay->void($options{'reason'});
4788       if ( $error ) {
4789         # gah, even with transactions.
4790         my $e = 'WARNING: Card/ACH voided but database not updated - '.
4791                 "error voiding payment: $error";
4792         warn $e;
4793         return $e;
4794       }
4795       warn "  void successful\n" if $DEBUG > 1;
4796       return '';
4797     }
4798   }
4799
4800   warn "  void unsuccessful, trying refund\n"
4801     if $DEBUG > 1;
4802
4803   #massage data
4804   my $address = $self->address1;
4805   $address .= ", ". $self->address2 if $self->address2;
4806
4807   my($payname, $payfirst, $paylast);
4808   if ( $self->payname && $method ne 'ECHECK' ) {
4809     $payname = $self->payname;
4810     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4811       or return "Illegal payname $payname";
4812     ($payfirst, $paylast) = ($1, $2);
4813   } else {
4814     $payfirst = $self->getfield('first');
4815     $paylast = $self->getfield('last');
4816     $payname =  "$payfirst $paylast";
4817   }
4818
4819   my @invoicing_list = $self->invoicing_list_emailonly;
4820   if ( $conf->exists('emailinvoiceautoalways')
4821        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4822        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4823     push @invoicing_list, $self->all_emails;
4824   }
4825
4826   my $email = ($conf->exists('business-onlinepayment-email-override'))
4827               ? $conf->config('business-onlinepayment-email-override')
4828               : $invoicing_list[0];
4829
4830   my $payip = exists($options{'payip'})
4831                 ? $options{'payip'}
4832                 : $self->payip;
4833   $content{customer_ip} = $payip
4834     if length($payip);
4835
4836   my $payinfo = '';
4837   if ( $method eq 'CC' ) {
4838
4839     if ( $cust_pay ) {
4840       $content{card_number} = $payinfo = $cust_pay->payinfo;
4841       (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4842         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4843         ($content{expiration} = "$2/$1");  # where available
4844     } else {
4845       $content{card_number} = $payinfo = $self->payinfo;
4846       (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4847         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4848       $content{expiration} = "$2/$1";
4849     }
4850
4851   } elsif ( $method eq 'ECHECK' ) {
4852
4853     if ( $cust_pay ) {
4854       $payinfo = $cust_pay->payinfo;
4855     } else {
4856       $payinfo = $self->payinfo;
4857     }
4858     ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4859     $content{bank_name} = $self->payname;
4860     $content{account_type} = 'CHECKING';
4861     $content{account_name} = $payname;
4862     $content{customer_org} = $self->company ? 'B' : 'I';
4863     $content{customer_ssn} = $self->ss;
4864   } elsif ( $method eq 'LEC' ) {
4865     $content{phone} = $payinfo = $self->payinfo;
4866   }
4867
4868   #then try refund
4869   my $refund = new Business::OnlinePayment( $processor, @bop_options );
4870   my %sub_content = $refund->content(
4871     'action'         => 'credit',
4872     'customer_id'    => $self->custnum,
4873     'last_name'      => $paylast,
4874     'first_name'     => $payfirst,
4875     'name'           => $payname,
4876     'address'        => $address,
4877     'city'           => $self->city,
4878     'state'          => $self->state,
4879     'zip'            => $self->zip,
4880     'country'        => $self->country,
4881     'email'          => $email,
4882     'phone'          => $self->daytime || $self->night,
4883     %content, #after
4884   );
4885   warn join('', map { "  $_ => $sub_content{$_}\n" } keys %sub_content )
4886     if $DEBUG > 1;
4887   $refund->submit();
4888
4889   return "$processor error: ". $refund->error_message
4890     unless $refund->is_success();
4891
4892   my %method2payby = (
4893     'CC'     => 'CARD',
4894     'ECHECK' => 'CHEK',
4895     'LEC'    => 'LECB',
4896   );
4897
4898   my $paybatch = "$processor:". $refund->authorization;
4899   $paybatch .= ':'. $refund->order_number
4900     if $refund->can('order_number') && $refund->order_number;
4901
4902   while ( $cust_pay && $cust_pay->unapplied < $amount ) {
4903     my @cust_bill_pay = $cust_pay->cust_bill_pay;
4904     last unless @cust_bill_pay;
4905     my $cust_bill_pay = pop @cust_bill_pay;
4906     my $error = $cust_bill_pay->delete;
4907     last if $error;
4908   }
4909
4910   my $cust_refund = new FS::cust_refund ( {
4911     'custnum'  => $self->custnum,
4912     'paynum'   => $options{'paynum'},
4913     'refund'   => $amount,
4914     '_date'    => '',
4915     'payby'    => $method2payby{$method},
4916     'payinfo'  => $payinfo,
4917     'paybatch' => $paybatch,
4918     'reason'   => $options{'reason'} || 'card or ACH refund',
4919   } );
4920   my $error = $cust_refund->insert;
4921   if ( $error ) {
4922     $cust_refund->paynum(''); #try again with no specific paynum
4923     my $error2 = $cust_refund->insert;
4924     if ( $error2 ) {
4925       # gah, even with transactions.
4926       my $e = 'WARNING: Card/ACH refunded but database not updated - '.
4927               "error inserting refund ($processor): $error2".
4928               " (previously tried insert with paynum #$options{'paynum'}" .
4929               ": $error )";
4930       warn $e;
4931       return $e;
4932     }
4933   }
4934
4935   ''; #no error
4936
4937 }
4938
4939 # does the configuration indicate the new bop routines are required?
4940
4941 sub _new_bop_required {
4942   my $self = shift;
4943
4944   my $botpp = 'Business::OnlineThirdPartyPayment';
4945
4946   return 1
4947     if (   (     $conf->exists('business-onlinepayment-namespace')
4948              &&  $conf->config('business-onlinepayment-namespace') eq $botpp
4949            )
4950          or scalar( grep { $_->gateway_namespace eq $botpp }
4951                     qsearch( 'payment_gateway', { 'disabled' => '' } )
4952                   )
4953        )
4954   ;
4955
4956   '';
4957 }
4958
4959 =item realtime_collect [ OPTION => VALUE ... ]
4960
4961 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4962 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
4963 gateway.  See L<http://420.am/business-onlinepayment> and
4964 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
4965
4966 On failure returns an error message.
4967
4968 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.
4969
4970 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
4971
4972 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>.  If none is specified
4973 then it is deduced from the customer record.
4974
4975 If no I<amount> is specified, then the customer balance is used.
4976
4977 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4978 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
4979 if set, will override the value from the customer record.
4980
4981 I<description> is a free-text field passed to the gateway.  It defaults to
4982 the value defined by the business-onlinepayment-description configuration
4983 option, or "Internet services" if that is unset.
4984
4985 If an I<invnum> is specified, this payment (if successful) is applied to the
4986 specified invoice.  If you don't specify an I<invnum> you might want to
4987 call the B<apply_payments> method or set the I<apply> option.
4988
4989 I<apply> can be set to true to apply a resulting payment.
4990
4991 I<quiet> can be set true to surpress email decline notices.
4992
4993 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
4994 resulting paynum, if any.
4995
4996 I<payunique> is a unique identifier for this payment.
4997
4998 I<session_id> is a session identifier associated with this payment.
4999
5000 I<depend_jobnum> allows payment capture to unlock export jobs
5001
5002 =cut
5003
5004 sub realtime_collect {
5005   my( $self, %options ) = @_;
5006
5007   if ( $DEBUG ) {
5008     warn "$me realtime_collect:\n";
5009     warn "  $_ => $options{$_}\n" foreach keys %options;
5010   }
5011
5012   $options{amount} = $self->balance unless exists( $options{amount} );
5013   $options{method} = FS::payby->payby2bop($self->payby)
5014     unless exists( $options{method} );
5015
5016   return $self->realtime_bop({%options});
5017
5018 }
5019
5020 =item _realtime_bop { [ ARG => VALUE ... ] }
5021
5022 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
5023 via a Business::OnlinePayment realtime gateway.  See
5024 L<http://420.am/business-onlinepayment> for supported gateways.
5025
5026 Required arguments in the hashref are I<method>, and I<amount>
5027
5028 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5029
5030 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
5031
5032 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5033 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
5034 if set, will override the value from the customer record.
5035
5036 I<description> is a free-text field passed to the gateway.  It defaults to
5037 the value defined by the business-onlinepayment-description configuration
5038 option, or "Internet services" if that is unset.
5039
5040 If an I<invnum> is specified, this payment (if successful) is applied to the
5041 specified invoice.  If you don't specify an I<invnum> you might want to
5042 call the B<apply_payments> method.
5043
5044 I<quiet> can be set true to surpress email decline notices.
5045
5046 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
5047 resulting paynum, if any.
5048
5049 I<payunique> is a unique identifier for this payment.
5050
5051 I<session_id> is a session identifier associated with this payment.
5052
5053 I<depend_jobnum> allows payment capture to unlock export jobs
5054
5055 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
5056
5057 =cut
5058
5059 # some helper routines
5060 sub _payment_gateway {
5061   my ($self, $options) = @_;
5062
5063   $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
5064     unless exists($options->{payment_gateway});
5065
5066   $options->{payment_gateway};
5067 }
5068
5069 sub _bop_auth {
5070   my ($self, $options) = @_;
5071
5072   (
5073     'login'    => $options->{payment_gateway}->gateway_username,
5074     'password' => $options->{payment_gateway}->gateway_password,
5075   );
5076 }
5077
5078 sub _bop_options {
5079   my ($self, $options) = @_;
5080
5081   $options->{payment_gateway}->gatewaynum
5082     ? $options->{payment_gateway}->options
5083     : @{ $options->{payment_gateway}->get('options') };
5084 }
5085
5086 sub _bop_defaults {
5087   my ($self, $options) = @_;
5088
5089   unless ( $options->{'description'} ) {
5090     if ( $conf->exists('business-onlinepayment-description') ) {
5091       my $dtempl = $conf->config('business-onlinepayment-description');
5092
5093       my $agent = $self->agent->agent;
5094       #$pkgs... not here
5095       $options->{'description'} = eval qq("$dtempl");
5096     } else {
5097       $options->{'description'} = 'Internet services';
5098     }
5099   }
5100
5101   $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
5102   $options->{invnum} ||= '';
5103   $options->{payname} = $self->payname unless exists( $options->{payname} );
5104 }
5105
5106 sub _bop_content {
5107   my ($self, $options) = @_;
5108   my %content = ();
5109
5110   $content{address} = exists($options->{'address1'})
5111                         ? $options->{'address1'}
5112                         : $self->address1;
5113   my $address2 = exists($options->{'address2'})
5114                    ? $options->{'address2'}
5115                    : $self->address2;
5116   $content{address} .= ", ". $address2 if length($address2);
5117
5118   my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
5119   $content{customer_ip} = $payip if length($payip);
5120
5121   $content{invoice_number} = $options->{'invnum'}
5122     if exists($options->{'invnum'}) && length($options->{'invnum'});
5123
5124   $content{email_customer} =
5125     (    $conf->exists('business-onlinepayment-email_customer')
5126       || $conf->exists('business-onlinepayment-email-override') );
5127
5128   $content{payfirst} = $self->getfield('first');
5129   $content{paylast} = $self->getfield('last');
5130
5131   $content{account_name} = "$content{payfirst} $content{paylast}"
5132     if $options->{method} eq 'ECHECK';
5133
5134   $content{name} = $options->{payname};
5135   $content{name} = $content{account_name} if exists($content{account_name});
5136
5137   $content{city} = exists($options->{city})
5138                      ? $options->{city}
5139                      : $self->city;
5140   $content{state} = exists($options->{state})
5141                       ? $options->{state}
5142                       : $self->state;
5143   $content{zip} = exists($options->{zip})
5144                     ? $options->{'zip'}
5145                     : $self->zip;
5146   $content{country} = exists($options->{country})
5147                         ? $options->{country}
5148                         : $self->country;
5149   $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
5150   $content{phone} = $self->daytime || $self->night;
5151
5152   (%content);
5153 }
5154
5155 my %bop_method2payby = (
5156   'CC'     => 'CARD',
5157   'ECHECK' => 'CHEK',
5158   'LEC'    => 'LECB',
5159 );
5160
5161 sub _new_realtime_bop {
5162   my $self = shift;
5163
5164   my %options = ();
5165   if (ref($_[0]) eq 'HASH') {
5166     %options = %{$_[0]};
5167   } else {
5168     my ( $method, $amount ) = ( shift, shift );
5169     %options = @_;
5170     $options{method} = $method;
5171     $options{amount} = $amount;
5172   }
5173
5174   if ( $DEBUG ) {
5175     warn "$me realtime_bop (new): $options{method} $options{amount}\n";
5176     warn "  $_ => $options{$_}\n" foreach keys %options;
5177   }
5178
5179   return $self->fake_bop(%options) if $options{'fake'};
5180
5181   $self->_bop_defaults(\%options);
5182
5183   ###
5184   # set trans_is_recur based on invnum if there is one
5185   ###
5186
5187   my $trans_is_recur = 0;
5188   if ( $options{'invnum'} ) {
5189
5190     my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
5191     die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
5192
5193     my @part_pkg =
5194       map  { $_->part_pkg }
5195       grep { $_ }
5196       map  { $_->cust_pkg }
5197       $cust_bill->cust_bill_pkg;
5198
5199     $trans_is_recur = 1
5200       if grep { $_->freq ne '0' } @part_pkg;
5201
5202   }
5203
5204   ###
5205   # select a gateway
5206   ###
5207
5208   my $payment_gateway =  $self->_payment_gateway( \%options );
5209   my $namespace = $payment_gateway->gateway_namespace;
5210
5211   eval "use $namespace";
5212   die $@ if $@;
5213
5214   ###
5215   # check for banned credit card/ACH
5216   ###
5217
5218   my $ban = qsearchs('banned_pay', {
5219     'payby'   => $bop_method2payby{$options{method}},
5220     'payinfo' => md5_base64($options{payinfo}),
5221   } );
5222   return "Banned credit card" if $ban;
5223
5224   ###
5225   # massage data
5226   ###
5227
5228   my (%bop_content) = $self->_bop_content(\%options);
5229
5230   if ( $options{method} ne 'ECHECK' ) {
5231     $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5232       or return "Illegal payname $options{payname}";
5233     ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
5234   }
5235
5236   my @invoicing_list = $self->invoicing_list_emailonly;
5237   if ( $conf->exists('emailinvoiceautoalways')
5238        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5239        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5240     push @invoicing_list, $self->all_emails;
5241   }
5242
5243   my $email = ($conf->exists('business-onlinepayment-email-override'))
5244               ? $conf->config('business-onlinepayment-email-override')
5245               : $invoicing_list[0];
5246
5247   my $paydate = '';
5248   my %content = ();
5249   if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
5250
5251     $content{card_number} = $options{payinfo};
5252     $paydate = exists($options{'paydate'})
5253                     ? $options{'paydate'}
5254                     : $self->paydate;
5255     $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5256     $content{expiration} = "$2/$1";
5257
5258     my $paycvv = exists($options{'paycvv'})
5259                    ? $options{'paycvv'}
5260                    : $self->paycvv;
5261     $content{cvv2} = $paycvv
5262       if length($paycvv);
5263
5264     my $paystart_month = exists($options{'paystart_month'})
5265                            ? $options{'paystart_month'}
5266                            : $self->paystart_month;
5267
5268     my $paystart_year  = exists($options{'paystart_year'})
5269                            ? $options{'paystart_year'}
5270                            : $self->paystart_year;
5271
5272     $content{card_start} = "$paystart_month/$paystart_year"
5273       if $paystart_month && $paystart_year;
5274
5275     my $payissue       = exists($options{'payissue'})
5276                            ? $options{'payissue'}
5277                            : $self->payissue;
5278     $content{issue_number} = $payissue if $payissue;
5279
5280     if ( $self->_bop_recurring_billing( 'payinfo'        => $options{'payinfo'},
5281                                         'trans_is_recur' => $trans_is_recur,
5282                                       )
5283        )
5284     {
5285       $content{recurring_billing} = 'YES';
5286       $content{acct_code} = 'rebill'
5287         if $conf->exists('credit_card-recurring_billing_acct_code');
5288     }
5289
5290   } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
5291     ( $content{account_number}, $content{routing_code} ) =
5292       split('@', $options{payinfo});
5293     $content{bank_name} = $options{payname};
5294     $content{bank_state} = exists($options{'paystate'})
5295                              ? $options{'paystate'}
5296                              : $self->getfield('paystate');
5297     $content{account_type} = exists($options{'paytype'})
5298                                ? uc($options{'paytype'}) || 'CHECKING'
5299                                : uc($self->getfield('paytype')) || 'CHECKING';
5300     $content{customer_org} = $self->company ? 'B' : 'I';
5301     $content{state_id}       = exists($options{'stateid'})
5302                                  ? $options{'stateid'}
5303                                  : $self->getfield('stateid');
5304     $content{state_id_state} = exists($options{'stateid_state'})
5305                                  ? $options{'stateid_state'}
5306                                  : $self->getfield('stateid_state');
5307     $content{customer_ssn} = exists($options{'ss'})
5308                                ? $options{'ss'}
5309                                : $self->ss;
5310   } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
5311     $content{phone} = $options{payinfo};
5312   } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5313     #move along
5314   } else {
5315     #die an evil death
5316   }
5317
5318   ###
5319   # run transaction(s)
5320   ###
5321
5322   my $balance = exists( $options{'balance'} )
5323                   ? $options{'balance'}
5324                   : $self->balance;
5325
5326   $self->select_for_update; #mutex ... just until we get our pending record in
5327
5328   #the checks here are intended to catch concurrent payments
5329   #double-form-submission prevention is taken care of in cust_pay_pending::check
5330
5331   #check the balance
5332   return "The customer's balance has changed; $options{method} transaction aborted."
5333     if $self->balance < $balance;
5334     #&& $self->balance < $options{amount}; #might as well anyway?
5335
5336   #also check and make sure there aren't *other* pending payments for this cust
5337
5338   my @pending = qsearch('cust_pay_pending', {
5339     'custnum' => $self->custnum,
5340     'status'  => { op=>'!=', value=>'done' }
5341   });
5342   return "A payment is already being processed for this customer (".
5343          join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
5344          "); $options{method} transaction aborted."
5345     if scalar(@pending);
5346
5347   #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
5348
5349   my $cust_pay_pending = new FS::cust_pay_pending {
5350     'custnum'           => $self->custnum,
5351     #'invnum'            => $options{'invnum'},
5352     'paid'              => $options{amount},
5353     '_date'             => '',
5354     'payby'             => $bop_method2payby{$options{method}},
5355     'payinfo'           => $options{payinfo},
5356     'paydate'           => $paydate,
5357     'recurring_billing' => $content{recurring_billing},
5358     'pkgnum'            => $options{'pkgnum'},
5359     'status'            => 'new',
5360     'gatewaynum'        => $payment_gateway->gatewaynum || '',
5361     'session_id'        => $options{session_id} || '',
5362     'jobnum'            => $options{depend_jobnum} || '',
5363   };
5364   $cust_pay_pending->payunique( $options{payunique} )
5365     if defined($options{payunique}) && length($options{payunique});
5366   my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
5367   return $cpp_new_err if $cpp_new_err;
5368
5369   my( $action1, $action2 ) =
5370     split( /\s*\,\s*/, $payment_gateway->gateway_action );
5371
5372   my $transaction = new $namespace( $payment_gateway->gateway_module,
5373                                     $self->_bop_options(\%options),
5374                                   );
5375
5376   $transaction->content(
5377     'type'           => $options{method},
5378     $self->_bop_auth(\%options),
5379     'action'         => $action1,
5380     'description'    => $options{'description'},
5381     'amount'         => $options{amount},
5382     #'invoice_number' => $options{'invnum'},
5383     'customer_id'    => $self->custnum,
5384     %bop_content,
5385     'reference'      => $cust_pay_pending->paypendingnum, #for now
5386     'email'          => $email,
5387     %content, #after
5388   );
5389
5390   $cust_pay_pending->status('pending');
5391   my $cpp_pending_err = $cust_pay_pending->replace;
5392   return $cpp_pending_err if $cpp_pending_err;
5393
5394   #config?
5395   my $BOP_TESTING = 0;
5396   my $BOP_TESTING_SUCCESS = 1;
5397
5398   unless ( $BOP_TESTING ) {
5399     $transaction->submit();
5400   } else {
5401     if ( $BOP_TESTING_SUCCESS ) {
5402       $transaction->is_success(1);
5403       $transaction->authorization('fake auth');
5404     } else {
5405       $transaction->is_success(0);
5406       $transaction->error_message('fake failure');
5407     }
5408   }
5409
5410   if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5411
5412     return { reference => $cust_pay_pending->paypendingnum,
5413              map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
5414
5415   } elsif ( $transaction->is_success() && $action2 ) {
5416
5417     $cust_pay_pending->status('authorized');
5418     my $cpp_authorized_err = $cust_pay_pending->replace;
5419     return $cpp_authorized_err if $cpp_authorized_err;
5420
5421     my $auth = $transaction->authorization;
5422     my $ordernum = $transaction->can('order_number')
5423                    ? $transaction->order_number
5424                    : '';
5425
5426     my $capture =
5427       new Business::OnlinePayment( $payment_gateway->gateway_module,
5428                                    $self->_bop_options(\%options),
5429                                  );
5430
5431     my %capture = (
5432       %content,
5433       type           => $options{method},
5434       action         => $action2,
5435       $self->_bop_auth(\%options),
5436       order_number   => $ordernum,
5437       amount         => $options{amount},
5438       authorization  => $auth,
5439       description    => $options{'description'},
5440     );
5441
5442     foreach my $field (qw( authorization_source_code returned_ACI
5443                            transaction_identifier validation_code
5444                            transaction_sequence_num local_transaction_date
5445                            local_transaction_time AVS_result_code          )) {
5446       $capture{$field} = $transaction->$field() if $transaction->can($field);
5447     }
5448
5449     $capture->content( %capture );
5450
5451     $capture->submit();
5452
5453     unless ( $capture->is_success ) {
5454       my $e = "Authorization successful but capture failed, custnum #".
5455               $self->custnum. ': '.  $capture->result_code.
5456               ": ". $capture->error_message;
5457       warn $e;
5458       return $e;
5459     }
5460
5461   }
5462
5463   ###
5464   # remove paycvv after initial transaction
5465   ###
5466
5467   #false laziness w/misc/process/payment.cgi - check both to make sure working
5468   # correctly
5469   if ( defined $self->dbdef_table->column('paycvv')
5470        && length($self->paycvv)
5471        && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
5472   ) {
5473     my $error = $self->remove_cvv;
5474     if ( $error ) {
5475       warn "WARNING: error removing cvv: $error\n";
5476     }
5477   }
5478
5479   ###
5480   # result handling
5481   ###
5482
5483   $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5484
5485 }
5486
5487 =item fake_bop
5488
5489 =cut
5490
5491 sub fake_bop {
5492   my $self = shift;
5493
5494   my %options = ();
5495   if (ref($_[0]) eq 'HASH') {
5496     %options = %{$_[0]};
5497   } else {
5498     my ( $method, $amount ) = ( shift, shift );
5499     %options = @_;
5500     $options{method} = $method;
5501     $options{amount} = $amount;
5502   }
5503
5504   if ( $options{'fake_failure'} ) {
5505      return "Error: No error; test failure requested with fake_failure";
5506   }
5507
5508   #my $paybatch = '';
5509   #if ( $payment_gateway->gatewaynum ) { # agent override
5510   #  $paybatch = $payment_gateway->gatewaynum. '-';
5511   #}
5512   #
5513   #$paybatch .= "$processor:". $transaction->authorization;
5514   #
5515   #$paybatch .= ':'. $transaction->order_number
5516   #  if $transaction->can('order_number')
5517   #  && length($transaction->order_number);
5518
5519   my $paybatch = 'FakeProcessor:54:32';
5520
5521   my $cust_pay = new FS::cust_pay ( {
5522      'custnum'  => $self->custnum,
5523      'invnum'   => $options{'invnum'},
5524      'paid'     => $options{amount},
5525      '_date'    => '',
5526      'payby'    => $bop_method2payby{$options{method}},
5527      #'payinfo'  => $payinfo,
5528      'payinfo'  => '4111111111111111',
5529      'paybatch' => $paybatch,
5530      #'paydate'  => $paydate,
5531      'paydate'  => '2012-05-01',
5532   } );
5533   $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5534
5535   my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5536
5537   if ( $error ) {
5538     $cust_pay->invnum(''); #try again with no specific invnum
5539     my $error2 = $cust_pay->insert( $options{'manual'} ?
5540                                     ( 'manual' => 1 ) : ()
5541                                   );
5542     if ( $error2 ) {
5543       # gah, even with transactions.
5544       my $e = 'WARNING: Card/ACH debited but database not updated - '.
5545               "error inserting (fake!) payment: $error2".
5546               " (previously tried insert with invnum #$options{'invnum'}" .
5547               ": $error )";
5548       warn $e;
5549       return $e;
5550     }
5551   }
5552
5553   if ( $options{'paynum_ref'} ) {
5554     ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5555   }
5556
5557   return ''; #no error
5558
5559 }
5560
5561
5562 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5563 #
5564 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5565 # phone bill transaction.
5566
5567 sub _realtime_bop_result {
5568   my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5569   if ( $DEBUG ) {
5570     warn "$me _realtime_bop_result: pending transaction ".
5571       $cust_pay_pending->paypendingnum. "\n";
5572     warn "  $_ => $options{$_}\n" foreach keys %options;
5573   }
5574
5575   my $payment_gateway = $options{payment_gateway}
5576     or return "no payment gateway in arguments to _realtime_bop_result";
5577
5578   $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5579   my $cpp_captured_err = $cust_pay_pending->replace;
5580   return $cpp_captured_err if $cpp_captured_err;
5581
5582   if ( $transaction->is_success() ) {
5583
5584     my $paybatch = '';
5585     if ( $payment_gateway->gatewaynum ) { # agent override
5586       $paybatch = $payment_gateway->gatewaynum. '-';
5587     }
5588
5589     $paybatch .= $payment_gateway->gateway_module. ":".
5590       $transaction->authorization;
5591
5592     $paybatch .= ':'. $transaction->order_number
5593       if $transaction->can('order_number')
5594       && length($transaction->order_number);
5595
5596     my $cust_pay = new FS::cust_pay ( {
5597        'custnum'  => $self->custnum,
5598        'invnum'   => $options{'invnum'},
5599        'paid'     => $cust_pay_pending->paid,
5600        '_date'    => '',
5601        'payby'    => $cust_pay_pending->payby,
5602        #'payinfo'  => $payinfo,
5603        'paybatch' => $paybatch,
5604        'paydate'  => $cust_pay_pending->paydate,
5605        'pkgnum'   => $cust_pay_pending->pkgnum,
5606     } );
5607     #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5608     $cust_pay->payunique( $options{payunique} )
5609       if defined($options{payunique}) && length($options{payunique});
5610
5611     my $oldAutoCommit = $FS::UID::AutoCommit;
5612     local $FS::UID::AutoCommit = 0;
5613     my $dbh = dbh;
5614
5615     #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5616
5617     my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5618
5619     if ( $error ) {
5620       $cust_pay->invnum(''); #try again with no specific invnum
5621       my $error2 = $cust_pay->insert( $options{'manual'} ?
5622                                       ( 'manual' => 1 ) : ()
5623                                     );
5624       if ( $error2 ) {
5625         # gah.  but at least we have a record of the state we had to abort in
5626         # from cust_pay_pending now.
5627         my $e = "WARNING: $options{method} captured but payment not recorded -".
5628                 " error inserting payment (". $payment_gateway->gateway_module.
5629                 "): $error2".
5630                 " (previously tried insert with invnum #$options{'invnum'}" .
5631                 ": $error ) - pending payment saved as paypendingnum ".
5632                 $cust_pay_pending->paypendingnum. "\n";
5633         warn $e;
5634         return $e;
5635       }
5636     }
5637
5638     my $jobnum = $cust_pay_pending->jobnum;
5639     if ( $jobnum ) {
5640        my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5641
5642        unless ( $placeholder ) {
5643          $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5644          my $e = "WARNING: $options{method} captured but job $jobnum not ".
5645              "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5646          warn $e;
5647          return $e;
5648        }
5649
5650        $error = $placeholder->delete;
5651
5652        if ( $error ) {
5653          $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5654          my $e = "WARNING: $options{method} captured but could not delete ".
5655               "job $jobnum for paypendingnum ".
5656               $cust_pay_pending->paypendingnum. ": $error\n";
5657          warn $e;
5658          return $e;
5659        }
5660
5661     }
5662
5663     if ( $options{'paynum_ref'} ) {
5664       ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5665     }
5666
5667     $cust_pay_pending->status('done');
5668     $cust_pay_pending->statustext('captured');
5669     $cust_pay_pending->paynum($cust_pay->paynum);
5670     my $cpp_done_err = $cust_pay_pending->replace;
5671
5672     if ( $cpp_done_err ) {
5673
5674       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5675       my $e = "WARNING: $options{method} captured but payment not recorded - ".
5676               "error updating status for paypendingnum ".
5677               $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5678       warn $e;
5679       return $e;
5680
5681     } else {
5682
5683       $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5684
5685       if ( $options{'apply'} ) {
5686         my $apply_error = $self->apply_payments_and_credits;
5687         if ( $apply_error ) {
5688           warn "WARNING: error applying payment: $apply_error\n";
5689           #but we still should return no error cause the payment otherwise went
5690           #through...
5691         }
5692       }
5693
5694       return ''; #no error
5695
5696     }
5697
5698   } else {
5699
5700     my $perror = $payment_gateway->gateway_module. " error: ".
5701       $transaction->error_message;
5702
5703     my $jobnum = $cust_pay_pending->jobnum;
5704     if ( $jobnum ) {
5705        my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5706
5707        if ( $placeholder ) {
5708          my $error = $placeholder->depended_delete;
5709          $error ||= $placeholder->delete;
5710          warn "error removing provisioning jobs after declined paypendingnum ".
5711            $cust_pay_pending->paypendingnum. "\n";
5712        } else {
5713          my $e = "error finding job $jobnum for declined paypendingnum ".
5714               $cust_pay_pending->paypendingnum. "\n";
5715          warn $e;
5716        }
5717
5718     }
5719
5720     unless ( $transaction->error_message ) {
5721
5722       my $t_response;
5723       if ( $transaction->can('response_page') ) {
5724         $t_response = {
5725                         'page'    => ( $transaction->can('response_page')
5726                                          ? $transaction->response_page
5727                                          : ''
5728                                      ),
5729                         'code'    => ( $transaction->can('response_code')
5730                                          ? $transaction->response_code
5731                                          : ''
5732                                      ),
5733                         'headers' => ( $transaction->can('response_headers')
5734                                          ? $transaction->response_headers
5735                                          : ''
5736                                      ),
5737                       };
5738       } else {
5739         $t_response .=
5740           "No additional debugging information available for ".
5741             $payment_gateway->gateway_module;
5742       }
5743
5744       $perror .= "No error_message returned from ".
5745                    $payment_gateway->gateway_module. " -- ".
5746                  ( ref($t_response) ? Dumper($t_response) : $t_response );
5747
5748     }
5749
5750     if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5751          && $conf->exists('emaildecline')
5752          && grep { $_ ne 'POST' } $self->invoicing_list
5753          && ! grep { $transaction->error_message =~ /$_/ }
5754                    $conf->config('emaildecline-exclude')
5755     ) {
5756       my @templ = $conf->config('declinetemplate');
5757       my $template = new Text::Template (
5758         TYPE   => 'ARRAY',
5759         SOURCE => [ map "$_\n", @templ ],
5760       ) or return "($perror) can't create template: $Text::Template::ERROR";
5761       $template->compile()
5762         or return "($perror) can't compile template: $Text::Template::ERROR";
5763
5764       my $templ_hash = {
5765         'company_name'    =>
5766           scalar( $conf->config('company_name', $self->agentnum ) ),
5767         'company_address' =>
5768           join("\n", $conf->config('company_address', $self->agentnum ) ),
5769         'error'           => $transaction->error_message,
5770       };
5771
5772       my $error = send_email(
5773         'from'    => $conf->config('invoice_from', $self->agentnum ),
5774         'to'      => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5775         'subject' => 'Your payment could not be processed',
5776         'body'    => [ $template->fill_in(HASH => $templ_hash) ],
5777       );
5778
5779       $perror .= " (also received error sending decline notification: $error)"
5780         if $error;
5781
5782     }
5783
5784     $cust_pay_pending->status('done');
5785     $cust_pay_pending->statustext("declined: $perror");
5786     my $cpp_done_err = $cust_pay_pending->replace;
5787     if ( $cpp_done_err ) {
5788       my $e = "WARNING: $options{method} declined but pending payment not ".
5789               "resolved - error updating status for paypendingnum ".
5790               $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5791       warn $e;
5792       $perror = "$e ($perror)";
5793     }
5794
5795     return $perror;
5796   }
5797
5798 }
5799
5800 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5801
5802 Verifies successful third party processing of a realtime credit card,
5803 ACH (electronic check) or phone bill transaction via a
5804 Business::OnlineThirdPartyPayment realtime gateway.  See
5805 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5806
5807 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5808
5809 The additional options I<payname>, I<city>, I<state>,
5810 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
5811 if set, will override the value from the customer record.
5812
5813 I<description> is a free-text field passed to the gateway.  It defaults to
5814 "Internet services".
5815
5816 If an I<invnum> is specified, this payment (if successful) is applied to the
5817 specified invoice.  If you don't specify an I<invnum> you might want to
5818 call the B<apply_payments> method.
5819
5820 I<quiet> can be set true to surpress email decline notices.
5821
5822 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
5823 resulting paynum, if any.
5824
5825 I<payunique> is a unique identifier for this payment.
5826
5827 Returns a hashref containing elements bill_error (which will be undefined
5828 upon success) and session_id of any associated session.
5829
5830 =cut
5831
5832 sub realtime_botpp_capture {
5833   my( $self, $cust_pay_pending, %options ) = @_;
5834   if ( $DEBUG ) {
5835     warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5836     warn "  $_ => $options{$_}\n" foreach keys %options;
5837   }
5838
5839   eval "use Business::OnlineThirdPartyPayment";
5840   die $@ if $@;
5841
5842   ###
5843   # select the gateway
5844   ###
5845
5846   my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5847
5848   my $payment_gateway = $cust_pay_pending->gatewaynum
5849     ? qsearchs( 'payment_gateway',
5850                 { gatewaynum => $cust_pay_pending->gatewaynum }
5851               )
5852     : $self->agent->payment_gateway( 'method' => $method,
5853                                      # 'invnum'  => $cust_pay_pending->invnum,
5854                                      # 'payinfo' => $cust_pay_pending->payinfo,
5855                                    );
5856
5857   $options{payment_gateway} = $payment_gateway; # for the helper subs
5858
5859   ###
5860   # massage data
5861   ###
5862
5863   my @invoicing_list = $self->invoicing_list_emailonly;
5864   if ( $conf->exists('emailinvoiceautoalways')
5865        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5866        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5867     push @invoicing_list, $self->all_emails;
5868   }
5869
5870   my $email = ($conf->exists('business-onlinepayment-email-override'))
5871               ? $conf->config('business-onlinepayment-email-override')
5872               : $invoicing_list[0];
5873
5874   my %content = ();
5875
5876   $content{email_customer} =
5877     (    $conf->exists('business-onlinepayment-email_customer')
5878       || $conf->exists('business-onlinepayment-email-override') );
5879
5880   ###
5881   # run transaction(s)
5882   ###
5883
5884   my $transaction =
5885     new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5886                                            $self->_bop_options(\%options),
5887                                          );
5888
5889   $transaction->reference({ %options });
5890
5891   $transaction->content(
5892     'type'           => $method,
5893     $self->_bop_auth(\%options),
5894     'action'         => 'Post Authorization',
5895     'description'    => $options{'description'},
5896     'amount'         => $cust_pay_pending->paid,
5897     #'invoice_number' => $options{'invnum'},
5898     'customer_id'    => $self->custnum,
5899     'referer'        => 'http://cleanwhisker.420.am/',
5900     'reference'      => $cust_pay_pending->paypendingnum,
5901     'email'          => $email,
5902     'phone'          => $self->daytime || $self->night,
5903     %content, #after
5904     # plus whatever is required for bogus capture avoidance
5905   );
5906
5907   $transaction->submit();
5908
5909   my $error =
5910     $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5911
5912   {
5913     bill_error => $error,
5914     session_id => $cust_pay_pending->session_id,
5915   }
5916
5917 }
5918
5919 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
5920
5921 =cut
5922
5923 sub default_payment_gateway {
5924   my( $self, $method ) = @_;
5925
5926   die "Real-time processing not enabled\n"
5927     unless $conf->exists('business-onlinepayment');
5928
5929   #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
5930
5931   #load up config
5932   my $bop_config = 'business-onlinepayment';
5933   $bop_config .= '-ach'
5934     if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
5935   my ( $processor, $login, $password, $action, @bop_options ) =
5936     $conf->config($bop_config);
5937   $action ||= 'normal authorization';
5938   pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
5939   die "No real-time processor is enabled - ".
5940       "did you set the business-onlinepayment configuration value?\n"
5941     unless $processor;
5942
5943   ( $processor, $login, $password, $action, @bop_options )
5944 }
5945
5946 =item remove_cvv
5947
5948 Removes the I<paycvv> field from the database directly.
5949
5950 If there is an error, returns the error, otherwise returns false.
5951
5952 =cut
5953
5954 sub remove_cvv {
5955   my $self = shift;
5956   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
5957     or return dbh->errstr;
5958   $sth->execute($self->custnum)
5959     or return $sth->errstr;
5960   $self->paycvv('');
5961   '';
5962 }
5963
5964 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
5965
5966 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
5967 via a Business::OnlinePayment realtime gateway.  See
5968 L<http://420.am/business-onlinepayment> for supported gateways.
5969
5970 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5971
5972 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
5973
5974 Most gateways require a reference to an original payment transaction to refund,
5975 so you probably need to specify a I<paynum>.
5976
5977 I<amount> defaults to the original amount of the payment if not specified.
5978
5979 I<reason> specifies a reason for the refund.
5980
5981 I<paydate> specifies the expiration date for a credit card overriding the
5982 value from the customer record or the payment record. Specified as yyyy-mm-dd
5983
5984 Implementation note: If I<amount> is unspecified or equal to the amount of the
5985 orignal payment, first an attempt is made to "void" the transaction via
5986 the gateway (to cancel a not-yet settled transaction) and then if that fails,
5987 the normal attempt is made to "refund" ("credit") the transaction via the
5988 gateway is attempted.
5989
5990 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5991 #I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
5992 #if set, will override the value from the customer record.
5993
5994 #If an I<invnum> is specified, this payment (if successful) is applied to the
5995 #specified invoice.  If you don't specify an I<invnum> you might want to
5996 #call the B<apply_payments> method.
5997
5998 =cut
5999
6000 #some false laziness w/realtime_bop, not enough to make it worth merging
6001 #but some useful small subs should be pulled out
6002 sub _new_realtime_refund_bop {
6003   my $self = shift;
6004
6005   my %options = ();
6006   if (ref($_[0]) ne 'HASH') {
6007     %options = %{$_[0]};
6008   } else {
6009     my $method = shift;
6010     %options = @_;
6011     $options{method} = $method;
6012   }
6013
6014   if ( $DEBUG ) {
6015     warn "$me realtime_refund_bop (new): $options{method} refund\n";
6016     warn "  $_ => $options{$_}\n" foreach keys %options;
6017   }
6018
6019   ###
6020   # look up the original payment and optionally a gateway for that payment
6021   ###
6022
6023   my $cust_pay = '';
6024   my $amount = $options{'amount'};
6025
6026   my( $processor, $login, $password, @bop_options, $namespace ) ;
6027   my( $auth, $order_number ) = ( '', '', '' );
6028
6029   if ( $options{'paynum'} ) {
6030
6031     warn "  paynum: $options{paynum}\n" if $DEBUG > 1;
6032     $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
6033       or return "Unknown paynum $options{'paynum'}";
6034     $amount ||= $cust_pay->paid;
6035
6036     $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
6037       or return "Can't parse paybatch for paynum $options{'paynum'}: ".
6038                 $cust_pay->paybatch;
6039     my $gatewaynum = '';
6040     ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
6041
6042     if ( $gatewaynum ) { #gateway for the payment to be refunded
6043
6044       my $payment_gateway =
6045         qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
6046       die "payment gateway $gatewaynum not found"
6047         unless $payment_gateway;
6048
6049       $processor   = $payment_gateway->gateway_module;
6050       $login       = $payment_gateway->gateway_username;
6051       $password    = $payment_gateway->gateway_password;
6052       $namespace   = $payment_gateway->gateway_namespace;
6053       @bop_options = $payment_gateway->options;
6054
6055     } else { #try the default gateway
6056
6057       my $conf_processor;
6058       my $payment_gateway =
6059         $self->agent->payment_gateway('method' => $options{method});
6060
6061       ( $conf_processor, $login, $password, $namespace ) =
6062         map { my $method = "gateway_$_"; $payment_gateway->$method }
6063           qw( module username password namespace );
6064
6065       @bop_options = $payment_gateway->gatewaynum
6066                        ? $payment_gateway->options
6067                        : @{ $payment_gateway->get('options') };
6068
6069       return "processor of payment $options{'paynum'} $processor does not".
6070              " match default processor $conf_processor"
6071         unless $processor eq $conf_processor;
6072
6073     }
6074
6075
6076   } else { # didn't specify a paynum, so look for agent gateway overrides
6077            # like a normal transaction
6078
6079     my $payment_gateway =
6080       $self->agent->payment_gateway( 'method'  => $options{method},
6081                                      #'payinfo' => $payinfo,
6082                                    );
6083     my( $processor, $login, $password, $namespace ) =
6084       map { my $method = "gateway_$_"; $payment_gateway->$method }
6085         qw( module username password namespace );
6086
6087     my @bop_options = $payment_gateway->gatewaynum
6088                         ? $payment_gateway->options
6089                         : @{ $payment_gateway->get('options') };
6090
6091   }
6092   return "neither amount nor paynum specified" unless $amount;
6093
6094   eval "use $namespace";
6095   die $@ if $@;
6096
6097   my %content = (
6098     'type'           => $options{method},
6099     'login'          => $login,
6100     'password'       => $password,
6101     'order_number'   => $order_number,
6102     'amount'         => $amount,
6103     'referer'        => 'http://cleanwhisker.420.am/', #XXX fix referer :/
6104   );
6105   $content{authorization} = $auth
6106     if length($auth); #echeck/ACH transactions have an order # but no auth
6107                       #(at least with authorize.net)
6108
6109   my $disable_void_after;
6110   if ($conf->exists('disable_void_after')
6111       && $conf->config('disable_void_after') =~ /^(\d+)$/) {
6112     $disable_void_after = $1;
6113   }
6114
6115   #first try void if applicable
6116   if ( $cust_pay && $cust_pay->paid == $amount
6117     && (
6118       ( not defined($disable_void_after) )
6119       || ( time < ($cust_pay->_date + $disable_void_after ) )
6120     )
6121   ) {
6122     warn "  attempting void\n" if $DEBUG > 1;
6123     my $void = new Business::OnlinePayment( $processor, @bop_options );
6124     if ( $void->can('info') ) {
6125       if ( $cust_pay->payby eq 'CARD'
6126            && $void->info('CC_void_requires_card') )
6127       {
6128         $content{'card_number'} = $cust_pay->payinfo;
6129       } elsif ( $cust_pay->payby eq 'CHEK'
6130                 && $void->info('ECHECK_void_requires_account') )
6131       {
6132         ( $content{'account_number'}, $content{'routing_code'} ) =
6133           split('@', $cust_pay->payinfo);
6134         $content{'name'} = $self->get('first'). ' '. $self->get('last');
6135       }
6136     }
6137     $void->content( 'action' => 'void', %content );
6138     $void->submit();
6139     if ( $void->is_success ) {
6140       my $error = $cust_pay->void($options{'reason'});
6141       if ( $error ) {
6142         # gah, even with transactions.
6143         my $e = 'WARNING: Card/ACH voided but database not updated - '.
6144                 "error voiding payment: $error";
6145         warn $e;
6146         return $e;
6147       }
6148       warn "  void successful\n" if $DEBUG > 1;
6149       return '';
6150     }
6151   }
6152
6153   warn "  void unsuccessful, trying refund\n"
6154     if $DEBUG > 1;
6155
6156   #massage data
6157   my $address = $self->address1;
6158   $address .= ", ". $self->address2 if $self->address2;
6159
6160   my($payname, $payfirst, $paylast);
6161   if ( $self->payname && $options{method} ne 'ECHECK' ) {
6162     $payname = $self->payname;
6163     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
6164       or return "Illegal payname $payname";
6165     ($payfirst, $paylast) = ($1, $2);
6166   } else {
6167     $payfirst = $self->getfield('first');
6168     $paylast = $self->getfield('last');
6169     $payname =  "$payfirst $paylast";
6170   }
6171
6172   my @invoicing_list = $self->invoicing_list_emailonly;
6173   if ( $conf->exists('emailinvoiceautoalways')
6174        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
6175        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
6176     push @invoicing_list, $self->all_emails;
6177   }
6178
6179   my $email = ($conf->exists('business-onlinepayment-email-override'))
6180               ? $conf->config('business-onlinepayment-email-override')
6181               : $invoicing_list[0];
6182
6183   my $payip = exists($options{'payip'})
6184                 ? $options{'payip'}
6185                 : $self->payip;
6186   $content{customer_ip} = $payip
6187     if length($payip);
6188
6189   my $payinfo = '';
6190   if ( $options{method} eq 'CC' ) {
6191
6192     if ( $cust_pay ) {
6193       $content{card_number} = $payinfo = $cust_pay->payinfo;
6194       (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
6195         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
6196         ($content{expiration} = "$2/$1");  # where available
6197     } else {
6198       $content{card_number} = $payinfo = $self->payinfo;
6199       (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
6200         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
6201       $content{expiration} = "$2/$1";
6202     }
6203
6204   } elsif ( $options{method} eq 'ECHECK' ) {
6205
6206     if ( $cust_pay ) {
6207       $payinfo = $cust_pay->payinfo;
6208     } else {
6209       $payinfo = $self->payinfo;
6210     }
6211     ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
6212     $content{bank_name} = $self->payname;
6213     $content{account_type} = 'CHECKING';
6214     $content{account_name} = $payname;
6215     $content{customer_org} = $self->company ? 'B' : 'I';
6216     $content{customer_ssn} = $self->ss;
6217   } elsif ( $options{method} eq 'LEC' ) {
6218     $content{phone} = $payinfo = $self->payinfo;
6219   }
6220
6221   #then try refund
6222   my $refund = new Business::OnlinePayment( $processor, @bop_options );
6223   my %sub_content = $refund->content(
6224     'action'         => 'credit',
6225     'customer_id'    => $self->custnum,
6226     'last_name'      => $paylast,
6227     'first_name'     => $payfirst,
6228     'name'           => $payname,
6229     'address'        => $address,
6230     'city'           => $self->city,
6231     'state'          => $self->state,
6232     'zip'            => $self->zip,
6233     'country'        => $self->country,
6234     'email'          => $email,
6235     'phone'          => $self->daytime || $self->night,
6236     %content, #after
6237   );
6238   warn join('', map { "  $_ => $sub_content{$_}\n" } keys %sub_content )
6239     if $DEBUG > 1;
6240   $refund->submit();
6241
6242   return "$processor error: ". $refund->error_message
6243     unless $refund->is_success();
6244
6245   my $paybatch = "$processor:". $refund->authorization;
6246   $paybatch .= ':'. $refund->order_number
6247     if $refund->can('order_number') && $refund->order_number;
6248
6249   while ( $cust_pay && $cust_pay->unapplied < $amount ) {
6250     my @cust_bill_pay = $cust_pay->cust_bill_pay;
6251     last unless @cust_bill_pay;
6252     my $cust_bill_pay = pop @cust_bill_pay;
6253     my $error = $cust_bill_pay->delete;
6254     last if $error;
6255   }
6256
6257   my $cust_refund = new FS::cust_refund ( {
6258     'custnum'  => $self->custnum,
6259     'paynum'   => $options{'paynum'},
6260     'refund'   => $amount,
6261     '_date'    => '',
6262     'payby'    => $bop_method2payby{$options{method}},
6263     'payinfo'  => $payinfo,
6264     'paybatch' => $paybatch,
6265     'reason'   => $options{'reason'} || 'card or ACH refund',
6266   } );
6267   my $error = $cust_refund->insert;
6268   if ( $error ) {
6269     $cust_refund->paynum(''); #try again with no specific paynum
6270     my $error2 = $cust_refund->insert;
6271     if ( $error2 ) {
6272       # gah, even with transactions.
6273       my $e = 'WARNING: Card/ACH refunded but database not updated - '.
6274               "error inserting refund ($processor): $error2".
6275               " (previously tried insert with paynum #$options{'paynum'}" .
6276               ": $error )";
6277       warn $e;
6278       return $e;
6279     }
6280   }
6281
6282   ''; #no error
6283
6284 }
6285
6286 =item batch_card OPTION => VALUE...
6287
6288 Adds a payment for this invoice to the pending credit card batch (see
6289 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
6290 runs the payment using a realtime gateway.
6291
6292 =cut
6293
6294 sub batch_card {
6295   my ($self, %options) = @_;
6296
6297   my $amount;
6298   if (exists($options{amount})) {
6299     $amount = $options{amount};
6300   }else{
6301     $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
6302   }
6303   return '' unless $amount > 0;
6304
6305   my $invnum = delete $options{invnum};
6306   my $payby = $options{invnum} || $self->payby;  #dubious
6307
6308   if ($options{'realtime'}) {
6309     return $self->realtime_bop( FS::payby->payby2bop($self->payby),
6310                                 $amount,
6311                                 %options,
6312                               );
6313   }
6314
6315   my $oldAutoCommit = $FS::UID::AutoCommit;
6316   local $FS::UID::AutoCommit = 0;
6317   my $dbh = dbh;
6318
6319   #this needs to handle mysql as well as Pg, like svc_acct.pm
6320   #(make it into a common function if folks need to do batching with mysql)
6321   $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
6322     or return "Cannot lock pay_batch: " . $dbh->errstr;
6323
6324   my %pay_batch = (
6325     'status' => 'O',
6326     'payby'  => FS::payby->payby2payment($payby),
6327   );
6328
6329   my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
6330
6331   unless ( $pay_batch ) {
6332     $pay_batch = new FS::pay_batch \%pay_batch;
6333     my $error = $pay_batch->insert;
6334     if ( $error ) {
6335       $dbh->rollback if $oldAutoCommit;
6336       die "error creating new batch: $error\n";
6337     }
6338   }
6339
6340   my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
6341       'batchnum' => $pay_batch->batchnum,
6342       'custnum'  => $self->custnum,
6343   } );
6344
6345   foreach (qw( address1 address2 city state zip country payby payinfo paydate
6346                payname )) {
6347     $options{$_} = '' unless exists($options{$_});
6348   }
6349
6350   my $cust_pay_batch = new FS::cust_pay_batch ( {
6351     'batchnum' => $pay_batch->batchnum,
6352     'invnum'   => $invnum || 0,                    # is there a better value?
6353                                                    # this field should be
6354                                                    # removed...
6355                                                    # cust_bill_pay_batch now
6356     'custnum'  => $self->custnum,
6357     'last'     => $self->getfield('last'),
6358     'first'    => $self->getfield('first'),
6359     'address1' => $options{address1} || $self->address1,
6360     'address2' => $options{address2} || $self->address2,
6361     'city'     => $options{city}     || $self->city,
6362     'state'    => $options{state}    || $self->state,
6363     'zip'      => $options{zip}      || $self->zip,
6364     'country'  => $options{country}  || $self->country,
6365     'payby'    => $options{payby}    || $self->payby,
6366     'payinfo'  => $options{payinfo}  || $self->payinfo,
6367     'exp'      => $options{paydate}  || $self->paydate,
6368     'payname'  => $options{payname}  || $self->payname,
6369     'amount'   => $amount,                         # consolidating
6370   } );
6371
6372   $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
6373     if $old_cust_pay_batch;
6374
6375   my $error;
6376   if ($old_cust_pay_batch) {
6377     $error = $cust_pay_batch->replace($old_cust_pay_batch)
6378   } else {
6379     $error = $cust_pay_batch->insert;
6380   }
6381
6382   if ( $error ) {
6383     $dbh->rollback if $oldAutoCommit;
6384     die $error;
6385   }
6386
6387   my $unapplied =   $self->total_unapplied_credits
6388                   + $self->total_unapplied_payments
6389                   + $self->in_transit_payments;
6390   foreach my $cust_bill ($self->open_cust_bill) {
6391     #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
6392     my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
6393       'invnum' => $cust_bill->invnum,
6394       'paybatchnum' => $cust_pay_batch->paybatchnum,
6395       'amount' => $cust_bill->owed,
6396       '_date' => time,
6397     };
6398     if ($unapplied >= $cust_bill_pay_batch->amount){
6399       $unapplied -= $cust_bill_pay_batch->amount;
6400       next;
6401     }else{
6402       $cust_bill_pay_batch->amount(sprintf ( "%.2f",
6403                                    $cust_bill_pay_batch->amount - $unapplied ));      $unapplied = 0;
6404     }
6405     $error = $cust_bill_pay_batch->insert;
6406     if ( $error ) {
6407       $dbh->rollback if $oldAutoCommit;
6408       die $error;
6409     }
6410   }
6411
6412   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6413   '';
6414 }
6415
6416 =item apply_payments_and_credits [ OPTION => VALUE ... ]
6417
6418 Applies unapplied payments and credits.
6419
6420 In most cases, this new method should be used in place of sequential
6421 apply_payments and apply_credits methods.
6422
6423 A hash of optional arguments may be passed.  Currently "manual" is supported.
6424 If true, a payment receipt is sent instead of a statement when
6425 'payment_receipt_email' configuration option is set.
6426
6427 If there is an error, returns the error, otherwise returns false.
6428
6429 =cut
6430
6431 sub apply_payments_and_credits {
6432   my( $self, %options ) = @_;
6433
6434   local $SIG{HUP} = 'IGNORE';
6435   local $SIG{INT} = 'IGNORE';
6436   local $SIG{QUIT} = 'IGNORE';
6437   local $SIG{TERM} = 'IGNORE';
6438   local $SIG{TSTP} = 'IGNORE';
6439   local $SIG{PIPE} = 'IGNORE';
6440
6441   my $oldAutoCommit = $FS::UID::AutoCommit;
6442   local $FS::UID::AutoCommit = 0;
6443   my $dbh = dbh;
6444
6445   $self->select_for_update; #mutex
6446
6447   foreach my $cust_bill ( $self->open_cust_bill ) {
6448     my $error = $cust_bill->apply_payments_and_credits(%options);
6449     if ( $error ) {
6450       $dbh->rollback if $oldAutoCommit;
6451       return "Error applying: $error";
6452     }
6453   }
6454
6455   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6456   ''; #no error
6457
6458 }
6459
6460 =item apply_credits OPTION => VALUE ...
6461
6462 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
6463 to outstanding invoice balances in chronological order (or reverse
6464 chronological order if the I<order> option is set to B<newest>) and returns the
6465 value of any remaining unapplied credits available for refund (see
6466 L<FS::cust_refund>).
6467
6468 Dies if there is an error.
6469
6470 =cut
6471
6472 sub apply_credits {
6473   my $self = shift;
6474   my %opt = @_;
6475
6476   local $SIG{HUP} = 'IGNORE';
6477   local $SIG{INT} = 'IGNORE';
6478   local $SIG{QUIT} = 'IGNORE';
6479   local $SIG{TERM} = 'IGNORE';
6480   local $SIG{TSTP} = 'IGNORE';
6481   local $SIG{PIPE} = 'IGNORE';
6482
6483   my $oldAutoCommit = $FS::UID::AutoCommit;
6484   local $FS::UID::AutoCommit = 0;
6485   my $dbh = dbh;
6486
6487   $self->select_for_update; #mutex
6488
6489   unless ( $self->total_unapplied_credits ) {
6490     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6491     return 0;
6492   }
6493
6494   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
6495       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
6496
6497   my @invoices = $self->open_cust_bill;
6498   @invoices = sort { $b->_date <=> $a->_date } @invoices
6499     if defined($opt{'order'}) && $opt{'order'} eq 'newest';
6500
6501   if ( $conf->exists('pkg-balances') ) {
6502     # limit @credits to those w/ a pkgnum grepped from $self
6503     my %pkgnums = ();
6504     foreach my $i (@invoices) {
6505       foreach my $li ( $i->cust_bill_pkg ) {
6506         $pkgnums{$li->pkgnum} = 1;
6507       }
6508     }
6509     @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6510   }
6511
6512   my $credit;
6513
6514   foreach my $cust_bill ( @invoices ) {
6515
6516     if ( !defined($credit) || $credit->credited == 0) {
6517       $credit = pop @credits or last;
6518     }
6519
6520     my $owed;
6521     if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6522       $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6523     } else {
6524       $owed = $cust_bill->owed;
6525     }
6526     unless ( $owed > 0 ) {
6527       push @credits, $credit;
6528       next;
6529     }
6530
6531     my $amount = min( $credit->credited, $owed );
6532
6533     my $cust_credit_bill = new FS::cust_credit_bill ( {
6534       'crednum' => $credit->crednum,
6535       'invnum'  => $cust_bill->invnum,
6536       'amount'  => $amount,
6537     } );
6538     $cust_credit_bill->pkgnum( $credit->pkgnum )
6539       if $conf->exists('pkg-balances') && $credit->pkgnum;
6540     my $error = $cust_credit_bill->insert;
6541     if ( $error ) {
6542       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6543       die $error;
6544     }
6545
6546     redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6547
6548   }
6549
6550   my $total_unapplied_credits = $self->total_unapplied_credits;
6551
6552   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6553
6554   return $total_unapplied_credits;
6555 }
6556
6557 =item apply_payments  [ OPTION => VALUE ... ]
6558
6559 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6560 to outstanding invoice balances in chronological order.
6561
6562  #and returns the value of any remaining unapplied payments.
6563
6564 A hash of optional arguments may be passed.  Currently "manual" is supported.
6565 If true, a payment receipt is sent instead of a statement when
6566 'payment_receipt_email' configuration option is set.
6567
6568 Dies if there is an error.
6569
6570 =cut
6571
6572 sub apply_payments {
6573   my( $self, %options ) = @_;
6574
6575   local $SIG{HUP} = 'IGNORE';
6576   local $SIG{INT} = 'IGNORE';
6577   local $SIG{QUIT} = 'IGNORE';
6578   local $SIG{TERM} = 'IGNORE';
6579   local $SIG{TSTP} = 'IGNORE';
6580   local $SIG{PIPE} = 'IGNORE';
6581
6582   my $oldAutoCommit = $FS::UID::AutoCommit;
6583   local $FS::UID::AutoCommit = 0;
6584   my $dbh = dbh;
6585
6586   $self->select_for_update; #mutex
6587
6588   #return 0 unless
6589
6590   my @payments = sort { $b->_date <=> $a->_date }
6591                  grep { $_->unapplied > 0 }
6592                  $self->cust_pay;
6593
6594   my @invoices = sort { $a->_date <=> $b->_date}
6595                  grep { $_->owed > 0 }
6596                  $self->cust_bill;
6597
6598   if ( $conf->exists('pkg-balances') ) {
6599     # limit @payments to those w/ a pkgnum grepped from $self
6600     my %pkgnums = ();
6601     foreach my $i (@invoices) {
6602       foreach my $li ( $i->cust_bill_pkg ) {
6603         $pkgnums{$li->pkgnum} = 1;
6604       }
6605     }
6606     @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6607   }
6608
6609   my $payment;
6610
6611   foreach my $cust_bill ( @invoices ) {
6612
6613     if ( !defined($payment) || $payment->unapplied == 0 ) {
6614       $payment = pop @payments or last;
6615     }
6616
6617     my $owed;
6618     if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6619       $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6620     } else {
6621       $owed = $cust_bill->owed;
6622     }
6623     unless ( $owed > 0 ) {
6624       push @payments, $payment;
6625       next;
6626     }
6627
6628     my $amount = min( $payment->unapplied, $owed );
6629
6630     my $cust_bill_pay = new FS::cust_bill_pay ( {
6631       'paynum' => $payment->paynum,
6632       'invnum' => $cust_bill->invnum,
6633       'amount' => $amount,
6634     } );
6635     $cust_bill_pay->pkgnum( $payment->pkgnum )
6636       if $conf->exists('pkg-balances') && $payment->pkgnum;
6637     my $error = $cust_bill_pay->insert(%options);
6638     if ( $error ) {
6639       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6640       die $error;
6641     }
6642
6643     redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6644
6645   }
6646
6647   my $total_unapplied_payments = $self->total_unapplied_payments;
6648
6649   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6650
6651   return $total_unapplied_payments;
6652 }
6653
6654 =item total_owed
6655
6656 Returns the total owed for this customer on all invoices
6657 (see L<FS::cust_bill/owed>).
6658
6659 =cut
6660
6661 sub total_owed {
6662   my $self = shift;
6663   $self->total_owed_date(2145859200); #12/31/2037
6664 }
6665
6666 =item total_owed_date TIME
6667
6668 Returns the total owed for this customer on all invoices with date earlier than
6669 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
6670 see L<Time::Local> and L<Date::Parse> for conversion functions.
6671
6672 =cut
6673
6674 sub total_owed_date {
6675   my $self = shift;
6676   my $time = shift;
6677
6678 #  my $custnum = $self->custnum;
6679 #
6680 #  my $owed_sql = FS::cust_bill->owed_sql;
6681 #
6682 #  my $sql = "
6683 #    SELECT SUM($owed_sql) FROM cust_bill
6684 #      WHERE custnum = $custnum
6685 #        AND _date <= $time
6686 #  ";
6687 #
6688 #  my $sth = dbh->prepare($sql) or die dbh->errstr;
6689 #  $sth->execute() or die $sth->errstr;
6690 #
6691 #  return sprintf( '%.2f', $sth->fetchrow_arrayref->[0] );
6692
6693   my $total_bill = 0;
6694   foreach my $cust_bill (
6695     grep { $_->_date <= $time }
6696       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6697   ) {
6698     $total_bill += $cust_bill->owed;
6699   }
6700   sprintf( "%.2f", $total_bill );
6701
6702 }
6703
6704 =item total_owed_pkgnum PKGNUM
6705
6706 Returns the total owed on all invoices for this customer's specific package
6707 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6708
6709 =cut
6710
6711 sub total_owed_pkgnum {
6712   my( $self, $pkgnum ) = @_;
6713   $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6714 }
6715
6716 =item total_owed_date_pkgnum TIME PKGNUM
6717
6718 Returns the total owed for this customer's specific package when using
6719 experimental package balances on all invoices with date earlier than
6720 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
6721 see L<Time::Local> and L<Date::Parse> for conversion functions.
6722
6723 =cut
6724
6725 sub total_owed_date_pkgnum {
6726   my( $self, $time, $pkgnum ) = @_;
6727
6728   my $total_bill = 0;
6729   foreach my $cust_bill (
6730     grep { $_->_date <= $time }
6731       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6732   ) {
6733     $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6734   }
6735   sprintf( "%.2f", $total_bill );
6736
6737 }
6738
6739 =item total_paid
6740
6741 Returns the total amount of all payments.
6742
6743 =cut
6744
6745 sub total_paid {
6746   my $self = shift;
6747   my $total = 0;
6748   $total += $_->paid foreach $self->cust_pay;
6749   sprintf( "%.2f", $total );
6750 }
6751
6752 =item total_unapplied_credits
6753
6754 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6755 customer.  See L<FS::cust_credit/credited>.
6756
6757 =item total_credited
6758
6759 Old name for total_unapplied_credits.  Don't use.
6760
6761 =cut
6762
6763 sub total_credited {
6764   #carp "total_credited deprecated, use total_unapplied_credits";
6765   shift->total_unapplied_credits(@_);
6766 }
6767
6768 sub total_unapplied_credits {
6769   my $self = shift;
6770   my $total_credit = 0;
6771   $total_credit += $_->credited foreach $self->cust_credit;
6772   sprintf( "%.2f", $total_credit );
6773 }
6774
6775 =item total_unapplied_credits_pkgnum PKGNUM
6776
6777 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6778 customer.  See L<FS::cust_credit/credited>.
6779
6780 =cut
6781
6782 sub total_unapplied_credits_pkgnum {
6783   my( $self, $pkgnum ) = @_;
6784   my $total_credit = 0;
6785   $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6786   sprintf( "%.2f", $total_credit );
6787 }
6788
6789
6790 =item total_unapplied_payments
6791
6792 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6793 See L<FS::cust_pay/unapplied>.
6794
6795 =cut
6796
6797 sub total_unapplied_payments {
6798   my $self = shift;
6799   my $total_unapplied = 0;
6800   $total_unapplied += $_->unapplied foreach $self->cust_pay;
6801   sprintf( "%.2f", $total_unapplied );
6802 }
6803
6804 =item total_unapplied_payments_pkgnum PKGNUM
6805
6806 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6807 specific package when using experimental package balances.  See
6808 L<FS::cust_pay/unapplied>.
6809
6810 =cut
6811
6812 sub total_unapplied_payments_pkgnum {
6813   my( $self, $pkgnum ) = @_;
6814   my $total_unapplied = 0;
6815   $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6816   sprintf( "%.2f", $total_unapplied );
6817 }
6818
6819
6820 =item total_unapplied_refunds
6821
6822 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6823 customer.  See L<FS::cust_refund/unapplied>.
6824
6825 =cut
6826
6827 sub total_unapplied_refunds {
6828   my $self = shift;
6829   my $total_unapplied = 0;
6830   $total_unapplied += $_->unapplied foreach $self->cust_refund;
6831   sprintf( "%.2f", $total_unapplied );
6832 }
6833
6834 =item balance
6835
6836 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6837 total_unapplied_credits minus total_unapplied_payments).
6838
6839 =cut
6840
6841 sub balance {
6842   my $self = shift;
6843   sprintf( "%.2f",
6844       $self->total_owed
6845     + $self->total_unapplied_refunds
6846     - $self->total_unapplied_credits
6847     - $self->total_unapplied_payments
6848   );
6849 }
6850
6851 =item balance_date TIME
6852
6853 Returns the balance for this customer, only considering invoices with date
6854 earlier than TIME (total_owed_date minus total_credited minus
6855 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
6856 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
6857 functions.
6858
6859 =cut
6860
6861 sub balance_date {
6862   my $self = shift;
6863   my $time = shift;
6864   sprintf( "%.2f",
6865         $self->total_owed_date($time)
6866       + $self->total_unapplied_refunds
6867       - $self->total_unapplied_credits
6868       - $self->total_unapplied_payments
6869   );
6870 }
6871
6872 =item balance_date_range START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
6873
6874 Returns the balance for this customer, only considering invoices with date
6875 earlier than START_TIME, and optionally not later than END_TIME
6876 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
6877
6878 Times are specified as SQL fragments or numeric
6879 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
6880 L<Date::Parse> for conversion functions.  The empty string can be passed
6881 to disable that time constraint completely.
6882
6883 Available options are:
6884
6885 =over 4
6886
6887 =item unapplied_date
6888
6889 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)
6890
6891 =back
6892
6893 =cut
6894
6895 sub balance_date_range {
6896   my $self = shift;
6897   my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
6898             ') FROM cust_main WHERE custnum='. $self->custnum;
6899   sprintf( "%.2f", $self->scalar_sql($sql) );
6900 }
6901
6902 =item balance_pkgnum PKGNUM
6903
6904 Returns the balance for this customer's specific package when using
6905 experimental package balances (total_owed plus total_unrefunded, minus
6906 total_unapplied_credits minus total_unapplied_payments)
6907
6908 =cut
6909
6910 sub balance_pkgnum {
6911   my( $self, $pkgnum ) = @_;
6912
6913   sprintf( "%.2f",
6914       $self->total_owed_pkgnum($pkgnum)
6915 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
6916 #    + $self->total_unapplied_refunds_pkgnum($pkgnum)
6917     - $self->total_unapplied_credits_pkgnum($pkgnum)
6918     - $self->total_unapplied_payments_pkgnum($pkgnum)
6919   );
6920 }
6921
6922 =item in_transit_payments
6923
6924 Returns the total of requests for payments for this customer pending in
6925 batches in transit to the bank.  See L<FS::pay_batch> and L<FS::cust_pay_batch>
6926
6927 =cut
6928
6929 sub in_transit_payments {
6930   my $self = shift;
6931   my $in_transit_payments = 0;
6932   foreach my $pay_batch ( qsearch('pay_batch', {
6933     'status' => 'I',
6934   } ) ) {
6935     foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
6936       'batchnum' => $pay_batch->batchnum,
6937       'custnum' => $self->custnum,
6938     } ) ) {
6939       $in_transit_payments += $cust_pay_batch->amount;
6940     }
6941   }
6942   sprintf( "%.2f", $in_transit_payments );
6943 }
6944
6945 =item payment_info
6946
6947 Returns a hash of useful information for making a payment.
6948
6949 =over 4
6950
6951 =item balance
6952
6953 Current balance.
6954
6955 =item payby
6956
6957 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
6958 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
6959 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
6960
6961 =back
6962
6963 For credit card transactions:
6964
6965 =over 4
6966
6967 =item card_type 1
6968
6969 =item payname
6970
6971 Exact name on card
6972
6973 =back
6974
6975 For electronic check transactions:
6976
6977 =over 4
6978
6979 =item stateid_state
6980
6981 =back
6982
6983 =cut
6984
6985 sub payment_info {
6986   my $self = shift;
6987
6988   my %return = ();
6989
6990   $return{balance} = $self->balance;
6991
6992   $return{payname} = $self->payname
6993                      || ( $self->first. ' '. $self->get('last') );
6994
6995   $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
6996
6997   $return{payby} = $self->payby;
6998   $return{stateid_state} = $self->stateid_state;
6999
7000   if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
7001     $return{card_type} = cardtype($self->payinfo);
7002     $return{payinfo} = $self->paymask;
7003
7004     @return{'month', 'year'} = $self->paydate_monthyear;
7005
7006   }
7007
7008   if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
7009     my ($payinfo1, $payinfo2) = split '@', $self->paymask;
7010     $return{payinfo1} = $payinfo1;
7011     $return{payinfo2} = $payinfo2;
7012     $return{paytype}  = $self->paytype;
7013     $return{paystate} = $self->paystate;
7014
7015   }
7016
7017   #doubleclick protection
7018   my $_date = time;
7019   $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
7020
7021   %return;
7022
7023 }
7024
7025 =item paydate_monthyear
7026
7027 Returns a two-element list consisting of the month and year of this customer's
7028 paydate (credit card expiration date for CARD customers)
7029
7030 =cut
7031
7032 sub paydate_monthyear {
7033   my $self = shift;
7034   if ( $self->paydate  =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
7035     ( $2, $1 );
7036   } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
7037     ( $1, $3 );
7038   } else {
7039     ('', '');
7040   }
7041 }
7042
7043 =item tax_exemption TAXNAME
7044
7045 =cut
7046
7047 sub tax_exemption {
7048   my( $self, $taxname ) = @_;
7049
7050   qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
7051                                      'taxname' => $taxname,
7052                                    },
7053           );
7054 }
7055
7056 =item cust_main_exemption
7057
7058 =cut
7059
7060 sub cust_main_exemption {
7061   my $self = shift;
7062   qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
7063 }
7064
7065 =item invoicing_list [ ARRAYREF ]
7066
7067 If an arguement is given, sets these email addresses as invoice recipients
7068 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
7069 (except as warnings), so use check_invoicing_list first.
7070
7071 Returns a list of email addresses (with svcnum entries expanded).
7072
7073 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
7074 check it without disturbing anything by passing nothing.
7075
7076 This interface may change in the future.
7077
7078 =cut
7079
7080 sub invoicing_list {
7081   my( $self, $arrayref ) = @_;
7082
7083   if ( $arrayref ) {
7084     my @cust_main_invoice;
7085     if ( $self->custnum ) {
7086       @cust_main_invoice =
7087         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7088     } else {
7089       @cust_main_invoice = ();
7090     }
7091     foreach my $cust_main_invoice ( @cust_main_invoice ) {
7092       #warn $cust_main_invoice->destnum;
7093       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
7094         #warn $cust_main_invoice->destnum;
7095         my $error = $cust_main_invoice->delete;
7096         warn $error if $error;
7097       }
7098     }
7099     if ( $self->custnum ) {
7100       @cust_main_invoice =
7101         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7102     } else {
7103       @cust_main_invoice = ();
7104     }
7105     my %seen = map { $_->address => 1 } @cust_main_invoice;
7106     foreach my $address ( @{$arrayref} ) {
7107       next if exists $seen{$address} && $seen{$address};
7108       $seen{$address} = 1;
7109       my $cust_main_invoice = new FS::cust_main_invoice ( {
7110         'custnum' => $self->custnum,
7111         'dest'    => $address,
7112       } );
7113       my $error = $cust_main_invoice->insert;
7114       warn $error if $error;
7115     }
7116   }
7117
7118   if ( $self->custnum ) {
7119     map { $_->address }
7120       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
7121   } else {
7122     ();
7123   }
7124
7125 }
7126
7127 =item check_invoicing_list ARRAYREF
7128
7129 Checks these arguements as valid input for the invoicing_list method.  If there
7130 is an error, returns the error, otherwise returns false.
7131
7132 =cut
7133
7134 sub check_invoicing_list {
7135   my( $self, $arrayref ) = @_;
7136
7137   foreach my $address ( @$arrayref ) {
7138
7139     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
7140       return 'Can\'t add FAX invoice destination with a blank FAX number.';
7141     }
7142
7143     my $cust_main_invoice = new FS::cust_main_invoice ( {
7144       'custnum' => $self->custnum,
7145       'dest'    => $address,
7146     } );
7147     my $error = $self->custnum
7148                 ? $cust_main_invoice->check
7149                 : $cust_main_invoice->checkdest
7150     ;
7151     return $error if $error;
7152
7153   }
7154
7155   return "Email address required"
7156     if $conf->exists('cust_main-require_invoicing_list_email')
7157     && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
7158
7159   '';
7160 }
7161
7162 =item set_default_invoicing_list
7163
7164 Sets the invoicing list to all accounts associated with this customer,
7165 overwriting any previous invoicing list.
7166
7167 =cut
7168
7169 sub set_default_invoicing_list {
7170   my $self = shift;
7171   $self->invoicing_list($self->all_emails);
7172 }
7173
7174 =item all_emails
7175
7176 Returns the email addresses of all accounts provisioned for this customer.
7177
7178 =cut
7179
7180 sub all_emails {
7181   my $self = shift;
7182   my %list;
7183   foreach my $cust_pkg ( $self->all_pkgs ) {
7184     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
7185     my @svc_acct =
7186       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7187         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7188           @cust_svc;
7189     $list{$_}=1 foreach map { $_->email } @svc_acct;
7190   }
7191   keys %list;
7192 }
7193
7194 =item invoicing_list_addpost
7195
7196 Adds postal invoicing to this customer.  If this customer is already configured
7197 to receive postal invoices, does nothing.
7198
7199 =cut
7200
7201 sub invoicing_list_addpost {
7202   my $self = shift;
7203   return if grep { $_ eq 'POST' } $self->invoicing_list;
7204   my @invoicing_list = $self->invoicing_list;
7205   push @invoicing_list, 'POST';
7206   $self->invoicing_list(\@invoicing_list);
7207 }
7208
7209 =item invoicing_list_emailonly
7210
7211 Returns the list of email invoice recipients (invoicing_list without non-email
7212 destinations such as POST and FAX).
7213
7214 =cut
7215
7216 sub invoicing_list_emailonly {
7217   my $self = shift;
7218   warn "$me invoicing_list_emailonly called"
7219     if $DEBUG;
7220   grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
7221 }
7222
7223 =item invoicing_list_emailonly_scalar
7224
7225 Returns the list of email invoice recipients (invoicing_list without non-email
7226 destinations such as POST and FAX) as a comma-separated scalar.
7227
7228 =cut
7229
7230 sub invoicing_list_emailonly_scalar {
7231   my $self = shift;
7232   warn "$me invoicing_list_emailonly_scalar called"
7233     if $DEBUG;
7234   join(', ', $self->invoicing_list_emailonly);
7235 }
7236
7237 =item referral_custnum_cust_main
7238
7239 Returns the customer who referred this customer (or the empty string, if
7240 this customer was not referred).
7241
7242 Note the difference with referral_cust_main method: This method,
7243 referral_custnum_cust_main returns the single customer (if any) who referred
7244 this customer, while referral_cust_main returns an array of customers referred
7245 BY this customer.
7246
7247 =cut
7248
7249 sub referral_custnum_cust_main {
7250   my $self = shift;
7251   return '' unless $self->referral_custnum;
7252   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7253 }
7254
7255 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
7256
7257 Returns an array of customers referred by this customer (referral_custnum set
7258 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
7259 customers referred by customers referred by this customer and so on, inclusive.
7260 The default behavior is DEPTH 1 (no recursion).
7261
7262 Note the difference with referral_custnum_cust_main method: This method,
7263 referral_cust_main, returns an array of customers referred BY this customer,
7264 while referral_custnum_cust_main returns the single customer (if any) who
7265 referred this customer.
7266
7267 =cut
7268
7269 sub referral_cust_main {
7270   my $self = shift;
7271   my $depth = @_ ? shift : 1;
7272   my $exclude = @_ ? shift : {};
7273
7274   my @cust_main =
7275     map { $exclude->{$_->custnum}++; $_; }
7276       grep { ! $exclude->{ $_->custnum } }
7277         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
7278
7279   if ( $depth > 1 ) {
7280     push @cust_main,
7281       map { $_->referral_cust_main($depth-1, $exclude) }
7282         @cust_main;
7283   }
7284
7285   @cust_main;
7286 }
7287
7288 =item referral_cust_main_ncancelled
7289
7290 Same as referral_cust_main, except only returns customers with uncancelled
7291 packages.
7292
7293 =cut
7294
7295 sub referral_cust_main_ncancelled {
7296   my $self = shift;
7297   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
7298 }
7299
7300 =item referral_cust_pkg [ DEPTH ]
7301
7302 Like referral_cust_main, except returns a flat list of all unsuspended (and
7303 uncancelled) packages for each customer.  The number of items in this list may
7304 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
7305
7306 =cut
7307
7308 sub referral_cust_pkg {
7309   my $self = shift;
7310   my $depth = @_ ? shift : 1;
7311
7312   map { $_->unsuspended_pkgs }
7313     grep { $_->unsuspended_pkgs }
7314       $self->referral_cust_main($depth);
7315 }
7316
7317 =item referring_cust_main
7318
7319 Returns the single cust_main record for the customer who referred this customer
7320 (referral_custnum), or false.
7321
7322 =cut
7323
7324 sub referring_cust_main {
7325   my $self = shift;
7326   return '' unless $self->referral_custnum;
7327   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7328 }
7329
7330 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
7331
7332 Applies a credit to this customer.  If there is an error, returns the error,
7333 otherwise returns false.
7334
7335 REASON can be a text string, an FS::reason object, or a scalar reference to
7336 a reasonnum.  If a text string, it will be automatically inserted as a new
7337 reason, and a 'reason_type' option must be passed to indicate the
7338 FS::reason_type for the new reason.
7339
7340 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
7341
7342 Any other options are passed to FS::cust_credit::insert.
7343
7344 =cut
7345
7346 sub credit {
7347   my( $self, $amount, $reason, %options ) = @_;
7348
7349   my $cust_credit = new FS::cust_credit {
7350     'custnum' => $self->custnum,
7351     'amount'  => $amount,
7352   };
7353
7354   if ( ref($reason) ) {
7355
7356     if ( ref($reason) eq 'SCALAR' ) {
7357       $cust_credit->reasonnum( $$reason );
7358     } else {
7359       $cust_credit->reasonnum( $reason->reasonnum );
7360     }
7361
7362   } else {
7363     $cust_credit->set('reason', $reason)
7364   }
7365
7366   $cust_credit->addlinfo( delete $options{'addlinfo'} )
7367     if exists($options{'addlinfo'});
7368
7369   $cust_credit->insert(%options);
7370
7371 }
7372
7373 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
7374
7375 Creates a one-time charge for this customer.  If there is an error, returns
7376 the error, otherwise returns false.
7377
7378 New-style, with a hashref of options:
7379
7380   my $error = $cust_main->charge(
7381                                   {
7382                                     'amount'     => 54.32,
7383                                     'quantity'   => 1,
7384                                     'start_date' => str2time('7/4/2009'),
7385                                     'pkg'        => 'Description',
7386                                     'comment'    => 'Comment',
7387                                     'additional' => [], #extra invoice detail
7388                                     'classnum'   => 1,  #pkg_class
7389
7390                                     'setuptax'   => '', # or 'Y' for tax exempt
7391
7392                                     #internal taxation
7393                                     'taxclass'   => 'Tax class',
7394
7395                                     #vendor taxation
7396                                     'taxproduct' => 2,  #part_pkg_taxproduct
7397                                     'override'   => {}, #XXX describe
7398
7399                                     #will be filled in with the new object
7400                                     'cust_pkg_ref' => \$cust_pkg,
7401
7402                                     #generate an invoice immediately
7403                                     'bill_now' => 0,
7404                                     'invoice_terms' => '', #with these terms
7405                                   }
7406                                 );
7407
7408 Old-style:
7409
7410   my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
7411
7412 =cut
7413
7414 sub charge {
7415   my $self = shift;
7416   my ( $amount, $quantity, $start_date, $classnum );
7417   my ( $pkg, $comment, $additional );
7418   my ( $setuptax, $taxclass );   #internal taxes
7419   my ( $taxproduct, $override ); #vendor (CCH) taxes
7420   my $cust_pkg_ref = '';
7421   my ( $bill_now, $invoice_terms ) = ( 0, '' );
7422   if ( ref( $_[0] ) ) {
7423     $amount     = $_[0]->{amount};
7424     $quantity   = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
7425     $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
7426     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
7427     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
7428                                            : '$'. sprintf("%.2f",$amount);
7429     $setuptax   = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
7430     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
7431     $classnum   = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
7432     $additional = $_[0]->{additional} || [];
7433     $taxproduct = $_[0]->{taxproductnum};
7434     $override   = { '' => $_[0]->{tax_override} };
7435     $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
7436     $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
7437     $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
7438   } else {
7439     $amount     = shift;
7440     $quantity   = 1;
7441     $start_date = '';
7442     $pkg        = @_ ? shift : 'One-time charge';
7443     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
7444     $setuptax   = '';
7445     $taxclass   = @_ ? shift : '';
7446     $additional = [];
7447   }
7448
7449   local $SIG{HUP} = 'IGNORE';
7450   local $SIG{INT} = 'IGNORE';
7451   local $SIG{QUIT} = 'IGNORE';
7452   local $SIG{TERM} = 'IGNORE';
7453   local $SIG{TSTP} = 'IGNORE';
7454   local $SIG{PIPE} = 'IGNORE';
7455
7456   my $oldAutoCommit = $FS::UID::AutoCommit;
7457   local $FS::UID::AutoCommit = 0;
7458   my $dbh = dbh;
7459
7460   my $part_pkg = new FS::part_pkg ( {
7461     'pkg'           => $pkg,
7462     'comment'       => $comment,
7463     'plan'          => 'flat',
7464     'freq'          => 0,
7465     'disabled'      => 'Y',
7466     'classnum'      => $classnum ? $classnum : '',
7467     'setuptax'      => $setuptax,
7468     'taxclass'      => $taxclass,
7469     'taxproductnum' => $taxproduct,
7470   } );
7471
7472   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
7473                         ( 0 .. @$additional - 1 )
7474                   ),
7475                   'additional_count' => scalar(@$additional),
7476                   'setup_fee' => $amount,
7477                 );
7478
7479   my $error = $part_pkg->insert( options       => \%options,
7480                                  tax_overrides => $override,
7481                                );
7482   if ( $error ) {
7483     $dbh->rollback if $oldAutoCommit;
7484     return $error;
7485   }
7486
7487   my $pkgpart = $part_pkg->pkgpart;
7488   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
7489   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
7490     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
7491     $error = $type_pkgs->insert;
7492     if ( $error ) {
7493       $dbh->rollback if $oldAutoCommit;
7494       return $error;
7495     }
7496   }
7497
7498   my $cust_pkg = new FS::cust_pkg ( {
7499     'custnum'    => $self->custnum,
7500     'pkgpart'    => $pkgpart,
7501     'quantity'   => $quantity,
7502     'start_date' => $start_date,
7503   } );
7504
7505   $error = $cust_pkg->insert;
7506   if ( $error ) {
7507     $dbh->rollback if $oldAutoCommit;
7508     return $error;
7509   } elsif ( $cust_pkg_ref ) {
7510     ${$cust_pkg_ref} = $cust_pkg;
7511   }
7512
7513   if ( $bill_now ) {
7514     my $error = $self->bill( 'invoice_terms' => $invoice_terms,
7515                              'pkg_list'      => [ $cust_pkg ],
7516                            );
7517     if ( $error ) {
7518       $dbh->rollback if $oldAutoCommit;
7519       return $error;
7520     }
7521   }
7522
7523   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7524   return '';
7525
7526 }
7527
7528 #=item charge_postal_fee
7529 #
7530 #Applies a one time charge this customer.  If there is an error,
7531 #returns the error, returns the cust_pkg charge object or false
7532 #if there was no charge.
7533 #
7534 #=cut
7535 #
7536 # This should be a customer event.  For that to work requires that bill
7537 # also be a customer event.
7538
7539 sub charge_postal_fee {
7540   my $self = shift;
7541
7542   my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7543   return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7544
7545   my $cust_pkg = new FS::cust_pkg ( {
7546     'custnum'  => $self->custnum,
7547     'pkgpart'  => $pkgpart,
7548     'quantity' => 1,
7549   } );
7550
7551   my $error = $cust_pkg->insert;
7552   $error ? $error : $cust_pkg;
7553 }
7554
7555 =item cust_bill
7556
7557 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7558
7559 =cut
7560
7561 sub cust_bill {
7562   my $self = shift;
7563   map { $_ } #return $self->num_cust_bill unless wantarray;
7564   sort { $a->_date <=> $b->_date }
7565     qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7566 }
7567
7568 =item open_cust_bill
7569
7570 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7571 customer.
7572
7573 =cut
7574
7575 sub open_cust_bill {
7576   my $self = shift;
7577
7578   qsearch({
7579     'table'     => 'cust_bill',
7580     'hashref'   => { 'custnum' => $self->custnum, },
7581     'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7582     'order_by'  => 'ORDER BY _date ASC',
7583   });
7584
7585 }
7586
7587 =item cust_statements
7588
7589 Returns all the statements (see L<FS::cust_statement>) for this customer.
7590
7591 =cut
7592
7593 sub cust_statement {
7594   my $self = shift;
7595   map { $_ } #return $self->num_cust_statement unless wantarray;
7596   sort { $a->_date <=> $b->_date }
7597     qsearch('cust_statement', { 'custnum' => $self->custnum, } )
7598 }
7599
7600 =item cust_credit
7601
7602 Returns all the credits (see L<FS::cust_credit>) for this customer.
7603
7604 =cut
7605
7606 sub cust_credit {
7607   my $self = shift;
7608   map { $_ } #return $self->num_cust_credit unless wantarray;
7609   sort { $a->_date <=> $b->_date }
7610     qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7611 }
7612
7613 =item cust_credit_pkgnum
7614
7615 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7616 package when using experimental package balances.
7617
7618 =cut
7619
7620 sub cust_credit_pkgnum {
7621   my( $self, $pkgnum ) = @_;
7622   map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
7623   sort { $a->_date <=> $b->_date }
7624     qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7625                               'pkgnum'  => $pkgnum,
7626                             }
7627     );
7628 }
7629
7630 =item cust_pay
7631
7632 Returns all the payments (see L<FS::cust_pay>) for this customer.
7633
7634 =cut
7635
7636 sub cust_pay {
7637   my $self = shift;
7638   return $self->num_cust_pay unless wantarray;
7639   sort { $a->_date <=> $b->_date }
7640     qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7641 }
7642
7643 =item num_cust_pay
7644
7645 Returns the number of payments (see L<FS::cust_pay>) for this customer.  Also
7646 called automatically when the cust_pay method is used in a scalar context.
7647
7648 =cut
7649
7650 sub num_cust_pay {
7651   my $self = shift;
7652   my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
7653   my $sth = dbh->prepare($sql) or die dbh->errstr;
7654   $sth->execute($self->custnum) or die $sth->errstr;
7655   $sth->fetchrow_arrayref->[0];
7656 }
7657
7658 =item cust_pay_pkgnum
7659
7660 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7661 package when using experimental package balances.
7662
7663 =cut
7664
7665 sub cust_pay_pkgnum {
7666   my( $self, $pkgnum ) = @_;
7667   map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
7668   sort { $a->_date <=> $b->_date }
7669     qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7670                            'pkgnum'  => $pkgnum,
7671                          }
7672     );
7673 }
7674
7675 =item cust_pay_void
7676
7677 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7678
7679 =cut
7680
7681 sub cust_pay_void {
7682   my $self = shift;
7683   map { $_ } #return $self->num_cust_pay_void unless wantarray;
7684   sort { $a->_date <=> $b->_date }
7685     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7686 }
7687
7688 =item cust_pay_batch
7689
7690 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7691
7692 =cut
7693
7694 sub cust_pay_batch {
7695   my $self = shift;
7696   map { $_ } #return $self->num_cust_pay_batch unless wantarray;
7697   sort { $a->paybatchnum <=> $b->paybatchnum }
7698     qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7699 }
7700
7701 =item cust_pay_pending
7702
7703 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7704 (without status "done").
7705
7706 =cut
7707
7708 sub cust_pay_pending {
7709   my $self = shift;
7710   return $self->num_cust_pay_pending unless wantarray;
7711   sort { $a->_date <=> $b->_date }
7712     qsearch( 'cust_pay_pending', {
7713                                    'custnum' => $self->custnum,
7714                                    'status'  => { op=>'!=', value=>'done' },
7715                                  },
7716            );
7717 }
7718
7719 =item num_cust_pay_pending
7720
7721 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7722 customer (without status "done").  Also called automatically when the
7723 cust_pay_pending method is used in a scalar context.
7724
7725 =cut
7726
7727 sub num_cust_pay_pending {
7728   my $self = shift;
7729   my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
7730             "   WHERE custnum = ? AND status != 'done' ";
7731   my $sth = dbh->prepare($sql) or die dbh->errstr;
7732   $sth->execute($self->custnum) or die $sth->errstr;
7733   $sth->fetchrow_arrayref->[0];
7734 }
7735
7736 =item cust_refund
7737
7738 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7739
7740 =cut
7741
7742 sub cust_refund {
7743   my $self = shift;
7744   map { $_ } #return $self->num_cust_refund unless wantarray;
7745   sort { $a->_date <=> $b->_date }
7746     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7747 }
7748
7749 =item display_custnum
7750
7751 Returns the displayed customer number for this customer: agent_custid if
7752 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7753
7754 =cut
7755
7756 sub display_custnum {
7757   my $self = shift;
7758   if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7759     return $self->agent_custid;
7760   } else {
7761     return $self->custnum;
7762   }
7763 }
7764
7765 =item name
7766
7767 Returns a name string for this customer, either "Company (Last, First)" or
7768 "Last, First".
7769
7770 =cut
7771
7772 sub name {
7773   my $self = shift;
7774   my $name = $self->contact;
7775   $name = $self->company. " ($name)" if $self->company;
7776   $name;
7777 }
7778
7779 =item ship_name
7780
7781 Returns a name string for this (service/shipping) contact, either
7782 "Company (Last, First)" or "Last, First".
7783
7784 =cut
7785
7786 sub ship_name {
7787   my $self = shift;
7788   if ( $self->get('ship_last') ) {
7789     my $name = $self->ship_contact;
7790     $name = $self->ship_company. " ($name)" if $self->ship_company;
7791     $name;
7792   } else {
7793     $self->name;
7794   }
7795 }
7796
7797 =item name_short
7798
7799 Returns a name string for this customer, either "Company" or "First Last".
7800
7801 =cut
7802
7803 sub name_short {
7804   my $self = shift;
7805   $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7806 }
7807
7808 =item ship_name_short
7809
7810 Returns a name string for this (service/shipping) contact, either "Company"
7811 or "First Last".
7812
7813 =cut
7814
7815 sub ship_name_short {
7816   my $self = shift;
7817   if ( $self->get('ship_last') ) {
7818     $self->ship_company !~ /^\s*$/
7819       ? $self->ship_company
7820       : $self->ship_contact_firstlast;
7821   } else {
7822     $self->name_company_or_firstlast;
7823   }
7824 }
7825
7826 =item contact
7827
7828 Returns this customer's full (billing) contact name only, "Last, First"
7829
7830 =cut
7831
7832 sub contact {
7833   my $self = shift;
7834   $self->get('last'). ', '. $self->first;
7835 }
7836
7837 =item ship_contact
7838
7839 Returns this customer's full (shipping) contact name only, "Last, First"
7840
7841 =cut
7842
7843 sub ship_contact {
7844   my $self = shift;
7845   $self->get('ship_last')
7846     ? $self->get('ship_last'). ', '. $self->ship_first
7847     : $self->contact;
7848 }
7849
7850 =item contact_firstlast
7851
7852 Returns this customers full (billing) contact name only, "First Last".
7853
7854 =cut
7855
7856 sub contact_firstlast {
7857   my $self = shift;
7858   $self->first. ' '. $self->get('last');
7859 }
7860
7861 =item ship_contact_firstlast
7862
7863 Returns this customer's full (shipping) contact name only, "First Last".
7864
7865 =cut
7866
7867 sub ship_contact_firstlast {
7868   my $self = shift;
7869   $self->get('ship_last')
7870     ? $self->first. ' '. $self->get('ship_last')
7871     : $self->contact_firstlast;
7872 }
7873
7874 =item country_full
7875
7876 Returns this customer's full country name
7877
7878 =cut
7879
7880 sub country_full {
7881   my $self = shift;
7882   code2country($self->country);
7883 }
7884
7885 =item geocode DATA_VENDOR
7886
7887 Returns a value for the customer location as encoded by DATA_VENDOR.
7888 Currently this only makes sense for "CCH" as DATA_VENDOR.
7889
7890 =cut
7891
7892 sub geocode {
7893   my ($self, $data_vendor) = (shift, shift);  #always cch for now
7894
7895   my $geocode = $self->get('geocode');  #XXX only one data_vendor for geocode
7896   return $geocode if $geocode;
7897
7898   my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
7899                ? 'ship_'
7900                : '';
7901
7902   my($zip,$plus4) = split /-/, $self->get("${prefix}zip")
7903     if $self->country eq 'US';
7904
7905   $zip ||= '';
7906   $plus4 ||= '';
7907   #CCH specific location stuff
7908   my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
7909
7910   my @cust_tax_location =
7911     qsearch( {
7912                'table'     => 'cust_tax_location',
7913                'hashref'   => { 'zip' => $zip, 'data_vendor' => $data_vendor },
7914                'extra_sql' => $extra_sql,
7915                'order_by'  => 'ORDER BY plus4hi',#overlapping with distinct ends
7916              }
7917            );
7918   $geocode = $cust_tax_location[0]->geocode
7919     if scalar(@cust_tax_location);
7920
7921   $geocode;
7922 }
7923
7924 =item cust_status
7925
7926 =item status
7927
7928 Returns a status string for this customer, currently:
7929
7930 =over 4
7931
7932 =item prospect - No packages have ever been ordered
7933
7934 =item active - One or more recurring packages is active
7935
7936 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
7937
7938 =item suspended - All non-cancelled recurring packages are suspended
7939
7940 =item cancelled - All recurring packages are cancelled
7941
7942 =back
7943
7944 =cut
7945
7946 sub status { shift->cust_status(@_); }
7947
7948 sub cust_status {
7949   my $self = shift;
7950   for my $status (qw( prospect active inactive suspended cancelled )) {
7951     my $method = $status.'_sql';
7952     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
7953     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
7954     $sth->execute( ($self->custnum) x $numnum )
7955       or die "Error executing 'SELECT $sql': ". $sth->errstr;
7956     return $status if $sth->fetchrow_arrayref->[0];
7957   }
7958 }
7959
7960 =item ucfirst_cust_status
7961
7962 =item ucfirst_status
7963
7964 Returns the status with the first character capitalized.
7965
7966 =cut
7967
7968 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
7969
7970 sub ucfirst_cust_status {
7971   my $self = shift;
7972   ucfirst($self->cust_status);
7973 }
7974
7975 =item statuscolor
7976
7977 Returns a hex triplet color string for this customer's status.
7978
7979 =cut
7980
7981 use vars qw(%statuscolor);
7982 tie %statuscolor, 'Tie::IxHash',
7983   'prospect'  => '7e0079', #'000000', #black?  naw, purple
7984   'active'    => '00CC00', #green
7985   'inactive'  => '0000CC', #blue
7986   'suspended' => 'FF9900', #yellow
7987   'cancelled' => 'FF0000', #red
7988 ;
7989
7990 sub statuscolor { shift->cust_statuscolor(@_); }
7991
7992 sub cust_statuscolor {
7993   my $self = shift;
7994   $statuscolor{$self->cust_status};
7995 }
7996
7997 =item tickets
7998
7999 Returns an array of hashes representing the customer's RT tickets.
8000
8001 =cut
8002
8003 sub tickets {
8004   my $self = shift;
8005
8006   my $num = $conf->config('cust_main-max_tickets') || 10;
8007   my @tickets = ();
8008
8009   if ( $conf->config('ticket_system') ) {
8010     unless ( $conf->config('ticket_system-custom_priority_field') ) {
8011
8012       @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
8013
8014     } else {
8015
8016       foreach my $priority (
8017         $conf->config('ticket_system-custom_priority_field-values'), ''
8018       ) {
8019         last if scalar(@tickets) >= $num;
8020         push @tickets,
8021           @{ FS::TicketSystem->customer_tickets( $self->custnum,
8022                                                  $num - scalar(@tickets),
8023                                                  $priority,
8024                                                )
8025            };
8026       }
8027     }
8028   }
8029   (@tickets);
8030 }
8031
8032 # Return services representing svc_accts in customer support packages
8033 sub support_services {
8034   my $self = shift;
8035   my %packages = map { $_ => 1 } $conf->config('support_packages');
8036
8037   grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
8038     grep { $_->part_svc->svcdb eq 'svc_acct' }
8039     map { $_->cust_svc }
8040     grep { exists $packages{ $_->pkgpart } }
8041     $self->ncancelled_pkgs;
8042
8043 }
8044
8045 # Return a list of latitude/longitude for one of the services (if any)
8046 sub service_coordinates {
8047   my $self = shift;
8048
8049   my @svc_X =
8050     grep { $_->latitude && $_->longitude }
8051     map { $_->svc_x }
8052     map { $_->cust_svc }
8053     $self->ncancelled_pkgs;
8054
8055   scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
8056 }
8057
8058 =back
8059
8060 =head1 CLASS METHODS
8061
8062 =over 4
8063
8064 =item statuses
8065
8066 Class method that returns the list of possible status strings for customers
8067 (see L<the status method|/status>).  For example:
8068
8069   @statuses = FS::cust_main->statuses();
8070
8071 =cut
8072
8073 sub statuses {
8074   #my $self = shift; #could be class...
8075   keys %statuscolor;
8076 }
8077
8078 =item prospect_sql
8079
8080 Returns an SQL expression identifying prospective cust_main records (customers
8081 with no packages ever ordered)
8082
8083 =cut
8084
8085 use vars qw($select_count_pkgs);
8086 $select_count_pkgs =
8087   "SELECT COUNT(*) FROM cust_pkg
8088     WHERE cust_pkg.custnum = cust_main.custnum";
8089
8090 sub select_count_pkgs_sql {
8091   $select_count_pkgs;
8092 }
8093
8094 sub prospect_sql { "
8095   0 = ( $select_count_pkgs )
8096 "; }
8097
8098 =item active_sql
8099
8100 Returns an SQL expression identifying active cust_main records (customers with
8101 active recurring packages).
8102
8103 =cut
8104
8105 sub active_sql { "
8106   0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
8107       )
8108 "; }
8109
8110 =item inactive_sql
8111
8112 Returns an SQL expression identifying inactive cust_main records (customers with
8113 no active recurring packages, but otherwise unsuspended/uncancelled).
8114
8115 =cut
8116
8117 sub inactive_sql { "
8118   0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8119   AND
8120   0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8121 "; }
8122
8123 =item susp_sql
8124 =item suspended_sql
8125
8126 Returns an SQL expression identifying suspended cust_main records.
8127
8128 =cut
8129
8130
8131 sub suspended_sql { susp_sql(@_); }
8132 sub susp_sql { "
8133     0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
8134     AND
8135     0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8136 "; }
8137
8138 =item cancel_sql
8139 =item cancelled_sql
8140
8141 Returns an SQL expression identifying cancelled cust_main records.
8142
8143 =cut
8144
8145 sub cancelled_sql { cancel_sql(@_); }
8146 sub cancel_sql {
8147
8148   my $recurring_sql = FS::cust_pkg->recurring_sql;
8149   my $cancelled_sql = FS::cust_pkg->cancelled_sql;
8150
8151   "
8152         0 < ( $select_count_pkgs )
8153     AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql   )
8154     AND 0 = ( $select_count_pkgs AND $recurring_sql
8155                   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
8156             )
8157     AND 0 = (  $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8158   ";
8159
8160 }
8161
8162 =item uncancel_sql
8163 =item uncancelled_sql
8164
8165 Returns an SQL expression identifying un-cancelled cust_main records.
8166
8167 =cut
8168
8169 sub uncancelled_sql { uncancel_sql(@_); }
8170 sub uncancel_sql { "
8171   ( 0 < ( $select_count_pkgs
8172                    AND ( cust_pkg.cancel IS NULL
8173                          OR cust_pkg.cancel = 0
8174                        )
8175         )
8176     OR 0 = ( $select_count_pkgs )
8177   )
8178 "; }
8179
8180 =item balance_sql
8181
8182 Returns an SQL fragment to retreive the balance.
8183
8184 =cut
8185
8186 sub balance_sql { "
8187     ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
8188         WHERE cust_bill.custnum   = cust_main.custnum     )
8189   - ( SELECT COALESCE( SUM(paid),    0 ) FROM cust_pay
8190         WHERE cust_pay.custnum    = cust_main.custnum     )
8191   - ( SELECT COALESCE( SUM(amount),  0 ) FROM cust_credit
8192         WHERE cust_credit.custnum = cust_main.custnum     )
8193   + ( SELECT COALESCE( SUM(refund),  0 ) FROM cust_refund
8194         WHERE cust_refund.custnum = cust_main.custnum     )
8195 "; }
8196
8197 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8198
8199 Returns an SQL fragment to retreive the balance for this customer, only
8200 considering invoices with date earlier than START_TIME, and optionally not
8201 later than END_TIME (total_owed_date minus total_unapplied_credits minus
8202 total_unapplied_payments).
8203
8204 Times are specified as SQL fragments or numeric
8205 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
8206 L<Date::Parse> for conversion functions.  The empty string can be passed
8207 to disable that time constraint completely.
8208
8209 Available options are:
8210
8211 =over 4
8212
8213 =item unapplied_date
8214
8215 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)
8216
8217 =item total
8218
8219 (unused.  obsolete?)
8220 set to true to remove all customer comparison clauses, for totals
8221
8222 =item where
8223
8224 (unused.  obsolete?)
8225 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
8226
8227 =item join
8228
8229 (unused.  obsolete?)
8230 JOIN clause (typically used with the total option)
8231
8232 =back
8233
8234 =cut
8235
8236 sub balance_date_sql {
8237   my( $class, $start, $end, %opt ) = @_;
8238
8239   my $owed         = FS::cust_bill->owed_sql;
8240   my $unapp_refund = FS::cust_refund->unapplied_sql;
8241   my $unapp_credit = FS::cust_credit->unapplied_sql;
8242   my $unapp_pay    = FS::cust_pay->unapplied_sql;
8243
8244   my $j = $opt{'join'} || '';
8245
8246   my $owed_wh   = $class->_money_table_where( 'cust_bill',   $start,$end,%opt );
8247   my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
8248   my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
8249   my $pay_wh    = $class->_money_table_where( 'cust_pay',    $start,$end,%opt );
8250
8251   "   ( SELECT COALESCE(SUM($owed),         0) FROM cust_bill   $j $owed_wh   )
8252     + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
8253     - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
8254     - ( SELECT COALESCE(SUM($unapp_pay),    0) FROM cust_pay    $j $pay_wh    )
8255   ";
8256
8257 }
8258
8259 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
8260
8261 Returns an SQL fragment to retreive the total unapplied payments for this
8262 customer, only considering invoices with date earlier than START_TIME, and
8263 optionally not later than END_TIME.
8264
8265 Times are specified as SQL fragments or numeric
8266 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
8267 L<Date::Parse> for conversion functions.  The empty string can be passed
8268 to disable that time constraint completely.
8269
8270 Available options are:
8271
8272 =cut
8273
8274 sub unapplied_payments_date_sql {
8275   my( $class, $start, $end, ) = @_;
8276
8277   my $unapp_pay    = FS::cust_pay->unapplied_sql;
8278
8279   my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
8280                                                           'unapplied_date'=>1 );
8281
8282   " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
8283 }
8284
8285 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8286
8287 Helper method for balance_date_sql; name (and usage) subject to change
8288 (suggestions welcome).
8289
8290 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
8291 cust_refund, cust_credit or cust_pay).
8292
8293 If TABLE is "cust_bill" or the unapplied_date option is true, only
8294 considers records with date earlier than START_TIME, and optionally not
8295 later than END_TIME .
8296
8297 =cut
8298
8299 sub _money_table_where {
8300   my( $class, $table, $start, $end, %opt ) = @_;
8301
8302   my @where = ();
8303   push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
8304   if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
8305     push @where, "$table._date <= $start" if defined($start) && length($start);
8306     push @where, "$table._date >  $end"   if defined($end)   && length($end);
8307   }
8308   push @where, @{$opt{'where'}} if $opt{'where'};
8309   my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
8310
8311   $where;
8312
8313 }
8314
8315 =item search HASHREF
8316
8317 (Class method)
8318
8319 Returns a qsearch hash expression to search for parameters specified in
8320 HASHREF.  Valid parameters are
8321
8322 =over 4
8323
8324 =item agentnum
8325
8326 =item status
8327
8328 =item cancelled_pkgs
8329
8330 bool
8331
8332 =item signupdate
8333
8334 listref of start date, end date
8335
8336 =item payby
8337
8338 listref
8339
8340 =item paydate_year
8341
8342 =item paydate_month
8343
8344 =item current_balance
8345
8346 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
8347
8348 =item cust_fields
8349
8350 =item flattened_pkgs
8351
8352 bool
8353
8354 =back
8355
8356 =cut
8357
8358 sub search {
8359   my ($class, $params) = @_;
8360
8361   my $dbh = dbh;
8362
8363   my @where = ();
8364   my $orderby;
8365
8366   ##
8367   # parse agent
8368   ##
8369
8370   if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
8371     push @where,
8372       "cust_main.agentnum = $1";
8373   }
8374
8375   ##
8376   # parse status
8377   ##
8378
8379   #prospect active inactive suspended cancelled
8380   if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
8381     my $method = $params->{'status'}. '_sql';
8382     #push @where, $class->$method();
8383     push @where, FS::cust_main->$method();
8384   }
8385
8386   ##
8387   # parse cancelled package checkbox
8388   ##
8389
8390   my $pkgwhere = "";
8391
8392   $pkgwhere .= "AND (cancel = 0 or cancel is null)"
8393     unless $params->{'cancelled_pkgs'};
8394
8395   ##
8396   # parse without census tract checkbox
8397   ##
8398
8399   push @where, "(censustract = '' or censustract is null)"
8400     if $params->{'no_censustract'};
8401
8402   ##
8403   # dates
8404   ##
8405
8406   foreach my $field (qw( signupdate )) {
8407
8408     next unless exists($params->{$field});
8409
8410     my($beginning, $ending) = @{$params->{$field}};
8411
8412     push @where,
8413       "cust_main.$field IS NOT NULL",
8414       "cust_main.$field >= $beginning",
8415       "cust_main.$field <= $ending";
8416
8417     $orderby ||= "ORDER BY cust_main.$field";
8418
8419   }
8420
8421   ###
8422   # payby
8423   ###
8424
8425   if ( $params->{'payby'} ) {
8426
8427     my @payby = ref( $params->{'payby'} )
8428                   ? @{ $params->{'payby'} }
8429                   :  ( $params->{'payby'} );
8430
8431     @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8432
8433     push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )'
8434       if @payby;
8435
8436   }
8437
8438   my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8439   if ( @payby ) {
8440     push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
8441   }
8442
8443   ###
8444   # paydate_year / paydate_month
8445   ###
8446
8447   if ( $params->{'paydate_year'} =~ /^(\d{4})$/ ) {
8448     my $year = $1;
8449     $params->{'paydate_month'} =~ /^(\d\d?)$/
8450       or die "paydate_year without paydate_month?";
8451     my $month = $1;
8452
8453     push @where,
8454       'paydate IS NOT NULL',
8455       "paydate != ''",
8456       "CAST(paydate AS timestamp) < CAST('$year-$month-01' AS timestamp )"
8457 ;
8458   }
8459
8460   ###
8461   # invoice terms
8462   ###
8463
8464   if ( $params->{'invoice_terms'} =~ /^([\w ]+)$/ ) {
8465     my $terms = $1;
8466     if ( $1 eq 'NULL' ) {
8467       push @where,
8468         "( cust_main.invoice_terms IS NULL OR cust_main.invoice_terms = '' )";
8469     } else {
8470       push @where,
8471         "cust_main.invoice_terms IS NOT NULL",
8472         "cust_main.invoice_terms = '$1'";
8473     }
8474   }
8475
8476   ##
8477   # amounts
8478   ##
8479
8480   if ( $params->{'current_balance'} ) {
8481
8482     #my $balance_sql = $class->balance_sql();
8483     my $balance_sql = FS::cust_main->balance_sql();
8484
8485     my @current_balance =
8486       ref( $params->{'current_balance'} )
8487       ? @{ $params->{'current_balance'} }
8488       :  ( $params->{'current_balance'} );
8489
8490     push @where, map { s/current_balance/$balance_sql/; $_ }
8491                      @current_balance;
8492
8493   }
8494
8495   ##
8496   # custbatch
8497   ##
8498
8499   if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
8500     push @where,
8501       "cust_main.custbatch = '$1'";
8502   }
8503
8504   ##
8505   # setup queries, subs, etc. for the search
8506   ##
8507
8508   $orderby ||= 'ORDER BY custnum';
8509
8510   # here is the agent virtualization
8511   push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
8512
8513   my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
8514
8515   my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum  ) ';
8516
8517   my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
8518
8519   my $select = join(', ',
8520                  'cust_main.custnum',
8521                  FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
8522                );
8523
8524   my(@extra_headers) = ();
8525   my(@extra_fields)  = ();
8526
8527   if ($params->{'flattened_pkgs'}) {
8528
8529     if ($dbh->{Driver}->{Name} eq 'Pg') {
8530
8531       $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";
8532
8533     }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
8534       $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
8535       $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
8536     }else{
8537       warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
8538            "omitting packing information from report.";
8539     }
8540
8541     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";
8542
8543     my $sth = dbh->prepare($header_query) or die dbh->errstr;
8544     $sth->execute() or die $sth->errstr;
8545     my $headerrow = $sth->fetchrow_arrayref;
8546     my $headercount = $headerrow ? $headerrow->[0] : 0;
8547     while($headercount) {
8548       unshift @extra_headers, "Package ". $headercount;
8549       unshift @extra_fields, eval q!sub {my $c = shift;
8550                                          my @a = split '\|', $c->magic;
8551                                          my $p = $a[!.--$headercount. q!];
8552                                          $p;
8553                                         };!;
8554     }
8555
8556   }
8557
8558   my $sql_query = {
8559     'table'         => 'cust_main',
8560     'select'        => $select,
8561     'hashref'       => {},
8562     'extra_sql'     => $extra_sql,
8563     'order_by'      => $orderby,
8564     'count_query'   => $count_query,
8565     'extra_headers' => \@extra_headers,
8566     'extra_fields'  => \@extra_fields,
8567   };
8568
8569 }
8570
8571 =item email_search_result HASHREF
8572
8573 (Class method)
8574
8575 Emails a notice to the specified customers.
8576
8577 Valid parameters are those of the L<search> method, plus the following:
8578
8579 =over 4
8580
8581 =item from
8582
8583 From: address
8584
8585 =item subject
8586
8587 Email Subject:
8588
8589 =item html_body
8590
8591 HTML body
8592
8593 =item text_body
8594
8595 Text body
8596
8597 =item job
8598
8599 Optional job queue job for status updates.
8600
8601 =back
8602
8603 Returns an error message, or false for success.
8604
8605 If an error occurs during any email, stops the enture send and returns that
8606 error.  Presumably if you're getting SMTP errors aborting is better than
8607 retrying everything.
8608
8609 =cut
8610
8611 sub email_search_result {
8612   my($class, $params) = @_;
8613
8614   my $from = delete $params->{from};
8615   my $subject = delete $params->{subject};
8616   my $html_body = delete $params->{html_body};
8617   my $text_body = delete $params->{text_body};
8618
8619   my $job = delete $params->{'job'};
8620
8621   $params->{'payby'} = [ split(/\0/, $params->{'payby'}) ]
8622     unless ref($params->{'payby'});
8623
8624   my $sql_query = $class->search($params);
8625
8626   my $count_query   = delete($sql_query->{'count_query'});
8627   my $count_sth = dbh->prepare($count_query)
8628     or die "Error preparing $count_query: ". dbh->errstr;
8629   $count_sth->execute
8630     or die "Error executing $count_query: ". $count_sth->errstr;
8631   my $count_arrayref = $count_sth->fetchrow_arrayref;
8632   my $num_cust = $count_arrayref->[0];
8633
8634   #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8635   #my @extra_fields  = @{ delete($sql_query->{'extra_fields'})  };
8636
8637
8638   my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8639
8640   #eventually order+limit magic to reduce memory use?
8641   foreach my $cust_main ( qsearch($sql_query) ) {
8642
8643     my $to = $cust_main->invoicing_list_emailonly_scalar;
8644     next unless $to;
8645
8646     my $error = send_email(
8647       generate_email(
8648         'from'      => $from,
8649         'to'        => $to,
8650         'subject'   => $subject,
8651         'html_body' => $html_body,
8652         'text_body' => $text_body,
8653       )
8654     );
8655     return $error if $error;
8656
8657     if ( $job ) { #progressbar foo
8658       $num++;
8659       if ( time - $min_sec > $last ) {
8660         my $error = $job->update_statustext(
8661           int( 100 * $num / $num_cust )
8662         );
8663         die $error if $error;
8664         $last = time;
8665       }
8666     }
8667
8668   }
8669
8670   return '';
8671 }
8672
8673 use Storable qw(thaw);
8674 use Data::Dumper;
8675 use MIME::Base64;
8676 sub process_email_search_result {
8677   my $job = shift;
8678   #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8679
8680   my $param = thaw(decode_base64(shift));
8681   warn Dumper($param) if $DEBUG;
8682
8683   $param->{'job'} = $job;
8684
8685   $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ]
8686     unless ref($param->{'payby'});
8687
8688   my $error = FS::cust_main->email_search_result( $param );
8689   die $error if $error;
8690
8691 }
8692
8693 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8694
8695 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8696 records.  Currently, I<first>, I<last>, I<company> and/or I<address1> may be
8697 specified (the appropriate ship_ field is also searched).
8698
8699 Additional options are the same as FS::Record::qsearch
8700
8701 =cut
8702
8703 sub fuzzy_search {
8704   my( $self, $fuzzy, $hash, @opt) = @_;
8705   #$self
8706   $hash ||= {};
8707   my @cust_main = ();
8708
8709   check_and_rebuild_fuzzyfiles();
8710   foreach my $field ( keys %$fuzzy ) {
8711
8712     my $all = $self->all_X($field);
8713     next unless scalar(@$all);
8714
8715     my %match = ();
8716     $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8717
8718     my @fcust = ();
8719     foreach ( keys %match ) {
8720       push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8721       push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8722     }
8723     my %fsaw = ();
8724     push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8725   }
8726
8727   # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8728   my %saw = ();
8729   @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8730
8731   @cust_main;
8732
8733 }
8734
8735 =item masked FIELD
8736
8737 Returns a masked version of the named field
8738
8739 =cut
8740
8741 sub masked {
8742 my ($self,$field) = @_;
8743
8744 # Show last four
8745
8746 'x'x(length($self->getfield($field))-4).
8747   substr($self->getfield($field), (length($self->getfield($field))-4));
8748
8749 }
8750
8751 =back
8752
8753 =head1 SUBROUTINES
8754
8755 =over 4
8756
8757 =item smart_search OPTION => VALUE ...
8758
8759 Accepts the following options: I<search>, the string to search for.  The string
8760 will be searched for as a customer number, phone number, name or company name,
8761 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8762 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8763 skip fuzzy matching when an exact match is found.
8764
8765 Any additional options are treated as an additional qualifier on the search
8766 (i.e. I<agentnum>).
8767
8768 Returns a (possibly empty) array of FS::cust_main objects.
8769
8770 =cut
8771
8772 sub smart_search {
8773   my %options = @_;
8774
8775   #here is the agent virtualization
8776   my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8777
8778   my @cust_main = ();
8779
8780   my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8781   my $search = delete $options{'search'};
8782   ( my $alphanum_search = $search ) =~ s/\W//g;
8783
8784   if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8785
8786     #false laziness w/Record::ut_phone
8787     my $phonen = "$1-$2-$3";
8788     $phonen .= " x$4" if $4;
8789
8790     push @cust_main, qsearch( {
8791       'table'   => 'cust_main',
8792       'hashref' => { %options },
8793       'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8794                      ' ( '.
8795                          join(' OR ', map "$_ = '$phonen'",
8796                                           qw( daytime night fax
8797                                               ship_daytime ship_night ship_fax )
8798                              ).
8799                      ' ) '.
8800                      " AND $agentnums_sql", #agent virtualization
8801     } );
8802
8803     unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8804       #try looking for matches with extensions unless one was specified
8805
8806       push @cust_main, qsearch( {
8807         'table'   => 'cust_main',
8808         'hashref' => { %options },
8809         'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8810                        ' ( '.
8811                            join(' OR ', map "$_ LIKE '$phonen\%'",
8812                                             qw( daytime night
8813                                                 ship_daytime ship_night )
8814                                ).
8815                        ' ) '.
8816                        " AND $agentnums_sql", #agent virtualization
8817       } );
8818
8819     }
8820
8821   # custnum search (also try agent_custid), with some tweaking options if your
8822   # legacy cust "numbers" have letters
8823   }
8824
8825   if ( $search =~ /^\s*(\d+)\s*$/
8826          || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8827               && $search =~ /^\s*(\w\w?\d+)\s*$/
8828             )
8829          || ( $conf->exists('address1-search' )
8830               && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
8831             )
8832      )
8833   {
8834
8835     my $num = $1;
8836
8837     if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
8838       push @cust_main, qsearch( {
8839         'table'     => 'cust_main',
8840         'hashref'   => { 'custnum' => $num, %options },
8841         'extra_sql' => " AND $agentnums_sql", #agent virtualization
8842       } );
8843     }
8844
8845     push @cust_main, qsearch( {
8846       'table'     => 'cust_main',
8847       'hashref'   => { 'agent_custid' => $num, %options },
8848       'extra_sql' => " AND $agentnums_sql", #agent virtualization
8849     } );
8850
8851     if ( $conf->exists('address1-search') ) {
8852       my $len = length($num);
8853       $num = lc($num);
8854       foreach my $prefix ( '', 'ship_' ) {
8855         push @cust_main, qsearch( {
8856           'table'     => 'cust_main',
8857           'hashref'   => { %options, },
8858           'extra_sql' =>
8859             ( keys(%options) ? ' AND ' : ' WHERE ' ).
8860             " LOWER(SUBSTRING(${prefix}address1 FROM 1 FOR $len)) = '$num' ".
8861             " AND $agentnums_sql",
8862         } );
8863       }
8864     }
8865
8866   } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
8867
8868     my($company, $last, $first) = ( $1, $2, $3 );
8869
8870     # "Company (Last, First)"
8871     #this is probably something a browser remembered,
8872     #so just do an exact search (but case-insensitive, so USPS standardization
8873     #doesn't throw a wrench in the works)
8874
8875     foreach my $prefix ( '', 'ship_' ) {
8876       push @cust_main, qsearch( {
8877         'table'     => 'cust_main',
8878         'hashref'   => { %options },
8879         'extra_sql' =>
8880           ( keys(%options) ? ' AND ' : ' WHERE ' ).
8881           join(' AND ',
8882             " LOWER(${prefix}first)   = ". dbh->quote(lc($first)),
8883             " LOWER(${prefix}last)    = ". dbh->quote(lc($last)),
8884             " LOWER(${prefix}company) = ". dbh->quote(lc($company)),
8885             $agentnums_sql,
8886           ),
8887       } );
8888     }
8889
8890   } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
8891                                               # try (ship_){last,company}
8892
8893     my $value = lc($1);
8894
8895     # # remove "(Last, First)" in "Company (Last, First)", otherwise the
8896     # # full strings the browser remembers won't work
8897     # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
8898
8899     use Lingua::EN::NameParse;
8900     my $NameParse = new Lingua::EN::NameParse(
8901              auto_clean     => 1,
8902              allow_reversed => 1,
8903     );
8904
8905     my($last, $first) = ( '', '' );
8906     #maybe disable this too and just rely on NameParse?
8907     if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
8908
8909       ($last, $first) = ( $1, $2 );
8910
8911     #} elsif  ( $value =~ /^(.+)\s+(.+)$/ ) {
8912     } elsif ( ! $NameParse->parse($value) ) {
8913
8914       my %name = $NameParse->components;
8915       $first = $name{'given_name_1'};
8916       $last  = $name{'surname_1'};
8917
8918     }
8919
8920     if ( $first && $last ) {
8921
8922       my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
8923
8924       #exact
8925       my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8926       $sql .= "
8927         (     ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
8928            OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
8929         )";
8930
8931       push @cust_main, qsearch( {
8932         'table'     => 'cust_main',
8933         'hashref'   => \%options,
8934         'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8935       } );
8936
8937       # or it just be something that was typed in... (try that in a sec)
8938
8939     }
8940
8941     my $q_value = dbh->quote($value);
8942
8943     #exact
8944     my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8945     $sql .= " (    LOWER(last)          = $q_value
8946                 OR LOWER(company)       = $q_value
8947                 OR LOWER(ship_last)     = $q_value
8948                 OR LOWER(ship_company)  = $q_value
8949             ";
8950     $sql .= "   OR LOWER(address1)      = $q_value
8951                 OR LOWER(ship_address1) = $q_value
8952             "
8953       if $conf->exists('address1-search');
8954     $sql .= " )";
8955
8956     push @cust_main, qsearch( {
8957       'table'     => 'cust_main',
8958       'hashref'   => \%options,
8959       'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8960     } );
8961
8962     #no exact match, trying substring/fuzzy
8963     #always do substring & fuzzy (unless they're explicity config'ed off)
8964     #getting complaints searches are not returning enough
8965     unless ( @cust_main  && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
8966
8967       #still some false laziness w/search (was search/cust_main.cgi)
8968
8969       #substring
8970
8971       my @hashrefs = (
8972         { 'company'      => { op=>'ILIKE', value=>"%$value%" }, },
8973         { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
8974       );
8975
8976       if ( $first && $last ) {
8977
8978         push @hashrefs,
8979           { 'first'        => { op=>'ILIKE', value=>"%$first%" },
8980             'last'         => { op=>'ILIKE', value=>"%$last%" },
8981           },
8982           { 'ship_first'   => { op=>'ILIKE', value=>"%$first%" },
8983             'ship_last'    => { op=>'ILIKE', value=>"%$last%" },
8984           },
8985         ;
8986
8987       } else {
8988
8989         push @hashrefs,
8990           { 'last'         => { op=>'ILIKE', value=>"%$value%" }, },
8991           { 'ship_last'    => { op=>'ILIKE', value=>"%$value%" }, },
8992         ;
8993       }
8994
8995       if ( $conf->exists('address1-search') ) {
8996         push @hashrefs,
8997           { 'address1'      => { op=>'ILIKE', value=>"%$value%" }, },
8998           { 'ship_address1' => { op=>'ILIKE', value=>"%$value%" }, },
8999         ;
9000       }
9001
9002       foreach my $hashref ( @hashrefs ) {
9003
9004         push @cust_main, qsearch( {
9005           'table'     => 'cust_main',
9006           'hashref'   => { %$hashref,
9007                            %options,
9008                          },
9009           'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
9010         } );
9011
9012       }
9013
9014       #fuzzy
9015       my @fuzopts = (
9016         \%options,                #hashref
9017         '',                       #select
9018         " AND $agentnums_sql",    #extra_sql  #agent virtualization
9019       );
9020
9021       if ( $first && $last ) {
9022         push @cust_main, FS::cust_main->fuzzy_search(
9023           { 'last'   => $last,    #fuzzy hashref
9024             'first'  => $first }, #
9025           @fuzopts
9026         );
9027       }
9028       foreach my $field ( 'last', 'company' ) {
9029         push @cust_main,
9030           FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
9031       }
9032       if ( $conf->exists('address1-search') ) {
9033         push @cust_main,
9034           FS::cust_main->fuzzy_search( { 'address1' => $value }, @fuzopts );
9035       }
9036
9037     }
9038
9039   }
9040
9041   #eliminate duplicates
9042   my %saw = ();
9043   @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
9044
9045   @cust_main;
9046
9047 }
9048
9049 =item email_search
9050
9051 Accepts the following options: I<email>, the email address to search for.  The
9052 email address will be searched for as an email invoice destination and as an
9053 svc_acct account.
9054
9055 #Any additional options are treated as an additional qualifier on the search
9056 #(i.e. I<agentnum>).
9057
9058 Returns a (possibly empty) array of FS::cust_main objects (but usually just
9059 none or one).
9060
9061 =cut
9062
9063 sub email_search {
9064   my %options = @_;
9065
9066   local($DEBUG) = 1;
9067
9068   my $email = delete $options{'email'};
9069
9070   #we're only being used by RT at the moment... no agent virtualization yet
9071   #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
9072
9073   my @cust_main = ();
9074
9075   if ( $email =~ /([^@]+)\@([^@]+)/ ) {
9076
9077     my ( $user, $domain ) = ( $1, $2 );
9078
9079     warn "$me smart_search: searching for $user in domain $domain"
9080       if $DEBUG;
9081
9082     push @cust_main,
9083       map $_->cust_main,
9084           qsearch( {
9085                      'table'     => 'cust_main_invoice',
9086                      'hashref'   => { 'dest' => $email },
9087                    }
9088                  );
9089
9090     push @cust_main,
9091       map  $_->cust_main,
9092       grep $_,
9093       map  $_->cust_svc->cust_pkg,
9094           qsearch( {
9095                      'table'     => 'svc_acct',
9096                      'hashref'   => { 'username' => $user, },
9097                      'extra_sql' =>
9098                        'AND ( SELECT domain FROM svc_domain
9099                                 WHERE svc_acct.domsvc = svc_domain.svcnum
9100                             ) = '. dbh->quote($domain),
9101                    }
9102                  );
9103   }
9104
9105   my %saw = ();
9106   @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
9107
9108   warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
9109     if $DEBUG;
9110
9111   @cust_main;
9112
9113 }
9114
9115 =item check_and_rebuild_fuzzyfiles
9116
9117 =cut
9118
9119 sub check_and_rebuild_fuzzyfiles {
9120   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9121   rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
9122 }
9123
9124 =item rebuild_fuzzyfiles
9125
9126 =cut
9127
9128 sub rebuild_fuzzyfiles {
9129
9130   use Fcntl qw(:flock);
9131
9132   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9133   mkdir $dir, 0700 unless -d $dir;
9134
9135   foreach my $fuzzy ( @fuzzyfields ) {
9136
9137     open(LOCK,">>$dir/cust_main.$fuzzy")
9138       or die "can't open $dir/cust_main.$fuzzy: $!";
9139     flock(LOCK,LOCK_EX)
9140       or die "can't lock $dir/cust_main.$fuzzy: $!";
9141
9142     open (CACHE,">$dir/cust_main.$fuzzy.tmp")
9143       or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
9144
9145     foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
9146       my $sth = dbh->prepare("SELECT $field FROM cust_main".
9147                              " WHERE $field != '' AND $field IS NOT NULL");
9148       $sth->execute or die $sth->errstr;
9149
9150       while ( my $row = $sth->fetchrow_arrayref ) {
9151         print CACHE $row->[0]. "\n";
9152       }
9153
9154     }
9155
9156     close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
9157
9158     rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
9159     close LOCK;
9160   }
9161
9162 }
9163
9164 =item all_X
9165
9166 =cut
9167
9168 sub all_X {
9169   my( $self, $field ) = @_;
9170   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9171   open(CACHE,"<$dir/cust_main.$field")
9172     or die "can't open $dir/cust_main.$field: $!";
9173   my @array = map { chomp; $_; } <CACHE>;
9174   close CACHE;
9175   \@array;
9176 }
9177
9178 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
9179
9180 =cut
9181
9182 sub append_fuzzyfiles {
9183   #my( $first, $last, $company ) = @_;
9184
9185   &check_and_rebuild_fuzzyfiles;
9186
9187   use Fcntl qw(:flock);
9188
9189   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
9190
9191   foreach my $field (@fuzzyfields) {
9192     my $value = shift;
9193
9194     if ( $value ) {
9195
9196       open(CACHE,">>$dir/cust_main.$field")
9197         or die "can't open $dir/cust_main.$field: $!";
9198       flock(CACHE,LOCK_EX)
9199         or die "can't lock $dir/cust_main.$field: $!";
9200
9201       print CACHE "$value\n";
9202
9203       flock(CACHE,LOCK_UN)
9204         or die "can't unlock $dir/cust_main.$field: $!";
9205       close CACHE;
9206     }
9207
9208   }
9209
9210   1;
9211 }
9212
9213 =item batch_charge
9214
9215 =cut
9216
9217 sub batch_charge {
9218   my $param = shift;
9219   #warn join('-',keys %$param);
9220   my $fh = $param->{filehandle};
9221   my @fields = @{$param->{fields}};
9222
9223   eval "use Text::CSV_XS;";
9224   die $@ if $@;
9225
9226   my $csv = new Text::CSV_XS;
9227   #warn $csv;
9228   #warn $fh;
9229
9230   my $imported = 0;
9231   #my $columns;
9232
9233   local $SIG{HUP} = 'IGNORE';
9234   local $SIG{INT} = 'IGNORE';
9235   local $SIG{QUIT} = 'IGNORE';
9236   local $SIG{TERM} = 'IGNORE';
9237   local $SIG{TSTP} = 'IGNORE';
9238   local $SIG{PIPE} = 'IGNORE';
9239
9240   my $oldAutoCommit = $FS::UID::AutoCommit;
9241   local $FS::UID::AutoCommit = 0;
9242   my $dbh = dbh;
9243
9244   #while ( $columns = $csv->getline($fh) ) {
9245   my $line;
9246   while ( defined($line=<$fh>) ) {
9247
9248     $csv->parse($line) or do {
9249       $dbh->rollback if $oldAutoCommit;
9250       return "can't parse: ". $csv->error_input();
9251     };
9252
9253     my @columns = $csv->fields();
9254     #warn join('-',@columns);
9255
9256     my %row = ();
9257     foreach my $field ( @fields ) {
9258       $row{$field} = shift @columns;
9259     }
9260
9261     my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
9262     unless ( $cust_main ) {
9263       $dbh->rollback if $oldAutoCommit;
9264       return "unknown custnum $row{'custnum'}";
9265     }
9266
9267     if ( $row{'amount'} > 0 ) {
9268       my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
9269       if ( $error ) {
9270         $dbh->rollback if $oldAutoCommit;
9271         return $error;
9272       }
9273       $imported++;
9274     } elsif ( $row{'amount'} < 0 ) {
9275       my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
9276                                       $row{'pkg'}                         );
9277       if ( $error ) {
9278         $dbh->rollback if $oldAutoCommit;
9279         return $error;
9280       }
9281       $imported++;
9282     } else {
9283       #hmm?
9284     }
9285
9286   }
9287
9288   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
9289
9290   return "Empty file!" unless $imported;
9291
9292   ''; #no error
9293
9294 }
9295
9296 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9297
9298 Sends a templated email notification to the customer (see L<Text::Template>).
9299
9300 OPTIONS is a hash and may include
9301
9302 I<from> - the email sender (default is invoice_from)
9303
9304 I<to> - comma-separated scalar or arrayref of recipients
9305    (default is invoicing_list)
9306
9307 I<subject> - The subject line of the sent email notification
9308    (default is "Notice from company_name")
9309
9310 I<extra_fields> - a hashref of name/value pairs which will be substituted
9311    into the template
9312
9313 The following variables are vavailable in the template.
9314
9315 I<$first> - the customer first name
9316 I<$last> - the customer last name
9317 I<$company> - the customer company
9318 I<$payby> - a description of the method of payment for the customer
9319             # would be nice to use FS::payby::shortname
9320 I<$payinfo> - the account information used to collect for this customer
9321 I<$expdate> - the expiration of the customer payment in seconds from epoch
9322
9323 =cut
9324
9325 sub notify {
9326   my ($self, $template, %options) = @_;
9327
9328   return unless $conf->exists($template);
9329
9330   my $from = $conf->config('invoice_from', $self->agentnum)
9331     if $conf->exists('invoice_from', $self->agentnum);
9332   $from = $options{from} if exists($options{from});
9333
9334   my $to = join(',', $self->invoicing_list_emailonly);
9335   $to = $options{to} if exists($options{to});
9336
9337   my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
9338     if $conf->exists('company_name', $self->agentnum);
9339   $subject = $options{subject} if exists($options{subject});
9340
9341   my $notify_template = new Text::Template (TYPE => 'ARRAY',
9342                                             SOURCE => [ map "$_\n",
9343                                               $conf->config($template)]
9344                                            )
9345     or die "can't create new Text::Template object: Text::Template::ERROR";
9346   $notify_template->compile()
9347     or die "can't compile template: Text::Template::ERROR";
9348
9349   $FS::notify_template::_template::company_name =
9350     $conf->config('company_name', $self->agentnum);
9351   $FS::notify_template::_template::company_address =
9352     join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
9353
9354   my $paydate = $self->paydate || '2037-12-31';
9355   $FS::notify_template::_template::first = $self->first;
9356   $FS::notify_template::_template::last = $self->last;
9357   $FS::notify_template::_template::company = $self->company;
9358   $FS::notify_template::_template::payinfo = $self->mask_payinfo;
9359   my $payby = $self->payby;
9360   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9361   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9362
9363   #credit cards expire at the end of the month/year of their exp date
9364   if ($payby eq 'CARD' || $payby eq 'DCRD') {
9365     $FS::notify_template::_template::payby = 'credit card';
9366     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9367     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9368     $expire_time--;
9369   }elsif ($payby eq 'COMP') {
9370     $FS::notify_template::_template::payby = 'complimentary account';
9371   }else{
9372     $FS::notify_template::_template::payby = 'current method';
9373   }
9374   $FS::notify_template::_template::expdate = $expire_time;
9375
9376   for (keys %{$options{extra_fields}}){
9377     no strict "refs";
9378     ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
9379   }
9380
9381   send_email(from => $from,
9382              to => $to,
9383              subject => $subject,
9384              body => $notify_template->fill_in( PACKAGE =>
9385                                                 'FS::notify_template::_template'                                              ),
9386             );
9387
9388 }
9389
9390 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9391
9392 Generates a templated notification to the customer (see L<Text::Template>).
9393
9394 OPTIONS is a hash and may include
9395
9396 I<extra_fields> - a hashref of name/value pairs which will be substituted
9397    into the template.  These values may override values mentioned below
9398    and those from the customer record.
9399
9400 The following variables are available in the template instead of or in addition
9401 to the fields of the customer record.
9402
9403 I<$payby> - a description of the method of payment for the customer
9404             # would be nice to use FS::payby::shortname
9405 I<$payinfo> - the masked account information used to collect for this customer
9406 I<$expdate> - the expiration of the customer payment method in seconds from epoch
9407 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
9408
9409 =cut
9410
9411 sub generate_letter {
9412   my ($self, $template, %options) = @_;
9413
9414   return unless $conf->exists($template);
9415
9416   my $letter_template = new Text::Template
9417                         ( TYPE       => 'ARRAY',
9418                           SOURCE     => [ map "$_\n", $conf->config($template)],
9419                           DELIMITERS => [ '[@--', '--@]' ],
9420                         )
9421     or die "can't create new Text::Template object: Text::Template::ERROR";
9422
9423   $letter_template->compile()
9424     or die "can't compile template: Text::Template::ERROR";
9425
9426   my %letter_data = map { $_ => $self->$_ } $self->fields;
9427   $letter_data{payinfo} = $self->mask_payinfo;
9428
9429   #my $paydate = $self->paydate || '2037-12-31';
9430   my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
9431
9432   my $payby = $self->payby;
9433   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9434   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9435
9436   #credit cards expire at the end of the month/year of their exp date
9437   if ($payby eq 'CARD' || $payby eq 'DCRD') {
9438     $letter_data{payby} = 'credit card';
9439     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9440     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9441     $expire_time--;
9442   }elsif ($payby eq 'COMP') {
9443     $letter_data{payby} = 'complimentary account';
9444   }else{
9445     $letter_data{payby} = 'current method';
9446   }
9447   $letter_data{expdate} = $expire_time;
9448
9449   for (keys %{$options{extra_fields}}){
9450     $letter_data{$_} = $options{extra_fields}->{$_};
9451   }
9452
9453   unless(exists($letter_data{returnaddress})){
9454     my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
9455                                                   $self->agent_template)
9456                      );
9457     if ( length($retadd) ) {
9458       $letter_data{returnaddress} = $retadd;
9459     } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
9460       $letter_data{returnaddress} =
9461         join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
9462                           $conf->config('company_address', $self->agentnum)
9463         );
9464     } else {
9465       $letter_data{returnaddress} = '~';
9466     }
9467   }
9468
9469   $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
9470
9471   $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
9472
9473   my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
9474   my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9475                            DIR      => $dir,
9476                            SUFFIX   => '.tex',
9477                            UNLINK   => 0,
9478                          ) or die "can't open temp file: $!\n";
9479
9480   $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
9481   close $fh;
9482   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
9483   return $1;
9484 }
9485
9486 =item print_ps TEMPLATE
9487
9488 Returns an postscript letter filled in from TEMPLATE, as a scalar.
9489
9490 =cut
9491
9492 sub print_ps {
9493   my $self = shift;
9494   my $file = $self->generate_letter(@_);
9495   FS::Misc::generate_ps($file);
9496 }
9497
9498 =item print TEMPLATE
9499
9500 Prints the filled in template.
9501
9502 TEMPLATE is the name of a L<Text::Template> to fill in and print.
9503
9504 =cut
9505
9506 sub queueable_print {
9507   my %opt = @_;
9508
9509   my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
9510     or die "invalid customer number: " . $opt{custvnum};
9511
9512   my $error = $self->print( $opt{template} );
9513   die $error if $error;
9514 }
9515
9516 sub print {
9517   my ($self, $template) = (shift, shift);
9518   do_print [ $self->print_ps($template) ];
9519 }
9520
9521 #these three subs should just go away once agent stuff is all config overrides
9522
9523 sub agent_template {
9524   my $self = shift;
9525   $self->_agent_plandata('agent_templatename');
9526 }
9527
9528 sub agent_invoice_from {
9529   my $self = shift;
9530   $self->_agent_plandata('agent_invoice_from');
9531 }
9532
9533 sub _agent_plandata {
9534   my( $self, $option ) = @_;
9535
9536   #yuck.  this whole thing needs to be reconciled better with 1.9's idea of
9537   #agent-specific Conf
9538
9539   use FS::part_event::Condition;
9540
9541   my $agentnum = $self->agentnum;
9542
9543   my $regexp = '';
9544   if ( driver_name =~ /^Pg/i ) {
9545     $regexp = '~';
9546   } elsif ( driver_name =~ /^mysql/i ) {
9547     $regexp = 'REGEXP';
9548   } else {
9549     die "don't know how to use regular expressions in ". driver_name. " databases";
9550   }
9551
9552   my $part_event_option =
9553     qsearchs({
9554       'select'    => 'part_event_option.*',
9555       'table'     => 'part_event_option',
9556       'addl_from' => q{
9557         LEFT JOIN part_event USING ( eventpart )
9558         LEFT JOIN part_event_option AS peo_agentnum
9559           ON ( part_event.eventpart = peo_agentnum.eventpart
9560                AND peo_agentnum.optionname = 'agentnum'
9561                AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
9562              )
9563         LEFT JOIN part_event_condition
9564           ON ( part_event.eventpart = part_event_condition.eventpart
9565                AND part_event_condition.conditionname = 'cust_bill_age'
9566              )
9567         LEFT JOIN part_event_condition_option
9568           ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
9569                AND part_event_condition_option.optionname = 'age'
9570              )
9571       },
9572       #'hashref'   => { 'optionname' => $option },
9573       #'hashref'   => { 'part_event_option.optionname' => $option },
9574       'extra_sql' =>
9575         " WHERE part_event_option.optionname = ". dbh->quote($option).
9576         " AND action = 'cust_bill_send_agent' ".
9577         " AND ( disabled IS NULL OR disabled != 'Y' ) ".
9578         " AND peo_agentnum.optionname = 'agentnum' ".
9579         " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
9580         " ORDER BY
9581            CASE WHEN part_event_condition_option.optionname IS NULL
9582            THEN -1
9583            ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
9584         " END
9585           , part_event.weight".
9586         " LIMIT 1"
9587     });
9588
9589   unless ( $part_event_option ) {
9590     return $self->agent->invoice_template || ''
9591       if $option eq 'agent_templatename';
9592     return '';
9593   }
9594
9595   $part_event_option->optionvalue;
9596
9597 }
9598
9599 sub queued_bill {
9600   ## actual sub, not a method, designed to be called from the queue.
9601   ## sets up the customer, and calls the bill_and_collect
9602   my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
9603   my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
9604       $cust_main->bill_and_collect(
9605         %args,
9606       );
9607 }
9608
9609 sub _upgrade_data { #class method
9610   my ($class, %opts) = @_;
9611
9612   my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
9613   my $sth = dbh->prepare($sql) or die dbh->errstr;
9614   $sth->execute or die $sth->errstr;
9615
9616 }
9617
9618 =back
9619
9620 =head1 BUGS
9621
9622 The delete method.
9623
9624 The delete method should possibly take an FS::cust_main object reference
9625 instead of a scalar customer number.
9626
9627 Bill and collect options should probably be passed as references instead of a
9628 list.
9629
9630 There should probably be a configuration file with a list of allowed credit
9631 card types.
9632
9633 No multiple currency support (probably a larger project than just this module).
9634
9635 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9636
9637 Birthdates rely on negative epoch values.
9638
9639 The payby for card/check batches is broken.  With mixed batching, bad
9640 things will happen.
9641
9642 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9643
9644 =head1 SEE ALSO
9645
9646 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9647 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9648 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
9649
9650 =cut
9651
9652 1;
9653