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 Scalar::Util qw( blessed );
  12 use Time::Local qw(timelocal_nocheck);
  13 use Data::Dumper;
  14 use Tie::IxHash;
  15 use Digest::MD5 qw(md5_base64);
  16 use Date::Format;
  17 use Date::Parse;
  18 #use Date::Manip;
  19 use String::Approx qw(amatch);
  20 use Business::CreditCard 0.28;
  21 use Locale::Country;
  22 use Data::Dumper;
  23 use FS::UID qw( getotaker dbh driver_name );
  24 use FS::Record qw( qsearchs qsearch dbdef );
  25 use FS::Misc qw( send_email generate_ps do_print );
  26 use FS::Msgcat qw(gettext);
  27 use FS::cust_pkg;
  28 use FS::cust_svc;
  29 use FS::cust_bill;
  30 use FS::cust_bill_pkg;
  31 use FS::cust_pay;
  32 use FS::cust_pay_pending;
  33 use FS::cust_pay_void;
  34 use FS::cust_pay_batch;
  35 use FS::cust_credit;
  36 use FS::cust_refund;
  37 use FS::part_referral;
  38 use FS::cust_main_county;
  39 use FS::agent;
  40 use FS::cust_main_invoice;
  41 use FS::cust_credit_bill;
  42 use FS::cust_bill_pay;
  43 use FS::prepay_credit;
  44 use FS::queue;
  45 use FS::part_pkg;
  46 use FS::part_event;
  47 use FS::part_event_condition;
  48 #use FS::cust_event;
  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
