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