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 ncancelled_pkgs [ EXTRA_QSEARCH_PARAMS_HASHREF ]
1959
1960 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1961
1962 =cut
1963
1964 sub ncancelled_pkgs {
1965   my $self = shift;
1966   my $extra_qsearch = ref($_[0]) ? shift : {};
1967
1968   return $self->num_ncancelled_pkgs unless wantarray;
1969
1970   my @cust_pkg = ();
1971   if ( $self->{'_pkgnum'} ) {
1972
1973     warn "$me ncancelled_pkgs: returning cached objects"
1974       if $DEBUG > 1;
1975
1976     @cust_pkg = grep { ! $_->getfield('cancel') }
1977                 values %{ $self->{'_pkgnum'}->cache };
1978
1979   } else {
1980
1981     warn "$me ncancelled_pkgs: searching for packages with custnum ".
1982          $self->custnum. "\n"
1983       if $DEBUG > 1;
1984
1985     $extra_qsearch->{'extra_sql'} .= ' AND ( cancel IS NULL OR cancel = 0 ) ';
1986
1987     @cust_pkg = $self->_cust_pkg($extra_qsearch);
1988
1989   }
1990
1991   sort sort_packages @cust_pkg;
1992
1993 }
1994
1995 sub _cust_pkg {
1996   my $self = shift;
1997   my $extra_qsearch = ref($_[0]) ? shift : {};
1998
1999   $extra_qsearch->{'select'} ||= '*';
2000   $extra_qsearch->{'select'} .=
2001    ',( SELECT COUNT(*) FROM cust_svc WHERE cust_pkg.pkgnum = cust_svc.pkgnum )
2002      AS _num_cust_svc';
2003
2004   map {
2005         $_->{'_num_cust_svc'} = $_->get('_num_cust_svc');
2006         $_;
2007       }
2008   qsearch({
2009     %$extra_qsearch,
2010     'table'   => 'cust_pkg',
2011     'hashref' => { 'custnum' => $self->custnum },
2012   });
2013
2014 }
2015
2016 # This should be generalized to use config options to determine order.
2017 sub sort_packages {
2018
2019   if ( $a->get('cancel') xor $b->get('cancel') ) {
2020     return -1 if $b->get('cancel');
2021     return  1 if $a->get('cancel');
2022     #shouldn't get here...
2023     return 0;
2024   } else {
2025     my $a_num_cust_svc = $a->num_cust_svc;
2026     my $b_num_cust_svc = $b->num_cust_svc;
2027     return 0  if !$a_num_cust_svc && !$b_num_cust_svc;
2028     return -1 if  $a_num_cust_svc && !$b_num_cust_svc;
2029     return 1  if !$a_num_cust_svc &&  $b_num_cust_svc;
2030     my @a_cust_svc = $a->cust_svc;
2031     my @b_cust_svc = $b->cust_svc;
2032     $a_cust_svc[0]->svc_x->label cmp $b_cust_svc[0]->svc_x->label;
2033   }
2034
2035 }
2036
2037 =item suspended_pkgs
2038
2039 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
2040
2041 =cut
2042
2043 sub suspended_pkgs {
2044   my $self = shift;
2045   grep { $_->susp } $self->ncancelled_pkgs;
2046 }
2047
2048 =item unflagged_suspended_pkgs
2049
2050 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
2051 customer (thouse packages without the `manual_flag' set).
2052
2053 =cut
2054
2055 sub unflagged_suspended_pkgs {
2056   my $self = shift;
2057   return $self->suspended_pkgs
2058     unless dbdef->table('cust_pkg')->column('manual_flag');
2059   grep { ! $_->manual_flag } $self->suspended_pkgs;
2060 }
2061
2062 =item unsuspended_pkgs
2063
2064 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
2065 this customer.
2066
2067 =cut
2068
2069 sub unsuspended_pkgs {
2070   my $self = shift;
2071   grep { ! $_->susp } $self->ncancelled_pkgs;
2072 }
2073
2074 =item next_bill_date
2075
2076 Returns the next date this customer will be billed, as a UNIX timestamp, or
2077 undef if no active package has a next bill date.
2078
2079 =cut
2080
2081 sub next_bill_date {
2082   my $self = shift;
2083   min( map $_->get('bill'), grep $_->get('bill'), $self->unsuspended_pkgs );
2084 }
2085
2086 =item num_cancelled_pkgs
2087
2088 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
2089 customer.
2090
2091 =cut
2092
2093 sub num_cancelled_pkgs {
2094   shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
2095 }
2096
2097 sub num_ncancelled_pkgs {
2098   shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
2099 }
2100
2101 sub num_pkgs {
2102   my( $self ) = shift;
2103   my $sql = scalar(@_) ? shift : '';
2104   $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
2105   my $sth = dbh->prepare(
2106     "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
2107   ) or die dbh->errstr;
2108   $sth->execute($self->custnum) or die $sth->errstr;
2109   $sth->fetchrow_arrayref->[0];
2110 }
2111
2112 =item unsuspend
2113
2114 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2115 and L<FS::cust_pkg>) for this customer.  Always returns a list: an empty list
2116 on success or a list of errors.
2117
2118 =cut
2119
2120 sub unsuspend {
2121   my $self = shift;
2122   grep { $_->unsuspend } $self->suspended_pkgs;
2123 }
2124
2125 =item suspend
2126
2127 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2128
2129 Returns a list: an empty list on success or a list of errors.
2130
2131 =cut
2132
2133 sub suspend {
2134   my $self = shift;
2135   grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2136 }
2137
2138 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2139
2140 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2141 PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref instead
2142 of a list of pkgparts; the hashref has the following keys:
2143
2144 =over 4
2145
2146 =item pkgparts - listref of pkgparts
2147
2148 =item (other options are passed to the suspend method)
2149
2150 =back
2151
2152
2153 Returns a list: an empty list on success or a list of errors.
2154
2155 =cut
2156
2157 sub suspend_if_pkgpart {
2158   my $self = shift;
2159   my (@pkgparts, %opt);
2160   if (ref($_[0]) eq 'HASH'){
2161     @pkgparts = @{$_[0]{pkgparts}};
2162     %opt      = %{$_[0]};
2163   }else{
2164     @pkgparts = @_;
2165   }
2166   grep { $_->suspend(%opt) }
2167     grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2168       $self->unsuspended_pkgs;
2169 }
2170
2171 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2172
2173 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2174 given PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref
2175 instead of a list of pkgparts; the hashref has the following keys:
2176
2177 =over 4
2178
2179 =item pkgparts - listref of pkgparts
2180
2181 =item (other options are passed to the suspend method)
2182
2183 =back
2184
2185 Returns a list: an empty list on success or a list of errors.
2186
2187 =cut
2188
2189 sub suspend_unless_pkgpart {
2190   my $self = shift;
2191   my (@pkgparts, %opt);
2192   if (ref($_[0]) eq 'HASH'){
2193     @pkgparts = @{$_[0]{pkgparts}};
2194     %opt      = %{$_[0]};
2195   }else{
2196     @pkgparts = @_;
2197   }
2198   grep { $_->suspend(%opt) }
2199     grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2200       $self->unsuspended_pkgs;
2201 }
2202
2203 =item cancel [ OPTION => VALUE ... ]
2204
2205 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2206
2207 Available options are:
2208
2209 =over 4
2210
2211 =item quiet - can be set true to supress email cancellation notices.
2212
2213 =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.
2214
2215 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2216
2217 =item nobill - can be set true to skip billing if it might otherwise be done.
2218
2219 =back
2220
2221 Always returns a list: an empty list on success or a list of errors.
2222
2223 =cut
2224
2225 # nb that dates are not specified as valid options to this method
2226
2227 sub cancel {
2228   my( $self, %opt ) = @_;
2229
2230   warn "$me cancel called on customer ". $self->custnum. " with options ".
2231        join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2232     if $DEBUG;
2233
2234   return ( 'access denied' )
2235     unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2236
2237   if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2238
2239     #should try decryption (we might have the private key)
2240     # and if not maybe queue a job for the server that does?
2241     return ( "Can't (yet) ban encrypted credit cards" )
2242       if $self->is_encrypted($self->payinfo);
2243
2244     my $ban = new FS::banned_pay $self->_banned_pay_hashref;
2245     my $error = $ban->insert;
2246     return ( $error ) if $error;
2247
2248   }
2249
2250   my @pkgs = $self->ncancelled_pkgs;
2251
2252   if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2253     $opt{nobill} = 1;
2254     my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2255     warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2256       if $error;
2257   }
2258
2259   warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2260        scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2261     if $DEBUG;
2262
2263   grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2264 }
2265
2266 sub _banned_pay_hashref {
2267   my $self = shift;
2268
2269   my %payby2ban = (
2270     'CARD' => 'CARD',
2271     'DCRD' => 'CARD',
2272     'CHEK' => 'CHEK',
2273     'DCHK' => 'CHEK'
2274   );
2275
2276   {
2277     'payby'   => $payby2ban{$self->payby},
2278     'payinfo' => md5_base64($self->payinfo),
2279     #don't ever *search* on reason! #'reason'  =>
2280   };
2281 }
2282
2283 =item notes
2284
2285 Returns all notes (see L<FS::cust_main_note>) for this customer.
2286
2287 =cut
2288
2289 sub notes {
2290   my $self = shift;
2291   #order by?
2292   qsearch( 'cust_main_note',
2293            { 'custnum' => $self->custnum },
2294            '',
2295            'ORDER BY _DATE DESC'
2296          );
2297 }
2298
2299 =item agent
2300
2301 Returns the agent (see L<FS::agent>) for this customer.
2302
2303 =cut
2304
2305 sub agent {
2306   my $self = shift;
2307   qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2308 }
2309
2310 =item bill_and_collect
2311
2312 Cancels and suspends any packages due, generates bills, applies payments and
2313 cred
2314
2315 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
2316
2317 Options are passed as name-value pairs.  Currently available options are:
2318
2319 =over 4
2320
2321 =item time
2322
2323 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:
2324
2325  use Date::Parse;
2326  ...
2327  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2328
2329 =item invoice_time
2330
2331 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.
2332
2333 =item check_freq
2334
2335 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2336
2337 =item resetup
2338
2339 If set true, re-charges setup fees.
2340
2341 =item debug
2342
2343 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)
2344
2345 =back
2346
2347 Options are passed to the B<bill> and B<collect> methods verbatim, so all
2348 options of those methods are also available.
2349
2350 =cut
2351
2352 sub bill_and_collect {
2353   my( $self, %options ) = @_;
2354
2355   #$options{actual_time} not $options{time} because freeside-daily -d is for
2356   #pre-printing invoices
2357   $self->cancel_expired_pkgs(    $options{actual_time} );
2358   $self->suspend_adjourned_pkgs( $options{actual_time} );
2359
2360   my $error = $self->bill( %options );
2361   warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
2362
2363   $self->apply_payments_and_credits;
2364
2365   unless ( $conf->exists('cancelled_cust-noevents')
2366            && ! $self->num_ncancelled_pkgs
2367   ) {
2368
2369     $error = $self->collect( %options );
2370     warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
2371
2372   }
2373
2374 }
2375
2376 sub cancel_expired_pkgs {
2377   my ( $self, $time ) = @_;
2378
2379   my @cancel_pkgs = $self->ncancelled_pkgs( {
2380     'extra_sql' => " AND expire IS NOT NULL AND expire > 0 AND expire <= $time "
2381   } );
2382
2383   foreach my $cust_pkg ( @cancel_pkgs ) {
2384     my $cpr = $cust_pkg->last_cust_pkg_reason('expire');
2385     my $error = $cust_pkg->cancel($cpr ? ( 'reason'        => $cpr->reasonnum,
2386                                            'reason_otaker' => $cpr->otaker
2387                                          )
2388                                        : ()
2389                                  );
2390     warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
2391          " for custnum ". $self->custnum. ": $error"
2392       if $error;
2393   }
2394
2395 }
2396
2397 sub suspend_adjourned_pkgs {
2398   my ( $self, $time ) = @_;
2399
2400   my @susp_pkgs = $self->ncancelled_pkgs( {
2401     'extra_sql' =>
2402       " AND ( susp IS NULL OR susp = 0 )
2403         AND (    ( bill    IS NOT NULL AND bill    != 0 AND bill    <  $time )
2404               OR ( adjourn IS NOT NULL AND adjourn != 0 AND adjourn <= $time )
2405             )
2406       ",
2407   } );
2408
2409   #only because there's no SQL test for is_prepaid :/
2410   @susp_pkgs =
2411     grep {     (    $_->part_pkg->is_prepaid
2412                  && $_->bill
2413                  && $_->bill < $time
2414                )
2415             || (    $_->adjourn
2416                  && $_->adjourn <= $time
2417                )
2418
2419          }
2420          @susp_pkgs;
2421
2422   foreach my $cust_pkg ( @susp_pkgs ) {
2423     my $cpr = $cust_pkg->last_cust_pkg_reason('adjourn')
2424       if ($cust_pkg->adjourn && $cust_pkg->adjourn < $^T);
2425     my $error = $cust_pkg->suspend($cpr ? ( 'reason' => $cpr->reasonnum,
2426                                             'reason_otaker' => $cpr->otaker
2427                                           )
2428                                         : ()
2429                                   );
2430
2431     warn "Error suspending package ". $cust_pkg->pkgnum.
2432          " for custnum ". $self->custnum. ": $error"
2433       if $error;
2434   }
2435
2436 }
2437
2438 =item bill OPTIONS
2439
2440 Generates invoices (see L<FS::cust_bill>) for this customer.  Usually used in
2441 conjunction with the collect method by calling B<bill_and_collect>.
2442
2443 If there is an error, returns the error, otherwise returns false.
2444
2445 Options are passed as name-value pairs.  Currently available options are:
2446
2447 =over 4
2448
2449 =item resetup
2450
2451 If set true, re-charges setup fees.
2452
2453 =item time
2454
2455 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:
2456
2457  use Date::Parse;
2458  ...
2459  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2460
2461 =item pkg_list
2462
2463 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2464
2465  $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2466
2467 =item not_pkgpart
2468
2469 A hashref of pkgparts to exclude from this billing run (can also be specified as a comma-separated scalar).
2470
2471 =item invoice_time
2472
2473 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.
2474
2475 =item cancel
2476
2477 This boolean value informs the us that the package is being cancelled.  This
2478 typically might mean not charging the normal recurring fee but only usage
2479 fees since the last billing. Setup charges may be charged.  Not all package
2480 plans support this feature (they tend to charge 0).
2481
2482 =item invoice_terms
2483
2484 Options terms to be printed on this invocice.  Otherwise, customer-specific
2485 terms or the default terms are used.
2486
2487 =back
2488
2489 =cut
2490
2491 sub bill {
2492   my( $self, %options ) = @_;
2493   return '' if $self->payby eq 'COMP';
2494   warn "$me bill customer ". $self->custnum. "\n"
2495     if $DEBUG;
2496
2497   my $time = $options{'time'} || time;
2498   my $invoice_time = $options{'invoice_time'} || $time;
2499
2500   $options{'not_pkgpart'} ||= {};
2501   $options{'not_pkgpart'} = { map { $_ => 1 }
2502                                   split(/\s*,\s*/, $options{'not_pkgpart'})
2503                             }
2504     unless ref($options{'not_pkgpart'});
2505
2506   local $SIG{HUP} = 'IGNORE';
2507   local $SIG{INT} = 'IGNORE';
2508   local $SIG{QUIT} = 'IGNORE';
2509   local $SIG{TERM} = 'IGNORE';
2510   local $SIG{TSTP} = 'IGNORE';
2511   local $SIG{PIPE} = 'IGNORE';
2512
2513   my $oldAutoCommit = $FS::UID::AutoCommit;
2514   local $FS::UID::AutoCommit = 0;
2515   my $dbh = dbh;
2516
2517   $self->select_for_update; #mutex
2518
2519   my $error = $self->do_cust_event(
2520     'debug'      => ( $options{'debug'} || 0 ),
2521     'time'       => $invoice_time,
2522     'check_freq' => $options{'check_freq'},
2523     'stage'      => 'pre-bill',
2524   );
2525   if ( $error ) {
2526     $dbh->rollback if $oldAutoCommit;
2527     return $error;
2528   }
2529
2530   my @cust_bill_pkg = ();
2531
2532   ###
2533   # find the packages which are due for billing, find out how much they are
2534   # & generate invoice database.
2535   ###
2536
2537   my( $total_setup, $total_recur, $postal_charge ) = ( 0, 0, 0 );
2538   my %taxlisthash;
2539   my @precommit_hooks = ();
2540
2541   $options{'pkg_list'} ||= [ $self->ncancelled_pkgs ];  #param checks?
2542   foreach my $cust_pkg ( @{ $options{'pkg_list'} } ) {
2543
2544     next if $options{'not_pkgpart'}->{$cust_pkg->pkgpart};
2545
2546     warn "  bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2547
2548     #? to avoid use of uninitialized value errors... ?
2549     $cust_pkg->setfield('bill', '')
2550       unless defined($cust_pkg->bill);
2551
2552     #my $part_pkg = $cust_pkg->part_pkg;
2553
2554     my $real_pkgpart = $cust_pkg->pkgpart;
2555     my %hash = $cust_pkg->hash;
2556
2557     foreach my $part_pkg ( $cust_pkg->part_pkg->self_and_bill_linked ) {
2558
2559       $cust_pkg->set($_, $hash{$_}) foreach qw ( setup last_bill bill );
2560
2561       my $error =
2562         $self->_make_lines( 'part_pkg'            => $part_pkg,
2563                             'cust_pkg'            => $cust_pkg,
2564                             'precommit_hooks'     => \@precommit_hooks,
2565                             'line_items'          => \@cust_bill_pkg,
2566                             'setup'               => \$total_setup,
2567                             'recur'               => \$total_recur,
2568                             'tax_matrix'          => \%taxlisthash,
2569                             'time'                => $time,
2570                             'real_pkgpart'        => $real_pkgpart,
2571                             'options'             => \%options,
2572                           );
2573       if ($error) {
2574         $dbh->rollback if $oldAutoCommit;
2575         return $error;
2576       }
2577
2578     } #foreach my $part_pkg
2579
2580   } #foreach my $cust_pkg
2581
2582   unless ( @cust_bill_pkg ) { #don't create an invoice w/o line items
2583     #but do commit any package date cycling that happened
2584     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2585     return '';
2586   }
2587
2588   if ( scalar( grep { $_->recur && $_->recur > 0 } @cust_bill_pkg) ||
2589          !$conf->exists('postal_invoice-recurring_only')
2590      )
2591   {
2592
2593     my $postal_pkg = $self->charge_postal_fee();
2594     if ( $postal_pkg && !ref( $postal_pkg ) ) {
2595
2596       $dbh->rollback if $oldAutoCommit;
2597       return "can't charge postal invoice fee for customer ".
2598         $self->custnum. ": $postal_pkg";
2599
2600     } elsif ( $postal_pkg ) {
2601
2602       my $real_pkgpart = $postal_pkg->pkgpart;
2603       foreach my $part_pkg ( $postal_pkg->part_pkg->self_and_bill_linked ) {
2604         my %postal_options = %options;
2605         delete $postal_options{cancel};
2606         my $error =
2607           $self->_make_lines( 'part_pkg'            => $part_pkg,
2608                               'cust_pkg'            => $postal_pkg,
2609                               'precommit_hooks'     => \@precommit_hooks,
2610                               'line_items'          => \@cust_bill_pkg,
2611                               'setup'               => \$total_setup,
2612                               'recur'               => \$total_recur,
2613                               'tax_matrix'          => \%taxlisthash,
2614                               'time'                => $time,
2615                               'real_pkgpart'        => $real_pkgpart,
2616                               'options'             => \%postal_options,
2617                             );
2618         if ($error) {
2619           $dbh->rollback if $oldAutoCommit;
2620           return $error;
2621         }
2622       }
2623
2624     }
2625
2626   }
2627
2628   my $listref_or_error =
2629     $self->calculate_taxes( \@cust_bill_pkg, \%taxlisthash, $invoice_time);
2630
2631   unless ( ref( $listref_or_error ) ) {
2632     $dbh->rollback if $oldAutoCommit;
2633     return $listref_or_error;
2634   }
2635
2636   foreach my $taxline ( @$listref_or_error ) {
2637     $total_setup = sprintf('%.2f', $total_setup+$taxline->setup );
2638     push @cust_bill_pkg, $taxline;
2639   }
2640
2641   #add tax adjustments
2642   warn "adding tax adjustments...\n" if $DEBUG > 2;
2643   foreach my $cust_tax_adjustment (
2644     qsearch('cust_tax_adjustment', { 'custnum'    => $self->custnum,
2645                                      'billpkgnum' => '',
2646                                    }
2647            )
2648   ) {
2649
2650     my $tax = sprintf('%.2f', $cust_tax_adjustment->amount );
2651
2652     my $itemdesc = $cust_tax_adjustment->taxname;
2653     $itemdesc = '' if $itemdesc eq 'Tax';
2654
2655     push @cust_bill_pkg, new FS::cust_bill_pkg {
2656       'pkgnum'      => 0,
2657       'setup'       => $tax,
2658       'recur'       => 0,
2659       'sdate'       => '',
2660       'edate'       => '',
2661       'itemdesc'    => $itemdesc,
2662       'itemcomment' => $cust_tax_adjustment->comment,
2663       'cust_tax_adjustment' => $cust_tax_adjustment,
2664       #'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2665     };
2666
2667   }
2668
2669   my $charged = sprintf('%.2f', $total_setup + $total_recur );
2670
2671   my @cust_bill = $self->cust_bill;
2672   my $balance = $self->balance;
2673   my $previous_balance = scalar(@cust_bill)
2674                            ? ( $cust_bill[$#cust_bill]->billing_balance || 0 )
2675                            : 0;
2676
2677   $previous_balance += $cust_bill[$#cust_bill]->charged
2678     if scalar(@cust_bill);
2679   #my $balance_adjustments =
2680   #  sprintf('%.2f', $balance - $prior_prior_balance - $prior_charged);
2681
2682   #create the new invoice
2683   my $cust_bill = new FS::cust_bill ( {
2684     'custnum'             => $self->custnum,
2685     '_date'               => ( $invoice_time ),
2686     'charged'             => $charged,
2687     'billing_balance'     => $balance,
2688     'previous_balance'    => $previous_balance,
2689     'invoice_terms'       => $options{'invoice_terms'},
2690   } );
2691   $error = $cust_bill->insert;
2692   if ( $error ) {
2693     $dbh->rollback if $oldAutoCommit;
2694     return "can't create invoice for customer #". $self->custnum. ": $error";
2695   }
2696
2697   foreach my $cust_bill_pkg ( @cust_bill_pkg ) {
2698     $cust_bill_pkg->invnum($cust_bill->invnum);
2699     my $error = $cust_bill_pkg->insert;
2700     if ( $error ) {
2701       $dbh->rollback if $oldAutoCommit;
2702       return "can't create invoice line item: $error";
2703     }
2704   }
2705
2706
2707   foreach my $hook ( @precommit_hooks ) {
2708     eval {
2709       &{$hook}; #($self) ?
2710     };
2711     if ( $@ ) {
2712       $dbh->rollback if $oldAutoCommit;
2713       return "$@ running precommit hook $hook\n";
2714     }
2715   }
2716
2717   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2718   ''; #no error
2719 }
2720
2721 =item calculate_taxes LINEITEMREF TAXHASHREF INVOICE_TIME
2722
2723 This is a weird one.  Perhaps it should not even be exposed.
2724
2725 Generates tax line items (see L<FS::cust_bill_pkg>) for this customer.
2726 Usually used internally by bill method B<bill>.
2727
2728 If there is an error, returns the error, otherwise returns reference to a
2729 list of line items suitable for insertion.
2730
2731 =over 4
2732
2733 =item LINEITEMREF
2734
2735 An array ref of the line items being billed.
2736
2737 =item TAXHASHREF
2738
2739 A strange beast.  The keys to this hash are internal identifiers consisting
2740 of the name of the tax object type, a space, and its unique identifier ( e.g.
2741  'cust_main_county 23' ).  The values of the hash are listrefs.  The first
2742 item in the list is the tax object.  The remaining items are either line
2743 items or floating point values (currency amounts).
2744
2745 The taxes are calculated on this entity.  Calculated exemption records are
2746 transferred to the LINEITEMREF items on the assumption that they are related.
2747
2748 Read the source.
2749
2750 =item INVOICE_TIME
2751
2752 This specifies the date appearing on the associated invoice.  Some
2753 jurisdictions (i.e. Texas) have tax exemptions which are date sensitive.
2754
2755 =back
2756
2757 =cut
2758 sub calculate_taxes {
2759   my ($self, $cust_bill_pkg, $taxlisthash, $invoice_time) = @_;
2760
2761   my @tax_line_items = ();
2762
2763   warn "having a look at the taxes we found...\n" if $DEBUG > 2;
2764
2765   # keys are tax names (as printed on invoices / itemdesc )
2766   # values are listrefs of taxlisthash keys (internal identifiers)
2767   my %taxname = ();
2768
2769   # keys are taxlisthash keys (internal identifiers)
2770   # values are (cumulative) amounts
2771   my %tax = ();
2772
2773   # keys are taxlisthash keys (internal identifiers)
2774   # values are listrefs of cust_bill_pkg_tax_location hashrefs
2775   my %tax_location = ();
2776
2777   # keys are taxlisthash keys (internal identifiers)
2778   # values are listrefs of cust_bill_pkg_tax_rate_location hashrefs
2779   my %tax_rate_location = ();
2780
2781   foreach my $tax ( keys %$taxlisthash ) {
2782     my $tax_object = shift @{ $taxlisthash->{$tax} };
2783     warn "found ". $tax_object->taxname. " as $tax\n" if $DEBUG > 2;
2784     warn " ". join('/', @{ $taxlisthash->{$tax} } ). "\n" if $DEBUG > 2;
2785     my $hashref_or_error =
2786       $tax_object->taxline( $taxlisthash->{$tax},
2787                             'custnum'      => $self->custnum,
2788                             'invoice_time' => $invoice_time
2789                           );
2790     return $hashref_or_error unless ref($hashref_or_error);
2791
2792     unshift @{ $taxlisthash->{$tax} }, $tax_object;
2793
2794     my $name   = $hashref_or_error->{'name'};
2795     my $amount = $hashref_or_error->{'amount'};
2796
2797     #warn "adding $amount as $name\n";
2798     $taxname{ $name } ||= [];
2799     push @{ $taxname{ $name } }, $tax;
2800
2801     $tax{ $tax } += $amount;
2802
2803     $tax_location{ $tax } ||= [];
2804     if ( $tax_object->get('pkgnum') || $tax_object->get('locationnum') ) {
2805       push @{ $tax_location{ $tax }  },
2806         {
2807           'taxnum'      => $tax_object->taxnum,
2808           'taxtype'     => ref($tax_object),
2809           'pkgnum'      => $tax_object->get('pkgnum'),
2810           'locationnum' => $tax_object->get('locationnum'),
2811           'amount'      => sprintf('%.2f', $amount ),
2812         };
2813     }
2814
2815     $tax_rate_location{ $tax } ||= [];
2816     if ( ref($tax_object) eq 'FS::tax_rate' ) {
2817       my $taxratelocationnum =
2818         $tax_object->tax_rate_location->taxratelocationnum;
2819       push @{ $tax_rate_location{ $tax }  },
2820         {
2821           'taxnum'             => $tax_object->taxnum,
2822           'taxtype'            => ref($tax_object),
2823           'amount'             => sprintf('%.2f', $amount ),
2824           'locationtaxid'      => $tax_object->location,
2825           'taxratelocationnum' => $taxratelocationnum,
2826         };
2827     }
2828
2829   }
2830
2831   #move the cust_tax_exempt_pkg records to the cust_bill_pkgs we will commit
2832   my %packagemap = map { $_->pkgnum => $_ } @$cust_bill_pkg;
2833   foreach my $tax ( keys %$taxlisthash ) {
2834     foreach ( @{ $taxlisthash->{$tax} }[1 ... scalar(@{ $taxlisthash->{$tax} })] ) {
2835       next unless ref($_) eq 'FS::cust_bill_pkg';
2836
2837       push @{ $packagemap{$_->pkgnum}->_cust_tax_exempt_pkg },
2838         splice( @{ $_->_cust_tax_exempt_pkg } );
2839     }
2840   }
2841
2842   #consolidate and create tax line items
2843   warn "consolidating and generating...\n" if $DEBUG > 2;
2844   foreach my $taxname ( keys %taxname ) {
2845     my $tax = 0;
2846     my %seen = ();
2847     my @cust_bill_pkg_tax_location = ();
2848     my @cust_bill_pkg_tax_rate_location = ();
2849     warn "adding $taxname\n" if $DEBUG > 1;
2850     foreach my $taxitem ( @{ $taxname{$taxname} } ) {
2851       next if $seen{$taxitem}++;
2852       warn "adding $tax{$taxitem}\n" if $DEBUG > 1;
2853       $tax += $tax{$taxitem};
2854       push @cust_bill_pkg_tax_location,
2855         map { new FS::cust_bill_pkg_tax_location $_ }
2856             @{ $tax_location{ $taxitem } };
2857       push @cust_bill_pkg_tax_rate_location,
2858         map { new FS::cust_bill_pkg_tax_rate_location $_ }
2859             @{ $tax_rate_location{ $taxitem } };
2860     }
2861     next unless $tax;
2862
2863     $tax = sprintf('%.2f', $tax );
2864
2865     my $pkg_category = qsearchs( 'pkg_category', { 'categoryname' => $taxname,
2866                                                    'disabled'     => '',
2867                                                  },
2868                                );
2869
2870     my @display = ();
2871     if ( $pkg_category and
2872          $conf->config('invoice_latexsummary') ||
2873          $conf->config('invoice_htmlsummary')
2874        )
2875     {
2876
2877       my %hash = (  'section' => $pkg_category->categoryname );
2878       push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
2879
2880     }
2881
2882     push @tax_line_items, new FS::cust_bill_pkg {
2883       'pkgnum'   => 0,
2884       'setup'    => $tax,
2885       'recur'    => 0,
2886       'sdate'    => '',
2887       'edate'    => '',
2888       'itemdesc' => $taxname,
2889       'display'  => \@display,
2890       'cust_bill_pkg_tax_location' => \@cust_bill_pkg_tax_location,
2891       'cust_bill_pkg_tax_rate_location' => \@cust_bill_pkg_tax_rate_location,
2892     };
2893
2894   }
2895
2896   \@tax_line_items;
2897 }
2898
2899 sub _make_lines {
2900   my ($self, %params) = @_;
2901
2902   my $part_pkg = $params{part_pkg} or die "no part_pkg specified";
2903   my $cust_pkg = $params{cust_pkg} or die "no cust_pkg specified";
2904   my $precommit_hooks = $params{precommit_hooks} or die "no package specified";
2905   my $cust_bill_pkgs = $params{line_items} or die "no line buffer specified";
2906   my $total_setup = $params{setup} or die "no setup accumulator specified";
2907   my $total_recur = $params{recur} or die "no recur accumulator specified";
2908   my $taxlisthash = $params{tax_matrix} or die "no tax accumulator specified";
2909   my $time = $params{'time'} or die "no time specified";
2910   my (%options) = %{$params{options}};
2911
2912   my $dbh = dbh;
2913   my $real_pkgpart = $params{real_pkgpart};
2914   my %hash = $cust_pkg->hash;
2915   my $old_cust_pkg = new FS::cust_pkg \%hash;
2916
2917   my @details = ();
2918
2919   my $lineitems = 0;
2920
2921   $cust_pkg->pkgpart($part_pkg->pkgpart);
2922
2923   ###
2924   # bill setup
2925   ###
2926
2927   my $setup = 0;
2928   my $unitsetup = 0;
2929   if ( $options{'resetup'}
2930        || ( ! $cust_pkg->setup
2931             && ( ! $cust_pkg->start_date
2932                  || $cust_pkg->start_date <= $time
2933                )
2934             && ( ! $conf->exists('disable_setup_suspended_pkgs')
2935                  || ( $conf->exists('disable_setup_suspended_pkgs') &&
2936                       ! $cust_pkg->getfield('susp')
2937                     )
2938                )
2939           )
2940     )
2941   {
2942
2943     warn "    bill setup\n" if $DEBUG > 1;
2944     $lineitems++;
2945
2946     $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2947     return "$@ running calc_setup for $cust_pkg\n"
2948       if $@;
2949
2950     $unitsetup = $cust_pkg->part_pkg->unit_setup || $setup; #XXX uuh
2951
2952     $cust_pkg->setfield('setup', $time)
2953       unless $cust_pkg->setup;
2954           #do need it, but it won't get written to the db
2955           #|| $cust_pkg->pkgpart != $real_pkgpart;
2956
2957     $cust_pkg->setfield('start_date', '')
2958       if $cust_pkg->start_date;
2959
2960   }
2961
2962   ###
2963   # bill recurring fee
2964   ###
2965
2966   #XXX unit stuff here too
2967   my $recur = 0;
2968   my $unitrecur = 0;
2969   my $sdate;
2970   if (     ! $cust_pkg->get('susp')
2971        and ! $cust_pkg->get('start_date')
2972        and ( $part_pkg->getfield('freq') ne '0'
2973              && ( $cust_pkg->getfield('bill') || 0 ) <= $time
2974            )
2975         || ( $part_pkg->plan eq 'voip_cdr'
2976               && $part_pkg->option('bill_every_call')
2977            )
2978         || ( $options{cancel} )
2979   ) {
2980
2981     # XXX should this be a package event?  probably.  events are called
2982     # at collection time at the moment, though...
2983     $part_pkg->reset_usage($cust_pkg, 'debug'=>$DEBUG)
2984       if $part_pkg->can('reset_usage');
2985       #don't want to reset usage just cause we want a line item??
2986       #&& $part_pkg->pkgpart == $real_pkgpart;
2987
2988     warn "    bill recur\n" if $DEBUG > 1;
2989     $lineitems++;
2990
2991     # XXX shared with $recur_prog
2992     $sdate = ( $options{cancel} ? $cust_pkg->last_bill : $cust_pkg->bill )
2993              || $cust_pkg->setup
2994              || $time;
2995
2996     #over two params!  lets at least switch to a hashref for the rest...
2997     my $increment_next_bill = ( $part_pkg->freq ne '0'
2998                                 && ( $cust_pkg->getfield('bill') || 0 ) <= $time
2999                                 && !$options{cancel}
3000                               );
3001     my %param = ( 'precommit_hooks'     => $precommit_hooks,
3002                   'increment_next_bill' => $increment_next_bill,
3003                 );
3004
3005     my $method = $options{cancel} ? 'calc_cancel' : 'calc_recur';
3006     $recur = eval { $cust_pkg->$method( \$sdate, \@details, \%param ) };
3007     return "$@ running $method for $cust_pkg\n"
3008       if ( $@ );
3009
3010     if ( $increment_next_bill ) {
3011
3012       my $next_bill = $part_pkg->add_freq($sdate);
3013       return "unparsable frequency: ". $part_pkg->freq
3014         if $next_bill == -1;
3015
3016       #pro-rating magic - if $recur_prog fiddled $sdate, want to use that
3017       # only for figuring next bill date, nothing else, so, reset $sdate again
3018       # here
3019       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
3020       #no need, its in $hash{last_bill}# my $last_bill = $cust_pkg->last_bill;
3021       $cust_pkg->last_bill($sdate);
3022
3023       $cust_pkg->setfield('bill', $next_bill );
3024
3025     }
3026
3027   }
3028
3029   warn "\$setup is undefined" unless defined($setup);
3030   warn "\$recur is undefined" unless defined($recur);
3031   warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
3032
3033   ###
3034   # If there's line items, create em cust_bill_pkg records
3035   # If $cust_pkg has been modified, update it (if we're a real pkgpart)
3036   ###
3037
3038   if ( $lineitems ) {
3039
3040     if ( $cust_pkg->modified && $cust_pkg->pkgpart == $real_pkgpart ) {
3041       # hmm.. and if just the options are modified in some weird price plan?
3042
3043       warn "  package ". $cust_pkg->pkgnum. " modified; updating\n"
3044         if $DEBUG >1;
3045
3046       my $error = $cust_pkg->replace( $old_cust_pkg,
3047                                       'options' => { $cust_pkg->options },
3048                                     );
3049       return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error"
3050         if $error; #just in case
3051     }
3052
3053     $setup = sprintf( "%.2f", $setup );
3054     $recur = sprintf( "%.2f", $recur );
3055     if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
3056       return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
3057     }
3058     if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
3059       return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
3060     }
3061
3062     if ( $setup != 0 || $recur != 0 ) {
3063
3064       warn "    charges (setup=$setup, recur=$recur); adding line items\n"
3065         if $DEBUG > 1;
3066
3067       my @cust_pkg_detail = map { $_->detail } $cust_pkg->cust_pkg_detail('I');
3068       if ( $DEBUG > 1 ) {
3069         warn "      adding customer package invoice detail: $_\n"
3070           foreach @cust_pkg_detail;
3071       }
3072       push @details, @cust_pkg_detail;
3073
3074       my $cust_bill_pkg = new FS::cust_bill_pkg {
3075         'pkgnum'    => $cust_pkg->pkgnum,
3076         'setup'     => $setup,
3077         'unitsetup' => $unitsetup,
3078         'recur'     => $recur,
3079         'unitrecur' => $unitrecur,
3080         'quantity'  => $cust_pkg->quantity,
3081         'details'   => \@details,
3082         'hidden'    => $part_pkg->hidden,
3083       };
3084
3085       if ( $part_pkg->option('recur_temporality', 1) eq 'preceding' ) {
3086         $cust_bill_pkg->sdate( $hash{last_bill} );
3087         $cust_bill_pkg->edate( $sdate - 86399   ); #60s*60m*24h-1
3088         $cust_bill_pkg->edate( $time ) if $options{cancel};
3089       } else { #if ( $part_pkg->option('recur_temporality', 1) eq 'upcoming' ) {
3090         $cust_bill_pkg->sdate( $sdate );
3091         $cust_bill_pkg->edate( $cust_pkg->bill );
3092         #$cust_bill_pkg->edate( $time ) if $options{cancel};
3093       }
3094
3095       $cust_bill_pkg->pkgpart_override($part_pkg->pkgpart)
3096         unless $part_pkg->pkgpart == $real_pkgpart;
3097
3098       $$total_setup += $setup;
3099       $$total_recur += $recur;
3100
3101       ###
3102       # handle taxes
3103       ###
3104
3105       my $error =
3106         $self->_handle_taxes($part_pkg, $taxlisthash, $cust_bill_pkg, $cust_pkg, $options{invoice_time}, $real_pkgpart, \%options);
3107       return $error if $error;
3108
3109       push @$cust_bill_pkgs, $cust_bill_pkg;
3110
3111     } #if $setup != 0 || $recur != 0
3112
3113   } #if $line_items
3114
3115   '';
3116
3117 }
3118
3119 sub _handle_taxes {
3120   my $self = shift;
3121   my $part_pkg = shift;
3122   my $taxlisthash = shift;
3123   my $cust_bill_pkg = shift;
3124   my $cust_pkg = shift;
3125   my $invoice_time = shift;
3126   my $real_pkgpart = shift;
3127   my $options = shift;
3128
3129   my %cust_bill_pkg = ();
3130   my %taxes = ();
3131
3132   my @classes;
3133   #push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->type eq 'U';
3134   push @classes, $cust_bill_pkg->usage_classes if $cust_bill_pkg->usage;
3135   push @classes, 'setup' if ($cust_bill_pkg->setup && !$options->{cancel});
3136   push @classes, 'recur' if ($cust_bill_pkg->recur && !$options->{cancel});
3137
3138   if ( $self->tax !~ /Y/i && $self->payby ne 'COMP' ) {
3139
3140     if ( $conf->exists('enable_taxproducts')
3141          && ( scalar($part_pkg->part_pkg_taxoverride)
3142               || $part_pkg->has_taxproduct
3143             )
3144        )
3145     {
3146
3147       if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3148         return "fatal: Can't (yet) use tax-pkg_address with taxproducts";
3149       }
3150
3151       foreach my $class (@classes) {
3152         my $err_or_ref = $self->_gather_taxes( $part_pkg, $class );
3153         return $err_or_ref unless ref($err_or_ref);
3154         $taxes{$class} = $err_or_ref;
3155       }
3156
3157       unless (exists $taxes{''}) {
3158         my $err_or_ref = $self->_gather_taxes( $part_pkg, '' );
3159         return $err_or_ref unless ref($err_or_ref);
3160         $taxes{''} = $err_or_ref;
3161       }
3162
3163     } else {
3164
3165       my @loc_keys = qw( city county state country );
3166       my %taxhash;
3167       if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3168         my $cust_location = $cust_pkg->cust_location;
3169         %taxhash = map { $_ => $cust_location->$_()    } @loc_keys;
3170       } else {
3171         my $prefix =
3172           ( $conf->exists('tax-ship_address') && length($self->ship_last) )
3173           ? 'ship_'
3174           : '';
3175         %taxhash = map { $_ => $self->get("$prefix$_") } @loc_keys;
3176       }
3177
3178       $taxhash{'taxclass'} = $part_pkg->taxclass;
3179
3180       my @taxes = qsearch( 'cust_main_county', \%taxhash );
3181
3182       my %taxhash_elim = %taxhash;
3183
3184       my @elim = qw( taxclass city county state );
3185       while ( !scalar(@taxes) && scalar(@elim) ) {
3186         $taxhash_elim{ shift(@elim) } = '';
3187         @taxes = qsearch( 'cust_main_county', \%taxhash_elim );
3188       }
3189
3190       @taxes = grep { ! $_->taxname or ! $self->tax_exemption($_->taxname) }
3191                     @taxes
3192         if $self->cust_main_exemption; #just to be safe
3193
3194       if ( $conf->exists('tax-pkg_address') && $cust_pkg->locationnum ) {
3195         foreach (@taxes) {
3196           $_->set('pkgnum',      $cust_pkg->pkgnum );
3197           $_->set('locationnum', $cust_pkg->locationnum );
3198         }
3199       }
3200
3201       $taxes{''} = [ @taxes ];
3202       $taxes{'setup'} = [ @taxes ];
3203       $taxes{'recur'} = [ @taxes ];
3204       $taxes{$_} = [ @taxes ] foreach (@classes);
3205
3206       # # maybe eliminate this entirely, along with all the 0% records
3207       # unless ( @taxes ) {
3208       #   return
3209       #     "fatal: can't find tax rate for state/county/country/taxclass ".
3210       #     join('/', map $taxhash{$_}, qw(state county country taxclass) );
3211       # }
3212
3213     } #if $conf->exists('enable_taxproducts') ...
3214
3215   }
3216
3217   my @display = ();
3218   my $separate = $conf->exists('separate_usage');
3219   my $usage_mandate = $cust_pkg->part_pkg->option('usage_mandate', 'Hush!');
3220   if ( $separate || $cust_bill_pkg->hidden || $usage_mandate ) {
3221
3222     my $temp_pkg = new FS::cust_pkg { pkgpart => $real_pkgpart };
3223     my %hash = $cust_bill_pkg->hidden  # maybe for all bill linked?
3224                ? (  'section' => $temp_pkg->part_pkg->categoryname )
3225                : ();
3226
3227     my $section = $cust_pkg->part_pkg->option('usage_section', 'Hush!');
3228     my $summary = $cust_pkg->part_pkg->option('summarize_usage', 'Hush!');
3229     if ( $separate ) {
3230       push @display, new FS::cust_bill_pkg_display { type => 'S', %hash };
3231       push @display, new FS::cust_bill_pkg_display { type => 'R', %hash };
3232     } else {
3233       push @display, new FS::cust_bill_pkg_display
3234                        { type => '',
3235                          %hash,
3236                          ( ( $usage_mandate ) ? ( 'summary' => 'Y' ) : () ),
3237                        };
3238     }
3239
3240     if ($separate && $section && $summary) {
3241       push @display, new FS::cust_bill_pkg_display { type    => 'U',
3242                                                      summary => 'Y',
3243                                                      %hash,
3244                                                    };
3245     }
3246     if ($usage_mandate || $section && $summary) {
3247       $hash{post_total} = 'Y';
3248     }
3249
3250     $hash{section} = $section if ($separate || $usage_mandate);
3251     push @display, new FS::cust_bill_pkg_display { type => 'U', %hash };
3252
3253   }
3254   $cust_bill_pkg->set('display', \@display);
3255
3256   my %tax_cust_bill_pkg = $cust_bill_pkg->disintegrate;
3257   foreach my $key (keys %tax_cust_bill_pkg) {
3258     my @taxes = @{ $taxes{$key} || [] };
3259     my $tax_cust_bill_pkg = $tax_cust_bill_pkg{$key};
3260
3261     my %localtaxlisthash = ();
3262     foreach my $tax ( @taxes ) {
3263
3264       my $taxname = ref( $tax ). ' '. $tax->taxnum;
3265 #      $taxname .= ' pkgnum'. $cust_pkg->pkgnum.
3266 #                  ' locationnum'. $cust_pkg->locationnum
3267 #        if $conf->exists('tax-pkg_address') && $cust_pkg->locationnum;
3268
3269       $taxlisthash->{ $taxname } ||= [ $tax ];
3270       push @{ $taxlisthash->{ $taxname  } }, $tax_cust_bill_pkg;
3271
3272       $localtaxlisthash{ $taxname } ||= [ $tax ];
3273       push @{ $localtaxlisthash{ $taxname  } }, $tax_cust_bill_pkg;
3274
3275     }
3276
3277     warn "finding taxed taxes...\n" if $DEBUG > 2;
3278     foreach my $tax ( keys %localtaxlisthash ) {
3279       my $tax_object = shift @{ $localtaxlisthash{$tax} };
3280       warn "found possible taxed tax ". $tax_object->taxname. " we call $tax\n"
3281         if $DEBUG > 2;
3282       next unless $tax_object->can('tax_on_tax');
3283
3284       foreach my $tot ( $tax_object->tax_on_tax( $self ) ) {
3285         my $totname = ref( $tot ). ' '. $tot->taxnum;
3286
3287         warn "checking $totname which we call ". $tot->taxname. " as applicable\n"
3288           if $DEBUG > 2;
3289         next unless exists( $localtaxlisthash{ $totname } ); # only increase
3290                                                              # existing taxes
3291         warn "adding $totname to taxed taxes\n" if $DEBUG > 2;
3292         my $hashref_or_error =
3293           $tax_object->taxline( $localtaxlisthash{$tax},
3294                                 'custnum'      => $self->custnum,
3295                                 'invoice_time' => $invoice_time,
3296                               );
3297         return $hashref_or_error
3298           unless ref($hashref_or_error);
3299
3300         $taxlisthash->{ $totname } ||= [ $tot ];
3301         push @{ $taxlisthash->{ $totname  } }, $hashref_or_error->{amount};
3302
3303       }
3304     }
3305
3306   }
3307
3308   '';
3309 }
3310
3311 sub _gather_taxes {
3312   my $self = shift;
3313   my $part_pkg = shift;
3314   my $class = shift;
3315
3316   my @taxes = ();
3317   my $geocode = $self->geocode('cch');
3318
3319   my @taxclassnums = map { $_->taxclassnum }
3320                      $part_pkg->part_pkg_taxoverride($class);
3321
3322   unless (@taxclassnums) {
3323     @taxclassnums = map { $_->taxclassnum }
3324                     grep { $_->taxable eq 'Y' }
3325                     $part_pkg->part_pkg_taxrate('cch', $geocode, $class);
3326   }
3327   warn "Found taxclassnum values of ". join(',', @taxclassnums)
3328     if $DEBUG;
3329
3330   my $extra_sql =
3331     "AND (".
3332     join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
3333
3334   @taxes = qsearch({ 'table' => 'tax_rate',
3335                      'hashref' => { 'geocode' => $geocode, },
3336                      'extra_sql' => $extra_sql,
3337                   })
3338     if scalar(@taxclassnums);
3339
3340   warn "Found taxes ".
3341        join(',', map{ ref($_). " ". $_->get($_->primary_key) } @taxes). "\n"
3342    if $DEBUG;
3343
3344   [ @taxes ];
3345
3346 }
3347
3348 =item collect [ HASHREF | OPTION => VALUE ... ]
3349
3350 (Attempt to) collect money for this customer's outstanding invoices (see
3351 L<FS::cust_bill>).  Usually used after the bill method.
3352
3353 Actions are now triggered by billing events; see L<FS::part_event> and the
3354 billing events web interface.  Old-style invoice events (see
3355 L<FS::part_bill_event>) have been deprecated.
3356
3357 If there is an error, returns the error, otherwise returns false.
3358
3359 Options are passed as name-value pairs.
3360
3361 Currently available options are:
3362
3363 =over 4
3364
3365 =item invoice_time
3366
3367 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.
3368
3369 =item retry
3370
3371 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3372
3373 =item check_freq
3374
3375 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3376
3377 =item quiet
3378
3379 set true to surpress email card/ACH decline notices.
3380
3381 =item debug
3382
3383 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)
3384
3385 =back
3386
3387 # =item payby
3388 #
3389 # allows for one time override of normal customer billing method
3390
3391 =cut
3392
3393 sub collect {
3394   my( $self, %options ) = @_;
3395   my $invoice_time = $options{'invoice_time'} || time;
3396
3397   #put below somehow?
3398   local $SIG{HUP} = 'IGNORE';
3399   local $SIG{INT} = 'IGNORE';
3400   local $SIG{QUIT} = 'IGNORE';
3401   local $SIG{TERM} = 'IGNORE';
3402   local $SIG{TSTP} = 'IGNORE';
3403   local $SIG{PIPE} = 'IGNORE';
3404
3405   my $oldAutoCommit = $FS::UID::AutoCommit;
3406   local $FS::UID::AutoCommit = 0;
3407   my $dbh = dbh;
3408
3409   $self->select_for_update; #mutex
3410
3411   if ( $DEBUG ) {
3412     my $balance = $self->balance;
3413     warn "$me collect customer ". $self->custnum. ": balance $balance\n"
3414   }
3415
3416   if ( exists($options{'retry_card'}) ) {
3417     carp 'retry_card option passed to collect is deprecated; use retry';
3418     $options{'retry'} ||= $options{'retry_card'};
3419   }
3420   if ( exists($options{'retry'}) && $options{'retry'} ) {
3421     my $error = $self->retry_realtime;
3422     if ( $error ) {
3423       $dbh->rollback if $oldAutoCommit;
3424       return $error;
3425     }
3426   }
3427
3428   my $error = $self->do_cust_event(
3429     'debug'      => ( $options{'debug'} || 0 ),
3430     'time'       => $invoice_time,
3431     'check_freq' => $options{'check_freq'},
3432     'stage'      => 'collect',
3433   );
3434   if ( $error ) {
3435     $dbh->rollback if $oldAutoCommit;
3436     return $error;
3437   }
3438
3439   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3440   '';
3441
3442 }
3443
3444 =item do_cust_event [ HASHREF | OPTION => VALUE ... ]
3445
3446 Runs billing events; see L<FS::part_event> and the billing events web
3447 interface.
3448
3449 If there is an error, returns the error, otherwise returns false.
3450
3451 Options are passed as name-value pairs.
3452
3453 Currently available options are:
3454
3455 =over 4
3456
3457 =item time
3458
3459 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.
3460
3461 =item check_freq
3462
3463 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
3464
3465 =item stage
3466
3467 "collect" (the default) or "pre-bill"
3468
3469 =item quiet
3470
3471 set true to surpress email card/ACH decline notices.
3472
3473 =item debug
3474
3475 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)
3476
3477 =cut
3478
3479 # =item payby
3480 #
3481 # allows for one time override of normal customer billing method
3482
3483 # =item retry
3484 #
3485 # Retry card/echeck/LEC transactions even when not scheduled by invoice events.
3486
3487 sub do_cust_event {
3488   my( $self, %options ) = @_;
3489   my $time = $options{'time'} || time;
3490
3491   #put below somehow?
3492   local $SIG{HUP} = 'IGNORE';
3493   local $SIG{INT} = 'IGNORE';
3494   local $SIG{QUIT} = 'IGNORE';
3495   local $SIG{TERM} = 'IGNORE';
3496   local $SIG{TSTP} = 'IGNORE';
3497   local $SIG{PIPE} = 'IGNORE';
3498
3499   my $oldAutoCommit = $FS::UID::AutoCommit;
3500   local $FS::UID::AutoCommit = 0;
3501   my $dbh = dbh;
3502
3503   $self->select_for_update; #mutex
3504
3505   if ( $DEBUG ) {
3506     my $balance = $self->balance;
3507     warn "$me do_cust_event customer ". $self->custnum. ": balance $balance\n"
3508   }
3509
3510 #  if ( exists($options{'retry_card'}) ) {
3511 #    carp 'retry_card option passed to collect is deprecated; use retry';
3512 #    $options{'retry'} ||= $options{'retry_card'};
3513 #  }
3514 #  if ( exists($options{'retry'}) && $options{'retry'} ) {
3515 #    my $error = $self->retry_realtime;
3516 #    if ( $error ) {
3517 #      $dbh->rollback if $oldAutoCommit;
3518 #      return $error;
3519 #    }
3520 #  }
3521
3522   # false laziness w/pay_batch::import_results
3523
3524   my $due_cust_event = $self->due_cust_event(
3525     'debug'      => ( $options{'debug'} || 0 ),
3526     'time'       => $time,
3527     'check_freq' => $options{'check_freq'},
3528     'stage'      => ( $options{'stage'} || 'collect' ),
3529   );
3530   unless( ref($due_cust_event) ) {
3531     $dbh->rollback if $oldAutoCommit;
3532     return $due_cust_event;
3533   }
3534
3535   foreach my $cust_event ( @$due_cust_event ) {
3536
3537     #XXX lock event
3538
3539     #re-eval event conditions (a previous event could have changed things)
3540     unless ( $cust_event->test_conditions( 'time' => $time ) ) {
3541       #don't leave stray "new/locked" records around
3542       my $error = $cust_event->delete;
3543       if ( $error ) {
3544         #gah, even with transactions
3545         $dbh->commit if $oldAutoCommit; #well.
3546         return $error;
3547       }
3548       next;
3549     }
3550
3551     {
3552       local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
3553       warn "  running cust_event ". $cust_event->eventnum. "\n"
3554         if $DEBUG > 1;
3555
3556
3557       #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
3558       if ( my $error = $cust_event->do_event() ) {
3559         #XXX wtf is this?  figure out a proper dealio with return value
3560         #from do_event
3561           # gah, even with transactions.
3562           $dbh->commit if $oldAutoCommit; #well.
3563           return $error;
3564         }
3565     }
3566
3567   }
3568
3569   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3570   '';
3571
3572 }
3573
3574 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
3575
3576 Inserts database records for and returns an ordered listref of new events due
3577 for this customer, as FS::cust_event objects (see L<FS::cust_event>).  If no
3578 events are due, an empty listref is returned.  If there is an error, returns a
3579 scalar error message.
3580
3581 To actually run the events, call each event's test_condition method, and if
3582 still true, call the event's do_event method.
3583
3584 Options are passed as a hashref or as a list of name-value pairs.  Available
3585 options are:
3586
3587 =over 4
3588
3589 =item check_freq
3590
3591 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.
3592
3593 =item stage
3594
3595 "collect" (the default) or "pre-bill"
3596
3597 =item time
3598
3599 "Current time" for the events.
3600
3601 =item debug
3602
3603 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)
3604
3605 =item eventtable
3606
3607 Only return events for the specified eventtable (by default, events of all eventtables are returned)
3608
3609 =item objects
3610
3611 Explicitly pass the objects to be tested (typically used with eventtable).
3612
3613 =item testonly
3614
3615 Set to true to return the objects, but not actually insert them into the
3616 database.
3617
3618 =back
3619
3620 =cut
3621
3622 sub due_cust_event {
3623   my $self = shift;
3624   my %opt = ref($_[0]) ? %{ $_[0] } : @_;
3625
3626   #???
3627   #my $DEBUG = $opt{'debug'}
3628   local($DEBUG) = $opt{'debug'}
3629     if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
3630
3631   warn "$me due_cust_event called with options ".
3632        join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
3633     if $DEBUG;
3634
3635   $opt{'time'} ||= time;
3636
3637   local $SIG{HUP} = 'IGNORE';
3638   local $SIG{INT} = 'IGNORE';
3639   local $SIG{QUIT} = 'IGNORE';
3640   local $SIG{TERM} = 'IGNORE';
3641   local $SIG{TSTP} = 'IGNORE';
3642   local $SIG{PIPE} = 'IGNORE';
3643
3644   my $oldAutoCommit = $FS::UID::AutoCommit;
3645   local $FS::UID::AutoCommit = 0;
3646   my $dbh = dbh;
3647
3648   $self->select_for_update #mutex
3649     unless $opt{testonly};
3650
3651   ###
3652   # find possible events (initial search)
3653   ###
3654
3655   my @cust_event = ();
3656
3657   my @eventtable = $opt{'eventtable'}
3658                      ? ( $opt{'eventtable'} )
3659                      : FS::part_event->eventtables_runorder;
3660
3661   foreach my $eventtable ( @eventtable ) {
3662
3663     my @objects;
3664     if ( $opt{'objects'} ) {
3665
3666       @objects = @{ $opt{'objects'} };
3667
3668     } else {
3669
3670       #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
3671       @objects = ( $eventtable eq 'cust_main' )
3672                    ? ( $self )
3673                    : ( $self->$eventtable() );
3674
3675     }
3676
3677     my @e_cust_event = ();
3678
3679     my $cross = "CROSS JOIN $eventtable";
3680     $cross .= ' LEFT JOIN cust_main USING ( custnum )'
3681       unless $eventtable eq 'cust_main';
3682
3683     foreach my $object ( @objects ) {
3684
3685       #this first search uses the condition_sql magic for optimization.
3686       #the more possible events we can eliminate in this step the better
3687
3688       my $cross_where = '';
3689       my $pkey = $object->primary_key;
3690       $cross_where = "$eventtable.$pkey = ". $object->$pkey();
3691
3692       my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
3693       my $extra_sql =
3694         FS::part_event_condition->where_conditions_sql( $eventtable,
3695                                                         'time'=>$opt{'time'}
3696                                                       );
3697       my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
3698
3699       $extra_sql = "AND $extra_sql" if $extra_sql;
3700
3701       #here is the agent virtualization
3702       $extra_sql .= " AND (    part_event.agentnum IS NULL
3703                             OR part_event.agentnum = ". $self->agentnum. ' )';
3704
3705       $extra_sql .= " $order";
3706
3707       warn "searching for events for $eventtable ". $object->$pkey. "\n"
3708         if $opt{'debug'} > 2;
3709       my @part_event = qsearch( {
3710         'debug'     => ( $opt{'debug'} > 3 ? 1 : 0 ),
3711         'select'    => 'part_event.*',
3712         'table'     => 'part_event',
3713         'addl_from' => "$cross $join",
3714         'hashref'   => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
3715                          'eventtable' => $eventtable,
3716                          'disabled'   => '',
3717                        },
3718         'extra_sql' => "AND $cross_where $extra_sql",
3719       } );
3720
3721       if ( $DEBUG > 2 ) {
3722         my $pkey = $object->primary_key;
3723         warn "      ". scalar(@part_event).
3724              " possible events found for $eventtable ". $object->$pkey(). "\n";
3725       }
3726
3727       push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
3728
3729     }
3730
3731     warn "    ". scalar(@e_cust_event).
3732          " subtotal possible cust events found for $eventtable\n"
3733       if $DEBUG > 1;
3734
3735     push @cust_event, @e_cust_event;
3736
3737   }
3738
3739   warn "  ". scalar(@cust_event).
3740        " total possible cust events found in initial search\n"
3741     if $DEBUG; # > 1;
3742
3743
3744   ##
3745   # test stage
3746   ##
3747
3748   $opt{stage} ||= 'collect';
3749   @cust_event =
3750     grep { my $stage = $_->part_event->event_stage;
3751            $opt{stage} eq $stage or ( ! $stage && $opt{stage} eq 'collect' )
3752          }
3753          @cust_event;
3754
3755   ##
3756   # test conditions
3757   ##
3758
3759   my %unsat = ();
3760
3761   @cust_event = grep $_->test_conditions( 'time'          => $opt{'time'},
3762                                           'stats_hashref' => \%unsat ),
3763                      @cust_event;
3764
3765   warn "  ". scalar(@cust_event). " cust events left satisfying conditions\n"
3766     if $DEBUG; # > 1;
3767
3768   warn "    invalid conditions not eliminated with condition_sql:\n".
3769        join('', map "      $_: ".$unsat{$_}."\n", keys %unsat )
3770     if $DEBUG; # > 1;
3771
3772   ##
3773   # insert
3774   ##
3775
3776   unless( $opt{testonly} ) {
3777     foreach my $cust_event ( @cust_event ) {
3778
3779       my $error = $cust_event->insert();
3780       if ( $error ) {
3781         $dbh->rollback if $oldAutoCommit;
3782         return $error;
3783       }
3784
3785     }
3786   }
3787
3788   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3789
3790   ##
3791   # return
3792   ##
3793
3794   warn "  returning events: ". Dumper(@cust_event). "\n"
3795     if $DEBUG > 2;
3796
3797   \@cust_event;
3798
3799 }
3800
3801 =item retry_realtime
3802
3803 Schedules realtime / batch  credit card / electronic check / LEC billing
3804 events for for retry.  Useful if card information has changed or manual
3805 retry is desired.  The 'collect' method must be called to actually retry
3806 the transaction.
3807
3808 Implementation details: For either this customer, or for each of this
3809 customer's open invoices, changes the status of the first "done" (with
3810 statustext error) realtime processing event to "failed".
3811
3812 =cut
3813
3814 sub retry_realtime {
3815   my $self = shift;
3816
3817   local $SIG{HUP} = 'IGNORE';
3818   local $SIG{INT} = 'IGNORE';
3819   local $SIG{QUIT} = 'IGNORE';
3820   local $SIG{TERM} = 'IGNORE';
3821   local $SIG{TSTP} = 'IGNORE';
3822   local $SIG{PIPE} = 'IGNORE';
3823
3824   my $oldAutoCommit = $FS::UID::AutoCommit;
3825   local $FS::UID::AutoCommit = 0;
3826   my $dbh = dbh;
3827
3828   #a little false laziness w/due_cust_event (not too bad, really)
3829
3830   my $join = FS::part_event_condition->join_conditions_sql;
3831   my $order = FS::part_event_condition->order_conditions_sql;
3832   my $mine =
3833   '( '
3834    . join ( ' OR ' , map {
3835     "( part_event.eventtable = " . dbh->quote($_)
3836     . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
3837    } FS::part_event->eventtables)
3838    . ') ';
3839
3840   #here is the agent virtualization
3841   my $agent_virt = " (    part_event.agentnum IS NULL
3842                        OR part_event.agentnum = ". $self->agentnum. ' )';
3843
3844   #XXX this shouldn't be hardcoded, actions should declare it...
3845   my @realtime_events = qw(
3846     cust_bill_realtime_card
3847     cust_bill_realtime_check
3848     cust_bill_realtime_lec
3849     cust_bill_batch
3850   );
3851
3852   my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
3853                                                   @realtime_events
3854                                      ).
3855                           ' ) ';
3856
3857   my @cust_event = qsearchs({
3858     'table'     => 'cust_event',
3859     'select'    => 'cust_event.*',
3860     'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
3861     'hashref'   => { 'status' => 'done' },
3862     'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
3863                    " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
3864   });
3865
3866   my %seen_invnum = ();
3867   foreach my $cust_event (@cust_event) {
3868
3869     #max one for the customer, one for each open invoice
3870     my $cust_X = $cust_event->cust_X;
3871     next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
3872                           ? $cust_X->invnum
3873                           : 0
3874                         }++
3875          or $cust_event->part_event->eventtable eq 'cust_bill'
3876             && ! $cust_X->owed;
3877
3878     my $error = $cust_event->retry;
3879     if ( $error ) {
3880       $dbh->rollback if $oldAutoCommit;
3881       return "error scheduling event for retry: $error";
3882     }
3883
3884   }
3885
3886   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3887   '';
3888
3889 }
3890
3891 # some horrid false laziness here to avoid refactor fallout
3892 # eventually realtime realtime_bop and realtime_refund_bop should go
3893 # away and be replaced by _new_realtime_bop and _new_realtime_refund_bop
3894
3895 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
3896
3897 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
3898 via a Business::OnlinePayment realtime gateway.  See
3899 L<http://420.am/business-onlinepayment> for supported gateways.
3900
3901 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3902
3903 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
3904
3905 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3906 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
3907 if set, will override the value from the customer record.
3908
3909 I<description> is a free-text field passed to the gateway.  It defaults to
3910 "Internet services".
3911
3912 If an I<invnum> is specified, this payment (if successful) is applied to the
3913 specified invoice.  If you don't specify an I<invnum> you might want to
3914 call the B<apply_payments> method or set the I<apply> option.
3915
3916 I<apply> can be set to true to apply a resulting payment.
3917
3918 I<quiet> can be set true to surpress email decline notices.
3919
3920 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
3921 resulting paynum, if any.
3922
3923 I<payunique> is a unique identifier for this payment.
3924
3925 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
3926
3927 =cut
3928
3929 sub realtime_bop {
3930   my $self = shift;
3931
3932   return $self->_new_realtime_bop(@_)
3933     if $self->_new_bop_required();
3934
3935   my($method, $amount);
3936   my %options = ();
3937   if (ref($_[0]) eq 'HASH') {
3938     %options = %{$_[0]};
3939     $method = $options{method};
3940     $amount = $options{amount};
3941   } else {
3942     ( $method, $amount ) = ( shift, shift );
3943     %options = @_;
3944   }
3945   if ( $DEBUG ) {
3946     warn "$me realtime_bop: $method $amount\n";
3947     warn "  $_ => $options{$_}\n" foreach keys %options;
3948   }
3949
3950   $options{'description'} ||= 'Internet services';
3951
3952   return $self->fake_bop($method, $amount, %options) if $options{'fake'};
3953
3954   eval "use Business::OnlinePayment";
3955   die $@ if $@;
3956
3957   my $payinfo = exists($options{'payinfo'})
3958                   ? $options{'payinfo'}
3959                   : $self->payinfo;
3960
3961   my %method2payby = (
3962     'CC'     => 'CARD',
3963     'ECHECK' => 'CHEK',
3964     'LEC'    => 'LECB',
3965   );
3966
3967   ###
3968   # check for banned credit card/ACH
3969   ###
3970
3971   my $ban = qsearchs('banned_pay', {
3972     'payby'   => $method2payby{$method},
3973     'payinfo' => md5_base64($payinfo),
3974   } );
3975   return "Banned credit card" if $ban;
3976
3977   ###
3978   # set taxclass and trans_is_recur based on invnum if there is one
3979   ###
3980
3981   my $taxclass = '';
3982   my $trans_is_recur = 0;
3983   if ( $options{'invnum'} ) {
3984
3985     my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
3986     die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
3987
3988     my @part_pkg =
3989       map  { $_->part_pkg }
3990       grep { $_ }
3991       map  { $_->cust_pkg }
3992       $cust_bill->cust_bill_pkg;
3993
3994     my @taxclasses = map $_->taxclass, @part_pkg;
3995     $taxclass = $taxclasses[0]
3996       unless grep { $taxclasses[0] ne $_ } @taxclasses; #unless there are
3997                                                         #different taxclasses
3998     $trans_is_recur = 1
3999       if grep { $_->freq ne '0' } @part_pkg;
4000
4001   }
4002
4003   ###
4004   # select a gateway
4005   ###
4006
4007   #look for an agent gateway override first
4008   my $cardtype;
4009   if ( $method eq 'CC' ) {
4010     $cardtype = cardtype($payinfo);
4011   } elsif ( $method eq 'ECHECK' ) {
4012     $cardtype = 'ACH';
4013   } else {
4014     $cardtype = $method;
4015   }
4016
4017   my $override =
4018        qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4019                                            cardtype => $cardtype,
4020                                            taxclass => $taxclass,       } )
4021     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4022                                            cardtype => '',
4023                                            taxclass => $taxclass,       } )
4024     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4025                                            cardtype => $cardtype,
4026                                            taxclass => '',              } )
4027     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4028                                            cardtype => '',
4029                                            taxclass => '',              } );
4030
4031   my $payment_gateway = '';
4032   my( $processor, $login, $password, $action, @bop_options );
4033   if ( $override ) { #use a payment gateway override
4034
4035     $payment_gateway = $override->payment_gateway;
4036
4037     $processor   = $payment_gateway->gateway_module;
4038     $login       = $payment_gateway->gateway_username;
4039     $password    = $payment_gateway->gateway_password;
4040     $action      = $payment_gateway->gateway_action;
4041     @bop_options = $payment_gateway->options;
4042
4043   } else { #use the standard settings from the config
4044
4045     ( $processor, $login, $password, $action, @bop_options ) =
4046       $self->default_payment_gateway($method);
4047
4048   }
4049
4050   ###
4051   # massage data
4052   ###
4053
4054   my $address = exists($options{'address1'})
4055                     ? $options{'address1'}
4056                     : $self->address1;
4057   my $address2 = exists($options{'address2'})
4058                     ? $options{'address2'}
4059                     : $self->address2;
4060   $address .= ", ". $address2 if length($address2);
4061
4062   my $o_payname = exists($options{'payname'})
4063                     ? $options{'payname'}
4064                     : $self->payname;
4065   my($payname, $payfirst, $paylast);
4066   if ( $o_payname && $method ne 'ECHECK' ) {
4067     ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4068       or return "Illegal payname $payname";
4069     ($payfirst, $paylast) = ($1, $2);
4070   } else {
4071     $payfirst = $self->getfield('first');
4072     $paylast = $self->getfield('last');
4073     $payname =  "$payfirst $paylast";
4074   }
4075
4076   my @invoicing_list = $self->invoicing_list_emailonly;
4077   if ( $conf->exists('emailinvoiceautoalways')
4078        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4079        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4080     push @invoicing_list, $self->all_emails;
4081   }
4082
4083   my $email = ($conf->exists('business-onlinepayment-email-override'))
4084               ? $conf->config('business-onlinepayment-email-override')
4085               : $invoicing_list[0];
4086
4087   my %content = ();
4088
4089   my $payip = exists($options{'payip'})
4090                 ? $options{'payip'}
4091                 : $self->payip;
4092   $content{customer_ip} = $payip
4093     if length($payip);
4094
4095   $content{invoice_number} = $options{'invnum'}
4096     if exists($options{'invnum'}) && length($options{'invnum'});
4097
4098   $content{email_customer} =
4099     (    $conf->exists('business-onlinepayment-email_customer')
4100       || $conf->exists('business-onlinepayment-email-override') );
4101
4102   my $paydate = '';
4103   if ( $method eq 'CC' ) {
4104
4105     $content{card_number} = $payinfo;
4106     $paydate = exists($options{'paydate'})
4107                     ? $options{'paydate'}
4108                     : $self->paydate;
4109     $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4110     $content{expiration} = "$2/$1";
4111
4112     my $paycvv = exists($options{'paycvv'})
4113                    ? $options{'paycvv'}
4114                    : $self->paycvv;
4115     $content{cvv2} = $paycvv
4116       if length($paycvv);
4117
4118     my $paystart_month = exists($options{'paystart_month'})
4119                            ? $options{'paystart_month'}
4120                            : $self->paystart_month;
4121
4122     my $paystart_year  = exists($options{'paystart_year'})
4123                            ? $options{'paystart_year'}
4124                            : $self->paystart_year;
4125
4126     $content{card_start} = "$paystart_month/$paystart_year"
4127       if $paystart_month && $paystart_year;
4128
4129     my $payissue       = exists($options{'payissue'})
4130                            ? $options{'payissue'}
4131                            : $self->payissue;
4132     $content{issue_number} = $payissue if $payissue;
4133
4134     if ( $self->_bop_recurring_billing( 'payinfo'        => $payinfo,
4135                                         'trans_is_recur' => $trans_is_recur,
4136                                       )
4137        )
4138     {
4139       $content{recurring_billing} = 'YES';
4140       $content{acct_code} = 'rebill'
4141         if $conf->exists('credit_card-recurring_billing_acct_code');
4142     }
4143
4144   } elsif ( $method eq 'ECHECK' ) {
4145     ( $content{account_number}, $content{routing_code} ) =
4146       split('@', $payinfo);
4147     $content{bank_name} = $o_payname;
4148     $content{bank_state} = exists($options{'paystate'})
4149                              ? $options{'paystate'}
4150                              : $self->getfield('paystate');
4151     $content{account_type} = exists($options{'paytype'})
4152                                ? uc($options{'paytype'}) || 'CHECKING'
4153                                : uc($self->getfield('paytype')) || 'CHECKING';
4154     $content{account_name} = $payname;
4155     $content{customer_org} = $self->company ? 'B' : 'I';
4156     $content{state_id}       = exists($options{'stateid'})
4157                                  ? $options{'stateid'}
4158                                  : $self->getfield('stateid');
4159     $content{state_id_state} = exists($options{'stateid_state'})
4160                                  ? $options{'stateid_state'}
4161                                  : $self->getfield('stateid_state');
4162     $content{customer_ssn} = exists($options{'ss'})
4163                                ? $options{'ss'}
4164                                : $self->ss;
4165   } elsif ( $method eq 'LEC' ) {
4166     $content{phone} = $payinfo;
4167   }
4168
4169   ###
4170   # run transaction(s)
4171   ###
4172
4173   my $balance = exists( $options{'balance'} )
4174                   ? $options{'balance'}
4175                   : $self->balance;
4176
4177   $self->select_for_update; #mutex ... just until we get our pending record in
4178
4179   #the checks here are intended to catch concurrent payments
4180   #double-form-submission prevention is taken care of in cust_pay_pending::check
4181
4182   #check the balance
4183   return "The customer's balance has changed; $method transaction aborted."
4184     if $self->balance < $balance;
4185     #&& $self->balance < $amount; #might as well anyway?
4186
4187   #also check and make sure there aren't *other* pending payments for this cust
4188
4189   my @pending = qsearch('cust_pay_pending', {
4190     'custnum' => $self->custnum,
4191     'status'  => { op=>'!=', value=>'done' }
4192   });
4193   return "A payment is already being processed for this customer (".
4194          join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
4195          "); $method transaction aborted."
4196     if scalar(@pending);
4197
4198   #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
4199
4200   my $cust_pay_pending = new FS::cust_pay_pending {
4201     'custnum'           => $self->custnum,
4202     #'invnum'            => $options{'invnum'},
4203     'paid'              => $amount,
4204     '_date'             => '',
4205     'payby'             => $method2payby{$method},
4206     'payinfo'           => $payinfo,
4207     'paydate'           => $paydate,
4208     'recurring_billing' => $content{recurring_billing},
4209     'pkgnum'            => $options{'pkgnum'},
4210     'status'            => 'new',
4211     'gatewaynum'        => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
4212   };
4213   $cust_pay_pending->payunique( $options{payunique} )
4214     if defined($options{payunique}) && length($options{payunique});
4215   my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
4216   return $cpp_new_err if $cpp_new_err;
4217
4218   my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
4219
4220   my $transaction = new Business::OnlinePayment( $processor, @bop_options );
4221   $transaction->content(
4222     'type'           => $method,
4223     'login'          => $login,
4224     'password'       => $password,
4225     'action'         => $action1,
4226     'description'    => $options{'description'},
4227     'amount'         => $amount,
4228     #'invoice_number' => $options{'invnum'},
4229     'customer_id'    => $self->custnum,
4230     'last_name'      => $paylast,
4231     'first_name'     => $payfirst,
4232     'name'           => $payname,
4233     'address'        => $address,
4234     'city'           => ( exists($options{'city'})
4235                             ? $options{'city'}
4236                             : $self->city          ),
4237     'state'          => ( exists($options{'state'})
4238                             ? $options{'state'}
4239                             : $self->state          ),
4240     'zip'            => ( exists($options{'zip'})
4241                             ? $options{'zip'}
4242                             : $self->zip          ),
4243     'country'        => ( exists($options{'country'})
4244                             ? $options{'country'}
4245                             : $self->country          ),
4246     'referer'        => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4247     'email'          => $email,
4248     'phone'          => $self->daytime || $self->night,
4249     %content, #after
4250   );
4251
4252   $cust_pay_pending->status('pending');
4253   my $cpp_pending_err = $cust_pay_pending->replace;
4254   return $cpp_pending_err if $cpp_pending_err;
4255
4256   #config?
4257   my $BOP_TESTING = 0;
4258   my $BOP_TESTING_SUCCESS = 1;
4259
4260   unless ( $BOP_TESTING ) {
4261     $transaction->submit();
4262   } else {
4263     if ( $BOP_TESTING_SUCCESS ) {
4264       $transaction->is_success(1);
4265       $transaction->authorization('fake auth');
4266     } else {
4267       $transaction->is_success(0);
4268       $transaction->error_message('fake failure');
4269     }
4270   }
4271
4272   if ( $transaction->is_success() && $action2 ) {
4273
4274     $cust_pay_pending->status('authorized');
4275     my $cpp_authorized_err = $cust_pay_pending->replace;
4276     return $cpp_authorized_err if $cpp_authorized_err;
4277
4278     my $auth = $transaction->authorization;
4279     my $ordernum = $transaction->can('order_number')
4280                    ? $transaction->order_number
4281                    : '';
4282
4283     my $capture =
4284       new Business::OnlinePayment( $processor, @bop_options );
4285
4286     my %capture = (
4287       %content,
4288       type           => $method,
4289       action         => $action2,
4290       login          => $login,
4291       password       => $password,
4292       order_number   => $ordernum,
4293       amount         => $amount,
4294       authorization  => $auth,
4295       description    => $options{'description'},
4296     );
4297
4298     foreach my $field (qw( authorization_source_code returned_ACI
4299                            transaction_identifier validation_code
4300                            transaction_sequence_num local_transaction_date
4301                            local_transaction_time AVS_result_code          )) {
4302       $capture{$field} = $transaction->$field() if $transaction->can($field);
4303     }
4304
4305     $capture->content( %capture );
4306
4307     $capture->submit();
4308
4309     unless ( $capture->is_success ) {
4310       my $e = "Authorization successful but capture failed, custnum #".
4311               $self->custnum. ': '.  $capture->result_code.
4312               ": ". $capture->error_message;
4313       warn $e;
4314       return $e;
4315     }
4316
4317   }
4318
4319   $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
4320   my $cpp_captured_err = $cust_pay_pending->replace;
4321   return $cpp_captured_err if $cpp_captured_err;
4322
4323   ###
4324   # remove paycvv after initial transaction
4325   ###
4326
4327   #false laziness w/misc/process/payment.cgi - check both to make sure working
4328   # correctly
4329   if ( defined $self->dbdef_table->column('paycvv')
4330        && length($self->paycvv)
4331        && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
4332   ) {
4333     my $error = $self->remove_cvv;
4334     if ( $error ) {
4335       warn "WARNING: error removing cvv: $error\n";
4336     }
4337   }
4338
4339   ###
4340   # result handling
4341   ###
4342
4343   if ( $transaction->is_success() ) {
4344
4345     my $paybatch = '';
4346     if ( $payment_gateway ) { # agent override
4347       $paybatch = $payment_gateway->gatewaynum. '-';
4348     }
4349
4350     $paybatch .= "$processor:". $transaction->authorization;
4351
4352     $paybatch .= ':'. $transaction->order_number
4353       if $transaction->can('order_number')
4354       && length($transaction->order_number);
4355
4356     my $cust_pay = new FS::cust_pay ( {
4357        'custnum'  => $self->custnum,
4358        'invnum'   => $options{'invnum'},
4359        'paid'     => $amount,
4360        '_date'    => '',
4361        'payby'    => $method2payby{$method},
4362        'payinfo'  => $payinfo,
4363        'paybatch' => $paybatch,
4364        'paydate'  => $paydate,
4365        'pkgnum'   => $options{'pkgnum'},
4366     } );
4367     #doesn't hurt to know, even though the dup check is in cust_pay_pending now
4368     $cust_pay->payunique( $options{payunique} )
4369       if defined($options{payunique}) && length($options{payunique});
4370
4371     my $oldAutoCommit = $FS::UID::AutoCommit;
4372     local $FS::UID::AutoCommit = 0;
4373     my $dbh = dbh;
4374
4375     #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
4376
4377     my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
4378
4379     if ( $error ) {
4380       $cust_pay->invnum(''); #try again with no specific invnum
4381       my $error2 = $cust_pay->insert( $options{'manual'} ?
4382                                       ( 'manual' => 1 ) : ()
4383                                     );
4384       if ( $error2 ) {
4385         # gah.  but at least we have a record of the state we had to abort in
4386         # from cust_pay_pending now.
4387         my $e = "WARNING: $method captured but payment not recorded - ".
4388                 "error inserting payment ($processor): $error2".
4389                 " (previously tried insert with invnum #$options{'invnum'}" .
4390                 ": $error ) - pending payment saved as paypendingnum ".
4391                 $cust_pay_pending->paypendingnum. "\n";
4392         warn $e;
4393         return $e;
4394       }
4395     }
4396
4397     if ( $options{'paynum_ref'} ) {
4398       ${ $options{'paynum_ref'} } = $cust_pay->paynum;
4399     }
4400
4401     $cust_pay_pending->status('done');
4402     $cust_pay_pending->statustext('captured');
4403     $cust_pay_pending->paynum($cust_pay->paynum);
4404     my $cpp_done_err = $cust_pay_pending->replace;
4405
4406     if ( $cpp_done_err ) {
4407
4408       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4409       my $e = "WARNING: $method captured but payment not recorded - ".
4410               "error updating status for paypendingnum ".
4411               $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4412       warn $e;
4413       return $e;
4414
4415     } else {
4416
4417       $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4418
4419       if ( $options{'apply'} ) {
4420         my $apply_error = $self->apply_payments_and_credits;
4421         if ( $apply_error ) {
4422           warn "WARNING: error applying payment: $apply_error\n";
4423           #but we still should return no error cause the payment otherwise went
4424           #through...
4425         }
4426       }
4427
4428       return ''; #no error
4429
4430     }
4431
4432   } else {
4433
4434     my $perror = "$processor error: ". $transaction->error_message;
4435
4436     unless ( $transaction->error_message ) {
4437
4438       my $t_response;
4439       if ( $transaction->can('response_page') ) {
4440         $t_response = {
4441                         'page'    => ( $transaction->can('response_page')
4442                                          ? $transaction->response_page
4443                                          : ''
4444                                      ),
4445                         'code'    => ( $transaction->can('response_code')
4446                                          ? $transaction->response_code
4447                                          : ''
4448                                      ),
4449                         'headers' => ( $transaction->can('response_headers')
4450                                          ? $transaction->response_headers
4451                                          : ''
4452                                      ),
4453                       };
4454       } else {
4455         $t_response .=
4456           "No additional debugging information available for $processor";
4457       }
4458
4459       $perror .= "No error_message returned from $processor -- ".
4460                  ( ref($t_response) ? Dumper($t_response) : $t_response );
4461
4462     }
4463
4464     if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
4465          && $conf->exists('emaildecline')
4466          && grep { $_ ne 'POST' } $self->invoicing_list
4467          && ! grep { $transaction->error_message =~ /$_/ }
4468                    $conf->config('emaildecline-exclude')
4469     ) {
4470       my @templ = $conf->config('declinetemplate');
4471       my $template = new Text::Template (
4472         TYPE   => 'ARRAY',
4473         SOURCE => [ map "$_\n", @templ ],
4474       ) or return "($perror) can't create template: $Text::Template::ERROR";
4475       $template->compile()
4476         or return "($perror) can't compile template: $Text::Template::ERROR";
4477
4478       my $templ_hash = {
4479         'company_name'    =>
4480           scalar( $conf->config('company_name', $self->agentnum ) ),
4481         'company_address' =>
4482           join("\n", $conf->config('company_address', $self->agentnum ) ),
4483         'error'           => $transaction->error_message,
4484       };
4485
4486       my $error = send_email(
4487         'from'    => $conf->config('invoice_from', $self->agentnum ),
4488         'to'      => [ grep { $_ ne 'POST' } $self->invoicing_list ],
4489         'subject' => 'Your payment could not be processed',
4490         'body'    => [ $template->fill_in(HASH => $templ_hash) ],
4491       );
4492
4493       $perror .= " (also received error sending decline notification: $error)"
4494         if $error;
4495
4496     }
4497
4498     $cust_pay_pending->status('done');
4499     $cust_pay_pending->statustext("declined: $perror");
4500     my $cpp_done_err = $cust_pay_pending->replace;
4501     if ( $cpp_done_err ) {
4502       my $e = "WARNING: $method declined but pending payment not resolved - ".
4503               "error updating status for paypendingnum ".
4504               $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
4505       warn $e;
4506       $perror = "$e ($perror)";
4507     }
4508
4509     return $perror;
4510   }
4511
4512 }
4513
4514 sub _bop_recurring_billing {
4515   my( $self, %opt ) = @_;
4516
4517   my $method = scalar($conf->config('credit_card-recurring_billing_flag'));
4518
4519   if ( defined($method) && $method eq 'transaction_is_recur' ) {
4520
4521     return 1 if $opt{'trans_is_recur'};
4522
4523   } else {
4524
4525     my %hash = ( 'custnum' => $self->custnum,
4526                  'payby'   => 'CARD',
4527                );
4528
4529     return 1
4530       if qsearch('cust_pay', { %hash, 'payinfo' => $opt{'payinfo'} } )
4531       || qsearch('cust_pay', { %hash, 'paymask' => $self->mask_payinfo('CARD',
4532                                                                $opt{'payinfo'} )
4533                              } );
4534
4535   }
4536
4537   return 0;
4538
4539 }
4540
4541
4542 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
4543
4544 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
4545 via a Business::OnlinePayment realtime gateway.  See
4546 L<http://420.am/business-onlinepayment> for supported gateways.
4547
4548 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4549
4550 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
4551
4552 Most gateways require a reference to an original payment transaction to refund,
4553 so you probably need to specify a I<paynum>.
4554
4555 I<amount> defaults to the original amount of the payment if not specified.
4556
4557 I<reason> specifies a reason for the refund.
4558
4559 I<paydate> specifies the expiration date for a credit card overriding the
4560 value from the customer record or the payment record. Specified as yyyy-mm-dd
4561
4562 Implementation note: If I<amount> is unspecified or equal to the amount of the
4563 orignal payment, first an attempt is made to "void" the transaction via
4564 the gateway (to cancel a not-yet settled transaction) and then if that fails,
4565 the normal attempt is made to "refund" ("credit") the transaction via the
4566 gateway is attempted.
4567
4568 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4569 #I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
4570 #if set, will override the value from the customer record.
4571
4572 #If an I<invnum> is specified, this payment (if successful) is applied to the
4573 #specified invoice.  If you don't specify an I<invnum> you might want to
4574 #call the B<apply_payments> method.
4575
4576 =cut
4577
4578 #some false laziness w/realtime_bop, not enough to make it worth merging
4579 #but some useful small subs should be pulled out
4580 sub realtime_refund_bop {
4581   my $self = shift;
4582
4583   return $self->_new_realtime_refund_bop(@_)
4584     if $self->_new_bop_required();
4585
4586   my( $method, %options ) = @_;
4587   if ( $DEBUG ) {
4588     warn "$me realtime_refund_bop: $method refund\n";
4589     warn "  $_ => $options{$_}\n" foreach keys %options;
4590   }
4591
4592   eval "use Business::OnlinePayment";
4593   die $@ if $@;
4594
4595   ###
4596   # look up the original payment and optionally a gateway for that payment
4597   ###
4598
4599   my $cust_pay = '';
4600   my $amount = $options{'amount'};
4601
4602   my( $processor, $login, $password, @bop_options ) ;
4603   my( $auth, $order_number ) = ( '', '', '' );
4604
4605   if ( $options{'paynum'} ) {
4606
4607     warn "  paynum: $options{paynum}\n" if $DEBUG > 1;
4608     $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
4609       or return "Unknown paynum $options{'paynum'}";
4610     $amount ||= $cust_pay->paid;
4611
4612     $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
4613       or return "Can't parse paybatch for paynum $options{'paynum'}: ".
4614                 $cust_pay->paybatch;
4615     my $gatewaynum = '';
4616     ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
4617
4618     if ( $gatewaynum ) { #gateway for the payment to be refunded
4619
4620       my $payment_gateway =
4621         qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
4622       die "payment gateway $gatewaynum not found"
4623         unless $payment_gateway;
4624
4625       $processor   = $payment_gateway->gateway_module;
4626       $login       = $payment_gateway->gateway_username;
4627       $password    = $payment_gateway->gateway_password;
4628       @bop_options = $payment_gateway->options;
4629
4630     } else { #try the default gateway
4631
4632       my( $conf_processor, $unused_action );
4633       ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
4634         $self->default_payment_gateway($method);
4635
4636       return "processor of payment $options{'paynum'} $processor does not".
4637              " match default processor $conf_processor"
4638         unless $processor eq $conf_processor;
4639
4640     }
4641
4642
4643   } else { # didn't specify a paynum, so look for agent gateway overrides
4644            # like a normal transaction
4645
4646     my $cardtype;
4647     if ( $method eq 'CC' ) {
4648       $cardtype = cardtype($self->payinfo);
4649     } elsif ( $method eq 'ECHECK' ) {
4650       $cardtype = 'ACH';
4651     } else {
4652       $cardtype = $method;
4653     }
4654     my $override =
4655            qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4656                                                cardtype => $cardtype,
4657                                                taxclass => '',              } )
4658         || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
4659                                                cardtype => '',
4660                                                taxclass => '',              } );
4661
4662     if ( $override ) { #use a payment gateway override
4663
4664       my $payment_gateway = $override->payment_gateway;
4665
4666       $processor   = $payment_gateway->gateway_module;
4667       $login       = $payment_gateway->gateway_username;
4668       $password    = $payment_gateway->gateway_password;
4669       #$action      = $payment_gateway->gateway_action;
4670       @bop_options = $payment_gateway->options;
4671
4672     } else { #use the standard settings from the config
4673
4674       my $unused_action;
4675       ( $processor, $login, $password, $unused_action, @bop_options ) =
4676         $self->default_payment_gateway($method);
4677
4678     }
4679
4680   }
4681   return "neither amount nor paynum specified" unless $amount;
4682
4683   my %content = (
4684     'type'           => $method,
4685     'login'          => $login,
4686     'password'       => $password,
4687     'order_number'   => $order_number,
4688     'amount'         => $amount,
4689     'referer'        => 'http://cleanwhisker.420.am/', #XXX fix referer :/
4690   );
4691   $content{authorization} = $auth
4692     if length($auth); #echeck/ACH transactions have an order # but no auth
4693                       #(at least with authorize.net)
4694
4695   my $disable_void_after;
4696   if ($conf->exists('disable_void_after')
4697       && $conf->config('disable_void_after') =~ /^(\d+)$/) {
4698     $disable_void_after = $1;
4699   }
4700
4701   #first try void if applicable
4702   if ( $cust_pay && $cust_pay->paid == $amount
4703     && (
4704       ( not defined($disable_void_after) )
4705       || ( time < ($cust_pay->_date + $disable_void_after ) )
4706     )
4707   ) {
4708     warn "  attempting void\n" if $DEBUG > 1;
4709     my $void = new Business::OnlinePayment( $processor, @bop_options );
4710     $void->content( 'action' => 'void', %content );
4711     $void->submit();
4712     if ( $void->is_success ) {
4713       my $error = $cust_pay->void($options{'reason'});
4714       if ( $error ) {
4715         # gah, even with transactions.
4716         my $e = 'WARNING: Card/ACH voided but database not updated - '.
4717                 "error voiding payment: $error";
4718         warn $e;
4719         return $e;
4720       }
4721       warn "  void successful\n" if $DEBUG > 1;
4722       return '';
4723     }
4724   }
4725
4726   warn "  void unsuccessful, trying refund\n"
4727     if $DEBUG > 1;
4728
4729   #massage data
4730   my $address = $self->address1;
4731   $address .= ", ". $self->address2 if $self->address2;
4732
4733   my($payname, $payfirst, $paylast);
4734   if ( $self->payname && $method ne 'ECHECK' ) {
4735     $payname = $self->payname;
4736     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
4737       or return "Illegal payname $payname";
4738     ($payfirst, $paylast) = ($1, $2);
4739   } else {
4740     $payfirst = $self->getfield('first');
4741     $paylast = $self->getfield('last');
4742     $payname =  "$payfirst $paylast";
4743   }
4744
4745   my @invoicing_list = $self->invoicing_list_emailonly;
4746   if ( $conf->exists('emailinvoiceautoalways')
4747        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
4748        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
4749     push @invoicing_list, $self->all_emails;
4750   }
4751
4752   my $email = ($conf->exists('business-onlinepayment-email-override'))
4753               ? $conf->config('business-onlinepayment-email-override')
4754               : $invoicing_list[0];
4755
4756   my $payip = exists($options{'payip'})
4757                 ? $options{'payip'}
4758                 : $self->payip;
4759   $content{customer_ip} = $payip
4760     if length($payip);
4761
4762   my $payinfo = '';
4763   if ( $method eq 'CC' ) {
4764
4765     if ( $cust_pay ) {
4766       $content{card_number} = $payinfo = $cust_pay->payinfo;
4767       (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
4768         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
4769         ($content{expiration} = "$2/$1");  # where available
4770     } else {
4771       $content{card_number} = $payinfo = $self->payinfo;
4772       (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
4773         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
4774       $content{expiration} = "$2/$1";
4775     }
4776
4777   } elsif ( $method eq 'ECHECK' ) {
4778
4779     if ( $cust_pay ) {
4780       $payinfo = $cust_pay->payinfo;
4781     } else {
4782       $payinfo = $self->payinfo;
4783     }
4784     ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
4785     $content{bank_name} = $self->payname;
4786     $content{account_type} = 'CHECKING';
4787     $content{account_name} = $payname;
4788     $content{customer_org} = $self->company ? 'B' : 'I';
4789     $content{customer_ssn} = $self->ss;
4790   } elsif ( $method eq 'LEC' ) {
4791     $content{phone} = $payinfo = $self->payinfo;
4792   }
4793
4794   #then try refund
4795   my $refund = new Business::OnlinePayment( $processor, @bop_options );
4796   my %sub_content = $refund->content(
4797     'action'         => 'credit',
4798     'customer_id'    => $self->custnum,
4799     'last_name'      => $paylast,
4800     'first_name'     => $payfirst,
4801     'name'           => $payname,
4802     'address'        => $address,
4803     'city'           => $self->city,
4804     'state'          => $self->state,
4805     'zip'            => $self->zip,
4806     'country'        => $self->country,
4807     'email'          => $email,
4808     'phone'          => $self->daytime || $self->night,
4809     %content, #after
4810   );
4811   warn join('', map { "  $_ => $sub_content{$_}\n" } keys %sub_content )
4812     if $DEBUG > 1;
4813   $refund->submit();
4814
4815   return "$processor error: ". $refund->error_message
4816     unless $refund->is_success();
4817
4818   my %method2payby = (
4819     'CC'     => 'CARD',
4820     'ECHECK' => 'CHEK',
4821     'LEC'    => 'LECB',
4822   );
4823
4824   my $paybatch = "$processor:". $refund->authorization;
4825   $paybatch .= ':'. $refund->order_number
4826     if $refund->can('order_number') && $refund->order_number;
4827
4828   while ( $cust_pay && $cust_pay->unapplied < $amount ) {
4829     my @cust_bill_pay = $cust_pay->cust_bill_pay;
4830     last unless @cust_bill_pay;
4831     my $cust_bill_pay = pop @cust_bill_pay;
4832     my $error = $cust_bill_pay->delete;
4833     last if $error;
4834   }
4835
4836   my $cust_refund = new FS::cust_refund ( {
4837     'custnum'  => $self->custnum,
4838     'paynum'   => $options{'paynum'},
4839     'refund'   => $amount,
4840     '_date'    => '',
4841     'payby'    => $method2payby{$method},
4842     'payinfo'  => $payinfo,
4843     'paybatch' => $paybatch,
4844     'reason'   => $options{'reason'} || 'card or ACH refund',
4845   } );
4846   my $error = $cust_refund->insert;
4847   if ( $error ) {
4848     $cust_refund->paynum(''); #try again with no specific paynum
4849     my $error2 = $cust_refund->insert;
4850     if ( $error2 ) {
4851       # gah, even with transactions.
4852       my $e = 'WARNING: Card/ACH refunded but database not updated - '.
4853               "error inserting refund ($processor): $error2".
4854               " (previously tried insert with paynum #$options{'paynum'}" .
4855               ": $error )";
4856       warn $e;
4857       return $e;
4858     }
4859   }
4860
4861   ''; #no error
4862
4863 }
4864
4865 # does the configuration indicate the new bop routines are required?
4866
4867 sub _new_bop_required {
4868   my $self = shift;
4869
4870   my $botpp = 'Business::OnlineThirdPartyPayment';
4871
4872   return 1
4873     if ( $conf->config('business-onlinepayment-namespace') eq $botpp ||
4874          scalar( grep { $_->gateway_namespace eq $botpp }
4875                  qsearch( 'payment_gateway', { 'disabled' => '' } )
4876                )
4877        )
4878   ;
4879
4880   '';
4881 }
4882
4883 =item realtime_collect [ OPTION => VALUE ... ]
4884
4885 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4886 via a Business::OnlinePayment or Business::OnlineThirdPartyPayment realtime
4887 gateway.  See L<http://420.am/business-onlinepayment> and
4888 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
4889
4890 On failure returns an error message.
4891
4892 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.
4893
4894 Available options are: I<method>, I<amount>, I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>, I<pkgnum>
4895
4896 I<method> is one of: I<CC>, I<ECHECK> and I<LEC>.  If none is specified
4897 then it is deduced from the customer record.
4898
4899 If no I<amount> is specified, then the customer balance is used.
4900
4901 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4902 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
4903 if set, will override the value from the customer record.
4904
4905 I<description> is a free-text field passed to the gateway.  It defaults to
4906 "Internet services".
4907
4908 If an I<invnum> is specified, this payment (if successful) is applied to the
4909 specified invoice.  If you don't specify an I<invnum> you might want to
4910 call the B<apply_payments> method or set the I<apply> option.
4911
4912 I<apply> can be set to true to apply a resulting payment.
4913
4914 I<quiet> can be set true to surpress email decline notices.
4915
4916 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
4917 resulting paynum, if any.
4918
4919 I<payunique> is a unique identifier for this payment.
4920
4921 I<session_id> is a session identifier associated with this payment.
4922
4923 I<depend_jobnum> allows payment capture to unlock export jobs
4924
4925 =cut
4926
4927 sub realtime_collect {
4928   my( $self, %options ) = @_;
4929
4930   if ( $DEBUG ) {
4931     warn "$me realtime_collect:\n";
4932     warn "  $_ => $options{$_}\n" foreach keys %options;
4933   }
4934
4935   $options{amount} = $self->balance unless exists( $options{amount} );
4936   $options{method} = FS::payby->payby2bop($self->payby)
4937     unless exists( $options{method} );
4938
4939   return $self->realtime_bop({%options});
4940
4941 }
4942
4943 =item _realtime_bop { [ ARG => VALUE ... ] }
4944
4945 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
4946 via a Business::OnlinePayment realtime gateway.  See
4947 L<http://420.am/business-onlinepayment> for supported gateways.
4948
4949 Required arguments in the hashref are I<method>, and I<amount>
4950
4951 Available methods are: I<CC>, I<ECHECK> and I<LEC>
4952
4953 Available optional arguments are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>, I<session_id>
4954
4955 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
4956 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
4957 if set, will override the value from the customer record.
4958
4959 I<description> is a free-text field passed to the gateway.  It defaults to
4960 "Internet services".
4961
4962 If an I<invnum> is specified, this payment (if successful) is applied to the
4963 specified invoice.  If you don't specify an I<invnum> you might want to
4964 call the B<apply_payments> method.
4965
4966 I<quiet> can be set true to surpress email decline notices.
4967
4968 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
4969 resulting paynum, if any.
4970
4971 I<payunique> is a unique identifier for this payment.
4972
4973 I<session_id> is a session identifier associated with this payment.
4974
4975 I<depend_jobnum> allows payment capture to unlock export jobs
4976
4977 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
4978
4979 =cut
4980
4981 # some helper routines
4982 sub _payment_gateway {
4983   my ($self, $options) = @_;
4984
4985   $options->{payment_gateway} = $self->agent->payment_gateway( %$options )
4986     unless exists($options->{payment_gateway});
4987
4988   $options->{payment_gateway};
4989 }
4990
4991 sub _bop_auth {
4992   my ($self, $options) = @_;
4993
4994   (
4995     'login'    => $options->{payment_gateway}->gateway_username,
4996     'password' => $options->{payment_gateway}->gateway_password,
4997   );
4998 }
4999
5000 sub _bop_options {
5001   my ($self, $options) = @_;
5002
5003   $options->{payment_gateway}->gatewaynum
5004     ? $options->{payment_gateway}->options
5005     : @{ $options->{payment_gateway}->get('options') };
5006 }
5007
5008 sub _bop_defaults {
5009   my ($self, $options) = @_;
5010
5011   $options->{description} ||= 'Internet services';
5012   $options->{payinfo} = $self->payinfo unless exists( $options->{payinfo} );
5013   $options->{invnum} ||= '';
5014   $options->{payname} = $self->payname unless exists( $options->{payname} );
5015 }
5016
5017 sub _bop_content {
5018   my ($self, $options) = @_;
5019   my %content = ();
5020
5021   $content{address} = exists($options->{'address1'})
5022                         ? $options->{'address1'}
5023                         : $self->address1;
5024   my $address2 = exists($options->{'address2'})
5025                    ? $options->{'address2'}
5026                    : $self->address2;
5027   $content{address} .= ", ". $address2 if length($address2);
5028
5029   my $payip = exists($options->{'payip'}) ? $options->{'payip'} : $self->payip;
5030   $content{customer_ip} = $payip if length($payip);
5031
5032   $content{invoice_number} = $options->{'invnum'}
5033     if exists($options->{'invnum'}) && length($options->{'invnum'});
5034
5035   $content{email_customer} =
5036     (    $conf->exists('business-onlinepayment-email_customer')
5037       || $conf->exists('business-onlinepayment-email-override') );
5038
5039   $content{payfirst} = $self->getfield('first');
5040   $content{paylast} = $self->getfield('last');
5041
5042   $content{account_name} = "$content{payfirst} $content{paylast}"
5043     if $options->{method} eq 'ECHECK';
5044
5045   $content{name} = $options->{payname};
5046   $content{name} = $content{account_name} if exists($content{account_name});
5047
5048   $content{city} = exists($options->{city})
5049                      ? $options->{city}
5050                      : $self->city;
5051   $content{state} = exists($options->{state})
5052                       ? $options->{state}
5053                       : $self->state;
5054   $content{zip} = exists($options->{zip})
5055                     ? $options->{'zip'}
5056                     : $self->zip;
5057   $content{country} = exists($options->{country})
5058                         ? $options->{country}
5059                         : $self->country;
5060   $content{referer} = 'http://cleanwhisker.420.am/'; #XXX fix referer :/
5061   $content{phone} = $self->daytime || $self->night;
5062
5063   (%content);
5064 }
5065
5066 my %bop_method2payby = (
5067   'CC'     => 'CARD',
5068   'ECHECK' => 'CHEK',
5069   'LEC'    => 'LECB',
5070 );
5071
5072 sub _new_realtime_bop {
5073   my $self = shift;
5074
5075   my %options = ();
5076   if (ref($_[0]) eq 'HASH') {
5077     %options = %{$_[0]};
5078   } else {
5079     my ( $method, $amount ) = ( shift, shift );
5080     %options = @_;
5081     $options{method} = $method;
5082     $options{amount} = $amount;
5083   }
5084
5085   if ( $DEBUG ) {
5086     warn "$me realtime_bop (new): $options{method} $options{amount}\n";
5087     warn "  $_ => $options{$_}\n" foreach keys %options;
5088   }
5089
5090   return $self->fake_bop(%options) if $options{'fake'};
5091
5092   $self->_bop_defaults(\%options);
5093
5094   ###
5095   # set trans_is_recur based on invnum if there is one
5096   ###
5097
5098   my $trans_is_recur = 0;
5099   if ( $options{'invnum'} ) {
5100
5101     my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
5102     die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
5103
5104     my @part_pkg =
5105       map  { $_->part_pkg }
5106       grep { $_ }
5107       map  { $_->cust_pkg }
5108       $cust_bill->cust_bill_pkg;
5109
5110     $trans_is_recur = 1
5111       if grep { $_->freq ne '0' } @part_pkg;
5112
5113   }
5114
5115   ###
5116   # select a gateway
5117   ###
5118
5119   my $payment_gateway =  $self->_payment_gateway( \%options );
5120   my $namespace = $payment_gateway->gateway_namespace;
5121
5122   eval "use $namespace";
5123   die $@ if $@;
5124
5125   ###
5126   # check for banned credit card/ACH
5127   ###
5128
5129   my $ban = qsearchs('banned_pay', {
5130     'payby'   => $bop_method2payby{$options{method}},
5131     'payinfo' => md5_base64($options{payinfo}),
5132   } );
5133   return "Banned credit card" if $ban;
5134
5135   ###
5136   # massage data
5137   ###
5138
5139   my (%bop_content) = $self->_bop_content(\%options);
5140
5141   if ( $options{method} ne 'ECHECK' ) {
5142     $options{payname} =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
5143       or return "Illegal payname $options{payname}";
5144     ($bop_content{payfirst}, $bop_content{paylast}) = ($1, $2);
5145   }
5146
5147   my @invoicing_list = $self->invoicing_list_emailonly;
5148   if ( $conf->exists('emailinvoiceautoalways')
5149        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5150        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5151     push @invoicing_list, $self->all_emails;
5152   }
5153
5154   my $email = ($conf->exists('business-onlinepayment-email-override'))
5155               ? $conf->config('business-onlinepayment-email-override')
5156               : $invoicing_list[0];
5157
5158   my $paydate = '';
5159   my %content = ();
5160   if ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'CC' ) {
5161
5162     $content{card_number} = $options{payinfo};
5163     $paydate = exists($options{'paydate'})
5164                     ? $options{'paydate'}
5165                     : $self->paydate;
5166     $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
5167     $content{expiration} = "$2/$1";
5168
5169     my $paycvv = exists($options{'paycvv'})
5170                    ? $options{'paycvv'}
5171                    : $self->paycvv;
5172     $content{cvv2} = $paycvv
5173       if length($paycvv);
5174
5175     my $paystart_month = exists($options{'paystart_month'})
5176                            ? $options{'paystart_month'}
5177                            : $self->paystart_month;
5178
5179     my $paystart_year  = exists($options{'paystart_year'})
5180                            ? $options{'paystart_year'}
5181                            : $self->paystart_year;
5182
5183     $content{card_start} = "$paystart_month/$paystart_year"
5184       if $paystart_month && $paystart_year;
5185
5186     my $payissue       = exists($options{'payissue'})
5187                            ? $options{'payissue'}
5188                            : $self->payissue;
5189     $content{issue_number} = $payissue if $payissue;
5190
5191     if ( $self->_bop_recurring_billing( 'payinfo'        => $options{'payinfo'},
5192                                         'trans_is_recur' => $trans_is_recur,
5193                                       )
5194        )
5195     {
5196       $content{recurring_billing} = 'YES';
5197       $content{acct_code} = 'rebill'
5198         if $conf->exists('credit_card-recurring_billing_acct_code');
5199     }
5200
5201   } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'ECHECK' ){
5202     ( $content{account_number}, $content{routing_code} ) =
5203       split('@', $options{payinfo});
5204     $content{bank_name} = $options{payname};
5205     $content{bank_state} = exists($options{'paystate'})
5206                              ? $options{'paystate'}
5207                              : $self->getfield('paystate');
5208     $content{account_type} = exists($options{'paytype'})
5209                                ? uc($options{'paytype'}) || 'CHECKING'
5210                                : uc($self->getfield('paytype')) || 'CHECKING';
5211     $content{customer_org} = $self->company ? 'B' : 'I';
5212     $content{state_id}       = exists($options{'stateid'})
5213                                  ? $options{'stateid'}
5214                                  : $self->getfield('stateid');
5215     $content{state_id_state} = exists($options{'stateid_state'})
5216                                  ? $options{'stateid_state'}
5217                                  : $self->getfield('stateid_state');
5218     $content{customer_ssn} = exists($options{'ss'})
5219                                ? $options{'ss'}
5220                                : $self->ss;
5221   } elsif ( $namespace eq 'Business::OnlinePayment' && $options{method} eq 'LEC' ) {
5222     $content{phone} = $options{payinfo};
5223   } elsif ( $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5224     #move along
5225   } else {
5226     #die an evil death
5227   }
5228
5229   ###
5230   # run transaction(s)
5231   ###
5232
5233   my $balance = exists( $options{'balance'} )
5234                   ? $options{'balance'}
5235                   : $self->balance;
5236
5237   $self->select_for_update; #mutex ... just until we get our pending record in
5238
5239   #the checks here are intended to catch concurrent payments
5240   #double-form-submission prevention is taken care of in cust_pay_pending::check
5241
5242   #check the balance
5243   return "The customer's balance has changed; $options{method} transaction aborted."
5244     if $self->balance < $balance;
5245     #&& $self->balance < $options{amount}; #might as well anyway?
5246
5247   #also check and make sure there aren't *other* pending payments for this cust
5248
5249   my @pending = qsearch('cust_pay_pending', {
5250     'custnum' => $self->custnum,
5251     'status'  => { op=>'!=', value=>'done' }
5252   });
5253   return "A payment is already being processed for this customer (".
5254          join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
5255          "); $options{method} transaction aborted."
5256     if scalar(@pending);
5257
5258   #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
5259
5260   my $cust_pay_pending = new FS::cust_pay_pending {
5261     'custnum'           => $self->custnum,
5262     #'invnum'            => $options{'invnum'},
5263     'paid'              => $options{amount},
5264     '_date'             => '',
5265     'payby'             => $bop_method2payby{$options{method}},
5266     'payinfo'           => $options{payinfo},
5267     'paydate'           => $paydate,
5268     'recurring_billing' => $content{recurring_billing},
5269     'pkgnum'            => $options{'pkgnum'},
5270     'status'            => 'new',
5271     'gatewaynum'        => $payment_gateway->gatewaynum || '',
5272     'session_id'        => $options{session_id} || '',
5273     'jobnum'            => $options{depend_jobnum} || '',
5274   };
5275   $cust_pay_pending->payunique( $options{payunique} )
5276     if defined($options{payunique}) && length($options{payunique});
5277   my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
5278   return $cpp_new_err if $cpp_new_err;
5279
5280   my( $action1, $action2 ) =
5281     split( /\s*\,\s*/, $payment_gateway->gateway_action );
5282
5283   my $transaction = new $namespace( $payment_gateway->gateway_module,
5284                                     $self->_bop_options(\%options),
5285                                   );
5286
5287   $transaction->content(
5288     'type'           => $options{method},
5289     $self->_bop_auth(\%options),
5290     'action'         => $action1,
5291     'description'    => $options{'description'},
5292     'amount'         => $options{amount},
5293     #'invoice_number' => $options{'invnum'},
5294     'customer_id'    => $self->custnum,
5295     %bop_content,
5296     'reference'      => $cust_pay_pending->paypendingnum, #for now
5297     'email'          => $email,
5298     %content, #after
5299   );
5300
5301   $cust_pay_pending->status('pending');
5302   my $cpp_pending_err = $cust_pay_pending->replace;
5303   return $cpp_pending_err if $cpp_pending_err;
5304
5305   #config?
5306   my $BOP_TESTING = 0;
5307   my $BOP_TESTING_SUCCESS = 1;
5308
5309   unless ( $BOP_TESTING ) {
5310     $transaction->submit();
5311   } else {
5312     if ( $BOP_TESTING_SUCCESS ) {
5313       $transaction->is_success(1);
5314       $transaction->authorization('fake auth');
5315     } else {
5316       $transaction->is_success(0);
5317       $transaction->error_message('fake failure');
5318     }
5319   }
5320
5321   if ( $transaction->is_success() && $namespace eq 'Business::OnlineThirdPartyPayment' ) {
5322
5323     return { reference => $cust_pay_pending->paypendingnum,
5324              map { $_ => $transaction->$_ } qw ( popup_url collectitems ) };
5325
5326   } elsif ( $transaction->is_success() && $action2 ) {
5327
5328     $cust_pay_pending->status('authorized');
5329     my $cpp_authorized_err = $cust_pay_pending->replace;
5330     return $cpp_authorized_err if $cpp_authorized_err;
5331
5332     my $auth = $transaction->authorization;
5333     my $ordernum = $transaction->can('order_number')
5334                    ? $transaction->order_number
5335                    : '';
5336
5337     my $capture =
5338       new Business::OnlinePayment( $payment_gateway->gateway_module,
5339                                    $self->_bop_options(\%options),
5340                                  );
5341
5342     my %capture = (
5343       %content,
5344       type           => $options{method},
5345       action         => $action2,
5346       $self->_bop_auth(\%options),
5347       order_number   => $ordernum,
5348       amount         => $options{amount},
5349       authorization  => $auth,
5350       description    => $options{'description'},
5351     );
5352
5353     foreach my $field (qw( authorization_source_code returned_ACI
5354                            transaction_identifier validation_code
5355                            transaction_sequence_num local_transaction_date
5356                            local_transaction_time AVS_result_code          )) {
5357       $capture{$field} = $transaction->$field() if $transaction->can($field);
5358     }
5359
5360     $capture->content( %capture );
5361
5362     $capture->submit();
5363
5364     unless ( $capture->is_success ) {
5365       my $e = "Authorization successful but capture failed, custnum #".
5366               $self->custnum. ': '.  $capture->result_code.
5367               ": ". $capture->error_message;
5368       warn $e;
5369       return $e;
5370     }
5371
5372   }
5373
5374   ###
5375   # remove paycvv after initial transaction
5376   ###
5377
5378   #false laziness w/misc/process/payment.cgi - check both to make sure working
5379   # correctly
5380   if ( defined $self->dbdef_table->column('paycvv')
5381        && length($self->paycvv)
5382        && ! grep { $_ eq cardtype($options{payinfo}) } $conf->config('cvv-save')
5383   ) {
5384     my $error = $self->remove_cvv;
5385     if ( $error ) {
5386       warn "WARNING: error removing cvv: $error\n";
5387     }
5388   }
5389
5390   ###
5391   # result handling
5392   ###
5393
5394   $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5395
5396 }
5397
5398 =item fake_bop
5399
5400 =cut
5401
5402 sub fake_bop {
5403   my $self = shift;
5404
5405   my %options = ();
5406   if (ref($_[0]) eq 'HASH') {
5407     %options = %{$_[0]};
5408   } else {
5409     my ( $method, $amount ) = ( shift, shift );
5410     %options = @_;
5411     $options{method} = $method;
5412     $options{amount} = $amount;
5413   }
5414
5415   if ( $options{'fake_failure'} ) {
5416      return "Error: No error; test failure requested with fake_failure";
5417   }
5418
5419   #my $paybatch = '';
5420   #if ( $payment_gateway->gatewaynum ) { # agent override
5421   #  $paybatch = $payment_gateway->gatewaynum. '-';
5422   #}
5423   #
5424   #$paybatch .= "$processor:". $transaction->authorization;
5425   #
5426   #$paybatch .= ':'. $transaction->order_number
5427   #  if $transaction->can('order_number')
5428   #  && length($transaction->order_number);
5429
5430   my $paybatch = 'FakeProcessor:54:32';
5431
5432   my $cust_pay = new FS::cust_pay ( {
5433      'custnum'  => $self->custnum,
5434      'invnum'   => $options{'invnum'},
5435      'paid'     => $options{amount},
5436      '_date'    => '',
5437      'payby'    => $bop_method2payby{$options{method}},
5438      #'payinfo'  => $payinfo,
5439      'payinfo'  => '4111111111111111',
5440      'paybatch' => $paybatch,
5441      #'paydate'  => $paydate,
5442      'paydate'  => '2012-05-01',
5443   } );
5444   $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
5445
5446   my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5447
5448   if ( $error ) {
5449     $cust_pay->invnum(''); #try again with no specific invnum
5450     my $error2 = $cust_pay->insert( $options{'manual'} ?
5451                                     ( 'manual' => 1 ) : ()
5452                                   );
5453     if ( $error2 ) {
5454       # gah, even with transactions.
5455       my $e = 'WARNING: Card/ACH debited but database not updated - '.
5456               "error inserting (fake!) payment: $error2".
5457               " (previously tried insert with invnum #$options{'invnum'}" .
5458               ": $error )";
5459       warn $e;
5460       return $e;
5461     }
5462   }
5463
5464   if ( $options{'paynum_ref'} ) {
5465     ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5466   }
5467
5468   return ''; #no error
5469
5470 }
5471
5472
5473 # item _realtime_bop_result CUST_PAY_PENDING, BOP_OBJECT [ OPTION => VALUE ... ]
5474 #
5475 # Wraps up processing of a realtime credit card, ACH (electronic check) or
5476 # phone bill transaction.
5477
5478 sub _realtime_bop_result {
5479   my( $self, $cust_pay_pending, $transaction, %options ) = @_;
5480   if ( $DEBUG ) {
5481     warn "$me _realtime_bop_result: pending transaction ".
5482       $cust_pay_pending->paypendingnum. "\n";
5483     warn "  $_ => $options{$_}\n" foreach keys %options;
5484   }
5485
5486   my $payment_gateway = $options{payment_gateway}
5487     or return "no payment gateway in arguments to _realtime_bop_result";
5488
5489   $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
5490   my $cpp_captured_err = $cust_pay_pending->replace;
5491   return $cpp_captured_err if $cpp_captured_err;
5492
5493   if ( $transaction->is_success() ) {
5494
5495     my $paybatch = '';
5496     if ( $payment_gateway->gatewaynum ) { # agent override
5497       $paybatch = $payment_gateway->gatewaynum. '-';
5498     }
5499
5500     $paybatch .= $payment_gateway->gateway_module. ":".
5501       $transaction->authorization;
5502
5503     $paybatch .= ':'. $transaction->order_number
5504       if $transaction->can('order_number')
5505       && length($transaction->order_number);
5506
5507     my $cust_pay = new FS::cust_pay ( {
5508        'custnum'  => $self->custnum,
5509        'invnum'   => $options{'invnum'},
5510        'paid'     => $cust_pay_pending->paid,
5511        '_date'    => '',
5512        'payby'    => $cust_pay_pending->payby,
5513        #'payinfo'  => $payinfo,
5514        'paybatch' => $paybatch,
5515        'paydate'  => $cust_pay_pending->paydate,
5516        'pkgnum'   => $cust_pay_pending->pkgnum,
5517     } );
5518     #doesn't hurt to know, even though the dup check is in cust_pay_pending now
5519     $cust_pay->payunique( $options{payunique} )
5520       if defined($options{payunique}) && length($options{payunique});
5521
5522     my $oldAutoCommit = $FS::UID::AutoCommit;
5523     local $FS::UID::AutoCommit = 0;
5524     my $dbh = dbh;
5525
5526     #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
5527
5528     my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
5529
5530     if ( $error ) {
5531       $cust_pay->invnum(''); #try again with no specific invnum
5532       my $error2 = $cust_pay->insert( $options{'manual'} ?
5533                                       ( 'manual' => 1 ) : ()
5534                                     );
5535       if ( $error2 ) {
5536         # gah.  but at least we have a record of the state we had to abort in
5537         # from cust_pay_pending now.
5538         my $e = "WARNING: $options{method} captured but payment not recorded -".
5539                 " error inserting payment (". $payment_gateway->gateway_module.
5540                 "): $error2".
5541                 " (previously tried insert with invnum #$options{'invnum'}" .
5542                 ": $error ) - pending payment saved as paypendingnum ".
5543                 $cust_pay_pending->paypendingnum. "\n";
5544         warn $e;
5545         return $e;
5546       }
5547     }
5548
5549     my $jobnum = $cust_pay_pending->jobnum;
5550     if ( $jobnum ) {
5551        my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5552
5553        unless ( $placeholder ) {
5554          $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5555          my $e = "WARNING: $options{method} captured but job $jobnum not ".
5556              "found for paypendingnum ". $cust_pay_pending->paypendingnum. "\n";
5557          warn $e;
5558          return $e;
5559        }
5560
5561        $error = $placeholder->delete;
5562
5563        if ( $error ) {
5564          $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5565          my $e = "WARNING: $options{method} captured but could not delete ".
5566               "job $jobnum for paypendingnum ".
5567               $cust_pay_pending->paypendingnum. ": $error\n";
5568          warn $e;
5569          return $e;
5570        }
5571
5572     }
5573
5574     if ( $options{'paynum_ref'} ) {
5575       ${ $options{'paynum_ref'} } = $cust_pay->paynum;
5576     }
5577
5578     $cust_pay_pending->status('done');
5579     $cust_pay_pending->statustext('captured');
5580     $cust_pay_pending->paynum($cust_pay->paynum);
5581     my $cpp_done_err = $cust_pay_pending->replace;
5582
5583     if ( $cpp_done_err ) {
5584
5585       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
5586       my $e = "WARNING: $options{method} captured but payment not recorded - ".
5587               "error updating status for paypendingnum ".
5588               $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5589       warn $e;
5590       return $e;
5591
5592     } else {
5593
5594       $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5595
5596       if ( $options{'apply'} ) {
5597         my $apply_error = $self->apply_payments_and_credits;
5598         if ( $apply_error ) {
5599           warn "WARNING: error applying payment: $apply_error\n";
5600           #but we still should return no error cause the payment otherwise went
5601           #through...
5602         }
5603       }
5604
5605       return ''; #no error
5606
5607     }
5608
5609   } else {
5610
5611     my $perror = $payment_gateway->gateway_module. " error: ".
5612       $transaction->error_message;
5613
5614     my $jobnum = $cust_pay_pending->jobnum;
5615     if ( $jobnum ) {
5616        my $placeholder = qsearchs( 'queue', { 'jobnum' => $jobnum } );
5617
5618        if ( $placeholder ) {
5619          my $error = $placeholder->depended_delete;
5620          $error ||= $placeholder->delete;
5621          warn "error removing provisioning jobs after declined paypendingnum ".
5622            $cust_pay_pending->paypendingnum. "\n";
5623        } else {
5624          my $e = "error finding job $jobnum for declined paypendingnum ".
5625               $cust_pay_pending->paypendingnum. "\n";
5626          warn $e;
5627        }
5628
5629     }
5630
5631     unless ( $transaction->error_message ) {
5632
5633       my $t_response;
5634       if ( $transaction->can('response_page') ) {
5635         $t_response = {
5636                         'page'    => ( $transaction->can('response_page')
5637                                          ? $transaction->response_page
5638                                          : ''
5639                                      ),
5640                         'code'    => ( $transaction->can('response_code')
5641                                          ? $transaction->response_code
5642                                          : ''
5643                                      ),
5644                         'headers' => ( $transaction->can('response_headers')
5645                                          ? $transaction->response_headers
5646                                          : ''
5647                                      ),
5648                       };
5649       } else {
5650         $t_response .=
5651           "No additional debugging information available for ".
5652             $payment_gateway->gateway_module;
5653       }
5654
5655       $perror .= "No error_message returned from ".
5656                    $payment_gateway->gateway_module. " -- ".
5657                  ( ref($t_response) ? Dumper($t_response) : $t_response );
5658
5659     }
5660
5661     if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
5662          && $conf->exists('emaildecline')
5663          && grep { $_ ne 'POST' } $self->invoicing_list
5664          && ! grep { $transaction->error_message =~ /$_/ }
5665                    $conf->config('emaildecline-exclude')
5666     ) {
5667       my @templ = $conf->config('declinetemplate');
5668       my $template = new Text::Template (
5669         TYPE   => 'ARRAY',
5670         SOURCE => [ map "$_\n", @templ ],
5671       ) or return "($perror) can't create template: $Text::Template::ERROR";
5672       $template->compile()
5673         or return "($perror) can't compile template: $Text::Template::ERROR";
5674
5675       my $templ_hash = {
5676         'company_name'    =>
5677           scalar( $conf->config('company_name', $self->agentnum ) ),
5678         'company_address' =>
5679           join("\n", $conf->config('company_address', $self->agentnum ) ),
5680         'error'           => $transaction->error_message,
5681       };
5682
5683       my $error = send_email(
5684         'from'    => $conf->config('invoice_from', $self->agentnum ),
5685         'to'      => [ grep { $_ ne 'POST' } $self->invoicing_list ],
5686         'subject' => 'Your payment could not be processed',
5687         'body'    => [ $template->fill_in(HASH => $templ_hash) ],
5688       );
5689
5690       $perror .= " (also received error sending decline notification: $error)"
5691         if $error;
5692
5693     }
5694
5695     $cust_pay_pending->status('done');
5696     $cust_pay_pending->statustext("declined: $perror");
5697     my $cpp_done_err = $cust_pay_pending->replace;
5698     if ( $cpp_done_err ) {
5699       my $e = "WARNING: $options{method} declined but pending payment not ".
5700               "resolved - error updating status for paypendingnum ".
5701               $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
5702       warn $e;
5703       $perror = "$e ($perror)";
5704     }
5705
5706     return $perror;
5707   }
5708
5709 }
5710
5711 =item realtime_botpp_capture CUST_PAY_PENDING [ OPTION => VALUE ... ]
5712
5713 Verifies successful third party processing of a realtime credit card,
5714 ACH (electronic check) or phone bill transaction via a
5715 Business::OnlineThirdPartyPayment realtime gateway.  See
5716 L<http://420.am/business-onlinethirdpartypayment> for supported gateways.
5717
5718 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
5719
5720 The additional options I<payname>, I<city>, I<state>,
5721 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
5722 if set, will override the value from the customer record.
5723
5724 I<description> is a free-text field passed to the gateway.  It defaults to
5725 "Internet services".
5726
5727 If an I<invnum> is specified, this payment (if successful) is applied to the
5728 specified invoice.  If you don't specify an I<invnum> you might want to
5729 call the B<apply_payments> method.
5730
5731 I<quiet> can be set true to surpress email decline notices.
5732
5733 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
5734 resulting paynum, if any.
5735
5736 I<payunique> is a unique identifier for this payment.
5737
5738 Returns a hashref containing elements bill_error (which will be undefined
5739 upon success) and session_id of any associated session.
5740
5741 =cut
5742
5743 sub realtime_botpp_capture {
5744   my( $self, $cust_pay_pending, %options ) = @_;
5745   if ( $DEBUG ) {
5746     warn "$me realtime_botpp_capture: pending transaction $cust_pay_pending\n";
5747     warn "  $_ => $options{$_}\n" foreach keys %options;
5748   }
5749
5750   eval "use Business::OnlineThirdPartyPayment";
5751   die $@ if $@;
5752
5753   ###
5754   # select the gateway
5755   ###
5756
5757   my $method = FS::payby->payby2bop($cust_pay_pending->payby);
5758
5759   my $payment_gateway = $cust_pay_pending->gatewaynum
5760     ? qsearchs( 'payment_gateway',
5761                 { gatewaynum => $cust_pay_pending->gatewaynum }
5762               )
5763     : $self->agent->payment_gateway( 'method' => $method,
5764                                      # 'invnum'  => $cust_pay_pending->invnum,
5765                                      # 'payinfo' => $cust_pay_pending->payinfo,
5766                                    );
5767
5768   $options{payment_gateway} = $payment_gateway; # for the helper subs
5769
5770   ###
5771   # massage data
5772   ###
5773
5774   my @invoicing_list = $self->invoicing_list_emailonly;
5775   if ( $conf->exists('emailinvoiceautoalways')
5776        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
5777        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
5778     push @invoicing_list, $self->all_emails;
5779   }
5780
5781   my $email = ($conf->exists('business-onlinepayment-email-override'))
5782               ? $conf->config('business-onlinepayment-email-override')
5783               : $invoicing_list[0];
5784
5785   my %content = ();
5786
5787   $content{email_customer} =
5788     (    $conf->exists('business-onlinepayment-email_customer')
5789       || $conf->exists('business-onlinepayment-email-override') );
5790
5791   ###
5792   # run transaction(s)
5793   ###
5794
5795   my $transaction =
5796     new Business::OnlineThirdPartyPayment( $payment_gateway->gateway_module,
5797                                            $self->_bop_options(\%options),
5798                                          );
5799
5800   $transaction->reference({ %options });
5801
5802   $transaction->content(
5803     'type'           => $method,
5804     $self->_bop_auth(\%options),
5805     'action'         => 'Post Authorization',
5806     'description'    => $options{'description'},
5807     'amount'         => $cust_pay_pending->paid,
5808     #'invoice_number' => $options{'invnum'},
5809     'customer_id'    => $self->custnum,
5810     'referer'        => 'http://cleanwhisker.420.am/',
5811     'reference'      => $cust_pay_pending->paypendingnum,
5812     'email'          => $email,
5813     'phone'          => $self->daytime || $self->night,
5814     %content, #after
5815     # plus whatever is required for bogus capture avoidance
5816   );
5817
5818   $transaction->submit();
5819
5820   my $error =
5821     $self->_realtime_bop_result( $cust_pay_pending, $transaction, %options );
5822
5823   {
5824     bill_error => $error,
5825     session_id => $cust_pay_pending->session_id,
5826   }
5827
5828 }
5829
5830 =item default_payment_gateway DEPRECATED -- use agent->payment_gateway
5831
5832 =cut
5833
5834 sub default_payment_gateway {
5835   my( $self, $method ) = @_;
5836
5837   die "Real-time processing not enabled\n"
5838     unless $conf->exists('business-onlinepayment');
5839
5840   #warn "default_payment_gateway deprecated -- use agent->payment_gateway\n";
5841
5842   #load up config
5843   my $bop_config = 'business-onlinepayment';
5844   $bop_config .= '-ach'
5845     if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
5846   my ( $processor, $login, $password, $action, @bop_options ) =
5847     $conf->config($bop_config);
5848   $action ||= 'normal authorization';
5849   pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
5850   die "No real-time processor is enabled - ".
5851       "did you set the business-onlinepayment configuration value?\n"
5852     unless $processor;
5853
5854   ( $processor, $login, $password, $action, @bop_options )
5855 }
5856
5857 =item remove_cvv
5858
5859 Removes the I<paycvv> field from the database directly.
5860
5861 If there is an error, returns the error, otherwise returns false.
5862
5863 =cut
5864
5865 sub remove_cvv {
5866   my $self = shift;
5867   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
5868     or return dbh->errstr;
5869   $sth->execute($self->custnum)
5870     or return $sth->errstr;
5871   $self->paycvv('');
5872   '';
5873 }
5874
5875 =item _new_realtime_refund_bop METHOD [ OPTION => VALUE ... ]
5876
5877 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
5878 via a Business::OnlinePayment realtime gateway.  See
5879 L<http://420.am/business-onlinepayment> for supported gateways.
5880
5881 Available methods are: I<CC>, I<ECHECK> and I<LEC>
5882
5883 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
5884
5885 Most gateways require a reference to an original payment transaction to refund,
5886 so you probably need to specify a I<paynum>.
5887
5888 I<amount> defaults to the original amount of the payment if not specified.
5889
5890 I<reason> specifies a reason for the refund.
5891
5892 I<paydate> specifies the expiration date for a credit card overriding the
5893 value from the customer record or the payment record. Specified as yyyy-mm-dd
5894
5895 Implementation note: If I<amount> is unspecified or equal to the amount of the
5896 orignal payment, first an attempt is made to "void" the transaction via
5897 the gateway (to cancel a not-yet settled transaction) and then if that fails,
5898 the normal attempt is made to "refund" ("credit") the transaction via the
5899 gateway is attempted.
5900
5901 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
5902 #I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
5903 #if set, will override the value from the customer record.
5904
5905 #If an I<invnum> is specified, this payment (if successful) is applied to the
5906 #specified invoice.  If you don't specify an I<invnum> you might want to
5907 #call the B<apply_payments> method.
5908
5909 =cut
5910
5911 #some false laziness w/realtime_bop, not enough to make it worth merging
5912 #but some useful small subs should be pulled out
5913 sub _new_realtime_refund_bop {
5914   my $self = shift;
5915
5916   my %options = ();
5917   if (ref($_[0]) ne 'HASH') {
5918     %options = %{$_[0]};
5919   } else {
5920     my $method = shift;
5921     %options = @_;
5922     $options{method} = $method;
5923   }
5924
5925   if ( $DEBUG ) {
5926     warn "$me realtime_refund_bop (new): $options{method} refund\n";
5927     warn "  $_ => $options{$_}\n" foreach keys %options;
5928   }
5929
5930   ###
5931   # look up the original payment and optionally a gateway for that payment
5932   ###
5933
5934   my $cust_pay = '';
5935   my $amount = $options{'amount'};
5936
5937   my( $processor, $login, $password, @bop_options, $namespace ) ;
5938   my( $auth, $order_number ) = ( '', '', '' );
5939
5940   if ( $options{'paynum'} ) {
5941
5942     warn "  paynum: $options{paynum}\n" if $DEBUG > 1;
5943     $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
5944       or return "Unknown paynum $options{'paynum'}";
5945     $amount ||= $cust_pay->paid;
5946
5947     $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
5948       or return "Can't parse paybatch for paynum $options{'paynum'}: ".
5949                 $cust_pay->paybatch;
5950     my $gatewaynum = '';
5951     ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
5952
5953     if ( $gatewaynum ) { #gateway for the payment to be refunded
5954
5955       my $payment_gateway =
5956         qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
5957       die "payment gateway $gatewaynum not found"
5958         unless $payment_gateway;
5959
5960       $processor   = $payment_gateway->gateway_module;
5961       $login       = $payment_gateway->gateway_username;
5962       $password    = $payment_gateway->gateway_password;
5963       $namespace   = $payment_gateway->gateway_namespace;
5964       @bop_options = $payment_gateway->options;
5965
5966     } else { #try the default gateway
5967
5968       my $conf_processor;
5969       my $payment_gateway =
5970         $self->agent->payment_gateway('method' => $options{method});
5971
5972       ( $conf_processor, $login, $password, $namespace ) =
5973         map { my $method = "gateway_$_"; $payment_gateway->$method }
5974           qw( module username password namespace );
5975
5976       @bop_options = $payment_gateway->gatewaynum
5977                        ? $payment_gateway->options
5978                        : @{ $payment_gateway->get('options') };
5979
5980       return "processor of payment $options{'paynum'} $processor does not".
5981              " match default processor $conf_processor"
5982         unless $processor eq $conf_processor;
5983
5984     }
5985
5986
5987   } else { # didn't specify a paynum, so look for agent gateway overrides
5988            # like a normal transaction
5989
5990     my $payment_gateway =
5991       $self->agent->payment_gateway( 'method'  => $options{method},
5992                                      #'payinfo' => $payinfo,
5993                                    );
5994     my( $processor, $login, $password, $namespace ) =
5995       map { my $method = "gateway_$_"; $payment_gateway->$method }
5996         qw( module username password namespace );
5997
5998     my @bop_options = $payment_gateway->gatewaynum
5999                         ? $payment_gateway->options
6000                         : @{ $payment_gateway->get('options') };
6001
6002   }
6003   return "neither amount nor paynum specified" unless $amount;
6004
6005   eval "use $namespace";
6006   die $@ if $@;
6007
6008   my %content = (
6009     'type'           => $options{method},
6010     'login'          => $login,
6011     'password'       => $password,
6012     'order_number'   => $order_number,
6013     'amount'         => $amount,
6014     'referer'        => 'http://cleanwhisker.420.am/', #XXX fix referer :/
6015   );
6016   $content{authorization} = $auth
6017     if length($auth); #echeck/ACH transactions have an order # but no auth
6018                       #(at least with authorize.net)
6019
6020   my $disable_void_after;
6021   if ($conf->exists('disable_void_after')
6022       && $conf->config('disable_void_after') =~ /^(\d+)$/) {
6023     $disable_void_after = $1;
6024   }
6025
6026   #first try void if applicable
6027   if ( $cust_pay && $cust_pay->paid == $amount
6028     && (
6029       ( not defined($disable_void_after) )
6030       || ( time < ($cust_pay->_date + $disable_void_after ) )
6031     )
6032   ) {
6033     warn "  attempting void\n" if $DEBUG > 1;
6034     my $void = new Business::OnlinePayment( $processor, @bop_options );
6035     $void->content( 'action' => 'void', %content );
6036     $void->submit();
6037     if ( $void->is_success ) {
6038       my $error = $cust_pay->void($options{'reason'});
6039       if ( $error ) {
6040         # gah, even with transactions.
6041         my $e = 'WARNING: Card/ACH voided but database not updated - '.
6042                 "error voiding payment: $error";
6043         warn $e;
6044         return $e;
6045       }
6046       warn "  void successful\n" if $DEBUG > 1;
6047       return '';
6048     }
6049   }
6050
6051   warn "  void unsuccessful, trying refund\n"
6052     if $DEBUG > 1;
6053
6054   #massage data
6055   my $address = $self->address1;
6056   $address .= ", ". $self->address2 if $self->address2;
6057
6058   my($payname, $payfirst, $paylast);
6059   if ( $self->payname && $options{method} ne 'ECHECK' ) {
6060     $payname = $self->payname;
6061     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
6062       or return "Illegal payname $payname";
6063     ($payfirst, $paylast) = ($1, $2);
6064   } else {
6065     $payfirst = $self->getfield('first');
6066     $paylast = $self->getfield('last');
6067     $payname =  "$payfirst $paylast";
6068   }
6069
6070   my @invoicing_list = $self->invoicing_list_emailonly;
6071   if ( $conf->exists('emailinvoiceautoalways')
6072        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
6073        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
6074     push @invoicing_list, $self->all_emails;
6075   }
6076
6077   my $email = ($conf->exists('business-onlinepayment-email-override'))
6078               ? $conf->config('business-onlinepayment-email-override')
6079               : $invoicing_list[0];
6080
6081   my $payip = exists($options{'payip'})
6082                 ? $options{'payip'}
6083                 : $self->payip;
6084   $content{customer_ip} = $payip
6085     if length($payip);
6086
6087   my $payinfo = '';
6088   if ( $options{method} eq 'CC' ) {
6089
6090     if ( $cust_pay ) {
6091       $content{card_number} = $payinfo = $cust_pay->payinfo;
6092       (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
6093         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
6094         ($content{expiration} = "$2/$1");  # where available
6095     } else {
6096       $content{card_number} = $payinfo = $self->payinfo;
6097       (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
6098         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
6099       $content{expiration} = "$2/$1";
6100     }
6101
6102   } elsif ( $options{method} eq 'ECHECK' ) {
6103
6104     if ( $cust_pay ) {
6105       $payinfo = $cust_pay->payinfo;
6106     } else {
6107       $payinfo = $self->payinfo;
6108     }
6109     ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
6110     $content{bank_name} = $self->payname;
6111     $content{account_type} = 'CHECKING';
6112     $content{account_name} = $payname;
6113     $content{customer_org} = $self->company ? 'B' : 'I';
6114     $content{customer_ssn} = $self->ss;
6115   } elsif ( $options{method} eq 'LEC' ) {
6116     $content{phone} = $payinfo = $self->payinfo;
6117   }
6118
6119   #then try refund
6120   my $refund = new Business::OnlinePayment( $processor, @bop_options );
6121   my %sub_content = $refund->content(
6122     'action'         => 'credit',
6123     'customer_id'    => $self->custnum,
6124     'last_name'      => $paylast,
6125     'first_name'     => $payfirst,
6126     'name'           => $payname,
6127     'address'        => $address,
6128     'city'           => $self->city,
6129     'state'          => $self->state,
6130     'zip'            => $self->zip,
6131     'country'        => $self->country,
6132     'email'          => $email,
6133     'phone'          => $self->daytime || $self->night,
6134     %content, #after
6135   );
6136   warn join('', map { "  $_ => $sub_content{$_}\n" } keys %sub_content )
6137     if $DEBUG > 1;
6138   $refund->submit();
6139
6140   return "$processor error: ". $refund->error_message
6141     unless $refund->is_success();
6142
6143   my $paybatch = "$processor:". $refund->authorization;
6144   $paybatch .= ':'. $refund->order_number
6145     if $refund->can('order_number') && $refund->order_number;
6146
6147   while ( $cust_pay && $cust_pay->unapplied < $amount ) {
6148     my @cust_bill_pay = $cust_pay->cust_bill_pay;
6149     last unless @cust_bill_pay;
6150     my $cust_bill_pay = pop @cust_bill_pay;
6151     my $error = $cust_bill_pay->delete;
6152     last if $error;
6153   }
6154
6155   my $cust_refund = new FS::cust_refund ( {
6156     'custnum'  => $self->custnum,
6157     'paynum'   => $options{'paynum'},
6158     'refund'   => $amount,
6159     '_date'    => '',
6160     'payby'    => $bop_method2payby{$options{method}},
6161     'payinfo'  => $payinfo,
6162     'paybatch' => $paybatch,
6163     'reason'   => $options{'reason'} || 'card or ACH refund',
6164   } );
6165   my $error = $cust_refund->insert;
6166   if ( $error ) {
6167     $cust_refund->paynum(''); #try again with no specific paynum
6168     my $error2 = $cust_refund->insert;
6169     if ( $error2 ) {
6170       # gah, even with transactions.
6171       my $e = 'WARNING: Card/ACH refunded but database not updated - '.
6172               "error inserting refund ($processor): $error2".
6173               " (previously tried insert with paynum #$options{'paynum'}" .
6174               ": $error )";
6175       warn $e;
6176       return $e;
6177     }
6178   }
6179
6180   ''; #no error
6181
6182 }
6183
6184 =item batch_card OPTION => VALUE...
6185
6186 Adds a payment for this invoice to the pending credit card batch (see
6187 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
6188 runs the payment using a realtime gateway.
6189
6190 =cut
6191
6192 sub batch_card {
6193   my ($self, %options) = @_;
6194
6195   my $amount;
6196   if (exists($options{amount})) {
6197     $amount = $options{amount};
6198   }else{
6199     $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
6200   }
6201   return '' unless $amount > 0;
6202
6203   my $invnum = delete $options{invnum};
6204   my $payby = $options{invnum} || $self->payby;  #dubious
6205
6206   if ($options{'realtime'}) {
6207     return $self->realtime_bop( FS::payby->payby2bop($self->payby),
6208                                 $amount,
6209                                 %options,
6210                               );
6211   }
6212
6213   my $oldAutoCommit = $FS::UID::AutoCommit;
6214   local $FS::UID::AutoCommit = 0;
6215   my $dbh = dbh;
6216
6217   #this needs to handle mysql as well as Pg, like svc_acct.pm
6218   #(make it into a common function if folks need to do batching with mysql)
6219   $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
6220     or return "Cannot lock pay_batch: " . $dbh->errstr;
6221
6222   my %pay_batch = (
6223     'status' => 'O',
6224     'payby'  => FS::payby->payby2payment($payby),
6225   );
6226
6227   my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
6228
6229   unless ( $pay_batch ) {
6230     $pay_batch = new FS::pay_batch \%pay_batch;
6231     my $error = $pay_batch->insert;
6232     if ( $error ) {
6233       $dbh->rollback if $oldAutoCommit;
6234       die "error creating new batch: $error\n";
6235     }
6236   }
6237
6238   my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
6239       'batchnum' => $pay_batch->batchnum,
6240       'custnum'  => $self->custnum,
6241   } );
6242
6243   foreach (qw( address1 address2 city state zip country payby payinfo paydate
6244                payname )) {
6245     $options{$_} = '' unless exists($options{$_});
6246   }
6247
6248   my $cust_pay_batch = new FS::cust_pay_batch ( {
6249     'batchnum' => $pay_batch->batchnum,
6250     'invnum'   => $invnum || 0,                    # is there a better value?
6251                                                    # this field should be
6252                                                    # removed...
6253                                                    # cust_bill_pay_batch now
6254     'custnum'  => $self->custnum,
6255     'last'     => $self->getfield('last'),
6256     'first'    => $self->getfield('first'),
6257     'address1' => $options{address1} || $self->address1,
6258     'address2' => $options{address2} || $self->address2,
6259     'city'     => $options{city}     || $self->city,
6260     'state'    => $options{state}    || $self->state,
6261     'zip'      => $options{zip}      || $self->zip,
6262     'country'  => $options{country}  || $self->country,
6263     'payby'    => $options{payby}    || $self->payby,
6264     'payinfo'  => $options{payinfo}  || $self->payinfo,
6265     'exp'      => $options{paydate}  || $self->paydate,
6266     'payname'  => $options{payname}  || $self->payname,
6267     'amount'   => $amount,                         # consolidating
6268   } );
6269
6270   $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
6271     if $old_cust_pay_batch;
6272
6273   my $error;
6274   if ($old_cust_pay_batch) {
6275     $error = $cust_pay_batch->replace($old_cust_pay_batch)
6276   } else {
6277     $error = $cust_pay_batch->insert;
6278   }
6279
6280   if ( $error ) {
6281     $dbh->rollback if $oldAutoCommit;
6282     die $error;
6283   }
6284
6285   my $unapplied =   $self->total_unapplied_credits
6286                   + $self->total_unapplied_payments
6287                   + $self->in_transit_payments;
6288   foreach my $cust_bill ($self->open_cust_bill) {
6289     #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
6290     my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
6291       'invnum' => $cust_bill->invnum,
6292       'paybatchnum' => $cust_pay_batch->paybatchnum,
6293       'amount' => $cust_bill->owed,
6294       '_date' => time,
6295     };
6296     if ($unapplied >= $cust_bill_pay_batch->amount){
6297       $unapplied -= $cust_bill_pay_batch->amount;
6298       next;
6299     }else{
6300       $cust_bill_pay_batch->amount(sprintf ( "%.2f",
6301                                    $cust_bill_pay_batch->amount - $unapplied ));      $unapplied = 0;
6302     }
6303     $error = $cust_bill_pay_batch->insert;
6304     if ( $error ) {
6305       $dbh->rollback if $oldAutoCommit;
6306       die $error;
6307     }
6308   }
6309
6310   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6311   '';
6312 }
6313
6314 =item apply_payments_and_credits [ OPTION => VALUE ... ]
6315
6316 Applies unapplied payments and credits.
6317
6318 In most cases, this new method should be used in place of sequential
6319 apply_payments and apply_credits methods.
6320
6321 A hash of optional arguments may be passed.  Currently "manual" is supported.
6322 If true, a payment receipt is sent instead of a statement when
6323 'payment_receipt_email' configuration option is set.
6324
6325 If there is an error, returns the error, otherwise returns false.
6326
6327 =cut
6328
6329 sub apply_payments_and_credits {
6330   my( $self, %options ) = @_;
6331
6332   local $SIG{HUP} = 'IGNORE';
6333   local $SIG{INT} = 'IGNORE';
6334   local $SIG{QUIT} = 'IGNORE';
6335   local $SIG{TERM} = 'IGNORE';
6336   local $SIG{TSTP} = 'IGNORE';
6337   local $SIG{PIPE} = 'IGNORE';
6338
6339   my $oldAutoCommit = $FS::UID::AutoCommit;
6340   local $FS::UID::AutoCommit = 0;
6341   my $dbh = dbh;
6342
6343   $self->select_for_update; #mutex
6344
6345   foreach my $cust_bill ( $self->open_cust_bill ) {
6346     my $error = $cust_bill->apply_payments_and_credits(%options);
6347     if ( $error ) {
6348       $dbh->rollback if $oldAutoCommit;
6349       return "Error applying: $error";
6350     }
6351   }
6352
6353   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6354   ''; #no error
6355
6356 }
6357
6358 =item apply_credits OPTION => VALUE ...
6359
6360 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
6361 to outstanding invoice balances in chronological order (or reverse
6362 chronological order if the I<order> option is set to B<newest>) and returns the
6363 value of any remaining unapplied credits available for refund (see
6364 L<FS::cust_refund>).
6365
6366 Dies if there is an error.
6367
6368 =cut
6369
6370 sub apply_credits {
6371   my $self = shift;
6372   my %opt = @_;
6373
6374   local $SIG{HUP} = 'IGNORE';
6375   local $SIG{INT} = 'IGNORE';
6376   local $SIG{QUIT} = 'IGNORE';
6377   local $SIG{TERM} = 'IGNORE';
6378   local $SIG{TSTP} = 'IGNORE';
6379   local $SIG{PIPE} = 'IGNORE';
6380
6381   my $oldAutoCommit = $FS::UID::AutoCommit;
6382   local $FS::UID::AutoCommit = 0;
6383   my $dbh = dbh;
6384
6385   $self->select_for_update; #mutex
6386
6387   unless ( $self->total_unapplied_credits ) {
6388     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6389     return 0;
6390   }
6391
6392   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
6393       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
6394
6395   my @invoices = $self->open_cust_bill;
6396   @invoices = sort { $b->_date <=> $a->_date } @invoices
6397     if defined($opt{'order'}) && $opt{'order'} eq 'newest';
6398
6399   if ( $conf->exists('pkg-balances') ) {
6400     # limit @credits to those w/ a pkgnum grepped from $self
6401     my %pkgnums = ();
6402     foreach my $i (@invoices) {
6403       foreach my $li ( $i->cust_bill_pkg ) {
6404         $pkgnums{$li->pkgnum} = 1;
6405       }
6406     }
6407     @credits = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @credits;
6408   }
6409
6410   my $credit;
6411
6412   foreach my $cust_bill ( @invoices ) {
6413
6414     if ( !defined($credit) || $credit->credited == 0) {
6415       $credit = pop @credits or last;
6416     }
6417
6418     my $owed;
6419     if ( $conf->exists('pkg-balances') && $credit->pkgnum ) {
6420       $owed = $cust_bill->owed_pkgnum($credit->pkgnum);
6421     } else {
6422       $owed = $cust_bill->owed;
6423     }
6424     unless ( $owed > 0 ) {
6425       push @credits, $credit;
6426       next;
6427     }
6428
6429     my $amount = min( $credit->credited, $owed );
6430
6431     my $cust_credit_bill = new FS::cust_credit_bill ( {
6432       'crednum' => $credit->crednum,
6433       'invnum'  => $cust_bill->invnum,
6434       'amount'  => $amount,
6435     } );
6436     $cust_credit_bill->pkgnum( $credit->pkgnum )
6437       if $conf->exists('pkg-balances') && $credit->pkgnum;
6438     my $error = $cust_credit_bill->insert;
6439     if ( $error ) {
6440       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6441       die $error;
6442     }
6443
6444     redo if ($cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6445
6446   }
6447
6448   my $total_unapplied_credits = $self->total_unapplied_credits;
6449
6450   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6451
6452   return $total_unapplied_credits;
6453 }
6454
6455 =item apply_payments  [ OPTION => VALUE ... ]
6456
6457 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
6458 to outstanding invoice balances in chronological order.
6459
6460  #and returns the value of any remaining unapplied payments.
6461
6462 A hash of optional arguments may be passed.  Currently "manual" is supported.
6463 If true, a payment receipt is sent instead of a statement when
6464 'payment_receipt_email' configuration option is set.
6465
6466 Dies if there is an error.
6467
6468 =cut
6469
6470 sub apply_payments {
6471   my( $self, %options ) = @_;
6472
6473   local $SIG{HUP} = 'IGNORE';
6474   local $SIG{INT} = 'IGNORE';
6475   local $SIG{QUIT} = 'IGNORE';
6476   local $SIG{TERM} = 'IGNORE';
6477   local $SIG{TSTP} = 'IGNORE';
6478   local $SIG{PIPE} = 'IGNORE';
6479
6480   my $oldAutoCommit = $FS::UID::AutoCommit;
6481   local $FS::UID::AutoCommit = 0;
6482   my $dbh = dbh;
6483
6484   $self->select_for_update; #mutex
6485
6486   #return 0 unless
6487
6488   my @payments = sort { $b->_date <=> $a->_date }
6489                  grep { $_->unapplied > 0 }
6490                  $self->cust_pay;
6491
6492   my @invoices = sort { $a->_date <=> $b->_date}
6493                  grep { $_->owed > 0 }
6494                  $self->cust_bill;
6495
6496   if ( $conf->exists('pkg-balances') ) {
6497     # limit @payments to those w/ a pkgnum grepped from $self
6498     my %pkgnums = ();
6499     foreach my $i (@invoices) {
6500       foreach my $li ( $i->cust_bill_pkg ) {
6501         $pkgnums{$li->pkgnum} = 1;
6502       }
6503     }
6504     @payments = grep { ! $_->pkgnum || $pkgnums{$_->pkgnum} } @payments;
6505   }
6506
6507   my $payment;
6508
6509   foreach my $cust_bill ( @invoices ) {
6510
6511     if ( !defined($payment) || $payment->unapplied == 0 ) {
6512       $payment = pop @payments or last;
6513     }
6514
6515     my $owed;
6516     if ( $conf->exists('pkg-balances') && $payment->pkgnum ) {
6517       $owed = $cust_bill->owed_pkgnum($payment->pkgnum);
6518     } else {
6519       $owed = $cust_bill->owed;
6520     }
6521     unless ( $owed > 0 ) {
6522       push @payments, $payment;
6523       next;
6524     }
6525
6526     my $amount = min( $payment->unapplied, $owed );
6527
6528     my $cust_bill_pay = new FS::cust_bill_pay ( {
6529       'paynum' => $payment->paynum,
6530       'invnum' => $cust_bill->invnum,
6531       'amount' => $amount,
6532     } );
6533     $cust_bill_pay->pkgnum( $payment->pkgnum )
6534       if $conf->exists('pkg-balances') && $payment->pkgnum;
6535     my $error = $cust_bill_pay->insert(%options);
6536     if ( $error ) {
6537       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
6538       die $error;
6539     }
6540
6541     redo if ( $cust_bill->owed > 0) && ! $conf->exists('pkg-balances');
6542
6543   }
6544
6545   my $total_unapplied_payments = $self->total_unapplied_payments;
6546
6547   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
6548
6549   return $total_unapplied_payments;
6550 }
6551
6552 =item total_owed
6553
6554 Returns the total owed for this customer on all invoices
6555 (see L<FS::cust_bill/owed>).
6556
6557 =cut
6558
6559 sub total_owed {
6560   my $self = shift;
6561   $self->total_owed_date(2145859200); #12/31/2037
6562 }
6563
6564 =item total_owed_date TIME
6565
6566 Returns the total owed for this customer on all invoices with date earlier than
6567 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
6568 see L<Time::Local> and L<Date::Parse> for conversion functions.
6569
6570 =cut
6571
6572 sub total_owed_date {
6573   my $self = shift;
6574   my $time = shift;
6575
6576 #  my $custnum = $self->custnum;
6577 #
6578 #  my $owed_sql = FS::cust_bill->owed_sql;
6579 #
6580 #  my $sql = "
6581 #    SELECT SUM($owed_sql) FROM cust_bill
6582 #      WHERE custnum = $custnum
6583 #        AND _date <= $time
6584 #  ";
6585 #
6586 #  my $sth = dbh->prepare($sql) or die dbh->errstr;
6587 #  $sth->execute() or die $sth->errstr;
6588 #
6589 #  return sprintf( '%.2f', $sth->fetchrow_arrayref->[0] );
6590
6591   my $total_bill = 0;
6592   foreach my $cust_bill (
6593     grep { $_->_date <= $time }
6594       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6595   ) {
6596     $total_bill += $cust_bill->owed;
6597   }
6598   sprintf( "%.2f", $total_bill );
6599
6600 }
6601
6602 =item total_owed_pkgnum PKGNUM
6603
6604 Returns the total owed on all invoices for this customer's specific package
6605 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
6606
6607 =cut
6608
6609 sub total_owed_pkgnum {
6610   my( $self, $pkgnum ) = @_;
6611   $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
6612 }
6613
6614 =item total_owed_date_pkgnum TIME PKGNUM
6615
6616 Returns the total owed for this customer's specific package when using
6617 experimental package balances on all invoices with date earlier than
6618 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
6619 see L<Time::Local> and L<Date::Parse> for conversion functions.
6620
6621 =cut
6622
6623 sub total_owed_date_pkgnum {
6624   my( $self, $time, $pkgnum ) = @_;
6625
6626   my $total_bill = 0;
6627   foreach my $cust_bill (
6628     grep { $_->_date <= $time }
6629       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
6630   ) {
6631     $total_bill += $cust_bill->owed_pkgnum($pkgnum);
6632   }
6633   sprintf( "%.2f", $total_bill );
6634
6635 }
6636
6637 =item total_paid
6638
6639 Returns the total amount of all payments.
6640
6641 =cut
6642
6643 sub total_paid {
6644   my $self = shift;
6645   my $total = 0;
6646   $total += $_->paid foreach $self->cust_pay;
6647   sprintf( "%.2f", $total );
6648 }
6649
6650 =item total_unapplied_credits
6651
6652 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6653 customer.  See L<FS::cust_credit/credited>.
6654
6655 =item total_credited
6656
6657 Old name for total_unapplied_credits.  Don't use.
6658
6659 =cut
6660
6661 sub total_credited {
6662   #carp "total_credited deprecated, use total_unapplied_credits";
6663   shift->total_unapplied_credits(@_);
6664 }
6665
6666 sub total_unapplied_credits {
6667   my $self = shift;
6668   my $total_credit = 0;
6669   $total_credit += $_->credited foreach $self->cust_credit;
6670   sprintf( "%.2f", $total_credit );
6671 }
6672
6673 =item total_unapplied_credits_pkgnum PKGNUM
6674
6675 Returns the total outstanding credit (see L<FS::cust_credit>) for this
6676 customer.  See L<FS::cust_credit/credited>.
6677
6678 =cut
6679
6680 sub total_unapplied_credits_pkgnum {
6681   my( $self, $pkgnum ) = @_;
6682   my $total_credit = 0;
6683   $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
6684   sprintf( "%.2f", $total_credit );
6685 }
6686
6687
6688 =item total_unapplied_payments
6689
6690 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
6691 See L<FS::cust_pay/unapplied>.
6692
6693 =cut
6694
6695 sub total_unapplied_payments {
6696   my $self = shift;
6697   my $total_unapplied = 0;
6698   $total_unapplied += $_->unapplied foreach $self->cust_pay;
6699   sprintf( "%.2f", $total_unapplied );
6700 }
6701
6702 =item total_unapplied_payments_pkgnum PKGNUM
6703
6704 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
6705 specific package when using experimental package balances.  See
6706 L<FS::cust_pay/unapplied>.
6707
6708 =cut
6709
6710 sub total_unapplied_payments_pkgnum {
6711   my( $self, $pkgnum ) = @_;
6712   my $total_unapplied = 0;
6713   $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
6714   sprintf( "%.2f", $total_unapplied );
6715 }
6716
6717
6718 =item total_unapplied_refunds
6719
6720 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
6721 customer.  See L<FS::cust_refund/unapplied>.
6722
6723 =cut
6724
6725 sub total_unapplied_refunds {
6726   my $self = shift;
6727   my $total_unapplied = 0;
6728   $total_unapplied += $_->unapplied foreach $self->cust_refund;
6729   sprintf( "%.2f", $total_unapplied );
6730 }
6731
6732 =item balance
6733
6734 Returns the balance for this customer (total_owed plus total_unrefunded, minus
6735 total_unapplied_credits minus total_unapplied_payments).
6736
6737 =cut
6738
6739 sub balance {
6740   my $self = shift;
6741   sprintf( "%.2f",
6742       $self->total_owed
6743     + $self->total_unapplied_refunds
6744     - $self->total_unapplied_credits
6745     - $self->total_unapplied_payments
6746   );
6747 }
6748
6749 =item balance_date TIME
6750
6751 Returns the balance for this customer, only considering invoices with date
6752 earlier than TIME (total_owed_date minus total_credited minus
6753 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
6754 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
6755 functions.
6756
6757 =cut
6758
6759 sub balance_date {
6760   my $self = shift;
6761   my $time = shift;
6762   sprintf( "%.2f",
6763         $self->total_owed_date($time)
6764       + $self->total_unapplied_refunds
6765       - $self->total_unapplied_credits
6766       - $self->total_unapplied_payments
6767   );
6768 }
6769
6770 =item balance_pkgnum PKGNUM
6771
6772 Returns the balance for this customer's specific package when using
6773 experimental package balances (total_owed plus total_unrefunded, minus
6774 total_unapplied_credits minus total_unapplied_payments)
6775
6776 =cut
6777
6778 sub balance_pkgnum {
6779   my( $self, $pkgnum ) = @_;
6780
6781   sprintf( "%.2f",
6782       $self->total_owed_pkgnum($pkgnum)
6783 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
6784 #    + $self->total_unapplied_refunds_pkgnum($pkgnum)
6785     - $self->total_unapplied_credits_pkgnum($pkgnum)
6786     - $self->total_unapplied_payments_pkgnum($pkgnum)
6787   );
6788 }
6789
6790 =item in_transit_payments
6791
6792 Returns the total of requests for payments for this customer pending in
6793 batches in transit to the bank.  See L<FS::pay_batch> and L<FS::cust_pay_batch>
6794
6795 =cut
6796
6797 sub in_transit_payments {
6798   my $self = shift;
6799   my $in_transit_payments = 0;
6800   foreach my $pay_batch ( qsearch('pay_batch', {
6801     'status' => 'I',
6802   } ) ) {
6803     foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
6804       'batchnum' => $pay_batch->batchnum,
6805       'custnum' => $self->custnum,
6806     } ) ) {
6807       $in_transit_payments += $cust_pay_batch->amount;
6808     }
6809   }
6810   sprintf( "%.2f", $in_transit_payments );
6811 }
6812
6813 =item payment_info
6814
6815 Returns a hash of useful information for making a payment.
6816
6817 =over 4
6818
6819 =item balance
6820
6821 Current balance.
6822
6823 =item payby
6824
6825 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
6826 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
6827 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
6828
6829 =back
6830
6831 For credit card transactions:
6832
6833 =over 4
6834
6835 =item card_type 1
6836
6837 =item payname
6838
6839 Exact name on card
6840
6841 =back
6842
6843 For electronic check transactions:
6844
6845 =over 4
6846
6847 =item stateid_state
6848
6849 =back
6850
6851 =cut
6852
6853 sub payment_info {
6854   my $self = shift;
6855
6856   my %return = ();
6857
6858   $return{balance} = $self->balance;
6859
6860   $return{payname} = $self->payname
6861                      || ( $self->first. ' '. $self->get('last') );
6862
6863   $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
6864
6865   $return{payby} = $self->payby;
6866   $return{stateid_state} = $self->stateid_state;
6867
6868   if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
6869     $return{card_type} = cardtype($self->payinfo);
6870     $return{payinfo} = $self->paymask;
6871
6872     @return{'month', 'year'} = $self->paydate_monthyear;
6873
6874   }
6875
6876   if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
6877     my ($payinfo1, $payinfo2) = split '@', $self->paymask;
6878     $return{payinfo1} = $payinfo1;
6879     $return{payinfo2} = $payinfo2;
6880     $return{paytype}  = $self->paytype;
6881     $return{paystate} = $self->paystate;
6882
6883   }
6884
6885   #doubleclick protection
6886   my $_date = time;
6887   $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
6888
6889   %return;
6890
6891 }
6892
6893 =item paydate_monthyear
6894
6895 Returns a two-element list consisting of the month and year of this customer's
6896 paydate (credit card expiration date for CARD customers)
6897
6898 =cut
6899
6900 sub paydate_monthyear {
6901   my $self = shift;
6902   if ( $self->paydate  =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
6903     ( $2, $1 );
6904   } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
6905     ( $1, $3 );
6906   } else {
6907     ('', '');
6908   }
6909 }
6910
6911 =item tax_exemption TAXNAME
6912
6913 =cut
6914
6915 sub tax_exemption {
6916   my( $self, $taxname ) = @_;
6917
6918   qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
6919                                      'taxname' => $taxname,
6920                                    },
6921           );
6922 }
6923
6924 =item cust_main_exemption
6925
6926 =cut
6927
6928 sub cust_main_exemption {
6929   my $self = shift;
6930   qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
6931 }
6932
6933 =item invoicing_list [ ARRAYREF ]
6934
6935 If an arguement is given, sets these email addresses as invoice recipients
6936 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
6937 (except as warnings), so use check_invoicing_list first.
6938
6939 Returns a list of email addresses (with svcnum entries expanded).
6940
6941 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
6942 check it without disturbing anything by passing nothing.
6943
6944 This interface may change in the future.
6945
6946 =cut
6947
6948 sub invoicing_list {
6949   my( $self, $arrayref ) = @_;
6950
6951   if ( $arrayref ) {
6952     my @cust_main_invoice;
6953     if ( $self->custnum ) {
6954       @cust_main_invoice =
6955         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6956     } else {
6957       @cust_main_invoice = ();
6958     }
6959     foreach my $cust_main_invoice ( @cust_main_invoice ) {
6960       #warn $cust_main_invoice->destnum;
6961       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
6962         #warn $cust_main_invoice->destnum;
6963         my $error = $cust_main_invoice->delete;
6964         warn $error if $error;
6965       }
6966     }
6967     if ( $self->custnum ) {
6968       @cust_main_invoice =
6969         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6970     } else {
6971       @cust_main_invoice = ();
6972     }
6973     my %seen = map { $_->address => 1 } @cust_main_invoice;
6974     foreach my $address ( @{$arrayref} ) {
6975       next if exists $seen{$address} && $seen{$address};
6976       $seen{$address} = 1;
6977       my $cust_main_invoice = new FS::cust_main_invoice ( {
6978         'custnum' => $self->custnum,
6979         'dest'    => $address,
6980       } );
6981       my $error = $cust_main_invoice->insert;
6982       warn $error if $error;
6983     }
6984   }
6985
6986   if ( $self->custnum ) {
6987     map { $_->address }
6988       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
6989   } else {
6990     ();
6991   }
6992
6993 }
6994
6995 =item check_invoicing_list ARRAYREF
6996
6997 Checks these arguements as valid input for the invoicing_list method.  If there
6998 is an error, returns the error, otherwise returns false.
6999
7000 =cut
7001
7002 sub check_invoicing_list {
7003   my( $self, $arrayref ) = @_;
7004
7005   foreach my $address ( @$arrayref ) {
7006
7007     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
7008       return 'Can\'t add FAX invoice destination with a blank FAX number.';
7009     }
7010
7011     my $cust_main_invoice = new FS::cust_main_invoice ( {
7012       'custnum' => $self->custnum,
7013       'dest'    => $address,
7014     } );
7015     my $error = $self->custnum
7016                 ? $cust_main_invoice->check
7017                 : $cust_main_invoice->checkdest
7018     ;
7019     return $error if $error;
7020
7021   }
7022
7023   return "Email address required"
7024     if $conf->exists('cust_main-require_invoicing_list_email')
7025     && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
7026
7027   '';
7028 }
7029
7030 =item set_default_invoicing_list
7031
7032 Sets the invoicing list to all accounts associated with this customer,
7033 overwriting any previous invoicing list.
7034
7035 =cut
7036
7037 sub set_default_invoicing_list {
7038   my $self = shift;
7039   $self->invoicing_list($self->all_emails);
7040 }
7041
7042 =item all_emails
7043
7044 Returns the email addresses of all accounts provisioned for this customer.
7045
7046 =cut
7047
7048 sub all_emails {
7049   my $self = shift;
7050   my %list;
7051   foreach my $cust_pkg ( $self->all_pkgs ) {
7052     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
7053     my @svc_acct =
7054       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7055         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
7056           @cust_svc;
7057     $list{$_}=1 foreach map { $_->email } @svc_acct;
7058   }
7059   keys %list;
7060 }
7061
7062 =item invoicing_list_addpost
7063
7064 Adds postal invoicing to this customer.  If this customer is already configured
7065 to receive postal invoices, does nothing.
7066
7067 =cut
7068
7069 sub invoicing_list_addpost {
7070   my $self = shift;
7071   return if grep { $_ eq 'POST' } $self->invoicing_list;
7072   my @invoicing_list = $self->invoicing_list;
7073   push @invoicing_list, 'POST';
7074   $self->invoicing_list(\@invoicing_list);
7075 }
7076
7077 =item invoicing_list_emailonly
7078
7079 Returns the list of email invoice recipients (invoicing_list without non-email
7080 destinations such as POST and FAX).
7081
7082 =cut
7083
7084 sub invoicing_list_emailonly {
7085   my $self = shift;
7086   warn "$me invoicing_list_emailonly called"
7087     if $DEBUG;
7088   grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
7089 }
7090
7091 =item invoicing_list_emailonly_scalar
7092
7093 Returns the list of email invoice recipients (invoicing_list without non-email
7094 destinations such as POST and FAX) as a comma-separated scalar.
7095
7096 =cut
7097
7098 sub invoicing_list_emailonly_scalar {
7099   my $self = shift;
7100   warn "$me invoicing_list_emailonly_scalar called"
7101     if $DEBUG;
7102   join(', ', $self->invoicing_list_emailonly);
7103 }
7104
7105 =item referral_custnum_cust_main
7106
7107 Returns the customer who referred this customer (or the empty string, if
7108 this customer was not referred).
7109
7110 Note the difference with referral_cust_main method: This method,
7111 referral_custnum_cust_main returns the single customer (if any) who referred
7112 this customer, while referral_cust_main returns an array of customers referred
7113 BY this customer.
7114
7115 =cut
7116
7117 sub referral_custnum_cust_main {
7118   my $self = shift;
7119   return '' unless $self->referral_custnum;
7120   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7121 }
7122
7123 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
7124
7125 Returns an array of customers referred by this customer (referral_custnum set
7126 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
7127 customers referred by customers referred by this customer and so on, inclusive.
7128 The default behavior is DEPTH 1 (no recursion).
7129
7130 Note the difference with referral_custnum_cust_main method: This method,
7131 referral_cust_main, returns an array of customers referred BY this customer,
7132 while referral_custnum_cust_main returns the single customer (if any) who
7133 referred this customer.
7134
7135 =cut
7136
7137 sub referral_cust_main {
7138   my $self = shift;
7139   my $depth = @_ ? shift : 1;
7140   my $exclude = @_ ? shift : {};
7141
7142   my @cust_main =
7143     map { $exclude->{$_->custnum}++; $_; }
7144       grep { ! $exclude->{ $_->custnum } }
7145         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
7146
7147   if ( $depth > 1 ) {
7148     push @cust_main,
7149       map { $_->referral_cust_main($depth-1, $exclude) }
7150         @cust_main;
7151   }
7152
7153   @cust_main;
7154 }
7155
7156 =item referral_cust_main_ncancelled
7157
7158 Same as referral_cust_main, except only returns customers with uncancelled
7159 packages.
7160
7161 =cut
7162
7163 sub referral_cust_main_ncancelled {
7164   my $self = shift;
7165   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
7166 }
7167
7168 =item referral_cust_pkg [ DEPTH ]
7169
7170 Like referral_cust_main, except returns a flat list of all unsuspended (and
7171 uncancelled) packages for each customer.  The number of items in this list may
7172 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
7173
7174 =cut
7175
7176 sub referral_cust_pkg {
7177   my $self = shift;
7178   my $depth = @_ ? shift : 1;
7179
7180   map { $_->unsuspended_pkgs }
7181     grep { $_->unsuspended_pkgs }
7182       $self->referral_cust_main($depth);
7183 }
7184
7185 =item referring_cust_main
7186
7187 Returns the single cust_main record for the customer who referred this customer
7188 (referral_custnum), or false.
7189
7190 =cut
7191
7192 sub referring_cust_main {
7193   my $self = shift;
7194   return '' unless $self->referral_custnum;
7195   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
7196 }
7197
7198 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
7199
7200 Applies a credit to this customer.  If there is an error, returns the error,
7201 otherwise returns false.
7202
7203 REASON can be a text string, an FS::reason object, or a scalar reference to
7204 a reasonnum.  If a text string, it will be automatically inserted as a new
7205 reason, and a 'reason_type' option must be passed to indicate the
7206 FS::reason_type for the new reason.
7207
7208 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
7209
7210 Any other options are passed to FS::cust_credit::insert.
7211
7212 =cut
7213
7214 sub credit {
7215   my( $self, $amount, $reason, %options ) = @_;
7216
7217   my $cust_credit = new FS::cust_credit {
7218     'custnum' => $self->custnum,
7219     'amount'  => $amount,
7220   };
7221
7222   if ( ref($reason) ) {
7223
7224     if ( ref($reason) eq 'SCALAR' ) {
7225       $cust_credit->reasonnum( $$reason );
7226     } else {
7227       $cust_credit->reasonnum( $reason->reasonnum );
7228     }
7229
7230   } else {
7231     $cust_credit->set('reason', $reason)
7232   }
7233
7234   $cust_credit->addlinfo( delete $options{'addlinfo'} )
7235     if exists($options{'addlinfo'});
7236
7237   $cust_credit->insert(%options);
7238
7239 }
7240
7241 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
7242
7243 Creates a one-time charge for this customer.  If there is an error, returns
7244 the error, otherwise returns false.
7245
7246 New-style, with a hashref of options:
7247
7248   my $error = $cust_main->charge(
7249                                   {
7250                                     'amount'     => 54.32,
7251                                     'quantity'   => 1,
7252                                     'start_date' => str2time('7/4/2009'),
7253                                     'pkg'        => 'Description',
7254                                     'comment'    => 'Comment',
7255                                     'additional' => [], #extra invoice detail
7256                                     'classnum'   => 1,  #pkg_class
7257
7258                                     'setuptax'   => '', # or 'Y' for tax exempt
7259
7260                                     #internal taxation
7261                                     'taxclass'   => 'Tax class',
7262
7263                                     #vendor taxation
7264                                     'taxproduct' => 2,  #part_pkg_taxproduct
7265                                     'override'   => {}, #XXX describe
7266
7267                                     #will be filled in with the new object
7268                                     'cust_pkg_ref' => \$cust_pkg,
7269
7270                                     #generate an invoice immediately
7271                                     'bill_now' => 0,
7272                                     'invoice_terms' => '', #with these terms
7273                                   }
7274                                 );
7275
7276 Old-style:
7277
7278   my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
7279
7280 =cut
7281
7282 sub charge {
7283   my $self = shift;
7284   my ( $amount, $quantity, $start_date, $classnum );
7285   my ( $pkg, $comment, $additional );
7286   my ( $setuptax, $taxclass );   #internal taxes
7287   my ( $taxproduct, $override ); #vendor (CCH) taxes
7288   my $cust_pkg_ref = '';
7289   my ( $bill_now, $invoice_terms ) = ( 0, '' );
7290   if ( ref( $_[0] ) ) {
7291     $amount     = $_[0]->{amount};
7292     $quantity   = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
7293     $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
7294     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
7295     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
7296                                            : '$'. sprintf("%.2f",$amount);
7297     $setuptax   = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
7298     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
7299     $classnum   = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
7300     $additional = $_[0]->{additional} || [];
7301     $taxproduct = $_[0]->{taxproductnum};
7302     $override   = { '' => $_[0]->{tax_override} };
7303     $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
7304     $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
7305     $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
7306   } else {
7307     $amount     = shift;
7308     $quantity   = 1;
7309     $start_date = '';
7310     $pkg        = @_ ? shift : 'One-time charge';
7311     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
7312     $setuptax   = '';
7313     $taxclass   = @_ ? shift : '';
7314     $additional = [];
7315   }
7316
7317   local $SIG{HUP} = 'IGNORE';
7318   local $SIG{INT} = 'IGNORE';
7319   local $SIG{QUIT} = 'IGNORE';
7320   local $SIG{TERM} = 'IGNORE';
7321   local $SIG{TSTP} = 'IGNORE';
7322   local $SIG{PIPE} = 'IGNORE';
7323
7324   my $oldAutoCommit = $FS::UID::AutoCommit;
7325   local $FS::UID::AutoCommit = 0;
7326   my $dbh = dbh;
7327
7328   my $part_pkg = new FS::part_pkg ( {
7329     'pkg'           => $pkg,
7330     'comment'       => $comment,
7331     'plan'          => 'flat',
7332     'freq'          => 0,
7333     'disabled'      => 'Y',
7334     'classnum'      => ( $classnum ? $classnum : '' ),
7335     'setuptax'      => $setuptax,
7336     'taxclass'      => $taxclass,
7337     'taxproductnum' => $taxproduct,
7338   } );
7339
7340   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
7341                         ( 0 .. @$additional - 1 )
7342                   ),
7343                   'additional_count' => scalar(@$additional),
7344                   'setup_fee' => $amount,
7345                 );
7346
7347   my $error = $part_pkg->insert( options       => \%options,
7348                                  tax_overrides => $override,
7349                                );
7350   if ( $error ) {
7351     $dbh->rollback if $oldAutoCommit;
7352     return $error;
7353   }
7354
7355   my $pkgpart = $part_pkg->pkgpart;
7356   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
7357   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
7358     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
7359     $error = $type_pkgs->insert;
7360     if ( $error ) {
7361       $dbh->rollback if $oldAutoCommit;
7362       return $error;
7363     }
7364   }
7365
7366   my $cust_pkg = new FS::cust_pkg ( {
7367     'custnum'    => $self->custnum,
7368     'pkgpart'    => $pkgpart,
7369     'quantity'   => $quantity,
7370     'start_date' => $start_date,
7371   } );
7372
7373   $error = $cust_pkg->insert;
7374   if ( $error ) {
7375     $dbh->rollback if $oldAutoCommit;
7376     return $error;
7377   } elsif ( $cust_pkg_ref ) {
7378     ${$cust_pkg_ref} = $cust_pkg;
7379   }
7380
7381   if ( $bill_now ) {
7382     my $error = $self->bill( 'invoice_terms' => $invoice_terms,
7383                              'pkg_list'      => [ $cust_pkg ],
7384                            );
7385     if ( $error ) {
7386       $dbh->rollback if $oldAutoCommit;
7387       return $error;
7388     }
7389   }
7390
7391   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
7392   return '';
7393
7394 }
7395
7396 #=item charge_postal_fee
7397 #
7398 #Applies a one time charge this customer.  If there is an error,
7399 #returns the error, returns the cust_pkg charge object or false
7400 #if there was no charge.
7401 #
7402 #=cut
7403 #
7404 # This should be a customer event.  For that to work requires that bill
7405 # also be a customer event.
7406
7407 sub charge_postal_fee {
7408   my $self = shift;
7409
7410   my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
7411   return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
7412
7413   my $cust_pkg = new FS::cust_pkg ( {
7414     'custnum'  => $self->custnum,
7415     'pkgpart'  => $pkgpart,
7416     'quantity' => 1,
7417   } );
7418
7419   my $error = $cust_pkg->insert;
7420   $error ? $error : $cust_pkg;
7421 }
7422
7423 =item cust_bill
7424
7425 Returns all the invoices (see L<FS::cust_bill>) for this customer.
7426
7427 =cut
7428
7429 sub cust_bill {
7430   my $self = shift;
7431   map { $_ } #return $self->num_cust_bill unless wantarray;
7432   sort { $a->_date <=> $b->_date }
7433     qsearch('cust_bill', { 'custnum' => $self->custnum, } )
7434 }
7435
7436 =item open_cust_bill
7437
7438 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
7439 customer.
7440
7441 =cut
7442
7443 sub open_cust_bill {
7444   my $self = shift;
7445
7446   qsearch({
7447     'table'     => 'cust_bill',
7448     'hashref'   => { 'custnum' => $self->custnum, },
7449     'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
7450     'order_by'  => 'ORDER BY _date ASC',
7451   });
7452
7453 }
7454
7455 =item cust_statements
7456
7457 Returns all the statements (see L<FS::cust_statement>) for this customer.
7458
7459 =cut
7460
7461 sub cust_statement {
7462   my $self = shift;
7463   map { $_ } #return $self->num_cust_statement unless wantarray;
7464   sort { $a->_date <=> $b->_date }
7465     qsearch('cust_statement', { 'custnum' => $self->custnum, } )
7466 }
7467
7468 =item cust_credit
7469
7470 Returns all the credits (see L<FS::cust_credit>) for this customer.
7471
7472 =cut
7473
7474 sub cust_credit {
7475   my $self = shift;
7476   map { $_ } #return $self->num_cust_credit unless wantarray;
7477   sort { $a->_date <=> $b->_date }
7478     qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
7479 }
7480
7481 =item cust_credit_pkgnum
7482
7483 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
7484 package when using experimental package balances.
7485
7486 =cut
7487
7488 sub cust_credit_pkgnum {
7489   my( $self, $pkgnum ) = @_;
7490   map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
7491   sort { $a->_date <=> $b->_date }
7492     qsearch( 'cust_credit', { 'custnum' => $self->custnum,
7493                               'pkgnum'  => $pkgnum,
7494                             }
7495     );
7496 }
7497
7498 =item cust_pay
7499
7500 Returns all the payments (see L<FS::cust_pay>) for this customer.
7501
7502 =cut
7503
7504 sub cust_pay {
7505   my $self = shift;
7506   return $self->num_cust_pay unless wantarray;
7507   sort { $a->_date <=> $b->_date }
7508     qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
7509 }
7510
7511 =item num_cust_pay
7512
7513 Returns the number of payments (see L<FS::cust_pay>) for this customer.  Also
7514 called automatically when the cust_pay method is used in a scalar context.
7515
7516 =cut
7517
7518 sub num_cust_pay {
7519   my $self = shift;
7520   my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
7521   my $sth = dbh->prepare($sql) or die dbh->errstr;
7522   $sth->execute($self->custnum) or die $sth->errstr;
7523   $sth->fetchrow_arrayref->[0];
7524 }
7525
7526 =item cust_pay_pkgnum
7527
7528 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
7529 package when using experimental package balances.
7530
7531 =cut
7532
7533 sub cust_pay_pkgnum {
7534   my( $self, $pkgnum ) = @_;
7535   map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
7536   sort { $a->_date <=> $b->_date }
7537     qsearch( 'cust_pay', { 'custnum' => $self->custnum,
7538                            'pkgnum'  => $pkgnum,
7539                          }
7540     );
7541 }
7542
7543 =item cust_pay_void
7544
7545 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
7546
7547 =cut
7548
7549 sub cust_pay_void {
7550   my $self = shift;
7551   map { $_ } #return $self->num_cust_pay_void unless wantarray;
7552   sort { $a->_date <=> $b->_date }
7553     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
7554 }
7555
7556 =item cust_pay_batch
7557
7558 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
7559
7560 =cut
7561
7562 sub cust_pay_batch {
7563   my $self = shift;
7564   map { $_ } #return $self->num_cust_pay_batch unless wantarray;
7565   sort { $a->paybatchnum <=> $b->paybatchnum }
7566     qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
7567 }
7568
7569 =item cust_pay_pending
7570
7571 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
7572 (without status "done").
7573
7574 =cut
7575
7576 sub cust_pay_pending {
7577   my $self = shift;
7578   return $self->num_cust_pay_pending unless wantarray;
7579   sort { $a->_date <=> $b->_date }
7580     qsearch( 'cust_pay_pending', {
7581                                    'custnum' => $self->custnum,
7582                                    'status'  => { op=>'!=', value=>'done' },
7583                                  },
7584            );
7585 }
7586
7587 =item num_cust_pay_pending
7588
7589 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
7590 customer (without status "done").  Also called automatically when the
7591 cust_pay_pending method is used in a scalar context.
7592
7593 =cut
7594
7595 sub num_cust_pay_pending {
7596   my $self = shift;
7597   my $sql = " SELECT COUNT(*) FROM cust_pay_pending ".
7598             "   WHERE custnum = ? AND status != 'done' ";
7599   my $sth = dbh->prepare($sql) or die dbh->errstr;
7600   $sth->execute($self->custnum) or die $sth->errstr;
7601   $sth->fetchrow_arrayref->[0];
7602 }
7603
7604 =item cust_refund
7605
7606 Returns all the refunds (see L<FS::cust_refund>) for this customer.
7607
7608 =cut
7609
7610 sub cust_refund {
7611   my $self = shift;
7612   map { $_ } #return $self->num_cust_refund unless wantarray;
7613   sort { $a->_date <=> $b->_date }
7614     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
7615 }
7616
7617 =item display_custnum
7618
7619 Returns the displayed customer number for this customer: agent_custid if
7620 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
7621
7622 =cut
7623
7624 sub display_custnum {
7625   my $self = shift;
7626   if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
7627     return $self->agent_custid;
7628   } else {
7629     return $self->custnum;
7630   }
7631 }
7632
7633 =item name
7634
7635 Returns a name string for this customer, either "Company (Last, First)" or
7636 "Last, First".
7637
7638 =cut
7639
7640 sub name {
7641   my $self = shift;
7642   my $name = $self->contact;
7643   $name = $self->company. " ($name)" if $self->company;
7644   $name;
7645 }
7646
7647 =item ship_name
7648
7649 Returns a name string for this (service/shipping) contact, either
7650 "Company (Last, First)" or "Last, First".
7651
7652 =cut
7653
7654 sub ship_name {
7655   my $self = shift;
7656   if ( $self->get('ship_last') ) {
7657     my $name = $self->ship_contact;
7658     $name = $self->ship_company. " ($name)" if $self->ship_company;
7659     $name;
7660   } else {
7661     $self->name;
7662   }
7663 }
7664
7665 =item name_short
7666
7667 Returns a name string for this customer, either "Company" or "First Last".
7668
7669 =cut
7670
7671 sub name_short {
7672   my $self = shift;
7673   $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
7674 }
7675
7676 =item ship_name_short
7677
7678 Returns a name string for this (service/shipping) contact, either "Company"
7679 or "First Last".
7680
7681 =cut
7682
7683 sub ship_name_short {
7684   my $self = shift;
7685   if ( $self->get('ship_last') ) {
7686     $self->ship_company !~ /^\s*$/
7687       ? $self->ship_company
7688       : $self->ship_contact_firstlast;
7689   } else {
7690     $self->name_company_or_firstlast;
7691   }
7692 }
7693
7694 =item contact
7695
7696 Returns this customer's full (billing) contact name only, "Last, First"
7697
7698 =cut
7699
7700 sub contact {
7701   my $self = shift;
7702   $self->get('last'). ', '. $self->first;
7703 }
7704
7705 =item ship_contact
7706
7707 Returns this customer's full (shipping) contact name only, "Last, First"
7708
7709 =cut
7710
7711 sub ship_contact {
7712   my $self = shift;
7713   $self->get('ship_last')
7714     ? $self->get('ship_last'). ', '. $self->ship_first
7715     : $self->contact;
7716 }
7717
7718 =item contact_firstlast
7719
7720 Returns this customers full (billing) contact name only, "First Last".
7721
7722 =cut
7723
7724 sub contact_firstlast {
7725   my $self = shift;
7726   $self->first. ' '. $self->get('last');
7727 }
7728
7729 =item ship_contact_firstlast
7730
7731 Returns this customer's full (shipping) contact name only, "First Last".
7732
7733 =cut
7734
7735 sub ship_contact_firstlast {
7736   my $self = shift;
7737   $self->get('ship_last')
7738     ? $self->first. ' '. $self->get('ship_last')
7739     : $self->contact_firstlast;
7740 }
7741
7742 =item country_full
7743
7744 Returns this customer's full country name
7745
7746 =cut
7747
7748 sub country_full {
7749   my $self = shift;
7750   code2country($self->country);
7751 }
7752
7753 =item geocode DATA_VENDOR
7754
7755 Returns a value for the customer location as encoded by DATA_VENDOR.
7756 Currently this only makes sense for "CCH" as DATA_VENDOR.
7757
7758 =cut
7759
7760 sub geocode {
7761   my ($self, $data_vendor) = (shift, shift);  #always cch for now
7762
7763   my $geocode = $self->get('geocode');  #XXX only one data_vendor for geocode
7764   return $geocode if $geocode;
7765
7766   my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
7767                ? 'ship_'
7768                : '';
7769
7770   my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
7771     if $self->country eq 'US';
7772
7773   #CCH specific location stuff
7774   my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
7775
7776   my @cust_tax_location =
7777     qsearch( {
7778                'table'     => 'cust_tax_location',
7779                'hashref'   => { 'zip' => $zip, 'data_vendor' => $data_vendor },
7780                'extra_sql' => $extra_sql,
7781                'order_by'  => 'ORDER BY plus4hi',#overlapping with distinct ends
7782              }
7783            );
7784   $geocode = $cust_tax_location[0]->geocode
7785     if scalar(@cust_tax_location);
7786
7787   $geocode;
7788 }
7789
7790 =item cust_status
7791
7792 =item status
7793
7794 Returns a status string for this customer, currently:
7795
7796 =over 4
7797
7798 =item prospect - No packages have ever been ordered
7799
7800 =item active - One or more recurring packages is active
7801
7802 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
7803
7804 =item suspended - All non-cancelled recurring packages are suspended
7805
7806 =item cancelled - All recurring packages are cancelled
7807
7808 =back
7809
7810 =cut
7811
7812 sub status { shift->cust_status(@_); }
7813
7814 sub cust_status {
7815   my $self = shift;
7816   for my $status (qw( prospect active inactive suspended cancelled )) {
7817     my $method = $status.'_sql';
7818     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
7819     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
7820     $sth->execute( ($self->custnum) x $numnum )
7821       or die "Error executing 'SELECT $sql': ". $sth->errstr;
7822     return $status if $sth->fetchrow_arrayref->[0];
7823   }
7824 }
7825
7826 =item ucfirst_cust_status
7827
7828 =item ucfirst_status
7829
7830 Returns the status with the first character capitalized.
7831
7832 =cut
7833
7834 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
7835
7836 sub ucfirst_cust_status {
7837   my $self = shift;
7838   ucfirst($self->cust_status);
7839 }
7840
7841 =item statuscolor
7842
7843 Returns a hex triplet color string for this customer's status.
7844
7845 =cut
7846
7847 use vars qw(%statuscolor);
7848 tie %statuscolor, 'Tie::IxHash',
7849   'prospect'  => '7e0079', #'000000', #black?  naw, purple
7850   'active'    => '00CC00', #green
7851   'inactive'  => '0000CC', #blue
7852   'suspended' => 'FF9900', #yellow
7853   'cancelled' => 'FF0000', #red
7854 ;
7855
7856 sub statuscolor { shift->cust_statuscolor(@_); }
7857
7858 sub cust_statuscolor {
7859   my $self = shift;
7860   $statuscolor{$self->cust_status};
7861 }
7862
7863 =item tickets
7864
7865 Returns an array of hashes representing the customer's RT tickets.
7866
7867 =cut
7868
7869 sub tickets {
7870   my $self = shift;
7871
7872   my $num = $conf->config('cust_main-max_tickets') || 10;
7873   my @tickets = ();
7874
7875   if ( $conf->config('ticket_system') ) {
7876     unless ( $conf->config('ticket_system-custom_priority_field') ) {
7877
7878       @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
7879
7880     } else {
7881
7882       foreach my $priority (
7883         $conf->config('ticket_system-custom_priority_field-values'), ''
7884       ) {
7885         last if scalar(@tickets) >= $num;
7886         push @tickets,
7887           @{ FS::TicketSystem->customer_tickets( $self->custnum,
7888                                                  $num - scalar(@tickets),
7889                                                  $priority,
7890                                                )
7891            };
7892       }
7893     }
7894   }
7895   (@tickets);
7896 }
7897
7898 # Return services representing svc_accts in customer support packages
7899 sub support_services {
7900   my $self = shift;
7901   my %packages = map { $_ => 1 } $conf->config('support_packages');
7902
7903   grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
7904     grep { $_->part_svc->svcdb eq 'svc_acct' }
7905     map { $_->cust_svc }
7906     grep { exists $packages{ $_->pkgpart } }
7907     $self->ncancelled_pkgs;
7908
7909 }
7910
7911 # Return a list of latitude/longitude for one of the services (if any)
7912 sub service_coordinates {
7913   my $self = shift;
7914
7915   my @svc_X =
7916     grep { $_->latitude && $_->longitude }
7917     map { $_->svc_x }
7918     map { $_->cust_svc }
7919     $self->ncancelled_pkgs;
7920
7921   scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
7922 }
7923
7924 =back
7925
7926 =head1 CLASS METHODS
7927
7928 =over 4
7929
7930 =item statuses
7931
7932 Class method that returns the list of possible status strings for customers
7933 (see L<the status method|/status>).  For example:
7934
7935   @statuses = FS::cust_main->statuses();
7936
7937 =cut
7938
7939 sub statuses {
7940   #my $self = shift; #could be class...
7941   keys %statuscolor;
7942 }
7943
7944 =item prospect_sql
7945
7946 Returns an SQL expression identifying prospective cust_main records (customers
7947 with no packages ever ordered)
7948
7949 =cut
7950
7951 use vars qw($select_count_pkgs);
7952 $select_count_pkgs =
7953   "SELECT COUNT(*) FROM cust_pkg
7954     WHERE cust_pkg.custnum = cust_main.custnum";
7955
7956 sub select_count_pkgs_sql {
7957   $select_count_pkgs;
7958 }
7959
7960 sub prospect_sql { "
7961   0 = ( $select_count_pkgs )
7962 "; }
7963
7964 =item active_sql
7965
7966 Returns an SQL expression identifying active cust_main records (customers with
7967 active recurring packages).
7968
7969 =cut
7970
7971 sub active_sql { "
7972   0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
7973       )
7974 "; }
7975
7976 =item inactive_sql
7977
7978 Returns an SQL expression identifying inactive cust_main records (customers with
7979 no active recurring packages, but otherwise unsuspended/uncancelled).
7980
7981 =cut
7982
7983 sub inactive_sql { "
7984   0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
7985   AND
7986   0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
7987 "; }
7988
7989 =item susp_sql
7990 =item suspended_sql
7991
7992 Returns an SQL expression identifying suspended cust_main records.
7993
7994 =cut
7995
7996
7997 sub suspended_sql { susp_sql(@_); }
7998 sub susp_sql { "
7999     0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
8000     AND
8001     0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
8002 "; }
8003
8004 =item cancel_sql
8005 =item cancelled_sql
8006
8007 Returns an SQL expression identifying cancelled cust_main records.
8008
8009 =cut
8010
8011 sub cancelled_sql { cancel_sql(@_); }
8012 sub cancel_sql {
8013
8014   my $recurring_sql = FS::cust_pkg->recurring_sql;
8015   my $cancelled_sql = FS::cust_pkg->cancelled_sql;
8016
8017   "
8018         0 < ( $select_count_pkgs )
8019     AND 0 < ( $select_count_pkgs AND $recurring_sql AND $cancelled_sql   )
8020     AND 0 = ( $select_count_pkgs AND $recurring_sql
8021                   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
8022             )
8023     AND 0 = (  $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
8024   ";
8025
8026 }
8027
8028 =item uncancel_sql
8029 =item uncancelled_sql
8030
8031 Returns an SQL expression identifying un-cancelled cust_main records.
8032
8033 =cut
8034
8035 sub uncancelled_sql { uncancel_sql(@_); }
8036 sub uncancel_sql { "
8037   ( 0 < ( $select_count_pkgs
8038                    AND ( cust_pkg.cancel IS NULL
8039                          OR cust_pkg.cancel = 0
8040                        )
8041         )
8042     OR 0 = ( $select_count_pkgs )
8043   )
8044 "; }
8045
8046 =item balance_sql
8047
8048 Returns an SQL fragment to retreive the balance.
8049
8050 =cut
8051
8052 sub balance_sql { "
8053     ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
8054         WHERE cust_bill.custnum   = cust_main.custnum     )
8055   - ( SELECT COALESCE( SUM(paid),    0 ) FROM cust_pay
8056         WHERE cust_pay.custnum    = cust_main.custnum     )
8057   - ( SELECT COALESCE( SUM(amount),  0 ) FROM cust_credit
8058         WHERE cust_credit.custnum = cust_main.custnum     )
8059   + ( SELECT COALESCE( SUM(refund),  0 ) FROM cust_refund
8060         WHERE cust_refund.custnum = cust_main.custnum     )
8061 "; }
8062
8063 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8064
8065 Returns an SQL fragment to retreive the balance for this customer, only
8066 considering invoices with date earlier than START_TIME, and optionally not
8067 later than END_TIME (total_owed_date minus total_unapplied_credits minus
8068 total_unapplied_payments).
8069
8070 Times are specified as SQL fragments or numeric
8071 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
8072 L<Date::Parse> for conversion functions.  The empty string can be passed
8073 to disable that time constraint completely.
8074
8075 Available options are:
8076
8077 =over 4
8078
8079 =item unapplied_date
8080
8081 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)
8082
8083 =item total
8084
8085 (unused.  obsolete?)
8086 set to true to remove all customer comparison clauses, for totals
8087
8088 =item where
8089
8090 (unused.  obsolete?)
8091 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
8092
8093 =item join
8094
8095 (unused.  obsolete?)
8096 JOIN clause (typically used with the total option)
8097
8098 =back
8099
8100 =cut
8101
8102 sub balance_date_sql {
8103   my( $class, $start, $end, %opt ) = @_;
8104
8105   my $owed         = FS::cust_bill->owed_sql;
8106   my $unapp_refund = FS::cust_refund->unapplied_sql;
8107   my $unapp_credit = FS::cust_credit->unapplied_sql;
8108   my $unapp_pay    = FS::cust_pay->unapplied_sql;
8109
8110   my $j = $opt{'join'} || '';
8111
8112   my $owed_wh   = $class->_money_table_where( 'cust_bill',   $start,$end,%opt );
8113   my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
8114   my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
8115   my $pay_wh    = $class->_money_table_where( 'cust_pay',    $start,$end,%opt );
8116
8117   "   ( SELECT COALESCE(SUM($owed),         0) FROM cust_bill   $j $owed_wh   )
8118     + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
8119     - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
8120     - ( SELECT COALESCE(SUM($unapp_pay),    0) FROM cust_pay    $j $pay_wh    )
8121   ";
8122
8123 }
8124
8125 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
8126
8127 Returns an SQL fragment to retreive the total unapplied payments for this
8128 customer, only considering invoices with date earlier than START_TIME, and
8129 optionally not later than END_TIME.
8130
8131 Times are specified as SQL fragments or numeric
8132 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
8133 L<Date::Parse> for conversion functions.  The empty string can be passed
8134 to disable that time constraint completely.
8135
8136 Available options are:
8137
8138 =cut
8139
8140 sub unapplied_payments_date_sql {
8141   my( $class, $start, $end, ) = @_;
8142
8143   my $unapp_pay    = FS::cust_pay->unapplied_sql;
8144
8145   my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
8146                                                           'unapplied_date'=>1 );
8147
8148   " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
8149 }
8150
8151 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
8152
8153 Helper method for balance_date_sql; name (and usage) subject to change
8154 (suggestions welcome).
8155
8156 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
8157 cust_refund, cust_credit or cust_pay).
8158
8159 If TABLE is "cust_bill" or the unapplied_date option is true, only
8160 considers records with date earlier than START_TIME, and optionally not
8161 later than END_TIME .
8162
8163 =cut
8164
8165 sub _money_table_where {
8166   my( $class, $table, $start, $end, %opt ) = @_;
8167
8168   my @where = ();
8169   push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
8170   if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
8171     push @where, "$table._date <= $start" if defined($start) && length($start);
8172     push @where, "$table._date >  $end"   if defined($end)   && length($end);
8173   }
8174   push @where, @{$opt{'where'}} if $opt{'where'};
8175   my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
8176
8177   $where;
8178
8179 }
8180
8181 =item search_sql HASHREF
8182
8183 (Class method)
8184
8185 Returns a qsearch hash expression to search for parameters specified in HREF.
8186 Valid parameters are
8187
8188 =over 4
8189
8190 =item agentnum
8191
8192 =item status
8193
8194 =item cancelled_pkgs
8195
8196 bool
8197
8198 =item signupdate
8199
8200 listref of start date, end date
8201
8202 =item payby
8203
8204 listref
8205
8206 =item current_balance
8207
8208 listref (list returned by FS::UI::Web::parse_lt_gt($cgi, 'current_balance'))
8209
8210 =item cust_fields
8211
8212 =item flattened_pkgs
8213
8214 bool
8215
8216 =back
8217
8218 =cut
8219
8220 sub search_sql {
8221   my ($class, $params) = @_;
8222
8223   my $dbh = dbh;
8224
8225   my @where = ();
8226   my $orderby;
8227
8228   ##
8229   # parse agent
8230   ##
8231
8232   if ( $params->{'agentnum'} =~ /^(\d+)$/ and $1 ) {
8233     push @where,
8234       "cust_main.agentnum = $1";
8235   }
8236
8237   ##
8238   # parse status
8239   ##
8240
8241   #prospect active inactive suspended cancelled
8242   if ( grep { $params->{'status'} eq $_ } FS::cust_main->statuses() ) {
8243     my $method = $params->{'status'}. '_sql';
8244     #push @where, $class->$method();
8245     push @where, FS::cust_main->$method();
8246   }
8247
8248   ##
8249   # parse cancelled package checkbox
8250   ##
8251
8252   my $pkgwhere = "";
8253
8254   $pkgwhere .= "AND (cancel = 0 or cancel is null)"
8255     unless $params->{'cancelled_pkgs'};
8256
8257   ##
8258   # parse without census tract checkbox
8259   ##
8260
8261   push @where, "(censustract = '' or censustract is null)"
8262     if $params->{'no_censustract'};
8263
8264   ##
8265   # dates
8266   ##
8267
8268   foreach my $field (qw( signupdate )) {
8269
8270     next unless exists($params->{$field});
8271
8272     my($beginning, $ending) = @{$params->{$field}};
8273
8274     push @where,
8275       "cust_main.$field IS NOT NULL",
8276       "cust_main.$field >= $beginning",
8277       "cust_main.$field <= $ending";
8278
8279     $orderby ||= "ORDER BY cust_main.$field";
8280
8281   }
8282
8283   ###
8284   # payby
8285   ###
8286
8287   my @payby = grep /^([A-Z]{4})$/, @{ $params->{'payby'} };
8288   if ( @payby ) {
8289     push @where, '( '. join(' OR ', map "cust_main.payby = '$_'", @payby). ' )';
8290   }
8291
8292   ##
8293   # amounts
8294   ##
8295
8296   #my $balance_sql = $class->balance_sql();
8297   my $balance_sql = FS::cust_main->balance_sql();
8298
8299   push @where, map { s/current_balance/$balance_sql/; $_ }
8300                    @{ $params->{'current_balance'} };
8301
8302   ##
8303   # custbatch
8304   ##
8305
8306   if ( $params->{'custbatch'} =~ /^([\w\/\-\:\.]+)$/ and $1 ) {
8307     push @where,
8308       "cust_main.custbatch = '$1'";
8309   }
8310
8311   ##
8312   # setup queries, subs, etc. for the search
8313   ##
8314
8315   $orderby ||= 'ORDER BY custnum';
8316
8317   # here is the agent virtualization
8318   push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
8319
8320   my $extra_sql = scalar(@where) ? ' WHERE '. join(' AND ', @where) : '';
8321
8322   my $addl_from = 'LEFT JOIN cust_pkg USING ( custnum  ) ';
8323
8324   my $count_query = "SELECT COUNT(*) FROM cust_main $extra_sql";
8325
8326   my $select = join(', ',
8327                  'cust_main.custnum',
8328                  FS::UI::Web::cust_sql_fields($params->{'cust_fields'}),
8329                );
8330
8331   my(@extra_headers) = ();
8332   my(@extra_fields)  = ();
8333
8334   if ($params->{'flattened_pkgs'}) {
8335
8336     if ($dbh->{Driver}->{Name} eq 'Pg') {
8337
8338       $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";
8339
8340     }elsif ($dbh->{Driver}->{Name} =~ /^mysql/i) {
8341       $select .= ", GROUP_CONCAT(pkg SEPARATOR '|') as magic";
8342       $addl_from .= " LEFT JOIN part_pkg using ( pkgpart )";
8343     }else{
8344       warn "warning: unknown database type ". $dbh->{Driver}->{Name}.
8345            "omitting packing information from report.";
8346     }
8347
8348     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";
8349
8350     my $sth = dbh->prepare($header_query) or die dbh->errstr;
8351     $sth->execute() or die $sth->errstr;
8352     my $headerrow = $sth->fetchrow_arrayref;
8353     my $headercount = $headerrow ? $headerrow->[0] : 0;
8354     while($headercount) {
8355       unshift @extra_headers, "Package ". $headercount;
8356       unshift @extra_fields, eval q!sub {my $c = shift;
8357                                          my @a = split '\|', $c->magic;
8358                                          my $p = $a[!.--$headercount. q!];
8359                                          $p;
8360                                         };!;
8361     }
8362
8363   }
8364
8365   my $sql_query = {
8366     'table'         => 'cust_main',
8367     'select'        => $select,
8368     'hashref'       => {},
8369     'extra_sql'     => $extra_sql,
8370     'order_by'      => $orderby,
8371     'count_query'   => $count_query,
8372     'extra_headers' => \@extra_headers,
8373     'extra_fields'  => \@extra_fields,
8374   };
8375
8376 }
8377
8378 =item email_search_sql HASHREF
8379
8380 (Class method)
8381
8382 Emails a notice to the specified customers.
8383
8384 Valid parameters are those of the L<search_sql> method, plus the following:
8385
8386 =over 4
8387
8388 =item from
8389
8390 From: address
8391
8392 =item subject
8393
8394 Email Subject:
8395
8396 =item html_body
8397
8398 HTML body
8399
8400 =item text_body
8401
8402 Text body
8403
8404 =item job
8405
8406 Optional job queue job for status updates.
8407
8408 =back
8409
8410 Returns an error message, or false for success.
8411
8412 If an error occurs during any email, stops the enture send and returns that
8413 error.  Presumably if you're getting SMTP errors aborting is better than
8414 retrying everything.
8415
8416 =cut
8417
8418 sub email_search_sql {
8419   my($class, $params) = @_;
8420
8421   my $from = delete $params->{from};
8422   my $subject = delete $params->{subject};
8423   my $html_body = delete $params->{html_body};
8424   my $text_body = delete $params->{text_body};
8425
8426   my $job = delete $params->{'job'};
8427
8428   $params->{'payby'} = [ split(/\0/, $params->{'payby'}) ]
8429     unless ref($params->{'payby'});
8430
8431   my $sql_query = $class->search_sql($params);
8432
8433   my $count_query   = delete($sql_query->{'count_query'});
8434   my $count_sth = dbh->prepare($count_query)
8435     or die "Error preparing $count_query: ". dbh->errstr;
8436   $count_sth->execute
8437     or die "Error executing $count_query: ". $count_sth->errstr;
8438   my $count_arrayref = $count_sth->fetchrow_arrayref;
8439   my $num_cust = $count_arrayref->[0];
8440
8441   #my @extra_headers = @{ delete($sql_query->{'extra_headers'}) };
8442   #my @extra_fields  = @{ delete($sql_query->{'extra_fields'})  };
8443
8444
8445   my( $num, $last, $min_sec ) = (0, time, 5); #progresbar foo
8446
8447   #eventually order+limit magic to reduce memory use?
8448   foreach my $cust_main ( qsearch($sql_query) ) {
8449
8450     my $to = $cust_main->invoicing_list_emailonly_scalar;
8451     next unless $to;
8452
8453     my $error = send_email(
8454       generate_email(
8455         'from'      => $from,
8456         'to'        => $to,
8457         'subject'   => $subject,
8458         'html_body' => $html_body,
8459         'text_body' => $text_body,
8460       )
8461     );
8462     return $error if $error;
8463
8464     if ( $job ) { #progressbar foo
8465       $num++;
8466       if ( time - $min_sec > $last ) {
8467         my $error = $job->update_statustext(
8468           int( 100 * $num / $num_cust )
8469         );
8470         die $error if $error;
8471         $last = time;
8472       }
8473     }
8474
8475   }
8476
8477   return '';
8478 }
8479
8480 use Storable qw(thaw);
8481 use Data::Dumper;
8482 use MIME::Base64;
8483 sub process_email_search_sql {
8484   my $job = shift;
8485   #warn "$me process_re_X $method for job $job\n" if $DEBUG;
8486
8487   my $param = thaw(decode_base64(shift));
8488   warn Dumper($param) if $DEBUG;
8489
8490   $param->{'job'} = $job;
8491
8492   $param->{'payby'} = [ split(/\0/, $param->{'payby'}) ]
8493     unless ref($param->{'payby'});
8494
8495   my $error = FS::cust_main->email_search_sql( $param );
8496   die $error if $error;
8497
8498 }
8499
8500 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
8501
8502 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
8503 records.  Currently, I<first>, I<last>, I<company> and/or I<address1> may be
8504 specified (the appropriate ship_ field is also searched).
8505
8506 Additional options are the same as FS::Record::qsearch
8507
8508 =cut
8509
8510 sub fuzzy_search {
8511   my( $self, $fuzzy, $hash, @opt) = @_;
8512   #$self
8513   $hash ||= {};
8514   my @cust_main = ();
8515
8516   check_and_rebuild_fuzzyfiles();
8517   foreach my $field ( keys %$fuzzy ) {
8518
8519     my $all = $self->all_X($field);
8520     next unless scalar(@$all);
8521
8522     my %match = ();
8523     $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
8524
8525     my @fcust = ();
8526     foreach ( keys %match ) {
8527       push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
8528       push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
8529     }
8530     my %fsaw = ();
8531     push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
8532   }
8533
8534   # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
8535   my %saw = ();
8536   @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
8537
8538   @cust_main;
8539
8540 }
8541
8542 =item masked FIELD
8543
8544 Returns a masked version of the named field
8545
8546 =cut
8547
8548 sub masked {
8549 my ($self,$field) = @_;
8550
8551 # Show last four
8552
8553 'x'x(length($self->getfield($field))-4).
8554   substr($self->getfield($field), (length($self->getfield($field))-4));
8555
8556 }
8557
8558 =back
8559
8560 =head1 SUBROUTINES
8561
8562 =over 4
8563
8564 =item smart_search OPTION => VALUE ...
8565
8566 Accepts the following options: I<search>, the string to search for.  The string
8567 will be searched for as a customer number, phone number, name or company name,
8568 as an exact, or, in some cases, a substring or fuzzy match (see the source code
8569 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
8570 skip fuzzy matching when an exact match is found.
8571
8572 Any additional options are treated as an additional qualifier on the search
8573 (i.e. I<agentnum>).
8574
8575 Returns a (possibly empty) array of FS::cust_main objects.
8576
8577 =cut
8578
8579 sub smart_search {
8580   my %options = @_;
8581
8582   #here is the agent virtualization
8583   my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8584
8585   my @cust_main = ();
8586
8587   my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
8588   my $search = delete $options{'search'};
8589   ( my $alphanum_search = $search ) =~ s/\W//g;
8590
8591   if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
8592
8593     #false laziness w/Record::ut_phone
8594     my $phonen = "$1-$2-$3";
8595     $phonen .= " x$4" if $4;
8596
8597     push @cust_main, qsearch( {
8598       'table'   => 'cust_main',
8599       'hashref' => { %options },
8600       'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8601                      ' ( '.
8602                          join(' OR ', map "$_ = '$phonen'",
8603                                           qw( daytime night fax
8604                                               ship_daytime ship_night ship_fax )
8605                              ).
8606                      ' ) '.
8607                      " AND $agentnums_sql", #agent virtualization
8608     } );
8609
8610     unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
8611       #try looking for matches with extensions unless one was specified
8612
8613       push @cust_main, qsearch( {
8614         'table'   => 'cust_main',
8615         'hashref' => { %options },
8616         'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
8617                        ' ( '.
8618                            join(' OR ', map "$_ LIKE '$phonen\%'",
8619                                             qw( daytime night
8620                                                 ship_daytime ship_night )
8621                                ).
8622                        ' ) '.
8623                        " AND $agentnums_sql", #agent virtualization
8624       } );
8625
8626     }
8627
8628   # custnum search (also try agent_custid), with some tweaking options if your
8629   # legacy cust "numbers" have letters
8630   }
8631
8632   if ( $search =~ /^\s*(\d+)\s*$/
8633          || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
8634               && $search =~ /^\s*(\w\w?\d+)\s*$/
8635             )
8636          || ( $conf->exists('address1-search' )
8637               && $search =~ /^\s*(\d+\-?\w*)\s*$/ #i.e. 1234A or 9432-D
8638             )
8639      )
8640   {
8641
8642     my $num = $1;
8643
8644     if ( $num =~ /^(\d+)$/ && $num <= 2147483647 ) { #need a bigint custnum? wow
8645       push @cust_main, qsearch( {
8646         'table'     => 'cust_main',
8647         'hashref'   => { 'custnum' => $num, %options },
8648         'extra_sql' => " AND $agentnums_sql", #agent virtualization
8649       } );
8650     }
8651
8652     push @cust_main, qsearch( {
8653       'table'     => 'cust_main',
8654       'hashref'   => { 'agent_custid' => $num, %options },
8655       'extra_sql' => " AND $agentnums_sql", #agent virtualization
8656     } );
8657
8658     if ( $conf->exists('address1-search') ) {
8659       my $len = length($num);
8660       $num = lc($num);
8661       foreach my $prefix ( '', 'ship_' ) {
8662         push @cust_main, qsearch( {
8663           'table'     => 'cust_main',
8664           'hashref'   => { %options, },
8665           'extra_sql' =>
8666             ( keys(%options) ? ' AND ' : ' WHERE ' ).
8667             " LOWER(SUBSTRING(${prefix}address1 FROM 1 FOR $len)) = '$num' ".
8668             " AND $agentnums_sql",
8669         } );
8670       }
8671     }
8672
8673   } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
8674
8675     my($company, $last, $first) = ( $1, $2, $3 );
8676
8677     # "Company (Last, First)"
8678     #this is probably something a browser remembered,
8679     #so just do an exact (but case-insensitive) search
8680
8681     foreach my $prefix ( '', 'ship_' ) {
8682       push @cust_main, qsearch( {
8683         'table'     => 'cust_main',
8684         'hashref'   => { $prefix.'first'   => $first,
8685                          $prefix.'last'    => $last,
8686                          $prefix.'company' => $company,
8687                          %options,
8688                        },
8689         'extra_sql' => " AND $agentnums_sql",
8690       } );
8691     }
8692
8693   } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
8694                                               # try (ship_){last,company}
8695
8696     my $value = lc($1);
8697
8698     # # remove "(Last, First)" in "Company (Last, First)", otherwise the
8699     # # full strings the browser remembers won't work
8700     # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
8701
8702     use Lingua::EN::NameParse;
8703     my $NameParse = new Lingua::EN::NameParse(
8704              auto_clean     => 1,
8705              allow_reversed => 1,
8706     );
8707
8708     my($last, $first) = ( '', '' );
8709     #maybe disable this too and just rely on NameParse?
8710     if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
8711
8712       ($last, $first) = ( $1, $2 );
8713
8714     #} elsif  ( $value =~ /^(.+)\s+(.+)$/ ) {
8715     } elsif ( ! $NameParse->parse($value) ) {
8716
8717       my %name = $NameParse->components;
8718       $first = $name{'given_name_1'};
8719       $last  = $name{'surname_1'};
8720
8721     }
8722
8723     if ( $first && $last ) {
8724
8725       my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
8726
8727       #exact
8728       my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8729       $sql .= "
8730         (     ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
8731            OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
8732         )";
8733
8734       push @cust_main, qsearch( {
8735         'table'     => 'cust_main',
8736         'hashref'   => \%options,
8737         'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8738       } );
8739
8740       # or it just be something that was typed in... (try that in a sec)
8741
8742     }
8743
8744     my $q_value = dbh->quote($value);
8745
8746     #exact
8747     my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
8748     $sql .= " (    LOWER(last)          = $q_value
8749                 OR LOWER(company)       = $q_value
8750                 OR LOWER(ship_last)     = $q_value
8751                 OR LOWER(ship_company)  = $q_value
8752             ";
8753     $sql .= "   OR LOWER(address1)      = $q_value
8754                 OR LOWER(ship_address1) = $q_value
8755             "
8756       if $conf->exists('address1-search');
8757     $sql .= " )";
8758
8759     push @cust_main, qsearch( {
8760       'table'     => 'cust_main',
8761       'hashref'   => \%options,
8762       'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
8763     } );
8764
8765     #no exact match, trying substring/fuzzy
8766     #always do substring & fuzzy (unless they're explicity config'ed off)
8767     #getting complaints searches are not returning enough
8768     unless ( @cust_main  && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
8769
8770       #still some false laziness w/search_sql (was search/cust_main.cgi)
8771
8772       #substring
8773
8774       my @hashrefs = (
8775         { 'company'      => { op=>'ILIKE', value=>"%$value%" }, },
8776         { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
8777       );
8778
8779       if ( $first && $last ) {
8780
8781         push @hashrefs,
8782           { 'first'        => { op=>'ILIKE', value=>"%$first%" },
8783             'last'         => { op=>'ILIKE', value=>"%$last%" },
8784           },
8785           { 'ship_first'   => { op=>'ILIKE', value=>"%$first%" },
8786             'ship_last'    => { op=>'ILIKE', value=>"%$last%" },
8787           },
8788         ;
8789
8790       } else {
8791
8792         push @hashrefs,
8793           { 'last'         => { op=>'ILIKE', value=>"%$value%" }, },
8794           { 'ship_last'    => { op=>'ILIKE', value=>"%$value%" }, },
8795         ;
8796       }
8797
8798       if ( $conf->exists('address1-search') ) {
8799         push @hashrefs,
8800           { 'address1'      => { op=>'ILIKE', value=>"%$value%" }, },
8801           { 'ship_address1' => { op=>'ILIKE', value=>"%$value%" }, },
8802         ;
8803       }
8804
8805       foreach my $hashref ( @hashrefs ) {
8806
8807         push @cust_main, qsearch( {
8808           'table'     => 'cust_main',
8809           'hashref'   => { %$hashref,
8810                            %options,
8811                          },
8812           'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
8813         } );
8814
8815       }
8816
8817       #fuzzy
8818       my @fuzopts = (
8819         \%options,                #hashref
8820         '',                       #select
8821         " AND $agentnums_sql",    #extra_sql  #agent virtualization
8822       );
8823
8824       if ( $first && $last ) {
8825         push @cust_main, FS::cust_main->fuzzy_search(
8826           { 'last'   => $last,    #fuzzy hashref
8827             'first'  => $first }, #
8828           @fuzopts
8829         );
8830       }
8831       foreach my $field ( 'last', 'company' ) {
8832         push @cust_main,
8833           FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
8834       }
8835       if ( $conf->exists('address1-search') ) {
8836         push @cust_main,
8837           FS::cust_main->fuzzy_search( { 'address1' => $value }, @fuzopts );
8838       }
8839
8840     }
8841
8842   }
8843
8844   #eliminate duplicates
8845   my %saw = ();
8846   @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8847
8848   @cust_main;
8849
8850 }
8851
8852 =item email_search
8853
8854 Accepts the following options: I<email>, the email address to search for.  The
8855 email address will be searched for as an email invoice destination and as an
8856 svc_acct account.
8857
8858 #Any additional options are treated as an additional qualifier on the search
8859 #(i.e. I<agentnum>).
8860
8861 Returns a (possibly empty) array of FS::cust_main objects (but usually just
8862 none or one).
8863
8864 =cut
8865
8866 sub email_search {
8867   my %options = @_;
8868
8869   local($DEBUG) = 1;
8870
8871   my $email = delete $options{'email'};
8872
8873   #we're only being used by RT at the moment... no agent virtualization yet
8874   #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
8875
8876   my @cust_main = ();
8877
8878   if ( $email =~ /([^@]+)\@([^@]+)/ ) {
8879
8880     my ( $user, $domain ) = ( $1, $2 );
8881
8882     warn "$me smart_search: searching for $user in domain $domain"
8883       if $DEBUG;
8884
8885     push @cust_main,
8886       map $_->cust_main,
8887           qsearch( {
8888                      'table'     => 'cust_main_invoice',
8889                      'hashref'   => { 'dest' => $email },
8890                    }
8891                  );
8892
8893     push @cust_main,
8894       map  $_->cust_main,
8895       grep $_,
8896       map  $_->cust_svc->cust_pkg,
8897           qsearch( {
8898                      'table'     => 'svc_acct',
8899                      'hashref'   => { 'username' => $user, },
8900                      'extra_sql' =>
8901                        'AND ( SELECT domain FROM svc_domain
8902                                 WHERE svc_acct.domsvc = svc_domain.svcnum
8903                             ) = '. dbh->quote($domain),
8904                    }
8905                  );
8906   }
8907
8908   my %saw = ();
8909   @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
8910
8911   warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
8912     if $DEBUG;
8913
8914   @cust_main;
8915
8916 }
8917
8918 =item check_and_rebuild_fuzzyfiles
8919
8920 =cut
8921
8922 sub check_and_rebuild_fuzzyfiles {
8923   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8924   rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
8925 }
8926
8927 =item rebuild_fuzzyfiles
8928
8929 =cut
8930
8931 sub rebuild_fuzzyfiles {
8932
8933   use Fcntl qw(:flock);
8934
8935   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8936   mkdir $dir, 0700 unless -d $dir;
8937
8938   foreach my $fuzzy ( @fuzzyfields ) {
8939
8940     open(LOCK,">>$dir/cust_main.$fuzzy")
8941       or die "can't open $dir/cust_main.$fuzzy: $!";
8942     flock(LOCK,LOCK_EX)
8943       or die "can't lock $dir/cust_main.$fuzzy: $!";
8944
8945     open (CACHE,">$dir/cust_main.$fuzzy.tmp")
8946       or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
8947
8948     foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
8949       my $sth = dbh->prepare("SELECT $field FROM cust_main".
8950                              " WHERE $field != '' AND $field IS NOT NULL");
8951       $sth->execute or die $sth->errstr;
8952
8953       while ( my $row = $sth->fetchrow_arrayref ) {
8954         print CACHE $row->[0]. "\n";
8955       }
8956
8957     }
8958
8959     close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
8960
8961     rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
8962     close LOCK;
8963   }
8964
8965 }
8966
8967 =item all_X
8968
8969 =cut
8970
8971 sub all_X {
8972   my( $self, $field ) = @_;
8973   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8974   open(CACHE,"<$dir/cust_main.$field")
8975     or die "can't open $dir/cust_main.$field: $!";
8976   my @array = map { chomp; $_; } <CACHE>;
8977   close CACHE;
8978   \@array;
8979 }
8980
8981 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
8982
8983 =cut
8984
8985 sub append_fuzzyfiles {
8986   #my( $first, $last, $company ) = @_;
8987
8988   &check_and_rebuild_fuzzyfiles;
8989
8990   use Fcntl qw(:flock);
8991
8992   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
8993
8994   foreach my $field (@fuzzyfields) {
8995     my $value = shift;
8996
8997     if ( $value ) {
8998
8999       open(CACHE,">>$dir/cust_main.$field")
9000         or die "can't open $dir/cust_main.$field: $!";
9001       flock(CACHE,LOCK_EX)
9002         or die "can't lock $dir/cust_main.$field: $!";
9003
9004       print CACHE "$value\n";
9005
9006       flock(CACHE,LOCK_UN)
9007         or die "can't unlock $dir/cust_main.$field: $!";
9008       close CACHE;
9009     }
9010
9011   }
9012
9013   1;
9014 }
9015
9016 =item batch_charge
9017
9018 =cut
9019
9020 sub batch_charge {
9021   my $param = shift;
9022   #warn join('-',keys %$param);
9023   my $fh = $param->{filehandle};
9024   my @fields = @{$param->{fields}};
9025
9026   eval "use Text::CSV_XS;";
9027   die $@ if $@;
9028
9029   my $csv = new Text::CSV_XS;
9030   #warn $csv;
9031   #warn $fh;
9032
9033   my $imported = 0;
9034   #my $columns;
9035
9036   local $SIG{HUP} = 'IGNORE';
9037   local $SIG{INT} = 'IGNORE';
9038   local $SIG{QUIT} = 'IGNORE';
9039   local $SIG{TERM} = 'IGNORE';
9040   local $SIG{TSTP} = 'IGNORE';
9041   local $SIG{PIPE} = 'IGNORE';
9042
9043   my $oldAutoCommit = $FS::UID::AutoCommit;
9044   local $FS::UID::AutoCommit = 0;
9045   my $dbh = dbh;
9046
9047   #while ( $columns = $csv->getline($fh) ) {
9048   my $line;
9049   while ( defined($line=<$fh>) ) {
9050
9051     $csv->parse($line) or do {
9052       $dbh->rollback if $oldAutoCommit;
9053       return "can't parse: ". $csv->error_input();
9054     };
9055
9056     my @columns = $csv->fields();
9057     #warn join('-',@columns);
9058
9059     my %row = ();
9060     foreach my $field ( @fields ) {
9061       $row{$field} = shift @columns;
9062     }
9063
9064     my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
9065     unless ( $cust_main ) {
9066       $dbh->rollback if $oldAutoCommit;
9067       return "unknown custnum $row{'custnum'}";
9068     }
9069
9070     if ( $row{'amount'} > 0 ) {
9071       my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
9072       if ( $error ) {
9073         $dbh->rollback if $oldAutoCommit;
9074         return $error;
9075       }
9076       $imported++;
9077     } elsif ( $row{'amount'} < 0 ) {
9078       my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
9079                                       $row{'pkg'}                         );
9080       if ( $error ) {
9081         $dbh->rollback if $oldAutoCommit;
9082         return $error;
9083       }
9084       $imported++;
9085     } else {
9086       #hmm?
9087     }
9088
9089   }
9090
9091   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
9092
9093   return "Empty file!" unless $imported;
9094
9095   ''; #no error
9096
9097 }
9098
9099 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9100
9101 Sends a templated email notification to the customer (see L<Text::Template>).
9102
9103 OPTIONS is a hash and may include
9104
9105 I<from> - the email sender (default is invoice_from)
9106
9107 I<to> - comma-separated scalar or arrayref of recipients
9108    (default is invoicing_list)
9109
9110 I<subject> - The subject line of the sent email notification
9111    (default is "Notice from company_name")
9112
9113 I<extra_fields> - a hashref of name/value pairs which will be substituted
9114    into the template
9115
9116 The following variables are vavailable in the template.
9117
9118 I<$first> - the customer first name
9119 I<$last> - the customer last name
9120 I<$company> - the customer company
9121 I<$payby> - a description of the method of payment for the customer
9122             # would be nice to use FS::payby::shortname
9123 I<$payinfo> - the account information used to collect for this customer
9124 I<$expdate> - the expiration of the customer payment in seconds from epoch
9125
9126 =cut
9127
9128 sub notify {
9129   my ($self, $template, %options) = @_;
9130
9131   return unless $conf->exists($template);
9132
9133   my $from = $conf->config('invoice_from', $self->agentnum)
9134     if $conf->exists('invoice_from', $self->agentnum);
9135   $from = $options{from} if exists($options{from});
9136
9137   my $to = join(',', $self->invoicing_list_emailonly);
9138   $to = $options{to} if exists($options{to});
9139
9140   my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
9141     if $conf->exists('company_name', $self->agentnum);
9142   $subject = $options{subject} if exists($options{subject});
9143
9144   my $notify_template = new Text::Template (TYPE => 'ARRAY',
9145                                             SOURCE => [ map "$_\n",
9146                                               $conf->config($template)]
9147                                            )
9148     or die "can't create new Text::Template object: Text::Template::ERROR";
9149   $notify_template->compile()
9150     or die "can't compile template: Text::Template::ERROR";
9151
9152   $FS::notify_template::_template::company_name =
9153     $conf->config('company_name', $self->agentnum);
9154   $FS::notify_template::_template::company_address =
9155     join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
9156
9157   my $paydate = $self->paydate || '2037-12-31';
9158   $FS::notify_template::_template::first = $self->first;
9159   $FS::notify_template::_template::last = $self->last;
9160   $FS::notify_template::_template::company = $self->company;
9161   $FS::notify_template::_template::payinfo = $self->mask_payinfo;
9162   my $payby = $self->payby;
9163   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9164   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9165
9166   #credit cards expire at the end of the month/year of their exp date
9167   if ($payby eq 'CARD' || $payby eq 'DCRD') {
9168     $FS::notify_template::_template::payby = 'credit card';
9169     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9170     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9171     $expire_time--;
9172   }elsif ($payby eq 'COMP') {
9173     $FS::notify_template::_template::payby = 'complimentary account';
9174   }else{
9175     $FS::notify_template::_template::payby = 'current method';
9176   }
9177   $FS::notify_template::_template::expdate = $expire_time;
9178
9179   for (keys %{$options{extra_fields}}){
9180     no strict "refs";
9181     ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
9182   }
9183
9184   send_email(from => $from,
9185              to => $to,
9186              subject => $subject,
9187              body => $notify_template->fill_in( PACKAGE =>
9188                                                 'FS::notify_template::_template'                                              ),
9189             );
9190
9191 }
9192
9193 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
9194
9195 Generates a templated notification to the customer (see L<Text::Template>).
9196
9197 OPTIONS is a hash and may include
9198
9199 I<extra_fields> - a hashref of name/value pairs which will be substituted
9200    into the template.  These values may override values mentioned below
9201    and those from the customer record.
9202
9203 The following variables are available in the template instead of or in addition
9204 to the fields of the customer record.
9205
9206 I<$payby> - a description of the method of payment for the customer
9207             # would be nice to use FS::payby::shortname
9208 I<$payinfo> - the masked account information used to collect for this customer
9209 I<$expdate> - the expiration of the customer payment method in seconds from epoch
9210 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
9211
9212 =cut
9213
9214 sub generate_letter {
9215   my ($self, $template, %options) = @_;
9216
9217   return unless $conf->exists($template);
9218
9219   my $letter_template = new Text::Template
9220                         ( TYPE       => 'ARRAY',
9221                           SOURCE     => [ map "$_\n", $conf->config($template)],
9222                           DELIMITERS => [ '[@--', '--@]' ],
9223                         )
9224     or die "can't create new Text::Template object: Text::Template::ERROR";
9225
9226   $letter_template->compile()
9227     or die "can't compile template: Text::Template::ERROR";
9228
9229   my %letter_data = map { $_ => $self->$_ } $self->fields;
9230   $letter_data{payinfo} = $self->mask_payinfo;
9231
9232   #my $paydate = $self->paydate || '2037-12-31';
9233   my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
9234
9235   my $payby = $self->payby;
9236   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
9237   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
9238
9239   #credit cards expire at the end of the month/year of their exp date
9240   if ($payby eq 'CARD' || $payby eq 'DCRD') {
9241     $letter_data{payby} = 'credit card';
9242     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
9243     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
9244     $expire_time--;
9245   }elsif ($payby eq 'COMP') {
9246     $letter_data{payby} = 'complimentary account';
9247   }else{
9248     $letter_data{payby} = 'current method';
9249   }
9250   $letter_data{expdate} = $expire_time;
9251
9252   for (keys %{$options{extra_fields}}){
9253     $letter_data{$_} = $options{extra_fields}->{$_};
9254   }
9255
9256   unless(exists($letter_data{returnaddress})){
9257     my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
9258                                                   $self->agent_template)
9259                      );
9260     if ( length($retadd) ) {
9261       $letter_data{returnaddress} = $retadd;
9262     } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
9263       $letter_data{returnaddress} =
9264         join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
9265                           $conf->config('company_address', $self->agentnum)
9266         );
9267     } else {
9268       $letter_data{returnaddress} = '~';
9269     }
9270   }
9271
9272   $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
9273
9274   $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
9275
9276   my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
9277   my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
9278                            DIR      => $dir,
9279                            SUFFIX   => '.tex',
9280                            UNLINK   => 0,
9281                          ) or die "can't open temp file: $!\n";
9282
9283   $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
9284   close $fh;
9285   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
9286   return $1;
9287 }
9288
9289 =item print_ps TEMPLATE
9290
9291 Returns an postscript letter filled in from TEMPLATE, as a scalar.
9292
9293 =cut
9294
9295 sub print_ps {
9296   my $self = shift;
9297   my $file = $self->generate_letter(@_);
9298   FS::Misc::generate_ps($file);
9299 }
9300
9301 =item print TEMPLATE
9302
9303 Prints the filled in template.
9304
9305 TEMPLATE is the name of a L<Text::Template> to fill in and print.
9306
9307 =cut
9308
9309 sub queueable_print {
9310   my %opt = @_;
9311
9312   my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
9313     or die "invalid customer number: " . $opt{custvnum};
9314
9315   my $error = $self->print( $opt{template} );
9316   die $error if $error;
9317 }
9318
9319 sub print {
9320   my ($self, $template) = (shift, shift);
9321   do_print [ $self->print_ps($template) ];
9322 }
9323
9324 #these three subs should just go away once agent stuff is all config overrides
9325
9326 sub agent_template {
9327   my $self = shift;
9328   $self->_agent_plandata('agent_templatename');
9329 }
9330
9331 sub agent_invoice_from {
9332   my $self = shift;
9333   $self->_agent_plandata('agent_invoice_from');
9334 }
9335
9336 sub _agent_plandata {
9337   my( $self, $option ) = @_;
9338
9339   #yuck.  this whole thing needs to be reconciled better with 1.9's idea of
9340   #agent-specific Conf
9341
9342   use FS::part_event::Condition;
9343
9344   my $agentnum = $self->agentnum;
9345
9346   my $regexp = '';
9347   if ( driver_name =~ /^Pg/i ) {
9348     $regexp = '~';
9349   } elsif ( driver_name =~ /^mysql/i ) {
9350     $regexp = 'REGEXP';
9351   } else {
9352     die "don't know how to use regular expressions in ". driver_name. " databases";
9353   }
9354
9355   my $part_event_option =
9356     qsearchs({
9357       'select'    => 'part_event_option.*',
9358       'table'     => 'part_event_option',
9359       'addl_from' => q{
9360         LEFT JOIN part_event USING ( eventpart )
9361         LEFT JOIN part_event_option AS peo_agentnum
9362           ON ( part_event.eventpart = peo_agentnum.eventpart
9363                AND peo_agentnum.optionname = 'agentnum'
9364                AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
9365              )
9366         LEFT JOIN part_event_condition
9367           ON ( part_event.eventpart = part_event_condition.eventpart
9368                AND part_event_condition.conditionname = 'cust_bill_age'
9369              )
9370         LEFT JOIN part_event_condition_option
9371           ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
9372                AND part_event_condition_option.optionname = 'age'
9373              )
9374       },
9375       #'hashref'   => { 'optionname' => $option },
9376       #'hashref'   => { 'part_event_option.optionname' => $option },
9377       'extra_sql' =>
9378         " WHERE part_event_option.optionname = ". dbh->quote($option).
9379         " AND action = 'cust_bill_send_agent' ".
9380         " AND ( disabled IS NULL OR disabled != 'Y' ) ".
9381         " AND peo_agentnum.optionname = 'agentnum' ".
9382         " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
9383         " ORDER BY
9384            CASE WHEN part_event_condition_option.optionname IS NULL
9385            THEN -1
9386            ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
9387         " END
9388           , part_event.weight".
9389         " LIMIT 1"
9390     });
9391
9392   unless ( $part_event_option ) {
9393     return $self->agent->invoice_template || ''
9394       if $option eq 'agent_templatename';
9395     return '';
9396   }
9397
9398   $part_event_option->optionvalue;
9399
9400 }
9401
9402 sub queued_bill {
9403   ## actual sub, not a method, designed to be called from the queue.
9404   ## sets up the customer, and calls the bill_and_collect
9405   my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
9406   my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
9407       $cust_main->bill_and_collect(
9408         %args,
9409       );
9410 }
9411
9412 sub _upgrade_data { #class method
9413   my ($class, %opts) = @_;
9414
9415   my $sql = 'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL';
9416   my $sth = dbh->prepare($sql) or die dbh->errstr;
9417   $sth->execute or die $sth->errstr;
9418
9419 }
9420
9421 =back
9422
9423 =head1 BUGS
9424
9425 The delete method.
9426
9427 The delete method should possibly take an FS::cust_main object reference
9428 instead of a scalar customer number.
9429
9430 Bill and collect options should probably be passed as references instead of a
9431 list.
9432
9433 There should probably be a configuration file with a list of allowed credit
9434 card types.
9435
9436 No multiple currency support (probably a larger project than just this module).
9437
9438 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
9439
9440 Birthdates rely on negative epoch values.
9441
9442 The payby for card/check batches is broken.  With mixed batching, bad
9443 things will happen.
9444
9445 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
9446
9447 =head1 SEE ALSO
9448
9449 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
9450 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
9451 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
9452
9453 =cut
9454
9455 1;
9456