FS/FS/cust_main.pm

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