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