1073   my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1074               ? shift
1075               : $self->replace_old;
1076
1077   my @param = @_;
1078
1079   warn "$me replace called\n"
1080     if $DEBUG;
1081
1082   my $curuser = $FS::CurrentUser::CurrentUser;
1083   if (    $self->payby eq 'COMP'
1084        && $self->payby ne $old->payby
1085        && ! $curuser->access_right('Complimentary customer')
1086      )
1087   {
1088     return "You are not permitted to create complimentary accounts.";
1089   }
1090
1091   local($ignore_expired_card) = 1
1092     if $old->payby  =~ /^(CARD|DCRD)$/
1093     && $self->payby =~ /^(CARD|DCRD)$/
1094     && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1095
1096   local $SIG{HUP} = 'IGNORE';
1097   local $SIG{INT} = 'IGNORE';
1098   local $SIG{QUIT} = 'IGNORE';
1099   local $SIG{TERM} = 'IGNORE';
1100   local $SIG{TSTP} = 'IGNORE';
1101   local $SIG{PIPE} = 'IGNORE';
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   if ( $self->has_ship_address
1294        && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1295                         $self->addr_fields )
1296      )
1297   {
1298     my $error =
1299       $self->ut_name('ship_last')
1300       || $self->ut_name('ship_first')
1301       || $self->ut_textn('ship_company')
1302       || $self->ut_text('ship_address1')
1303       || $self->ut_textn('ship_address2')
1304       || $self->ut_text('ship_city')
1305       || $self->ut_textn('ship_county')
1306       || $self->ut_textn('ship_state')
1307       || $self->ut_country('ship_country')
1308     ;
1309     return $error if $error;
1310
1311     #false laziness with above
1312     unless ( qsearchs('cust_main_county', {
1313       'country' => $self->ship_country,
1314       'state'   => '',
1315      } ) ) {
1316       return "Unknown ship_state/ship_county/ship_country: ".
1317         $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1318         unless qsearch('cust_main_county',{
1319           'state'   => $self->ship_state,
1320           'county'  => $self->ship_county,
1321           'country' => $self->ship_country,
1322         } );
1323     }
1324     #eofalse
1325
1326     $error =
1327       $self->ut_phonen('ship_daytime', $self->ship_country)
1328       || $self->ut_phonen('ship_night', $self->ship_country)
1329       || $self->ut_phonen('ship_fax', $self->ship_country)
1330       || $self->ut_zip('ship_zip', $self->ship_country)
1331     ;
1332     return $error if $error;
1333
1334     return "Unit # is required."
1335       if $self->ship_address2 =~ /^\s*$/
1336       && $conf->exists('cust_main-require_address2');
1337
1338   } else { # ship_ info eq billing info, so don't store dup info in database
1339
1340     $self->setfield("ship_$_", '')
1341       foreach $self->addr_fields;
1342
1343     return "Unit # is required."
1344       if $self->address2 =~ /^\s*$/
1345       && $conf->exists('cust_main-require_address2');
1346
1347   }
1348
1349   #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1350   #  or return "Illegal payby: ". $self->payby;
1351   #$self->payby($1);
1352   FS::payby->can_payby($self->table, $self->payby)
1353     or return "Illegal payby: ". $self->payby;
1354
1355   $error =    $self->ut_numbern('paystart_month')
1356            || $self->ut_numbern('paystart_year')
1357            || $self->ut_numbern('payissue')
1358            || $self->ut_textn('paytype')
1359   ;
1360   return $error if $error;
1361
1362   if ( $self->payip eq '' ) {
1363     $self->payip('');
1364   } else {
1365     $error = $self->ut_ip('payip');
1366     return $error if $error;
1367   }
1368
1369   # If it is encrypted and the private key is not availaible then we can't
1370   # check the credit card.
1371
1372   my $check_payinfo = 1;
1373
1374   if ($self->is_encrypted($self->payinfo)) {
1375     $check_payinfo = 0;
1376   }
1377
1378   if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1379
1380     my $payinfo = $self->payinfo;
1381     $payinfo =~ s/\D//g;
1382     $payinfo =~ /^(\d{13,16})$/
1383       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1384     $payinfo = $1;
1385     $self->payinfo($payinfo);
1386     validate($payinfo)
1387       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1388
1389     return gettext('unknown_card_type')
1390       if cardtype($self->payinfo) eq "Unknown";
1391
1392     my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1393     if ( $ban ) {
1394       return 'Banned credit card: banned on '.
1395              time2str('%a %h %o at %r', $ban->_date).
1396              ' by '. $ban->otaker.
1397              ' (ban# '. $ban->bannum. ')';
1398     }
1399
1400     if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1401       if ( cardtype($self->payinfo) eq 'American Express card' ) {
1402         $self->paycvv =~ /^(\d{4})$/
1403           or return "CVV2 (CID) for American Express cards is four digits.";
1404         $self->paycvv($1);
1405       } else {
1406         $self->paycvv =~ /^(\d{3})$/
1407           or return "CVV2 (CVC2/CID) is three digits.";
1408         $self->paycvv($1);
1409       }
1410     } else {
1411       $self->paycvv('');
1412     }
1413
1414     my $cardtype = cardtype($payinfo);
1415     if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1416
1417       return "Start date or issue number is required for $cardtype cards"
1418         unless $self->paystart_month && $self->paystart_year or $self->payissue;
1419
1420       return "Start month must be between 1 and 12"
1421         if $self->paystart_month
1422            and $self->paystart_month < 1 || $self->paystart_month > 12;
1423
1424       return "Start year must be 1990 or later"
1425         if $self->paystart_year
1426            and $self->paystart_year < 1990;
1427
1428       return "Issue number must be beween 1 and 99"
1429         if $self->payissue
1430           and $self->payissue < 1 || $self->payissue > 99;
1431
1432     } else {
1433       $self->paystart_month('');
1434       $self->paystart_year('');
1435       $self->payissue('');
1436     }
1437
1438   } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1439
1440     my $payinfo = $self->payinfo;
1441     $payinfo =~ s/[^\d\@]//g;
1442     if ( $conf->exists('echeck-nonus') ) {
1443       $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1444       $payinfo = "$1\@$2";
1445     } else {
1446       $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1447       $payinfo = "$1\@$2";
1448     }
1449     $self->payinfo($payinfo);
1450     $self->paycvv('');
1451
1452     my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1453     if ( $ban ) {
1454       return 'Banned ACH account: banned on '.
1455              time2str('%a %h %o at %r', $ban->_date).
1456              ' by '. $ban->otaker.
1457              ' (ban# '. $ban->bannum. ')';
1458     }
1459
1460   } elsif ( $self->payby eq 'LECB' ) {
1461
1462     my $payinfo = $self->payinfo;
1463     $payinfo =~ s/\D//g;
1464     $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1465     $payinfo = $1;
1466     $self->payinfo($payinfo);
1467     $self->paycvv('');
1468
1469   } elsif ( $self->payby eq 'BILL' ) {
1470
1471     $error = $self->ut_textn('payinfo');
1472     return "Illegal P.O. number: ". $self->payinfo if $error;
1473     $self->paycvv('');
1474
1475   } elsif ( $self->payby eq 'COMP' ) {
1476
1477     my $curuser = $FS::CurrentUser::CurrentUser;
1478     if (    ! $self->custnum
1479          && ! $curuser->access_right('Complimentary customer')
1480        )
1481     {
1482       return "You are not permitted to create complimentary accounts."
1483     }
1484
1485     $error = $self->ut_textn('payinfo');
1486     return "Illegal comp account issuer: ". $self->payinfo if $error;
1487     $self->paycvv('');
1488
1489   } elsif ( $self->payby eq 'PREPAY' ) {
1490
1491     my $payinfo = $self->payinfo;
1492     $payinfo =~ s/\W//g; #anything else would just confuse things
1493     $self->payinfo($payinfo);
1494     $error = $self->ut_alpha('payinfo');
1495     return "Illegal prepayment identifier: ". $self->payinfo if $error;
1496     return "Unknown prepayment identifier"
1497       unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1498     $self->paycvv('');
1499
1500   }
1501
1502   if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1503     return "Expiration date required"
1504       unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1505     $self->paydate('');
1506   } else {
1507     my( $m, $y );
1508     if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1509       ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1510     } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1511       ( $m, $y ) = ( $3, "20$2" );
1512     } else {
1513       return "Illegal expiration date: ". $self->paydate;
1514     }
1515     $self->paydate("$y-$m-01");
1516     my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1517     return gettext('expired_card')
1518       if !$import
1519       && !$ignore_expired_card
1520       && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1521   }
1522
1523   if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1524        ( ! $conf->exists('require_cardname')
1525          || $self->payby !~ /^(CARD|DCRD)$/  )
1526   ) {
1527     $self->payname( $self->first. " ". $self->getfield('last') );
1528   } else {
1529     $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1530       or return gettext('illegal_name'). " payname: ". $self->payname;
1531     $self->payname($1);
1532   }
1533
1534   foreach my $flag (qw( tax spool_cdr )) {
1535     $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1536     $self->$flag($1);
1537   }
1538
1539   $self->otaker(getotaker) unless $self->otaker;
1540
1541   warn "$me check AFTER: \n". $self->_dump
1542     if $DEBUG > 2;
1543
1544   $self->SUPER::check;
1545 }
1546
1547 =item addr_fields
1548
1549 Returns a list of fields which have ship_ duplicates.
1550
1551 =cut
1552
1553 sub addr_fields {
1554   qw( last first company
1555       address1 address2 city county state zip country
1556       daytime night fax
1557     );
1558 }
1559
1560 =item has_ship_address
1561
1562 Returns true if this customer record has a separate shipping address.
1563
1564 =cut
1565
1566 sub has_ship_address {
1567   my $self = shift;
1568   scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
1569 }
1570
1571 =item all_pkgs
1572
1573 Returns all packages (see L<FS::cust_pkg>) for this customer.
1574
1575 =cut
1576
1577 sub all_pkgs {
1578   my $self = shift;
1579
1580   return $self->num_pkgs unless wantarray;
1581
1582   my @cust_pkg = ();
1583   if ( $self->{'_pkgnum'} ) {
1584     @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1585   } else {
1586     @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1587   }
1588
1589   sort sort_packages @cust_pkg;
1590 }
1591
1592 =item cust_pkg
1593
1594 Synonym for B<all_pkgs>.
1595
1596 =cut
1597
1598 sub cust_pkg {
1599   shift->all_pkgs(@_);
1600 }
1601
1602 =item ncancelled_pkgs
1603
1604 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1605
1606 =cut
1607
1608 sub ncancelled_pkgs {
1609   my $self = shift;
1610
1611   return $self->num_ncancelled_pkgs unless wantarray;
1612
1613   my @cust_pkg = ();
1614   if ( $self->{'_pkgnum'} ) {
1615
1616     warn "$me ncancelled_pkgs: returning cached objects"
1617       if $DEBUG > 1;
1618
1619     @cust_pkg = grep { ! $_->getfield('cancel') }
1620                 values %{ $self->{'_pkgnum'}->cache };
1621
1622   } else {
1623
1624     warn "$me ncancelled_pkgs: searching for packages with custnum ".
1625          $self->custnum. "\n"
1626       if $DEBUG > 1;
1627
1628     @cust_pkg =
1629       qsearch( 'cust_pkg', {
1630                              'custnum' => $self->custnum,
1631                              'cancel'  => '',
1632                            });
1633     push @cust_pkg,
1634       qsearch( 'cust_pkg', {
1635                              'custnum' => $self->custnum,
1636                              'cancel'  => 0,
1637                            });
1638   }
1639
1640   sort sort_packages @cust_pkg;
1641
1642 }
1643
1644 # This should be generalized to use config options to determine order.
1645 sub sort_packages {
1646   if ( $a->get('cancel') and $b->get('cancel') ) {
1647     $a->pkgnum <=> $b->pkgnum;
1648   } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1649     return -1 if $b->get('cancel');
1650     return  1 if $a->get('cancel');
1651     return 0;
1652   } else {
1653     $a->pkgnum <=> $b->pkgnum;
1654   }
1655 }
1656
1657 =item suspended_pkgs
1658
1659 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1660
1661 =cut
1662
1663 sub suspended_pkgs {
1664   my $self = shift;
1665   grep { $_->susp } $self->ncancelled_pkgs;
1666 }
1667
1668 =item unflagged_suspended_pkgs
1669
1670 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1671 customer (thouse packages without the `manual_flag' set).
1672
1673 =cut
1674
1675 sub unflagged_suspended_pkgs {
1676   my $self = shift;
1677   return $self->suspended_pkgs
1678     unless dbdef->table('cust_pkg')->column('manual_flag');
1679   grep { ! $_->manual_flag } $self->suspended_pkgs;
1680 }
1681
1682 =item unsuspended_pkgs
1683
1684 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1685 this customer.
1686
1687 =cut
1688
1689 sub unsuspended_pkgs {
1690   my $self = shift;
1691   grep { ! $_->susp } $self->ncancelled_pkgs;
1692 }
1693
1694 =item num_cancelled_pkgs
1695
1696 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1697 customer.
1698
1699 =cut
1700
1701 sub num_cancelled_pkgs {
1702   shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1703 }
1704
1705 sub num_ncancelled_pkgs {
1706   shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1707 }
1708
1709 sub num_pkgs {
1710   my( $self ) = shift;
1711   my $sql = scalar(@_) ? shift : '';
1712   $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1713   my $sth = dbh->prepare(
1714     "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1715   ) or die dbh->errstr;
1716   $sth->execute($self->custnum) or die $sth->errstr;
1717   $sth->fetchrow_arrayref->[0];
1718 }
1719
1720 =item unsuspend
1721
1722 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1723 and L<FS::cust_pkg>) for this customer.  Always returns a list: an empty list
1724 on success or a list of errors.
1725
1726 =cut
1727
1728 sub unsuspend {
1729   my $self = shift;
1730   grep { $_->unsuspend } $self->suspended_pkgs;
1731 }
1732
1733 =item suspend
1734
1735 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1736
1737 Returns a list: an empty list on success or a list of errors.
1738
1739 =cut
1740
1741 sub suspend {
1742   my $self = shift;
1743   grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1744 }
1745
1746 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1747
1748 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1749 PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref instead
1750 of a list of pkgparts; the hashref has the following keys:
1751
1752 =over 4
1753
1754 =item pkgparts - listref of pkgparts
1755
1756 =item (other options are passed to the suspend method)
1757
1758 =back
1759
1760
1761 Returns a list: an empty list on success or a list of errors.
1762
1763 =cut
1764
1765 sub suspend_if_pkgpart {
1766   my $self = shift;
1767   my (@pkgparts, %opt);
1768   if (ref($_[0]) eq 'HASH'){
1769     @pkgparts = @{$_[0]{pkgparts}};
1770     %opt      = %{$_[0]};
1771   }else{
1772     @pkgparts = @_;
1773   }
1774   grep { $_->suspend(%opt) }
1775     grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1776       $self->unsuspended_pkgs;
1777 }
1778
1779 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
1780
1781 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1782 given PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref
1783 instead of a list of pkgparts; the hashref has the following keys:
1784
1785 =over 4
1786
1787 =item pkgparts - listref of pkgparts
1788
1789 =item (other options are passed to the suspend method)
1790
1791 =back
1792
1793 Returns a list: an empty list on success or a list of errors.
1794
1795 =cut
1796
1797 sub suspend_unless_pkgpart {
1798   my $self = shift;
1799   my (@pkgparts, %opt);
1800   if (ref($_[0]) eq 'HASH'){
1801     @pkgparts = @{$_[0]{pkgparts}};
1802     %opt      = %{$_[0]};
1803   }else{
1804     @pkgparts = @_;
1805   }
1806   grep { $_->suspend(%opt) }
1807     grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1808       $self->unsuspended_pkgs;
1809 }
1810
1811 =item cancel [ OPTION => VALUE ... ]
1812
1813 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1814
1815 Available options are:
1816
1817 =over 4
1818
1819 =item quiet - can be set true to supress email cancellation notices.
1820
1821 =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.
1822
1823 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
1824
1825 =back
1826
1827 Always returns a list: an empty list on success or a list of errors.
1828
1829 =cut
1830
1831 sub cancel {
1832   my( $self, %opt ) = @_;
1833
1834   warn "$me cancel called on customer ". $self->custnum. " with options ".
1835        join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
1836     if $DEBUG;
1837
1838   return ( 'access denied' )
1839     unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
1840
1841   if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1842
1843     #should try decryption (we might have the private key)
1844     # and if not maybe queue a job for the server that does?
1845     return ( "Can't (yet) ban encrypted credit cards" )
1846       if $self->is_encrypted($self->payinfo);
1847
1848     my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1849     my $error = $ban->insert;
1850     return ( $error ) if $error;
1851
1852   }
1853
1854   my @pkgs = $self->ncancelled_pkgs;
1855
1856   warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
1857        scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
1858     if $DEBUG;
1859
1860   grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
1861 }
1862
1863 sub _banned_pay_hashref {
1864   my $self = shift;
1865
1866   my %payby2ban = (
1867     'CARD' => 'CARD',
1868     'DCRD' => 'CARD',
1869     'CHEK' => 'CHEK',
1870     'DCHK' => 'CHEK'
1871   );
1872
1873   {
1874     'payby'   => $payby2ban{$self->payby},
1875     'payinfo' => md5_base64($self->payinfo),
1876     #don't ever *search* on reason! #'reason'  =>
1877   };
1878 }
1879
1880 =item notes
1881
1882 Returns all notes (see L<FS::cust_main_note>) for this customer.
1883
1884 =cut
1885
1886 sub notes {
1887   my $self = shift;
1888   #order by?
1889   qsearch( 'cust_main_note',
1890            { 'custnum' => $self->custnum },
1891            '',
1892            'ORDER BY _DATE DESC'
1893          );
1894 }
1895
1896 =item agent
1897
1898 Returns the agent (see L<FS::agent>) for this customer.
1899
1900 =cut
1901
1902 sub agent {
1903   my $self = shift;
1904   qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1905 }
1906
1907 =item bill_and_collect
1908
1909 Cancels and suspends any packages due, generates bills, applies payments and
1910 cred
1911
1912 Warns on errors (Does not currently: If there is an error, returns the error, otherwise returns false.)
1913
1914 Options are passed as name-value pairs.  Currently available options are:
1915
1916 =over 4
1917
1918 =item time
1919
1920 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:
1921
1922  use Date::Parse;
1923  ...
1924  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1925
1926 =item invoice_time
1927
1928 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.
1929
1930 =item check_freq
1931
1932 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
1933
1934 =item resetup
1935
1936 If set true, re-charges setup fees.
1937
1938 =item debug
1939
1940 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)
1941
1942 =back
1943
1944 =cut
1945
1946 sub bill_and_collect {
1947   my( $self, %options ) = @_;
1948
1949   ###
1950   # cancel packages
1951   ###
1952
1953   #$^T not $options{time} because freeside-daily -d is for pre-printing invoices
1954   foreach my $cust_pkg (
1955     grep { $_->expire && $_->expire <= $^T } $self->ncancelled_pkgs
1956   ) {
1957     my $error = $cust_pkg->cancel;
1958     warn "Error cancelling expired pkg ". $cust_pkg->pkgnum.
1959          " for custnum ". $self->custnum. ": $error"
1960       if $error;
1961   }
1962
1963   ###
1964   # suspend packages
1965   ###
1966
1967   #$^T not $options{time} because freeside-daily -d is for pre-printing invoices
1968   foreach my $cust_pkg (
1969     grep { (    $_->part_pkg->is_prepaid && $_->bill && $_->bill < $^T
1970              || $_->adjourn && $_->adjourn <= $^T
1971            )
1972            && ! $_->susp
1973          }
1974          $self->ncancelled_pkgs
1975   ) {
1976     my $error = $cust_pkg->suspend;
1977     warn "Error suspending package ". $cust_pkg->pkgnum.
1978          " for custnum ". $self->custnum. ": $error"
1979       if $error;
1980   }
1981
1982   ###
1983   # bill and collect
1984   ###
1985
1986   my $error = $self->bill( %options );
1987   warn "Error billing, custnum ". $self->custnum. ": $error" if $error;
1988
1989   $self->apply_payments_and_credits;
1990
1991   $error = $self->collect( %options );
1992   warn "Error collecting, custnum". $self->custnum. ": $error" if $error;
1993
1994 }
1995
1996 =item bill OPTIONS
1997
1998 Generates invoices (see L<FS::cust_bill>) for this customer.  Usually used in
1999 conjunction with the collect method by calling B<bill_and_collect>.
2000
2001 If there is an error, returns the error, otherwise returns false.
2002
2003 Options are passed as name-value pairs.  Currently available options are:
2004
2005 =over 4
2006
2007 =item resetup
2008
2009 If set true, re-charges setup fees.
2010
2011 =item time
2012
2013 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:
2014
2015  use Date::Parse;
2016  ...
2017  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
2018
2019 =item pkg_list
2020
2021 An array ref of specific packages (objects) to attempt billing, instead trying all of them.
2022
2023  $cust_main->bill( pkg_list => [$pkg1, $pkg2] );
2024
2025 =item invoice_time
2026
2027 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.
2028
2029 =back
2030
2031 =cut
2032
2033 sub bill {
2034   my( $self, %options ) = @_;
2035   return '' if $self->payby eq 'COMP';
2036   warn "$me bill customer ". $self->custnum. "\n"
2037     if $DEBUG;
2038
2039   my $time = $options{'time'} || time;
2040
2041   my $error;
2042
2043   #put below somehow?
2044   local $SIG{HUP} = 'IGNORE';
2045   local $SIG{INT} = 'IGNORE';
2046   local $SIG{QUIT} = 'IGNORE';
2047   local $SIG{TERM} = 'IGNORE';
2048   local $SIG{TSTP} = 'IGNORE';
2049   local $SIG{PIPE} = 'IGNORE';
2050
2051   my $oldAutoCommit = $FS::UID::AutoCommit;
2052   local $FS::UID::AutoCommit = 0;
2053   my $dbh = dbh;
2054
2055   $self->select_for_update; #mutex
2056
2057   #create a new invoice
2058   #(we'll remove it later if it doesn't actually need to be generated [contains
2059   # no line items] and we're inside a transaciton so nothing else will see it)
2060   my $cust_bill = new FS::cust_bill ( {
2061     'custnum' => $self->custnum,
2062     '_date'   => ( $options{'invoice_time'} || $time ),
2063     #'charged' => $charged,
2064     'charged' => 0,
2065   } );
2066   $error = $cust_bill->insert;
2067   if ( $error ) {
2068     $dbh->rollback if $oldAutoCommit;
2069     return "can't create invoice for customer #". $self->custnum. ": $error";
2070   }
2071   my $invnum = $cust_bill->invnum;
2072
2073   ###
2074   # find the packages which are due for billing, find out how much they are
2075   # & generate invoice database.
2076   ###
2077
2078   my( $total_setup, $total_recur ) = ( 0, 0 );
2079   my %tax;
2080   my %taxlisthash;
2081   my @precommit_hooks = ();
2082
2083   foreach my $cust_pkg (
2084     qsearch('cust_pkg', { 'custnum' => $self->custnum } )
2085   ) {
2086
2087     #NO!! next if $cust_pkg->cancel;
2088     next if $cust_pkg->getfield('cancel');
2089
2090     warn "  bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
2091
2092     #? to avoid use of uninitialized value errors... ?
2093     $cust_pkg->setfield('bill', '')
2094       unless defined($cust_pkg->bill);
2095
2096     my $part_pkg = $cust_pkg->part_pkg;
2097
2098     my %hash = $cust_pkg->hash;
2099     my $old_cust_pkg = new FS::cust_pkg \%hash;
2100
2101     my @details = ();
2102
2103     ###
2104     # bill setup
2105     ###
2106
2107     my $setup = 0;
2108     if ( ! $cust_pkg->setup &&
2109          (
2110            ( $conf->exists('disable_setup_suspended_pkgs') &&
2111             ! $cust_pkg->getfield('susp')
2112           ) || ! $conf->exists('disable_setup_suspended_pkgs')
2113          )
2114       || $options{'resetup'}
2115     ) {
2116
2117       warn "    bill setup\n" if $DEBUG > 1;
2118
2119       $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
2120       if ( $@ ) {
2121         $dbh->rollback if $oldAutoCommit;
2122         return "$@ running calc_setup for $cust_pkg\n";
2123       }
2124
2125       $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
2126     }
2127
2128     ###
2129     # bill recurring fee
2130     ###
2131
2132     my $recur = 0;
2133     my $sdate;
2134     if ( $part_pkg->getfield('freq') ne '0' &&
2135          ! $cust_pkg->getfield('susp') &&
2136          ( $cust_pkg->getfield('bill') || 0 ) <= $time
2137     ) {
2138
2139       # XXX should this be a package event?  probably.  events are called
2140       # at collection time at the moment, though...
2141       if ( $part_pkg->can('reset_usage') ) {
2142         warn "    resetting usage counters" if $DEBUG > 1;
2143         $part_pkg->reset_usage($cust_pkg);
2144       }
2145
2146       warn "    bill recur\n" if $DEBUG > 1;
2147
2148       # XXX shared with $recur_prog
2149       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2150
2151       #over two params!  lets at least switch to a hashref for the rest...
2152       my %param = ( 'precommit_hooks' => \@precommit_hooks, );
2153
2154       $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
2155       if ( $@ ) {
2156         $dbh->rollback if $oldAutoCommit;
2157         return "$@ running calc_recur for $cust_pkg\n";
2158       }
2159
2160       #change this bit to use Date::Manip? CAREFUL with timezones (see
2161       # mailing list archive)
2162       my ($sec,$min,$hour,$mday,$mon,$year) =
2163         (localtime($sdate) )[0,1,2,3,4,5];
2164
2165       #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
2166       # only for figuring next bill date, nothing else, so, reset $sdate again
2167       # here
2168       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
2169       $cust_pkg->last_bill($sdate);
2170
2171       if ( $part_pkg->freq =~ /^\d+$/ ) {
2172         $mon += $part_pkg->freq;
2173         until ( $mon < 12 ) { $mon -= 12; $year++; }
2174       } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
2175         my $weeks = $1;
2176         $mday += $weeks * 7;
2177       } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
2178         my $days = $1;
2179         $mday += $days;
2180       } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
2181         my $hours = $1;
2182         $hour += $hours;
2183       } else {
2184         $dbh->rollback if $oldAutoCommit;
2185         return "unparsable frequency: ". $part_pkg->freq;
2186       }
2187       $cust_pkg->setfield('bill',
2188         timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
2189     }
2190
2191     warn "\$setup is undefined" unless defined($setup);
2192     warn "\$recur is undefined" unless defined($recur);
2193     warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
2194
2195     ###
2196     # If $cust_pkg has been modified, update it and create cust_bill_pkg records
2197     ###
2198
2199     if ( $cust_pkg->modified ) {  # hmmm.. and if the options are modified?
2200
2201       warn "  package ". $cust_pkg->pkgnum. " modified; updating\n"
2202         if $DEBUG >1;
2203
2204       $error=$cust_pkg->replace($old_cust_pkg,
2205                                 options => { $cust_pkg->options },
2206                                );
2207       if ( $error ) { #just in case
2208         $dbh->rollback if $oldAutoCommit;
2209         return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
2210       }
2211
2212       $setup = sprintf( "%.2f", $setup );
2213       $recur = sprintf( "%.2f", $recur );
2214       if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2215         $dbh->rollback if $oldAutoCommit;
2216         return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2217       }
2218       if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2219         $dbh->rollback if $oldAutoCommit;
2220         return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2221       }
2222
2223       if ( $setup != 0 || $recur != 0 ) {
2224
2225         warn "    charges (setup=$setup, recur=$recur); adding line items\n"
2226           if $DEBUG > 1;
2227         my $cust_bill_pkg = new FS::cust_bill_pkg ({
2228           'invnum'  => $invnum,
2229           'pkgnum'  => $cust_pkg->pkgnum,
2230           'setup'   => $setup,
2231           'recur'   => $recur,
2232           'sdate'   => $sdate,
2233           'edate'   => $cust_pkg->bill,
2234           'details' => \@details,
2235         });
2236         $error = $cust_bill_pkg->insert;
2237         if ( $error ) {
2238           $dbh->rollback if $oldAutoCommit;
2239           return "can't create invoice line item for invoice #$invnum: $error";
2240         }
2241         $total_setup += $setup;
2242         $total_recur += $recur;
2243
2244         ###
2245         # handle taxes
2246         ###
2247
2248         unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2249
2250           my @taxes = ();
2251           my @taxoverrides = $part_pkg->part_pkg_taxoverride;
2252
2253           my $prefix =
2254             ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2255             ? 'ship_'
2256             : '';
2257
2258           if ( $conf->exists('enable_taxproducts')
2259                && (scalar(@taxoverrides) || $part_pkg->taxproductnum )
2260              )
2261           {
2262
2263             my @taxclassnums = ();
2264             my $geocode = $self->geocode('cch');
2265
2266             if ( scalar( @taxoverrides ) ) {
2267               @taxclassnums = map { $_->taxclassnum } @taxoverrides;
2268             }elsif ( $part_pkg->taxproductnum ) {
2269               @taxclassnums = map { $_->taxclassnum }
2270                               $part_pkg->part_pkg_taxrate('cch', $geocode);
2271             }
2272
2273             my $extra_sql =
2274               "AND (".
2275               join(' OR ', map { "taxclassnum = $_" } @taxclassnums ). ")";
2276
2277             @taxes = qsearch({ 'table' => 'tax_rate',
2278                                'hashref' => { 'geocode' => $geocode, },
2279                                'extra_sql' => $extra_sql,
2280                             })
2281               if scalar(@taxclassnums);
2282
2283
2284           }else{
2285
2286             my %taxhash = map { $_ => $self->get("$prefix$_") }
2287                               qw( state county country );
2288
2289             $taxhash{'taxclass'} = $part_pkg->taxclass;
2290
2291             @taxes = qsearch( 'cust_main_county', \%taxhash );
2292
2293             unless ( @taxes ) {
2294               $taxhash{'taxclass'} = '';
2295               @taxes =  qsearch( 'cust_main_county', \%taxhash );
2296             }
2297
2298             #one more try at a whole-country tax rate
2299             unless ( @taxes ) {
2300               $taxhash{$_} = '' foreach qw( state county );
2301               @taxes =  qsearch( 'cust_main_county', \%taxhash );
2302             }
2303
2304           } #if $conf->exists('enable_taxproducts')
2305
2306           # maybe eliminate this entirely, along with all the 0% records
2307           unless ( @taxes ) {
2308             $dbh->rollback if $oldAutoCommit;
2309             my $error;
2310             if ( $conf->exists('enable_taxproducts') ) {
2311               $error =
2312                 "fatal: can't find tax rate for zip/taxproduct/pkgpart ".
2313                 join('/', ( map $self->get("$prefix$_"),
2314                                 qw(zip)
2315                           ),
2316                           $part_pkg->taxproduct_description,
2317                           $part_pkg->pkgpart ). "\n";
2318             }else{
2319               $error =
2320                 "fatal: can't find tax rate for state/county/country/taxclass ".
2321                 join('/', ( map $self->get("$prefix$_"),
2322                                 qw(state county country)
2323                           ),
2324                           $part_pkg->taxclass ). "\n";
2325             }
2326             return $error;
2327           }
2328
2329           foreach my $tax ( @taxes ) {
2330             my $taxname = ref( $tax ). ' '. $tax->taxnum;
2331             if ( exists( $taxlisthash{ $taxname } ) ) {
2332               push @{ $taxlisthash{ $taxname  } }, $cust_bill_pkg;
2333             }else{
2334               $taxlisthash{ $taxname } = [ $tax, $cust_bill_pkg ];
2335             }
2336           }
2337
2338
2339         } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2340
2341       } #if $setup != 0 || $recur != 0
2342
2343     } #if $cust_pkg->modified
2344
2345   } #foreach my $cust_pkg
2346
2347   unless ( $cust_bill->cust_bill_pkg ) {
2348     $cust_bill->delete; #don't create an invoice w/o line items
2349
2350    # XXX this seems to be broken
2351    #( DBD::Pg::st execute failed: ERROR:  syntax error at or near "hcb" )
2352 #   # get rid of our fake history too, waste of unecessary space
2353 #    my $h_cleanup_query = q{
2354 #      DELETE FROM h_cust_bill hcb
2355 #       WHERE hcb.invnum = ?
2356 #      AND NOT EXISTS ( SELECT 1 FROM cust_bill cb where cb.invnum = hcb.invnum )
2357 #    };
2358 #    my $h_sth = $dbh->prepare($h_cleanup_query);
2359 #    $h_sth->execute($invnum);
2360
2361     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2362     return '';
2363   }
2364
2365   my $charged = sprintf( "%.2f", $total_setup + $total_recur );
2366
2367   foreach my $tax ( keys %taxlisthash ) {
2368     my $tax_object = shift @{ $taxlisthash{$tax} };
2369     my $listref_or_error = $tax_object->taxline( @{ $taxlisthash{$tax} } );
2370     unless (ref($listref_or_error)) {
2371       $dbh->rollback if $oldAutoCommit;
2372       return $listref_or_error;
2373     }
2374
2375     $tax{ $listref_or_error->[0] } += $listref_or_error->[1];
2376
2377   }
2378
2379   foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2380     my $tax = sprintf("%.2f", $tax{$taxname} );
2381     $charged = sprintf( "%.2f", $charged+$tax );
2382
2383     my $cust_bill_pkg = new FS::cust_bill_pkg ({
2384       'invnum'   => $invnum,
2385       'pkgnum'   => 0,
2386       'setup'    => $tax,
2387       'recur'    => 0,
2388       'sdate'    => '',
2389       'edate'    => '',
2390       'itemdesc' => $taxname,
2391     });
2392     $error = $cust_bill_pkg->insert;
2393     if ( $error ) {
2394       $dbh->rollback if $oldAutoCommit;
2395       return "can't create invoice line item for invoice #$invnum: $error";
2396     }
2397     $total_setup += $tax;
2398
2399   }
2400
2401   $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2402   $error = $cust_bill->replace;
2403   if ( $error ) {
2404     $dbh->rollback if $oldAutoCommit;
2405     return "can't update charged for invoice #$invnum: $error";
2406   }
2407
2408   foreach my $hook ( @precommit_hooks ) {
2409     eval {
2410       &{$hook}; #($self) ?
2411     };
2412     if ( $@ ) {
2413       $dbh->rollback if $oldAutoCommit;
2414       return "$@ running precommit hook $hook\n";
2415     }
2416   }
2417
2418   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2419   ''; #no error
2420 }
2421
2422 =item collect OPTIONS
2423
2424 (Attempt to) collect money for this customer's outstanding invoices (see
2425 L<FS::cust_bill>).  Usually used after the bill method.
2426
2427 Actions are now triggered by billing events; see L<FS::part_event> and the
2428 billing events web interface.  Old-style invoice events (see
2429 L<FS::part_bill_event>) have been deprecated.
2430
2431 If there is an error, returns the error, otherwise returns false.
2432
2433 Options are passed as name-value pairs.
2434
2435 Currently available options are:
2436
2437 =over 4
2438
2439 =item invoice_time
2440
2441 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.
2442
2443 =item retry
2444
2445 Retry card/echeck/LEC transactions even when not scheduled by invoice events.
2446
2447 =item quiet
2448
2449 set true to surpress email card/ACH decline notices.
2450
2451 =item check_freq
2452
2453 "1d" for the traditional, daily events (the default), or "1m" for the new monthly events (part_event.check_freq)
2454
2455 =item payby
2456
2457 allows for one time override of normal customer billing method
2458
2459 =item debug
2460
2461 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)
2462
2463
2464 =back
2465
2466 =cut
2467
2468 sub collect {
2469   my( $self, %options ) = @_;
2470   my $invoice_time = $options{'invoice_time'} || time;
2471
2472   #put below somehow?
2473   local $SIG{HUP} = 'IGNORE';
2474   local $SIG{INT} = 'IGNORE';
2475   local $SIG{QUIT} = 'IGNORE';
2476   local $SIG{TERM} = 'IGNORE';
2477   local $SIG{TSTP} = 'IGNORE';
2478   local $SIG{PIPE} = 'IGNORE';
2479
2480   my $oldAutoCommit = $FS::UID::AutoCommit;
2481   local $FS::UID::AutoCommit = 0;
2482   my $dbh = dbh;
2483
2484   $self->select_for_update; #mutex
2485
2486   if ( $DEBUG ) {
2487     my $balance = $self->balance;
2488     warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2489   }
2490
2491   if ( exists($options{'retry_card'}) ) {
2492     carp 'retry_card option passed to collect is deprecated; use retry';
2493     $options{'retry'} ||= $options{'retry_card'};
2494   }
2495   if ( exists($options{'retry'}) && $options{'retry'} ) {
2496     my $error = $self->retry_realtime;
2497     if ( $error ) {
2498       $dbh->rollback if $oldAutoCommit;
2499       return $error;
2500     }
2501   }
2502
2503   # false laziness w/pay_batch::import_results
2504
2505   my $due_cust_event = $self->due_cust_event(
2506     'debug'      => ( $options{'debug'} || 0 ),
2507     'time'       => $invoice_time,
2508     'check_freq' => $options{'check_freq'},
2509   );
2510   unless( ref($due_cust_event) ) {
2511     $dbh->rollback if $oldAutoCommit;
2512     return $due_cust_event;
2513   }
2514
2515   foreach my $cust_event ( @$due_cust_event ) {
2516
2517     #XXX lock event
2518
2519     #re-eval event conditions (a previous event could have changed things)
2520     unless ( $cust_event->test_conditions( 'time' => $invoice_time ) ) {
2521       #don't leave stray "new/locked" records around
2522       my $error = $cust_event->delete;
2523       if ( $error ) {
2524         #gah, even with transactions
2525         $dbh->commit if $oldAutoCommit; #well.
2526         return $error;
2527       }
2528       next;
2529     }
2530
2531     {
2532       local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2533       warn "  running cust_event ". $cust_event->eventnum. "\n"
2534         if $DEBUG > 1;
2535
2536
2537       #if ( my $error = $cust_event->do_event(%options) ) { #XXX %options?
2538       if ( my $error = $cust_event->do_event() ) {
2539         #XXX wtf is this?  figure out a proper dealio with return value
2540         #from do_event
2541           # gah, even with transactions.
2542           $dbh->commit if $oldAutoCommit; #well.
2543           return $error;
2544         }
2545     }
2546
2547   }
2548
2549   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2550   '';
2551
2552 }
2553
2554 =item due_cust_event [ HASHREF | OPTION => VALUE ... ]
2555
2556 Inserts database records for and returns an ordered listref of new events due
2557 for this customer, as FS::cust_event objects (see L<FS::cust_event>).  If no
2558 events are due, an empty listref is returned.  If there is an error, returns a
2559 scalar error message.
2560
2561 To actually run the events, call each event's test_condition method, and if
2562 still true, call the event's do_event method.
2563
2564 Options are passed as a hashref or as a list of name-value pairs.  Available
2565 options are:
2566
2567 =over 4
2568
2569 =item check_freq
2570
2571 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.
2572
2573 =item time
2574
2575 "Current time" for the events.
2576
2577 =item debug
2578
2579 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)
2580
2581 =item eventtable
2582
2583 Only return events for the specified eventtable (by default, events of all eventtables are returned)
2584
2585 =item objects
2586
2587 Explicitly pass the objects to be tested (typically used with eventtable).
2588
2589 =back
2590
2591 =cut
2592
2593 sub due_cust_event {
2594   my $self = shift;
2595   my %opt = ref($_[0]) ? %{ $_[0] } : @_;
2596
2597   #???
2598   #my $DEBUG = $opt{'debug'}
2599   local($DEBUG) = $opt{'debug'}
2600     if defined($opt{'debug'}) && $opt{'debug'} > $DEBUG;
2601
2602   warn "$me due_cust_event called with options ".
2603        join(', ', map { "$_: $opt{$_}" } keys %opt). "\n"
2604     if $DEBUG;
2605
2606   $opt{'time'} ||= time;
2607
2608   local $SIG{HUP} = 'IGNORE';
2609   local $SIG{INT} = 'IGNORE';
2610   local $SIG{QUIT} = 'IGNORE';
2611   local $SIG{TERM} = 'IGNORE';
2612   local $SIG{TSTP} = 'IGNORE';
2613   local $SIG{PIPE} = 'IGNORE';
2614
2615   my $oldAutoCommit = $FS::UID::AutoCommit;
2616   local $FS::UID::AutoCommit = 0;
2617   my $dbh = dbh;
2618
2619   $self->select_for_update; #mutex
2620
2621   ###
2622   # 1: find possible events (initial search)
2623   ###
2624
2625   my @cust_event = ();
2626
2627   my @eventtable = $opt{'eventtable'}
2628                      ? ( $opt{'eventtable'} )
2629                      : FS::part_event->eventtables_runorder;
2630
2631   foreach my $eventtable ( @eventtable ) {
2632
2633     my @objects;
2634     if ( $opt{'objects'} ) {
2635
2636       @objects = @{ $opt{'objects'} };
2637
2638     } else {
2639
2640       #my @objects = $self->eventtable(); # sub cust_main { @{ [ $self ] }; }
2641       @objects = ( $eventtable eq 'cust_main' )
2642                    ? ( $self )
2643                    : ( $self->$eventtable() );
2644
2645     }
2646
2647     my @e_cust_event = ();
2648
2649     my $cross = "CROSS JOIN $eventtable";
2650     $cross .= ' LEFT JOIN cust_main USING ( custnum )'
2651       unless $eventtable eq 'cust_main';
2652
2653     foreach my $object ( @objects ) {
2654
2655       #this first search uses the condition_sql magic for optimization.
2656       #the more possible events we can eliminate in this step the better
2657
2658       my $cross_where = '';
2659       my $pkey = $object->primary_key;
2660       $cross_where = "$eventtable.$pkey = ". $object->$pkey();
2661
2662       my $join = FS::part_event_condition->join_conditions_sql( $eventtable );
2663       my $extra_sql =
2664         FS::part_event_condition->where_conditions_sql( $eventtable,
2665                                                         'time'=>$opt{'time'}
2666                                                       );
2667       my $order = FS::part_event_condition->order_conditions_sql( $eventtable );
2668
2669       $extra_sql = "AND $extra_sql" if $extra_sql;
2670
2671       #here is the agent virtualization
2672       $extra_sql .= " AND (    part_event.agentnum IS NULL
2673                             OR part_event.agentnum = ". $self->agentnum. ' )';
2674
2675       $extra_sql .= " $order";
2676
2677       warn "searching for events for $eventtable ". $object->$pkey. "\n"
2678         if $opt{'debug'} > 2;
2679       my @part_event = qsearch( {
2680         'debug'     => ( $opt{'debug'} > 3 ? 1 : 0 ),
2681         'select'    => 'part_event.*',
2682         'table'     => 'part_event',
2683         'addl_from' => "$cross $join",
2684         'hashref'   => { 'check_freq' => ( $opt{'check_freq'} || '1d' ),
2685                          'eventtable' => $eventtable,
2686                          'disabled'   => '',
2687                        },
2688         'extra_sql' => "AND $cross_where $extra_sql",
2689       } );
2690
2691       if ( $DEBUG > 2 ) {
2692         my $pkey = $object->primary_key;
2693         warn "      ". scalar(@part_event).
2694              " possible events found for $eventtable ". $object->$pkey(). "\n";
2695       }
2696
2697       push @e_cust_event, map { $_->new_cust_event($object) } @part_event;
2698
2699     }
2700
2701     warn "    ". scalar(@e_cust_event).
2702          " subtotal possible cust events found for $eventtable\n"
2703       if $DEBUG > 1;
2704
2705     push @cust_event, @e_cust_event;
2706
2707   }
2708
2709   warn "  ". scalar(@cust_event).
2710        " total possible cust events found in initial search\n"
2711     if $DEBUG; # > 1;
2712
2713   ##
2714   # 2: test conditions
2715   ##
2716
2717   my %unsat = ();
2718
2719   @cust_event = grep $_->test_conditions( 'time'          => $opt{'time'},
2720                                           'stats_hashref' => \%unsat ),
2721                      @cust_event;
2722
2723   warn "  ". scalar(@cust_event). " cust events left satisfying conditions\n"
2724     if $DEBUG; # > 1;
2725
2726   warn "    invalid conditions not eliminated with condition_sql:\n".
2727        join('', map "      $_: ".$unsat{$_}."\n", keys %unsat )
2728     if $DEBUG; # > 1;
2729
2730   ##
2731   # 3: insert
2732   ##
2733
2734   foreach my $cust_event ( @cust_event ) {
2735
2736     my $error = $cust_event->insert();
2737     if ( $error ) {
2738       $dbh->rollback if $oldAutoCommit;
2739       return $error;
2740     }
2741
2742   }
2743
2744   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2745
2746   ##
2747   # 4: return
2748   ##
2749
2750   warn "  returning events: ". Dumper(@cust_event). "\n"
2751     if $DEBUG > 2;
2752
2753   \@cust_event;
2754
2755 }
2756
2757 =item retry_realtime
2758
2759 Schedules realtime / batch  credit card / electronic check / LEC billing
2760 events for for retry.  Useful if card information has changed or manual
2761 retry is desired.  The 'collect' method must be called to actually retry
2762 the transaction.
2763
2764 Implementation details: For either this customer, or for each of this
2765 customer's open invoices, changes the status of the first "done" (with
2766 statustext error) realtime processing event to "failed".
2767
2768 =cut
2769
2770 sub retry_realtime {
2771   my $self = shift;
2772
2773   local $SIG{HUP} = 'IGNORE';
2774   local $SIG{INT} = 'IGNORE';
2775   local $SIG{QUIT} = 'IGNORE';
2776   local $SIG{TERM} = 'IGNORE';
2777   local $SIG{TSTP} = 'IGNORE';
2778   local $SIG{PIPE} = 'IGNORE';
2779
2780   my $oldAutoCommit = $FS::UID::AutoCommit;
2781   local $FS::UID::AutoCommit = 0;
2782   my $dbh = dbh;
2783
2784   #a little false laziness w/due_cust_event (not too bad, really)
2785
2786   my $join = FS::part_event_condition->join_conditions_sql;
2787   my $order = FS::part_event_condition->order_conditions_sql;
2788   my $mine =
2789   '( '
2790    . join ( ' OR ' , map {
2791     "( part_event.eventtable = " . dbh->quote($_)
2792     . " AND tablenum IN( SELECT " . dbdef->table($_)->primary_key . " from $_ where custnum = " . dbh->quote( $self->custnum ) . "))" ;
2793    } FS::part_event->eventtables)
2794    . ') ';
2795
2796   #here is the agent virtualization
2797   my $agent_virt = " (    part_event.agentnum IS NULL
2798                        OR part_event.agentnum = ". $self->agentnum. ' )';
2799
2800   #XXX this shouldn't be hardcoded, actions should declare it...
2801   my @realtime_events = qw(
2802     cust_bill_realtime_card
2803     cust_bill_realtime_check
2804     cust_bill_realtime_lec
2805     cust_bill_batch
2806   );
2807
2808   my $is_realtime_event = ' ( '. join(' OR ', map "part_event.action = '$_'",
2809                                                   @realtime_events
2810                                      ).
2811                           ' ) ';
2812
2813   my @cust_event = qsearchs({
2814     'table'     => 'cust_event',
2815     'select'    => 'cust_event.*',
2816     'addl_from' => "LEFT JOIN part_event USING ( eventpart ) $join",
2817     'hashref'   => { 'status' => 'done' },
2818     'extra_sql' => " AND statustext IS NOT NULL AND statustext != '' ".
2819                    " AND $mine AND $is_realtime_event AND $agent_virt $order" # LIMIT 1"
2820   });
2821
2822   my %seen_invnum = ();
2823   foreach my $cust_event (@cust_event) {
2824
2825     #max one for the customer, one for each open invoice
2826     my $cust_X = $cust_event->cust_X;
2827     next if $seen_invnum{ $cust_event->part_event->eventtable eq 'cust_bill'
2828                           ? $cust_X->invnum
2829                           : 0
2830                         }++
2831          or $cust_event->part_event->eventtable eq 'cust_bill'
2832             && ! $cust_X->owed;
2833
2834     my $error = $cust_event->retry;
2835     if ( $error ) {
2836       $dbh->rollback if $oldAutoCommit;
2837       return "error scheduling event for retry: $error";
2838     }
2839
2840   }
2841
2842   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2843   '';
2844
2845 }
2846
2847 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2848
2849 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2850 via a Business::OnlinePayment realtime gateway.  See
2851 L<http://420.am/business-onlinepayment> for supported gateways.
2852
2853 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2854
2855 Available options are: I<description>, I<invnum>, I<quiet>, I<paynum_ref>, I<payunique>
2856
2857 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2858 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
2859 if set, will override the value from the customer record.
2860
2861 I<description> is a free-text field passed to the gateway.  It defaults to
2862 "Internet services".
2863
2864 If an I<invnum> is specified, this payment (if successful) is applied to the
2865 specified invoice.  If you don't specify an I<invnum> you might want to
2866 call the B<apply_payments> method.
2867
2868 I<quiet> can be set true to surpress email decline notices.
2869
2870 I<paynum_ref> can be set to a scalar reference.  It will be filled in with the
2871 resulting paynum, if any.
2872
2873 I<payunique> is a unique identifier for this payment.
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   return $self->fake_bop($method, $amount, %options) if $options{'fake'};
2889
2890   eval "use Business::OnlinePayment";
2891   die $@ if $@;
2892
2893   my $payinfo = exists($options{'payinfo'})
2894                   ? $options{'payinfo'}
2895                   : $self->payinfo;
2896
2897   my %method2payby = (
2898     'CC'     => 'CARD',
2899     'ECHECK' => 'CHEK',
2900     'LEC'    => 'LECB',
2901   );
2902
2903   ###
2904   # check for banned credit card/ACH
2905   ###
2906
2907   my $ban = qsearchs('banned_pay', {
2908     'payby'   => $method2payby{$method},
2909     'payinfo' => md5_base64($payinfo),
2910   } );
2911   return "Banned credit card" if $ban;
2912
2913   ###
2914   # select a gateway
2915   ###
2916
2917   my $taxclass = '';
2918   if ( $options{'invnum'} ) {
2919     my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2920     die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2921     my @taxclasses =
2922       map  { $_->part_pkg->taxclass }
2923       grep { $_ }
2924       map  { $_->cust_pkg }
2925       $cust_bill->cust_bill_pkg;
2926     unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2927                                                            #different taxclasses
2928       $taxclass = $taxclasses[0];
2929     }
2930   }
2931
2932   #look for an agent gateway override first
2933   my $cardtype;
2934   if ( $method eq 'CC' ) {
2935     $cardtype = cardtype($payinfo);
2936   } elsif ( $method eq 'ECHECK' ) {
2937     $cardtype = 'ACH';
2938   } else {
2939     $cardtype = $method;
2940   }
2941
2942   my $override =
2943        qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2944                                            cardtype => $cardtype,
2945                                            taxclass => $taxclass,       } )
2946     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2947                                            cardtype => '',
2948                                            taxclass => $taxclass,       } )
2949     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2950                                            cardtype => $cardtype,
2951                                            taxclass => '',              } )
2952     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2953                                            cardtype => '',
2954                                            taxclass => '',              } );
2955
2956   my $payment_gateway = '';
2957   my( $processor, $login, $password, $action, @bop_options );
2958   if ( $override ) { #use a payment gateway override
2959
2960     $payment_gateway = $override->payment_gateway;
2961
2962     $processor   = $payment_gateway->gateway_module;
2963     $login       = $payment_gateway->gateway_username;
2964     $password    = $payment_gateway->gateway_password;
2965     $action      = $payment_gateway->gateway_action;
2966     @bop_options = $payment_gateway->options;
2967
2968   } else { #use the standard settings from the config
2969
2970     ( $processor, $login, $password, $action, @bop_options ) =
2971       $self->default_payment_gateway($method);
2972
2973   }
2974
2975   ###
2976   # massage data
2977   ###
2978
2979   my $address = exists($options{'address1'})
2980                     ? $options{'address1'}
2981                     : $self->address1;
2982   my $address2 = exists($options{'address2'})
2983                     ? $options{'address2'}
2984                     : $self->address2;
2985   $address .= ", ". $address2 if length($address2);
2986
2987   my $o_payname = exists($options{'payname'})
2988                     ? $options{'payname'}
2989                     : $self->payname;
2990   my($payname, $payfirst, $paylast);
2991   if ( $o_payname && $method ne 'ECHECK' ) {
2992     ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2993       or return "Illegal payname $payname";
2994     ($payfirst, $paylast) = ($1, $2);
2995   } else {
2996     $payfirst = $self->getfield('first');
2997     $paylast = $self->getfield('last');
2998     $payname =  "$payfirst $paylast";
2999   }
3000
3001   my @invoicing_list = $self->invoicing_list_emailonly;
3002   if ( $conf->exists('emailinvoiceautoalways')
3003        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3004        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3005     push @invoicing_list, $self->all_emails;
3006   }
3007
3008   my $email = ($conf->exists('business-onlinepayment-email-override'))
3009               ? $conf->config('business-onlinepayment-email-override')
3010               : $invoicing_list[0];
3011
3012   my %content = ();
3013
3014   my $payip = exists($options{'payip'})
3015                 ? $options{'payip'}
3016                 : $self->payip;
3017   $content{customer_ip} = $payip
3018     if length($payip);
3019
3020   $content{invoice_number} = $options{'invnum'}
3021     if exists($options{'invnum'}) && length($options{'invnum'});
3022
3023   $content{email_customer} =
3024     (    $conf->exists('business-onlinepayment-email_customer')
3025       || $conf->exists('business-onlinepayment-email-override') );
3026
3027   my $paydate = '';
3028   if ( $method eq 'CC' ) {
3029
3030     $content{card_number} = $payinfo;
3031     $paydate = exists($options{'paydate'})
3032                     ? $options{'paydate'}
3033                     : $self->paydate;
3034     $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3035     $content{expiration} = "$2/$1";
3036
3037     my $paycvv = exists($options{'paycvv'})
3038                    ? $options{'paycvv'}
3039                    : $self->paycvv;
3040     $content{cvv2} = $paycvv
3041       if length($paycvv);
3042
3043     my $paystart_month = exists($options{'paystart_month'})
3044                            ? $options{'paystart_month'}
3045                            : $self->paystart_month;
3046
3047     my $paystart_year  = exists($options{'paystart_year'})
3048                            ? $options{'paystart_year'}
3049                            : $self->paystart_year;
3050
3051     $content{card_start} = "$paystart_month/$paystart_year"
3052       if $paystart_month && $paystart_year;
3053
3054     my $payissue       = exists($options{'payissue'})
3055                            ? $options{'payissue'}
3056                            : $self->payissue;
3057     $content{issue_number} = $payissue if $payissue;
3058
3059     $content{recurring_billing} = 'YES'
3060       if qsearch('cust_pay', { 'custnum' => $self->custnum,
3061                                'payby'   => 'CARD',
3062                                'payinfo' => $payinfo,
3063                              } )
3064       || qsearch('cust_pay', { 'custnum' => $self->custnum,
3065                                'payby'   => 'CARD',
3066                                'paymask' => $self->mask_payinfo('CARD', $payinfo),
3067                              } );
3068
3069
3070   } elsif ( $method eq 'ECHECK' ) {
3071     ( $content{account_number}, $content{routing_code} ) =
3072       split('@', $payinfo);
3073     $content{bank_name} = $o_payname;
3074     $content{bank_state} = exists($options{'paystate'})
3075                              ? $options{'paystate'}
3076                              : $self->getfield('paystate');
3077     $content{account_type} = exists($options{'paytype'})
3078                                ? uc($options{'paytype'}) || 'CHECKING'
3079                                : uc($self->getfield('paytype')) || 'CHECKING';
3080     $content{account_name} = $payname;
3081     $content{customer_org} = $self->company ? 'B' : 'I';
3082     $content{state_id}       = exists($options{'stateid'})
3083                                  ? $options{'stateid'}
3084                                  : $self->getfield('stateid');
3085     $content{state_id_state} = exists($options{'stateid_state'})
3086                                  ? $options{'stateid_state'}
3087                                  : $self->getfield('stateid_state');
3088     $content{customer_ssn} = exists($options{'ss'})
3089                                ? $options{'ss'}
3090                                : $self->ss;
3091   } elsif ( $method eq 'LEC' ) {
3092     $content{phone} = $payinfo;
3093   }
3094
3095   ###
3096   # run transaction(s)
3097   ###
3098
3099   my $balance = exists( $options{'balance'} )
3100                   ? $options{'balance'}
3101                   : $self->balance;
3102
3103   $self->select_for_update; #mutex ... just until we get our pending record in
3104
3105   #the checks here are intended to catch concurrent payments
3106   #double-form-submission prevention is taken care of in cust_pay_pending::check
3107
3108   #check the balance
3109   return "The customer's balance has changed; $method transaction aborted."
3110     if $self->balance < $balance;
3111     #&& $self->balance < $amount; #might as well anyway?
3112
3113   #also check and make sure there aren't *other* pending payments for this cust
3114
3115   my @pending = qsearch('cust_pay_pending', {
3116     'custnum' => $self->custnum,
3117     'status'  => { op=>'!=', value=>'done' }
3118   });
3119   return "A payment is already being processed for this customer (".
3120          join(', ', map 'paypendingnum '. $_->paypendingnum, @pending ).
3121          "); $method transaction aborted."
3122     if scalar(@pending);
3123
3124   #okay, good to go, if we're a duplicate, cust_pay_pending will kick us out
3125
3126   my $cust_pay_pending = new FS::cust_pay_pending {
3127     'custnum'    => $self->custnum,
3128     #'invnum'     => $options{'invnum'},
3129     'paid'       => $amount,
3130     '_date'      => '',
3131     'payby'      => $method2payby{$method},
3132     'payinfo'    => $payinfo,
3133     'paydate'    => $paydate,
3134     'status'     => 'new',
3135     'gatewaynum' => ( $payment_gateway ? $payment_gateway->gatewaynum : '' ),
3136   };
3137   $cust_pay_pending->payunique( $options{payunique} )
3138     if defined($options{payunique}) && length($options{payunique});
3139   my $cpp_new_err = $cust_pay_pending->insert; #mutex lost when this is inserted
3140   return $cpp_new_err if $cpp_new_err;
3141
3142   my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
3143
3144   my $transaction = new Business::OnlinePayment( $processor, @bop_options );
3145   $transaction->content(
3146     'type'           => $method,
3147     'login'          => $login,
3148     'password'       => $password,
3149     'action'         => $action1,
3150     'description'    => $options{'description'},
3151     'amount'         => $amount,
3152     #'invoice_number' => $options{'invnum'},
3153     'customer_id'    => $self->custnum,
3154     'last_name'      => $paylast,
3155     'first_name'     => $payfirst,
3156     'name'           => $payname,
3157     'address'        => $address,
3158     'city'           => ( exists($options{'city'})
3159                             ? $options{'city'}
3160                             : $self->city          ),
3161     'state'          => ( exists($options{'state'})
3162                             ? $options{'state'}
3163                             : $self->state          ),
3164     'zip'            => ( exists($options{'zip'})
3165                             ? $options{'zip'}
3166                             : $self->zip          ),
3167     'country'        => ( exists($options{'country'})
3168                             ? $options{'country'}
3169                             : $self->country          ),
3170     'referer'        => 'http://cleanwhisker.420.am/',
3171     'email'          => $email,
3172     'phone'          => $self->daytime || $self->night,
3173     %content, #after
3174   );
3175
3176   $cust_pay_pending->status('pending');
3177   my $cpp_pending_err = $cust_pay_pending->replace;
3178   return $cpp_pending_err if $cpp_pending_err;
3179
3180   #config?
3181   my $BOP_TESTING = 0;
3182   my $BOP_TESTING_SUCCESS = 1;
3183
3184   unless ( $BOP_TESTING ) {
3185     $transaction->submit();
3186   } else {
3187     if ( $BOP_TESTING_SUCCESS ) {
3188       $transaction->is_success(1);
3189       $transaction->authorization('fake auth');
3190     } else {
3191       $transaction->is_success(0);
3192       $transaction->error_message('fake failure');
3193     }
3194   }
3195
3196   if ( $transaction->is_success() && $action2 ) {
3197
3198     $cust_pay_pending->status('authorized');
3199     my $cpp_authorized_err = $cust_pay_pending->replace;
3200     return $cpp_authorized_err if $cpp_authorized_err;
3201
3202     my $auth = $transaction->authorization;
3203     my $ordernum = $transaction->can('order_number')
3204                    ? $transaction->order_number
3205                    : '';
3206
3207     my $capture =
3208       new Business::OnlinePayment( $processor, @bop_options );
3209
3210     my %capture = (
3211       %content,
3212       type           => $method,
3213       action         => $action2,
3214       login          => $login,
3215       password       => $password,
3216       order_number   => $ordernum,
3217       amount         => $amount,
3218       authorization  => $auth,
3219       description    => $options{'description'},
3220     );
3221
3222     foreach my $field (qw( authorization_source_code returned_ACI
3223                            transaction_identifier validation_code
3224                            transaction_sequence_num local_transaction_date
3225                            local_transaction_time AVS_result_code          )) {
3226       $capture{$field} = $transaction->$field() if $transaction->can($field);
3227     }
3228
3229     $capture->content( %capture );
3230
3231     $capture->submit();
3232
3233     unless ( $capture->is_success ) {
3234       my $e = "Authorization successful but capture failed, custnum #".
3235               $self->custnum. ': '.  $capture->result_code.
3236               ": ". $capture->error_message;
3237       warn $e;
3238       return $e;
3239     }
3240
3241   }
3242
3243   $cust_pay_pending->status($transaction->is_success() ? 'captured' : 'declined');
3244   my $cpp_captured_err = $cust_pay_pending->replace;
3245   return $cpp_captured_err if $cpp_captured_err;
3246
3247   ###
3248   # remove paycvv after initial transaction
3249   ###
3250
3251   #false laziness w/misc/process/payment.cgi - check both to make sure working
3252   # correctly
3253   if ( defined $self->dbdef_table->column('paycvv')
3254        && length($self->paycvv)
3255        && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
3256   ) {
3257     my $error = $self->remove_cvv;
3258     if ( $error ) {
3259       warn "WARNING: error removing cvv: $error\n";
3260     }
3261   }
3262
3263   ###
3264   # result handling
3265   ###
3266
3267   if ( $transaction->is_success() ) {
3268
3269     my $paybatch = '';
3270     if ( $payment_gateway ) { # agent override
3271       $paybatch = $payment_gateway->gatewaynum. '-';
3272     }
3273
3274     $paybatch .= "$processor:". $transaction->authorization;
3275
3276     $paybatch .= ':'. $transaction->order_number
3277       if $transaction->can('order_number')
3278       && length($transaction->order_number);
3279
3280     my $cust_pay = new FS::cust_pay ( {
3281        'custnum'  => $self->custnum,
3282        'invnum'   => $options{'invnum'},
3283        'paid'     => $amount,
3284        '_date'    => '',
3285        'payby'    => $method2payby{$method},
3286        'payinfo'  => $payinfo,
3287        'paybatch' => $paybatch,
3288        'paydate'  => $paydate,
3289     } );
3290     #doesn't hurt to know, even though the dup check is in cust_pay_pending now
3291     $cust_pay->payunique( $options{payunique} )
3292       if defined($options{payunique}) && length($options{payunique});
3293
3294     my $oldAutoCommit = $FS::UID::AutoCommit;
3295     local $FS::UID::AutoCommit = 0;
3296     my $dbh = dbh;
3297
3298     #start a transaction, insert the cust_pay and set cust_pay_pending.status to done in a single transction
3299
3300     my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3301
3302     if ( $error ) {
3303       $cust_pay->invnum(''); #try again with no specific invnum
3304       my $error2 = $cust_pay->insert( $options{'manual'} ?
3305                                       ( 'manual' => 1 ) : ()
3306                                     );
3307       if ( $error2 ) {
3308         # gah.  but at least we have a record of the state we had to abort in
3309         # from cust_pay_pending now.
3310         my $e = "WARNING: $method captured but payment not recorded - ".
3311                 "error inserting payment ($processor): $error2".
3312                 " (previously tried insert with invnum #$options{'invnum'}" .
3313                 ": $error ) - pending payment saved as paypendingnum ".
3314                 $cust_pay_pending->paypendingnum. "\n";
3315         warn $e;
3316         return $e;
3317       }
3318     }
3319
3320     if ( $options{'paynum_ref'} ) {
3321       ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3322     }
3323
3324     $cust_pay_pending->status('done');
3325     $cust_pay_pending->statustext('captured');
3326     my $cpp_done_err = $cust_pay_pending->replace;
3327
3328     if ( $cpp_done_err ) {
3329
3330       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
3331       my $e = "WARNING: $method captured but payment not recorded - ".
3332               "error updating status for paypendingnum ".
3333               $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3334       warn $e;
3335       return $e;
3336
3337     } else {
3338
3339       $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3340       return ''; #no error
3341
3342     }
3343
3344   } else {
3345
3346     my $perror = "$processor error: ". $transaction->error_message;
3347
3348     unless ( $transaction->error_message ) {
3349
3350       my $t_response;
3351       if ( $transaction->can('response_page') ) {
3352         $t_response = {
3353                         'page'    => ( $transaction->can('response_page')
3354                                          ? $transaction->response_page
3355                                          : ''
3356                                      ),
3357                         'code'    => ( $transaction->can('response_code')
3358                                          ? $transaction->response_code
3359                                          : ''
3360                                      ),
3361                         'headers' => ( $transaction->can('response_headers')
3362                                          ? $transaction->response_headers
3363                                          : ''
3364                                      ),
3365                       };
3366       } else {
3367         $t_response .=
3368           "No additional debugging information available for $processor";
3369       }
3370
3371       $perror .= "No error_message returned from $processor -- ".
3372                  ( ref($t_response) ? Dumper($t_response) : $t_response );
3373
3374     }
3375
3376     if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
3377          && $conf->exists('emaildecline')
3378          && grep { $_ ne 'POST' } $self->invoicing_list
3379          && ! grep { $transaction->error_message =~ /$_/ }
3380                    $conf->config('emaildecline-exclude')
3381     ) {
3382       my @templ = $conf->config('declinetemplate');
3383       my $template = new Text::Template (
3384         TYPE   => 'ARRAY',
3385         SOURCE => [ map "$_\n", @templ ],
3386       ) or return "($perror) can't create template: $Text::Template::ERROR";
3387       $template->compile()
3388         or return "($perror) can't compile template: $Text::Template::ERROR";
3389
3390       my $templ_hash = { error => $transaction->error_message };
3391
3392       my $error = send_email(
3393         'from'    => $conf->config('invoice_from'),
3394         'to'      => [ grep { $_ ne 'POST' } $self->invoicing_list ],
3395         'subject' => 'Your payment could not be processed',
3396         'body'    => [ $template->fill_in(HASH => $templ_hash) ],
3397       );
3398
3399       $perror .= " (also received error sending decline notification: $error)"
3400         if $error;
3401
3402     }
3403
3404     $cust_pay_pending->status('done');
3405     $cust_pay_pending->statustext("declined: $perror");
3406     my $cpp_done_err = $cust_pay_pending->replace;
3407     if ( $cpp_done_err ) {
3408       my $e = "WARNING: $method declined but pending payment not resolved - ".
3409               "error updating status for paypendingnum ".
3410               $cust_pay_pending->paypendingnum. ": $cpp_done_err \n";
3411       warn $e;
3412       $perror = "$e ($perror)";
3413     }
3414
3415     return $perror;
3416   }
3417
3418 }
3419
3420 =item fake_bop
3421
3422 =cut
3423
3424 sub fake_bop {
3425   my( $self, $method, $amount, %options ) = @_;
3426
3427   if ( $options{'fake_failure'} ) {
3428      return "Error: No error; test failure requested with fake_failure";
3429   }
3430
3431   my %method2payby = (
3432     'CC'     => 'CARD',
3433     'ECHECK' => 'CHEK',
3434     'LEC'    => 'LECB',
3435   );
3436
3437   #my $paybatch = '';
3438   #if ( $payment_gateway ) { # agent override
3439   #  $paybatch = $payment_gateway->gatewaynum. '-';
3440   #}
3441   #
3442   #$paybatch .= "$processor:". $transaction->authorization;
3443   #
3444   #$paybatch .= ':'. $transaction->order_number
3445   #  if $transaction->can('order_number')
3446   #  && length($transaction->order_number);
3447
3448   my $paybatch = 'FakeProcessor:54:32';
3449
3450   my $cust_pay = new FS::cust_pay ( {
3451      'custnum'  => $self->custnum,
3452      'invnum'   => $options{'invnum'},
3453      'paid'     => $amount,
3454      '_date'    => '',
3455      'payby'    => $method2payby{$method},
3456      #'payinfo'  => $payinfo,
3457      'payinfo'  => '4111111111111111',
3458      'paybatch' => $paybatch,
3459      #'paydate'  => $paydate,
3460      'paydate'  => '2012-05-01',
3461   } );
3462   $cust_pay->payunique( $options{payunique} ) if length($options{payunique});
3463
3464   my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
3465
3466   if ( $error ) {
3467     $cust_pay->invnum(''); #try again with no specific invnum
3468     my $error2 = $cust_pay->insert( $options{'manual'} ?
3469                                     ( 'manual' => 1 ) : ()
3470                                   );
3471     if ( $error2 ) {
3472       # gah, even with transactions.
3473       my $e = 'WARNING: Card/ACH debited but database not updated - '.
3474               "error inserting (fake!) payment: $error2".
3475               " (previously tried insert with invnum #$options{'invnum'}" .
3476               ": $error )";
3477       warn $e;
3478       return $e;
3479     }
3480   }
3481
3482   if ( $options{'paynum_ref'} ) {
3483     ${ $options{'paynum_ref'} } = $cust_pay->paynum;
3484   }
3485
3486   return ''; #no error
3487
3488 }
3489
3490 =item default_payment_gateway
3491
3492 =cut
3493
3494 sub default_payment_gateway {
3495   my( $self, $method ) = @_;
3496
3497   die "Real-time processing not enabled\n"
3498     unless $conf->exists('business-onlinepayment');
3499
3500   #load up config
3501   my $bop_config = 'business-onlinepayment';
3502   $bop_config .= '-ach'
3503     if $method =~ /^(ECHECK|CHEK)$/ && $conf->exists($bop_config. '-ach');
3504   my ( $processor, $login, $password, $action, @bop_options ) =
3505     $conf->config($bop_config);
3506   $action ||= 'normal authorization';
3507   pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
3508   die "No real-time processor is enabled - ".
3509       "did you set the business-onlinepayment configuration value?\n"
3510     unless $processor;
3511
3512   ( $processor, $login, $password, $action, @bop_options )
3513 }
3514
3515 =item remove_cvv
3516
3517 Removes the I<paycvv> field from the database directly.
3518
3519 If there is an error, returns the error, otherwise returns false.
3520
3521 =cut
3522
3523 sub remove_cvv {
3524   my $self = shift;
3525   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
3526     or return dbh->errstr;
3527   $sth->execute($self->custnum)
3528     or return $sth->errstr;
3529   $self->paycvv('');
3530   '';
3531 }
3532
3533 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
3534
3535 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
3536 via a Business::OnlinePayment realtime gateway.  See
3537 L<http://420.am/business-onlinepayment> for supported gateways.
3538
3539 Available methods are: I<CC>, I<ECHECK> and I<LEC>
3540
3541 Available options are: I<amount>, I<reason>, I<paynum>, I<paydate>
3542
3543 Most gateways require a reference to an original payment transaction to refund,
3544 so you probably need to specify a I<paynum>.
3545
3546 I<amount> defaults to the original amount of the payment if not specified.
3547
3548 I<reason> specifies a reason for the refund.
3549
3550 I<paydate> specifies the expiration date for a credit card overriding the
3551 value from the customer record or the payment record. Specified as yyyy-mm-dd
3552
3553 Implementation note: If I<amount> is unspecified or equal to the amount of the
3554 orignal payment, first an attempt is made to "void" the transaction via
3555 the gateway (to cancel a not-yet settled transaction) and then if that fails,
3556 the normal attempt is made to "refund" ("credit") the transaction via the
3557 gateway is attempted.
3558
3559 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
3560 #I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
3561 #if set, will override the value from the customer record.
3562
3563 #If an I<invnum> is specified, this payment (if successful) is applied to the
3564 #specified invoice.  If you don't specify an I<invnum> you might want to
3565 #call the B<apply_payments> method.
3566
3567 =cut
3568
3569 #some false laziness w/realtime_bop, not enough to make it worth merging
3570 #but some useful small subs should be pulled out
3571 sub realtime_refund_bop {
3572   my( $self, $method, %options ) = @_;
3573   if ( $DEBUG ) {
3574     warn "$me realtime_refund_bop: $method refund\n";
3575     warn "  $_ => $options{$_}\n" foreach keys %options;
3576   }
3577
3578   eval "use Business::OnlinePayment";
3579   die $@ if $@;
3580
3581   ###
3582   # look up the original payment and optionally a gateway for that payment
3583   ###
3584
3585   my $cust_pay = '';
3586   my $amount = $options{'amount'};
3587
3588   my( $processor, $login, $password, @bop_options ) ;
3589   my( $auth, $order_number ) = ( '', '', '' );
3590
3591   if ( $options{'paynum'} ) {
3592
3593     warn "  paynum: $options{paynum}\n" if $DEBUG > 1;
3594     $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
3595       or return "Unknown paynum $options{'paynum'}";
3596     $amount ||= $cust_pay->paid;
3597
3598     $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
3599       or return "Can't parse paybatch for paynum $options{'paynum'}: ".
3600                 $cust_pay->paybatch;
3601     my $gatewaynum = '';
3602     ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
3603
3604     if ( $gatewaynum ) { #gateway for the payment to be refunded
3605
3606       my $payment_gateway =
3607         qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
3608       die "payment gateway $gatewaynum not found"
3609         unless $payment_gateway;
3610
3611       $processor   = $payment_gateway->gateway_module;
3612       $login       = $payment_gateway->gateway_username;
3613       $password    = $payment_gateway->gateway_password;
3614       @bop_options = $payment_gateway->options;
3615
3616     } else { #try the default gateway
3617
3618       my( $conf_processor, $unused_action );
3619       ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
3620         $self->default_payment_gateway($method);
3621
3622       return "processor of payment $options{'paynum'} $processor does not".
3623              " match default processor $conf_processor"
3624         unless $processor eq $conf_processor;
3625
3626     }
3627
3628
3629   } else { # didn't specify a paynum, so look for agent gateway overrides
3630            # like a normal transaction
3631
3632     my $cardtype;
3633     if ( $method eq 'CC' ) {
3634       $cardtype = cardtype($self->payinfo);
3635     } elsif ( $method eq 'ECHECK' ) {
3636       $cardtype = 'ACH';
3637     } else {
3638       $cardtype = $method;
3639     }
3640     my $override =
3641            qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3642                                                cardtype => $cardtype,
3643                                                taxclass => '',              } )
3644         || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
3645                                                cardtype => '',
3646                                                taxclass => '',              } );
3647
3648     if ( $override ) { #use a payment gateway override
3649
3650       my $payment_gateway = $override->payment_gateway;
3651
3652       $processor   = $payment_gateway->gateway_module;
3653       $login       = $payment_gateway->gateway_username;
3654       $password    = $payment_gateway->gateway_password;
3655       #$action      = $payment_gateway->gateway_action;
3656       @bop_options = $payment_gateway->options;
3657
3658     } else { #use the standard settings from the config
3659
3660       my $unused_action;
3661       ( $processor, $login, $password, $unused_action, @bop_options ) =
3662         $self->default_payment_gateway($method);
3663
3664     }
3665
3666   }
3667   return "neither amount nor paynum specified" unless $amount;
3668
3669   my %content = (
3670     'type'           => $method,
3671     'login'          => $login,
3672     'password'       => $password,
3673     'order_number'   => $order_number,
3674     'amount'         => $amount,
3675     'referer'        => 'http://cleanwhisker.420.am/',
3676   );
3677   $content{authorization} = $auth
3678     if length($auth); #echeck/ACH transactions have an order # but no auth
3679                       #(at least with authorize.net)
3680
3681   my $disable_void_after;
3682   if ($conf->exists('disable_void_after')
3683       && $conf->config('disable_void_after') =~ /^(\d+)$/) {
3684     $disable_void_after = $1;
3685   }
3686
3687   #first try void if applicable
3688   if ( $cust_pay && $cust_pay->paid == $amount
3689     && (
3690       ( not defined($disable_void_after) )
3691       || ( time < ($cust_pay->_date + $disable_void_after ) )
3692     )
3693   ) {
3694     warn "  attempting void\n" if $DEBUG > 1;
3695     my $void = new Business::OnlinePayment( $processor, @bop_options );
3696     $void->content( 'action' => 'void', %content );
3697     $void->submit();
3698     if ( $void->is_success ) {
3699       my $error = $cust_pay->void($options{'reason'});
3700       if ( $error ) {
3701         # gah, even with transactions.
3702         my $e = 'WARNING: Card/ACH voided but database not updated - '.
3703                 "error voiding payment: $error";
3704         warn $e;
3705         return $e;
3706       }
3707       warn "  void successful\n" if $DEBUG > 1;
3708       return '';
3709     }
3710   }
3711
3712   warn "  void unsuccessful, trying refund\n"
3713     if $DEBUG > 1;
3714
3715   #massage data
3716   my $address = $self->address1;
3717   $address .= ", ". $self->address2 if $self->address2;
3718
3719   my($payname, $payfirst, $paylast);
3720   if ( $self->payname && $method ne 'ECHECK' ) {
3721     $payname = $self->payname;
3722     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3723       or return "Illegal payname $payname";
3724     ($payfirst, $paylast) = ($1, $2);
3725   } else {
3726     $payfirst = $self->getfield('first');
3727     $paylast = $self->getfield('last');
3728     $payname =  "$payfirst $paylast";
3729   }
3730
3731   my @invoicing_list = $self->invoicing_list_emailonly;
3732   if ( $conf->exists('emailinvoiceautoalways')
3733        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3734        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3735     push @invoicing_list, $self->all_emails;
3736   }
3737
3738   my $email = ($conf->exists('business-onlinepayment-email-override'))
3739               ? $conf->config('business-onlinepayment-email-override')
3740               : $invoicing_list[0];
3741
3742   my $payip = exists($options{'payip'})
3743                 ? $options{'payip'}
3744                 : $self->payip;
3745   $content{customer_ip} = $payip
3746     if length($payip);
3747
3748   my $payinfo = '';
3749   if ( $method eq 'CC' ) {
3750
3751     if ( $cust_pay ) {
3752       $content{card_number} = $payinfo = $cust_pay->payinfo;
3753       (exists($options{'paydate'}) ? $options{'paydate'} : $cust_pay->paydate)
3754         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/ &&
3755         ($content{expiration} = "$2/$1");  # where available
3756     } else {
3757       $content{card_number} = $payinfo = $self->payinfo;
3758       (exists($options{'paydate'}) ? $options{'paydate'} : $self->paydate)
3759         =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3760       $content{expiration} = "$2/$1";
3761     }
3762
3763   } elsif ( $method eq 'ECHECK' ) {
3764
3765     if ( $cust_pay ) {
3766       $payinfo = $cust_pay->payinfo;
3767     } else {
3768       $payinfo = $self->payinfo;
3769     }
3770     ( $content{account_number}, $content{routing_code} )= split('@', $payinfo );
3771     $content{bank_name} = $self->payname;
3772     $content{account_type} = 'CHECKING';
3773     $content{account_name} = $payname;
3774     $content{customer_org} = $self->company ? 'B' : 'I';
3775     $content{customer_ssn} = $self->ss;
3776   } elsif ( $method eq 'LEC' ) {
3777     $content{phone} = $payinfo = $self->payinfo;
3778   }
3779
3780   #then try refund
3781   my $refund = new Business::OnlinePayment( $processor, @bop_options );
3782   my %sub_content = $refund->content(
3783     'action'         => 'credit',
3784     'customer_id'    => $self->custnum,
3785     'last_name'      => $paylast,
3786     'first_name'     => $payfirst,
3787     'name'           => $payname,
3788     'address'        => $address,
3789     'city'           => $self->city,
3790     'state'          => $self->state,
3791     'zip'            => $self->zip,
3792     'country'        => $self->country,
3793     'email'          => $email,
3794     'phone'          => $self->daytime || $self->night,
3795     %content, #after
3796   );
3797   warn join('', map { "  $_ => $sub_content{$_}\n" } keys %sub_content )
3798     if $DEBUG > 1;
3799   $refund->submit();
3800
3801   return "$processor error: ". $refund->error_message
3802     unless $refund->is_success();
3803
3804   my %method2payby = (
3805     'CC'     => 'CARD',
3806     'ECHECK' => 'CHEK',
3807     'LEC'    => 'LECB',
3808   );
3809
3810   my $paybatch = "$processor:". $refund->authorization;
3811   $paybatch .= ':'. $refund->order_number
3812     if $refund->can('order_number') && $refund->order_number;
3813
3814   while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3815     my @cust_bill_pay = $cust_pay->cust_bill_pay;
3816     last unless @cust_bill_pay;
3817     my $cust_bill_pay = pop @cust_bill_pay;
3818     my $error = $cust_bill_pay->delete;
3819     last if $error;
3820   }
3821
3822   my $cust_refund = new FS::cust_refund ( {
3823     'custnum'  => $self->custnum,
3824     'paynum'   => $options{'paynum'},
3825     'refund'   => $amount,
3826     '_date'    => '',
3827     'payby'    => $method2payby{$method},
3828     'payinfo'  => $payinfo,
3829     'paybatch' => $paybatch,
3830     'reason'   => $options{'reason'} || 'card or ACH refund',
3831   } );
3832   my $error = $cust_refund->insert;
3833   if ( $error ) {
3834     $cust_refund->paynum(''); #try again with no specific paynum
3835     my $error2 = $cust_refund->insert;
3836     if ( $error2 ) {
3837       # gah, even with transactions.
3838       my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3839               "error inserting refund ($processor): $error2".
3840               " (previously tried insert with paynum #$options{'paynum'}" .
3841               ": $error )";
3842       warn $e;
3843       return $e;
3844     }
3845   }
3846
3847   ''; #no error
3848
3849 }
3850
3851 =item batch_card OPTION => VALUE...
3852
3853 Adds a payment for this invoice to the pending credit card batch (see
3854 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
3855 runs the payment using a realtime gateway.
3856
3857 =cut
3858
3859 sub batch_card {
3860   my ($self, %options) = @_;
3861
3862   my $amount;
3863   if (exists($options{amount})) {
3864     $amount = $options{amount};
3865   }else{
3866     $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
3867   }
3868   return '' unless $amount > 0;
3869
3870   my $invnum = delete $options{invnum};
3871   my $payby = $options{invnum} || $self->payby;  #dubious
3872
3873   if ($options{'realtime'}) {
3874     return $self->realtime_bop( FS::payby->payby2bop($self->payby),
3875                                 $amount,
3876                                 %options,
3877                               );
3878   }
3879
3880   my $oldAutoCommit = $FS::UID::AutoCommit;
3881   local $FS::UID::AutoCommit = 0;
3882   my $dbh = dbh;
3883
3884   #this needs to handle mysql as well as Pg, like svc_acct.pm
3885   #(make it into a common function if folks need to do batching with mysql)
3886   $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
3887     or return "Cannot lock pay_batch: " . $dbh->errstr;
3888
3889   my %pay_batch = (
3890     'status' => 'O',
3891     'payby'  => FS::payby->payby2payment($payby),
3892   );
3893
3894   my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
3895
3896   unless ( $pay_batch ) {
3897     $pay_batch = new FS::pay_batch \%pay_batch;
3898     my $error = $pay_batch->insert;
3899     if ( $error ) {
3900       $dbh->rollback if $oldAutoCommit;
3901       die "error creating new batch: $error\n";
3902     }
3903   }
3904
3905   my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
3906       'batchnum' => $pay_batch->batchnum,
3907       'custnum'  => $self->custnum,
3908   } );
3909
3910   foreach (qw( address1 address2 city state zip country payby payinfo paydate
3911                payname )) {
3912     $options{$_} = '' unless exists($options{$_});
3913   }
3914
3915   my $cust_pay_batch = new FS::cust_pay_batch ( {
3916     'batchnum' => $pay_batch->batchnum,
3917     'invnum'   => $invnum || 0,                    # is there a better value?
3918                                                    # this field should be
3919                                                    # removed...
3920                                                    # cust_bill_pay_batch now
3921     'custnum'  => $self->custnum,
3922     'last'     => $self->getfield('last'),
3923     'first'    => $self->getfield('first'),
3924     'address1' => $options{address1} || $self->address1,
3925     'address2' => $options{address2} || $self->address2,
3926     'city'     => $options{city}     || $self->city,
3927     'state'    => $options{state}    || $self->state,
3928     'zip'      => $options{zip}      || $self->zip,
3929     'country'  => $options{country}  || $self->country,
3930     'payby'    => $options{payby}    || $self->payby,
3931     'payinfo'  => $options{payinfo}  || $self->payinfo,
3932     'exp'      => $options{paydate}  || $self->paydate,
3933     'payname'  => $options{payname}  || $self->payname,
3934     'amount'   => $amount,                         # consolidating
3935   } );
3936
3937   $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
3938     if $old_cust_pay_batch;
3939
3940   my $error;
3941   if ($old_cust_pay_batch) {
3942     $error = $cust_pay_batch->replace($old_cust_pay_batch)
3943   } else {
3944     $error = $cust_pay_batch->insert;
3945   }
3946
3947   if ( $error ) {
3948     $dbh->rollback if $oldAutoCommit;
3949     die $error;
3950   }
3951
3952   my $unapplied = $self->total_credited + $self->total_unapplied_payments + $self->in_transit_payments;
3953   foreach my $cust_bill ($self->open_cust_bill) {
3954     #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
3955     my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
3956       'invnum' => $cust_bill->invnum,
3957       'paybatchnum' => $cust_pay_batch->paybatchnum,
3958       'amount' => $cust_bill->owed,
3959       '_date' => time,
3960     };
3961     if ($unapplied >= $cust_bill_pay_batch->amount){
3962       $unapplied -= $cust_bill_pay_batch->amount;
3963       next;
3964     }else{
3965       $cust_bill_pay_batch->amount(sprintf ( "%.2f",
3966                                    $cust_bill_pay_batch->amount - $unapplied ));      $unapplied = 0;
3967     }
3968     $error = $cust_bill_pay_batch->insert;
3969     if ( $error ) {
3970       $dbh->rollback if $oldAutoCommit;
3971       die $error;
3972     }
3973   }
3974
3975   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3976   '';
3977 }
3978
3979 =item total_owed
3980
3981 Returns the total owed for this customer on all invoices
3982 (see L<FS::cust_bill/owed>).
3983
3984 =cut
3985
3986 sub total_owed {
3987   my $self = shift;
3988   $self->total_owed_date(2145859200); #12/31/2037
3989 }
3990
3991 =item total_owed_date TIME
3992
3993 Returns the total owed for this customer on all invoices with date earlier than
3994 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
3995 see L<Time::Local> and L<Date::Parse> for conversion functions.
3996
3997 =cut
3998
3999 sub total_owed_date {
4000   my $self = shift;
4001   my $time = shift;
4002   my $total_bill = 0;
4003   foreach my $cust_bill (
4004     grep { $_->_date <= $time }
4005       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4006   ) {
4007     $total_bill += $cust_bill->owed;
4008   }
4009   sprintf( "%.2f", $total_bill );
4010 }
4011
4012 =item apply_payments_and_credits
4013
4014 Applies unapplied payments and credits.
4015
4016 In most cases, this new method should be used in place of sequential
4017 apply_payments and apply_credits methods.
4018
4019 If there is an error, returns the error, otherwise returns false.
4020
4021 =cut
4022
4023 sub apply_payments_and_credits {
4024   my $self = shift;
4025
4026   local $SIG{HUP} = 'IGNORE';
4027   local $SIG{INT} = 'IGNORE';
4028   local $SIG{QUIT} = 'IGNORE';
4029   local $SIG{TERM} = 'IGNORE';
4030   local $SIG{TSTP} = 'IGNORE';
4031   local $SIG{PIPE} = 'IGNORE';
4032
4033   my $oldAutoCommit = $FS::UID::AutoCommit;
4034   local $FS::UID::AutoCommit = 0;
4035   my $dbh = dbh;
4036
4037   $self->select_for_update; #mutex
4038
4039   foreach my $cust_bill ( $self->open_cust_bill ) {
4040     my $error = $cust_bill->apply_payments_and_credits;
4041     if ( $error ) {
4042       $dbh->rollback if $oldAutoCommit;
4043       return "Error applying: $error";
4044     }
4045   }
4046
4047   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4048   ''; #no error
4049
4050 }
4051
4052 =item apply_credits OPTION => VALUE ...
4053
4054 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
4055 to outstanding invoice balances in chronological order (or reverse
4056 chronological order if the I<order> option is set to B<newest>) and returns the
4057 value of any remaining unapplied credits available for refund (see
4058 L<FS::cust_refund>).
4059
4060 Dies if there is an error.
4061
4062 =cut
4063
4064 sub apply_credits {
4065   my $self = shift;
4066   my %opt = @_;
4067
4068   local $SIG{HUP} = 'IGNORE';
4069   local $SIG{INT} = 'IGNORE';
4070   local $SIG{QUIT} = 'IGNORE';
4071   local $SIG{TERM} = 'IGNORE';
4072   local $SIG{TSTP} = 'IGNORE';
4073   local $SIG{PIPE} = 'IGNORE';
4074
4075   my $oldAutoCommit = $FS::UID::AutoCommit;
4076   local $FS::UID::AutoCommit = 0;
4077   my $dbh = dbh;
4078
4079   $self->select_for_update; #mutex
4080
4081   unless ( $self->total_credited ) {
4082     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4083     return 0;
4084   }
4085
4086   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
4087       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
4088
4089   my @invoices = $self->open_cust_bill;
4090   @invoices = sort { $b->_date <=> $a->_date } @invoices
4091     if defined($opt{'order'}) && $opt{'order'} eq 'newest';
4092
4093   my $credit;
4094   foreach my $cust_bill ( @invoices ) {
4095     my $amount;
4096
4097     if ( !defined($credit) || $credit->credited == 0) {
4098       $credit = pop @credits or last;
4099     }
4100
4101     if ($cust_bill->owed >= $credit->credited) {
4102       $amount=$credit->credited;
4103     }else{
4104       $amount=$cust_bill->owed;
4105     }
4106
4107     my $cust_credit_bill = new FS::cust_credit_bill ( {
4108       'crednum' => $credit->crednum,
4109       'invnum'  => $cust_bill->invnum,
4110       'amount'  => $amount,
4111     } );
4112     my $error = $cust_credit_bill->insert;
4113     if ( $error ) {
4114       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4115       die $error;
4116     }
4117
4118     redo if ($cust_bill->owed > 0);
4119
4120   }
4121
4122   my $total_credited = $self->total_credited;
4123
4124   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4125
4126   return $total_credited;
4127 }
4128
4129 =item apply_payments
4130
4131 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
4132 to outstanding invoice balances in chronological order.
4133
4134  #and returns the value of any remaining unapplied payments.
4135
4136 Dies if there is an error.
4137
4138 =cut
4139
4140 sub apply_payments {
4141   my $self = shift;
4142
4143   local $SIG{HUP} = 'IGNORE';
4144   local $SIG{INT} = 'IGNORE';
4145   local $SIG{QUIT} = 'IGNORE';
4146   local $SIG{TERM} = 'IGNORE';
4147   local $SIG{TSTP} = 'IGNORE';
4148   local $SIG{PIPE} = 'IGNORE';
4149
4150   my $oldAutoCommit = $FS::UID::AutoCommit;
4151   local $FS::UID::AutoCommit = 0;
4152   my $dbh = dbh;
4153
4154   $self->select_for_update; #mutex
4155
4156   #return 0 unless
4157
4158   my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
4159       qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
4160
4161   my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
4162       qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
4163
4164   my $payment;
4165
4166   foreach my $cust_bill ( @invoices ) {
4167     my $amount;
4168
4169     if ( !defined($payment) || $payment->unapplied == 0 ) {
4170       $payment = pop @payments or last;
4171     }
4172
4173     if ( $cust_bill->owed >= $payment->unapplied ) {
4174       $amount = $payment->unapplied;
4175     } else {
4176       $amount = $cust_bill->owed;
4177     }
4178
4179     my $cust_bill_pay = new FS::cust_bill_pay ( {
4180       'paynum' => $payment->paynum,
4181       'invnum' => $cust_bill->invnum,
4182       'amount' => $amount,
4183     } );
4184     my $error = $cust_bill_pay->insert;
4185     if ( $error ) {
4186       $dbh->rollback or die $dbh->errstr if $oldAutoCommit;
4187       die $error;
4188     }
4189
4190     redo if ( $cust_bill->owed > 0);
4191
4192   }
4193
4194   my $total_unapplied_payments = $self->total_unapplied_payments;
4195
4196   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4197
4198   return $total_unapplied_payments;
4199 }
4200
4201 =item total_credited
4202
4203 Returns the total outstanding credit (see L<FS::cust_credit>) for this
4204 customer.  See L<FS::cust_credit/credited>.
4205
4206 =cut
4207
4208 sub total_credited {
4209   my $self = shift;
4210   my $total_credit = 0;
4211   foreach my $cust_credit ( qsearch('cust_credit', {
4212     'custnum' => $self->custnum,
4213   } ) ) {
4214     $total_credit += $cust_credit->credited;
4215   }
4216   sprintf( "%.2f", $total_credit );
4217 }
4218
4219 =item total_unapplied_payments
4220
4221 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
4222 See L<FS::cust_pay/unapplied>.
4223
4224 =cut
4225
4226 sub total_unapplied_payments {
4227   my $self = shift;
4228   my $total_unapplied = 0;
4229   foreach my $cust_pay ( qsearch('cust_pay', {
4230     'custnum' => $self->custnum,
4231   } ) ) {
4232     $total_unapplied += $cust_pay->unapplied;
4233   }
4234   sprintf( "%.2f", $total_unapplied );
4235 }
4236
4237 =item total_unapplied_refunds
4238
4239 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
4240 customer.  See L<FS::cust_refund/unapplied>.
4241
4242 =cut
4243
4244 sub total_unapplied_refunds {
4245   my $self = shift;
4246   my $total_unapplied = 0;
4247   foreach my $cust_refund ( qsearch('cust_refund', {
4248     'custnum' => $self->custnum,
4249   } ) ) {
4250     $total_unapplied += $cust_refund->unapplied;
4251   }
4252   sprintf( "%.2f", $total_unapplied );
4253 }
4254
4255 =item balance
4256
4257 Returns the balance for this customer (total_owed plus total_unrefunded, minus
4258 total_credited minus total_unapplied_payments).
4259
4260 =cut
4261
4262 sub balance {
4263   my $self = shift;
4264   sprintf( "%.2f",
4265       $self->total_owed
4266     + $self->total_unapplied_refunds
4267     - $self->total_credited
4268     - $self->total_unapplied_payments
4269   );
4270 }
4271
4272 =item balance_date TIME
4273
4274 Returns the balance for this customer, only considering invoices with date
4275 earlier than TIME (total_owed_date minus total_credited minus
4276 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
4277 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
4278 functions.
4279
4280 =cut
4281
4282 sub balance_date {
4283   my $self = shift;
4284   my $time = shift;
4285   sprintf( "%.2f",
4286         $self->total_owed_date($time)
4287       + $self->total_unapplied_refunds
4288       - $self->total_credited
4289       - $self->total_unapplied_payments
4290   );
4291 }
4292
4293 =item in_transit_payments
4294
4295 Returns the total of requests for payments for this customer pending in
4296 batches in transit to the bank.  See L<FS::pay_batch> and L<FS::cust_pay_batch>
4297
4298 =cut
4299
4300 sub in_transit_payments {
4301   my $self = shift;
4302   my $in_transit_payments = 0;
4303   foreach my $pay_batch ( qsearch('pay_batch', {
4304     'status' => 'I',
4305   } ) ) {
4306     foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
4307       'batchnum' => $pay_batch->batchnum,
4308       'custnum' => $self->custnum,
4309     } ) ) {
4310       $in_transit_payments += $cust_pay_batch->amount;
4311     }
4312   }
4313   sprintf( "%.2f", $in_transit_payments );
4314 }
4315
4316 =item paydate_monthyear
4317
4318 Returns a two-element list consisting of the month and year of this customer's
4319 paydate (credit card expiration date for CARD customers)
4320
4321 =cut
4322
4323 sub paydate_monthyear {
4324   my $self = shift;
4325   if ( $self->paydate  =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
4326     ( $2, $1 );
4327   } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
4328     ( $1, $3 );
4329   } else {
4330     ('', '');
4331   }
4332 }
4333
4334 =item invoicing_list [ ARRAYREF ]
4335
4336 If an arguement is given, sets these email addresses as invoice recipients
4337 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
4338 (except as warnings), so use check_invoicing_list first.
4339
4340 Returns a list of email addresses (with svcnum entries expanded).
4341
4342 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
4343 check it without disturbing anything by passing nothing.
4344
4345 This interface may change in the future.
4346
4347 =cut
4348
4349 sub invoicing_list {
4350   my( $self, $arrayref ) = @_;
4351
4352   if ( $arrayref ) {
4353     my @cust_main_invoice;
4354     if ( $self->custnum ) {
4355       @cust_main_invoice =
4356         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4357     } else {
4358       @cust_main_invoice = ();
4359     }
4360     foreach my $cust_main_invoice ( @cust_main_invoice ) {
4361       #warn $cust_main_invoice->destnum;
4362       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
4363         #warn $cust_main_invoice->destnum;
4364         my $error = $cust_main_invoice->delete;
4365         warn $error if $error;
4366       }
4367     }
4368     if ( $self->custnum ) {
4369       @cust_main_invoice =
4370         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4371     } else {
4372       @cust_main_invoice = ();
4373     }
4374     my %seen = map { $_->address => 1 } @cust_main_invoice;
4375     foreach my $address ( @{$arrayref} ) {
4376       next if exists $seen{$address} && $seen{$address};
4377       $seen{$address} = 1;
4378       my $cust_main_invoice = new FS::cust_main_invoice ( {
4379         'custnum' => $self->custnum,
4380         'dest'    => $address,
4381       } );
4382       my $error = $cust_main_invoice->insert;
4383       warn $error if $error;
4384     }
4385   }
4386
4387   if ( $self->custnum ) {
4388     map { $_->address }
4389       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
4390   } else {
4391     ();
4392   }
4393
4394 }
4395
4396 =item check_invoicing_list ARRAYREF
4397
4398 Checks these arguements as valid input for the invoicing_list method.  If there
4399 is an error, returns the error, otherwise returns false.
4400
4401 =cut
4402
4403 sub check_invoicing_list {
4404   my( $self, $arrayref ) = @_;
4405
4406   foreach my $address ( @$arrayref ) {
4407
4408     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
4409       return 'Can\'t add FAX invoice destination with a blank FAX number.';
4410     }
4411
4412     my $cust_main_invoice = new FS::cust_main_invoice ( {
4413       'custnum' => $self->custnum,
4414       'dest'    => $address,
4415     } );
4416     my $error = $self->custnum
4417                 ? $cust_main_invoice->check
4418                 : $cust_main_invoice->checkdest
4419     ;
4420     return $error if $error;
4421
4422   }
4423
4424   return "Email address required"
4425     if $conf->exists('cust_main-require_invoicing_list_email')
4426     && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
4427
4428   '';
4429 }
4430
4431 =item set_default_invoicing_list
4432
4433 Sets the invoicing list to all accounts associated with this customer,
4434 overwriting any previous invoicing list.
4435
4436 =cut
4437
4438 sub set_default_invoicing_list {
4439   my $self = shift;
4440   $self->invoicing_list($self->all_emails);
4441 }
4442
4443 =item all_emails
4444
4445 Returns the email addresses of all accounts provisioned for this customer.
4446
4447 =cut
4448
4449 sub all_emails {
4450   my $self = shift;
4451   my %list;
4452   foreach my $cust_pkg ( $self->all_pkgs ) {
4453     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
4454     my @svc_acct =
4455       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4456         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
4457           @cust_svc;
4458     $list{$_}=1 foreach map { $_->email } @svc_acct;
4459   }
4460   keys %list;
4461 }
4462
4463 =item invoicing_list_addpost
4464
4465 Adds postal invoicing to this customer.  If this customer is already configured
4466 to receive postal invoices, does nothing.
4467
4468 =cut
4469
4470 sub invoicing_list_addpost {
4471   my $self = shift;
4472   return if grep { $_ eq 'POST' } $self->invoicing_list;
4473   my @invoicing_list = $self->invoicing_list;
4474   push @invoicing_list, 'POST';
4475   $self->invoicing_list(\@invoicing_list);
4476 }
4477
4478 =item invoicing_list_emailonly
4479
4480 Returns the list of email invoice recipients (invoicing_list without non-email
4481 destinations such as POST and FAX).
4482
4483 =cut
4484
4485 sub invoicing_list_emailonly {
4486   my $self = shift;
4487   warn "$me invoicing_list_emailonly called"
4488     if $DEBUG;
4489   grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
4490 }
4491
4492 =item invoicing_list_emailonly_scalar
4493
4494 Returns the list of email invoice recipients (invoicing_list without non-email
4495 destinations such as POST and FAX) as a comma-separated scalar.
4496
4497 =cut
4498
4499 sub invoicing_list_emailonly_scalar {
4500   my $self = shift;
4501   warn "$me invoicing_list_emailonly_scalar called"
4502     if $DEBUG;
4503   join(', ', $self->invoicing_list_emailonly);
4504 }
4505
4506 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
4507
4508 Returns an array of customers referred by this customer (referral_custnum set
4509 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
4510 customers referred by customers referred by this customer and so on, inclusive.
4511 The default behavior is DEPTH 1 (no recursion).
4512
4513 =cut
4514
4515 sub referral_cust_main {
4516   my $self = shift;
4517   my $depth = @_ ? shift : 1;
4518   my $exclude = @_ ? shift : {};
4519
4520   my @cust_main =
4521     map { $exclude->{$_->custnum}++; $_; }
4522       grep { ! $exclude->{ $_->custnum } }
4523         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
4524
4525   if ( $depth > 1 ) {
4526     push @cust_main,
4527       map { $_->referral_cust_main($depth-1, $exclude) }
4528         @cust_main;
4529   }
4530
4531   @cust_main;
4532 }
4533
4534 =item referral_cust_main_ncancelled
4535
4536 Same as referral_cust_main, except only returns customers with uncancelled
4537 packages.
4538
4539 =cut
4540
4541 sub referral_cust_main_ncancelled {
4542   my $self = shift;
4543   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
4544 }
4545
4546 =item referral_cust_pkg [ DEPTH ]
4547
4548 Like referral_cust_main, except returns a flat list of all unsuspended (and
4549 uncancelled) packages for each customer.  The number of items in this list may
4550 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
4551
4552 =cut
4553
4554 sub referral_cust_pkg {
4555   my $self = shift;
4556   my $depth = @_ ? shift : 1;
4557
4558   map { $_->unsuspended_pkgs }
4559     grep { $_->unsuspended_pkgs }
4560       $self->referral_cust_main($depth);
4561 }
4562
4563 =item referring_cust_main
4564
4565 Returns the single cust_main record for the customer who referred this customer
4566 (referral_custnum), or false.
4567
4568 =cut
4569
4570 sub referring_cust_main {
4571   my $self = shift;
4572   return '' unless $self->referral_custnum;
4573   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
4574 }
4575
4576 =item credit AMOUNT, REASON
4577
4578 Applies a credit to this customer.  If there is an error, returns the error,
4579 otherwise returns false.
4580
4581 =cut
4582
4583 sub credit {
4584   my( $self, $amount, $reason, %options ) = @_;
4585   my $cust_credit = new FS::cust_credit {
4586     'custnum' => $self->custnum,
4587     'amount'  => $amount,
4588     'reason'  => $reason,
4589   };
4590   $cust_credit->insert(%options);
4591 }
4592
4593 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
4594
4595 Creates a one-time charge for this customer.  If there is an error, returns
4596 the error, otherwise returns false.
4597
4598 =cut
4599
4600 sub charge {
4601   my $self = shift;
4602   my ( $amount, $pkg, $comment, $taxclass, $additional, $classnum );
4603   if ( ref( $_[0] ) ) {
4604     $amount     = $_[0]->{amount};
4605     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
4606     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
4607                                            : '$'. sprintf("%.2f",$amount);
4608     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
4609     $classnum   = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
4610     $additional = $_[0]->{additional};
4611   }else{
4612     $amount     = shift;
4613     $pkg        = @_ ? shift : 'One-time charge';
4614     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
4615     $taxclass   = @_ ? shift : '';
4616     $additional = [];
4617   }
4618
4619   local $SIG{HUP} = 'IGNORE';
4620   local $SIG{INT} = 'IGNORE';
4621   local $SIG{QUIT} = 'IGNORE';
4622   local $SIG{TERM} = 'IGNORE';
4623   local $SIG{TSTP} = 'IGNORE';
4624   local $SIG{PIPE} = 'IGNORE';
4625
4626   my $oldAutoCommit = $FS::UID::AutoCommit;
4627   local $FS::UID::AutoCommit = 0;
4628   my $dbh = dbh;
4629
4630   my $part_pkg = new FS::part_pkg ( {
4631     'pkg'      => $pkg,
4632     'comment'  => $comment,
4633     'plan'     => 'flat',
4634     'freq'     => 0,
4635     'disabled' => 'Y',
4636     'classnum' => $classnum ? $classnum : '',
4637     'taxclass' => $taxclass,
4638   } );
4639
4640   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
4641                         ( 0 .. @$additional - 1 )
4642                   ),
4643                   'additional_count' => scalar(@$additional),
4644                   'setup_fee' => $amount,
4645                 );
4646
4647   my $error = $part_pkg->insert( options => \%options );
4648   if ( $error ) {
4649     $dbh->rollback if $oldAutoCommit;
4650     return $error;
4651   }
4652
4653   my $pkgpart = $part_pkg->pkgpart;
4654   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
4655   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
4656     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
4657     $error = $type_pkgs->insert;
4658     if ( $error ) {
4659       $dbh->rollback if $oldAutoCommit;
4660       return $error;
4661     }
4662   }
4663
4664   my $cust_pkg = new FS::cust_pkg ( {
4665     'custnum' => $self->custnum,
4666     'pkgpart' => $pkgpart,
4667   } );
4668
4669   $error = $cust_pkg->insert;
4670   if ( $error ) {
4671     $dbh->rollback if $oldAutoCommit;
4672     return $error;
4673   }
4674
4675   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4676   '';
4677
4678 }
4679
4680 =item cust_bill
4681
4682 Returns all the invoices (see L<FS::cust_bill>) for this customer.
4683
4684 =cut
4685
4686 sub cust_bill {
4687   my $self = shift;
4688   sort { $a->_date <=> $b->_date }
4689     qsearch('cust_bill', { 'custnum' => $self->custnum, } )
4690 }
4691
4692 =item open_cust_bill
4693
4694 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
4695 customer.
4696
4697 =cut
4698
4699 sub open_cust_bill {
4700   my $self = shift;
4701   grep { $_->owed > 0 } $self->cust_bill;
4702 }
4703
4704 =item cust_credit
4705
4706 Returns all the credits (see L<FS::cust_credit>) for this customer.
4707
4708 =cut
4709
4710 sub cust_credit {
4711   my $self = shift;
4712   sort { $a->_date <=> $b->_date }
4713     qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
4714 }
4715
4716 =item cust_pay
4717
4718 Returns all the payments (see L<FS::cust_pay>) for this customer.
4719
4720 =cut
4721
4722 sub cust_pay {
4723   my $self = shift;
4724   sort { $a->_date <=> $b->_date }
4725     qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
4726 }
4727
4728 =item cust_pay_void
4729
4730 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
4731
4732 =cut
4733
4734 sub cust_pay_void {
4735   my $self = shift;
4736   sort { $a->_date <=> $b->_date }
4737     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
4738 }
4739
4740 =item cust_pay_batch
4741
4742 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
4743
4744 =cut
4745
4746 sub cust_pay_batch {
4747   my $self = shift;
4748   sort { $a->_date <=> $b->_date }
4749     qsearch( 'cust_pay_batch', { 'custnum' => $self->custnum } )
4750 }
4751
4752 =item cust_refund
4753
4754 Returns all the refunds (see L<FS::cust_refund>) for this customer.
4755
4756 =cut
4757
4758 sub cust_refund {
4759   my $self = shift;
4760   sort { $a->_date <=> $b->_date }
4761     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
4762 }
4763
4764 =item name
4765
4766 Returns a name string for this customer, either "Company (Last, First)" or
4767 "Last, First".
4768
4769 =cut
4770
4771 sub name {
4772   my $self = shift;
4773   my $name = $self->contact;
4774   $name = $self->company. " ($name)" if $self->company;
4775   $name;
4776 }
4777
4778 =item ship_name
4779
4780 Returns a name string for this (service/shipping) contact, either
4781 "Company (Last, First)" or "Last, First".
4782
4783 =cut
4784
4785 sub ship_name {
4786   my $self = shift;
4787   if ( $self->get('ship_last') ) {
4788     my $name = $self->ship_contact;
4789     $name = $self->ship_company. " ($name)" if $self->ship_company;
4790     $name;
4791   } else {
4792     $self->name;
4793   }
4794 }
4795
4796 =item contact
4797
4798 Returns this customer's full (billing) contact name only, "Last, First"
4799
4800 =cut
4801
4802 sub contact {
4803   my $self = shift;
4804   $self->get('last'). ', '. $self->first;
4805 }
4806
4807 =item ship_contact
4808
4809 Returns this customer's full (shipping) contact name only, "Last, First"
4810
4811 =cut
4812
4813 sub ship_contact {
4814   my $self = shift;
4815   $self->get('ship_last')
4816     ? $self->get('ship_last'). ', '. $self->ship_first
4817     : $self->contact;
4818 }
4819
4820 =item country_full
4821
4822 Returns this customer's full country name
4823
4824 =cut
4825
4826 sub country_full {
4827   my $self = shift;
4828   code2country($self->country);
4829 }
4830
4831 =item geocode DATA_PROVIDER
4832
4833 Returns a value for the customer location as encoded by DATA_PROVIDER.
4834 Currently this only makes sense for "CCH" as DATA_PROVIDER.
4835
4836 =cut
4837
4838 sub geocode {
4839   my ($self, $data_provider) = (shift, shift);  #always cch for now
4840
4841   my $prefix = ( $conf->exists('tax-ship_address') && length($self->ship_last) )
4842                ? 'ship_'
4843                : '';
4844
4845   my ($zip,$plus4) = split /-/, $self->get("${prefix}zip")
4846     if $self->country eq 'US';
4847
4848   #CCH specific location stuff
4849   my $extra_sql = "AND plus4lo <= '$plus4' AND plus4hi >= '$plus4'";
4850
4851   my $geocode = '';
4852   my $cust_tax_location =
4853     qsearchs( {
4854                 'table'     => 'cust_tax_location',
4855                 'hashref'   => { 'zip' => $zip, 'data_provider' => $data_provider },
4856                 'extra_sql' => $extra_sql,
4857               }
4858             );
4859   $geocode = $cust_tax_location->geocode
4860     if $cust_tax_location;
4861
4862   $geocode;
4863 }
4864
4865 =item cust_status
4866
4867 =item status
4868
4869 Returns a status string for this customer, currently:
4870
4871 =over 4
4872
4873 =item prospect - No packages have ever been ordered
4874
4875 =item active - One or more recurring packages is active
4876
4877 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4878
4879 =item suspended - All non-cancelled recurring packages are suspended
4880
4881 =item cancelled - All recurring packages are cancelled
4882
4883 =back
4884
4885 =cut
4886
4887 sub status { shift->cust_status(@_); }
4888
4889 sub cust_status {
4890   my $self = shift;
4891   for my $status (qw( prospect active inactive suspended cancelled )) {
4892     my $method = $status.'_sql';
4893     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4894     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4895     $sth->execute( ($self->custnum) x $numnum )
4896       or die "Error executing 'SELECT $sql': ". $sth->errstr;
4897     return $status if $sth->fetchrow_arrayref->[0];
4898   }
4899 }
4900
4901 =item ucfirst_cust_status
4902
4903 =item ucfirst_status
4904
4905 Returns the status with the first character capitalized.
4906
4907 =cut
4908
4909 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4910
4911 sub ucfirst_cust_status {
4912   my $self = shift;
4913   ucfirst($self->cust_status);
4914 }
4915
4916 =item statuscolor
4917
4918 Returns a hex triplet color string for this customer's status.
4919
4920 =cut
4921
4922 use vars qw(%statuscolor);
4923 tie my %statuscolor, 'Tie::IxHash',
4924   'prospect'  => '7e0079', #'000000', #black?  naw, purple
4925   'active'    => '00CC00', #green
4926   'inactive'  => '0000CC', #blue
4927   'suspended' => 'FF9900', #yellow
4928   'cancelled' => 'FF0000', #red
4929 ;
4930
4931 sub statuscolor { shift->cust_statuscolor(@_); }
4932
4933 sub cust_statuscolor {
4934   my $self = shift;
4935   $statuscolor{$self->cust_status};
4936 }
4937
4938 =item tickets
4939
4940 Returns an array of hashes representing the customer's RT tickets.
4941
4942 =cut
4943
4944 sub tickets {
4945   my $self = shift;
4946
4947   my $num = $conf->config('cust_main-max_tickets') || 10;
4948   my @tickets = ();
4949
4950   unless ( $conf->config('ticket_system-custom_priority_field') ) {
4951
4952     @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4953
4954   } else {
4955
4956     foreach my $priority (
4957       $conf->config('ticket_system-custom_priority_field-values'), ''
4958     ) {
4959       last if scalar(@tickets) >= $num;
4960       push @tickets,
4961         @{ FS::TicketSystem->customer_tickets( $self->custnum,
4962                                                $num - scalar(@tickets),
4963                                                $priority,
4964                                              )
4965          };
4966     }
4967   }
4968   (@tickets);
4969 }
4970
4971 # Return services representing svc_accts in customer support packages
4972 sub support_services {
4973   my $self = shift;
4974   my %packages = map { $_ => 1 } $conf->config('support_packages');
4975
4976   grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4977     grep { $_->part_svc->svcdb eq 'svc_acct' }
4978     map { $_->cust_svc }
4979     grep { exists $packages{ $_->pkgpart } }
4980     $self->ncancelled_pkgs;
4981
4982 }
4983
4984 =back
4985
4986 =head1 CLASS METHODS
4987
4988 =over 4
4989
4990 =item statuses
4991
4992 Class method that returns the list of possible status strings for customers
4993 (see L<the status method|/status>).  For example:
4994
4995   @statuses = FS::cust_main->statuses();
4996
4997 =cut
4998
4999 sub statuses {
5000   #my $self = shift; #could be class...
5001   keys %statuscolor;
5002 }
5003
5004 =item prospect_sql
5005
5006 Returns an SQL expression identifying prospective cust_main records (customers
5007 with no packages ever ordered)
5008
5009 =cut
5010
5011 use vars qw($select_count_pkgs);
5012 $select_count_pkgs =
5013   "SELECT COUNT(*) FROM cust_pkg
5014     WHERE cust_pkg.custnum = cust_main.custnum";
5015
5016 sub select_count_pkgs_sql {
5017   $select_count_pkgs;
5018 }
5019
5020 sub prospect_sql { "
5021   0 = ( $select_count_pkgs )
5022 "; }
5023
5024 =item active_sql
5025
5026 Returns an SQL expression identifying active cust_main records (customers with
5027 no active recurring packages, but otherwise unsuspended/uncancelled).
5028
5029 =cut
5030
5031 sub active_sql { "
5032   0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
5033       )
5034 "; }
5035
5036 =item inactive_sql
5037
5038 Returns an SQL expression identifying inactive cust_main records (customers with
5039 active recurring packages).
5040
5041 =cut
5042
5043 sub inactive_sql { "
5044   0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
5045   AND
5046   0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
5047 "; }
5048
5049 =item susp_sql
5050 =item suspended_sql
5051
5052 Returns an SQL expression identifying suspended cust_main records.
5053
5054 =cut
5055
5056
5057 sub suspended_sql { susp_sql(@_); }
5058 sub susp_sql { "
5059     0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
5060     AND
5061     0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
5062 "; }
5063
5064 =item cancel_sql
5065 =item cancelled_sql
5066
5067 Returns an SQL expression identifying cancelled cust_main records.
5068
5069 =cut
5070
5071 sub cancelled_sql { cancel_sql(@_); }
5072 sub cancel_sql {
5073
5074   my $recurring_sql = FS::cust_pkg->recurring_sql;
5075   #my $recurring_sql = "
5076   #  '0' != ( select freq from part_pkg
5077   #             where cust_pkg.pkgpart = part_pkg.pkgpart )
5078   #";
5079
5080   "
5081     0 < ( $select_count_pkgs )
5082     AND 0 = ( $select_count_pkgs AND $recurring_sql
5083                   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
5084             )
5085   ";
5086 }
5087
5088 =item uncancel_sql
5089 =item uncancelled_sql
5090
5091 Returns an SQL expression identifying un-cancelled cust_main records.
5092
5093 =cut
5094
5095 sub uncancelled_sql { uncancel_sql(@_); }
5096 sub uncancel_sql { "
5097   ( 0 < ( $select_count_pkgs
5098                    AND ( cust_pkg.cancel IS NULL
5099                          OR cust_pkg.cancel = 0
5100                        )
5101         )
5102     OR 0 = ( $select_count_pkgs )
5103   )
5104 "; }
5105
5106 =item balance_sql
5107
5108 Returns an SQL fragment to retreive the balance.
5109
5110 =cut
5111
5112 sub balance_sql { "
5113     ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
5114         WHERE cust_bill.custnum   = cust_main.custnum     )
5115   - ( SELECT COALESCE( SUM(paid),    0 ) FROM cust_pay
5116         WHERE cust_pay.custnum    = cust_main.custnum     )
5117   - ( SELECT COALESCE( SUM(amount),  0 ) FROM cust_credit
5118         WHERE cust_credit.custnum = cust_main.custnum     )
5119   + ( SELECT COALESCE( SUM(refund),  0 ) FROM cust_refund
5120         WHERE cust_refund.custnum = cust_main.custnum     )
5121 "; }
5122
5123 =item balance_date_sql START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5124
5125 Returns an SQL fragment to retreive the balance for this customer, only
5126 considering invoices with date earlier than START_TIME, and optionally not
5127 later than END_TIME (total_owed_date minus total_credited minus
5128 total_unapplied_payments).
5129
5130 Times are specified as SQL fragments or numeric
5131 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
5132 L<Date::Parse> for conversion functions.  The empty string can be passed
5133 to disable that time constraint completely.
5134
5135 Available options are:
5136
5137 =over 4
5138
5139 =item unapplied_date - set to true to disregard unapplied credits, payments and refunds outside the specified time period - by default the time period restriction only applies to invoices (useful for reporting, probably a bad idea for event triggering)
5140
5141 =item total - set to true to remove all customer comparison clauses, for totals
5142
5143 =item where - WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
5144
5145 =item join - JOIN clause (typically used with the total option)
5146
5147 =item
5148
5149 =back
5150
5151 =cut
5152
5153 sub balance_date_sql {
5154   my( $class, $start, $end, %opt ) = @_;
5155
5156   my $owed         = FS::cust_bill->owed_sql;
5157   my $unapp_refund = FS::cust_refund->unapplied_sql;
5158   my $unapp_credit = FS::cust_credit->unapplied_sql;
5159   my $unapp_pay    = FS::cust_pay->unapplied_sql;
5160
5161   my $j = $opt{'join'} || '';
5162
5163   my $owed_wh   = $class->_money_table_where( 'cust_bill',   $start,$end,%opt );
5164   my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
5165   my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
5166   my $pay_wh    = $class->_money_table_where( 'cust_pay',    $start,$end,%opt );
5167
5168   "   ( SELECT COALESCE(SUM($owed),         0) FROM cust_bill   $j $owed_wh   )
5169     + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
5170     - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
5171     - ( SELECT COALESCE(SUM($unapp_pay),    0) FROM cust_pay    $j $pay_wh    )
5172   ";
5173
5174 }
5175
5176 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
5177
5178 Helper method for balance_date_sql; name (and usage) subject to change
5179 (suggestions welcome).
5180
5181 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
5182 cust_refund, cust_credit or cust_pay).
5183
5184 If TABLE is "cust_bill" or the unapplied_date option is true, only
5185 considers records with date earlier than START_TIME, and optionally not
5186 later than END_TIME .
5187
5188 =cut
5189
5190 sub _money_table_where {
5191   my( $class, $table, $start, $end, %opt ) = @_;
5192
5193   my @where = ();
5194   push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
5195   if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
5196     push @where, "$table._date <= $start" if defined($start) && length($start);
5197     push @where, "$table._date >  $end"   if defined($end)   && length($end);
5198   }
5199   push @where, @{$opt{'where'}} if $opt{'where'};
5200   my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
5201
5202   $where;
5203
5204 }
5205
5206 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
5207
5208 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
5209 records.  Currently, I<first>, I<last> and/or I<company> may be specified (the
5210 appropriate ship_ field is also searched).
5211
5212 Additional options are the same as FS::Record::qsearch
5213
5214 =cut
5215
5216 sub fuzzy_search {
5217   my( $self, $fuzzy, $hash, @opt) = @_;
5218   #$self
5219   $hash ||= {};
5220   my @cust_main = ();
5221
5222   check_and_rebuild_fuzzyfiles();
5223   foreach my $field ( keys %$fuzzy ) {
5224
5225     my $all = $self->all_X($field);
5226     next unless scalar(@$all);
5227
5228     my %match = ();
5229     $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
5230
5231     my @fcust = ();
5232     foreach ( keys %match ) {
5233       push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
5234       push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
5235     }
5236     my %fsaw = ();
5237     push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
5238   }
5239
5240   # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
5241   my %saw = ();
5242   @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
5243
5244   @cust_main;
5245
5246 }
5247
5248 =item masked FIELD
5249
5250 Returns a masked version of the named field
5251
5252 =cut
5253
5254 sub masked {
5255 my ($self,$field) = @_;
5256
5257 # Show last four
5258
5259 'x'x(length($self->getfield($field))-4).
5260   substr($self->getfield($field), (length($self->getfield($field))-4));
5261
5262 }
5263
5264 =back
5265
5266 =head1 SUBROUTINES
5267
5268 =over 4
5269
5270 =item smart_search OPTION => VALUE ...
5271
5272 Accepts the following options: I<search>, the string to search for.  The string
5273 will be searched for as a customer number, phone number, name or company name,
5274 as an exact, or, in some cases, a substring or fuzzy match (see the source code
5275 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
5276 skip fuzzy matching when an exact match is found.
5277
5278 Any additional options are treated as an additional qualifier on the search
5279 (i.e. I<agentnum>).
5280
5281 Returns a (possibly empty) array of FS::cust_main objects.
5282
5283 =cut
5284
5285 sub smart_search {
5286   my %options = @_;
5287
5288   #here is the agent virtualization
5289   my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
5290
5291   my @cust_main = ();
5292
5293   my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
5294   my $search = delete $options{'search'};
5295   ( my $alphanum_search = $search ) =~ s/\W//g;
5296
5297   if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
5298
5299     #false laziness w/Record::ut_phone
5300     my $phonen = "$1-$2-$3";
5301     $phonen .= " x$4" if $4;
5302
5303     push @cust_main, qsearch( {
5304       'table'   => 'cust_main',
5305       'hashref' => { %options },
5306       'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5307                      ' ( '.
5308                          join(' OR ', map "$_ = '$phonen'",
5309                                           qw( daytime night fax
5310                                               ship_daytime ship_night ship_fax )
5311                              ).
5312                      ' ) '.
5313                      " AND $agentnums_sql", #agent virtualization
5314     } );
5315
5316     unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
5317       #try looking for matches with extensions unless one was specified
5318
5319       push @cust_main, qsearch( {
5320         'table'   => 'cust_main',
5321         'hashref' => { %options },
5322         'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
5323                        ' ( '.
5324                            join(' OR ', map "$_ LIKE '$phonen\%'",
5325                                             qw( daytime night
5326                                                 ship_daytime ship_night )
5327                                ).
5328                        ' ) '.
5329                        " AND $agentnums_sql", #agent virtualization
5330       } );
5331
5332     }
5333
5334   # custnum search (also try agent_custid), with some tweaking options if your
5335   # legacy cust "numbers" have letters
5336   } elsif ( $search =~ /^\s*(\d+)\s*$/
5337             || ( $conf->config('cust_main-agent_custid-format') eq 'ww?d+'
5338                  && $search =~ /^\s*(\w\w?\d+)\s*$/
5339                )
5340           )
5341   {
5342
5343     push @cust_main, qsearch( {
5344       'table'     => 'cust_main',
5345       'hashref'   => { 'custnum' => $1, %options },
5346       'extra_sql' => " AND $agentnums_sql", #agent virtualization
5347     } );
5348
5349     push @cust_main, qsearch( {
5350       'table'     => 'cust_main',
5351       'hashref'   => { 'agent_custid' => $1, %options },
5352       'extra_sql' => " AND $agentnums_sql", #agent virtualization
5353     } );
5354
5355   } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
5356
5357     my($company, $last, $first) = ( $1, $2, $3 );
5358
5359     # "Company (Last, First)"
5360     #this is probably something a browser remembered,
5361     #so just do an exact search
5362
5363     foreach my $prefix ( '', 'ship_' ) {
5364       push @cust_main, qsearch( {
5365         'table'     => 'cust_main',
5366         'hashref'   => { $prefix.'first'   => $first,
5367                          $prefix.'last'    => $last,
5368                          $prefix.'company' => $company,
5369                          %options,
5370                        },
5371         'extra_sql' => " AND $agentnums_sql",
5372       } );
5373     }
5374
5375   } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
5376                                               # try (ship_){last,company}
5377
5378     my $value = lc($1);
5379
5380     # # remove "(Last, First)" in "Company (Last, First)", otherwise the
5381     # # full strings the browser remembers won't work
5382     # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
5383
5384     use Lingua::EN::NameParse;
5385     my $NameParse = new Lingua::EN::NameParse(
5386              auto_clean     => 1,
5387              allow_reversed => 1,
5388     );
5389
5390     my($last, $first) = ( '', '' );
5391     #maybe disable this too and just rely on NameParse?
5392     if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
5393
5394       ($last, $first) = ( $1, $2 );
5395
5396     #} elsif  ( $value =~ /^(.+)\s+(.+)$/ ) {
5397     } elsif ( ! $NameParse->parse($value) ) {
5398
5399       my %name = $NameParse->components;
5400       $first = $name{'given_name_1'};
5401       $last  = $name{'surname_1'};
5402
5403     }
5404
5405     if ( $first && $last ) {
5406
5407       my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
5408
5409       #exact
5410       my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5411       $sql .= "
5412         (     ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
5413            OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
5414         )";
5415
5416       push @cust_main, qsearch( {
5417         'table'     => 'cust_main',
5418         'hashref'   => \%options,
5419         'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5420       } );
5421
5422       # or it just be something that was typed in... (try that in a sec)
5423
5424     }
5425
5426     my $q_value = dbh->quote($value);
5427
5428     #exact
5429     my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
5430     $sql .= " (    LOWER(last)         = $q_value
5431                 OR LOWER(company)      = $q_value
5432                 OR LOWER(ship_last)    = $q_value
5433                 OR LOWER(ship_company) = $q_value
5434               )";
5435
5436     push @cust_main, qsearch( {
5437       'table'     => 'cust_main',
5438       'hashref'   => \%options,
5439       'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
5440     } );
5441
5442     #no exact match, trying substring/fuzzy
5443     #always do substring & fuzzy (unless they're explicity config'ed off)
5444     #getting complaints searches are not returning enough
5445     unless ( @cust_main  && $skip_fuzzy || $conf->exists('disable-fuzzy') ) {
5446
5447       #still some false laziness w/ search/cust_main.cgi
5448
5449       #substring
5450
5451       my @hashrefs = (
5452         { 'company'      => { op=>'ILIKE', value=>"%$value%" }, },
5453         { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
5454       );
5455
5456       if ( $first && $last ) {
5457
5458         push @hashrefs,
5459           { 'first'        => { op=>'ILIKE', value=>"%$first%" },
5460             'last'         => { op=>'ILIKE', value=>"%$last%" },
5461           },
5462           { 'ship_first'   => { op=>'ILIKE', value=>"%$first%" },
5463             'ship_last'    => { op=>'ILIKE', value=>"%$last%" },
5464           },
5465         ;
5466
5467       } else {
5468
5469         push @hashrefs,
5470           { 'last'         => { op=>'ILIKE', value=>"%$value%" }, },
5471           { 'ship_last'    => { op=>'ILIKE', value=>"%$value%" }, },
5472         ;
5473       }
5474
5475       foreach my $hashref ( @hashrefs ) {
5476
5477         push @cust_main, qsearch( {
5478           'table'     => 'cust_main',
5479           'hashref'   => { %$hashref,
5480                            %options,
5481                          },
5482           'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
5483         } );
5484
5485       }
5486
5487       #fuzzy
5488       my @fuzopts = (
5489         \%options,                #hashref
5490         '',                       #select
5491         " AND $agentnums_sql",    #extra_sql  #agent virtualization
5492       );
5493
5494       if ( $first && $last ) {
5495         push @cust_main, FS::cust_main->fuzzy_search(
5496           { 'last'   => $last,    #fuzzy hashref
5497             'first'  => $first }, #
5498           @fuzopts
5499         );
5500       }
5501       foreach my $field ( 'last', 'company' ) {
5502         push @cust_main,
5503           FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
5504       }
5505
5506     }
5507
5508     #eliminate duplicates
5509     my %saw = ();
5510     @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5511
5512   }
5513
5514   @cust_main;
5515
5516 }
5517
5518 =item email_search
5519
5520 Accepts the following options: I<email>, the email address to search for.  The
5521 email address will be searched for as an email invoice destination and as an
5522 svc_acct account.
5523
5524 #Any additional options are treated as an additional qualifier on the search
5525 #(i.e. I<agentnum>).
5526
5527 Returns a (possibly empty) array of FS::cust_main objects (but usually just
5528 none or one).
5529
5530 =cut
5531
5532 sub email_search {
5533   my %options = @_;
5534
5535   local($DEBUG) = 1;
5536
5537   my $email = delete $options{'email'};
5538
5539   #we're only being used by RT at the moment... no agent virtualization yet
5540   #my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
5541
5542   my @cust_main = ();
5543
5544   if ( $email =~ /([^@]+)\@([^@]+)/ ) {
5545
5546     my ( $user, $domain ) = ( $1, $2 );
5547
5548     warn "$me smart_search: searching for $user in domain $domain"
5549       if $DEBUG;
5550
5551     push @cust_main,
5552       map $_->cust_main,
5553           qsearch( {
5554                      'table'     => 'cust_main_invoice',
5555                      'hashref'   => { 'dest' => $email },
5556                    }
5557                  );
5558
5559     push @cust_main,
5560       map  $_->cust_main,
5561       grep $_,
5562       map  $_->cust_svc->cust_pkg,
5563           qsearch( {
5564                      'table'     => 'svc_acct',
5565                      'hashref'   => { 'username' => $user, },
5566                      'extra_sql' =>
5567                        'AND ( SELECT domain FROM svc_domain
5568                                 WHERE svc_acct.domsvc = svc_domain.svcnum
5569                             ) = '. dbh->quote($domain),
5570                    }
5571                  );
5572   }
5573
5574   my %saw = ();
5575   @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
5576
5577   warn "$me smart_search: found ". scalar(@cust_main). " unique customers"
5578     if $DEBUG;
5579
5580   @cust_main;
5581
5582 }
5583
5584 =item check_and_rebuild_fuzzyfiles
5585
5586 =cut
5587
5588 use vars qw(@fuzzyfields);
5589 @fuzzyfields = ( 'last', 'first', 'company' );
5590
5591 sub check_and_rebuild_fuzzyfiles {
5592   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5593   rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
5594 }
5595
5596 =item rebuild_fuzzyfiles
5597
5598 =cut
5599
5600 sub rebuild_fuzzyfiles {
5601
5602   use Fcntl qw(:flock);
5603
5604   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5605   mkdir $dir, 0700 unless -d $dir;
5606
5607   foreach my $fuzzy ( @fuzzyfields ) {
5608
5609     open(LOCK,">>$dir/cust_main.$fuzzy")
5610       or die "can't open $dir/cust_main.$fuzzy: $!";
5611     flock(LOCK,LOCK_EX)
5612       or die "can't lock $dir/cust_main.$fuzzy: $!";
5613
5614     open (CACHE,">$dir/cust_main.$fuzzy.tmp")
5615       or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
5616
5617     foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
5618       my $sth = dbh->prepare("SELECT $field FROM cust_main".
5619                              " WHERE $field != '' AND $field IS NOT NULL");
5620       $sth->execute or die $sth->errstr;
5621
5622       while ( my $row = $sth->fetchrow_arrayref ) {
5623         print CACHE $row->[0]. "\n";
5624       }
5625
5626     }
5627
5628     close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
5629
5630     rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
5631     close LOCK;
5632   }
5633
5634 }
5635
5636 =item all_X
5637
5638 =cut
5639
5640 sub all_X {
5641   my( $self, $field ) = @_;
5642   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5643   open(CACHE,"<$dir/cust_main.$field")
5644     or die "can't open $dir/cust_main.$field: $!";
5645   my @array = map { chomp; $_; } <CACHE>;
5646   close CACHE;
5647   \@array;
5648 }
5649
5650 =item append_fuzzyfiles LASTNAME COMPANY
5651
5652 =cut
5653
5654 sub append_fuzzyfiles {
5655   #my( $first, $last, $company ) = @_;
5656
5657   &check_and_rebuild_fuzzyfiles;
5658
5659   use Fcntl qw(:flock);
5660
5661   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
5662
5663   foreach my $field (qw( first last company )) {
5664     my $value = shift;
5665
5666     if ( $value ) {
5667
5668       open(CACHE,">>$dir/cust_main.$field")
5669         or die "can't open $dir/cust_main.$field: $!";
5670       flock(CACHE,LOCK_EX)
5671         or die "can't lock $dir/cust_main.$field: $!";
5672
5673       print CACHE "$value\n";
5674
5675       flock(CACHE,LOCK_UN)
5676         or die "can't unlock $dir/cust_main.$field: $!";
5677       close CACHE;
5678     }
5679
5680   }
5681
5682   1;
5683 }
5684
5685 =item batch_import
5686
5687 =cut
5688
5689 sub batch_import {
5690   my $param = shift;
5691   #warn join('-',keys %$param);
5692   my $fh = $param->{filehandle};
5693   my $agentnum = $param->{agentnum};
5694
5695   my $refnum = $param->{refnum};
5696   my $pkgpart = $param->{pkgpart};
5697
5698   #my @fields = @{$param->{fields}};
5699   my $format = $param->{'format'};
5700   my @fields;
5701   my $payby;
5702   if ( $format eq 'simple' ) {
5703     @fields = qw( cust_pkg.setup dayphone first last
5704                   address1 address2 city state zip comments );
5705     $payby = 'BILL';
5706   } elsif ( $format eq 'extended' ) {
5707     @fields = qw( agent_custid refnum
5708                   last first address1 address2 city state zip country
5709                   daytime night
5710                   ship_last ship_first ship_address1 ship_address2
5711                   ship_city ship_state ship_zip ship_country
5712                   payinfo paycvv paydate
5713                   invoicing_list
5714                   cust_pkg.pkgpart
5715                   svc_acct.username svc_acct._password
5716                 );
5717     $payby = 'BILL';
5718  } elsif ( $format eq 'extended-plus_company' ) {
5719     @fields = qw( agent_custid refnum
5720                   last first company address1 address2 city state zip country
5721                   daytime night
5722                   ship_last ship_first ship_company ship_address1 ship_address2
5723                   ship_city ship_state ship_zip ship_country
5724                   payinfo paycvv paydate
5725                   invoicing_list
5726                   cust_pkg.pkgpart
5727                   svc_acct.username svc_acct._password
5728                 );
5729     $payby = 'BILL';
5730   } else {
5731     die "unknown format $format";
5732   }
5733
5734   eval "use Text::CSV_XS;";
5735   die $@ if $@;
5736
5737   my $csv = new Text::CSV_XS;
5738   #warn $csv;
5739   #warn $fh;
5740
5741   my $imported = 0;
5742   #my $columns;
5743
5744   local $SIG{HUP} = 'IGNORE';
5745   local $SIG{INT} = 'IGNORE';
5746   local $SIG{QUIT} = 'IGNORE';
5747   local $SIG{TERM} = 'IGNORE';
5748   local $SIG{TSTP} = 'IGNORE';
5749   local $SIG{PIPE} = 'IGNORE';
5750
5751   my $oldAutoCommit = $FS::UID::AutoCommit;
5752   local $FS::UID::AutoCommit = 0;
5753   my $dbh = dbh;
5754
5755   #while ( $columns = $csv->getline($fh) ) {
5756   my $line;
5757   while ( defined($line=<$fh>) ) {
5758
5759     $csv->parse($line) or do {
5760       $dbh->rollback if $oldAutoCommit;
5761       return "can't parse: ". $csv->error_input();
5762     };
5763
5764     my @columns = $csv->fields();
5765     #warn join('-',@columns);
5766
5767     my %cust_main = (
5768       agentnum => $agentnum,
5769       refnum   => $refnum,
5770       country  => $conf->config('countrydefault') || 'US',
5771       payby    => $payby, #default
5772       paydate  => '12/2037', #default
5773     );
5774     my $billtime = time;
5775     my %cust_pkg = ( pkgpart => $pkgpart );
5776     my %svc_acct = ();
5777     foreach my $field ( @fields ) {
5778
5779       if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|adjourn|expire|cancel)$/ ) {
5780
5781         #$cust_pkg{$1} = str2time( shift @$columns );
5782         if ( $1 eq 'pkgpart' ) {
5783           $cust_pkg{$1} = shift @columns;
5784         } elsif ( $1 eq 'setup' ) {
5785           $billtime = str2time(shift @columns);
5786         } else {
5787           $cust_pkg{$1} = str2time( shift @columns );
5788         }
5789
5790       } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
5791
5792         $svc_acct{$1} = shift @columns;
5793
5794       } else {
5795
5796         #refnum interception
5797         if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
5798
5799           my $referral = $columns[0];
5800           my %hash = ( 'referral' => $referral,
5801                        'agentnum' => $agentnum,
5802                        'disabled' => '',
5803                      );
5804
5805           my $part_referral = qsearchs('part_referral', \%hash )
5806                               || new FS::part_referral \%hash;
5807
5808           unless ( $part_referral->refnum ) {
5809             my $error = $part_referral->insert;
5810             if ( $error ) {
5811               $dbh->rollback if $oldAutoCommit;
5812               return "can't auto-insert advertising source: $referral: $error";
5813             }
5814           }
5815
5816           $columns[0] = $part_referral->refnum;
5817         }
5818
5819         #$cust_main{$field} = shift @$columns;
5820         $cust_main{$field} = shift @columns;
5821       }
5822     }
5823
5824     $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
5825
5826     my $invoicing_list = $cust_main{'invoicing_list'}
5827                            ? [ delete $cust_main{'invoicing_list'} ]
5828                            : [];
5829
5830     my $cust_main = new FS::cust_main ( \%cust_main );
5831
5832     use Tie::RefHash;
5833     tie my %hash, 'Tie::RefHash'; #this part is important
5834
5835     if ( $cust_pkg{'pkgpart'} ) {
5836       my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
5837
5838       my @svc_acct = ();
5839       if ( $svc_acct{'username'} ) {
5840         my $part_pkg = $cust_pkg->part_pkg;
5841         unless ( $part_pkg ) {
5842           $dbh->rollback if $oldAutoCommit;
5843           return "unknown pkgpart: ". $cust_pkg{'pkgpart'};
5844         }
5845         $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
5846         push @svc_acct, new FS::svc_acct ( \%svc_acct )
5847       }
5848
5849       $hash{$cust_pkg} = \@svc_acct;
5850     }
5851
5852     my $error = $cust_main->insert( \%hash, $invoicing_list );
5853
5854     if ( $error ) {
5855       $dbh->rollback if $oldAutoCommit;
5856       return "can't insert customer for $line: $error";
5857     }
5858
5859     if ( $format eq 'simple' ) {
5860
5861       #false laziness w/bill.cgi
5862       $error = $cust_main->bill( 'time' => $billtime );
5863       if ( $error ) {
5864         $dbh->rollback if $oldAutoCommit;
5865         return "can't bill customer for $line: $error";
5866       }
5867
5868       $error = $cust_main->apply_payments_and_credits;
5869       if ( $error ) {
5870         $dbh->rollback if $oldAutoCommit;
5871         return "can't bill customer for $line: $error";
5872       }
5873
5874       $error = $cust_main->collect();
5875       if ( $error ) {
5876         $dbh->rollback if $oldAutoCommit;
5877         return "can't collect customer for $line: $error";
5878       }
5879
5880     }
5881
5882     $imported++;
5883   }
5884
5885   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5886
5887   return "Empty file!" unless $imported;
5888
5889   ''; #no error
5890
5891 }
5892
5893 =item batch_charge
5894
5895 =cut
5896
5897 sub batch_charge {
5898   my $param = shift;
5899   #warn join('-',keys %$param);
5900   my $fh = $param->{filehandle};
5901   my @fields = @{$param->{fields}};
5902
5903   eval "use Text::CSV_XS;";
5904   die $@ if $@;
5905
5906   my $csv = new Text::CSV_XS;
5907   #warn $csv;
5908   #warn $fh;
5909
5910   my $imported = 0;
5911   #my $columns;
5912
5913   local $SIG{HUP} = 'IGNORE';
5914   local $SIG{INT} = 'IGNORE';
5915   local $SIG{QUIT} = 'IGNORE';
5916   local $SIG{TERM} = 'IGNORE';
5917   local $SIG{TSTP} = 'IGNORE';
5918   local $SIG{PIPE} = 'IGNORE';
5919
5920   my $oldAutoCommit = $FS::UID::AutoCommit;
5921   local $FS::UID::AutoCommit = 0;
5922   my $dbh = dbh;
5923
5924   #while ( $columns = $csv->getline($fh) ) {
5925   my $line;
5926   while ( defined($line=<$fh>) ) {
5927
5928     $csv->parse($line) or do {
5929       $dbh->rollback if $oldAutoCommit;
5930       return "can't parse: ". $csv->error_input();
5931     };
5932
5933     my @columns = $csv->fields();
5934     #warn join('-',@columns);
5935
5936     my %row = ();
5937     foreach my $field ( @fields ) {
5938       $row{$field} = shift @columns;
5939     }
5940
5941     my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
5942     unless ( $cust_main ) {
5943       $dbh->rollback if $oldAutoCommit;
5944       return "unknown custnum $row{'custnum'}";
5945     }
5946
5947     if ( $row{'amount'} > 0 ) {
5948       my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
5949       if ( $error ) {
5950         $dbh->rollback if $oldAutoCommit;
5951         return $error;
5952       }
5953       $imported++;
5954     } elsif ( $row{'amount'} < 0 ) {
5955       my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
5956                                       $row{'pkg'}                         );
5957       if ( $error ) {
5958         $dbh->rollback if $oldAutoCommit;
5959         return $error;
5960       }
5961       $imported++;
5962     } else {
5963       #hmm?
5964     }
5965
5966   }
5967
5968   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
5969
5970   return "Empty file!" unless $imported;
5971
5972   ''; #no error
5973
5974 }
5975
5976 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
5977
5978 Sends a templated email notification to the customer (see L<Text::Template>).
5979
5980 OPTIONS is a hash and may include
5981
5982 I<from> - the email sender (default is invoice_from)
5983
5984 I<to> - comma-separated scalar or arrayref of recipients
5985    (default is invoicing_list)
5986
5987 I<subject> - The subject line of the sent email notification
5988    (default is "Notice from company_name")
5989
5990 I<extra_fields> - a hashref of name/value pairs which will be substituted
5991    into the template
5992
5993 The following variables are vavailable in the template.
5994
5995 I<$first> - the customer first name
5996 I<$last> - the customer last name
5997 I<$company> - the customer company
5998 I<$payby> - a description of the method of payment for the customer
5999             # would be nice to use FS::payby::shortname
6000 I<$payinfo> - the account information used to collect for this customer
6001 I<$expdate> - the expiration of the customer payment in seconds from epoch
6002
6003 =cut
6004
6005 sub notify {
6006   my ($customer, $template, %options) = @_;
6007
6008   return unless $conf->exists($template);
6009
6010   my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
6011   $from = $options{from} if exists($options{from});
6012
6013   my $to = join(',', $customer->invoicing_list_emailonly);
6014   $to = $options{to} if exists($options{to});
6015
6016   my $subject = "Notice from " . $conf->config('company_name')
6017     if $conf->exists('company_name');
6018   $subject = $options{subject} if exists($options{subject});
6019
6020   my $notify_template = new Text::Template (TYPE => 'ARRAY',
6021                                             SOURCE => [ map "$_\n",
6022                                               $conf->config($template)]
6023                                            )
6024     or die "can't create new Text::Template object: Text::Template::ERROR";
6025   $notify_template->compile()
6026     or die "can't compile template: Text::Template::ERROR";
6027
6028   $FS::notify_template::_template::company_name = $conf->config('company_name');
6029   $FS::notify_template::_template::company_address =
6030     join("\n", $conf->config('company_address') ). "\n";
6031
6032   my $paydate = $customer->paydate || '2037-12-31';
6033   $FS::notify_template::_template::first = $customer->first;
6034   $FS::notify_template::_template::last = $customer->last;
6035   $FS::notify_template::_template::company = $customer->company;
6036   $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
6037   my $payby = $customer->payby;
6038   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6039   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6040
6041   #credit cards expire at the end of the month/year of their exp date
6042   if ($payby eq 'CARD' || $payby eq 'DCRD') {
6043     $FS::notify_template::_template::payby = 'credit card';
6044     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6045     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6046     $expire_time--;
6047   }elsif ($payby eq 'COMP') {
6048     $FS::notify_template::_template::payby = 'complimentary account';
6049   }else{
6050     $FS::notify_template::_template::payby = 'current method';
6051   }
6052   $FS::notify_template::_template::expdate = $expire_time;
6053
6054   for (keys %{$options{extra_fields}}){
6055     no strict "refs";
6056     ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
6057   }
6058
6059   send_email(from => $from,
6060              to => $to,
6061              subject => $subject,
6062              body => $notify_template->fill_in( PACKAGE =>
6063                                                 'FS::notify_template::_template'                                              ),
6064             );
6065
6066 }
6067
6068 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
6069
6070 Generates a templated notification to the customer (see L<Text::Template>).
6071
6072 OPTIONS is a hash and may include
6073
6074 I<extra_fields> - a hashref of name/value pairs which will be substituted
6075    into the template.  These values may override values mentioned below
6076    and those from the customer record.
6077
6078 The following variables are available in the template instead of or in addition
6079 to the fields of the customer record.
6080
6081 I<$payby> - a description of the method of payment for the customer
6082             # would be nice to use FS::payby::shortname
6083 I<$payinfo> - the masked account information used to collect for this customer
6084 I<$expdate> - the expiration of the customer payment method in seconds from epoch
6085 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
6086
6087 =cut
6088
6089 sub generate_letter {
6090   my ($self, $template, %options) = @_;
6091
6092   return unless $conf->exists($template);
6093
6094   my $letter_template = new Text::Template
6095                         ( TYPE       => 'ARRAY',
6096                           SOURCE     => [ map "$_\n", $conf->config($template)],
6097                           DELIMITERS => [ '[@--', '--@]' ],
6098                         )
6099     or die "can't create new Text::Template object: Text::Template::ERROR";
6100
6101   $letter_template->compile()
6102     or die "can't compile template: Text::Template::ERROR";
6103
6104   my %letter_data = map { $_ => $self->$_ } $self->fields;
6105   $letter_data{payinfo} = $self->mask_payinfo;
6106
6107   #my $paydate = $self->paydate || '2037-12-31';
6108   my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
6109
6110   my $payby = $self->payby;
6111   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
6112   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
6113
6114   #credit cards expire at the end of the month/year of their exp date
6115   if ($payby eq 'CARD' || $payby eq 'DCRD') {
6116     $letter_data{payby} = 'credit card';
6117     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
6118     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
6119     $expire_time--;
6120   }elsif ($payby eq 'COMP') {
6121     $letter_data{payby} = 'complimentary account';
6122   }else{
6123     $letter_data{payby} = 'current method';
6124   }
6125   $letter_data{expdate} = $expire_time;
6126
6127   for (keys %{$options{extra_fields}}){
6128     $letter_data{$_} = $options{extra_fields}->{$_};
6129   }
6130
6131   unless(exists($letter_data{returnaddress})){
6132     my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
6133                                                   $self->agent_template)
6134                      );
6135     if ( length($retadd) ) {
6136       $letter_data{returnaddress} = $retadd;
6137     } elsif ( grep /\S/, $conf->config('company_address') ) {
6138       $letter_data{returnaddress} =
6139         join( '\\*'."\n", map s/( {2,})/'~' x length($1)/eg,
6140                           $conf->config('company_address')
6141         );
6142     } else {
6143       $letter_data{returnaddress} = '~';
6144     }
6145   }
6146
6147   $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
6148
6149   $letter_data{company_name} = $conf->config('company_name');
6150
6151   my $dir = $FS::UID::conf_dir."cache.". $FS::UID::datasrc;
6152   my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
6153                            DIR      => $dir,
6154                            SUFFIX   => '.tex',
6155                            UNLINK   => 0,
6156                          ) or die "can't open temp file: $!\n";
6157
6158   $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
6159   close $fh;
6160   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
6161   return $1;
6162 }
6163
6164 =item print_ps TEMPLATE
6165
6166 Returns an postscript letter filled in from TEMPLATE, as a scalar.
6167
6168 =cut
6169
6170 sub print_ps {
6171   my $self = shift;
6172   my $file = $self->generate_letter(@_);
6173   FS::Misc::generate_ps($file);
6174 }
6175
6176 =item print TEMPLATE
6177
6178 Prints the filled in template.
6179
6180 TEMPLATE is the name of a L<Text::Template> to fill in and print.
6181
6182 =cut
6183
6184 sub queueable_print {
6185   my %opt = @_;
6186
6187   my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
6188     or die "invalid customer number: " . $opt{custvnum};
6189
6190   my $error = $self->print( $opt{template} );
6191   die $error if $error;
6192 }
6193
6194 sub print {
6195   my ($self, $template) = (shift, shift);
6196   do_print [ $self->print_ps($template) ];
6197 }
6198
6199 sub agent_template {
6200   my $self = shift;
6201   $self->_agent_plandata('agent_templatename');
6202 }
6203
6204 sub agent_invoice_from {
6205   my $self = shift;
6206   $self->_agent_plandata('agent_invoice_from');
6207 }
6208
6209 sub _agent_plandata {
6210   my( $self, $option ) = @_;
6211
6212   #yuck.  this whole thing needs to be reconciled better with 1.9's idea of
6213   #agent-specific Conf
6214
6215   use FS::part_event::Condition;
6216
6217   my $agentnum = $self->agentnum;
6218
6219   my $regexp = '';
6220   if ( driver_name =~ /^Pg/i ) {
6221     $regexp = '~';
6222   } elsif ( driver_name =~ /^mysql/i ) {
6223     $regexp = 'REGEXP';
6224   } else {
6225     die "don't know how to use regular expressions in ". driver_name. " databases";
6226   }
6227
6228   my $part_event_option =
6229     qsearchs({
6230       'select'    => 'part_event_option.*',
6231       'table'     => 'part_event_option',
6232       'addl_from' => q{
6233         LEFT JOIN part_event USING ( eventpart )
6234         LEFT JOIN part_event_option AS peo_agentnum
6235           ON ( part_event.eventpart = peo_agentnum.eventpart
6236                AND peo_agentnum.optionname = 'agentnum'
6237                AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
6238              )
6239         LEFT JOIN part_event_option AS peo_cust_bill_age
6240           ON ( part_event.eventpart = peo_cust_bill_age.eventpart
6241                AND peo_cust_bill_age.optionname = 'cust_bill_age'
6242              )
6243       },
6244       #'hashref'   => { 'optionname' => $option },
6245       #'hashref'   => { 'part_event_option.optionname' => $option },
6246       'extra_sql' =>
6247         " WHERE part_event_option.optionname = ". dbh->quote($option).
6248         " AND action = 'cust_bill_send_agent' ".
6249         " AND ( disabled IS NULL OR disabled != 'Y' ) ".
6250         " AND peo_agentnum.optionname = 'agentnum' ".
6251         " AND agentnum IS NULL OR agentnum = $agentnum ".
6252         " ORDER BY
6253            CASE WHEN peo_cust_bill_age.optionname != 'cust_bill_age'
6254            THEN -1
6255            ELSE ". FS::part_event::Condition->age2seconds_sql('peo_cust_bill_age.optionvalue').
6256         " END
6257           , part_event.weight".
6258         " LIMIT 1"
6259     });
6260
6261   unless ( $part_event_option ) {
6262     return $self->agent->invoice_template || ''
6263       if $option eq 'agent_templatename';
6264     return '';
6265   }
6266
6267   $part_event_option->optionvalue;
6268
6269 }
6270
6271 sub queued_bill {
6272   ## actual sub, not a method, designed to be called from the queue.
6273   ## sets up the customer, and calls the bill_and_collect
6274   my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
6275   my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
6276       $cust_main->bill_and_collect(
6277         %args,
6278       );
6279 }
6280
6281 =back
6282
6283 =head1 BUGS
6284
6285 The delete method.
6286
6287 The delete method should possibly take an FS::cust_main object reference
6288 instead of a scalar customer number.
6289
6290 Bill and collect options should probably be passed as references instead of a
6291 list.
6292
6293 There should probably be a configuration file with a list of allowed credit
6294 card types.
6295
6296 No multiple currency support (probably a larger project than just this module).
6297
6298 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
6299
6300 Birthdates rely on negative epoch values.
6301
6302 The payby for card/check batches is broken.  With mixed batching, bad
6303 things will happen.
6304
6305 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
6306
6307 =head1 SEE ALSO
6308
6309 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
6310 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
6311 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
6312
6313 =cut
6314
6315 1;
6316