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 @encrypted_fields
   6              $import $skip_fuzzyfiles $ignore_expired_card @paytypes);
   7 use vars qw( $realtime_bop_decline_quiet ); #ugh
   8 use Safe;
   9 use Carp;
  10 use Exporter;
  11 use Time::Local qw(timelocal_nocheck);
  12 use Data::Dumper;
  13 use Tie::IxHash;
  14 use Digest::MD5 qw(md5_base64);
  15 use Date::Format;
  16 use Date::Parse;
  17 #use Date::Manip;
  18 use String::Approx qw(amatch);
  19 use Business::CreditCard 0.28;
  20 use Locale::Country;
  21 use Data::Dumper;
  22 use FS::UID qw( getotaker dbh );
  23 use FS::Record qw( qsearchs qsearch dbdef );
  24 use FS::Misc qw( send_email generate_ps do_print );
  25 use FS::Msgcat qw(gettext);
  26 use FS::cust_pkg;
  27 use FS::cust_svc;
  28 use FS::cust_bill;
  29 use FS::cust_bill_pkg;
  30 use FS::cust_pay;
  31 use FS::cust_pay_void;
  32 use FS::cust_pay_batch;
  33 use FS::cust_credit;
  34 use FS::cust_refund;
  35 use FS::part_referral;
  36 use FS::cust_main_county;
  37 use FS::agent;
  38 use FS::cust_main_invoice;
  39 use FS::cust_credit_bill;
  40 use FS::cust_bill_pay;
  41 use FS::prepay_credit;
  42 use FS::queue;
  43 use FS::part_pkg;
  44 use FS::part_event;
  45 use FS::part_event_condition;
  46 #use FS::cust_event;
  47 use FS::cust_tax_exempt;
  48 use FS::cust_tax_exempt_pkg;
  49 use FS::type_pkgs;
  50 use FS::payment_gateway;
  51 use FS::agent_payment_gateway;
  52 use FS::banned_pay;
  53 use FS::payinfo_Mixin;
  54 use FS::TicketSystem;
  55
  56 @ISA = qw( FS::Record FS::payinfo_Mixin );
  57
  58 @EXPORT_OK = qw( smart_search );
  59
  60 $realtime_bop_decline_quiet = 0;
  61
  62 # 1 is mostly method/subroutine entry and options
  63 # 2 traces progress of some operations
  64 # 3 is even more information including possibly sensitive data
  65 $DEBUG = 0;
  66 $me = '[FS::cust_main]';
  67
  68 $import = 0;
  69 $skip_fuzzyfiles = 0;
  70 $ignore_expired_card = 0;
  71
  72 @encrypted_fields = ('payinfo', 'paycvv');
  73 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
  74
  75 #ask FS::UID to run this stuff for us later
  76 #$FS::UID::callback{'FS::cust_main'} = sub {
  77 install_callback FS::UID sub {
  78   $conf = new FS::Conf;
  79   #yes, need it for stuff below (prolly should be cached)
  80 };
  81
  82 sub _cache {
  83   my $self = shift;
  84   my ( $hashref, $cache ) = @_;
  85   if ( exists $hashref->{'pkgnum'} ) {
  86     #@{ $self->{'_pkgnum'} } = ();
  87     my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
  88     $self->{'_pkgnum'} = $subcache;
  89     #push @{ $self->{'_pkgnum'} },
  90     FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
  91   }
  92 }
  93
  94 =head1 NAME
  95
  96 FS::cust_main - Object methods for cust_main records
  97
  98 =head1 SYNOPSIS
  99
 100   use FS::cust_main;
 101
 102   $record = new FS::cust_main \%hash;
 103   $record = new FS::cust_main { 'column' => 'value' };
 104
 105   $error = $record->insert;
 106
 107   $error = $new_record->replace($old_record);
 108
 109   $error = $record->delete;
 110
 111   $error = $record->check;
 112
 113   @cust_pkg = $record->all_pkgs;
 114
 115   @cust_pkg = $record->ncancelled_pkgs;
 116
 117   @cust_pkg = $record->suspended_pkgs;
 118
 119   $error = $record->bill;
 120   $error = $record->bill %options;
 121   $error = $record->bill 'time' => $time;
 122
 123   $error = $record->collect;
 124   $error = $record->collect %options;
 125   $error = $record->collect 'invoice_time'   => $time,
 126                           ;
 127
 128 =head1 DESCRIPTION
 129
 130 An FS::cust_main object represents a customer.  FS::cust_main inherits from
 131 FS::Record.  The following fields are currently supported:
 132
 133 =over 4
 134
 135 =item custnum - primary key (assigned automatically for new customers)
 136
 137 =item agentnum - agent (see L<FS::agent>)
 138
 139 =item refnum - Advertising source (see L<FS::part_referral>)
 140
 141 =item first - name
 142
 143 =item last - name
 144
 145 =item ss - social security number (optional)
 146
 147 =item company - (optional)
 148
 149 =item address1
 150
 151 =item address2 - (optional)
 152
 153 =item city
 154
 155 =item county - (optional, see L<FS::cust_main_county>)
 156
 157 =item state - (see L<FS::cust_main_county>)
 158
 159 =item zip
 160
 161 =item country - (see L<FS::cust_main_county>)
 162
 163 =item daytime - phone (optional)
 164
 165 =item night - phone (optional)
 166
 167 =item fax - phone (optional)
 168
 169 =item ship_first - name
 170
 171 =item ship_last - name
 172
 173 =item ship_company - (optional)
 174
 175 =item ship_address1
 176
 177 =item ship_address2 - (optional)
 178
 179 =item ship_city
 180
 181 =item ship_county - (optional, see L<FS::cust_main_county>)
 182
 183 =item ship_state - (see L<FS::cust_main_county>)
 184
 185 =item ship_zip
 186
 187 =item ship_country - (see L<FS::cust_main_county>)
 188
 189 =item ship_daytime - phone (optional)
 190
 191 =item ship_night - phone (optional)
 192
 193 =item ship_fax - phone (optional)
 194
 195 =item payby - Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
 196
 197 =item payinfo - Payment Information (See L<FS::payinfo_Mixin> for data format)
 198
 199 =item paymask - Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
 200
 201 =item paycvv
 202
 203 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
 204
 205 =item paydate - expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
 206
 207 =item paystart_month - start date month (maestro/solo cards only)
 208
 209 =item paystart_year - start date year (maestro/solo cards only)
 210
 211 =item payissue - issue number (maestro/solo cards only)
 212
 213 =item payname - name on card or billing name
 214
 215 =item payip - IP address from which payment information was received
 216
 217 =item tax - tax exempt, empty or `Y'
 218
 219 =item otaker - order taker (assigned automatically, see L<FS::UID>)
 220
 221 =item comments - comments (optional)
 222
 223 =item referral_custnum - referring customer number
 224
 225 =item spool_cdr - Enable individual CDR spooling, empty or `Y'
 226
 227 =back
 228
 229 =head1 METHODS
 230
 231 =over 4
 232
 233 =item new HASHREF
 234
 235 Creates a new customer.  To add the customer to the database, see L<"insert">.
 236
 237 Note that this stores the hash reference, not a distinct copy of the hash it
 238 points to.  You can ask the object for a copy with the I<hash> method.
 239
 240 =cut
 241
 242 sub table { 'cust_main'; }
 243
 244 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
 245
 246 Adds this customer to the database.  If there is an error, returns the error,
 247 otherwise returns false.
 248
 249 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
 250 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
 251 are inserted atomicly, or the transaction is rolled back.  Passing an empty
 252 hash reference is equivalent to not supplying this parameter.  There should be
 253 a better explanation of this, but until then, here's an example:
 254
 255   use Tie::RefHash;
 256   tie %hash, 'Tie::RefHash'; #this part is important
 257   %hash = (
 258     $cust_pkg => [ $svc_acct ],
 259     ...
 260   );
 261   $cust_main->insert( \%hash );
 262
 263 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
 264 be set as the invoicing list (see L<"invoicing_list">).  Errors return as
 265 expected and rollback the entire transaction; it is not necessary to call
 266 check_invoicing_list first.  The invoicing_list is set after the records in the
 267 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
 268 invoicing_list destination to the newly-created svc_acct.  Here's an example:
 269
 270   $cust_main->insert( {}, [ $email, 'POST' ] );
 271
 272 Currently available options are: I<depend_jobnum> and I<noexport>.
 273
 274 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
 275 on the supplied jobnum (they will not run until the specific job completes).
 276 This can be used to defer provisioning until some action completes (such
 277 as running the customer's credit card successfully).
 278
 279 The I<noexport> option is deprecated.  If I<noexport> is set true, no
 280 provisioning jobs (exports) are scheduled.  (You can schedule them later with
 281 the B<reexport> method.)
 282
 283 =cut
 284
 285 sub insert {
 286   my $self = shift;
 287   my $cust_pkgs = @_ ? shift : {};
 288   my $invoicing_list = @_ ? shift : '';
 289   my %options = @_;
 290   warn "$me insert called with options ".
 291        join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
 292     if $DEBUG;
 293
 294   local $SIG{HUP} = 'IGNORE';
 295   local $SIG{INT} = 'IGNORE';
 296   local $SIG{QUIT} = 'IGNORE';
 297   local $SIG{TERM} = 'IGNORE';
 298   local $SIG{TSTP} = 'IGNORE';
 299   local $SIG{PIPE} = 'IGNORE';
 300
 301   my $oldAutoCommit = $FS::UID::AutoCommit;
 302   local $FS::UID::AutoCommit = 0;
 303   my $dbh = dbh;
 304
 305   my $prepay_identifier = '';
 306   my( $amount, $seconds ) = ( 0, 0 );
 307   my $payby = '';
 308   if ( $self->payby eq 'PREPAY' ) {
 309
 310     $self->payby('BILL');
 311     $prepay_identifier = $self->payinfo;
 312     $self->payinfo('');
 313
 314     warn "  looking up prepaid card $prepay_identifier\n"
 315       if $DEBUG > 1;
 316
 317     my $error = $self->get_prepay($prepay_identifier, \$amount, \$seconds);
 318     if ( $error ) {
 319       $dbh->rollback if $oldAutoCommit;
 320       #return "error applying prepaid card (transaction rolled back): $error";
 321       return $error;
 322     }
 323
 324     $payby = 'PREP' if $amount;
 325
 326   } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
 327
 328     $payby = $1;
 329     $self->payby('BILL');
 330     $amount = $self->paid;
 331
 332   }
 333
 334   warn "  inserting $self\n"
 335     if $DEBUG > 1;
 336
 337   $self->signupdate(time) unless $self->signupdate;
 338
 339   my $error = $self->SUPER::insert;
 340   if ( $error ) {
 341     $dbh->rollback if $oldAutoCommit;
 342     #return "inserting cust_main record (transaction rolled back): $error";
 343     return $error;
 344   }
 345
 346   warn "  setting invoicing list\n"
 347     if $DEBUG > 1;
 348
 349   if ( $invoicing_list ) {
 350     $error = $self->check_invoicing_list( $invoicing_list );
 351     if ( $error ) {
 352       $dbh->rollback if $oldAutoCommit;
 353       #return "checking invoicing_list (transaction rolled back): $error";
 354       return $error;
 355     }
 356     $self->invoicing_list( $invoicing_list );
 357   }
 358
 359   if (    $conf->config('cust_main-skeleton_tables')
 360        && $conf->config('cust_main-skeleton_custnum') ) {
 361
 362     warn "  inserting skeleton records\n"
 363       if $DEBUG > 1;
 364
 365     my $error = $self->start_copy_skel;
 366     if ( $error ) {
 367       $dbh->rollback if $oldAutoCommit;
 368       return $error;
 369     }
 370
 371   }
 372
 373   warn "  ordering packages\n"
 374     if $DEBUG > 1;
 375
 376   $error = $self->order_pkgs($cust_pkgs, \$seconds, %options);
 377   if ( $error ) {
 378     $dbh->rollback if $oldAutoCommit;
 379     return $error;
 380   }
 381
 382   if ( $seconds ) {
 383     $dbh->rollback if $oldAutoCommit;
 384     return "No svc_acct record to apply pre-paid time";
 385   }
 386
 387   if ( $amount ) {
 388     warn "  inserting initial $payby payment of $amount\n"
 389       if $DEBUG > 1;
 390     $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
 391     if ( $error ) {
 392       $dbh->rollback if $oldAutoCommit;
 393       return "inserting payment (transaction rolled back): $error";
 394     }
 395   }
 396
 397   unless ( $import || $skip_fuzzyfiles ) {
 398     warn "  queueing fuzzyfiles update\n"
 399       if $DEBUG > 1;
 400     $error = $self->queue_fuzzyfiles_update;
 401     if ( $error ) {
 402       $dbh->rollback if $oldAutoCommit;
 403       return "updating fuzzy search cache: $error";
 404     }
 405   }
 406
 407   warn "  insert complete; committing transaction\n"
 408     if $DEBUG > 1;
 409
 410   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 411   '';
 412
 413 }
 414
 415 sub start_copy_skel {
 416   my $self = shift;
 417
 418   #'mg_user_preference' => {},
 419   #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
 420   #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
 421   #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
 422   #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
 423   my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
 424   die $@ if $@;
 425
 426   _copy_skel( 'cust_main',                                 #tablename
 427               $conf->config('cust_main-skeleton_custnum'), #sourceid
 428               $self->custnum,                              #destid
 429               @tables,                                     #child tables
 430             );
 431 }
 432
 433 #recursive subroutine, not a method
 434 sub _copy_skel {
 435   my( $table, $sourceid, $destid, %child_tables ) = @_;
 436
 437   my $primary_key;
 438   if ( $table =~ /^(\w+)\.(\w+)$/ ) {
 439     ( $table, $primary_key ) = ( $1, $2 );
 440   } else {
 441     my $dbdef_table = dbdef->table($table);
 442     $primary_key = $dbdef_table->primary_key
 443       or return "$table has no primary key".
 444                 " (or do you need to run dbdef-create?)";
 445   }
 446
 447   warn "  _copy_skel: $table.$primary_key $sourceid to $destid for ".
 448        join (', ', keys %child_tables). "\n"
 449     if $DEBUG > 2;
 450
 451   foreach my $child_table_def ( keys %child_tables ) {
 452
 453     my $child_table;
 454     my $child_pkey = '';
 455     if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
 456       ( $child_table, $child_pkey ) = ( $1, $2 );
 457     } else {
 458       $child_table = $child_table_def;
 459
 460       $child_pkey = dbdef->table($child_table)->primary_key;
 461       #  or return "$table has no primary key".
 462       #            " (or do you need to run dbdef-create?)\n";
 463     }
 464
 465     my $sequence = '';
 466     if ( keys %{ $child_tables{$child_table_def} } ) {
 467
 468       return "$child_table has no primary key".
 469              " (run dbdef-create or try specifying it?)\n"
 470         unless $child_pkey;
 471
 472       #false laziness w/Record::insert and only works on Pg
 473       #refactor the proper last-inserted-id stuff out of Record::insert if this
 474       # ever gets use for anything besides a quick kludge for one customer
 475       my $default = dbdef->table($child_table)->column($child_pkey)->default;
 476       $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
 477         or return "can't parse $child_table.$child_pkey default value ".
 478                   " for sequence name: $default";
 479       $sequence = $1;
 480
 481     }
 482
 483     my @sel_columns = grep { $_ ne $primary_key }
 484                            dbdef->table($child_table)->columns;
 485     my $sel_columns = join(', ', @sel_columns );
 486
 487     my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
 488     my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
 489     my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
 490
 491     my $sel_st = "SELECT $sel_columns FROM $child_table".
 492                  " WHERE $primary_key = $sourceid";
 493     warn "    $sel_st\n"
 494       if $DEBUG > 2;
 495     my $sel_sth = dbh->prepare( $sel_st )
 496       or return dbh->errstr;
 497
 498     $sel_sth->execute or return $sel_sth->errstr;
 499
 500     while ( my $row = $sel_sth->fetchrow_hashref ) {
 501
 502       warn "    selected row: ".
 503            join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
 504         if $DEBUG > 2;
 505
 506       my $statement =
 507         "INSERT INTO $child_table $ins_columns VALUES $placeholders";
 508       my $ins_sth =dbh->prepare($statement)
 509           or return dbh->errstr;
 510       my @param = ( $destid, map $row->{$_}, @ins_columns );
 511       warn "    $statement: [ ". join(', ', @param). " ]\n"
 512         if $DEBUG > 2;
 513       $ins_sth->execute( @param )
 514         or return $ins_sth->errstr;
 515
 516       #next unless keys %{ $child_tables{$child_table} };
 517       next unless $sequence;
 518
 519       #another section of that laziness
 520       my $seq_sql = "SELECT currval('$sequence')";
 521       my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
 522       $seq_sth->execute or return $seq_sth->errstr;
 523       my $insertid = $seq_sth->fetchrow_arrayref->[0];
 524
 525       # don't drink soap!  recurse!  recurse!  okay!
 526       my $error =
 527         _copy_skel( $child_table_def,
 528                     $row->{$child_pkey}, #sourceid
 529                     $insertid, #destid
 530                     %{ $child_tables{$child_table_def} },
 531                   );
 532       return $error if $error;
 533
 534     }
 535
 536   }
 537
 538   return '';
 539
 540 }
 541
 542 =item order_pkgs HASHREF, [ SECONDSREF, [ , OPTION => VALUE ... ] ]
 543
 544 Like the insert method on an existing record, this method orders a package
 545 and included services atomicaly.  Pass a Tie::RefHash data structure to this
 546 method containing FS::cust_pkg and FS::svc_I<tablename> objects.  There should
 547 be a better explanation of this, but until then, here's an example:
 548
 549   use Tie::RefHash;
 550   tie %hash, 'Tie::RefHash'; #this part is important
 551   %hash = (
 552     $cust_pkg => [ $svc_acct ],
 553     ...
 554   );
 555   $cust_main->order_pkgs( \%hash, \'0', 'noexport'=>1 );
 556
 557 Services can be new, in which case they are inserted, or existing unaudited
 558 services, in which case they are linked to the newly-created package.
 559
 560 Currently available options are: I<depend_jobnum> and I<noexport>.
 561
 562 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
 563 on the supplied jobnum (they will not run until the specific job completes).
 564 This can be used to defer provisioning until some action completes (such
 565 as running the customer's credit card successfully).
 566
 567 The I<noexport> option is deprecated.  If I<noexport> is set true, no
 568 provisioning jobs (exports) are scheduled.  (You can schedule them later with
 569 the B<reexport> method for each cust_pkg object.  Using the B<reexport> method
 570 on the cust_main object is not recommended, as existing services will also be
 571 reexported.)
 572
 573 =cut
 574
 575 sub order_pkgs {
 576   my $self = shift;
 577   my $cust_pkgs = shift;
 578   my $seconds = shift;
 579   my %options = @_;
 580   my %svc_options = ();
 581   $svc_options{'depend_jobnum'} = $options{'depend_jobnum'}
 582     if exists $options{'depend_jobnum'};
 583   warn "$me order_pkgs called with options ".
 584        join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
 585     if $DEBUG;
 586
 587   local $SIG{HUP} = 'IGNORE';
 588   local $SIG{INT} = 'IGNORE';
 589   local $SIG{QUIT} = 'IGNORE';
 590   local $SIG{TERM} = 'IGNORE';
 591   local $SIG{TSTP} = 'IGNORE';
 592   local $SIG{PIPE} = 'IGNORE';
 593
 594   my $oldAutoCommit = $FS::UID::AutoCommit;
 595   local $FS::UID::AutoCommit = 0;
 596   my $dbh = dbh;
 597
 598   local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
 599
 600   foreach my $cust_pkg ( keys %$cust_pkgs ) {
 601     $cust_pkg->custnum( $self->custnum );
 602     my $error = $cust_pkg->insert;
 603     if ( $error ) {
 604       $dbh->rollback if $oldAutoCommit;
 605       return "inserting cust_pkg (transaction rolled back): $error";
 606     }
 607     foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
 608       if ( $svc_something->svcnum ) {
 609         my $old_cust_svc = $svc_something->cust_svc;
 610         my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
 611         $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
 612         $error = $new_cust_svc->replace($old_cust_svc);
 613       } else {
 614         $svc_something->pkgnum( $cust_pkg->pkgnum );
 615         if ( $seconds && $$seconds && $svc_something->isa('FS::svc_acct') ) {
 616           $svc_something->seconds( $svc_something->seconds + $$seconds );
 617           $$seconds = 0;
 618         }
 619         $error = $svc_something->insert(%svc_options);
 620       }
 621       if ( $error ) {
 622         $dbh->rollback if $oldAutoCommit;
 623         #return "inserting svc_ (transaction rolled back): $error";
 624         return $error;
 625       }
 626     }
 627   }
 628
 629   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 630   ''; #no error
 631 }
 632
 633 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
 634
 635 Recharges this (existing) customer with the specified prepaid card (see
 636 L<FS::prepay_credit>), specified either by I<identifier> or as an
 637 FS::prepay_credit object.  If there is an error, returns the error, otherwise
 638 returns false.
 639
 640 Optionally, four scalar references can be passed as well.  They will have their
 641 values filled in with the amount, number of seconds, and number of upload and
 642 download bytes applied by this prepaid
 643 card.
 644
 645 =cut
 646
 647 sub recharge_prepay {
 648   my( $self, $prepay_credit, $amountref, $secondsref,
 649       $upbytesref, $downbytesref, $totalbytesref ) = @_;
 650
 651   local $SIG{HUP} = 'IGNORE';
 652   local $SIG{INT} = 'IGNORE';
 653   local $SIG{QUIT} = 'IGNORE';
 654   local $SIG{TERM} = 'IGNORE';
 655   local $SIG{TSTP} = 'IGNORE';
 656   local $SIG{PIPE} = 'IGNORE';
 657
 658   my $oldAutoCommit = $FS::UID::AutoCommit;
 659   local $FS::UID::AutoCommit = 0;
 660   my $dbh = dbh;
 661
 662   my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
 663
 664   my $error = $self->get_prepay($prepay_credit, \$amount,
 665                                 \$seconds, \$upbytes, \$downbytes, \$totalbytes)
 666            || $self->increment_seconds($seconds)
 667            || $self->increment_upbytes($upbytes)
 668            || $self->increment_downbytes($downbytes)
 669            || $self->increment_totalbytes($totalbytes)
 670            || $self->insert_cust_pay_prepay( $amount,
 671                                              ref($prepay_credit)
 672                                                ? $prepay_credit->identifier
 673                                                : $prepay_credit
 674                                            );
 675
 676   if ( $error ) {
 677     $dbh->rollback if $oldAutoCommit;
 678     return $error;
 679   }
 680
 681   if ( defined($amountref)  ) { $$amountref  = $amount;  }
 682   if ( defined($secondsref) ) { $$secondsref = $seconds; }
 683   if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
 684   if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
 685   if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
 686
 687   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 688   '';
 689
 690 }
 691
 692 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ , AMOUNTREF, SECONDSREF
 693
 694 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
 695 specified either by I<identifier> or as an FS::prepay_credit object.
 696
 697 References to I<amount> and I<seconds> scalars should be passed as arguments
 698 and will be incremented by the values of the prepaid card.
 699
 700 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
 701 check or set this customer's I<agentnum>.
 702
 703 If there is an error, returns the error, otherwise returns false.
 704
 705 =cut
 706
 707
 708 sub get_prepay {
 709   my( $self, $prepay_credit, $amountref, $secondsref,
 710       $upref, $downref, $totalref) = @_;
 711
 712   local $SIG{HUP} = 'IGNORE';
 713   local $SIG{INT} = 'IGNORE';
 714   local $SIG{QUIT} = 'IGNORE';
 715   local $SIG{TERM} = 'IGNORE';
 716   local $SIG{TSTP} = 'IGNORE';
 717   local $SIG{PIPE} = 'IGNORE';
 718
 719   my $oldAutoCommit = $FS::UID::AutoCommit;
 720   local $FS::UID::AutoCommit = 0;
 721   my $dbh = dbh;
 722
 723   unless ( ref($prepay_credit) ) {
 724
 725     my $identifier = $prepay_credit;
 726
 727     $prepay_credit = qsearchs(
 728       'prepay_credit',
 729       { 'identifier' => $prepay_credit },
 730       '',
 731       'FOR UPDATE'
 732     );
 733
 734     unless ( $prepay_credit ) {
 735       $dbh->rollback if $oldAutoCommit;
 736       return "Invalid prepaid card: ". $identifier;
 737     }
 738
 739   }
 740
 741   if ( $prepay_credit->agentnum ) {
 742     if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
 743       $dbh->rollback if $oldAutoCommit;
 744       return "prepaid card not valid for agent ". $self->agentnum;
 745     }
 746     $self->agentnum($prepay_credit->agentnum);
 747   }
 748
 749   my $error = $prepay_credit->delete;
 750   if ( $error ) {
 751     $dbh->rollback if $oldAutoCommit;
 752     return "removing prepay_credit (transaction rolled back): $error";
 753   }
 754
 755   $$amountref  += $prepay_credit->amount;
 756   $$secondsref += $prepay_credit->seconds;
 757   $$upref      += $prepay_credit->upbytes;
 758   $$downref    += $prepay_credit->downbytes;
 759   $$totalref   += $prepay_credit->totalbytes;
 760
 761   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 762   '';
 763
 764 }
 765
 766 =item increment_upbytes SECONDS
 767
 768 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 769 the specified number of upbytes.  If there is an error, returns the error,
 770 otherwise returns false.
 771
 772 =cut
 773
 774 sub increment_upbytes {
 775   _increment_column( shift, 'upbytes', @_);
 776 }
 777
 778 =item increment_downbytes SECONDS
 779
 780 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 781 the specified number of downbytes.  If there is an error, returns the error,
 782 otherwise returns false.
 783
 784 =cut
 785
 786 sub increment_downbytes {
 787   _increment_column( shift, 'downbytes', @_);
 788 }
 789
 790 =item increment_totalbytes SECONDS
 791
 792 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 793 the specified number of totalbytes.  If there is an error, returns the error,
 794 otherwise returns false.
 795
 796 =cut
 797
 798 sub increment_totalbytes {
 799   _increment_column( shift, 'totalbytes', @_);
 800 }
 801
 802 =item increment_seconds SECONDS
 803
 804 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 805 the specified number of seconds.  If there is an error, returns the error,
 806 otherwise returns false.
 807
 808 =cut
 809
 810 sub increment_seconds {
 811   _increment_column( shift, 'seconds', @_);
 812 }
 813
 814 =item _increment_column AMOUNT
 815
 816 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 817 the specified number of seconds or bytes.  If there is an error, returns
 818 the error, otherwise returns false.
 819
 820 =cut
 821
 822 sub _increment_column {
 823   my( $self, $column, $amount ) = @_;
 824   warn "$me increment_column called: $column, $amount\n"
 825     if $DEBUG;
 826
 827   return '' unless $amount;
 828
 829   my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
 830                       $self->ncancelled_pkgs;
 831
 832   if ( ! @cust_pkg ) {
 833     return 'No packages with primary or single services found'.
 834            ' to apply pre-paid time';
 835   } elsif ( scalar(@cust_pkg) > 1 ) {
 836     #maybe have a way to specify the package/account?
 837     return 'Multiple packages found to apply pre-paid time';
 838   }
 839
 840   my $cust_pkg = $cust_pkg[0];
 841   warn "  found package pkgnum ". $cust_pkg->pkgnum. "\n"
 842     if $DEBUG > 1;
 843
 844   my @cust_svc =
 845     $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
 846
 847   if ( ! @cust_svc ) {
 848     return 'No account found to apply pre-paid time';
 849   } elsif ( scalar(@cust_svc) > 1 ) {
 850     return 'Multiple accounts found to apply pre-paid time';
 851   }
 852
 853   my $svc_acct = $cust_svc[0]->svc_x;
 854   warn "  found service svcnum ". $svc_acct->pkgnum.
 855        ' ('. $svc_acct->email. ")\n"
 856     if $DEBUG > 1;
 857
 858   $column = "increment_$column";
 859   $svc_acct->$column($amount);
 860
 861 }
 862
 863 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
 864
 865 Inserts a prepayment in the specified amount for this customer.  An optional
 866 second argument can specify the prepayment identifier for tracking purposes.
 867 If there is an error, returns the error, otherwise returns false.
 868
 869 =cut
 870
 871 sub insert_cust_pay_prepay {
 872   shift->insert_cust_pay('PREP', @_);
 873 }
 874
 875 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
 876
 877 Inserts a cash payment in the specified amount for this customer.  An optional
 878 second argument can specify the payment identifier for tracking purposes.
 879 If there is an error, returns the error, otherwise returns false.
 880
 881 =cut
 882
 883 sub insert_cust_pay_cash {
 884   shift->insert_cust_pay('CASH', @_);
 885 }
 886
 887 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
 888
 889 Inserts a Western Union payment in the specified amount for this customer.  An
 890 optional second argument can specify the prepayment identifier for tracking
 891 purposes.  If there is an error, returns the error, otherwise returns false.
 892
 893 =cut
 894
 895 sub insert_cust_pay_west {
 896   shift->insert_cust_pay('WEST', @_);
 897 }
 898
 899 sub insert_cust_pay {
 900   my( $self, $payby, $amount ) = splice(@_, 0, 3);
 901   my $payinfo = scalar(@_) ? shift : '';
 902
 903   my $cust_pay = new FS::cust_pay {
 904     'custnum' => $self->custnum,
 905     'paid'    => sprintf('%.2f', $amount),
 906     #'_date'   => #date the prepaid card was purchased???
 907     'payby'   => $payby,
 908     'payinfo' => $payinfo,
 909   };
 910   $cust_pay->insert;
 911
 912 }
 913
 914 =item reexport
 915
 916 This method is deprecated.  See the I<depend_jobnum> option to the insert and
 917 order_pkgs methods for a better way to defer provisioning.
 918
 919 Re-schedules all exports by calling the B<reexport> method of all associated
 920 packages (see L<FS::cust_pkg>).  If there is an error, returns the error;
 921 otherwise returns false.
 922
 923 =cut
 924
 925 sub reexport {
 926   my $self = shift;
 927
 928   carp "WARNING: FS::cust_main::reexport is deprectated; ".
 929        "use the depend_jobnum option to insert or order_pkgs to delay export";
 930
 931   local $SIG{HUP} = 'IGNORE';
 932   local $SIG{INT} = 'IGNORE';
 933   local $SIG{QUIT} = 'IGNORE';
 934   local $SIG{TERM} = 'IGNORE';
 935   local $SIG{TSTP} = 'IGNORE';
 936   local $SIG{PIPE} = 'IGNORE';
 937
 938   my $oldAutoCommit = $FS::UID::AutoCommit;
 939   local $FS::UID::AutoCommit = 0;
 940   my $dbh = dbh;
 941
 942   foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
 943     my $error = $cust_pkg->reexport;
 944     if ( $error ) {
 945       $dbh->rollback if $oldAutoCommit;
 946       return $error;
 947     }
 948   }
 949
 950   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 951   '';
 952
 953 }
 954
 955 =item delete NEW_CUSTNUM
 956
 957 This deletes the customer.  If there is an error, returns the error, otherwise
 958 returns false.
 959
 960 This will completely remove all traces of the customer record.  This is not
 961 what you want when a customer cancels service; for that, cancel all of the
 962 customer's packages (see L</cancel>).
 963
 964 If the customer has any uncancelled packages, you need to pass a new (valid)
 965 customer number for those packages to be transferred to.  Cancelled packages
 966 will be deleted.  Did I mention that this is NOT what you want when a customer
 967 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
 968
 969 You can't delete a customer with invoices (see L<FS::cust_bill>),
 970 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
 971 refunds (see L<FS::cust_refund>).
 972
 973 =cut
 974
 975 sub delete {
 976   my $self = shift;
 977
 978   local $SIG{HUP} = 'IGNORE';
 979   local $SIG{INT} = 'IGNORE';
 980   local $SIG{QUIT} = 'IGNORE';
 981   local $SIG{TERM} = 'IGNORE';
 982   local $SIG{TSTP} = 'IGNORE';
 983   local $SIG{PIPE} = 'IGNORE';
 984
 985   my $oldAutoCommit = $FS::UID::AutoCommit;
 986   local $FS::UID::AutoCommit = 0;
 987   my $dbh = dbh;
 988
 989   if ( $self->cust_bill ) {
 990     $dbh->rollback if $oldAutoCommit;
 991     return "Can't delete a customer with invoices";
 992   }
 993   if ( $self->cust_credit ) {
 994     $dbh->rollback if $oldAutoCommit;
 995     return "Can't delete a customer with credits";
 996   }
 997   if ( $self->cust_pay ) {
 998     $dbh->rollback if $oldAutoCommit;
 999     return "Can't delete a customer with payments";
1000   }
1001   if ( $self->cust_refund ) {
1002     $dbh->rollback if $oldAutoCommit;
1003     return "Can't delete a customer with refunds";
1004   }
1005
1006   my @cust_pkg = $self->ncancelled_pkgs;
1007   if ( @cust_pkg ) {
1008     my $new_custnum = shift;
1009     unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1010       $dbh->rollback if $oldAutoCommit;
1011       return "Invalid new customer number: $new_custnum";
1012     }
1013     foreach my $cust_pkg ( @cust_pkg ) {
1014       my %hash = $cust_pkg->hash;
1015       $hash{'custnum'} = $new_custnum;
1016       my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1017       my $error = $new_cust_pkg->replace($cust_pkg,
1018                                          options => { $cust_pkg->options },
1019                                         );
1020       if ( $error ) {
1021         $dbh->rollback if $oldAutoCommit;
1022         return $error;
1023       }
1024     }
1025   }
1026   my @cancelled_cust_pkg = $self->all_pkgs;
1027   foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1028     my $error = $cust_pkg->delete;
1029     if ( $error ) {
1030       $dbh->rollback if $oldAutoCommit;
1031       return $error;
1032     }
1033   }
1034
1035   foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1036     qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1037   ) {
1038     my $error = $cust_main_invoice->delete;
1039     if ( $error ) {
1040       $dbh->rollback if $oldAutoCommit;
1041       return $error;
1042     }
1043   }
1044
1045   my $error = $self->SUPER::delete;
1046   if ( $error ) {
1047     $dbh->rollback if $oldAutoCommit;
1048     return $error;
1049   }
1050
1051   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1052   '';
1053
1054 }
1055
1056 =item replace OLD_RECORD [ INVOICING_LIST_ARYREF ]
1057
1058 Replaces the OLD_RECORD with this one in the database.  If there is an error,
1059 returns the error, otherwise returns false.
1060
1061 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1062 be set as the invoicing list (see L<"invoicing_list">).  Errors return as
1063 expected and rollback the entire transaction; it is not necessary to call
1064 check_invoicing_list first.  Here's an example:
1065
1066   $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1067
1068 =cut
1069
1070 sub replace {
1071   my $self = shift;
1072   my $old = shift;
1073   my @param = @_;
1074   warn "$me replace called\n"
1075     if $DEBUG;
1076
1077   local $SIG{HUP} = 'IGNORE';
1078   local $SIG{INT} = 'IGNORE';
1079   local $SIG{QUIT} = 'IGNORE';
1080   local $SIG{TERM} = 'IGNORE';
1081   local $SIG{TSTP} = 'IGNORE';
1082   local $SIG{PIPE} = 'IGNORE';
1083
1084   # We absolutely have to have an old vs. new record to make this work.
1085   if (!defined($old)) {
1086     $old = qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
1087   }
1088
1089   my $curuser = $FS::CurrentUser::CurrentUser;
1090   if (    $self->payby eq 'COMP'
1091        && $self->payby ne $old->payby
1092        && ! $curuser->access_right('Complimentary customer')
1093      )
1094   {
1095     return "You are not permitted to create complimentary accounts.";
1096   }
1097
1098   local($ignore_expired_card) = 1
1099     if $old->payby  =~ /^(CARD|DCRD)$/
1100     && $self->payby =~ /^(CARD|DCRD)$/
1101     && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1102
1103   my $oldAutoCommit = $FS::UID::AutoCommit;
1104   local $FS::UID::AutoCommit = 0;
1105   my $dbh = dbh;
1106
1107   my $error = $self->SUPER::replace($old);
1108
1109   if ( $error ) {
1110     $dbh->rollback if $oldAutoCommit;
1111     return $error;
1112   }
1113
1114   if ( @param ) { # INVOICING_LIST_ARYREF
1115     my $invoicing_list = shift @param;
1116     $error = $self->check_invoicing_list( $invoicing_list );
1117     if ( $error ) {
1118       $dbh->rollback if $oldAutoCommit;
1119       return $error;
1120     }
1121     $self->invoicing_list( $invoicing_list );
1122   }
1123
1124   if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1125        grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1126     # card/check/lec info has changed, want to retry realtime_ invoice events
1127     my $error = $self->retry_realtime;
1128     if ( $error ) {
1129       $dbh->rollback if $oldAutoCommit;
1130       return $error;
1131     }
1132   }
1133
1134   unless ( $import || $skip_fuzzyfiles ) {
1135     $error = $self->queue_fuzzyfiles_update;
1136     if ( $error ) {
1137       $dbh->rollback if $oldAutoCommit;
1138       return "updating fuzzy search cache: $error";
1139     }
1140   }
1141
1142   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1143   '';
1144
1145 }
1146
1147 =item queue_fuzzyfiles_update
1148
1149 Used by insert & replace to update the fuzzy search cache
1150
1151 =cut
1152
1153 sub queue_fuzzyfiles_update {
1154   my $self = shift;
1155
1156   local $SIG{HUP} = 'IGNORE';
1157   local $SIG{INT} = 'IGNORE';
1158   local $SIG{QUIT} = 'IGNORE';
1159   local $SIG{TERM} = 'IGNORE';
1160   local $SIG{TSTP} = 'IGNORE';
1161   local $SIG{PIPE} = 'IGNORE';
1162
1163   my $oldAutoCommit = $FS::UID::AutoCommit;
1164   local $FS::UID::AutoCommit = 0;
1165   my $dbh = dbh;
1166
1167   my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1168   my $error = $queue->insert( map $self->getfield($_),
1169                                   qw(first last company)
1170                             );
1171   if ( $error ) {
1172     $dbh->rollback if $oldAutoCommit;
1173     return "queueing job (transaction rolled back): $error";
1174   }
1175
1176   if ( $self->ship_last ) {
1177     $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1178     $error = $queue->insert( map $self->getfield("ship_$_"),
1179                                  qw(first last company)
1180                            );
1181     if ( $error ) {
1182       $dbh->rollback if $oldAutoCommit;
1183       return "queueing job (transaction rolled back): $error";
1184     }
1185   }
1186
1187   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1188   '';
1189
1190 }
1191
1192 =item check
1193
1194 Checks all fields to make sure this is a valid customer record.  If there is
1195 an error, returns the error, otherwise returns false.  Called by the insert
1196 and replace methods.
1197
1198 =cut
1199
1200 sub check {
1201   my $self = shift;
1202
1203   warn "$me check BEFORE: \n". $self->_dump
1204     if $DEBUG > 2;
1205
1206   my $error =
1207     $self->ut_numbern('custnum')
1208     || $self->ut_number('agentnum')
1209     || $self->ut_textn('agent_custid')
1210     || $self->ut_number('refnum')
1211     || $self->ut_name('last')
1212     || $self->ut_name('first')
1213     || $self->ut_snumbern('birthdate')
1214     || $self->ut_snumbern('signupdate')
1215     || $self->ut_textn('company')
1216     || $self->ut_text('address1')
1217     || $self->ut_textn('address2')
1218     || $self->ut_text('city')
1219     || $self->ut_textn('county')
1220     || $self->ut_textn('state')
1221     || $self->ut_country('country')
1222     || $self->ut_anything('comments')
1223     || $self->ut_numbern('referral_custnum')
1224     || $self->ut_textn('stateid')
1225     || $self->ut_textn('stateid_state')
1226     || $self->ut_textn('invoice_terms')
1227   ;
1228   #barf.  need message catalogs.  i18n.  etc.
1229   $error .= "Please select an advertising source."
1230     if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1231   return $error if $error;
1232
1233   return "Unknown agent"
1234     unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1235
1236   return "Unknown refnum"
1237     unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1238
1239   return "Unknown referring custnum: ". $self->referral_custnum
1240     unless ! $self->referral_custnum
1241            || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1242
1243   if ( $self->ss eq '' ) {
1244     $self->ss('');
1245   } else {
1246     my $ss = $self->ss;
1247     $ss =~ s/\D//g;
1248     $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1249       or return "Illegal social security number: ". $self->ss;
1250     $self->ss("$1-$2-$3");
1251   }
1252
1253
1254 # bad idea to disable, causes billing to fail because of no tax rates later
1255 #  unless ( $import ) {
1256     unless ( qsearch('cust_main_county', {
1257       'country' => $self->country,
1258       'state'   => '',
1259      } ) ) {
1260       return "Unknown state/county/country: ".
1261         $self->state. "/". $self->county. "/". $self->country
1262         unless qsearch('cust_main_county',{
1263           'state'   => $self->state,
1264           'county'  => $self->county,
1265           'country' => $self->country,
1266         } );
1267     }
1268 #  }
1269
1270   $error =
1271     $self->ut_phonen('daytime', $self->country)
1272     || $self->ut_phonen('night', $self->country)
1273     || $self->ut_phonen('fax', $self->country)
1274     || $self->ut_zip('zip', $self->country)
1275   ;
1276   return $error if $error;
1277
1278   if ( $conf->exists('cust_main-require_phone')
1279        && ! length($self->daytime) && ! length($self->night)
1280      ) {
1281
1282     my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1283                           ? 'Day Phone'
1284                           : FS::Msgcat::_gettext('daytime');
1285     my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1286                         ? 'Night Phone'
1287                         : FS::Msgcat::_gettext('night');
1288
1289     return "$daytime_label or $night_label is required"
1290
1291   }
1292
1293   my @addfields = qw(
1294     last first company address1 address2 city county state zip
1295     country daytime night fax
1296   );
1297
1298   if ( defined $self->dbdef_table->column('ship_last') ) {
1299     if ( scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1300                        @addfields )
1301          && scalar ( grep { $self->getfield("ship_$_") ne '' } @addfields )
1302        )
1303     {
1304       my $error =
1305         $self->ut_name('ship_last')
1306         || $self->ut_name('ship_first')
1307         || $self->ut_textn('ship_company')
1308         || $self->ut_text('ship_address1')
1309         || $self->ut_textn('ship_address2')
1310         || $self->ut_text('ship_city')
1311         || $self->ut_textn('ship_county')
1312         || $self->ut_textn('ship_state')
1313         || $self->ut_country('ship_country')
1314       ;
1315       return $error if $error;
1316
1317       #false laziness with above
1318       unless ( qsearchs('cust_main_county', {
1319         'country' => $self->ship_country,
1320         'state'   => '',
1321        } ) ) {
1322         return "Unknown ship_state/ship_county/ship_country: ".
1323           $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1324           unless qsearch('cust_main_county',{
1325             'state'   => $self->ship_state,
1326             'county'  => $self->ship_county,
1327             'country' => $self->ship_country,
1328           } );
1329       }
1330       #eofalse
1331
1332       $error =
1333         $self->ut_phonen('ship_daytime', $self->ship_country)
1334         || $self->ut_phonen('ship_night', $self->ship_country)
1335         || $self->ut_phonen('ship_fax', $self->ship_country)
1336         || $self->ut_zip('ship_zip', $self->ship_country)
1337       ;
1338       return $error if $error;
1339
1340     } else { # ship_ info eq billing info, so don't store dup info in database
1341       $self->setfield("ship_$_", '')
1342         foreach qw( last first company address1 address2 city county state zip
1343                     country daytime night fax );
1344     }
1345   }
1346
1347   #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1348   #  or return "Illegal payby: ". $self->payby;
1349   #$self->payby($1);
1350   FS::payby->can_payby($self->table, $self->payby)
1351     or return "Illegal payby: ". $self->payby;
1352
1353   $error =    $self->ut_numbern('paystart_month')
1354            || $self->ut_numbern('paystart_year')
1355            || $self->ut_numbern('payissue')
1356            || $self->ut_textn('paytype')
1357   ;
1358   return $error if $error;
1359
1360   if ( $self->payip eq '' ) {
1361     $self->payip('');
1362   } else {
1363     $error = $self->ut_ip('payip');
1364     return $error if $error;
1365   }
1366
1367   # If it is encrypted and the private key is not availaible then we can't
1368   # check the credit card.
1369
1370   my $check_payinfo = 1;
1371
1372   if ($self->is_encrypted($self->payinfo)) {
1373     $check_payinfo = 0;
1374   }
1375
1376   if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1377
1378     my $payinfo = $self->payinfo;
1379     $payinfo =~ s/\D//g;
1380     $payinfo =~ /^(\d{13,16})$/
1381       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1382     $payinfo = $1;
1383     $self->payinfo($payinfo);
1384     validate($payinfo)
1385       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1386
1387     return gettext('unknown_card_type')
1388       if cardtype($self->payinfo) eq "Unknown";
1389
1390     my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1391     if ( $ban ) {
1392       return 'Banned credit card: banned on '.
1393              time2str('%a %h %o at %r', $ban->_date).
1394              ' by '. $ban->otaker.
1395              ' (ban# '. $ban->bannum. ')';
1396     }
1397
1398     if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1399       if ( cardtype($self->payinfo) eq 'American Express card' ) {
1400         $self->paycvv =~ /^(\d{4})$/
1401           or return "CVV2 (CID) for American Express cards is four digits.";
1402         $self->paycvv($1);
1403       } else {
1404         $self->paycvv =~ /^(\d{3})$/
1405           or return "CVV2 (CVC2/CID) is three digits.";
1406         $self->paycvv($1);
1407       }
1408     } else {
1409       $self->paycvv('');
1410     }
1411
1412     my $cardtype = cardtype($payinfo);
1413     if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1414
1415       return "Start date or issue number is required for $cardtype cards"
1416         unless $self->paystart_month && $self->paystart_year or $self->payissue;
1417
1418       return "Start month must be between 1 and 12"
1419         if $self->paystart_month
1420            and $self->paystart_month < 1 || $self->paystart_month > 12;
1421
1422       return "Start year must be 1990 or later"
1423         if $self->paystart_year
1424            and $self->paystart_year < 1990;
1425
1426       return "Issue number must be beween 1 and 99"
1427         if $self->payissue
1428           and $self->payissue < 1 || $self->payissue > 99;
1429
1430     } else {
1431       $self->paystart_month('');
1432       $self->paystart_year('');
1433       $self->payissue('');
1434     }
1435
1436   } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1437
1438     my $payinfo = $self->payinfo;
1439     $payinfo =~ s/[^\d\@]//g;
1440     if ( $conf->exists('echeck-nonus') ) {
1441       $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1442       $payinfo = "$1\@$2";
1443     } else {
1444       $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1445       $payinfo = "$1\@$2";
1446     }
1447     $self->payinfo($payinfo);
1448     $self->paycvv('');
1449
1450     my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1451     if ( $ban ) {
1452       return 'Banned ACH account: banned on '.
1453              time2str('%a %h %o at %r', $ban->_date).
1454              ' by '. $ban->otaker.
1455              ' (ban# '. $ban->bannum. ')';
1456     }
1457
1458   } elsif ( $self->payby eq 'LECB' ) {
1459
1460     my $payinfo = $self->payinfo;
1461     $payinfo =~ s/\D//g;
1462     $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1463     $payinfo = $1;
1464     $self->payinfo($payinfo);
1465     $self->paycvv('');
1466
1467   } elsif ( $self->payby eq 'BILL' ) {
1468
1469     $error = $self->ut_textn('payinfo');
1470     return "Illegal P.O. number: ". $self->payinfo if $error;
1471     $self->paycvv('');
1472
1473   } elsif ( $self->payby eq 'COMP' ) {
1474
1475     my $curuser = $FS::CurrentUser::CurrentUser;
1476     if (    ! $self->custnum
1477          && ! $curuser->access_right('Complimentary customer')
1478        )
1479     {
1480       return "You are not permitted to create complimentary accounts."
1481     }
1482
1483     $error = $self->ut_textn('payinfo');
1484     return "Illegal comp account issuer: ". $self->payinfo if $error;
1485     $self->paycvv('');
1486
1487   } elsif ( $self->payby eq 'PREPAY' ) {
1488
1489     my $payinfo = $self->payinfo;
1490     $payinfo =~ s/\W//g; #anything else would just confuse things
1491     $self->payinfo($payinfo);
1492     $error = $self->ut_alpha('payinfo');
1493     return "Illegal prepayment identifier: ". $self->payinfo if $error;
1494     return "Unknown prepayment identifier"
1495       unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1496     $self->paycvv('');
1497
1498   }
1499
1500   if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1501     return "Expiration date required"
1502       unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1503     $self->paydate('');
1504   } else {
1505     my( $m, $y );
1506     if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1507       ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1508     } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1509       ( $m, $y ) = ( $3, "20$2" );
1510     } else {
1511       return "Illegal expiration date: ". $self->paydate;
1512     }
1513     $self->paydate("$y-$m-01");
1514     my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1515     return gettext('expired_card')
1516       if !$import
1517       && !$ignore_expired_card
1518       && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1519   }
1520
1521   if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1522        ( ! $conf->exists('require_cardname')
1523          || $self->payby !~ /^(CARD|DCRD)$/  )
1524   ) {
1525     $self->payname( $self->first. " ". $self->getfield('last') );
1526   } else {
1527     $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1528       or return gettext('illegal_name'). " payname: ". $self->payname;
1529     $self->payname($1);
1530   }
1531
1532   foreach my $flag (qw( tax spool_cdr )) {
1533     $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1534     $self->$flag($1);
1535   }
1536
1537   $self->otaker(getotaker) unless $self->otaker;
1538
1539   warn "$me check AFTER: \n". $self->_dump
1540     if $DEBUG > 2;
1541
1542   $self->SUPER::check;
1543 }
1544
1545 =item all_pkgs
1546
1547 Returns all packages (see L<FS::cust_pkg>) for this customer.
1548
1549 =cut
1550
1551 sub all_pkgs {
1552   my $self = shift;
1553
1554   return $self->num_pkgs unless wantarray;
1555
1556   my @cust_pkg = ();
1557   if ( $self->{'_pkgnum'} ) {
1558     @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1559   } else {
1560     @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1561   }
1562
1563   sort sort_packages @cust_pkg;
1564 }
1565
1566 =item cust_pkg
1567
1568 Synonym for B<all_pkgs>.
1569
1570 =cut
1571
1572 sub cust_pkg {
1573   shift->all_pkgs(@_);
1574 }
1575
1576 =item ncancelled_pkgs
1577
1578 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1579
1580 =cut
1581
1582 sub ncancelled_pkgs {
1583   my $self = shift;
1584
1585   return $self->num_ncancelled_pkgs unless wantarray;
1586
1587   my @cust_pkg = ();
1588   if ( $self->{'_pkgnum'} ) {
1589
1590     warn "$me ncancelled_pkgs: returning cached objects"
1591       if $DEBUG > 1;
1592
1593     @cust_pkg = grep { ! $_->getfield('cancel') }
1594                 values %{ $self->{'_pkgnum'}->cache };
1595
1596   } else {
1597
1598     warn "$me ncancelled_pkgs: searching for packages for custnum ".
1599          $self->custnum
1600       if $DEBUG > 1;
1601
1602     @cust_pkg =
1603       qsearch( 'cust_pkg', {
1604                              'custnum' => $self->custnum,
1605                              'cancel'  => '',
1606                            });
1607     push @cust_pkg,
1608       qsearch( 'cust_pkg', {
1609                              'custnum' => $self->custnum,
1610                              'cancel'  => 0,
1611                            });
1612   }
1613
1614   sort sort_packages @cust_pkg;
1615
1616 }
1617
1618 # This should be generalized to use config options to determine order.
1619 sub sort_packages {
1620   if ( $a->get('cancel') and $b->get('cancel') ) {
1621     $a->pkgnum <=> $b->pkgnum;
1622   } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1623     return -1 if $b->get('cancel');
1624     return  1 if $a->get('cancel');
1625     return 0;
1626   } else {
1627     $a->pkgnum <=> $b->pkgnum;
1628   }
1629 }
1630
1631 =item suspended_pkgs
1632
1633 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1634
1635 =cut
1636
1637 sub suspended_pkgs {
1638   my $self = shift;
1639   grep { $_->susp } $self->ncancelled_pkgs;
1640 }
1641
1642 =item unflagged_suspended_pkgs
1643
1644 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1645 customer (thouse packages without the `manual_flag' set).
1646
1647 =cut
1648
1649 sub unflagged_suspended_pkgs {
1650   my $self = shift;
1651   return $self->suspended_pkgs
1652     unless dbdef->table('cust_pkg')->column('manual_flag');
1653   grep { ! $_->manual_flag } $self->suspended_pkgs;
1654 }
1655
1656 =item unsuspended_pkgs
1657
1658 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1659 this customer.
1660
1661 =cut
1662
1663 sub unsuspended_pkgs {
1664   my $self = shift;
1665   grep { ! $_->susp } $self->ncancelled_pkgs;
1666 }
1667
1668 =item num_cancelled_pkgs
1669
1670 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1671 customer.
1672
1673 =cut
1674
1675 sub num_cancelled_pkgs {
1676   shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1677 }
1678
1679 sub num_ncancelled_pkgs {
1680   shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1681 }
1682
1683 sub num_pkgs {
1684   my( $self, $sql ) = @_;
1685   $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1686   my $sth = dbh->prepare(
1687     "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1688   ) or die dbh->errstr;
1689   $sth->execute($self->custnum) or die $sth->errstr;
1690   $sth->fetchrow_arrayref->[0];
1691 }
1692
1693 =item unsuspend
1694
1695 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1696 and L<FS::cust_pkg>) for this customer.  Always returns a list: an empty list
1697 on success or a list of errors.
1698
1699 =cut
1700
1701 sub unsuspend {
1702   my $self = shift;
1703   grep { $_->unsuspend } $self->suspended_pkgs;
1704 }
1705
1706 =item suspend
1707
1708 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1709
1710 Returns a list: an empty list on success or a list of errors.
1711
1712 =cut
1713
1714 sub suspend {
1715   my $self = shift;
1716   grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1717 }
1718
1719 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1720
1721 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1722 PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref instead
1723 of a list of pkgparts; the hashref has the following keys:
1724
1725 =over 4
1726
1727 =item pkgparts - listref of pkgparts
1728
1729 =item (other options are passed to the suspend method)
1730
1731 =back
1732
1733
1734 Returns a list: an empty list on success or a list of errors.
1735
1736 =cut
1737
1738 sub suspend_if_pkgpart {
1739   my $self = shift;
1740   my (@pkgparts, %opt);
1741   if (ref($_[0]) eq 'HASH'){
1742     @pkgparts = @{$_[0]{pkgparts}};
1743     %opt      = %{$_[0]};
1744   }else{
1745     @pkgparts = @_;
1746   }
1747   grep { $_->suspend(%opt) }
1748     grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1749       $self->unsuspended_pkgs;
1750 }
1751
1752 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1753
1754 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1755 given PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref
1756 instead of a list of pkgparts; the hashref has the following keys:
1757
1758 =over 4
1759
1760 =item pkgparts - listref of pkgparts
1761
1762 =item (other options are passed to the suspend method)
1763
1764 =back
1765
1766 Returns a list: an empty list on success or a list of errors.
1767
1768 =cut
1769
1770 sub suspend_unless_pkgpart {
1771   my $self = shift;
1772   my (@pkgparts, %opt);
1773   if (ref($_[0]) eq 'HASH'){
1774     @pkgparts = @{$_[0]{pkgparts}};
1775     %opt      = %{$_[0]};
1776   }else{
1777     @pkgparts = @_;
1778   }
1779   grep { $_->suspend(%opt) }
1780     grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1781       $self->unsuspended_pkgs;
1782 }
1783
1784 =item cancel [ OPTION => VALUE ... ]
1785
1786 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1787
1788 Available options are:
1789
1790 =over 4
1791
1792 =item quiet - can be set true to supress email cancellation notices.
1793
1794 =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.
1795
1796 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
1797
1798 =back
1799
1800 Always returns a list: an empty list on success or a list of errors.
1801
1802 =cut
1803
1804 sub cancel {
1805   my( $self, %opt ) = @_;
1806
1807   warn "$me cancel called on customer ". $self->custnum. " with options ".
1808        join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
1809     if $DEBUG;
1810
1811   return ( 'access denied' )
1812     unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
1813
1814   if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1815
1816     #should try decryption (we might have the private key)
1817     # and if not maybe queue a job for the server that does?
1818     return ( "Can't (yet) ban encrypted credit cards" )
1819       if $self->is_encrypted($self->payinfo);
1820
1821     my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1822     my $error = $ban->insert;
1823     return ( $error ) if $error;
1824
1825   }
1826
1827   my @pkgs = $self->ncancelled_pkgs;
1828
1829   warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
1830        scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
1831     if $DEBUG;
1832
1833   grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
1834 }
1835
1836 sub _banned_pay_hashref {
1837   my $self = shift;
1838
1839   my %payby2ban = (
1840     'CARD' => 'CARD',
1841     'DCRD' => 'CARD',
1842     'CHEK' => 'CHEK',
1843     'DCHK' => 'CHEK'
1844   );
1845
1846   {
1847     'payby'   => $payby2ban{$self->payby},
1848     'payinfo' => md5_base64($self->payinfo),
1849     #don't ever *search* on reason! #'reason'  =>
1850   };
1851 }
1852
1853 =item notes
1854
1855 Returns all notes (see L<FS::cust_main_note>) for this customer.
1856
1857 =cut
1858
1859 sub notes {
1860   my $self = shift;
1861   #order by?
1862   qsearch( 'cust_main_note',
1863            { 'custnum' => $self->custnum },
1864            '',
1865            'ORDER BY _DATE DESC'
1866          );
1867 }
1868
1869 =item agent
1870
1871 Returns the agent (see L<FS::agent>) for this customer.
1872
1873 =cut
1874
1875 sub agent {
1876   my $self = shift;
1877   qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1878 }
1879
1880 =item bill_and_collect
1881
1882 Cancels and suspends any packages due, generates bills, applies payments and
1883 cred
1884
1885 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
1886
1887 Options are passed as name-value pairs.  Currently available options are:
1888
1889 =over 4
1890
1891 =item time - 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:
1892
1893  use Date::Parse;
1894  ...
1895  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1896
1897 =item invoice_time - 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.
1898
1899 =item check_freq - "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1900
1901 =item resetup - if set true, re-charges setup fees.
1902
1903 =back
1904
1905 =cut
1906
1907 sub bill_and_collect {
1908   my( $self, %options ) = @_;
1909
1910   ###
1911   # cancel packages
1912   ###
1913
1914   #$^T not $options{time} because freeside-daily -d is for pre-printing invoices
1915   foreach my $cust_pkg (
1916     grep { $_->expire && $_->expire <= $^T } $self->ncancelled_pkgs
1917   ) {
1918     my $error = $cust_pkg->cancel;
1919     warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
1920          " for custnum ". $self->custnum. ": $error"
1921       if $error;
1922   }
1923
1924   ###
1925   # suspend packages
1926   ###
1927
1928   #$^T not $options{time} because freeside-daily -d is for pre-printing invoices
1929   foreach my $cust_pkg (
1930     grep { (    $_->part_pkg->is_prepaid && $_->bill && $_->bill < $^T
1931              || $_->adjourn && $_->adjourn <= $^T
1932            )
1933            && ! $_->susp
1934          }
1935          $self->ncancelled_pkgs
1936   ) {
1937     my $error = $cust_pkg->suspend;
1938     warn "Error suspending package ". $cust_pkg->pkgnum.
1939          " for custnum ". $self->custnum. ": $error"
1940       if $error;
1941   }
1942
1943   ###
1944   # bill and collect
1945   ###
1946
1947   my $error = $self->bill( %options );
1948   warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
1949
1950   $self->apply_payments_and_credits;
1951
1952   $error = $self->collect( %options );
1953   warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
1954
1955 }
1956
1957 =item bill OPTIONS
1958
1959 Generates invoices (see L<FS::cust_bill>) for this customer.  Usually used in
1960 conjunction with the collect method by calling B<bill_and_collect>.
1961
1962 If there is an error, returns the error, otherwise returns false.
1963
1964 Options are passed as name-value pairs.  Currently available options are:
1965
1966 =over 4
1967
1968 =item resetup - if set true, re-charges setup fees.
1969
1970 =item time - 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:
1971
1972  use Date::Parse;
1973  ...
1974  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1975
1976 =item pkg_list - An array ref of specific packages (objects) to attempt billing, instead trying all of them.
1977
1978  $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
1979
1980 =item invoice_time - 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.
1981
1982 =back
1983
1984 =cut
1985
1986 sub bill {
1987   my( $self, %options ) = @_;
1988   return '' if $self->payby eq 'COMP';
1989   warn "$me bill customer ". $self->custnum. "\n"
1990     if $DEBUG;
1991
1992   my $time = $options{'time'} || time;
1993
1994   my $error;
1995
1996   #put below somehow?
1997   local $SIG{HUP} = 'IGNORE';
1998   local $SIG{INT} = 'IGNORE';
1999   local $SIG{QUIT} = 'IGNORE';
2000   local $SIG{TERM} = 'IGNORE';
2001   local $SIG{TSTP} = 'IGNORE';
2002   local $SIG{PIPE} = 'IGNORE';
2003
2004   my $oldAutoCommit = $FS::UID::AutoCommit;
2005   local $FS::UID::AutoCommit = 0;
2006   my $dbh = dbh;
2007
2008   $self->select_for_update; #mutex
2009
2010   #create a new invoice
2011   #(we'll remove it later if it doesn't actually need to be generated [contains
2012   # no line items] and we're inside a transaciton so nothing else will see it)
2013   my $cust_bill = new FS::cust_bill ( {
2014     'custnum' => $self->custnum,
2015     '_date'   => ( $options{'invoice_time'} || $time ),
2016     #'charged' => $charged,
2017     'charged' => 0,
2018   } );
2019   $error = $cust_bill->insert;
2020   if ( $error ) {
2021     $dbh->rollback if $oldAutoCommit;
2022     return "can't create invoice for customer #". $self->custnum. ": $error";
2023   }
2024   my $invnum = $cust_bill->invnum;
2025
2026   ###
2027   # find the packages which are due for billing, find out how much they are
2028   # & generate invoice database.
2029   ###
2030
2031   my( $total_setup, $total_recur ) = ( 0, 0 );
2032   my %tax;
2033   my @precommit_hooks = ();
2034
2035   foreach my $cust_pkg (
2036     qsearch('cust_pkg', { 'custnum' => $self->custnum } )
2037   ) {
2038
2039     #NO!! next if $cust_pkg->cancel;
2040     next if $cust_pkg->getfield('cancel');
2041
2042     warn "  bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2043
2044     #? to avoid use of uninitialized value errors... ?
2045     $cust_pkg->setfield('bill', '')
2046       unless defined($cust_pkg->bill);
2047
2048     my $part_pkg = $cust_pkg->part_pkg;
2049
2050     my %hash = $cust_pkg->hash;
2051     my $old_cust_pkg = new FS::cust_pkg \%hash;
2052
2053     my @details = ();
2054
2055     ###
2056     # bill setup
2057     ###
2058
2059     my $setup = 0;
2060     if ( ! $cust_pkg->setup &&
2061          (
2062            ( $conf->exists('disable_setup_suspended_pkgs') &&
2063             ! $cust_pkg->getfield('susp')
2064           ) || ! $conf->exists('disable_setup_suspended_pkgs')
2065          )
2066       || $options{'resetup'}
2067     ) {
2068
2069       warn "    bill setup\n" if $DEBUG > 1;
2070
2071       $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2072       if ( $@ ) {
2073         $dbh->rollback if $oldAutoCommit;
2074         return "$@ running calc_setup for $cust_pkg\n";
2075       }
2076
2077       $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
2078     }
2079
2080     ###
2081     # bill recurring fee
2082     ###
2083
2084     my $recur = 0;
2085     my $sdate;
2086     if ( $part_pkg->getfield('freq') ne '0' &&
2087          ! $cust_pkg->getfield('susp') &&
2088          ( $cust_pkg->getfield('bill') || 0 ) <= $time
2089     ) {
2090
2091       # XXX should this be a package event?  probably.  events are called
2092       # at collection time at the moment, though...
2093       if ( $part_pkg->can('reset_usage') ) {
2094         warn "    resetting usage counters" if $DEBUG > 1;
2095         $part_pkg->reset_usage($cust_pkg);
2096       }
2097
2098       warn "    bill recur\n" if $DEBUG > 1;
2099
2100       # XXX shared with $recur_prog
2101       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2102
2103       #over two params!  lets at least switch to a hashref for the rest...
2104       my %param = ( 'precommit_hooks' => \@precommit_hooks, );
2105
2106       $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2107       if ( $@ ) {
2108         $dbh->rollback if $oldAutoCommit;
2109         return "$@ running calc_recur for $cust_pkg\n";
2110       }
2111
2112       #change this bit to use Date::Manip? CAREFUL with timezones (see
2113       # mailing list archive)
2114       my ($sec,$min,$hour,$mday,$mon,$year) =
2115         (localtime($sdate) )[0,1,2,3,4,5];
2116
2117       #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
2118       # only for figuring next bill date, nothing else, so, reset $sdate again
2119       # here
2120       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2121       $cust_pkg->last_bill($sdate)
2122         if $cust_pkg->dbdef_table->column('last_bill');
2123
2124       if ( $part_pkg->freq =~ /^\d+$/ ) {
2125         $mon += $part_pkg->freq;
2126         until ( $mon < 12 ) { $mon -= 12; $year++; }
2127       } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
2128         my $weeks = $1;
2129         $mday += $weeks * 7;
2130       } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
2131         my $days = $1;
2132         $mday += $days;
2133       } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
2134         my $hours = $1;
2135         $hour += $hours;
2136       } else {
2137         $dbh->rollback if $oldAutoCommit;
2138         return "unparsable frequency: ". $part_pkg->freq;
2139       }
2140       $cust_pkg->setfield('bill',
2141         timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
2142     }
2143
2144     warn "\$setup is undefined" unless defined($setup);
2145     warn "\$recur is undefined" unless defined($recur);
2146     warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2147
2148     ###
2149     # If $cust_pkg has been modified, update it and create cust_bill_pkg records
2150     ###
2151
2152     if ( $cust_pkg->modified ) {  # hmmm.. and if the options are modified?
2153
2154       warn "  package ". $cust_pkg->pkgnum. " modified; updating\n"
2155         if $DEBUG >1;
2156
2157       $error=$cust_pkg->replace($old_cust_pkg,
2158                                 options => { $cust_pkg->options },
2159                                );
2160       if ( $error ) { #just in case
2161         $dbh->rollback if $oldAutoCommit;
2162         return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
2163       }
2164
2165       $setup = sprintf( "%.2f", $setup );
2166       $recur = sprintf( "%.2f", $recur );
2167       if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2168         $dbh->rollback if $oldAutoCommit;
2169         return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2170       }
2171       if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2172         $dbh->rollback if $oldAutoCommit;
2173         return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2174       }
2175
2176       if ( $setup != 0 || $recur != 0 ) {
2177
2178         warn "    charges (setup=$setup, recur=$recur); adding line items\n"
2179           if $DEBUG > 1;
2180         my $cust_bill_pkg = new FS::cust_bill_pkg ({
2181           'invnum'  => $invnum,
2182           'pkgnum'  => $cust_pkg->pkgnum,
2183           'setup'   => $setup,
2184           'recur'   => $recur,
2185           'sdate'   => $sdate,
2186           'edate'   => $cust_pkg->bill,
2187           'details' => \@details,
2188         });
2189         $error = $cust_bill_pkg->insert;
2190         if ( $error ) {
2191           $dbh->rollback if $oldAutoCommit;
2192           return "can't create invoice line item for invoice #$invnum: $error";
2193         }
2194         $total_setup += $setup;
2195         $total_recur += $recur;
2196
2197         ###
2198         # handle taxes
2199         ###
2200
2201         unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2202
2203           my $prefix =
2204             ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2205             ? 'ship_'
2206             : '';
2207           my %taxhash = map { $_ => $self->get("$prefix$_") }
2208                             qw( state county country );
2209
2210           $taxhash{'taxclass'} = $part_pkg->taxclass;
2211
2212           my @taxes = qsearch( 'cust_main_county', \%taxhash );
2213
2214           unless ( @taxes ) {
2215             $taxhash{'taxclass'} = '';
2216             @taxes =  qsearch( 'cust_main_county', \%taxhash );
2217           }
2218
2219           #one more try at a whole-country tax rate
2220           unless ( @taxes ) {
2221             $taxhash{$_} = '' foreach qw( state county );
2222             @taxes =  qsearch( 'cust_main_county', \%taxhash );
2223           }
2224
2225           # maybe eliminate this entirely, along with all the 0% records
2226           unless ( @taxes ) {
2227             $dbh->rollback if $oldAutoCommit;
2228             return
2229               "fatal: can't find tax rate for state/county/country/taxclass ".
2230               join('/', ( map $self->get("$prefix$_"),
2231                               qw(state county country)
2232                         ),
2233                         $part_pkg->taxclass ). "\n";
2234           }
2235
2236           foreach my $tax ( @taxes ) {
2237
2238             my $taxable_charged = 0;
2239             $taxable_charged += $setup
2240               unless $part_pkg->setuptax =~ /^Y$/i
2241                   || $tax->setuptax =~ /^Y$/i;
2242             $taxable_charged += $recur
2243               unless $part_pkg->recurtax =~ /^Y$/i
2244                   || $tax->recurtax =~ /^Y$/i;
2245             next unless $taxable_charged;
2246
2247             if ( $tax->exempt_amount && $tax->exempt_amount > 0 ) {
2248               #my ($mon,$year) = (localtime($sdate) )[4,5];
2249               my ($mon,$year) = (localtime( $sdate || $cust_bill->_date ) )[4,5];
2250               $mon++;
2251               my $freq = $part_pkg->freq || 1;
2252               if ( $freq !~ /(\d+)$/ ) {
2253                 $dbh->rollback if $oldAutoCommit;
2254                 return "daily/weekly package definitions not (yet?)".
2255                        " compatible with monthly tax exemptions";
2256               }
2257               my $taxable_per_month =
2258                 sprintf("%.2f", $taxable_charged / $freq );
2259
2260               #call the whole thing off if this customer has any old
2261               #exemption records...
2262               my @cust_tax_exempt =
2263                 qsearch( 'cust_tax_exempt' => { custnum=> $self->custnum } );
2264               if ( @cust_tax_exempt ) {
2265                 $dbh->rollback if $oldAutoCommit;
2266                 return
2267                   'this customer still has old-style tax exemption records; '.
2268                   'run bin/fs-migrate-cust_tax_exempt?';
2269               }
2270
2271               foreach my $which_month ( 1 .. $freq ) {
2272
2273                 #maintain the new exemption table now
2274                 my $sql = "
2275                   SELECT SUM(amount)
2276                     FROM cust_tax_exempt_pkg
2277                       LEFT JOIN cust_bill_pkg USING ( billpkgnum )
2278                       LEFT JOIN cust_bill     USING ( invnum     )
2279                     WHERE custnum = ?
2280                       AND taxnum  = ?
2281                       AND year    = ?
2282                       AND month   = ?
2283                 ";
2284                 my $sth = dbh->prepare($sql) or do {
2285                   $dbh->rollback if $oldAutoCommit;
2286                   return "fatal: can't lookup exising exemption: ". dbh->errstr;
2287                 };
2288                 $sth->execute(
2289                   $self->custnum,
2290                   $tax->taxnum,
2291                   1900+$year,
2292                   $mon,
2293                 ) or do {
2294                   $dbh->rollback if $oldAutoCommit;
2295                   return "fatal: can't lookup exising exemption: ". dbh->errstr;
2296                 };
2297                 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
2298
2299                 my $remaining_exemption =
2300                   $tax->exempt_amount - $existing_exemption;
2301                 if ( $remaining_exemption > 0 ) {
2302                   my $addl = $remaining_exemption > $taxable_per_month
2303                     ? $taxable_per_month
2304                     : $remaining_exemption;
2305                   $taxable_charged -= $addl;
2306
2307                   my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg ( {
2308                     'billpkgnum' => $cust_bill_pkg->billpkgnum,
2309                     'taxnum'     => $tax->taxnum,
2310                     'year'       => 1900+$year,
2311                     'month'      => $mon,
2312                     'amount'     => sprintf("%.2f", $addl ),
2313                   } );
2314                   $error = $cust_tax_exempt_pkg->insert;
2315                   if ( $error ) {
2316                     $dbh->rollback if $oldAutoCommit;
2317                     return "fatal: can't insert cust_tax_exempt_pkg: $error";
2318                   }
2319                 } # if $remaining_exemption > 0
2320
2321                 #++
2322                 $mon++;
2323                 #until ( $mon < 12 ) { $mon -= 12; $year++; }
2324                 until ( $mon < 13 ) { $mon -= 12; $year++; }
2325
2326               } #foreach $which_month
2327
2328             } #if $tax->exempt_amount
2329
2330             $taxable_charged = sprintf( "%.2f", $taxable_charged);
2331
2332             #$tax += $taxable_charged * $cust_main_county->tax / 100
2333             $tax{ $tax->taxname || 'Tax' } +=
2334               $taxable_charged * $tax->tax / 100
2335
2336           } #foreach my $tax ( @taxes )
2337
2338         } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2339
2340       } #if $setup != 0 || $recur != 0
2341
2342     } #if $cust_pkg->modified
2343
2344   } #foreach my $cust_pkg
2345
2346   unless ( $cust_bill->cust_bill_pkg ) {
2347     $cust_bill->delete; #don't create an invoice w/o line items
2348
2349    # XXX this seems to be broken
2350    #( DBD::Pg::st execute failed: ERROR:  syntax error at or near "hcb" )
2351 #   # get rid of our fake history too, waste of unecessary space
2352 #    my $h_cleanup_query = q{
2353 #      DELETE FROM h_cust_bill hcb
2354 #       WHERE hcb.invnum = ?
2355 #      AND NOT EXISTS ( SELECT 1 FROM cust_bill cb where cb.invnum = hcb.invnum )
2356 #    };
2357 #    my $h_sth = $dbh->prepare($h_cleanup_query);
2358 #    $h_sth->execute($invnum);
2359
2360     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2361     return '';
2362   }
2363
2364   my $charged = sprintf( "%.2f", $total_setup + $total_recur );
2365
2366   foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2367     my $tax = sprintf("%.2f", $tax{$taxname} );
2368     $charged = sprintf( "%.2f", $charged+$tax );
2369
2370     my $cust_bill_pkg = new FS::cust_bill_pkg ({
2371       'invnum'   => $invnum,
2372       'pkgnum'   => 0,
2373       'setup'    => $tax,
2374       'recur'    => 0,
2375       'sdate'    => '',
2376       'edate'    => '',
2377       'itemdesc' => $taxname,
2378     });
2379     $error = $cust_bill_pkg->insert;
2380     if ( $error ) {
2381       $dbh->rollback if $oldAutoCommit;
2382       return "can't create invoice line item for invoice #$invnum: $error";
2383     }
2384     $total_setup += $tax;
2385
2386   }
2387
2388   $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2389   $error = $cust_bill->replace;
2390   if ( $error ) {
2391     $dbh->rollback if $oldAutoCommit;
2392     return "can't update charged for invoice #$invnum: $error";
2393   }
2394
2395   foreach my $hook ( @precommit_hooks ) {
2396     eval {
2397       &{$hook}; #($self) ?
2398     };
2399     if ( $@ ) {
2400       $dbh->rollback if $oldAutoCommit;
2401       return "$@ running precommit hook $hook\n";
2402     }
2403   }
2404
2405   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2406   ''; #no error
2407 }
2408
2409 =item collect OPTIONS
2410
2411 (Attempt to) collect money for this customer's outstanding invoices (see
2412 L<FS::cust_bill>).  Usually used after the bill method.
2413
2414 Actions are now triggered by billing events; see L<FS::part_event> and the
2415 billing events web interface.  Old-style invoice events (see
2416 L<FS::part_bill_event>) have been deprecated.
2417
2418 If there is an error, returns the error, otherwise returns false.
2419
2420 Options are passed as name-value pairs.
2421
2422 Currently available options are:
2423
2424 =over 4
2425
2426 =item invoice_time - 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.
2427
2428 =item retry - Retry card/echeck/LEC transactions even when not scheduled by invoice events.
2429
2430 =item quiet - set true to surpress email card/ACH decline notices.
2431
2432 =item check_freq - "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2433
2434 =item payby - allows for one time override of normal customer billing method
2435
2436 =back
2437
2438 =cut
2439
2440 sub collect {
2441   my( $self, %options ) = @_;
2442   my $invoice_time = $options{'invoice_time'} || time;
2443
2444   #put below somehow?
2445   local $SIG{HUP} = 'IGNORE';
2446   local $SIG{INT} = 'IGNORE';
2447   local $SIG{QUIT} = 'IGNORE';
2448   local $SIG{TERM} = 'IGNORE';
2449   local $SIG{TSTP} = 'IGNORE';
2450   local $SIG{PIPE} = 'IGNORE';
2451
2452   my $oldAutoCommit = $FS::UID::AutoCommit;
2453   local $FS::UID::AutoCommit = 0;
2454   my $dbh = dbh;
2455
2456   $self->select_for_update; #mutex
2457
2458   if ( $DEBUG ) {
2459     my $balance = $self->balance;
2460     warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2461   }
2462
2463   if ( exists($options{'retry_card'}) ) {
2464     carp 'retry_card option passed to collect is deprecated; use retry';
2465     $options{'retry'} ||= $options{'retry_card'};
2466   }
2467   if ( exists($options{'retry'}) && $options{'retry'} ) {
2468     my $error = $self->retry_realtime;
2469     if ( $error ) {
2470       $dbh->rollback if $oldAutoCommit;
2471       return $error;
2472     }
2473   }
2474
2475   # false laziness w/pay_batch::import_results
2476
2477   my $due_cust_event = $self->due_cust_event(
2478     'time'       => $invoice_time,
2479     'check_freq' => $options{'check_freq'},
2480   );
2481   unless( ref($due_cust_event) ) {
2482     $dbh->rollback if $oldAutoCommit;
2483     return $due_cust_event;
2484   }
2485
2486   foreach my $cust_event ( @$due_cust_event ) {
2487
2488     #XXX lock event
2489
2490     #re-eval event conditions (a previous event could have changed things)
2491     next unless $cust_event->test_conditions( 'time' => $invoice_time );
2492
2493     {
2494       local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2495       warn "  running cust_event ". $cust_event->eventnum. "\n"
2496         if $DEBUG > 1;
2497
2498
2499       #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2500       if ( my $error = $cust_event->do_event() ) {
2501         #XXX wtf is this?  figure out a proper dealio with return value
2502         #from do_event
2503           # gah, even with transactions.
2504           $dbh->commit if $oldAutoCommit; #well.
2505           return $error;
2506         }
2507     }
2508
2509   }
2510
2511   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2512   '';
2513
2514 }
2515
2516 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2517
2518 Inserts database records for and returns an ordered listref of new events due
2519 for this customer, as FS::cust_event objects (see L<FS::cust_event>).  If no
2520 events are due, an empty listref is returned.  If there is an error, returns a
2521 scalar error message.
2522
2523 To actually run the events, call each event's test_condition method, and if
2524 still true, call the event's do_event method.
2525
2526 Options are passed as a hashref or as a list of name-value pairs.  Available
2527 options are:
2528
2529 =over 4
2530
2531 =item check_freq - 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.
2532
2533 =item time - "Current time" for the events.
2534
2535 =item debug - Debugging level.  Default is 0 (no debugging), or can be set to 1 (passed-in options), 2 (traces progress), or 3 (more information)
2536
2537 =item eventtable - Only return events for the specified eventtable (by default, events of all eventtables are returned)
2538
2539 =item objects - Explicitly pass the objects to be tested (typically used with eventtable).
2540
2541 =back
2542
2543 =cut
2544
2545 sub due_cust_event {
2546   my $self = shift;
2547   my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2548
2549   #???
2550   #my $DEBUG = $opt{'debug'}
2551   local($DEBUG) = $opt{'debug'}
2552     if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
2553
2554   warn "$me due_cust_event called with options ".
2555        join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2556     if $DEBUG;
2557
2558   $opt{'time'} ||= time;
2559
2560   local $SIG{HUP} = 'IGNORE';
2561   local $SIG{INT} = 'IGNORE';
2562   local $SIG{QUIT} = 'IGNORE';
2563   local $SIG{TERM} = 'IGNORE';
2564   local $SIG{TSTP} = 'IGNORE';
2565   local $SIG{PIPE} = 'IGNORE';
2566
2567   my $oldAutoCommit = $FS::UID::AutoCommit;
2568   local $FS::UID::AutoCommit = 0;
2569   my $dbh = dbh;
2570
2571   $self->select_for_update; #mutex
2572
2573   ###
2574   # 1: find possible events (initial search)
2575   ###
2576
2577   my @cust_event = ();
2578
2579   my @eventtable = $opt{'eventtable'}
2580                      ? ( $opt{'eventtable'} )
2581                      : FS::part_event->eventtables_runorder;
2582
2583   foreach my $eventtable ( @eventtable ) {
2584
2585     my @objects;
2586     if ( $opt{'objects'} ) {
2587
2588       @objects = @{ $opt{'objects'} };
2589
2590     } else {
2591
2592       #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
2593       @objects = ( $eventtable eq 'cust_main' )
2594                    ? ( $self )
2595                    : ( $self->$eventtable() );
2596
2597     }
2598
2599     my @e_cust_event = ();
2600
2601     my $cross = "CROSS JOIN $eventtable";
2602     $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2603       unless $eventtable eq 'cust_main';
2604
2605     foreach my $object ( @objects ) {
2606
2607       #this first search uses the condition_sql magic for optimization.
2608       #the more possible events we can eliminate in this step the better
2609
2610       my $cross_where = '';
2611       my $pkey = $object->primary_key;
2612       $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2613
2614       my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2615       my $extra_sql =
2616         FS::part_event_condition->where_conditions_sql( $eventtable,
2617                                                         'time'=>$opt{'time'}
2618                                                       );
2619       my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2620
2621       $extra_sql = "AND $extra_sql" if $extra_sql;
2622
2623       #here is the agent virtualization
2624       $extra_sql .= " AND (    part_event.agentnum IS NULL
2625                             OR part_event.agentnum = ". $self->agentnum. ' )';
2626
2627       $extra_sql .= " $order";
2628
2629       my @part_event = qsearch( {
2630         'select'    => 'part_event.*',
2631         'table'     => 'part_event',
2632         'addl_from' => "$cross $join",
2633         'hashref'   => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
2634                          'eventtable' => $eventtable,
2635                          'disabled'   => '',
2636                        },
2637         'extra_sql' => "AND $cross_where $extra_sql",
2638       } );
2639
2640       if ( $DEBUG > 2 ) {
2641         my $pkey = $object->primary_key;
2642         warn "      ". scalar(@part_event).
2643              " possible events found for $eventtable ". $object->$pkey(). "\n";
2644       }
2645
2646       push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
2647
2648     }
2649
2650     warn "    ". scalar(@e_cust_event).
2651          " subtotal possible cust events found for $eventtable"
2652       if $DEBUG > 1;
2653
2654     push @cust_event, @e_cust_event;
2655
2656   }
2657
2658   warn "  ". scalar(@cust_event).
2659        " total possible cust events found in initial search\n"
2660     if $DEBUG; # > 1;
2661
2662   ##
2663   # 2: test conditions
2664   ##
2665
2666   my %unsat = ();
2667
2668   @cust_event = grep $_->test_conditions( 'time'          => $opt{'time'},
2669                                           'stats_hashref' => \%unsat ),
2670                      @cust_event;
2671
2672   warn "  ". scalar(@cust_event). " cust events left satisfying conditions\n"
2673     if $DEBUG; # > 1;
2674
2675   warn "    invalid conditions not eliminated with condition_sql:\n".
2676        join('', map "      $_: ".$unsat{$_}."\n", keys %unsat );
2677
2678   ##
2679   # 3: insert
2680   ##
2681
2682   foreach my $cust_event ( @cust_event ) {
2683
2684     my $error = $cust_event->insert();
2685     if ( $error ) {
2686       $dbh->rollback if $oldAutoCommit;
2687       return $error;
2688     }
2689
2690   }
2691
2692   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2693
2694   ##
2695   # 4: return
2696   ##
2697
2698   warn "  returning events: ". Dumper(@cust_event). "\n"
2699     if $DEBUG > 2;
2700
2701   \@cust_event;
2702
2703 }
2704
2705 =item retry_realtime
2706
2707 Schedules realtime / batch  credit card / electronic check / LEC billing
2708 events for for retry.  Useful if card information has changed or manual
2709 retry is desired.  The 'collect' method must be called to actually retry
2710 the transaction.
2711
2712 Implementation details: For either this customer, or for each of this
2713 customer's open invoices, changes the status of the first "done" (with
2714 statustext error) realtime processing event to "failed".
2715
2716 =cut
2717
2718 sub retry_realtime {
2719   my $self = shift;
2720
2721   local $SIG{HUP} = 'IGNORE';
2722   local $SIG{INT} = 'IGNORE';
2723   local $SIG{QUIT} = 'IGNORE';
2724   local $SIG{TERM} = 'IGNORE';
2725   local $SIG{TSTP} = 'IGNORE';
2726   local $SIG{PIPE} = 'IGNORE';
2727
2728   my $oldAutoCommit = $FS::UID::AutoCommit;
2729   local $FS::UID::AutoCommit = 0;
2730   my $dbh = dbh;
2731
2732   #a little false laziness w/due_cust_event (not too bad, really)
2733
2734   my $join = FS::part_event_condition->join_conditions_sql;
2735   my $order = FS::part_event_condition->order_conditions_sql;
2736   my $mine =
2737   '( '
2738    . join ( ' OR ' , map {
2739     "( part_event.eventtable = " . dbh->quote($_)
2740     . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
2741    } FS::part_event->eventtables)
2742    . ') ';
2743
2744   #here is the agent virtualization
2745   my $agent_virt = " (    part_event.agentnum IS NULL
2746                        OR part_event.agentnum = ". $self->agentnum. ' )';
2747
2748   #XXX this shouldn't be hardcoded, actions should declare it...
2749   my @realtime_events = qw(
2750     cust_bill_realtime_card
2751     cust_bill_realtime_check
2752     cust_bill_realtime_lec
2753     cust_bill_batch
2754   );
2755
2756   my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
2757                                                   @realtime_events
2758                                      ).
2759                           ' ) ';
2760
2761   my @cust_event = qsearchs({
2762     'table'     => 'cust_event',
2763     'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
2764     'hashref'   => { 'status' => 'done' },
2765     'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
2766                    " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
2767   });
2768
2769   my %seen_invnum = ();
2770   foreach my $cust_event (@cust_event) {
2771
2772     #max one for the customer, one for each open invoice
2773     my $cust_X = $cust_event->cust_X;
2774     next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
2775                           ? $cust_X->invnum
2776                           : 0
2777                         }++
2778          or $cust_event->part_event->eventtable eq 'cust_bill'
2779             && ! $cust_X->owed;
2780
2781     my $error = $cust_event->retry;
2782     if ( $error ) {
2783       $dbh->rollback if $oldAutoCommit;
2784       return "error scheduling event for retry: $error";
2785     }
2786
2787   }
2788
2789   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2790   '';
2791
2792 }
2793
2794 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2795
2796 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2797 via a Business::OnlinePayment realtime gateway.  See
2798 L<http://420.am/business-onlinepayment> for supported gateways.
2799
2800 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2801
2802 Available options are: I<description>, I<invnum>, I<quiet>
2803
2804 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2805 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
2806 if set, will override the value from the customer record.
2807
2808 I<description> is a free-text field passed to the gateway.  It defaults to
2809 "Internet services".
2810
2811 If an I<invnum> is specified, this payment (if successful) is applied to the
2812 specified invoice.  If you don't specify an I<invnum> you might want to
2813 call the B<apply_payments> method.
2814
2815 I<quiet> can be set true to surpress email decline notices.
2816
2817 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2818
2819 =cut
2820
2821 sub realtime_bop {
2822   my( $self, $method, $amount, %options ) = @_;
2823   if ( $DEBUG ) {
2824     warn "$me realtime_bop: $method $amount\n";
2825     warn "  $_ => $options{$_}\n" foreach keys %options;
2826   }
2827
2828   $options{'description'} ||= 'Internet services';
2829
2830   eval "use Business::OnlinePayment";
2831   die $@ if $@;
2832
2833   my $payinfo = exists($options{'payinfo'})
2834                   ? $options{'payinfo'}
2835                   : $self->payinfo;
2836
2837   my %method2payby = (
2838     'CC'     => 'CARD',
2839     'ECHECK' => 'CHEK',
2840     'LEC'    => 'LECB',
2841   );
2842
2843   ###
2844   # check for banned credit card/ACH
2845   ###
2846
2847   my $ban = qsearchs('banned_pay', {
2848     'payby'   => $method2payby{$method},
2849     'payinfo' => md5_base64($payinfo),
2850   } );
2851   return "Banned credit card" if $ban;
2852
2853   ###
2854   # select a gateway
2855   ###
2856
2857   my $taxclass = '';
2858   if ( $options{'invnum'} ) {
2859     my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2860     die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2861     my @taxclasses =
2862       map  { $_->part_pkg->taxclass }
2863       grep { $_ }
2864       map  { $_->cust_pkg }
2865       $cust_bill->cust_bill_pkg;
2866     unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2867                                                            #different taxclasses
2868       $taxclass = $taxclasses[0];
2869     }
2870   }
2871
2872   #look for an agent gateway override first
2873   my $cardtype;
2874   if ( $method eq 'CC' ) {
2875     $cardtype = cardtype($payinfo);
2876   } elsif ( $method eq 'ECHECK' ) {
2877     $cardtype = 'ACH';
2878   } else {
2879     $cardtype = $method;
2880   }
2881
2882   my $override =
2883        qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2884                                            cardtype => $cardtype,
2885                                            taxclass => $taxclass,       } )
2886     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2887                                            cardtype => '',
2888                                            taxclass => $taxclass,       } )
2889     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2890                                            cardtype => $cardtype,
2891                                            taxclass => '',              } )
2892     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2893                                            cardtype => '',
2894                                            taxclass => '',              } );
2895
2896   my $payment_gateway = '';
2897   my( $processor, $login, $password, $action, @bop_options );
2898   if ( $override ) { #use a payment gateway override
2899
2900     $payment_gateway = $override->payment_gateway;
2901
2902     $processor   = $payment_gateway->gateway_module;
2903     $login       = $payment_gateway->gateway_username;
2904     $password    = $payment_gateway->gateway_password;
2905     $action      = $payment_gateway->gateway_action;
2906     @bop_options = $payment_gateway->options;
2907
2908   } else { #use the standard settings from the config
2909
2910     ( $processor, $login, $password, $action, @bop_options ) =
2911       $self->default_payment_gateway($method);
2912
2913   }
2914
2915   ###
2916   # massage data
2917   ###
2918
2919   my $address = exists($options{'address1'})
2920                     ? $options{'address1'}
2921                     : $self->address1;
2922   my $address2 = exists($options{'address2'})
2923                     ? $options{'address2'}
2924                     : $self->address2;
2925   $address .= ", ". $address2 if length($address2);
2926
2927   my $o_payname = exists($options{'payname'})
2928                     ? $options{'payname'}
2929                     : $self->payname;
2930   my($payname, $payfirst, $paylast);
2931   if ( $o_payname && $method ne 'ECHECK' ) {
2932     ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2933       or return "Illegal payname $payname";
2934     ($payfirst, $paylast) = ($1, $2);
2935   } else {
2936     $payfirst = $self->getfield('first');
2937     $paylast = $self->getfield('last');
2938     $payname =  "$payfirst $paylast";
2939   }
2940
2941   my @invoicing_list = $self->invoicing_list_emailonly;
2942   if ( $conf->exists('emailinvoiceautoalways')
2943        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
2944        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
2945     push @invoicing_list, $self->all_emails;
2946   }
2947
2948   my $email = ($conf->exists('business-onlinepayment-email-override'))
2949               ? $conf->config('business-onlinepayment-email-override')
2950               : $invoicing_list[0];
2951
2952   my %content = ();
2953
2954   my $payip = exists($options{'payip'})
2955                 ? $options{'payip'}
2956                 : $self->payip;
2957   $content{customer_ip} = $payip
2958     if length($payip);
2959
2960   $content{invoice_number} = $options{'invnum'}
2961     if exists($options{'invnum'}) && length($options{'invnum'});
2962
2963   my $paydate = '';
2964   if ( $method eq 'CC' ) {
2965
2966     $content{card_number} = $payinfo;
2967     $paydate = exists($options{'paydate'})
2968                     ? $options{'paydate'}
2969                     : $self->paydate;
2970     $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2971     $content{expiration} = "$2/$1";
2972
2973     my $paycvv = exists($options{'paycvv'})
2974                    ? $options{'paycvv'}
2975                    : $self->paycvv;
2976     $content{cvv2} = $self->paycvv
2977       if length($paycvv);
2978
2979     my $paystart_month = exists($options{'paystart_month'})
2980                            ? $options{'paystart_month'}
2981                            : $self->paystart_month;
2982
2983     my $paystart_year  = exists($options{'paystart_year'})
2984                            ? $options{'paystart_year'}
2985                            : $self->paystart_year;
2986
2987     $content{card_start} = "$paystart_month/$paystart_year"
2988       if $paystart_month && $paystart_year;
2989
2990     my $payissue       = exists($options{'payissue'})
2991                            ? $options{'payissue'}
2992                            : $self->payissue;
2993     $content{issue_number} = $payissue if $payissue;
2994
2995     $content{recurring_billing} = 'YES'
2996       if qsearch('cust_pay', { 'custnum' => $self->custnum,
2997                                'payby'   => 'CARD',
2998                                'payinfo' => $payinfo,
2999                              } )
3000       || qsearch('cust_pay', { 'custnum' => $self->custnum,
3001                                'payby'   => 'CARD',
3002                                'paymask' => $self->mask_payinfo('CARD', $payinfo),
3003                              } );
3004
3005
3006   } elsif ( $method eq 'ECHECK' ) {
3007     ( $content{account_number}, $content{routing_code} ) =
3008       split('@', $payinfo);
3009     $content{bank_name} = $o_payname;
3010     $content{bank_state} = exists($options{'paystate'})
3011                              ? $options{'paystate'}
3012                              : $self->getfield('paystate');
3013     $content{account_type} = exists($options{'paytype'})
3014                                ? uc($options{'paytype'}) || 'CHECKING'
3015                                : uc($self->getfield('paytype')) || 'CHECKING';
3016     $content{account_name} = $payname;
3017     $content{customer_org} = $self->company ? 'B' : 'I';
3018     $content{state_id}       = exists($options{'stateid'})
3019                                  ? $options{'stateid'}
3020                                  : $self->getfield('stateid');
3021     $content{state_id_state} = exists($options{'stateid_state'})
3022                                  ? $options{'stateid_state'}
3023                                  : $self->getfield('stateid_state');
3024     $content{customer_ssn} = exists($options{'ss'})
3025                                ? $options{'ss'}
3026                                : $self->ss;
3027   } elsif ( $method eq 'LEC' ) {
3028     $content{phone} = $payinfo;
3029   }
3030
3031   ###
3032   # run transaction(s)
3033   ###
3034
3035   my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3036
3037   my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3038   $transaction->content(
3039     'type'           => $method,
3040     'login'          => $login,
3041     'password'       => $password,
3042     'action'         => $action1,
3043     'description'    => $options{'description'},
3044     'amount'         => $amount,
3045     #'invoice_number' => $options{'invnum'},
3046     'customer_id'    => $self->custnum,
3047     'last_name'      => $paylast,
3048     'first_name'     => $payfirst,
3049     'name'           => $payname,
3050     'address'        => $address,
3051     'city'           => ( exists($options{'city'})
3052                             ? $options{'city'}
3053                             : $self->city          ),
3054     'state'          => ( exists($options{'state'})
3055                             ? $options{'state'}
3056                             : $self->state          ),
3057     'zip'            => ( exists($options{'zip'})
3058                             ? $options{'zip'}
3059                             : $self->zip          ),
3060     'country'        => ( exists($options{'country'})
3061                             ? $options{'country'}
3062                             : $self->country          ),
3063     'referer'        => 'http://cleanwhisker.420.am/',
3064     'email'          => $email,
3065     'phone'          => $self->daytime || $self->night,
3066     %content, #after
3067   );
3068   $transaction->submit();
3069
3070   if ( $transaction->is_success() && $action2 ) {
3071     my $auth = $transaction->authorization;
3072     my $ordernum = $transaction->can('order_number')
3073                    ? $transaction->order_number
3074                    : '';
3075
3076     my $capture =
3077       new Business::OnlinePayment( $processor, @bop_options );
3078
3079     my %capture = (
3080       %content,
3081       type           => $method,
3082       action         => $action2,
3083       login          => $login,
3084       password       => $password,
3085       order_number   => $ordernum,
3086       amount         => $amount,
3087       authorization  => $auth,
3088       description    => $options{'description'},
3089     );
3090
3091     foreach my $field (qw( authorization_source_code returned_ACI
3092                            transaction_identifier validation_code
3093                            transaction_sequence_num local_transaction_date
3094                            local_transaction_time AVS_result_code          )) {
3095       $capture{$field} = $transaction->$field() if $transaction->can($field);
3096     }
3097
3098     $capture->content( %capture );
3099
3100     $capture->submit();
3101
3102     unless ( $capture->is_success ) {
3103       my $e = "Authorization successful but capture failed, custnum #".
3104               $self->custnum. ': '.  $capture->result_code.
3105               ": ". $capture->error_message;
3106       warn $e;
3107       return $e;
3108     }
3109
3110   }
3111
3112   ###
3113   # remove paycvv after initial transaction
3114   ###
3115
3116   #false laziness w/misc/process/payment.cgi - check both to make sure working
3117   # correctly
3118   if ( defined $self->dbdef_table->column('paycvv')
3119        && length($self->paycvv)
3120        && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3121   ) {
3122     my $error = $self->remove_cvv;
3123     if ( $error ) {
3124       warn "WARNING: error removing cvv: $error\n";
3125     }
3126   }
3127
3128   ###
3129   # result handling
3130   ###
3131
3132   if ( $transaction->is_success() ) {
3133
3134     my %method2payby = (
3135       'CC'     => 'CARD',
3136       'ECHECK' => 'CHEK',
3137       'LEC'    => 'LECB',
3138     );
3139
3140     my $paybatch = '';
3141     if ( $payment_gateway ) { # agent override
3142       $paybatch = $payment_gateway->gatewaynum. '-';
3143     }
3144
3145     $paybatch .= "$processor:". $transaction->authorization;
3146
3147     $paybatch .= ':'. $transaction->order_number
3148       if $transaction->can('order_number')
3149       && length($transaction->order_number);
3150
3151     my $cust_pay = new FS::cust_pay ( {
3152        'custnum'  => $self->custnum,
3153        'invnum'   => $options{'invnum'},
3154        'paid'     => $amount,
3155        '_date'     => '',
3156        'payby'    => $method2payby{$method},
3157        'payinfo'  => $payinfo,
3158        'paybatch' => $paybatch,
3159        'paydate'  => $paydate,
3160     } );
3161     $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
3162
3163     my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3164
3165     if ( $error ) {
3166       $cust_pay->invnum(''); #try again with no specific invnum
3167       my $error2 = $cust_pay->insert( $options{'manual'} ?
3168                                       ( 'manual' => 1 ) : ()
3169                                     );
3170       if ( $error2 ) {
3171         # gah, even with transactions.
3172         my $e = 'WARNING: Card/ACH debited but database not updated - '.
3173                 "error inserting payment ($processor): $error2".
3174                 " (previously tried insert with invnum #$options{'invnum'}" .
3175                 ": $error )";
3176         warn $e;
3177         return $e;
3178       }
3179     }
3180     return ''; #no error
3181
3182   } else {
3183
3184     my $perror = "$processor error: ". $transaction->error_message;
3185
3186     unless ( $transaction->error_message ) {
3187
3188       my $t_response;
3189       if ( $transaction->can('response_page') ) {
3190         $t_response = {
3191                         'page'    => ( $transaction->can('response_page')
3192                                          ? $transaction->response_page
3193                                          : ''
3194                                      ),
3195                         'code'    => ( $transaction->can('response_code')
3196                                          ? $transaction->response_code
3197                                          : ''
3198                                      ),
3199                         'headers' => ( $transaction->can('response_headers')
3200                                          ? $transaction->response_headers
3201                                          : ''
3202                                      ),
3203                       };
3204       } else {
3205         $t_response .=
3206           "No additional debugging information available for $processor";
3207       }
3208
3209       $perror .= "No error_message returned from $processor -- ".
3210                  ( ref($t_response) ? Dumper($t_response) : $t_response );
3211
3212     }
3213
3214     if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
3215          && $conf->exists('emaildecline')
3216          && grep { $_ ne 'POST' } $self->invoicing_list
3217          && ! grep { $transaction->error_message =~ /$_/ }
3218                    $conf->config('emaildecline-exclude')
3219     ) {
3220       my @templ = $conf->config('declinetemplate');
3221       my $template = new Text::Template (
3222         TYPE   => 'ARRAY',
3223         SOURCE => [ map "$_\n", @templ ],
3224       ) or return "($perror) can't create template: $Text::Template::ERROR";
3225       $template->compile()
3226         or return "($perror) can't compile template: $Text::Template::ERROR";
3227
3228       my $templ_hash = { error => $transaction->error_message };
3229
3230       my $error = send_email(
3231         'from'    => $conf->config('invoice_from'),
3232         'to'      => [ grep { $_ ne 'POST' } $self->invoicing_list ],
3233         'subject' => 'Your payment could not be processed',
3234         'body'    => [ $template->fill_in(HASH => $templ_hash) ],
3235       );
3236
3237       $perror .= " (also received error sending decline notification: $error)"
3238         if $error;
3239
3240     }
3241
3242     return $perror;
3243   }
3244
3245 }
3246
3247 =item default_payment_gateway
3248
3249 =cut
3250
3251 sub default_payment_gateway {
3252   my( $self, $method ) = @_;
3253
3254   die "Real-time processing not enabled\n"
3255     unless $conf->exists('business-onlinepayment');
3256
3257   #load up config
3258   my $bop_config = 'business-onlinepayment';
3259   $bop_config .= '-ach'
3260     if $method eq 'ECHECK' && $conf->exists($bop_config. '-ach');
3261   my ( $processor, $login, $password, $action, @bop_options ) =
3262     $conf->config($bop_config);
3263   $action ||= 'normal authorization';
3264   pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3265   die "No real-time processor is enabled - ".
3266       "did you set the business-onlinepayment configuration value?\n"
3267     unless $processor;
3268
3269   ( $processor, $login, $password, $action, @bop_options )
3270 }
3271
3272 =item remove_cvv
3273
3274 Removes the I<paycvv> field from the database directly.
3275
3276 If there is an error, returns the error, otherwise returns false.
3277
3278 =cut
3279
3280 sub remove_cvv {
3281   my $self = shift;
3282   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3283     or return dbh->errstr;
3284   $sth->execute($self->custnum)
3285     or return $sth->errstr;
3286   $self->paycvv('');
3287   '';
3288 }
3289
3290 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3291
3292 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3293 via a Business::OnlinePayment realtime gateway.  See
3294 L<http://420.am/business-onlinepayment> for supported gateways.
3295
3296 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3297
3298 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3299
3300 Most gateways require a reference to an original payment transaction to refund,
3301 so you probably need to specify a I<paynum>.
3302
3303 I<amount> defaults to the original amount of the payment if not specified.
3304
3305 I<reason> specifies a reason for the refund.
3306
3307 I<paydate> specifies the expiration date for a credit card overriding the
3308 value from the customer record or the payment record. Specified as yyyy-mm-dd
3309
3310 Implementation note: If I<amount> is unspecified or equal to the amount of the
3311 orignal payment, first an attempt is made to "void" the transaction via
3312 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3313 the normal attempt is made to "refund" ("credit") the transaction via the
3314 gateway is attempted.
3315
3316 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3317 #I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
3318 #if set, will override the value from the customer record.
3319
3320 #If an I<invnum> is specified, this payment (if successful) is applied to the
3321 #specified invoice.  If you don't specify an I<invnum> you might want to
3322 #call the B<apply_payments> method.
3323
3324 =cut
3325
3326 #some false laziness w/realtime_bop, not enough to make it worth merging
3327 #but some useful small subs should be pulled out
3328 sub realtime_refund_bop {
3329   my( $self, $method, %options ) = @_;
3330   if ( $DEBUG ) {
3331     warn "$me realtime_refund_bop: $method refund\n";
3332     warn "  $_ => $options{$_}\n" foreach keys %options;
3333   }
3334
3335   eval "use Business::OnlinePayment";
3336   die $@ if $@;
3337
3338   ###
3339   # look up the original payment and optionally a gateway for that payment
3340   ###
3341
3342   my $cust_pay = '';
3343   my $amount = $options{'amount'};
3344
3345   my( $processor, $login, $password, @bop_options ) ;
3346   my( $auth, $order_number ) = ( '', '', '' );
3347
3348   if ( $options{'paynum'} ) {
3349
3350     warn "  paynum: $options{paynum}\n" if $DEBUG > 1;
3351     $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3352       or return "Unknown paynum $options{'paynum'}";
3353     $amount ||= $cust_pay->paid;
3354
3355     $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3356       or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3357                 $cust_pay->paybatch;
3358     my $gatewaynum = '';
3359     ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3360
3361     if ( $gatewaynum ) { #gateway for the payment to be refunded
3362
3363       my $payment_gateway =
3364         qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3365       die "payment gateway $gatewaynum not found"
3366         unless $payment_gateway;
3367
3368       $processor   = $payment_gateway->gateway_module;
3369       $login       = $payment_gateway->gateway_username;
3370       $password    = $payment_gateway->gateway_password;
3371       @bop_options = $payment_gateway->options;
3372
3373     } else { #try the default gateway
3374
3375       my( $conf_processor, $unused_action );
3376       ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3377         $self->default_payment_gateway($method);
3378
3379       return "processor of payment $options{'paynum'} $processor does not".
3380              " match default processor $conf_processor"
3381         unless $processor eq $conf_processor;
3382
3383     }
3384
3385
3386   } else { # didn't specify a paynum, so look for agent gateway overrides
3387            # like a normal transaction
3388
3389     my $cardtype;
3390     if ( $method eq 'CC' ) {
3391       $cardtype = cardtype($self->payinfo);
3392     } elsif ( $method eq 'ECHECK' ) {
3393       $cardtype = 'ACH';
3394     } else {
3395       $cardtype = $method;
3396     }
3397     my $override =
3398            qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3399                                                cardtype => $cardtype,
3400                                                taxclass => '',              } )
3401         || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3402                                                cardtype => '',
3403                                                taxclass => '',              } );
3404
3405     if ( $override ) { #use a payment gateway override
3406
3407       my $payment_gateway = $override->payment_gateway;
3408
3409       $processor   = $payment_gateway->gateway_module;
3410       $login       = $payment_gateway->gateway_username;
3411       $password    = $payment_gateway->gateway_password;
3412       #$action      = $payment_gateway->gateway_action;
3413       @bop_options = $payment_gateway->options;
3414
3415     } else { #use the standard settings from the config
3416
3417       my $unused_action;
3418       ( $processor, $login, $password, $unused_action, @bop_options ) =
3419         $self->default_payment_gateway($method);
3420
3421     }
3422
3423   }
3424   return "neither amount nor paynum specified" unless $amount;
3425
3426   my %content = (
3427     'type'           => $method,
3428     'login'          => $login,
3429     'password'       => $password,
3430     'order_number'   => $order_number,
3431     'amount'         => $amount,
3432     'referer'        => 'http://cleanwhisker.420.am/',
3433   );
3434   $content{authorization} = $auth
3435     if length($auth); #echeck/ACH transactions have an order # but no auth
3436                       #(at least with authorize.net)
3437
3438   my $disable_void_after;
3439   if ($conf->exists('disable_void_after')
3440       && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3441     $disable_void_after = $1;
3442   }
3443
3444   #first try void if applicable
3445   if ( $cust_pay && $cust_pay->paid == $amount
3446     && (
3447       ( not defined($disable_void_after) )
3448       || ( time < ($cust_pay->_date + $disable_void_after ) )
3449     )
3450   ) {
3451     warn "  attempting void\n" if $DEBUG > 1;
3452     my $void = new Business::OnlinePayment( $processor, @bop_options );
3453     $void->content( 'action' => 'void', %content );
3454     $void->submit();
3455     if ( $void->is_success ) {
3456       my $error = $cust_pay->void($options{'reason'});
3457       if ( $error ) {
3458         # gah, even with transactions.
3459         my $e = 'WARNING: Card/ACH voided but database not updated - '.
3460                 "error voiding payment: $error";
3461         warn $e;
3462         return $e;
3463       }
3464       warn "  void successful\n" if $DEBUG > 1;
3465       return '';
3466     }
3467   }
3468
3469   warn "  void unsuccessful, trying refund\n"
3470     if $DEBUG > 1;
3471
3472   #massage data
3473   my $address = $self->address1;
3474   $address .= ", ". $self->address2 if $self->address2;
3475
3476   my($payname, $payfirst, $paylast);
3477   if ( $self->payname && $method ne 'ECHECK' ) {
3478     $payname = $self->payname;
3479     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3480       or return "Illegal payname $payname";
3481     ($payfirst, $paylast) = ($1, $2);
3482   } else {
3483     $payfirst = $self->getfield('first');
3484     $paylast = $self->getfield('last');
3485     $payname =  "$payfirst $paylast";
3486   }
3487
3488   my @invoicing_list = $self->invoicing_list_emailonly;
3489   if ( $conf->exists('emailinvoiceautoalways')
3490        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3491        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3492     push @invoicing_list, $self->all_emails;
3493   }
3494
3495   my $email = ($conf->exists('business-onlinepayment-email-override'))
3496               ? $conf->config('business-onlinepayment-email-override')
3497               : $invoicing_list[0];
3498
3499   my $payip = exists($options{'payip'})
3500                 ? $options{'payip'}
3501                 : $self->payip;
3502   $content{customer_ip} = $payip
3503     if length($payip);
3504
3505   my $payinfo = '';
3506   if ( $method eq 'CC' ) {
3507
3508     if ( $cust_pay ) {
3509       $content{card_number} = $payinfo = $cust_pay->payinfo;
3510       (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
3511         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
3512         ($content{expiration} = "$2/$1");  # where available
3513     } else {
3514       $content{card_number} = $payinfo = $self->payinfo;
3515       (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
3516         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3517       $content{expiration} = "$2/$1";
3518     }
3519
3520   } elsif ( $method eq 'ECHECK' ) {
3521
3522     if ( $cust_pay ) {
3523       $payinfo = $cust_pay->payinfo;
3524     } else {
3525       $payinfo = $self->payinfo;
3526     }
3527     ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
3528     $content{bank_name} = $self->payname;
3529     $content{account_type} = 'CHECKING';
3530     $content{account_name} = $payname;
3531     $content{customer_org} = $self->company ? 'B' : 'I';
3532     $content{customer_ssn} = $self->ss;
3533   } elsif ( $method eq 'LEC' ) {
3534     $content{phone} = $payinfo = $self->payinfo;
3535   }
3536
3537   #then try refund
3538   my $refund = new Business::OnlinePayment( $processor, @bop_options );
3539   my %sub_content = $refund->content(
3540     'action'         => 'credit',
3541     'customer_id'    => $self->custnum,
3542     'last_name'      => $paylast,
3543     'first_name'     => $payfirst,
3544     'name'           => $payname,
3545     'address'        => $address,
3546     'city'           => $self->city,
3547     'state'          => $self->state,
3548     'zip'            => $self->zip,
3549     'country'        => $self->country,
3550     'email'          => $email,
3551     'phone'          => $self->daytime || $self->night,
3552     %content, #after
3553   );
3554   warn join('', map { "  $_ => $sub_content{$_}\n" } keys %sub_content )
3555     if $DEBUG > 1;
3556   $refund->submit();
3557
3558   return "$processor error: ". $refund->error_message
3559     unless $refund->is_success();
3560
3561   my %method2payby = (
3562     'CC'     => 'CARD',
3563     'ECHECK' => 'CHEK',
3564     'LEC'    => 'LECB',
3565   );
3566
3567   my $paybatch = "$processor:". $refund->authorization;
3568   $paybatch .= ':'. $refund->order_number
3569     if $refund->can('order_number') && $refund->order_number;
3570
3571   while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3572     my @cust_bill_pay = $cust_pay->cust_bill_pay;
3573     last unless @cust_bill_pay;
3574     my $cust_bill_pay = pop @cust_bill_pay;
3575     my $error = $cust_bill_pay->delete;
3576     last if $error;
3577   }
3578
3579   my $cust_refund = new FS::cust_refund ( {
3580     'custnum'  => $self->custnum,
3581     'paynum'   => $options{'paynum'},
3582     'refund'   => $amount,
3583     '_date'    => '',
3584     'payby'    => $method2payby{$method},
3585     'payinfo'  => $payinfo,
3586     'paybatch' => $paybatch,
3587     'reason'   => $options{'reason'} || 'card or ACH refund',
3588   } );
3589   my $error = $cust_refund->insert;
3590   if ( $error ) {
3591     $cust_refund->paynum(''); #try again with no specific paynum
3592     my $error2 = $cust_refund->insert;
3593     if ( $error2 ) {
3594       # gah, even with transactions.
3595       my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3596               "error inserting refund ($processor): $error2".
3597               " (previously tried insert with paynum #$options{'paynum'}" .
3598               ": $error )";
3599       warn $e;
3600       return $e;
3601     }
3602   }
3603
3604   ''; #no error
3605
3606 }
3607
3608 =item batch_card OPTION => VALUE...
3609
3610 Adds a payment for this invoice to the pending credit card batch (see
3611 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
3612 runs the payment using a realtime gateway.
3613
3614 =cut
3615
3616 sub batch_card {
3617   my ($self, %options) = @_;
3618
3619   my $amount;
3620   if (exists($options{amount})) {
3621     $amount = $options{amount};
3622   }else{
3623     $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
3624   }
3625   return '' unless $amount > 0;
3626
3627   my $invnum = delete $options{invnum};
3628   my $payby = $options{invnum} || $self->payby;  #dubious
3629
3630   if ($options{'realtime'}) {
3631     return $self->realtime_bop( FS::payby->payby2bop($self->payby),
3632                                 $amount,
3633                                 %options,
3634                               );
3635   }
3636
3637   my $oldAutoCommit = $FS::UID::AutoCommit;
3638   local $FS::UID::AutoCommit = 0;
3639   my $dbh = dbh;
3640
3641   $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
3642     or return "Cannot lock pay_batch: " . $dbh->errstr;
3643
3644   my %pay_batch = (
3645     'status' => 'O',
3646     'payby'  => FS::payby->payby2payment($payby),
3647   );
3648
3649   my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
3650
3651   unless ( $pay_batch ) {
3652     $pay_batch = new FS::pay_batch \%pay_batch;
3653     my $error = $pay_batch->insert;
3654     if ( $error ) {
3655       $dbh->rollback if $oldAutoCommit;
3656       die "error creating new batch: $error\n";
3657     }
3658   }
3659
3660   my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
3661       'batchnum' => $pay_batch->batchnum,
3662       'custnum'  => $self->custnum,
3663   } );
3664
3665   foreach (qw( address1 address2 city state zip country payby payinfo paydate
3666                payname )) {
3667     $options{$_} = '' unless exists($options{$_});
3668   }
3669
3670   my $cust_pay_batch = new FS::cust_pay_batch ( {
3671     'batchnum' => $pay_batch->batchnum,
3672     'invnum'   => $invnum || 0,                    # is there a better value?
3673                                                    # this field should be
3674                                                    # removed...
3675                                                    # cust_bill_pay_batch now
3676     'custnum'  => $self->custnum,
3677     'last'     => $self->getfield('last'),
3678     'first'    => $self->getfield('first'),
3679     'address1' => $options{address1} || $self->address1,
3680     'address2' => $options{address2} || $self->address2,
3681     'city'     => $options{city}     || $self->city,
3682     'state'    => $options{state}    || $self->state,
3683     'zip'      => $options{zip}      || $self->zip,
3684     'country'  => $options{country}  || $self->country,
3685     'payby'    => $options{payby}    || $self->payby,
3686     'payinfo'  => $options{payinfo}  || $self->payinfo,
3687     'exp'      => $options{paydate}  || $self->paydate,
3688     'payname'  => $options{payname}  || $self->payname,
3689     'amount'   => $amount,                         # consolidating
3690   } );
3691
3692   $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
3693     if $old_cust_pay_batch;
3694
3695   my $error;
3696   if ($old_cust_pay_batch) {
3697     $error = $cust_pay_batch->replace($old_cust_pay_batch)
3698   } else {
3699     $error = $cust_pay_batch->insert;
3700   }
3701
3702   if ( $error ) {
3703     $dbh->rollback if $oldAutoCommit;
3704     die $error;
3705   }
3706
3707   my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
3708   foreach my $cust_bill ($self->open_cust_bill) {
3709     #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
3710     my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
3711       'invnum' => $cust_bill->invnum,
3712       'paybatchnum' => $cust_pay_batch->paybatchnum,
3713       'amount' => $cust_bill->owed,
3714       '_date' => time,
3715     };
3716     if ($unapplied >= $cust_bill_pay_batch->amount){
3717       $unapplied -= $cust_bill_pay_batch->amount;
3718       next;
3719     }else{
3720       $cust_bill_pay_batch->amount(sprintf ( "%.2f",
3721                                    $cust_bill_pay_batch->amount - $unapplied ));      $unapplied = 0;
3722     }
3723     $error = $cust_bill_pay_batch->insert;
3724     if ( $error ) {
3725       $dbh->rollback if $oldAutoCommit;
3726       die $error;
3727     }
3728   }
3729
3730   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3731   '';
3732 }
3733
3734 =item total_owed
3735
3736 Returns the total owed for this customer on all invoices
3737 (see L<FS::cust_bill/owed>).
3738
3739 =cut
3740
3741 sub total_owed {
3742   my $self = shift;
3743   $self->total_owed_date(2145859200); #12/31/2037
3744 }
3745
3746 =item total_owed_date TIME
3747
3748 Returns the total owed for this customer on all invoices with date earlier than
3749 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
3750 see L<Time::Local> and L<Date::Parse> for conversion functions.
3751
3752 =cut
3753
3754 sub total_owed_date {
3755   my $self = shift;
3756   my $time = shift;
3757   my $total_bill = 0;
3758   foreach my $cust_bill (
3759     grep { $_->_date <= $time }
3760       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3761   ) {
3762     $total_bill += $cust_bill->owed;
3763   }
3764   sprintf( "%.2f", $total_bill );
3765 }
3766
3767 =item apply_payments_and_credits
3768
3769 Applies unapplied payments and credits.
3770
3771 In most cases, this new method should be used in place of sequential
3772 apply_payments and apply_credits methods.
3773
3774 If there is an error, returns the error, otherwise returns false.
3775
3776 =cut
3777
3778 sub apply_payments_and_credits {
3779   my $self = shift;
3780
3781   local $SIG{HUP} = 'IGNORE';
3782   local $SIG{INT} = 'IGNORE';
3783   local $SIG{QUIT} = 'IGNORE';
3784   local $SIG{TERM} = 'IGNORE';
3785   local $SIG{TSTP} = 'IGNORE';
3786   local $SIG{PIPE} = 'IGNORE';
3787
3788   my $oldAutoCommit = $FS::UID::AutoCommit;
3789   local $FS::UID::AutoCommit = 0;
3790   my $dbh = dbh;
3791
3792   $self->select_for_update; #mutex
3793
3794   foreach my $cust_bill ( $self->open_cust_bill ) {
3795     my $error = $cust_bill->apply_payments_and_credits;
3796     if ( $error ) {
3797       $dbh->rollback if $oldAutoCommit;
3798       return "Error applying: $error";
3799     }
3800   }
3801
3802   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3803   ''; #no error
3804
3805 }
3806
3807 =item apply_credits OPTION => VALUE ...
3808
3809 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3810 to outstanding invoice balances in chronological order (or reverse
3811 chronological order if the I<order> option is set to B<newest>) and returns the
3812 value of any remaining unapplied credits available for refund (see
3813 L<FS::cust_refund>).
3814
3815 Dies if there is an error.
3816
3817 =cut
3818
3819 sub apply_credits {
3820   my $self = shift;
3821   my %opt = @_;
3822
3823   local $SIG{HUP} = 'IGNORE';
3824   local $SIG{INT} = 'IGNORE';
3825   local $SIG{QUIT} = 'IGNORE';
3826   local $SIG{TERM} = 'IGNORE';
3827   local $SIG{TSTP} = 'IGNORE';
3828   local $SIG{PIPE} = 'IGNORE';
3829
3830   my $oldAutoCommit = $FS::UID::AutoCommit;
3831   local $FS::UID::AutoCommit = 0;
3832   my $dbh = dbh;
3833
3834   $self->select_for_update; #mutex
3835
3836   unless ( $self->total_credited ) {
3837     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3838     return 0;
3839   }
3840
3841   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3842       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3843
3844   my @invoices = $self->open_cust_bill;
3845   @invoices = sort { $b->_date <=> $a->_date } @invoices
3846     if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3847
3848   my $credit;
3849   foreach my $cust_bill ( @invoices ) {
3850     my $amount;
3851
3852     if ( !defined($credit) || $credit->credited == 0) {
3853       $credit = pop @credits or last;
3854     }
3855
3856     if ($cust_bill->owed >= $credit->credited) {
3857       $amount=$credit->credited;
3858     }else{
3859       $amount=$cust_bill->owed;
3860     }
3861
3862     my $cust_credit_bill = new FS::cust_credit_bill ( {
3863       'crednum' => $credit->crednum,
3864       'invnum'  => $cust_bill->invnum,
3865       'amount'  => $amount,
3866     } );
3867     my $error = $cust_credit_bill->insert;
3868     if ( $error ) {
3869       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3870       die $error;
3871     }
3872
3873     redo if ($cust_bill->owed > 0);
3874
3875   }
3876
3877   my $total_credited = $self->total_credited;
3878
3879   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3880
3881   return $total_credited;
3882 }
3883
3884 =item apply_payments
3885
3886 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3887 to outstanding invoice balances in chronological order.
3888
3889  #and returns the value of any remaining unapplied payments.
3890
3891 Dies if there is an error.
3892
3893 =cut
3894
3895 sub apply_payments {
3896   my $self = shift;
3897
3898   local $SIG{HUP} = 'IGNORE';
3899   local $SIG{INT} = 'IGNORE';
3900   local $SIG{QUIT} = 'IGNORE';
3901   local $SIG{TERM} = 'IGNORE';
3902   local $SIG{TSTP} = 'IGNORE';
3903   local $SIG{PIPE} = 'IGNORE';
3904
3905   my $oldAutoCommit = $FS::UID::AutoCommit;
3906   local $FS::UID::AutoCommit = 0;
3907   my $dbh = dbh;
3908
3909   $self->select_for_update; #mutex
3910
3911   #return 0 unless
3912
3913   my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
3914       qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
3915
3916   my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
3917       qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
3918
3919   my $payment;
3920
3921   foreach my $cust_bill ( @invoices ) {
3922     my $amount;
3923
3924     if ( !defined($payment) || $payment->unapplied == 0 ) {
3925       $payment = pop @payments or last;
3926     }
3927
3928     if ( $cust_bill->owed >= $payment->unapplied ) {
3929       $amount = $payment->unapplied;
3930     } else {
3931       $amount = $cust_bill->owed;
3932     }
3933
3934     my $cust_bill_pay = new FS::cust_bill_pay ( {
3935       'paynum' => $payment->paynum,
3936       'invnum' => $cust_bill->invnum,
3937       'amount' => $amount,
3938     } );
3939     my $error = $cust_bill_pay->insert;
3940     if ( $error ) {
3941       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3942       die $error;
3943     }
3944
3945     redo if ( $cust_bill->owed > 0);
3946
3947   }
3948
3949   my $total_unapplied_payments = $self->total_unapplied_payments;
3950
3951   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3952
3953   return $total_unapplied_payments;
3954 }
3955
3956 =item total_credited
3957
3958 Returns the total outstanding credit (see L<FS::cust_credit>) for this
3959 customer.  See L<FS::cust_credit/credited>.
3960
3961 =cut
3962
3963 sub total_credited {
3964   my $self = shift;
3965   my $total_credit = 0;
3966   foreach my $cust_credit ( qsearch('cust_credit', {
3967     'custnum' => $self->custnum,
3968   } ) ) {
3969     $total_credit += $cust_credit->credited;
3970   }
3971   sprintf( "%.2f", $total_credit );
3972 }
3973
3974 =item total_unapplied_payments
3975
3976 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
3977 See L<FS::cust_pay/unapplied>.
3978
3979 =cut
3980
3981 sub total_unapplied_payments {
3982   my $self = shift;
3983   my $total_unapplied = 0;
3984   foreach my $cust_pay ( qsearch('cust_pay', {
3985     'custnum' => $self->custnum,
3986   } ) ) {
3987     $total_unapplied += $cust_pay->unapplied;
3988   }
3989   sprintf( "%.2f", $total_unapplied );
3990 }
3991
3992 =item total_unapplied_refunds
3993
3994 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
3995 customer.  See L<FS::cust_refund/unapplied>.
3996
3997 =cut
3998
3999 sub total_unapplied_refunds {
4000   my $self = shift;
4001   my $total_unapplied = 0;
4002   foreach my $cust_refund ( qsearch('cust_refund', {
4003     'custnum' => $self->custnum,
4004   } ) ) {
4005     $total_unapplied += $cust_refund->unapplied;
4006   }
4007   sprintf( "%.2f", $total_unapplied );
4008 }
4009
4010 =item balance
4011
4012 Returns the balance for this customer (total_owed plus total_unrefunded, minus
4013 total_credited minus total_unapplied_payments).
4014
4015 =cut
4016
4017 sub balance {
4018   my $self = shift;
4019   sprintf( "%.2f",
4020       $self->total_owed
4021     + $self->total_unapplied_refunds
4022     - $self->total_credited
4023     - $self->total_unapplied_payments
4024   );
4025 }
4026
4027 =item balance_date TIME
4028
4029 Returns the balance for this customer, only considering invoices with date
4030 earlier than TIME (total_owed_date minus total_credited minus
4031 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
4032 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
4033 functions.
4034
4035 =cut
4036
4037 sub balance_date {
4038   my $self = shift;
4039   my $time = shift;
4040   sprintf( "%.2f",
4041         $self->total_owed_date($time)
4042       + $self->total_unapplied_refunds
4043       - $self->total_credited
4044       - $self->total_unapplied_payments
4045   );
4046 }
4047
4048 =item in_transit_payments
4049
4050 Returns the total of requests for payments for this customer pending in
4051 batches in transit to the bank.  See L<FS::pay_batch> and L<FS::cust_pay_batch>
4052
4053 =cut
4054
4055 sub in_transit_payments {
4056   my $self = shift;
4057   my $in_transit_payments = 0;
4058   foreach my $pay_batch ( qsearch('pay_batch', {
4059     'status' => 'I',
4060   } ) ) {
4061     foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
4062       'batchnum' => $pay_batch->batchnum,
4063       'custnum' => $self->custnum,
4064     } ) ) {
4065       $in_transit_payments += $cust_pay_batch->amount;
4066     }
4067   }
4068   sprintf( "%.2f", $in_transit_payments );
4069 }
4070
4071 =item paydate_monthyear
4072
4073 Returns a two-element list consisting of the month and year of this customer's
4074 paydate (credit card expiration date for CARD customers)
4075
4076 =cut
4077
4078 sub paydate_monthyear {
4079   my $self = shift;
4080   if ( $self->paydate  =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
4081     ( $2, $1 );
4082   } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
4083     ( $1, $3 );
4084   } else {
4085     ('', '');
4086   }
4087 }
4088
4089 =item invoicing_list [ ARRAYREF ]
4090
4091 If an arguement is given, sets these email addresses as invoice recipients
4092 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
4093 (except as warnings), so use check_invoicing_list first.
4094
4095 Returns a list of email addresses (with svcnum entries expanded).
4096
4097 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
4098 check it without disturbing anything by passing nothing.
4099
4100 This interface may change in the future.
4101
4102 =cut
4103
4104 sub invoicing_list {
4105   my( $self, $arrayref ) = @_;
4106
4107   if ( $arrayref ) {
4108     my @cust_main_invoice;
4109     if ( $self->custnum ) {
4110       @cust_main_invoice =
4111         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4112     } else {
4113       @cust_main_invoice = ();
4114     }
4115     foreach my $cust_main_invoice ( @cust_main_invoice ) {
4116       #warn $cust_main_invoice->destnum;
4117       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
4118         #warn $cust_main_invoice->destnum;
4119         my $error = $cust_main_invoice->delete;
4120         warn $error if $error;
4121       }
4122     }
4123     if ( $self->custnum ) {
4124       @cust_main_invoice =
4125         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4126     } else {
4127       @cust_main_invoice = ();
4128     }
4129     my %seen = map { $_->address => 1 } @cust_main_invoice;
4130     foreach my $address ( @{$arrayref} ) {
4131       next if exists $seen{$address} && $seen{$address};
4132       $seen{$address} = 1;
4133       my $cust_main_invoice = new FS::cust_main_invoice ( {
4134         'custnum' => $self->custnum,
4135         'dest'    => $address,
4136       } );
4137       my $error = $cust_main_invoice->insert;
4138       warn $error if $error;
4139     }
4140   }
4141
4142   if ( $self->custnum ) {
4143     map { $_->address }
4144       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4145   } else {
4146     ();
4147   }
4148
4149 }
4150
4151 =item check_invoicing_list ARRAYREF
4152
4153 Checks these arguements as valid input for the invoicing_list method.  If there
4154 is an error, returns the error, otherwise returns false.
4155
4156 =cut
4157
4158 sub check_invoicing_list {
4159   my( $self, $arrayref ) = @_;
4160
4161   foreach my $address ( @$arrayref ) {
4162
4163     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
4164       return 'Can\'t add FAX invoice destination with a blank FAX number.';
4165     }
4166
4167     my $cust_main_invoice = new FS::cust_main_invoice ( {
4168       'custnum' => $self->custnum,
4169       'dest'    => $address,
4170     } );
4171     my $error = $self->custnum
4172                 ? $cust_main_invoice->check
4173                 : $cust_main_invoice->checkdest
4174     ;
4175     return $error if $error;
4176
4177   }
4178
4179   return "Email address required"
4180     if $conf->exists('cust_main-require_invoicing_list_email')
4181     && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
4182
4183   '';
4184 }
4185
4186 =item set_default_invoicing_list
4187
4188 Sets the invoicing list to all accounts associated with this customer,
4189 overwriting any previous invoicing list.
4190
4191 =cut
4192
4193 sub set_default_invoicing_list {
4194   my $self = shift;
4195   $self->invoicing_list($self->all_emails);
4196 }
4197
4198 =item all_emails
4199
4200 Returns the email addresses of all accounts provisioned for this customer.
4201
4202 =cut
4203
4204 sub all_emails {
4205   my $self = shift;
4206   my %list;
4207   foreach my $cust_pkg ( $self->all_pkgs ) {
4208     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
4209     my @svc_acct =
4210       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4211         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4212           @cust_svc;
4213     $list{$_}=1 foreach map { $_->email } @svc_acct;
4214   }
4215   keys %list;
4216 }
4217
4218 =item invoicing_list_addpost
4219
4220 Adds postal invoicing to this customer.  If this customer is already configured
4221 to receive postal invoices, does nothing.
4222
4223 =cut
4224
4225 sub invoicing_list_addpost {
4226   my $self = shift;
4227   return if grep { $_ eq 'POST' } $self->invoicing_list;
4228   my @invoicing_list = $self->invoicing_list;
4229   push @invoicing_list, 'POST';
4230   $self->invoicing_list(\@invoicing_list);
4231 }
4232
4233 =item invoicing_list_emailonly
4234
4235 Returns the list of email invoice recipients (invoicing_list without non-email
4236 destinations such as POST and FAX).
4237
4238 =cut
4239
4240 sub invoicing_list_emailonly {
4241   my $self = shift;
4242   warn "$me invoicing_list_emailonly called"
4243     if $DEBUG;
4244   grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
4245 }
4246
4247 =item invoicing_list_emailonly_scalar
4248
4249 Returns the list of email invoice recipients (invoicing_list without non-email
4250 destinations such as POST and FAX) as a comma-separated scalar.
4251
4252 =cut
4253
4254 sub invoicing_list_emailonly_scalar {
4255   my $self = shift;
4256   warn "$me invoicing_list_emailonly_scalar called"
4257     if $DEBUG;
4258   join(', ', $self->invoicing_list_emailonly);
4259 }
4260
4261 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
4262
4263 Returns an array of customers referred by this customer (referral_custnum set
4264 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
4265 customers referred by customers referred by this customer and so on, inclusive.
4266 The default behavior is DEPTH 1 (no recursion).
4267
4268 =cut
4269
4270 sub referral_cust_main {
4271   my $self = shift;
4272   my $depth = @_ ? shift : 1;
4273   my $exclude = @_ ? shift : {};
4274
4275   my @cust_main =
4276     map { $exclude->{$_->custnum}++; $_; }
4277       grep { ! $exclude->{ $_->custnum } }
4278         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4279
4280   if ( $depth > 1 ) {
4281     push @cust_main,
4282       map { $_->referral_cust_main($depth-1, $exclude) }
4283         @cust_main;
4284   }
4285
4286   @cust_main;
4287 }
4288
4289 =item referral_cust_main_ncancelled
4290
4291 Same as referral_cust_main, except only returns customers with uncancelled
4292 packages.
4293
4294 =cut
4295
4296 sub referral_cust_main_ncancelled {
4297   my $self = shift;
4298   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4299 }
4300
4301 =item referral_cust_pkg [ DEPTH ]
4302
4303 Like referral_cust_main, except returns a flat list of all unsuspended (and
4304 uncancelled) packages for each customer.  The number of items in this list may
4305 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4306
4307 =cut
4308
4309 sub referral_cust_pkg {
4310   my $self = shift;
4311   my $depth = @_ ? shift : 1;
4312
4313   map { $_->unsuspended_pkgs }
4314     grep { $_->unsuspended_pkgs }
4315       $self->referral_cust_main($depth);
4316 }
4317
4318 =item referring_cust_main
4319
4320 Returns the single cust_main record for the customer who referred this customer
4321 (referral_custnum), or false.
4322
4323 =cut
4324
4325 sub referring_cust_main {
4326   my $self = shift;
4327   return '' unless $self->referral_custnum;
4328   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4329 }
4330
4331 =item credit AMOUNT, REASON
4332
4333 Applies a credit to this customer.  If there is an error, returns the error,
4334 otherwise returns false.
4335
4336 =cut
4337
4338 sub credit {
4339   my( $self, $amount, $reason ) = @_;
4340   my $cust_credit = new FS::cust_credit {
4341     'custnum' => $self->custnum,
4342     'amount'  => $amount,
4343     'reason'  => $reason,
4344   };
4345   $cust_credit->insert;
4346 }
4347
4348 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4349
4350 Creates a one-time charge for this customer.  If there is an error, returns
4351 the error, otherwise returns false.
4352
4353 =cut
4354
4355 sub charge {
4356   my $self = shift;
4357   my ( $amount, $pkg, $comment, $taxclass, $additional );
4358   if ( ref( $_[0] ) ) {
4359     $amount     = $_[0]->{amount};
4360     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4361     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
4362                                            : '$'. sprintf("%.2f",$amount);
4363     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4364     $additional = $_[0]->{additional};
4365   }else{
4366     $amount     = shift;
4367     $pkg        = @_ ? shift : 'One-time charge';
4368     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
4369     $taxclass   = @_ ? shift : '';
4370     $additional = [];
4371   }
4372
4373   local $SIG{HUP} = 'IGNORE';
4374   local $SIG{INT} = 'IGNORE';
4375   local $SIG{QUIT} = 'IGNORE';
4376   local $SIG{TERM} = 'IGNORE';
4377   local $SIG{TSTP} = 'IGNORE';
4378   local $SIG{PIPE} = 'IGNORE';
4379
4380   my $oldAutoCommit = $FS::UID::AutoCommit;
4381   local $FS::UID::AutoCommit = 0;
4382   my $dbh = dbh;
4383
4384   my $part_pkg = new FS::part_pkg ( {
4385     'pkg'      => $pkg,
4386     'comment'  => $comment,
4387     'plan'     => 'flat',
4388     'freq'     => 0,
4389     'disabled' => 'Y',
4390     'taxclass' => $taxclass,
4391   } );
4392
4393   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4394                         ( 0 .. @$additional - 1 )
4395                   ),
4396                   'additional_count' => scalar(@$additional),
4397                   'setup_fee' => $amount,
4398                 );
4399
4400   my $error = $part_pkg->insert( options => \%options );
4401   if ( $error ) {
4402     $dbh->rollback if $oldAutoCommit;
4403     return $error;
4404   }
4405
4406   my $pkgpart = $part_pkg->pkgpart;
4407   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
4408   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
4409     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
4410     $error = $type_pkgs->insert;
4411     if ( $error ) {
4412       $dbh->rollback if $oldAutoCommit;
4413       return $error;
4414     }
4415   }
4416
4417   my $cust_pkg = new FS::cust_pkg ( {
4418     'custnum' => $self->custnum,
4419     'pkgpart' => $pkgpart,
4420   } );
4421
4422   $error = $cust_pkg->insert;
4423   if ( $error ) {
4424     $dbh->rollback if $oldAutoCommit;
4425     return $error;
4426   }
4427
4428   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4429   '';
4430
4431 }
4432
4433 =item cust_bill
4434
4435 Returns all the invoices (see L<FS::cust_bill>) for this customer.
4436
4437 =cut
4438
4439 sub cust_bill {
4440   my $self = shift;
4441   sort { $a->_date <=> $b->_date }
4442     qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4443 }
4444
4445 =item open_cust_bill
4446
4447 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
4448 customer.
4449
4450 =cut
4451
4452 sub open_cust_bill {
4453   my $self = shift;
4454   grep { $_->owed > 0 } $self->cust_bill;
4455 }
4456
4457 =item cust_credit
4458
4459 Returns all the credits (see L<FS::cust_credit>) for this customer.
4460
4461 =cut
4462
4463 sub cust_credit {
4464   my $self = shift;
4465   sort { $a->_date <=> $b->_date }
4466     qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
4467 }
4468
4469 =item cust_pay
4470
4471 Returns all the payments (see L<FS::cust_pay>) for this customer.
4472
4473 =cut
4474
4475 sub cust_pay {
4476   my $self = shift;
4477   sort { $a->_date <=> $b->_date }
4478     qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
4479 }
4480
4481 =item cust_pay_void
4482
4483 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4484
4485 =cut
4486
4487 sub cust_pay_void {
4488   my $self = shift;
4489   sort { $a->_date <=> $b->_date }
4490     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4491 }
4492
4493 =item cust_pay_batch
4494
4495 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
4496
4497 =cut
4498
4499 sub cust_pay_batch {
4500   my $self = shift;
4501   sort { $a->_date <=> $b->_date }
4502     qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
4503 }
4504
4505 =item cust_refund
4506
4507 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4508
4509 =cut
4510
4511 sub cust_refund {
4512   my $self = shift;
4513   sort { $a->_date <=> $b->_date }
4514     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4515 }
4516
4517 =item name
4518
4519 Returns a name string for this customer, either "Company (Last, First)" or
4520 "Last, First".
4521
4522 =cut
4523
4524 sub name {
4525   my $self = shift;
4526   my $name = $self->contact;
4527   $name = $self->company. " ($name)" if $self->company;
4528   $name;
4529 }
4530
4531 =item ship_name
4532
4533 Returns a name string for this (service/shipping) contact, either
4534 "Company (Last, First)" or "Last, First".
4535
4536 =cut
4537
4538 sub ship_name {
4539   my $self = shift;
4540   if ( $self->get('ship_last') ) {
4541     my $name = $self->ship_contact;
4542     $name = $self->ship_company. " ($name)" if $self->ship_company;
4543     $name;
4544   } else {
4545     $self->name;
4546   }
4547 }
4548
4549 =item contact
4550
4551 Returns this customer's full (billing) contact name only, "Last, First"
4552
4553 =cut
4554
4555 sub contact {
4556   my $self = shift;
4557   $self->get('last'). ', '. $self->first;
4558 }
4559
4560 =item ship_contact
4561
4562 Returns this customer's full (shipping) contact name only, "Last, First"
4563
4564 =cut
4565
4566 sub ship_contact {
4567   my $self = shift;
4568   $self->get('ship_last')
4569     ? $self->get('ship_last'). ', '. $self->ship_first
4570     : $self->contact;
4571 }
4572
4573 =item country_full
4574
4575 Returns this customer's full country name
4576
4577 =cut
4578
4579 sub country_full {
4580   my $self = shift;
4581   code2country($self->country);
4582 }
4583
4584 =item cust_status
4585
4586 =item status
4587
4588 Returns a status string for this customer, currently:
4589
4590 =over 4
4591
4592 =item prospect - No packages have ever been ordered
4593
4594 =item active - One or more recurring packages is active
4595
4596 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4597
4598 =item suspended - All non-cancelled recurring packages are suspended
4599
4600 =item cancelled - All recurring packages are cancelled
4601
4602 =back
4603
4604 =cut
4605
4606 sub status { shift->cust_status(@_); }
4607
4608 sub cust_status {
4609   my $self = shift;
4610   for my $status (qw( prospect active inactive suspended cancelled )) {
4611     my $method = $status.'_sql';
4612     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4613     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4614     $sth->execute( ($self->custnum) x $numnum )
4615       or die "Error executing 'SELECT $sql': ". $sth->errstr;
4616     return $status if $sth->fetchrow_arrayref->[0];
4617   }
4618 }
4619
4620 =item ucfirst_cust_status
4621
4622 =item ucfirst_status
4623
4624 Returns the status with the first character capitalized.
4625
4626 =cut
4627
4628 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4629
4630 sub ucfirst_cust_status {
4631   my $self = shift;
4632   ucfirst($self->cust_status);
4633 }
4634
4635 =item statuscolor
4636
4637 Returns a hex triplet color string for this customer's status.
4638
4639 =cut
4640
4641 use vars qw(%statuscolor);
4642 tie my %statuscolor, 'Tie::IxHash',
4643   'prospect'  => '7e0079', #'000000', #black?  naw, purple
4644   'active'    => '00CC00', #green
4645   'inactive'  => '0000CC', #blue
4646   'suspended' => 'FF9900', #yellow
4647   'cancelled' => 'FF0000', #red
4648 ;
4649
4650 sub statuscolor { shift->cust_statuscolor(@_); }
4651
4652 sub cust_statuscolor {
4653   my $self = shift;
4654   $statuscolor{$self->cust_status};
4655 }
4656
4657 =item tickets
4658
4659 Returns an array of hashes representing the customer's RT tickets.
4660
4661 =cut
4662
4663 sub tickets {
4664   my $self = shift;
4665
4666   my $num = $conf->config('cust_main-max_tickets') || 10;
4667   my @tickets = ();
4668
4669   unless ( $conf->config('ticket_system-custom_priority_field') ) {
4670
4671     @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4672
4673   } else {
4674
4675     foreach my $priority (
4676       $conf->config('ticket_system-custom_priority_field-values'), ''
4677     ) {
4678       last if scalar(@tickets) >= $num;
4679       push @tickets,
4680         @{ FS::TicketSystem->customer_tickets( $self->custnum,
4681                                                $num - scalar(@tickets),
4682                                                $priority,
4683                                              )
4684          };
4685     }
4686   }
4687   (@tickets);
4688 }
4689
4690 # Return services representing svc_accts in customer support packages
4691 sub support_services {
4692   my $self = shift;
4693   my %packages = map { $_ => 1 } $conf->config('support_packages');
4694
4695   grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4696     grep { $_->part_svc->svcdb eq 'svc_acct' }
4697     map { $_->cust_svc }
4698     grep { exists $packages{ $_->pkgpart } }
4699     $self->ncancelled_pkgs;
4700
4701 }
4702
4703 =back
4704
4705 =head1 CLASS METHODS
4706
4707 =over 4
4708
4709 =item statuses
4710
4711 Class method that returns the list of possible status strings for customers
4712 (see L<the status method|/status>).  For example:
4713
4714   @statuses = FS::cust_main->statuses();
4715
4716 =cut
4717
4718 sub statuses {
4719   #my $self = shift; #could be class...
4720   keys %statuscolor;
4721 }
4722
4723 =item prospect_sql
4724
4725 Returns an SQL expression identifying prospective cust_main records (customers
4726 with no packages ever ordered)
4727
4728 =cut
4729
4730 use vars qw($select_count_pkgs);
4731 $select_count_pkgs =
4732   "SELECT COUNT(*) FROM cust_pkg
4733     WHERE cust_pkg.custnum = cust_main.custnum";
4734
4735 sub select_count_pkgs_sql {
4736   $select_count_pkgs;
4737 }
4738
4739 sub prospect_sql { "
4740   0 = ( $select_count_pkgs )
4741 "; }
4742
4743 =item active_sql
4744
4745 Returns an SQL expression identifying active cust_main records (customers with
4746 no active recurring packages, but otherwise unsuspended/uncancelled).
4747
4748 =cut
4749
4750 sub active_sql { "
4751   0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
4752       )
4753 "; }
4754
4755 =item inactive_sql
4756
4757 Returns an SQL expression identifying inactive cust_main records (customers with
4758 active recurring packages).
4759
4760 =cut
4761
4762 sub inactive_sql { "
4763   0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4764   AND
4765   0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
4766 "; }
4767
4768 =item susp_sql
4769 =item suspended_sql
4770
4771 Returns an SQL expression identifying suspended cust_main records.
4772
4773 =cut
4774
4775
4776 sub suspended_sql { susp_sql(@_); }
4777 sub susp_sql { "
4778     0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
4779     AND
4780     0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4781 "; }
4782
4783 =item cancel_sql
4784 =item cancelled_sql
4785
4786 Returns an SQL expression identifying cancelled cust_main records.
4787
4788 =cut
4789
4790 sub cancelled_sql { cancel_sql(@_); }
4791 sub cancel_sql {
4792
4793   my $recurring_sql = FS::cust_pkg->recurring_sql;
4794   #my $recurring_sql = "
4795   #  '0' != ( select freq from part_pkg
4796   #             where cust_pkg.pkgpart = part_pkg.pkgpart )
4797   #";
4798
4799   "
4800     0 < ( $select_count_pkgs )
4801     AND 0 = ( $select_count_pkgs AND $recurring_sql
4802                   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4803             )
4804   ";
4805 }
4806
4807 =item uncancel_sql
4808 =item uncancelled_sql
4809
4810 Returns an SQL expression identifying un-cancelled cust_main records.
4811
4812 =cut
4813
4814 sub uncancelled_sql { uncancel_sql(@_); }
4815 sub uncancel_sql { "
4816   ( 0 < ( $select_count_pkgs
4817                    AND ( cust_pkg.cancel IS NULL
4818                          OR cust_pkg.cancel = 0
4819                        )
4820         )
4821     OR 0 = ( $select_count_pkgs )
4822   )
4823 "; }
4824
4825 =item balance_sql
4826
4827 Returns an SQL fragment to retreive the balance.
4828
4829 =cut
4830
4831 sub balance_sql { "
4832     COALESCE( ( SELECT SUM(charged) FROM cust_bill
4833                   WHERE cust_bill.custnum   = cust_main.custnum ), 0)
4834   - COALESCE( ( SELECT SUM(paid)    FROM cust_pay
4835                   WHERE cust_pay.custnum    = cust_main.custnum ), 0)
4836   - COALESCE( ( SELECT SUM(amount)  FROM cust_credit
4837                   WHERE cust_credit.custnum = cust_main.custnum ), 0)
4838   + COALESCE( ( SELECT SUM(refund)  FROM cust_refund
4839                    WHERE cust_refund.custnum = cust_main.custnum ), 0)
4840 "; }
4841
4842 =item balance_date_sql TIME
4843
4844 Returns an SQL fragment to retreive the balance for this customer, only
4845 considering invoices with date earlier than TIME. (total_owed_date minus total_credited minus
4846 total_unapplied_payments).  TIME is specified as an SQL fragment or a numeric
4847 UNIX timestamp; see L<perlfunc/"time">).  Also see L<Time::Local> and
4848 L<Date::Parse> for conversion functions.
4849
4850 =cut
4851
4852 sub balance_date_sql {
4853   my( $class, $time ) = @_;
4854
4855   my $owed_sql         = FS::cust_bill->owed_sql;
4856   my $unapp_refund_sql = FS::cust_refund->unapplied_sql;
4857   #my $unapp_credit_sql = FS::cust_credit->unapplied_sql;
4858   my $unapp_credit_sql = FS::cust_credit->credited_sql;
4859   my $unapp_pay_sql    = FS::cust_pay->unapplied_sql;
4860
4861   "
4862       COALESCE( ( SELECT SUM($owed_sql) FROM cust_bill
4863                     WHERE cust_bill.custnum   = cust_main.custnum
4864                       AND cust_bill._date    <= $time             )
4865                 ,0
4866               )
4867     + COALESCE( ( SELECT SUM($unapp_refund_sql) FROM cust_refund
4868                     WHERE cust_refund.custnum = cust_main.custnum )
4869                 ,0
4870               )
4871     - COALESCE( ( SELECT SUM($unapp_credit_sql) FROM cust_credit
4872                     WHERE cust_credit.custnum = cust_main.custnum )
4873                 ,0
4874               )
4875     - COALESCE( ( SELECT SUM($unapp_pay_sql) FROM cust_pay
4876                     WHERE cust_pay.custnum = cust_main.custnum )
4877                 ,0
4878               )
4879
4880   ";
4881
4882 }
4883
4884 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
4885
4886 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
4887 records.  Currently, I<first>, I<last> and/or I<company> may be specified (the
4888 appropriate ship_ field is also searched).
4889
4890 Additional options are the same as FS::Record::qsearch
4891
4892 =cut
4893
4894 sub fuzzy_search {
4895   my( $self, $fuzzy, $hash, @opt) = @_;
4896   #$self
4897   $hash ||= {};
4898   my @cust_main = ();
4899
4900   check_and_rebuild_fuzzyfiles();
4901   foreach my $field ( keys %$fuzzy ) {
4902
4903     my $all = $self->all_X($field);
4904     next unless scalar(@$all);
4905
4906     my %match = ();
4907     $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
4908
4909     my @fcust = ();
4910     foreach ( keys %match ) {
4911       push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
4912       push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
4913     }
4914     my %fsaw = ();
4915     push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
4916   }
4917
4918   # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
4919   my %saw = ();
4920   @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
4921
4922   @cust_main;
4923
4924 }
4925
4926 =item masked FIELD
4927
4928 Returns a masked version of the named field
4929
4930 =cut
4931
4932 sub masked {
4933 my ($self,$field) = @_;
4934
4935 # Show last four
4936
4937 'x'x(length($self->getfield($field))-4).
4938   substr($self->getfield($field), (length($self->getfield($field))-4));
4939
4940 }
4941
4942 =back
4943
4944 =head1 SUBROUTINES
4945
4946 =over 4
4947
4948 =item smart_search OPTION => VALUE ...
4949
4950 Accepts the following options: I<search>, the string to search for.  The string
4951 will be searched for as a customer number, phone number, name or company name,
4952 as an exact, or, in some cases, a substring or fuzzy match (see the source code
4953 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
4954 skip fuzzy matching when an exact match is found.
4955
4956 Any additional options are treated as an additional qualifier on the search
4957 (i.e. I<agentnum>).
4958
4959 Returns a (possibly empty) array of FS::cust_main objects.
4960
4961 =cut
4962
4963 sub smart_search {
4964   my %options = @_;
4965
4966   #here is the agent virtualization
4967   my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
4968
4969   my @cust_main = ();
4970
4971   my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
4972   my $search = delete $options{'search'};
4973   ( my $alphanum_search = $search ) =~ s/\W//g;
4974
4975   if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
4976
4977     #false laziness w/Record::ut_phone
4978     my $phonen = "$1-$2-$3";
4979     $phonen .= " x$4" if $4;
4980
4981     push @cust_main, qsearch( {
4982       'table'   => 'cust_main',
4983       'hashref' => { %options },
4984       'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4985                      ' ( '.
4986                          join(' OR ', map "$_ = '$phonen'",
4987                                           qw( daytime night fax
4988                                               ship_daytime ship_night ship_fax )
4989                              ).
4990                      ' ) '.
4991                      " AND $agentnums_sql", #agent virtualization
4992     } );
4993
4994     unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
4995       #try looking for matches with extensions unless one was specified
4996
4997       push @cust_main, qsearch( {
4998         'table'   => 'cust_main',
4999         'hashref' => { %options },
5000         'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5001                        ' ( '.
5002                            join(' OR ', map "$_ LIKE '$phonen\%'",
5003                                             qw( daytime night
5004                                                 ship_daytime ship_night )
5005                                ).
5006                        ' ) '.
5007                        " AND $agentnums_sql", #agent virtualization
5008       } );
5009
5010     }
5011
5012   } elsif ( $search =~ /^\s*(\d+)\s*$/ ) { # customer # search
5013
5014     push @cust_main, qsearch( {
5015       'table'     => 'cust_main',
5016       'hashref'   => { 'custnum' => $1, %options },
5017       'extra_sql' => " AND $agentnums_sql", #agent virtualization
5018     } );
5019
5020   } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
5021
5022     my($company, $last, $first) = ( $1, $2, $3 );
5023
5024     # "Company (Last, First)"
5025     #this is probably something a browser remembered,
5026     #so just do an exact search
5027
5028     foreach my $prefix ( '', 'ship_' ) {
5029       push @cust_main, qsearch( {
5030         'table'     => 'cust_main',
5031         'hashref'   => { $prefix.'first'   => $first,
5032                          $prefix.'last'    => $last,
5033                          $prefix.'company' => $company,
5034                          %options,
5035                        },
5036         'extra_sql' => " AND $agentnums_sql",
5037       } );
5038     }
5039
5040   } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
5041                                               # try (ship_){last,company}
5042
5043     my $value = lc($1);
5044
5045     # # remove "(Last, First)" in "Company (Last, First)", otherwise the
5046     # # full strings the browser remembers won't work
5047     # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
5048
5049     use Lingua::EN::NameParse;
5050     my $NameParse = new Lingua::EN::NameParse(
5051              auto_clean     => 1,
5052              allow_reversed => 1,
5053     );
5054
5055     my($last, $first) = ( '', '' );
5056     #maybe disable this too and just rely on NameParse?
5057     if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
5058
5059       ($last, $first) = ( $1, $2 );
5060
5061     #} elsif  ( $value =~ /^(.+)\s+(.+)$/ ) {
5062     } elsif ( ! $NameParse->parse($value) ) {
5063
5064       my %name = $NameParse->components;
5065       $first = $name{'given_name_1'};
5066       $last  = $name{'surname_1'};
5067
5068     }
5069
5070     if ( $first && $last ) {
5071
5072       my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
5073
5074       #exact
5075       my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5076       $sql .= "
5077         (     ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
5078            OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
5079         )";
5080
5081       push @cust_main, qsearch( {
5082         'table'     => 'cust_main',
5083         'hashref'   => \%options,
5084         'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5085       } );
5086
5087       # or it just be something that was typed in... (try that in a sec)
5088
5089     }
5090
5091     my $q_value = dbh->quote($value);
5092
5093     #exact
5094     my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5095     $sql .= " (    LOWER(last)         = $q_value
5096                 OR LOWER(company)      = $q_value
5097                 OR LOWER(ship_last)    = $q_value
5098                 OR LOWER(ship_company) = $q_value
5099               )";
5100
5101     push @cust_main, qsearch( {
5102       'table'     => 'cust_main',
5103       'hashref'   => \%options,
5104       'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5105     } );
5106
5107     #no exact match, trying substring/fuzzy
5108     #always do substring & fuzzy (unless they're explicity config'ed off)
5109     #getting complaints searches are not returning enough
5110     unless ( @cust_main  && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
5111
5112       #still some false laziness w/ search/cust_main.cgi
5113
5114       #substring
5115
5116       my @hashrefs = (
5117         { 'company'      => { op=>'ILIKE', value=>"%$value%" }, },
5118         { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
5119       );
5120
5121       if ( $first && $last ) {
5122
5123         push @hashrefs,
5124           { 'first'        => { op=>'ILIKE', value=>"%$first%" },
5125             'last'         => { op=>'ILIKE', value=>"%$last%" },
5126           },
5127           { 'ship_first'   => { op=>'ILIKE', value=>"%$first%" },
5128             'ship_last'    => { op=>'ILIKE', value=>"%$last%" },
5129           },
5130         ;
5131
5132       } else {
5133
5134         push @hashrefs,
5135           { 'last'         => { op=>'ILIKE', value=>"%$value%" }, },
5136           { 'ship_last'    => { op=>'ILIKE', value=>"%$value%" }, },
5137         ;
5138       }
5139
5140       foreach my $hashref ( @hashrefs ) {
5141
5142         push @cust_main, qsearch( {
5143           'table'     => 'cust_main',
5144           'hashref'   => { %$hashref,
5145                            %options,
5146                          },
5147           'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
5148         } );
5149
5150       }
5151
5152       #fuzzy
5153       my @fuzopts = (
5154         \%options,                #hashref
5155         '',                       #select
5156         " AND $agentnums_sql",    #extra_sql  #agent virtualization
5157       );
5158
5159       if ( $first && $last ) {
5160         push @cust_main, FS::cust_main->fuzzy_search(
5161           { 'last'   => $last,    #fuzzy hashref
5162             'first'  => $first }, #
5163           @fuzopts
5164         );
5165       }
5166       foreach my $field ( 'last', 'company' ) {
5167         push @cust_main,
5168           FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
5169       }
5170
5171     }
5172
5173     #eliminate duplicates
5174     my %saw = ();
5175     @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5176
5177   }
5178
5179   @cust_main;
5180
5181 }
5182
5183 =item check_and_rebuild_fuzzyfiles
5184
5185 =cut
5186
5187 use vars qw(@fuzzyfields);
5188 @fuzzyfields = ( 'last', 'first', 'company' );
5189
5190 sub check_and_rebuild_fuzzyfiles {
5191   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5192   rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
5193 }
5194
5195 =item rebuild_fuzzyfiles
5196
5197 =cut
5198
5199 sub rebuild_fuzzyfiles {
5200
5201   use Fcntl qw(:flock);
5202
5203   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5204   mkdir $dir, 0700 unless -d $dir;
5205
5206   foreach my $fuzzy ( @fuzzyfields ) {
5207
5208     open(LOCK,">>$dir/cust_main.$fuzzy")
5209       or die "can't open $dir/cust_main.$fuzzy: $!";
5210     flock(LOCK,LOCK_EX)
5211       or die "can't lock $dir/cust_main.$fuzzy: $!";
5212
5213     open (CACHE,">$dir/cust_main.$fuzzy.tmp")
5214       or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
5215
5216     foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
5217       my $sth = dbh->prepare("SELECT $field FROM cust_main".
5218                              " WHERE $field != '' AND $field IS NOT NULL");
5219       $sth->execute or die $sth->errstr;
5220
5221       while ( my $row = $sth->fetchrow_arrayref ) {
5222         print CACHE $row->[0]. "\n";
5223       }
5224
5225     }
5226
5227     close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
5228
5229     rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
5230     close LOCK;
5231   }
5232
5233 }
5234
5235 =item all_X
5236
5237 =cut
5238
5239 sub all_X {
5240   my( $self, $field ) = @_;
5241   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5242   open(CACHE,"<$dir/cust_main.$field")
5243     or die "can't open $dir/cust_main.$field: $!";
5244   my @array = map { chomp; $_; } <CACHE>;
5245   close CACHE;
5246   \@array;
5247 }
5248
5249 =item append_fuzzyfiles LASTNAME COMPANY
5250
5251 =cut
5252
5253 sub append_fuzzyfiles {
5254   #my( $first, $last, $company ) = @_;
5255
5256   &check_and_rebuild_fuzzyfiles;
5257
5258   use Fcntl qw(:flock);
5259
5260   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5261
5262   foreach my $field (qw( first last company )) {
5263     my $value = shift;
5264
5265     if ( $value ) {
5266
5267       open(CACHE,">>$dir/cust_main.$field")
5268         or die "can't open $dir/cust_main.$field: $!";
5269       flock(CACHE,LOCK_EX)
5270         or die "can't lock $dir/cust_main.$field: $!";
5271
5272       print CACHE "$value\n";
5273
5274       flock(CACHE,LOCK_UN)
5275         or die "can't unlock $dir/cust_main.$field: $!";
5276       close CACHE;
5277     }
5278
5279   }
5280
5281   1;
5282 }
5283
5284 =item batch_import
5285
5286 =cut
5287
5288 sub batch_import {
5289   my $param = shift;
5290   #warn join('-',keys %$param);
5291   my $fh = $param->{filehandle};
5292   my $agentnum = $param->{agentnum};
5293
5294   my $refnum = $param->{refnum};
5295   my $pkgpart = $param->{pkgpart};
5296
5297   #my @fields = @{$param->{fields}};
5298   my $format = $param->{'format'};
5299   my @fields;
5300   my $payby;
5301   if ( $format eq 'simple' ) {
5302     @fields = qw( cust_pkg.setup dayphone first last
5303                   address1 address2 city state zip comments );
5304     $payby = 'BILL';
5305   } elsif ( $format eq 'extended' ) {
5306     @fields = qw( agent_custid refnum
5307                   last first address1 address2 city state zip country
5308                   daytime night
5309                   ship_last ship_first ship_address1 ship_address2
5310                   ship_city ship_state ship_zip ship_country
5311                   payinfo paycvv paydate
5312                   invoicing_list
5313                   cust_pkg.pkgpart
5314                   svc_acct.username svc_acct._password
5315                 );
5316     $payby = 'BILL';
5317   } else {
5318     die "unknown format $format";
5319   }
5320
5321   eval "use Text::CSV_XS;";
5322   die $@ if $@;
5323
5324   my $csv = new Text::CSV_XS;
5325   #warn $csv;
5326   #warn $fh;
5327
5328   my $imported = 0;
5329   #my $columns;
5330
5331   local $SIG{HUP} = 'IGNORE';
5332   local $SIG{INT} = 'IGNORE';
5333   local $SIG{QUIT} = 'IGNORE';
5334   local $SIG{TERM} = 'IGNORE';
5335   local $SIG{TSTP} = 'IGNORE';
5336   local $SIG{PIPE} = 'IGNORE';
5337
5338   my $oldAutoCommit = $FS::UID::AutoCommit;
5339   local $FS::UID::AutoCommit = 0;
5340   my $dbh = dbh;
5341
5342   #while ( $columns = $csv->getline($fh) ) {
5343   my $line;
5344   while ( defined($line=<$fh>) ) {
5345
5346     $csv->parse($line) or do {
5347       $dbh->rollback if $oldAutoCommit;
5348       return "can't parse: ". $csv->error_input();
5349     };
5350
5351     my @columns = $csv->fields();
5352     #warn join('-',@columns);
5353
5354     my %cust_main = (
5355       agentnum => $agentnum,
5356       refnum   => $refnum,
5357       country  => $conf->config('countrydefault') || 'US',
5358       payby    => $payby, #default
5359       paydate  => '12/2037', #default
5360     );
5361     my $billtime = time;
5362     my %cust_pkg = ( pkgpart => $pkgpart );
5363     my %svc_acct = ();
5364     foreach my $field ( @fields ) {
5365
5366       if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
5367
5368         #$cust_pkg{$1} = str2time( shift @$columns );
5369         if ( $1 eq 'pkgpart' ) {
5370           $cust_pkg{$1} = shift @columns;
5371         } elsif ( $1 eq 'setup' ) {
5372           $billtime = str2time(shift @columns);
5373         } else {
5374           $cust_pkg{$1} = str2time( shift @columns );
5375         }
5376
5377       } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
5378
5379         $svc_acct{$1} = shift @columns;
5380
5381       } else {
5382
5383         #refnum interception
5384         if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
5385
5386           my $referral = $columns[0];
5387           my %hash = ( 'referral' => $referral,
5388                        'agentnum' => $agentnum,
5389                        'disabled' => '',
5390                      );
5391
5392           my $part_referral = qsearchs('part_referral', \%hash )
5393                               || new FS::part_referral \%hash;
5394
5395           unless ( $part_referral->refnum ) {
5396             my $error = $part_referral->insert;
5397             if ( $error ) {
5398               $dbh->rollback if $oldAutoCommit;
5399               return "can't auto-insert advertising source: $referral: $error";
5400             }
5401           }
5402
5403           $columns[0] = $part_referral->refnum;
5404         }
5405
5406         #$cust_main{$field} = shift @$columns;
5407         $cust_main{$field} = shift @columns;
5408       }
5409     }
5410
5411     $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
5412
5413     my $invoicing_list = $cust_main{'invoicing_list'}
5414                            ? [ delete $cust_main{'invoicing_list'} ]
5415                            : [];
5416
5417     my $cust_main = new FS::cust_main ( \%cust_main );
5418
5419     use Tie::RefHash;
5420     tie my %hash, 'Tie::RefHash'; #this part is important
5421
5422     if ( $cust_pkg{'pkgpart'} ) {
5423       my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
5424
5425       my @svc_acct = ();
5426       if ( $svc_acct{'username'} ) {
5427         my $part_pkg = $cust_pkg->part_pkg;
5428         unless ( $part_pkg ) {
5429           $dbh->rollback if $oldAutoCommit;
5430           return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
5431         }
5432         $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
5433         push @svc_acct, new FS::svc_acct ( \%svc_acct )
5434       }
5435
5436       $hash{$cust_pkg} = \@svc_acct;
5437     }
5438
5439     my $error = $cust_main->insert( \%hash, $invoicing_list );
5440
5441     if ( $error ) {
5442       $dbh->rollback if $oldAutoCommit;
5443       return "can't insert customer for $line: $error";
5444     }
5445
5446     if ( $format eq 'simple' ) {
5447
5448       #false laziness w/bill.cgi
5449       $error = $cust_main->bill( 'time' => $billtime );
5450       if ( $error ) {
5451         $dbh->rollback if $oldAutoCommit;
5452         return "can't bill customer for $line: $error";
5453       }
5454
5455       $error = $cust_main->apply_payments_and_credits;
5456       if ( $error ) {
5457         $dbh->rollback if $oldAutoCommit;
5458         return "can't bill customer for $line: $error";
5459       }
5460
5461       $error = $cust_main->collect();
5462       if ( $error ) {
5463         $dbh->rollback if $oldAutoCommit;
5464         return "can't collect customer for $line: $error";
5465       }
5466
5467     }
5468
5469     $imported++;
5470   }
5471
5472   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5473
5474   return "Empty file!" unless $imported;
5475
5476   ''; #no error
5477
5478 }
5479
5480 =item batch_charge
5481
5482 =cut
5483
5484 sub batch_charge {
5485   my $param = shift;
5486   #warn join('-',keys %$param);
5487   my $fh = $param->{filehandle};
5488   my @fields = @{$param->{fields}};
5489
5490   eval "use Text::CSV_XS;";
5491   die $@ if $@;
5492
5493   my $csv = new Text::CSV_XS;
5494   #warn $csv;
5495   #warn $fh;
5496
5497   my $imported = 0;
5498   #my $columns;
5499
5500   local $SIG{HUP} = 'IGNORE';
5501   local $SIG{INT} = 'IGNORE';
5502   local $SIG{QUIT} = 'IGNORE';
5503   local $SIG{TERM} = 'IGNORE';
5504   local $SIG{TSTP} = 'IGNORE';
5505   local $SIG{PIPE} = 'IGNORE';
5506
5507   my $oldAutoCommit = $FS::UID::AutoCommit;
5508   local $FS::UID::AutoCommit = 0;
5509   my $dbh = dbh;
5510
5511   #while ( $columns = $csv->getline($fh) ) {
5512   my $line;
5513   while ( defined($line=<$fh>) ) {
5514
5515     $csv->parse($line) or do {
5516       $dbh->rollback if $oldAutoCommit;
5517       return "can't parse: ". $csv->error_input();
5518     };
5519
5520     my @columns = $csv->fields();
5521     #warn join('-',@columns);
5522
5523     my %row = ();
5524     foreach my $field ( @fields ) {
5525       $row{$field} = shift @columns;
5526     }
5527
5528     my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
5529     unless ( $cust_main ) {
5530       $dbh->rollback if $oldAutoCommit;
5531       return "unknown custnum $row{'custnum'}";
5532     }
5533
5534     if ( $row{'amount'} > 0 ) {
5535       my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
5536       if ( $error ) {
5537         $dbh->rollback if $oldAutoCommit;
5538         return $error;
5539       }
5540       $imported++;
5541     } elsif ( $row{'amount'} < 0 ) {
5542       my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
5543                                       $row{'pkg'}                         );
5544       if ( $error ) {
5545         $dbh->rollback if $oldAutoCommit;
5546         return $error;
5547       }
5548       $imported++;
5549     } else {
5550       #hmm?
5551     }
5552
5553   }
5554
5555   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5556
5557   return "Empty file!" unless $imported;
5558
5559   ''; #no error
5560
5561 }
5562
5563 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5564
5565 Sends a templated email notification to the customer (see L<Text::Template>).
5566
5567 OPTIONS is a hash and may include
5568
5569 I<from> - the email sender (default is invoice_from)
5570
5571 I<to> - comma-separated scalar or arrayref of recipients
5572    (default is invoicing_list)
5573
5574 I<subject> - The subject line of the sent email notification
5575    (default is "Notice from company_name")
5576
5577 I<extra_fields> - a hashref of name/value pairs which will be substituted
5578    into the template
5579
5580 The following variables are vavailable in the template.
5581
5582 I<$first> - the customer first name
5583 I<$last> - the customer last name
5584 I<$company> - the customer company
5585 I<$payby> - a description of the method of payment for the customer
5586             # would be nice to use FS::payby::shortname
5587 I<$payinfo> - the account information used to collect for this customer
5588 I<$expdate> - the expiration of the customer payment in seconds from epoch
5589
5590 =cut
5591
5592 sub notify {
5593   my ($customer, $template, %options) = @_;
5594
5595   return unless $conf->exists($template);
5596
5597   my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
5598   $from = $options{from} if exists($options{from});
5599
5600   my $to = join(',', $customer->invoicing_list_emailonly);
5601   $to = $options{to} if exists($options{to});
5602
5603   my $subject = "Notice from " . $conf->config('company_name')
5604     if $conf->exists('company_name');
5605   $subject = $options{subject} if exists($options{subject});
5606
5607   my $notify_template = new Text::Template (TYPE => 'ARRAY',
5608                                             SOURCE => [ map "$_\n",
5609                                               $conf->config($template)]
5610                                            )
5611     or die "can't create new Text::Template object: Text::Template::ERROR";
5612   $notify_template->compile()
5613     or die "can't compile template: Text::Template::ERROR";
5614
5615   my $paydate = $customer->paydate;
5616   $FS::notify_template::_template::first = $customer->first;
5617   $FS::notify_template::_template::last = $customer->last;
5618   $FS::notify_template::_template::company = $customer->company;
5619   $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
5620   my $payby = $customer->payby;
5621   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5622   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5623
5624   #credit cards expire at the end of the month/year of their exp date
5625   if ($payby eq 'CARD' || $payby eq 'DCRD') {
5626     $FS::notify_template::_template::payby = 'credit card';
5627     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5628     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5629     $expire_time--;
5630   }elsif ($payby eq 'COMP') {
5631     $FS::notify_template::_template::payby = 'complimentary account';
5632   }else{
5633     $FS::notify_template::_template::payby = 'current method';
5634   }
5635   $FS::notify_template::_template::expdate = $expire_time;
5636
5637   for (keys %{$options{extra_fields}}){
5638     no strict "refs";
5639     ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5640   }
5641
5642   send_email(from => $from,
5643              to => $to,
5644              subject => $subject,
5645              body => $notify_template->fill_in( PACKAGE =>
5646                                                 'FS::notify_template::_template'                                              ),
5647             );
5648
5649 }
5650
5651 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5652
5653 Generates a templated notification to the customer (see L<Text::Template>).
5654
5655 OPTIONS is a hash and may include
5656
5657 I<extra_fields> - a hashref of name/value pairs which will be substituted
5658    into the template.  These values may override values mentioned below
5659    and those from the customer record.
5660
5661 The following variables are available in the template instead of or in addition
5662 to the fields of the customer record.
5663
5664 I<$payby> - a description of the method of payment for the customer
5665             # would be nice to use FS::payby::shortname
5666 I<$payinfo> - the masked account information used to collect for this customer
5667 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5668 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress
5669
5670 =cut
5671
5672 sub generate_letter {
5673   my ($self, $template, %options) = @_;
5674
5675   return unless $conf->exists($template);
5676
5677   my $letter_template = new Text::Template
5678                         ( TYPE       => 'ARRAY',
5679                           SOURCE     => [ map "$_\n", $conf->config($template)],
5680                           DELIMITERS => [ '[@--', '--@]' ],
5681                         )
5682     or die "can't create new Text::Template object: Text::Template::ERROR";
5683
5684   $letter_template->compile()
5685     or die "can't compile template: Text::Template::ERROR";
5686
5687   my %letter_data = map { $_ => $self->$_ } $self->fields;
5688   $letter_data{payinfo} = $self->mask_payinfo;
5689
5690   #my $paydate = $self->paydate || '2037-12';
5691   my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12';
5692
5693   my $payby = $self->payby;
5694   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5695   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5696
5697   #credit cards expire at the end of the month/year of their exp date
5698   if ($payby eq 'CARD' || $payby eq 'DCRD') {
5699     $letter_data{payby} = 'credit card';
5700     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5701     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5702     $expire_time--;
5703   }elsif ($payby eq 'COMP') {
5704     $letter_data{payby} = 'complimentary account';
5705   }else{
5706     $letter_data{payby} = 'current method';
5707   }
5708   $letter_data{expdate} = $expire_time;
5709
5710   for (keys %{$options{extra_fields}}){
5711     $letter_data{$_} = $options{extra_fields}->{$_};
5712   }
5713
5714   unless(exists($letter_data{returnaddress})){
5715     my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5716                                                   $self->agent_template)
5717                      );
5718
5719     $letter_data{returnaddress} = length($retadd) ? $retadd : '~';
5720   }
5721
5722   $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5723
5724   my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
5725   my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5726                            DIR      => $dir,
5727                            SUFFIX   => '.tex',
5728                            UNLINK   => 0,
5729                          ) or die "can't open temp file: $!\n";
5730
5731   $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5732   close $fh;
5733   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5734   return $1;
5735 }
5736
5737 =item print_ps TEMPLATE
5738
5739 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5740
5741 =cut
5742
5743 sub print_ps {
5744   my $self = shift;
5745   my $file = $self->generate_letter(@_);
5746   FS::Misc::generate_ps($file);
5747 }
5748
5749 =item print TEMPLATE
5750
5751 Prints the filled in template.
5752
5753 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5754
5755 =cut
5756
5757 sub queueable_print {
5758   my %opt = @_;
5759
5760   my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5761     or die "invalid customer number: " . $opt{custvnum};
5762
5763   my $error = $self->print( $opt{template} );
5764   die $error if $error;
5765 }
5766
5767 sub print {
5768   my ($self, $template) = (shift, shift);
5769   do_print [ $self->print_ps($template) ];
5770 }
5771
5772 sub agent_template {
5773   my $self = shift;
5774   $self->_agent_plandata('agent_templatename');
5775 }
5776
5777 sub agent_invoice_from {
5778   my $self = shift;
5779   $self->_agent_plandata('agent_invoice_from');
5780 }
5781
5782 sub _agent_plandata {
5783   my( $self, $option ) = @_;
5784
5785   #yuck.  this whole thing needs to be reconciled better with 1.9's idea of
5786   #agent-specific Conf
5787
5788   my $agentnum = $self->agentnum;
5789
5790   my $part_event_option =
5791     qsearchs({
5792       'select'    => 'part_event_option.*',
5793       'table'     => 'part_event_option',
5794       'addl_from' => q{
5795         LEFT JOIN part_event USING ( eventpart )
5796         LEFT JOIN part_event_option AS peo_agentnum
5797           ON ( part_event.eventpart = peo_agentnum.eventpart
5798                AND peo_agentnum.optionname = 'agentnum'
5799                AND peo_agentnum.optionvalue ~ '(^|,)}. $agentnum. q{(,|$)'
5800              )
5801         LEFT JOIN part_event_option AS peo_cust_bill_age
5802           ON ( part_event.eventpart = peo_cust_bill_age.eventpart
5803                AND peo_cust_bill_age.optionname = 'cust_bill_age'
5804              )
5805       },
5806       #'hashref'   => { 'optionname' => $option },
5807       #'hashref'   => { 'part_event_option.optionname' => $option },
5808       'extra_sql' =>
5809         " WHERE part_event_option.optionname = ". dbh->quote($option).
5810         " AND action = 'cust_bill_send_agent' ".
5811         " AND ( disabled IS NULL OR disabled != 'Y' ) ".
5812         " AND peo_agentnum.optionname = 'agentnum' ".
5813         " AND agentnum IS NULL OR agentnum = $agentnum ".
5814         " ORDER BY
5815            CASE WHEN peo_cust_bill_age.optionname != 'cust_bill_age'
5816            THEN -1
5817            ELSE EXTRACT( EPOCH FROM
5818                            REPLACE( peo_cust_bill_age.optionvalue,
5819                                     'm',
5820                                     'mon'
5821                                   )::interval
5822                        )
5823           END
5824           , part_event.weight".
5825         " LIMIT 1"
5826     });
5827
5828   unless ( $part_event_option ) {
5829     return $self->agent->invoice_template || ''
5830       if $option eq 'agent_templatename';
5831     return '';
5832   }
5833
5834   $part_event_option->optionvalue;
5835
5836 }
5837
5838 sub queued_bill {
5839   ## actual sub, not a method, designed to be called from the queue.
5840   ## sets up the customer, and calls the bill_and_collect
5841   my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
5842   my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
5843       $cust_main->bill_and_collect(
5844         %args,
5845       );
5846 }
5847
5848 =back
5849
5850 =head1 BUGS
5851
5852 The delete method.
5853
5854 The delete method should possibly take an FS::cust_main object reference
5855 instead of a scalar customer number.
5856
5857 Bill and collect options should probably be passed as references instead of a
5858 list.
5859
5860 There should probably be a configuration file with a list of allowed credit
5861 card types.
5862
5863 No multiple currency support (probably a larger project than just this module).
5864
5865 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5866
5867 Birthdates rely on negative epoch values.
5868
5869 The payby for card/check batches is broken.  With mixed batching, bad
5870 things will happen.
5871
5872 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5873
5874 =head1 SEE ALSO
5875
5876 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5877 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5878 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
5879
5880 =cut
5881
5882 1;
5883