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 =cut
2437
2438 sub collect {
2439   my( $self, %options ) = @_;
2440   my $invoice_time = $options{'invoice_time'} || time;
2441
2442   #put below somehow?
2443   local $SIG{HUP} = 'IGNORE';
2444   local $SIG{INT} = 'IGNORE';
2445   local $SIG{QUIT} = 'IGNORE';
2446   local $SIG{TERM} = 'IGNORE';
2447   local $SIG{TSTP} = 'IGNORE';
2448   local $SIG{PIPE} = 'IGNORE';
2449
2450   my $oldAutoCommit = $FS::UID::AutoCommit;
2451   local $FS::UID::AutoCommit = 0;
2452   my $dbh = dbh;
2453
2454   $self->select_for_update; #mutex
2455
2456   if ( $DEBUG ) {
2457     my $balance = $self->balance;
2458     warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2459   }
2460
2461   if ( exists($options{'retry_card'}) ) {
2462     carp 'retry_card option passed to collect is deprecated; use retry';
2463     $options{'retry'} ||= $options{'retry_card'};
2464   }
2465   if ( exists($options{'retry'}) && $options{'retry'} ) {
2466     my $error = $self->retry_realtime;
2467     if ( $error ) {
2468       $dbh->rollback if $oldAutoCommit;
2469       return $error;
2470     }
2471   }
2472
2473   # false laziness w/pay_batch::import_results
2474
2475   my $due_cust_event = $self->due_cust_event(
2476     'time'       => $invoice_time,
2477     'check_freq' => $options{'check_freq'},
2478   );
2479   unless( ref($due_cust_event) ) {
2480     $dbh->rollback if $oldAutoCommit;
2481     return $due_cust_event;
2482   }
2483
2484   foreach my $cust_event ( @$due_cust_event ) {
2485
2486     #XXX lock event
2487
2488     #re-eval event conditions (a previous event could have changed things)
2489     next unless $cust_event->test_conditions( 'time' => $invoice_time );
2490
2491     {
2492       local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2493       warn "  running cust_event ". $cust_event->eventnum. "\n"
2494         if $DEBUG > 1;
2495
2496
2497       #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2498       if ( my $error = $cust_event->do_event() ) {
2499         #XXX wtf is this?  figure out a proper dealio with return value
2500         #from do_event
2501           # gah, even with transactions.
2502           $dbh->commit if $oldAutoCommit; #well.
2503           return $error;
2504         }
2505     }
2506
2507   }
2508
2509   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2510   '';
2511
2512 }
2513
2514 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2515
2516 Inserts database records for and returns an ordered listref of new events due
2517 for this customer, as FS::cust_event objects (see L<FS::cust_event>).  If no
2518 events are due, an empty listref is returned.  If there is an error, returns a
2519 scalar error message.
2520
2521 To actually run the events, call each event's test_condition method, and if
2522 still true, call the event's do_event method.
2523
2524 Options are passed as a hashref or as a list of name-value pairs.  Available
2525 options are:
2526
2527 =over 4
2528
2529 =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.
2530
2531 =item time - "Current time" for the events.
2532
2533 =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)
2534
2535 =item eventtable - Only return events for the specified eventtable (by default, events of all eventtables are returned)
2536
2537 =item objects - Explicitly pass the objects to be tested (typically used with eventtable).
2538
2539 =back
2540
2541 =cut
2542
2543 sub due_cust_event {
2544   my $self = shift;
2545   my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2546
2547   #???
2548   #my $DEBUG = $opt{'debug'}
2549   local($DEBUG) = $opt{'debug'}
2550     if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
2551
2552   warn "$me due_cust_event called with options ".
2553        join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2554     if $DEBUG;
2555
2556   $opt{'time'} ||= time;
2557
2558   local $SIG{HUP} = 'IGNORE';
2559   local $SIG{INT} = 'IGNORE';
2560   local $SIG{QUIT} = 'IGNORE';
2561   local $SIG{TERM} = 'IGNORE';
2562   local $SIG{TSTP} = 'IGNORE';
2563   local $SIG{PIPE} = 'IGNORE';
2564
2565   my $oldAutoCommit = $FS::UID::AutoCommit;
2566   local $FS::UID::AutoCommit = 0;
2567   my $dbh = dbh;
2568
2569   $self->select_for_update; #mutex
2570
2571   ###
2572   # 1: find possible events (initial search)
2573   ###
2574
2575   my @cust_event = ();
2576
2577   my @eventtable = $opt{'eventtable'}
2578                      ? ( $opt{'eventtable'} )
2579                      : FS::part_event->eventtables_runorder;
2580
2581   foreach my $eventtable ( @eventtable ) {
2582
2583     my @objects;
2584     if ( $opt{'objects'} ) {
2585
2586       @objects = @{ $opt{'objects'} };
2587
2588     } else {
2589
2590       #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
2591       @objects = ( $eventtable eq 'cust_main' )
2592                    ? ( $self )
2593                    : ( $self->$eventtable() );
2594
2595     }
2596
2597     my @e_cust_event = ();
2598
2599     my $cross = "CROSS JOIN $eventtable";
2600     $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2601       unless $eventtable eq 'cust_main';
2602
2603     foreach my $object ( @objects ) {
2604
2605       #this first search uses the condition_sql magic for optimization.
2606       #the more possible events we can eliminate in this step the better
2607
2608       my $cross_where = '';
2609       my $pkey = $object->primary_key;
2610       $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2611
2612       my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2613       my $extra_sql =
2614         FS::part_event_condition->where_conditions_sql( $eventtable,
2615                                                         'time'=>$opt{'time'}
2616                                                       );
2617       my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2618
2619       $extra_sql = "AND $extra_sql" if $extra_sql;
2620
2621       #here is the agent virtualization
2622       $extra_sql .= " AND (    part_event.agentnum IS NULL
2623                             OR part_event.agentnum = ". $self->agentnum. ' )';
2624
2625       $extra_sql .= " $order";
2626
2627       my @part_event = qsearch( {
2628         'select'    => 'part_event.*',
2629         'table'     => 'part_event',
2630         'addl_from' => "$cross $join",
2631         'hashref'   => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
2632                          'eventtable' => $eventtable,
2633                          'disabled'   => '',
2634                        },
2635         'extra_sql' => "AND $cross_where $extra_sql",
2636       } );
2637
2638       if ( $DEBUG > 2 ) {
2639         my $pkey = $object->primary_key;
2640         warn "      ". scalar(@part_event).
2641              " possible events found for $eventtable ". $object->$pkey(). "\n";
2642       }
2643
2644       push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
2645
2646     }
2647
2648     warn "    ". scalar(@e_cust_event).
2649          " subtotal possible cust events found for $eventtable"
2650       if $DEBUG > 1;
2651
2652     push @cust_event, @e_cust_event;
2653
2654   }
2655
2656   warn "  ". scalar(@cust_event).
2657        " total possible cust events found in initial search\n"
2658     if $DEBUG; # > 1;
2659
2660   ##
2661   # 2: test conditions
2662   ##
2663
2664   my %unsat = ();
2665
2666   @cust_event = grep $_->test_conditions( 'time'          => $opt{'time'},
2667                                           'stats_hashref' => \%unsat ),
2668                      @cust_event;
2669
2670   warn "  ". scalar(@cust_event). " cust events left satisfying conditions\n"
2671     if $DEBUG; # > 1;
2672
2673   warn "    invalid conditions not eliminated with condition_sql:\n".
2674        join('', map "      $_: ".$unsat{$_}."\n", keys %unsat );
2675
2676   ##
2677   # 3: insert
2678   ##
2679
2680   foreach my $cust_event ( @cust_event ) {
2681
2682     my $error = $cust_event->insert();
2683     if ( $error ) {
2684       $dbh->rollback if $oldAutoCommit;
2685       return $error;
2686     }
2687
2688   }
2689
2690   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2691
2692   ##
2693   # 4: return
2694   ##
2695
2696   warn "  returning events: ". Dumper(@cust_event). "\n"
2697     if $DEBUG > 2;
2698
2699   \@cust_event;
2700
2701 }
2702
2703 =item retry_realtime
2704
2705 Schedules realtime / batch  credit card / electronic check / LEC billing
2706 events for for retry.  Useful if card information has changed or manual
2707 retry is desired.  The 'collect' method must be called to actually retry
2708 the transaction.
2709
2710 Implementation details: For either this customer, or for each of this
2711 customer's open invoices, changes the status of the first "done" (with
2712 statustext error) realtime processing event to "failed".
2713
2714 =cut
2715
2716 sub retry_realtime {
2717   my $self = shift;
2718
2719   local $SIG{HUP} = 'IGNORE';
2720   local $SIG{INT} = 'IGNORE';
2721   local $SIG{QUIT} = 'IGNORE';
2722   local $SIG{TERM} = 'IGNORE';
2723   local $SIG{TSTP} = 'IGNORE';
2724   local $SIG{PIPE} = 'IGNORE';
2725
2726   my $oldAutoCommit = $FS::UID::AutoCommit;
2727   local $FS::UID::AutoCommit = 0;
2728   my $dbh = dbh;
2729
2730   #a little false laziness w/due_cust_event (not too bad, really)
2731
2732   my $join = FS::part_event_condition->join_conditions_sql;
2733   my $order = FS::part_event_condition->order_conditions_sql;
2734
2735   #here is the agent virtualization
2736   my $agent_virt = " (    part_event.agentnum IS NULL
2737                        OR part_event.agentnum = ". $self->agentnum. ' )';
2738
2739   #XXX this shouldn't be hardcoded, actions should declare it...
2740   my @realtime_events = qw(
2741     cust_bill_realtime_card
2742     cust_bill_realtime_check
2743     cust_bill_realtime_lec
2744     cust_bill_batch
2745   );
2746
2747   my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
2748                                                   @realtime_events
2749                                      ).
2750                           ' ) ';
2751
2752   my @cust_event = qsearchs({
2753     'table'     => 'cust_event',
2754     'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
2755     'hashref'   => { 'status' => 'done' },
2756     'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
2757                    " AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
2758   });
2759
2760   my %seen_invnum = ();
2761   foreach my $cust_event (@cust_event) {
2762
2763     #max one for the customer, one for each open invoice
2764     my $cust_X = $cust_event->cust_X;
2765     next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
2766                           ? $cust_X->invnum
2767                           : 0
2768                         }++
2769          or $cust_event->part_event->eventtable eq 'cust_bill'
2770             && ! $cust_X->owed;
2771
2772     my $error = $cust_event->retry;
2773     if ( $error ) {
2774       $dbh->rollback if $oldAutoCommit;
2775       return "error scheduling event for retry: $error";
2776     }
2777
2778   }
2779
2780   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2781   '';
2782
2783 }
2784
2785 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2786
2787 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2788 via a Business::OnlinePayment realtime gateway.  See
2789 L<http://420.am/business-onlinepayment> for supported gateways.
2790
2791 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2792
2793 Available options are: I<description>, I<invnum>, I<quiet>
2794
2795 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2796 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
2797 if set, will override the value from the customer record.
2798
2799 I<description> is a free-text field passed to the gateway.  It defaults to
2800 "Internet services".
2801
2802 If an I<invnum> is specified, this payment (if successful) is applied to the
2803 specified invoice.  If you don't specify an I<invnum> you might want to
2804 call the B<apply_payments> method.
2805
2806 I<quiet> can be set true to surpress email decline notices.
2807
2808 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2809
2810 =cut
2811
2812 sub realtime_bop {
2813   my( $self, $method, $amount, %options ) = @_;
2814   if ( $DEBUG ) {
2815     warn "$me realtime_bop: $method $amount\n";
2816     warn "  $_ => $options{$_}\n" foreach keys %options;
2817   }
2818
2819   $options{'description'} ||= 'Internet services';
2820
2821   eval "use Business::OnlinePayment";
2822   die $@ if $@;
2823
2824   my $payinfo = exists($options{'payinfo'})
2825                   ? $options{'payinfo'}
2826                   : $self->payinfo;
2827
2828   my %method2payby = (
2829     'CC'     => 'CARD',
2830     'ECHECK' => 'CHEK',
2831     'LEC'    => 'LECB',
2832   );
2833
2834   ###
2835   # check for banned credit card/ACH
2836   ###
2837
2838   my $ban = qsearchs('banned_pay', {
2839     'payby'   => $method2payby{$method},
2840     'payinfo' => md5_base64($payinfo),
2841   } );
2842   return "Banned credit card" if $ban;
2843
2844   ###
2845   # select a gateway
2846   ###
2847
2848   my $taxclass = '';
2849   if ( $options{'invnum'} ) {
2850     my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2851     die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2852     my @taxclasses =
2853       map  { $_->part_pkg->taxclass }
2854       grep { $_ }
2855       map  { $_->cust_pkg }
2856       $cust_bill->cust_bill_pkg;
2857     unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2858                                                            #different taxclasses
2859       $taxclass = $taxclasses[0];
2860     }
2861   }
2862
2863   #look for an agent gateway override first
2864   my $cardtype;
2865   if ( $method eq 'CC' ) {
2866     $cardtype = cardtype($payinfo);
2867   } elsif ( $method eq 'ECHECK' ) {
2868     $cardtype = 'ACH';
2869   } else {
2870     $cardtype = $method;
2871   }
2872
2873   my $override =
2874        qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2875                                            cardtype => $cardtype,
2876                                            taxclass => $taxclass,       } )
2877     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2878                                            cardtype => '',
2879                                            taxclass => $taxclass,       } )
2880     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2881                                            cardtype => $cardtype,
2882                                            taxclass => '',              } )
2883     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2884                                            cardtype => '',
2885                                            taxclass => '',              } );
2886
2887   my $payment_gateway = '';
2888   my( $processor, $login, $password, $action, @bop_options );
2889   if ( $override ) { #use a payment gateway override
2890
2891     $payment_gateway = $override->payment_gateway;
2892
2893     $processor   = $payment_gateway->gateway_module;
2894     $login       = $payment_gateway->gateway_username;
2895     $password    = $payment_gateway->gateway_password;
2896     $action      = $payment_gateway->gateway_action;
2897     @bop_options = $payment_gateway->options;
2898
2899   } else { #use the standard settings from the config
2900
2901     ( $processor, $login, $password, $action, @bop_options ) =
2902       $self->default_payment_gateway($method);
2903
2904   }
2905
2906   ###
2907   # massage data
2908   ###
2909
2910   my $address = exists($options{'address1'})
2911                     ? $options{'address1'}
2912                     : $self->address1;
2913   my $address2 = exists($options{'address2'})
2914                     ? $options{'address2'}
2915                     : $self->address2;
2916   $address .= ", ". $address2 if length($address2);
2917
2918   my $o_payname = exists($options{'payname'})
2919                     ? $options{'payname'}
2920                     : $self->payname;
2921   my($payname, $payfirst, $paylast);
2922   if ( $o_payname && $method ne 'ECHECK' ) {
2923     ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2924       or return "Illegal payname $payname";
2925     ($payfirst, $paylast) = ($1, $2);
2926   } else {
2927     $payfirst = $self->getfield('first');
2928     $paylast = $self->getfield('last');
2929     $payname =  "$payfirst $paylast";
2930   }
2931
2932   my @invoicing_list = $self->invoicing_list_emailonly;
2933   if ( $conf->exists('emailinvoiceautoalways')
2934        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
2935        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
2936     push @invoicing_list, $self->all_emails;
2937   }
2938
2939   my $email = ($conf->exists('business-onlinepayment-email-override'))
2940               ? $conf->config('business-onlinepayment-email-override')
2941               : $invoicing_list[0];
2942
2943   my %content = ();
2944
2945   my $payip = exists($options{'payip'})
2946                 ? $options{'payip'}
2947                 : $self->payip;
2948   $content{customer_ip} = $payip
2949     if length($payip);
2950
2951   $content{invoice_number} = $options{'invnum'}
2952     if exists($options{'invnum'}) && length($options{'invnum'});
2953
2954   my $paydate = '';
2955   if ( $method eq 'CC' ) {
2956
2957     $content{card_number} = $payinfo;
2958     $paydate = exists($options{'paydate'})
2959                     ? $options{'paydate'}
2960                     : $self->paydate;
2961     $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2962     $content{expiration} = "$2/$1";
2963
2964     my $paycvv = exists($options{'paycvv'})
2965                    ? $options{'paycvv'}
2966                    : $self->paycvv;
2967     $content{cvv2} = $self->paycvv
2968       if length($paycvv);
2969
2970     my $paystart_month = exists($options{'paystart_month'})
2971                            ? $options{'paystart_month'}
2972                            : $self->paystart_month;
2973
2974     my $paystart_year  = exists($options{'paystart_year'})
2975                            ? $options{'paystart_year'}
2976                            : $self->paystart_year;
2977
2978     $content{card_start} = "$paystart_month/$paystart_year"
2979       if $paystart_month && $paystart_year;
2980
2981     my $payissue       = exists($options{'payissue'})
2982                            ? $options{'payissue'}
2983                            : $self->payissue;
2984     $content{issue_number} = $payissue if $payissue;
2985
2986     $content{recurring_billing} = 'YES'
2987       if qsearch('cust_pay', { 'custnum' => $self->custnum,
2988                                'payby'   => 'CARD',
2989                                'payinfo' => $payinfo,
2990                              } )
2991       || qsearch('cust_pay', { 'custnum' => $self->custnum,
2992                                'payby'   => 'CARD',
2993                                'paymask' => $self->mask_payinfo('CARD', $payinfo),
2994                              } );
2995
2996
2997   } elsif ( $method eq 'ECHECK' ) {
2998     ( $content{account_number}, $content{routing_code} ) =
2999       split('@', $payinfo);
3000     $content{bank_name} = $o_payname;
3001     $content{bank_state} = exists($options{'paystate'})
3002                              ? $options{'paystate'}
3003                              : $self->getfield('paystate');
3004     $content{account_type} = exists($options{'paytype'})
3005                                ? uc($options{'paytype'}) || 'CHECKING'
3006                                : uc($self->getfield('paytype')) || 'CHECKING';
3007     $content{account_name} = $payname;
3008     $content{customer_org} = $self->company ? 'B' : 'I';
3009     $content{state_id}       = exists($options{'stateid'})
3010                                  ? $options{'stateid'}
3011                                  : $self->getfield('stateid');
3012     $content{state_id_state} = exists($options{'stateid_state'})
3013                                  ? $options{'stateid_state'}
3014                                  : $self->getfield('stateid_state');
3015     $content{customer_ssn} = exists($options{'ss'})
3016                                ? $options{'ss'}
3017                                : $self->ss;
3018   } elsif ( $method eq 'LEC' ) {
3019     $content{phone} = $payinfo;
3020   }
3021
3022   ###
3023   # run transaction(s)
3024   ###
3025
3026   my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3027
3028   my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3029   $transaction->content(
3030     'type'           => $method,
3031     'login'          => $login,
3032     'password'       => $password,
3033     'action'         => $action1,
3034     'description'    => $options{'description'},
3035     'amount'         => $amount,
3036     #'invoice_number' => $options{'invnum'},
3037     'customer_id'    => $self->custnum,
3038     'last_name'      => $paylast,
3039     'first_name'     => $payfirst,
3040     'name'           => $payname,
3041     'address'        => $address,
3042     'city'           => ( exists($options{'city'})
3043                             ? $options{'city'}
3044                             : $self->city          ),
3045     'state'          => ( exists($options{'state'})
3046                             ? $options{'state'}
3047                             : $self->state          ),
3048     'zip'            => ( exists($options{'zip'})
3049                             ? $options{'zip'}
3050                             : $self->zip          ),
3051     'country'        => ( exists($options{'country'})
3052                             ? $options{'country'}
3053                             : $self->country          ),
3054     'referer'        => 'http://cleanwhisker.420.am/',
3055     'email'          => $email,
3056     'phone'          => $self->daytime || $self->night,
3057     %content, #after
3058   );
3059   $transaction->submit();
3060
3061   if ( $transaction->is_success() && $action2 ) {
3062     my $auth = $transaction->authorization;
3063     my $ordernum = $transaction->can('order_number')
3064                    ? $transaction->order_number
3065                    : '';
3066
3067     my $capture =
3068       new Business::OnlinePayment( $processor, @bop_options );
3069
3070     my %capture = (
3071       %content,
3072       type           => $method,
3073       action         => $action2,
3074       login          => $login,
3075       password       => $password,
3076       order_number   => $ordernum,
3077       amount         => $amount,
3078       authorization  => $auth,
3079       description    => $options{'description'},
3080     );
3081
3082     foreach my $field (qw( authorization_source_code returned_ACI
3083                            transaction_identifier validation_code
3084                            transaction_sequence_num local_transaction_date
3085                            local_transaction_time AVS_result_code          )) {
3086       $capture{$field} = $transaction->$field() if $transaction->can($field);
3087     }
3088
3089     $capture->content( %capture );
3090
3091     $capture->submit();
3092
3093     unless ( $capture->is_success ) {
3094       my $e = "Authorization successful but capture failed, custnum #".
3095               $self->custnum. ': '.  $capture->result_code.
3096               ": ". $capture->error_message;
3097       warn $e;
3098       return $e;
3099     }
3100
3101   }
3102
3103   ###
3104   # remove paycvv after initial transaction
3105   ###
3106
3107   #false laziness w/misc/process/payment.cgi - check both to make sure working
3108   # correctly
3109   if ( defined $self->dbdef_table->column('paycvv')
3110        && length($self->paycvv)
3111        && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3112   ) {
3113     my $error = $self->remove_cvv;
3114     if ( $error ) {
3115       warn "WARNING: error removing cvv: $error\n";
3116     }
3117   }
3118
3119   ###
3120   # result handling
3121   ###
3122
3123   if ( $transaction->is_success() ) {
3124
3125     my %method2payby = (
3126       'CC'     => 'CARD',
3127       'ECHECK' => 'CHEK',
3128       'LEC'    => 'LECB',
3129     );
3130
3131     my $paybatch = '';
3132     if ( $payment_gateway ) { # agent override
3133       $paybatch = $payment_gateway->gatewaynum. '-';
3134     }
3135
3136     $paybatch .= "$processor:". $transaction->authorization;
3137
3138     $paybatch .= ':'. $transaction->order_number
3139       if $transaction->can('order_number')
3140       && length($transaction->order_number);
3141
3142     my $cust_pay = new FS::cust_pay ( {
3143        'custnum'  => $self->custnum,
3144        'invnum'   => $options{'invnum'},
3145        'paid'     => $amount,
3146        '_date'     => '',
3147        'payby'    => $method2payby{$method},
3148        'payinfo'  => $payinfo,
3149        'paybatch' => $paybatch,
3150        'paydate'  => $paydate,
3151     } );
3152     $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
3153
3154     my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3155
3156     if ( $error ) {
3157       $cust_pay->invnum(''); #try again with no specific invnum
3158       my $error2 = $cust_pay->insert( $options{'manual'} ?
3159                                       ( 'manual' => 1 ) : ()
3160                                     );
3161       if ( $error2 ) {
3162         # gah, even with transactions.
3163         my $e = 'WARNING: Card/ACH debited but database not updated - '.
3164                 "error inserting payment ($processor): $error2".
3165                 " (previously tried insert with invnum #$options{'invnum'}" .
3166                 ": $error )";
3167         warn $e;
3168         return $e;
3169       }
3170     }
3171     return ''; #no error
3172
3173   } else {
3174
3175     my $perror = "$processor error: ". $transaction->error_message;
3176
3177     unless ( $transaction->error_message ) {
3178
3179       my $t_response;
3180       if ( $transaction->can('response_page') ) {
3181         $t_response = {
3182                         'page'    => ( $transaction->can('response_page')
3183                                          ? $transaction->response_page
3184                                          : ''
3185                                      ),
3186                         'code'    => ( $transaction->can('response_code')
3187                                          ? $transaction->response_code
3188                                          : ''
3189                                      ),
3190                         'headers' => ( $transaction->can('response_headers')
3191                                          ? $transaction->response_headers
3192                                          : ''
3193                                      ),
3194                       };
3195       } else {
3196         $t_response .=
3197           "No additional debugging information available for $processor";
3198       }
3199
3200       $perror .= "No error_message returned from $processor -- ".
3201                  ( ref($t_response) ? Dumper($t_response) : $t_response );
3202
3203     }
3204
3205     if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
3206          && $conf->exists('emaildecline')
3207          && grep { $_ ne 'POST' } $self->invoicing_list
3208          && ! grep { $transaction->error_message =~ /$_/ }
3209                    $conf->config('emaildecline-exclude')
3210     ) {
3211       my @templ = $conf->config('declinetemplate');
3212       my $template = new Text::Template (
3213         TYPE   => 'ARRAY',
3214         SOURCE => [ map "$_\n", @templ ],
3215       ) or return "($perror) can't create template: $Text::Template::ERROR";
3216       $template->compile()
3217         or return "($perror) can't compile template: $Text::Template::ERROR";
3218
3219       my $templ_hash = { error => $transaction->error_message };
3220
3221       my $error = send_email(
3222         'from'    => $conf->config('invoice_from'),
3223         'to'      => [ grep { $_ ne 'POST' } $self->invoicing_list ],
3224         'subject' => 'Your payment could not be processed',
3225         'body'    => [ $template->fill_in(HASH => $templ_hash) ],
3226       );
3227
3228       $perror .= " (also received error sending decline notification: $error)"
3229         if $error;
3230
3231     }
3232
3233     return $perror;
3234   }
3235
3236 }
3237
3238 =item default_payment_gateway
3239
3240 =cut
3241
3242 sub default_payment_gateway {
3243   my( $self, $method ) = @_;
3244
3245   die "Real-time processing not enabled\n"
3246     unless $conf->exists('business-onlinepayment');
3247
3248   #load up config
3249   my $bop_config = 'business-onlinepayment';
3250   $bop_config .= '-ach'
3251     if $method eq 'ECHECK' && $conf->exists($bop_config. '-ach');
3252   my ( $processor, $login, $password, $action, @bop_options ) =
3253     $conf->config($bop_config);
3254   $action ||= 'normal authorization';
3255   pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3256   die "No real-time processor is enabled - ".
3257       "did you set the business-onlinepayment configuration value?\n"
3258     unless $processor;
3259
3260   ( $processor, $login, $password, $action, @bop_options )
3261 }
3262
3263 =item remove_cvv
3264
3265 Removes the I<paycvv> field from the database directly.
3266
3267 If there is an error, returns the error, otherwise returns false.
3268
3269 =cut
3270
3271 sub remove_cvv {
3272   my $self = shift;
3273   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3274     or return dbh->errstr;
3275   $sth->execute($self->custnum)
3276     or return $sth->errstr;
3277   $self->paycvv('');
3278   '';
3279 }
3280
3281 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3282
3283 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3284 via a Business::OnlinePayment realtime gateway.  See
3285 L<http://420.am/business-onlinepayment> for supported gateways.
3286
3287 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3288
3289 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3290
3291 Most gateways require a reference to an original payment transaction to refund,
3292 so you probably need to specify a I<paynum>.
3293
3294 I<amount> defaults to the original amount of the payment if not specified.
3295
3296 I<reason> specifies a reason for the refund.
3297
3298 I<paydate> specifies the expiration date for a credit card overriding the
3299 value from the customer record or the payment record. Specified as yyyy-mm-dd
3300
3301 Implementation note: If I<amount> is unspecified or equal to the amount of the
3302 orignal payment, first an attempt is made to "void" the transaction via
3303 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3304 the normal attempt is made to "refund" ("credit") the transaction via the
3305 gateway is attempted.
3306
3307 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3308 #I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
3309 #if set, will override the value from the customer record.
3310
3311 #If an I<invnum> is specified, this payment (if successful) is applied to the
3312 #specified invoice.  If you don't specify an I<invnum> you might want to
3313 #call the B<apply_payments> method.
3314
3315 =cut
3316
3317 #some false laziness w/realtime_bop, not enough to make it worth merging
3318 #but some useful small subs should be pulled out
3319 sub realtime_refund_bop {
3320   my( $self, $method, %options ) = @_;
3321   if ( $DEBUG ) {
3322     warn "$me realtime_refund_bop: $method refund\n";
3323     warn "  $_ => $options{$_}\n" foreach keys %options;
3324   }
3325
3326   eval "use Business::OnlinePayment";
3327   die $@ if $@;
3328
3329   ###
3330   # look up the original payment and optionally a gateway for that payment
3331   ###
3332
3333   my $cust_pay = '';
3334   my $amount = $options{'amount'};
3335
3336   my( $processor, $login, $password, @bop_options ) ;
3337   my( $auth, $order_number ) = ( '', '', '' );
3338
3339   if ( $options{'paynum'} ) {
3340
3341     warn "  paynum: $options{paynum}\n" if $DEBUG > 1;
3342     $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3343       or return "Unknown paynum $options{'paynum'}";
3344     $amount ||= $cust_pay->paid;
3345
3346     $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3347       or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3348                 $cust_pay->paybatch;
3349     my $gatewaynum = '';
3350     ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3351
3352     if ( $gatewaynum ) { #gateway for the payment to be refunded
3353
3354       my $payment_gateway =
3355         qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3356       die "payment gateway $gatewaynum not found"
3357         unless $payment_gateway;
3358
3359       $processor   = $payment_gateway->gateway_module;
3360       $login       = $payment_gateway->gateway_username;
3361       $password    = $payment_gateway->gateway_password;
3362       @bop_options = $payment_gateway->options;
3363
3364     } else { #try the default gateway
3365
3366       my( $conf_processor, $unused_action );
3367       ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3368         $self->default_payment_gateway($method);
3369
3370       return "processor of payment $options{'paynum'} $processor does not".
3371              " match default processor $conf_processor"
3372         unless $processor eq $conf_processor;
3373
3374     }
3375
3376
3377   } else { # didn't specify a paynum, so look for agent gateway overrides
3378            # like a normal transaction
3379
3380     my $cardtype;
3381     if ( $method eq 'CC' ) {
3382       $cardtype = cardtype($self->payinfo);
3383     } elsif ( $method eq 'ECHECK' ) {
3384       $cardtype = 'ACH';
3385     } else {
3386       $cardtype = $method;
3387     }
3388     my $override =
3389            qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3390                                                cardtype => $cardtype,
3391                                                taxclass => '',              } )
3392         || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3393                                                cardtype => '',
3394                                                taxclass => '',              } );
3395
3396     if ( $override ) { #use a payment gateway override
3397
3398       my $payment_gateway = $override->payment_gateway;
3399
3400       $processor   = $payment_gateway->gateway_module;
3401       $login       = $payment_gateway->gateway_username;
3402       $password    = $payment_gateway->gateway_password;
3403       #$action      = $payment_gateway->gateway_action;
3404       @bop_options = $payment_gateway->options;
3405
3406     } else { #use the standard settings from the config
3407
3408       my $unused_action;
3409       ( $processor, $login, $password, $unused_action, @bop_options ) =
3410         $self->default_payment_gateway($method);
3411
3412     }
3413
3414   }
3415   return "neither amount nor paynum specified" unless $amount;
3416
3417   my %content = (
3418     'type'           => $method,
3419     'login'          => $login,
3420     'password'       => $password,
3421     'order_number'   => $order_number,
3422     'amount'         => $amount,
3423     'referer'        => 'http://cleanwhisker.420.am/',
3424   );
3425   $content{authorization} = $auth
3426     if length($auth); #echeck/ACH transactions have an order # but no auth
3427                       #(at least with authorize.net)
3428
3429   my $disable_void_after;
3430   if ($conf->exists('disable_void_after')
3431       && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3432     $disable_void_after = $1;
3433   }
3434
3435   #first try void if applicable
3436   if ( $cust_pay && $cust_pay->paid == $amount
3437     && (
3438       ( not defined($disable_void_after) )
3439       || ( time < ($cust_pay->_date + $disable_void_after ) )
3440     )
3441   ) {
3442     warn "  attempting void\n" if $DEBUG > 1;
3443     my $void = new Business::OnlinePayment( $processor, @bop_options );
3444     $void->content( 'action' => 'void', %content );
3445     $void->submit();
3446     if ( $void->is_success ) {
3447       my $error = $cust_pay->void($options{'reason'});
3448       if ( $error ) {
3449         # gah, even with transactions.
3450         my $e = 'WARNING: Card/ACH voided but database not updated - '.
3451                 "error voiding payment: $error";
3452         warn $e;
3453         return $e;
3454       }
3455       warn "  void successful\n" if $DEBUG > 1;
3456       return '';
3457     }
3458   }
3459
3460   warn "  void unsuccessful, trying refund\n"
3461     if $DEBUG > 1;
3462
3463   #massage data
3464   my $address = $self->address1;
3465   $address .= ", ". $self->address2 if $self->address2;
3466
3467   my($payname, $payfirst, $paylast);
3468   if ( $self->payname && $method ne 'ECHECK' ) {
3469     $payname = $self->payname;
3470     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3471       or return "Illegal payname $payname";
3472     ($payfirst, $paylast) = ($1, $2);
3473   } else {
3474     $payfirst = $self->getfield('first');
3475     $paylast = $self->getfield('last');
3476     $payname =  "$payfirst $paylast";
3477   }
3478
3479   my @invoicing_list = $self->invoicing_list_emailonly;
3480   if ( $conf->exists('emailinvoiceautoalways')
3481        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3482        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3483     push @invoicing_list, $self->all_emails;
3484   }
3485
3486   my $email = ($conf->exists('business-onlinepayment-email-override'))
3487               ? $conf->config('business-onlinepayment-email-override')
3488               : $invoicing_list[0];
3489
3490   my $payip = exists($options{'payip'})
3491                 ? $options{'payip'}
3492                 : $self->payip;
3493   $content{customer_ip} = $payip
3494     if length($payip);
3495
3496   my $payinfo = '';
3497   if ( $method eq 'CC' ) {
3498
3499     if ( $cust_pay ) {
3500       $content{card_number} = $payinfo = $cust_pay->payinfo;
3501       (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
3502         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
3503         ($content{expiration} = "$2/$1");  # where available
3504     } else {
3505       $content{card_number} = $payinfo = $self->payinfo;
3506       (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
3507         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3508       $content{expiration} = "$2/$1";
3509     }
3510
3511   } elsif ( $method eq 'ECHECK' ) {
3512
3513     if ( $cust_pay ) {
3514       $payinfo = $cust_pay->payinfo;
3515     } else {
3516       $payinfo = $self->payinfo;
3517     }
3518     ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
3519     $content{bank_name} = $self->payname;
3520     $content{account_type} = 'CHECKING';
3521     $content{account_name} = $payname;
3522     $content{customer_org} = $self->company ? 'B' : 'I';
3523     $content{customer_ssn} = $self->ss;
3524   } elsif ( $method eq 'LEC' ) {
3525     $content{phone} = $payinfo = $self->payinfo;
3526   }
3527
3528   #then try refund
3529   my $refund = new Business::OnlinePayment( $processor, @bop_options );
3530   my %sub_content = $refund->content(
3531     'action'         => 'credit',
3532     'customer_id'    => $self->custnum,
3533     'last_name'      => $paylast,
3534     'first_name'     => $payfirst,
3535     'name'           => $payname,
3536     'address'        => $address,
3537     'city'           => $self->city,
3538     'state'          => $self->state,
3539     'zip'            => $self->zip,
3540     'country'        => $self->country,
3541     'email'          => $email,
3542     'phone'          => $self->daytime || $self->night,
3543     %content, #after
3544   );
3545   warn join('', map { "  $_ => $sub_content{$_}\n" } keys %sub_content )
3546     if $DEBUG > 1;
3547   $refund->submit();
3548
3549   return "$processor error: ". $refund->error_message
3550     unless $refund->is_success();
3551
3552   my %method2payby = (
3553     'CC'     => 'CARD',
3554     'ECHECK' => 'CHEK',
3555     'LEC'    => 'LECB',
3556   );
3557
3558   my $paybatch = "$processor:". $refund->authorization;
3559   $paybatch .= ':'. $refund->order_number
3560     if $refund->can('order_number') && $refund->order_number;
3561
3562   while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3563     my @cust_bill_pay = $cust_pay->cust_bill_pay;
3564     last unless @cust_bill_pay;
3565     my $cust_bill_pay = pop @cust_bill_pay;
3566     my $error = $cust_bill_pay->delete;
3567     last if $error;
3568   }
3569
3570   my $cust_refund = new FS::cust_refund ( {
3571     'custnum'  => $self->custnum,
3572     'paynum'   => $options{'paynum'},
3573     'refund'   => $amount,
3574     '_date'    => '',
3575     'payby'    => $method2payby{$method},
3576     'payinfo'  => $payinfo,
3577     'paybatch' => $paybatch,
3578     'reason'   => $options{'reason'} || 'card or ACH refund',
3579   } );
3580   my $error = $cust_refund->insert;
3581   if ( $error ) {
3582     $cust_refund->paynum(''); #try again with no specific paynum
3583     my $error2 = $cust_refund->insert;
3584     if ( $error2 ) {
3585       # gah, even with transactions.
3586       my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3587               "error inserting refund ($processor): $error2".
3588               " (previously tried insert with paynum #$options{'paynum'}" .
3589               ": $error )";
3590       warn $e;
3591       return $e;
3592     }
3593   }
3594
3595   ''; #no error
3596
3597 }
3598
3599 =item batch_card OPTION => VALUE...
3600
3601 Adds a payment for this invoice to the pending credit card batch (see
3602 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
3603 runs the payment using a realtime gateway.
3604
3605 =cut
3606
3607 sub batch_card {
3608   my ($self, %options) = @_;
3609
3610   my $amount;
3611   if (exists($options{amount})) {
3612     $amount = $options{amount};
3613   }else{
3614     $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
3615   }
3616   return '' unless $amount > 0;
3617
3618   my $invnum = delete $options{invnum};
3619   my $payby = $options{invnum} || $self->payby;  #dubious
3620
3621   if ($options{'realtime'}) {
3622     return $self->realtime_bop( FS::payby->payby2bop($self->payby),
3623                                 $amount,
3624                                 %options,
3625                               );
3626   }
3627
3628   my $oldAutoCommit = $FS::UID::AutoCommit;
3629   local $FS::UID::AutoCommit = 0;
3630   my $dbh = dbh;
3631
3632   $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
3633     or return "Cannot lock pay_batch: " . $dbh->errstr;
3634
3635   my %pay_batch = (
3636     'status' => 'O',
3637     'payby'  => FS::payby->payby2payment($payby),
3638   );
3639
3640   my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
3641
3642   unless ( $pay_batch ) {
3643     $pay_batch = new FS::pay_batch \%pay_batch;
3644     my $error = $pay_batch->insert;
3645     if ( $error ) {
3646       $dbh->rollback if $oldAutoCommit;
3647       die "error creating new batch: $error\n";
3648     }
3649   }
3650
3651   my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
3652       'batchnum' => $pay_batch->batchnum,
3653       'custnum'  => $self->custnum,
3654   } );
3655
3656   foreach (qw( address1 address2 city state zip country payby payinfo paydate
3657                payname )) {
3658     $options{$_} = '' unless exists($options{$_});
3659   }
3660
3661   my $cust_pay_batch = new FS::cust_pay_batch ( {
3662     'batchnum' => $pay_batch->batchnum,
3663     'invnum'   => $invnum || 0,                    # is there a better value?
3664                                                    # this field should be
3665                                                    # removed...
3666                                                    # cust_bill_pay_batch now
3667     'custnum'  => $self->custnum,
3668     'last'     => $self->getfield('last'),
3669     'first'    => $self->getfield('first'),
3670     'address1' => $options{address1} || $self->address1,
3671     'address2' => $options{address2} || $self->address2,
3672     'city'     => $options{city}     || $self->city,
3673     'state'    => $options{state}    || $self->state,
3674     'zip'      => $options{zip}      || $self->zip,
3675     'country'  => $options{country}  || $self->country,
3676     'payby'    => $options{payby}    || $self->payby,
3677     'payinfo'  => $options{payinfo}  || $self->payinfo,
3678     'exp'      => $options{paydate}  || $self->paydate,
3679     'payname'  => $options{payname}  || $self->payname,
3680     'amount'   => $amount,                         # consolidating
3681   } );
3682
3683   $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
3684     if $old_cust_pay_batch;
3685
3686   my $error;
3687   if ($old_cust_pay_batch) {
3688     $error = $cust_pay_batch->replace($old_cust_pay_batch)
3689   } else {
3690     $error = $cust_pay_batch->insert;
3691   }
3692
3693   if ( $error ) {
3694     $dbh->rollback if $oldAutoCommit;
3695     die $error;
3696   }
3697
3698   my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
3699   foreach my $cust_bill ($self->open_cust_bill) {
3700     #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
3701     my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
3702       'invnum' => $cust_bill->invnum,
3703       'paybatchnum' => $cust_pay_batch->paybatchnum,
3704       'amount' => $cust_bill->owed,
3705       '_date' => time,
3706     };
3707     if ($unapplied >= $cust_bill_pay_batch->amount){
3708       $unapplied -= $cust_bill_pay_batch->amount;
3709       next;
3710     }else{
3711       $cust_bill_pay_batch->amount(sprintf ( "%.2f",
3712                                    $cust_bill_pay_batch->amount - $unapplied ));      $unapplied = 0;
3713     }
3714     $error = $cust_bill_pay_batch->insert;
3715     if ( $error ) {
3716       $dbh->rollback if $oldAutoCommit;
3717       die $error;
3718     }
3719   }
3720
3721   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3722   '';
3723 }
3724
3725 =item total_owed
3726
3727 Returns the total owed for this customer on all invoices
3728 (see L<FS::cust_bill/owed>).
3729
3730 =cut
3731
3732 sub total_owed {
3733   my $self = shift;
3734   $self->total_owed_date(2145859200); #12/31/2037
3735 }
3736
3737 =item total_owed_date TIME
3738
3739 Returns the total owed for this customer on all invoices with date earlier than
3740 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
3741 see L<Time::Local> and L<Date::Parse> for conversion functions.
3742
3743 =cut
3744
3745 sub total_owed_date {
3746   my $self = shift;
3747   my $time = shift;
3748   my $total_bill = 0;
3749   foreach my $cust_bill (
3750     grep { $_->_date <= $time }
3751       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3752   ) {
3753     $total_bill += $cust_bill->owed;
3754   }
3755   sprintf( "%.2f", $total_bill );
3756 }
3757
3758 =item apply_payments_and_credits
3759
3760 Applies unapplied payments and credits.
3761
3762 In most cases, this new method should be used in place of sequential
3763 apply_payments and apply_credits methods.
3764
3765 If there is an error, returns the error, otherwise returns false.
3766
3767 =cut
3768
3769 sub apply_payments_and_credits {
3770   my $self = shift;
3771
3772   local $SIG{HUP} = 'IGNORE';
3773   local $SIG{INT} = 'IGNORE';
3774   local $SIG{QUIT} = 'IGNORE';
3775   local $SIG{TERM} = 'IGNORE';
3776   local $SIG{TSTP} = 'IGNORE';
3777   local $SIG{PIPE} = 'IGNORE';
3778
3779   my $oldAutoCommit = $FS::UID::AutoCommit;
3780   local $FS::UID::AutoCommit = 0;
3781   my $dbh = dbh;
3782
3783   $self->select_for_update; #mutex
3784
3785   foreach my $cust_bill ( $self->open_cust_bill ) {
3786     my $error = $cust_bill->apply_payments_and_credits;
3787     if ( $error ) {
3788       $dbh->rollback if $oldAutoCommit;
3789       return "Error applying: $error";
3790     }
3791   }
3792
3793   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3794   ''; #no error
3795
3796 }
3797
3798 =item apply_credits OPTION => VALUE ...
3799
3800 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3801 to outstanding invoice balances in chronological order (or reverse
3802 chronological order if the I<order> option is set to B<newest>) and returns the
3803 value of any remaining unapplied credits available for refund (see
3804 L<FS::cust_refund>).
3805
3806 Dies if there is an error.
3807
3808 =cut
3809
3810 sub apply_credits {
3811   my $self = shift;
3812   my %opt = @_;
3813
3814   local $SIG{HUP} = 'IGNORE';
3815   local $SIG{INT} = 'IGNORE';
3816   local $SIG{QUIT} = 'IGNORE';
3817   local $SIG{TERM} = 'IGNORE';
3818   local $SIG{TSTP} = 'IGNORE';
3819   local $SIG{PIPE} = 'IGNORE';
3820
3821   my $oldAutoCommit = $FS::UID::AutoCommit;
3822   local $FS::UID::AutoCommit = 0;
3823   my $dbh = dbh;
3824
3825   $self->select_for_update; #mutex
3826
3827   unless ( $self->total_credited ) {
3828     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3829     return 0;
3830   }
3831
3832   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3833       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3834
3835   my @invoices = $self->open_cust_bill;
3836   @invoices = sort { $b->_date <=> $a->_date } @invoices
3837     if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3838
3839   my $credit;
3840   foreach my $cust_bill ( @invoices ) {
3841     my $amount;
3842
3843     if ( !defined($credit) || $credit->credited == 0) {
3844       $credit = pop @credits or last;
3845     }
3846
3847     if ($cust_bill->owed >= $credit->credited) {
3848       $amount=$credit->credited;
3849     }else{
3850       $amount=$cust_bill->owed;
3851     }
3852
3853     my $cust_credit_bill = new FS::cust_credit_bill ( {
3854       'crednum' => $credit->crednum,
3855       'invnum'  => $cust_bill->invnum,
3856       'amount'  => $amount,
3857     } );
3858     my $error = $cust_credit_bill->insert;
3859     if ( $error ) {
3860       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3861       die $error;
3862     }
3863
3864     redo if ($cust_bill->owed > 0);
3865
3866   }
3867
3868   my $total_credited = $self->total_credited;
3869
3870   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3871
3872   return $total_credited;
3873 }
3874
3875 =item apply_payments
3876
3877 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3878 to outstanding invoice balances in chronological order.
3879
3880  #and returns the value of any remaining unapplied payments.
3881
3882 Dies if there is an error.
3883
3884 =cut
3885
3886 sub apply_payments {
3887   my $self = shift;
3888
3889   local $SIG{HUP} = 'IGNORE';
3890   local $SIG{INT} = 'IGNORE';
3891   local $SIG{QUIT} = 'IGNORE';
3892   local $SIG{TERM} = 'IGNORE';
3893   local $SIG{TSTP} = 'IGNORE';
3894   local $SIG{PIPE} = 'IGNORE';
3895
3896   my $oldAutoCommit = $FS::UID::AutoCommit;
3897   local $FS::UID::AutoCommit = 0;
3898   my $dbh = dbh;
3899
3900   $self->select_for_update; #mutex
3901
3902   #return 0 unless
3903
3904   my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
3905       qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
3906
3907   my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
3908       qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
3909
3910   my $payment;
3911
3912   foreach my $cust_bill ( @invoices ) {
3913     my $amount;
3914
3915     if ( !defined($payment) || $payment->unapplied == 0 ) {
3916       $payment = pop @payments or last;
3917     }
3918
3919     if ( $cust_bill->owed >= $payment->unapplied ) {
3920       $amount = $payment->unapplied;
3921     } else {
3922       $amount = $cust_bill->owed;
3923     }
3924
3925     my $cust_bill_pay = new FS::cust_bill_pay ( {
3926       'paynum' => $payment->paynum,
3927       'invnum' => $cust_bill->invnum,
3928       'amount' => $amount,
3929     } );
3930     my $error = $cust_bill_pay->insert;
3931     if ( $error ) {
3932       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3933       die $error;
3934     }
3935
3936     redo if ( $cust_bill->owed > 0);
3937
3938   }
3939
3940   my $total_unapplied_payments = $self->total_unapplied_payments;
3941
3942   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3943
3944   return $total_unapplied_payments;
3945 }
3946
3947 =item total_credited
3948
3949 Returns the total outstanding credit (see L<FS::cust_credit>) for this
3950 customer.  See L<FS::cust_credit/credited>.
3951
3952 =cut
3953
3954 sub total_credited {
3955   my $self = shift;
3956   my $total_credit = 0;
3957   foreach my $cust_credit ( qsearch('cust_credit', {
3958     'custnum' => $self->custnum,
3959   } ) ) {
3960     $total_credit += $cust_credit->credited;
3961   }
3962   sprintf( "%.2f", $total_credit );
3963 }
3964
3965 =item total_unapplied_payments
3966
3967 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
3968 See L<FS::cust_pay/unapplied>.
3969
3970 =cut
3971
3972 sub total_unapplied_payments {
3973   my $self = shift;
3974   my $total_unapplied = 0;
3975   foreach my $cust_pay ( qsearch('cust_pay', {
3976     'custnum' => $self->custnum,
3977   } ) ) {
3978     $total_unapplied += $cust_pay->unapplied;
3979   }
3980   sprintf( "%.2f", $total_unapplied );
3981 }
3982
3983 =item total_unapplied_refunds
3984
3985 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
3986 customer.  See L<FS::cust_refund/unapplied>.
3987
3988 =cut
3989
3990 sub total_unapplied_refunds {
3991   my $self = shift;
3992   my $total_unapplied = 0;
3993   foreach my $cust_refund ( qsearch('cust_refund', {
3994     'custnum' => $self->custnum,
3995   } ) ) {
3996     $total_unapplied += $cust_refund->unapplied;
3997   }
3998   sprintf( "%.2f", $total_unapplied );
3999 }
4000
4001 =item balance
4002
4003 Returns the balance for this customer (total_owed plus total_unrefunded, minus
4004 total_credited minus total_unapplied_payments).
4005
4006 =cut
4007
4008 sub balance {
4009   my $self = shift;
4010   sprintf( "%.2f",
4011       $self->total_owed
4012     + $self->total_unapplied_refunds
4013     - $self->total_credited
4014     - $self->total_unapplied_payments
4015   );
4016 }
4017
4018 =item balance_date TIME
4019
4020 Returns the balance for this customer, only considering invoices with date
4021 earlier than TIME (total_owed_date minus total_credited minus
4022 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
4023 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
4024 functions.
4025
4026 =cut
4027
4028 sub balance_date {
4029   my $self = shift;
4030   my $time = shift;
4031   sprintf( "%.2f",
4032         $self->total_owed_date($time)
4033       + $self->total_unapplied_refunds
4034       - $self->total_credited
4035       - $self->total_unapplied_payments
4036   );
4037 }
4038
4039 =item in_transit_payments
4040
4041 Returns the total of requests for payments for this customer pending in
4042 batches in transit to the bank.  See L<FS::pay_batch> and L<FS::cust_pay_batch>
4043
4044 =cut
4045
4046 sub in_transit_payments {
4047   my $self = shift;
4048   my $in_transit_payments = 0;
4049   foreach my $pay_batch ( qsearch('pay_batch', {
4050     'status' => 'I',
4051   } ) ) {
4052     foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
4053       'batchnum' => $pay_batch->batchnum,
4054       'custnum' => $self->custnum,
4055     } ) ) {
4056       $in_transit_payments += $cust_pay_batch->amount;
4057     }
4058   }
4059   sprintf( "%.2f", $in_transit_payments );
4060 }
4061
4062 =item paydate_monthyear
4063
4064 Returns a two-element list consisting of the month and year of this customer's
4065 paydate (credit card expiration date for CARD customers)
4066
4067 =cut
4068
4069 sub paydate_monthyear {
4070   my $self = shift;
4071   if ( $self->paydate  =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
4072     ( $2, $1 );
4073   } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
4074     ( $1, $3 );
4075   } else {
4076     ('', '');
4077   }
4078 }
4079
4080 =item invoicing_list [ ARRAYREF ]
4081
4082 If an arguement is given, sets these email addresses as invoice recipients
4083 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
4084 (except as warnings), so use check_invoicing_list first.
4085
4086 Returns a list of email addresses (with svcnum entries expanded).
4087
4088 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
4089 check it without disturbing anything by passing nothing.
4090
4091 This interface may change in the future.
4092
4093 =cut
4094
4095 sub invoicing_list {
4096   my( $self, $arrayref ) = @_;
4097
4098   if ( $arrayref ) {
4099     my @cust_main_invoice;
4100     if ( $self->custnum ) {
4101       @cust_main_invoice =
4102         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4103     } else {
4104       @cust_main_invoice = ();
4105     }
4106     foreach my $cust_main_invoice ( @cust_main_invoice ) {
4107       #warn $cust_main_invoice->destnum;
4108       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
4109         #warn $cust_main_invoice->destnum;
4110         my $error = $cust_main_invoice->delete;
4111         warn $error if $error;
4112       }
4113     }
4114     if ( $self->custnum ) {
4115       @cust_main_invoice =
4116         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4117     } else {
4118       @cust_main_invoice = ();
4119     }
4120     my %seen = map { $_->address => 1 } @cust_main_invoice;
4121     foreach my $address ( @{$arrayref} ) {
4122       next if exists $seen{$address} && $seen{$address};
4123       $seen{$address} = 1;
4124       my $cust_main_invoice = new FS::cust_main_invoice ( {
4125         'custnum' => $self->custnum,
4126         'dest'    => $address,
4127       } );
4128       my $error = $cust_main_invoice->insert;
4129       warn $error if $error;
4130     }
4131   }
4132
4133   if ( $self->custnum ) {
4134     map { $_->address }
4135       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4136   } else {
4137     ();
4138   }
4139
4140 }
4141
4142 =item check_invoicing_list ARRAYREF
4143
4144 Checks these arguements as valid input for the invoicing_list method.  If there
4145 is an error, returns the error, otherwise returns false.
4146
4147 =cut
4148
4149 sub check_invoicing_list {
4150   my( $self, $arrayref ) = @_;
4151
4152   foreach my $address ( @$arrayref ) {
4153
4154     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
4155       return 'Can\'t add FAX invoice destination with a blank FAX number.';
4156     }
4157
4158     my $cust_main_invoice = new FS::cust_main_invoice ( {
4159       'custnum' => $self->custnum,
4160       'dest'    => $address,
4161     } );
4162     my $error = $self->custnum
4163                 ? $cust_main_invoice->check
4164                 : $cust_main_invoice->checkdest
4165     ;
4166     return $error if $error;
4167
4168   }
4169
4170   return "Email address required"
4171     if $conf->exists('cust_main-require_invoicing_list_email')
4172     && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
4173
4174   '';
4175 }
4176
4177 =item set_default_invoicing_list
4178
4179 Sets the invoicing list to all accounts associated with this customer,
4180 overwriting any previous invoicing list.
4181
4182 =cut
4183
4184 sub set_default_invoicing_list {
4185   my $self = shift;
4186   $self->invoicing_list($self->all_emails);
4187 }
4188
4189 =item all_emails
4190
4191 Returns the email addresses of all accounts provisioned for this customer.
4192
4193 =cut
4194
4195 sub all_emails {
4196   my $self = shift;
4197   my %list;
4198   foreach my $cust_pkg ( $self->all_pkgs ) {
4199     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
4200     my @svc_acct =
4201       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4202         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4203           @cust_svc;
4204     $list{$_}=1 foreach map { $_->email } @svc_acct;
4205   }
4206   keys %list;
4207 }
4208
4209 =item invoicing_list_addpost
4210
4211 Adds postal invoicing to this customer.  If this customer is already configured
4212 to receive postal invoices, does nothing.
4213
4214 =cut
4215
4216 sub invoicing_list_addpost {
4217   my $self = shift;
4218   return if grep { $_ eq 'POST' } $self->invoicing_list;
4219   my @invoicing_list = $self->invoicing_list;
4220   push @invoicing_list, 'POST';
4221   $self->invoicing_list(\@invoicing_list);
4222 }
4223
4224 =item invoicing_list_emailonly
4225
4226 Returns the list of email invoice recipients (invoicing_list without non-email
4227 destinations such as POST and FAX).
4228
4229 =cut
4230
4231 sub invoicing_list_emailonly {
4232   my $self = shift;
4233   warn "$me invoicing_list_emailonly called"
4234     if $DEBUG;
4235   grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
4236 }
4237
4238 =item invoicing_list_emailonly_scalar
4239
4240 Returns the list of email invoice recipients (invoicing_list without non-email
4241 destinations such as POST and FAX) as a comma-separated scalar.
4242
4243 =cut
4244
4245 sub invoicing_list_emailonly_scalar {
4246   my $self = shift;
4247   warn "$me invoicing_list_emailonly_scalar called"
4248     if $DEBUG;
4249   join(', ', $self->invoicing_list_emailonly);
4250 }
4251
4252 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
4253
4254 Returns an array of customers referred by this customer (referral_custnum set
4255 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
4256 customers referred by customers referred by this customer and so on, inclusive.
4257 The default behavior is DEPTH 1 (no recursion).
4258
4259 =cut
4260
4261 sub referral_cust_main {
4262   my $self = shift;
4263   my $depth = @_ ? shift : 1;
4264   my $exclude = @_ ? shift : {};
4265
4266   my @cust_main =
4267     map { $exclude->{$_->custnum}++; $_; }
4268       grep { ! $exclude->{ $_->custnum } }
4269         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4270
4271   if ( $depth > 1 ) {
4272     push @cust_main,
4273       map { $_->referral_cust_main($depth-1, $exclude) }
4274         @cust_main;
4275   }
4276
4277   @cust_main;
4278 }
4279
4280 =item referral_cust_main_ncancelled
4281
4282 Same as referral_cust_main, except only returns customers with uncancelled
4283 packages.
4284
4285 =cut
4286
4287 sub referral_cust_main_ncancelled {
4288   my $self = shift;
4289   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4290 }
4291
4292 =item referral_cust_pkg [ DEPTH ]
4293
4294 Like referral_cust_main, except returns a flat list of all unsuspended (and
4295 uncancelled) packages for each customer.  The number of items in this list may
4296 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4297
4298 =cut
4299
4300 sub referral_cust_pkg {
4301   my $self = shift;
4302   my $depth = @_ ? shift : 1;
4303
4304   map { $_->unsuspended_pkgs }
4305     grep { $_->unsuspended_pkgs }
4306       $self->referral_cust_main($depth);
4307 }
4308
4309 =item referring_cust_main
4310
4311 Returns the single cust_main record for the customer who referred this customer
4312 (referral_custnum), or false.
4313
4314 =cut
4315
4316 sub referring_cust_main {
4317   my $self = shift;
4318   return '' unless $self->referral_custnum;
4319   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4320 }
4321
4322 =item credit AMOUNT, REASON
4323
4324 Applies a credit to this customer.  If there is an error, returns the error,
4325 otherwise returns false.
4326
4327 =cut
4328
4329 sub credit {
4330   my( $self, $amount, $reason ) = @_;
4331   my $cust_credit = new FS::cust_credit {
4332     'custnum' => $self->custnum,
4333     'amount'  => $amount,
4334     'reason'  => $reason,
4335   };
4336   $cust_credit->insert;
4337 }
4338
4339 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4340
4341 Creates a one-time charge for this customer.  If there is an error, returns
4342 the error, otherwise returns false.
4343
4344 =cut
4345
4346 sub charge {
4347   my $self = shift;
4348   my ( $amount, $pkg, $comment, $taxclass, $additional );
4349   if ( ref( $_[0] ) ) {
4350     $amount     = $_[0]->{amount};
4351     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4352     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
4353                                            : '$'. sprintf("%.2f",$amount);
4354     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4355     $additional = $_[0]->{additional};
4356   }else{
4357     $amount     = shift;
4358     $pkg        = @_ ? shift : 'One-time charge';
4359     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
4360     $taxclass   = @_ ? shift : '';
4361     $additional = [];
4362   }
4363
4364   local $SIG{HUP} = 'IGNORE';
4365   local $SIG{INT} = 'IGNORE';
4366   local $SIG{QUIT} = 'IGNORE';
4367   local $SIG{TERM} = 'IGNORE';
4368   local $SIG{TSTP} = 'IGNORE';
4369   local $SIG{PIPE} = 'IGNORE';
4370
4371   my $oldAutoCommit = $FS::UID::AutoCommit;
4372   local $FS::UID::AutoCommit = 0;
4373   my $dbh = dbh;
4374
4375   my $part_pkg = new FS::part_pkg ( {
4376     'pkg'      => $pkg,
4377     'comment'  => $comment,
4378     'plan'     => 'flat',
4379     'freq'     => 0,
4380     'disabled' => 'Y',
4381     'taxclass' => $taxclass,
4382   } );
4383
4384   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4385                         ( 0 .. @$additional - 1 )
4386                   ),
4387                   'additional_count' => scalar(@$additional),
4388                   'setup_fee' => $amount,
4389                 );
4390
4391   my $error = $part_pkg->insert( options => \%options );
4392   if ( $error ) {
4393     $dbh->rollback if $oldAutoCommit;
4394     return $error;
4395   }
4396
4397   my $pkgpart = $part_pkg->pkgpart;
4398   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
4399   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
4400     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
4401     $error = $type_pkgs->insert;
4402     if ( $error ) {
4403       $dbh->rollback if $oldAutoCommit;
4404       return $error;
4405     }
4406   }
4407
4408   my $cust_pkg = new FS::cust_pkg ( {
4409     'custnum' => $self->custnum,
4410     'pkgpart' => $pkgpart,
4411   } );
4412
4413   $error = $cust_pkg->insert;
4414   if ( $error ) {
4415     $dbh->rollback if $oldAutoCommit;
4416     return $error;
4417   }
4418
4419   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4420   '';
4421
4422 }
4423
4424 =item cust_bill
4425
4426 Returns all the invoices (see L<FS::cust_bill>) for this customer.
4427
4428 =cut
4429
4430 sub cust_bill {
4431   my $self = shift;
4432   sort { $a->_date <=> $b->_date }
4433     qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4434 }
4435
4436 =item open_cust_bill
4437
4438 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
4439 customer.
4440
4441 =cut
4442
4443 sub open_cust_bill {
4444   my $self = shift;
4445   grep { $_->owed > 0 } $self->cust_bill;
4446 }
4447
4448 =item cust_credit
4449
4450 Returns all the credits (see L<FS::cust_credit>) for this customer.
4451
4452 =cut
4453
4454 sub cust_credit {
4455   my $self = shift;
4456   sort { $a->_date <=> $b->_date }
4457     qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
4458 }
4459
4460 =item cust_pay
4461
4462 Returns all the payments (see L<FS::cust_pay>) for this customer.
4463
4464 =cut
4465
4466 sub cust_pay {
4467   my $self = shift;
4468   sort { $a->_date <=> $b->_date }
4469     qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
4470 }
4471
4472 =item cust_pay_void
4473
4474 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4475
4476 =cut
4477
4478 sub cust_pay_void {
4479   my $self = shift;
4480   sort { $a->_date <=> $b->_date }
4481     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4482 }
4483
4484 =item cust_pay_batch
4485
4486 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
4487
4488 =cut
4489
4490 sub cust_pay_batch {
4491   my $self = shift;
4492   sort { $a->_date <=> $b->_date }
4493     qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
4494 }
4495
4496 =item cust_refund
4497
4498 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4499
4500 =cut
4501
4502 sub cust_refund {
4503   my $self = shift;
4504   sort { $a->_date <=> $b->_date }
4505     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4506 }
4507
4508 =item name
4509
4510 Returns a name string for this customer, either "Company (Last, First)" or
4511 "Last, First".
4512
4513 =cut
4514
4515 sub name {
4516   my $self = shift;
4517   my $name = $self->contact;
4518   $name = $self->company. " ($name)" if $self->company;
4519   $name;
4520 }
4521
4522 =item ship_name
4523
4524 Returns a name string for this (service/shipping) contact, either
4525 "Company (Last, First)" or "Last, First".
4526
4527 =cut
4528
4529 sub ship_name {
4530   my $self = shift;
4531   if ( $self->get('ship_last') ) {
4532     my $name = $self->ship_contact;
4533     $name = $self->ship_company. " ($name)" if $self->ship_company;
4534     $name;
4535   } else {
4536     $self->name;
4537   }
4538 }
4539
4540 =item contact
4541
4542 Returns this customer's full (billing) contact name only, "Last, First"
4543
4544 =cut
4545
4546 sub contact {
4547   my $self = shift;
4548   $self->get('last'). ', '. $self->first;
4549 }
4550
4551 =item ship_contact
4552
4553 Returns this customer's full (shipping) contact name only, "Last, First"
4554
4555 =cut
4556
4557 sub ship_contact {
4558   my $self = shift;
4559   $self->get('ship_last')
4560     ? $self->get('ship_last'). ', '. $self->ship_first
4561     : $self->contact;
4562 }
4563
4564 =item country_full
4565
4566 Returns this customer's full country name
4567
4568 =cut
4569
4570 sub country_full {
4571   my $self = shift;
4572   code2country($self->country);
4573 }
4574
4575 =item cust_status
4576
4577 =item status
4578
4579 Returns a status string for this customer, currently:
4580
4581 =over 4
4582
4583 =item prospect - No packages have ever been ordered
4584
4585 =item active - One or more recurring packages is active
4586
4587 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4588
4589 =item suspended - All non-cancelled recurring packages are suspended
4590
4591 =item cancelled - All recurring packages are cancelled
4592
4593 =back
4594
4595 =cut
4596
4597 sub status { shift->cust_status(@_); }
4598
4599 sub cust_status {
4600   my $self = shift;
4601   for my $status (qw( prospect active inactive suspended cancelled )) {
4602     my $method = $status.'_sql';
4603     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4604     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4605     $sth->execute( ($self->custnum) x $numnum )
4606       or die "Error executing 'SELECT $sql': ". $sth->errstr;
4607     return $status if $sth->fetchrow_arrayref->[0];
4608   }
4609 }
4610
4611 =item ucfirst_cust_status
4612
4613 =item ucfirst_status
4614
4615 Returns the status with the first character capitalized.
4616
4617 =cut
4618
4619 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4620
4621 sub ucfirst_cust_status {
4622   my $self = shift;
4623   ucfirst($self->cust_status);
4624 }
4625
4626 =item statuscolor
4627
4628 Returns a hex triplet color string for this customer's status.
4629
4630 =cut
4631
4632 use vars qw(%statuscolor);
4633 tie my %statuscolor, 'Tie::IxHash',
4634   'prospect'  => '7e0079', #'000000', #black?  naw, purple
4635   'active'    => '00CC00', #green
4636   'inactive'  => '0000CC', #blue
4637   'suspended' => 'FF9900', #yellow
4638   'cancelled' => 'FF0000', #red
4639 ;
4640
4641 sub statuscolor { shift->cust_statuscolor(@_); }
4642
4643 sub cust_statuscolor {
4644   my $self = shift;
4645   $statuscolor{$self->cust_status};
4646 }
4647
4648 =item tickets
4649
4650 Returns an array of hashes representing the customer's RT tickets.
4651
4652 =cut
4653
4654 sub tickets {
4655   my $self = shift;
4656
4657   my $num = $conf->config('cust_main-max_tickets') || 10;
4658   my @tickets = ();
4659
4660   unless ( $conf->config('ticket_system-custom_priority_field') ) {
4661
4662     @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4663
4664   } else {
4665
4666     foreach my $priority (
4667       $conf->config('ticket_system-custom_priority_field-values'), ''
4668     ) {
4669       last if scalar(@tickets) >= $num;
4670       push @tickets,
4671         @{ FS::TicketSystem->customer_tickets( $self->custnum,
4672                                                $num - scalar(@tickets),
4673                                                $priority,
4674                                              )
4675          };
4676     }
4677   }
4678   (@tickets);
4679 }
4680
4681 # Return services representing svc_accts in customer support packages
4682 sub support_services {
4683   my $self = shift;
4684   my %packages = map { $_ => 1 } $conf->config('support_packages');
4685
4686   grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4687     grep { $_->part_svc->svcdb eq 'svc_acct' }
4688     map { $_->cust_svc }
4689     grep { exists $packages{ $_->pkgpart } }
4690     $self->ncancelled_pkgs;
4691
4692 }
4693
4694 =back
4695
4696 =head1 CLASS METHODS
4697
4698 =over 4
4699
4700 =item statuses
4701
4702 Class method that returns the list of possible status strings for customers
4703 (see L<the status method|/status>).  For example:
4704
4705   @statuses = FS::cust_main->statuses();
4706
4707 =cut
4708
4709 sub statuses {
4710   #my $self = shift; #could be class...
4711   keys %statuscolor;
4712 }
4713
4714 =item prospect_sql
4715
4716 Returns an SQL expression identifying prospective cust_main records (customers
4717 with no packages ever ordered)
4718
4719 =cut
4720
4721 use vars qw($select_count_pkgs);
4722 $select_count_pkgs =
4723   "SELECT COUNT(*) FROM cust_pkg
4724     WHERE cust_pkg.custnum = cust_main.custnum";
4725
4726 sub select_count_pkgs_sql {
4727   $select_count_pkgs;
4728 }
4729
4730 sub prospect_sql { "
4731   0 = ( $select_count_pkgs )
4732 "; }
4733
4734 =item active_sql
4735
4736 Returns an SQL expression identifying active cust_main records (customers with
4737 no active recurring packages, but otherwise unsuspended/uncancelled).
4738
4739 =cut
4740
4741 sub active_sql { "
4742   0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
4743       )
4744 "; }
4745
4746 =item inactive_sql
4747
4748 Returns an SQL expression identifying inactive cust_main records (customers with
4749 active recurring packages).
4750
4751 =cut
4752
4753 sub inactive_sql { "
4754   0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4755   AND
4756   0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
4757 "; }
4758
4759 =item susp_sql
4760 =item suspended_sql
4761
4762 Returns an SQL expression identifying suspended cust_main records.
4763
4764 =cut
4765
4766
4767 sub suspended_sql { susp_sql(@_); }
4768 sub susp_sql { "
4769     0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
4770     AND
4771     0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4772 "; }
4773
4774 =item cancel_sql
4775 =item cancelled_sql
4776
4777 Returns an SQL expression identifying cancelled cust_main records.
4778
4779 =cut
4780
4781 sub cancelled_sql { cancel_sql(@_); }
4782 sub cancel_sql {
4783
4784   my $recurring_sql = FS::cust_pkg->recurring_sql;
4785   #my $recurring_sql = "
4786   #  '0' != ( select freq from part_pkg
4787   #             where cust_pkg.pkgpart = part_pkg.pkgpart )
4788   #";
4789
4790   "
4791     0 < ( $select_count_pkgs )
4792     AND 0 = ( $select_count_pkgs AND $recurring_sql
4793                   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4794             )
4795   ";
4796 }
4797
4798 =item uncancel_sql
4799 =item uncancelled_sql
4800
4801 Returns an SQL expression identifying un-cancelled cust_main records.
4802
4803 =cut
4804
4805 sub uncancelled_sql { uncancel_sql(@_); }
4806 sub uncancel_sql { "
4807   ( 0 < ( $select_count_pkgs
4808                    AND ( cust_pkg.cancel IS NULL
4809                          OR cust_pkg.cancel = 0
4810                        )
4811         )
4812     OR 0 = ( $select_count_pkgs )
4813   )
4814 "; }
4815
4816 =item balance_sql
4817
4818 Returns an SQL fragment to retreive the balance.
4819
4820 =cut
4821
4822 sub balance_sql { "
4823     COALESCE( ( SELECT SUM(charged) FROM cust_bill
4824                   WHERE cust_bill.custnum   = cust_main.custnum ), 0)
4825   - COALESCE( ( SELECT SUM(paid)    FROM cust_pay
4826                   WHERE cust_pay.custnum    = cust_main.custnum ), 0)
4827   - COALESCE( ( SELECT SUM(amount)  FROM cust_credit
4828                   WHERE cust_credit.custnum = cust_main.custnum ), 0)
4829   + COALESCE( ( SELECT SUM(refund)  FROM cust_refund
4830                    WHERE cust_refund.custnum = cust_main.custnum ), 0)
4831 "; }
4832
4833 =item balance_date_sql TIME
4834
4835 Returns an SQL fragment to retreive the balance for this customer, only
4836 considering invoices with date earlier than TIME. (total_owed_date minus total_credited minus
4837 total_unapplied_payments).  TIME is specified as an SQL fragment or a numeric
4838 UNIX timestamp; see L<perlfunc/"time">).  Also see L<Time::Local> and
4839 L<Date::Parse> for conversion functions.
4840
4841 =cut
4842
4843 sub balance_date_sql {
4844   my( $class, $time ) = @_;
4845
4846   my $owed_sql         = FS::cust_bill->owed_sql;
4847   my $unapp_refund_sql = FS::cust_refund->unapplied_sql;
4848   #my $unapp_credit_sql = FS::cust_credit->unapplied_sql;
4849   my $unapp_credit_sql = FS::cust_credit->credited_sql;
4850   my $unapp_pay_sql    = FS::cust_pay->unapplied_sql;
4851
4852   "
4853       COALESCE( ( SELECT SUM($owed_sql) FROM cust_bill
4854                     WHERE cust_bill.custnum   = cust_main.custnum
4855                       AND cust_bill._date    <= $time             )
4856                 ,0
4857               )
4858     + COALESCE( ( SELECT SUM($unapp_refund_sql) FROM cust_refund
4859                     WHERE cust_refund.custnum = cust_main.custnum )
4860                 ,0
4861               )
4862     - COALESCE( ( SELECT SUM($unapp_credit_sql) FROM cust_credit
4863                     WHERE cust_credit.custnum = cust_main.custnum )
4864                 ,0
4865               )
4866     - COALESCE( ( SELECT SUM($unapp_pay_sql) FROM cust_pay
4867                     WHERE cust_pay.custnum = cust_main.custnum )
4868                 ,0
4869               )
4870
4871   ";
4872
4873 }
4874
4875 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
4876
4877 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
4878 records.  Currently, I<first>, I<last> and/or I<company> may be specified (the
4879 appropriate ship_ field is also searched).
4880
4881 Additional options are the same as FS::Record::qsearch
4882
4883 =cut
4884
4885 sub fuzzy_search {
4886   my( $self, $fuzzy, $hash, @opt) = @_;
4887   #$self
4888   $hash ||= {};
4889   my @cust_main = ();
4890
4891   check_and_rebuild_fuzzyfiles();
4892   foreach my $field ( keys %$fuzzy ) {
4893
4894     my $all = $self->all_X($field);
4895     next unless scalar(@$all);
4896
4897     my %match = ();
4898     $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
4899
4900     my @fcust = ();
4901     foreach ( keys %match ) {
4902       push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
4903       push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
4904     }
4905     my %fsaw = ();
4906     push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
4907   }
4908
4909   # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
4910   my %saw = ();
4911   @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
4912
4913   @cust_main;
4914
4915 }
4916
4917 =item masked FIELD
4918
4919 Returns a masked version of the named field
4920
4921 =cut
4922
4923 sub masked {
4924 my ($self,$field) = @_;
4925
4926 # Show last four
4927
4928 'x'x(length($self->getfield($field))-4).
4929   substr($self->getfield($field), (length($self->getfield($field))-4));
4930
4931 }
4932
4933 =back
4934
4935 =head1 SUBROUTINES
4936
4937 =over 4
4938
4939 =item smart_search OPTION => VALUE ...
4940
4941 Accepts the following options: I<search>, the string to search for.  The string
4942 will be searched for as a customer number, phone number, name or company name,
4943 as an exact, or, in some cases, a substring or fuzzy match (see the source code
4944 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
4945 skip fuzzy matching when an exact match is found.
4946
4947 Any additional options are treated as an additional qualifier on the search
4948 (i.e. I<agentnum>).
4949
4950 Returns a (possibly empty) array of FS::cust_main objects.
4951
4952 =cut
4953
4954 sub smart_search {
4955   my %options = @_;
4956
4957   #here is the agent virtualization
4958   my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
4959
4960   my @cust_main = ();
4961
4962   my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
4963   my $search = delete $options{'search'};
4964   ( my $alphanum_search = $search ) =~ s/\W//g;
4965
4966   if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
4967
4968     #false laziness w/Record::ut_phone
4969     my $phonen = "$1-$2-$3";
4970     $phonen .= " x$4" if $4;
4971
4972     push @cust_main, qsearch( {
4973       'table'   => 'cust_main',
4974       'hashref' => { %options },
4975       'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4976                      ' ( '.
4977                          join(' OR ', map "$_ = '$phonen'",
4978                                           qw( daytime night fax
4979                                               ship_daytime ship_night ship_fax )
4980                              ).
4981                      ' ) '.
4982                      " AND $agentnums_sql", #agent virtualization
4983     } );
4984
4985     unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
4986       #try looking for matches with extensions unless one was specified
4987
4988       push @cust_main, qsearch( {
4989         'table'   => 'cust_main',
4990         'hashref' => { %options },
4991         'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4992                        ' ( '.
4993                            join(' OR ', map "$_ LIKE '$phonen\%'",
4994                                             qw( daytime night
4995                                                 ship_daytime ship_night )
4996                                ).
4997                        ' ) '.
4998                        " AND $agentnums_sql", #agent virtualization
4999       } );
5000
5001     }
5002
5003   } elsif ( $search =~ /^\s*(\d+)\s*$/ ) { # customer # search
5004
5005     push @cust_main, qsearch( {
5006       'table'     => 'cust_main',
5007       'hashref'   => { 'custnum' => $1, %options },
5008       'extra_sql' => " AND $agentnums_sql", #agent virtualization
5009     } );
5010
5011   } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
5012
5013     my($company, $last, $first) = ( $1, $2, $3 );
5014
5015     # "Company (Last, First)"
5016     #this is probably something a browser remembered,
5017     #so just do an exact search
5018
5019     foreach my $prefix ( '', 'ship_' ) {
5020       push @cust_main, qsearch( {
5021         'table'     => 'cust_main',
5022         'hashref'   => { $prefix.'first'   => $first,
5023                          $prefix.'last'    => $last,
5024                          $prefix.'company' => $company,
5025                          %options,
5026                        },
5027         'extra_sql' => " AND $agentnums_sql",
5028       } );
5029     }
5030
5031   } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
5032                                               # try (ship_){last,company}
5033
5034     my $value = lc($1);
5035
5036     # # remove "(Last, First)" in "Company (Last, First)", otherwise the
5037     # # full strings the browser remembers won't work
5038     # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
5039
5040     use Lingua::EN::NameParse;
5041     my $NameParse = new Lingua::EN::NameParse(
5042              auto_clean     => 1,
5043              allow_reversed => 1,
5044     );
5045
5046     my($last, $first) = ( '', '' );
5047     #maybe disable this too and just rely on NameParse?
5048     if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
5049
5050       ($last, $first) = ( $1, $2 );
5051
5052     #} elsif  ( $value =~ /^(.+)\s+(.+)$/ ) {
5053     } elsif ( ! $NameParse->parse($value) ) {
5054
5055       my %name = $NameParse->components;
5056       $first = $name{'given_name_1'};
5057       $last  = $name{'surname_1'};
5058
5059     }
5060
5061     if ( $first && $last ) {
5062
5063       my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
5064
5065       #exact
5066       my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5067       $sql .= "
5068         (     ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
5069            OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
5070         )";
5071
5072       push @cust_main, qsearch( {
5073         'table'     => 'cust_main',
5074         'hashref'   => \%options,
5075         'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5076       } );
5077
5078       # or it just be something that was typed in... (try that in a sec)
5079
5080     }
5081
5082     my $q_value = dbh->quote($value);
5083
5084     #exact
5085     my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5086     $sql .= " (    LOWER(last)         = $q_value
5087                 OR LOWER(company)      = $q_value
5088                 OR LOWER(ship_last)    = $q_value
5089                 OR LOWER(ship_company) = $q_value
5090               )";
5091
5092     push @cust_main, qsearch( {
5093       'table'     => 'cust_main',
5094       'hashref'   => \%options,
5095       'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5096     } );
5097
5098     #no exact match, trying substring/fuzzy
5099     #always do substring & fuzzy (unless they're explicity config'ed off)
5100     #getting complaints searches are not returning enough
5101     unless ( @cust_main  && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
5102
5103       #still some false laziness w/ search/cust_main.cgi
5104
5105       #substring
5106
5107       my @hashrefs = (
5108         { 'company'      => { op=>'ILIKE', value=>"%$value%" }, },
5109         { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
5110       );
5111
5112       if ( $first && $last ) {
5113
5114         push @hashrefs,
5115           { 'first'        => { op=>'ILIKE', value=>"%$first%" },
5116             'last'         => { op=>'ILIKE', value=>"%$last%" },
5117           },
5118           { 'ship_first'   => { op=>'ILIKE', value=>"%$first%" },
5119             'ship_last'    => { op=>'ILIKE', value=>"%$last%" },
5120           },
5121         ;
5122
5123       } else {
5124
5125         push @hashrefs,
5126           { 'last'         => { op=>'ILIKE', value=>"%$value%" }, },
5127           { 'ship_last'    => { op=>'ILIKE', value=>"%$value%" }, },
5128         ;
5129       }
5130
5131       foreach my $hashref ( @hashrefs ) {
5132
5133         push @cust_main, qsearch( {
5134           'table'     => 'cust_main',
5135           'hashref'   => { %$hashref,
5136                            %options,
5137                          },
5138           'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
5139         } );
5140
5141       }
5142
5143       #fuzzy
5144       my @fuzopts = (
5145         \%options,                #hashref
5146         '',                       #select
5147         " AND $agentnums_sql",    #extra_sql  #agent virtualization
5148       );
5149
5150       if ( $first && $last ) {
5151         push @cust_main, FS::cust_main->fuzzy_search(
5152           { 'last'   => $last,    #fuzzy hashref
5153             'first'  => $first }, #
5154           @fuzopts
5155         );
5156       }
5157       foreach my $field ( 'last', 'company' ) {
5158         push @cust_main,
5159           FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
5160       }
5161
5162     }
5163
5164     #eliminate duplicates
5165     my %saw = ();
5166     @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5167
5168   }
5169
5170   @cust_main;
5171
5172 }
5173
5174 =item check_and_rebuild_fuzzyfiles
5175
5176 =cut
5177
5178 use vars qw(@fuzzyfields);
5179 @fuzzyfields = ( 'last', 'first', 'company' );
5180
5181 sub check_and_rebuild_fuzzyfiles {
5182   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5183   rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
5184 }
5185
5186 =item rebuild_fuzzyfiles
5187
5188 =cut
5189
5190 sub rebuild_fuzzyfiles {
5191
5192   use Fcntl qw(:flock);
5193
5194   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5195   mkdir $dir, 0700 unless -d $dir;
5196
5197   foreach my $fuzzy ( @fuzzyfields ) {
5198
5199     open(LOCK,">>$dir/cust_main.$fuzzy")
5200       or die "can't open $dir/cust_main.$fuzzy: $!";
5201     flock(LOCK,LOCK_EX)
5202       or die "can't lock $dir/cust_main.$fuzzy: $!";
5203
5204     open (CACHE,">$dir/cust_main.$fuzzy.tmp")
5205       or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
5206
5207     foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
5208       my $sth = dbh->prepare("SELECT $field FROM cust_main".
5209                              " WHERE $field != '' AND $field IS NOT NULL");
5210       $sth->execute or die $sth->errstr;
5211
5212       while ( my $row = $sth->fetchrow_arrayref ) {
5213         print CACHE $row->[0]. "\n";
5214       }
5215
5216     }
5217
5218     close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
5219
5220     rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
5221     close LOCK;
5222   }
5223
5224 }
5225
5226 =item all_X
5227
5228 =cut
5229
5230 sub all_X {
5231   my( $self, $field ) = @_;
5232   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5233   open(CACHE,"<$dir/cust_main.$field")
5234     or die "can't open $dir/cust_main.$field: $!";
5235   my @array = map { chomp; $_; } <CACHE>;
5236   close CACHE;
5237   \@array;
5238 }
5239
5240 =item append_fuzzyfiles LASTNAME COMPANY
5241
5242 =cut
5243
5244 sub append_fuzzyfiles {
5245   #my( $first, $last, $company ) = @_;
5246
5247   &check_and_rebuild_fuzzyfiles;
5248
5249   use Fcntl qw(:flock);
5250
5251   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5252
5253   foreach my $field (qw( first last company )) {
5254     my $value = shift;
5255
5256     if ( $value ) {
5257
5258       open(CACHE,">>$dir/cust_main.$field")
5259         or die "can't open $dir/cust_main.$field: $!";
5260       flock(CACHE,LOCK_EX)
5261         or die "can't lock $dir/cust_main.$field: $!";
5262
5263       print CACHE "$value\n";
5264
5265       flock(CACHE,LOCK_UN)
5266         or die "can't unlock $dir/cust_main.$field: $!";
5267       close CACHE;
5268     }
5269
5270   }
5271
5272   1;
5273 }
5274
5275 =item batch_import
5276
5277 =cut
5278
5279 sub batch_import {
5280   my $param = shift;
5281   #warn join('-',keys %$param);
5282   my $fh = $param->{filehandle};
5283   my $agentnum = $param->{agentnum};
5284
5285   my $refnum = $param->{refnum};
5286   my $pkgpart = $param->{pkgpart};
5287
5288   #my @fields = @{$param->{fields}};
5289   my $format = $param->{'format'};
5290   my @fields;
5291   my $payby;
5292   if ( $format eq 'simple' ) {
5293     @fields = qw( cust_pkg.setup dayphone first last
5294                   address1 address2 city state zip comments );
5295     $payby = 'BILL';
5296   } elsif ( $format eq 'extended' ) {
5297     @fields = qw( agent_custid refnum
5298                   last first address1 address2 city state zip country
5299                   daytime night
5300                   ship_last ship_first ship_address1 ship_address2
5301                   ship_city ship_state ship_zip ship_country
5302                   payinfo paycvv paydate
5303                   invoicing_list
5304                   cust_pkg.pkgpart
5305                   svc_acct.username svc_acct._password
5306                 );
5307     $payby = 'BILL';
5308   } else {
5309     die "unknown format $format";
5310   }
5311
5312   eval "use Text::CSV_XS;";
5313   die $@ if $@;
5314
5315   my $csv = new Text::CSV_XS;
5316   #warn $csv;
5317   #warn $fh;
5318
5319   my $imported = 0;
5320   #my $columns;
5321
5322   local $SIG{HUP} = 'IGNORE';
5323   local $SIG{INT} = 'IGNORE';
5324   local $SIG{QUIT} = 'IGNORE';
5325   local $SIG{TERM} = 'IGNORE';
5326   local $SIG{TSTP} = 'IGNORE';
5327   local $SIG{PIPE} = 'IGNORE';
5328
5329   my $oldAutoCommit = $FS::UID::AutoCommit;
5330   local $FS::UID::AutoCommit = 0;
5331   my $dbh = dbh;
5332
5333   #while ( $columns = $csv->getline($fh) ) {
5334   my $line;
5335   while ( defined($line=<$fh>) ) {
5336
5337     $csv->parse($line) or do {
5338       $dbh->rollback if $oldAutoCommit;
5339       return "can't parse: ". $csv->error_input();
5340     };
5341
5342     my @columns = $csv->fields();
5343     #warn join('-',@columns);
5344
5345     my %cust_main = (
5346       agentnum => $agentnum,
5347       refnum   => $refnum,
5348       country  => $conf->config('countrydefault') || 'US',
5349       payby    => $payby, #default
5350       paydate  => '12/2037', #default
5351     );
5352     my $billtime = time;
5353     my %cust_pkg = ( pkgpart => $pkgpart );
5354     my %svc_acct = ();
5355     foreach my $field ( @fields ) {
5356
5357       if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
5358
5359         #$cust_pkg{$1} = str2time( shift @$columns );
5360         if ( $1 eq 'pkgpart' ) {
5361           $cust_pkg{$1} = shift @columns;
5362         } elsif ( $1 eq 'setup' ) {
5363           $billtime = str2time(shift @columns);
5364         } else {
5365           $cust_pkg{$1} = str2time( shift @columns );
5366         }
5367
5368       } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
5369
5370         $svc_acct{$1} = shift @columns;
5371
5372       } else {
5373
5374         #refnum interception
5375         if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
5376
5377           my $referral = $columns[0];
5378           my %hash = ( 'referral' => $referral,
5379                        'agentnum' => $agentnum,
5380                        'disabled' => '',
5381                      );
5382
5383           my $part_referral = qsearchs('part_referral', \%hash )
5384                               || new FS::part_referral \%hash;
5385
5386           unless ( $part_referral->refnum ) {
5387             my $error = $part_referral->insert;
5388             if ( $error ) {
5389               $dbh->rollback if $oldAutoCommit;
5390               return "can't auto-insert advertising source: $referral: $error";
5391             }
5392           }
5393
5394           $columns[0] = $part_referral->refnum;
5395         }
5396
5397         #$cust_main{$field} = shift @$columns;
5398         $cust_main{$field} = shift @columns;
5399       }
5400     }
5401
5402     $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
5403
5404     my $invoicing_list = $cust_main{'invoicing_list'}
5405                            ? [ delete $cust_main{'invoicing_list'} ]
5406                            : [];
5407
5408     my $cust_main = new FS::cust_main ( \%cust_main );
5409
5410     use Tie::RefHash;
5411     tie my %hash, 'Tie::RefHash'; #this part is important
5412
5413     if ( $cust_pkg{'pkgpart'} ) {
5414       my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
5415
5416       my @svc_acct = ();
5417       if ( $svc_acct{'username'} ) {
5418         my $part_pkg = $cust_pkg->part_pkg;
5419         unless ( $part_pkg ) {
5420           $dbh->rollback if $oldAutoCommit;
5421           return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
5422         }
5423         $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
5424         push @svc_acct, new FS::svc_acct ( \%svc_acct )
5425       }
5426
5427       $hash{$cust_pkg} = \@svc_acct;
5428     }
5429
5430     my $error = $cust_main->insert( \%hash, $invoicing_list );
5431
5432     if ( $error ) {
5433       $dbh->rollback if $oldAutoCommit;
5434       return "can't insert customer for $line: $error";
5435     }
5436
5437     if ( $format eq 'simple' ) {
5438
5439       #false laziness w/bill.cgi
5440       $error = $cust_main->bill( 'time' => $billtime );
5441       if ( $error ) {
5442         $dbh->rollback if $oldAutoCommit;
5443         return "can't bill customer for $line: $error";
5444       }
5445
5446       $error = $cust_main->apply_payments_and_credits;
5447       if ( $error ) {
5448         $dbh->rollback if $oldAutoCommit;
5449         return "can't bill customer for $line: $error";
5450       }
5451
5452       $error = $cust_main->collect();
5453       if ( $error ) {
5454         $dbh->rollback if $oldAutoCommit;
5455         return "can't collect customer for $line: $error";
5456       }
5457
5458     }
5459
5460     $imported++;
5461   }
5462
5463   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5464
5465   return "Empty file!" unless $imported;
5466
5467   ''; #no error
5468
5469 }
5470
5471 =item batch_charge
5472
5473 =cut
5474
5475 sub batch_charge {
5476   my $param = shift;
5477   #warn join('-',keys %$param);
5478   my $fh = $param->{filehandle};
5479   my @fields = @{$param->{fields}};
5480
5481   eval "use Text::CSV_XS;";
5482   die $@ if $@;
5483
5484   my $csv = new Text::CSV_XS;
5485   #warn $csv;
5486   #warn $fh;
5487
5488   my $imported = 0;
5489   #my $columns;
5490
5491   local $SIG{HUP} = 'IGNORE';
5492   local $SIG{INT} = 'IGNORE';
5493   local $SIG{QUIT} = 'IGNORE';
5494   local $SIG{TERM} = 'IGNORE';
5495   local $SIG{TSTP} = 'IGNORE';
5496   local $SIG{PIPE} = 'IGNORE';
5497
5498   my $oldAutoCommit = $FS::UID::AutoCommit;
5499   local $FS::UID::AutoCommit = 0;
5500   my $dbh = dbh;
5501
5502   #while ( $columns = $csv->getline($fh) ) {
5503   my $line;
5504   while ( defined($line=<$fh>) ) {
5505
5506     $csv->parse($line) or do {
5507       $dbh->rollback if $oldAutoCommit;
5508       return "can't parse: ". $csv->error_input();
5509     };
5510
5511     my @columns = $csv->fields();
5512     #warn join('-',@columns);
5513
5514     my %row = ();
5515     foreach my $field ( @fields ) {
5516       $row{$field} = shift @columns;
5517     }
5518
5519     my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
5520     unless ( $cust_main ) {
5521       $dbh->rollback if $oldAutoCommit;
5522       return "unknown custnum $row{'custnum'}";
5523     }
5524
5525     if ( $row{'amount'} > 0 ) {
5526       my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
5527       if ( $error ) {
5528         $dbh->rollback if $oldAutoCommit;
5529         return $error;
5530       }
5531       $imported++;
5532     } elsif ( $row{'amount'} < 0 ) {
5533       my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
5534                                       $row{'pkg'}                         );
5535       if ( $error ) {
5536         $dbh->rollback if $oldAutoCommit;
5537         return $error;
5538       }
5539       $imported++;
5540     } else {
5541       #hmm?
5542     }
5543
5544   }
5545
5546   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5547
5548   return "Empty file!" unless $imported;
5549
5550   ''; #no error
5551
5552 }
5553
5554 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5555
5556 Sends a templated email notification to the customer (see L<Text::Template>).
5557
5558 OPTIONS is a hash and may include
5559
5560 I<from> - the email sender (default is invoice_from)
5561
5562 I<to> - comma-separated scalar or arrayref of recipients
5563    (default is invoicing_list)
5564
5565 I<subject> - The subject line of the sent email notification
5566    (default is "Notice from company_name")
5567
5568 I<extra_fields> - a hashref of name/value pairs which will be substituted
5569    into the template
5570
5571 The following variables are vavailable in the template.
5572
5573 I<$first> - the customer first name
5574 I<$last> - the customer last name
5575 I<$company> - the customer company
5576 I<$payby> - a description of the method of payment for the customer
5577             # would be nice to use FS::payby::shortname
5578 I<$payinfo> - the account information used to collect for this customer
5579 I<$expdate> - the expiration of the customer payment in seconds from epoch
5580
5581 =cut
5582
5583 sub notify {
5584   my ($customer, $template, %options) = @_;
5585
5586   return unless $conf->exists($template);
5587
5588   my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
5589   $from = $options{from} if exists($options{from});
5590
5591   my $to = join(',', $customer->invoicing_list_emailonly);
5592   $to = $options{to} if exists($options{to});
5593
5594   my $subject = "Notice from " . $conf->config('company_name')
5595     if $conf->exists('company_name');
5596   $subject = $options{subject} if exists($options{subject});
5597
5598   my $notify_template = new Text::Template (TYPE => 'ARRAY',
5599                                             SOURCE => [ map "$_\n",
5600                                               $conf->config($template)]
5601                                            )
5602     or die "can't create new Text::Template object: Text::Template::ERROR";
5603   $notify_template->compile()
5604     or die "can't compile template: Text::Template::ERROR";
5605
5606   my $paydate = $customer->paydate;
5607   $FS::notify_template::_template::first = $customer->first;
5608   $FS::notify_template::_template::last = $customer->last;
5609   $FS::notify_template::_template::company = $customer->company;
5610   $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
5611   my $payby = $customer->payby;
5612   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5613   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5614
5615   #credit cards expire at the end of the month/year of their exp date
5616   if ($payby eq 'CARD' || $payby eq 'DCRD') {
5617     $FS::notify_template::_template::payby = 'credit card';
5618     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5619     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5620     $expire_time--;
5621   }elsif ($payby eq 'COMP') {
5622     $FS::notify_template::_template::payby = 'complimentary account';
5623   }else{
5624     $FS::notify_template::_template::payby = 'current method';
5625   }
5626   $FS::notify_template::_template::expdate = $expire_time;
5627
5628   for (keys %{$options{extra_fields}}){
5629     no strict "refs";
5630     ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
5631   }
5632
5633   send_email(from => $from,
5634              to => $to,
5635              subject => $subject,
5636              body => $notify_template->fill_in( PACKAGE =>
5637                                                 'FS::notify_template::_template'                                              ),
5638             );
5639
5640 }
5641
5642 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5643
5644 Generates a templated notification to the customer (see L<Text::Template>).
5645
5646 OPTIONS is a hash and may include
5647
5648 I<extra_fields> - a hashref of name/value pairs which will be substituted
5649    into the template.  These values may override values mentioned below
5650    and those from the customer record.
5651
5652 The following variables are available in the template instead of or in addition
5653 to the fields of the customer record.
5654
5655 I<$payby> - a description of the method of payment for the customer
5656             # would be nice to use FS::payby::shortname
5657 I<$payinfo> - the masked account information used to collect for this customer
5658 I<$expdate> - the expiration of the customer payment method in seconds from epoch
5659 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress
5660
5661 =cut
5662
5663 sub generate_letter {
5664   my ($self, $template, %options) = @_;
5665
5666   return unless $conf->exists($template);
5667
5668   my $letter_template = new Text::Template
5669                         ( TYPE       => 'ARRAY',
5670                           SOURCE     => [ map "$_\n", $conf->config($template)],
5671                           DELIMITERS => [ '[@--', '--@]' ],
5672                         )
5673     or die "can't create new Text::Template object: Text::Template::ERROR";
5674
5675   $letter_template->compile()
5676     or die "can't compile template: Text::Template::ERROR";
5677
5678   my %letter_data = map { $_ => $self->$_ } $self->fields;
5679   $letter_data{payinfo} = $self->mask_payinfo;
5680
5681   #my $paydate = $self->paydate || '2037-12';
5682   my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12';
5683
5684   my $payby = $self->payby;
5685   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
5686   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
5687
5688   #credit cards expire at the end of the month/year of their exp date
5689   if ($payby eq 'CARD' || $payby eq 'DCRD') {
5690     $letter_data{payby} = 'credit card';
5691     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
5692     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
5693     $expire_time--;
5694   }elsif ($payby eq 'COMP') {
5695     $letter_data{payby} = 'complimentary account';
5696   }else{
5697     $letter_data{payby} = 'current method';
5698   }
5699   $letter_data{expdate} = $expire_time;
5700
5701   for (keys %{$options{extra_fields}}){
5702     $letter_data{$_} = $options{extra_fields}->{$_};
5703   }
5704
5705   unless(exists($letter_data{returnaddress})){
5706     my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
5707                                                   $self->agent_template)
5708                      );
5709
5710     $letter_data{returnaddress} = length($retadd) ? $retadd : '~';
5711   }
5712
5713   $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
5714
5715   my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
5716   my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
5717                            DIR      => $dir,
5718                            SUFFIX   => '.tex',
5719                            UNLINK   => 0,
5720                          ) or die "can't open temp file: $!\n";
5721
5722   $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
5723   close $fh;
5724   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
5725   return $1;
5726 }
5727
5728 =item print_ps TEMPLATE
5729
5730 Returns an postscript letter filled in from TEMPLATE, as a scalar.
5731
5732 =cut
5733
5734 sub print_ps {
5735   my $self = shift;
5736   my $file = $self->generate_letter(@_);
5737   FS::Misc::generate_ps($file);
5738 }
5739
5740 =item print TEMPLATE
5741
5742 Prints the filled in template.
5743
5744 TEMPLATE is the name of a L<Text::Template> to fill in and print.
5745
5746 =cut
5747
5748 sub queueable_print {
5749   my %opt = @_;
5750
5751   my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
5752     or die "invalid customer number: " . $opt{custvnum};
5753
5754   my $error = $self->print( $opt{template} );
5755   die $error if $error;
5756 }
5757
5758 sub print {
5759   my ($self, $template) = (shift, shift);
5760   do_print [ $self->print_ps($template) ];
5761 }
5762
5763 sub agent_template {
5764   my $self = shift;
5765   $self->_agent_plandata('agent_templatename');
5766 }
5767
5768 sub agent_invoice_from {
5769   my $self = shift;
5770   $self->_agent_plandata('agent_invoice_from');
5771 }
5772
5773 sub _agent_plandata {
5774   my( $self, $option ) = @_;
5775
5776   #yuck.  this whole thing needs to be reconciled better with 1.9's idea of
5777   #agent-specific Conf
5778
5779   my $agentnum = $self->agentnum;
5780
5781   my $part_event_option =
5782     qsearchs({
5783       'table'     => 'part_event_option',
5784       'addl_from' => q{
5785         LEFT JOIN part_event USING ( eventpart )
5786         LEFT JOIN part_event_option AS peo_agentnum
5787           ON ( part_event.eventpart = peo_agentnum.eventpart
5788                AND peo_agentnum.optionname = 'agentnum'
5789                AND peo_agentnum.optionvalue ~ '(^|,)agentnum(,|$)'
5790              )
5791         LEFT JOIN part_event_option AS peo_cust_bill_age
5792           ON ( part_event.eventpart = peo_cust_bill_age.eventpart
5793                AND peo_cust_bill_age.optionname = 'cust_bill_age'
5794              )
5795       },
5796       #'hashref'   => { 'optionname' => $option },
5797       'hashref'   => { 'part_event_option.optionname' => $option },
5798       'extra_sql' => " AND event = 'cust_bill_send_agent' ".
5799                      " AND peo_agentnum.optionname = 'agentnum' ".
5800                      " AND agentnum IS NULL OR agentnum = $agentnum ".
5801                      " ORDER BY
5802                         CASE WHEN peo_cust_bill_age.optionname != 'cust_bill_age'
5803                         THEN -1
5804                         ELSE EXTRACT( EPOCH FROM
5805                                         REPLACE( peo_cust_bill_age.optionvalue,
5806                                                  'm',
5807                                                  'mon'
5808                                                )::interval
5809                                     )
5810                        END
5811                        , part_event.weight".
5812                      " LIMIT 1"
5813     });
5814
5815   unless ( $part_event_option ) {
5816     return $self->agent->invoice_template || ''
5817       if $option eq '$agent_templatename';
5818     return '';
5819   }
5820
5821   $part_event_option->optionvalue;
5822
5823 }
5824
5825 =back
5826
5827 =head1 BUGS
5828
5829 The delete method.
5830
5831 The delete method should possibly take an FS::cust_main object reference
5832 instead of a scalar customer number.
5833
5834 Bill and collect options should probably be passed as references instead of a
5835 list.
5836
5837 There should probably be a configuration file with a list of allowed credit
5838 card types.
5839
5840 No multiple currency support (probably a larger project than just this module).
5841
5842 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5843
5844 Birthdates rely on negative epoch values.
5845
5846 The payby for card/check batches is broken.  With mixed batching, bad
5847 things will happen.
5848
5849 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5850
5851 =head1 SEE ALSO
5852
5853 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5854 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5855 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
5856
5857 =cut
5858
5859 1;
5860