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