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