FS/FS/cust_main.pm

   1 package FS::cust_main;
   2
   3 use strict;
   4 use vars qw( @ISA @EXPORT_OK $DEBUG $me $conf @encrypted_fields
   5              $import $skip_fuzzyfiles $ignore_expired_card @paytypes);
   6 use vars qw( $realtime_bop_decline_quiet ); #ugh
   7 use Safe;
   8 use Carp;
   9 use Exporter;
  10 BEGIN {
  11   eval "use Time::Local;";
  12   die "Time::Local minimum version 1.05 required with Perl versions before 5.6"
  13     if $] < 5.006 && !defined($Time::Local::VERSION);
  14   #eval "use Time::Local qw(timelocal timelocal_nocheck);";
  15   eval "use Time::Local qw(timelocal_nocheck);";
  16 }
  17 use Digest::MD5 qw(md5_base64);
  18 use Date::Format;
  19 use Date::Parse;
  20 #use Date::Manip;
  21 use String::Approx qw(amatch);
  22 use Business::CreditCard 0.28;
  23 use Locale::Country;
  24 use Data::Dumper;
  25 use FS::UID qw( getotaker dbh );
  26 use FS::Record qw( qsearchs qsearch dbdef );
  27 use FS::Misc qw( send_email );
  28 use FS::Msgcat qw(gettext);
  29 use FS::cust_pkg;
  30 use FS::cust_svc;
  31 use FS::cust_bill;
  32 use FS::cust_bill_pkg;
  33 use FS::cust_pay;
  34 use FS::cust_pay_void;
  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_bill_event qw(due_events);
  47 use FS::cust_bill_event;
  48 use FS::cust_tax_exempt;
  49 use FS::cust_tax_exempt_pkg;
  50 use FS::type_pkgs;
  51 use FS::payment_gateway;
  52 use FS::agent_payment_gateway;
  53 use FS::banned_pay;
  54 use FS::payinfo_Mixin;
  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     }
 355     $self->invoicing_list( $invoicing_list );
 356   }
 357
 358   if (    $conf->config('cust_main-skeleton_tables')
 359        && $conf->config('cust_main-skeleton_custnum') ) {
 360
 361     warn "  inserting skeleton records\n"
 362       if $DEBUG > 1;
 363
 364     my $error = $self->start_copy_skel;
 365     if ( $error ) {
 366       $dbh->rollback if $oldAutoCommit;
 367       return $error;
 368     }
 369
 370   }
 371
 372   warn "  ordering packages\n"
 373     if $DEBUG > 1;
 374
 375   $error = $self->order_pkgs($cust_pkgs, \$seconds, %options);
 376   if ( $error ) {
 377     $dbh->rollback if $oldAutoCommit;
 378     return $error;
 379   }
 380
 381   if ( $seconds ) {
 382     $dbh->rollback if $oldAutoCommit;
 383     return "No svc_acct record to apply pre-paid time";
 384   }
 385
 386   if ( $amount ) {
 387     warn "  inserting initial $payby payment of $amount\n"
 388       if $DEBUG > 1;
 389     $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
 390     if ( $error ) {
 391       $dbh->rollback if $oldAutoCommit;
 392       return "inserting payment (transaction rolled back): $error";
 393     }
 394   }
 395
 396   unless ( $import || $skip_fuzzyfiles ) {
 397     warn "  queueing fuzzyfiles update\n"
 398       if $DEBUG > 1;
 399     $error = $self->queue_fuzzyfiles_update;
 400     if ( $error ) {
 401       $dbh->rollback if $oldAutoCommit;
 402       return "updating fuzzy search cache: $error";
 403     }
 404   }
 405
 406   warn "  insert complete; committing transaction\n"
 407     if $DEBUG > 1;
 408
 409   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 410   '';
 411
 412 }
 413
 414 sub start_copy_skel {
 415   my $self = shift;
 416
 417   #'mg_user_preference' => {},
 418   #'mg_user_indicator_profile.user_indicator_profile_id' => { 'mg_profile_indicator.profile_indicator_id' => { 'mg_profile_details.profile_detail_id' }, },
 419   #'mg_watchlist_header.watchlist_header_id' => { 'mg_watchlist_details.watchlist_details_id' },
 420   #'mg_user_grid_header.grid_header_id' => { 'mg_user_grid_details.user_grid_details_id' },
 421   #'mg_portfolio_header.portfolio_header_id' => { 'mg_portfolio_trades.portfolio_trades_id' => { 'mg_portfolio_trades_positions.portfolio_trades_positions_id' } },
 422   my @tables = eval(join('\n',$conf->config('cust_main-skeleton_tables')));
 423   die $@ if $@;
 424
 425   _copy_skel( 'cust_main',                                 #tablename
 426               $conf->config('cust_main-skeleton_custnum'), #sourceid
 427               $self->custnum,                              #destid
 428               @tables,                                     #child tables
 429             );
 430 }
 431
 432 #recursive subroutine, not a method
 433 sub _copy_skel {
 434   my( $table, $sourceid, $destid, %child_tables ) = @_;
 435
 436   my $primary_key;
 437   if ( $table =~ /^(\w+)\.(\w+)$/ ) {
 438     ( $table, $primary_key ) = ( $1, $2 );
 439   } else {
 440     my $dbdef_table = dbdef->table($table);
 441     $primary_key = $dbdef_table->primary_key
 442       or return "$table has no primary key".
 443                 " (or do you need to run dbdef-create?)";
 444   }
 445
 446   warn "  _copy_skel: $table.$primary_key $sourceid to $destid for ".
 447        join (', ', keys %child_tables). "\n"
 448     if $DEBUG > 2;
 449
 450   foreach my $child_table_def ( keys %child_tables ) {
 451
 452     my $child_table;
 453     my $child_pkey = '';
 454     if ( $child_table_def =~ /^(\w+)\.(\w+)$/ ) {
 455       ( $child_table, $child_pkey ) = ( $1, $2 );
 456     } else {
 457       $child_table = $child_table_def;
 458
 459       $child_pkey = dbdef->table($child_table)->primary_key;
 460       #  or return "$table has no primary key".
 461       #            " (or do you need to run dbdef-create?)\n";
 462     }
 463
 464     my $sequence = '';
 465     if ( keys %{ $child_tables{$child_table_def} } ) {
 466
 467       return "$child_table has no primary key".
 468              " (run dbdef-create or try specifying it?)\n"
 469         unless $child_pkey;
 470
 471       #false laziness w/Record::insert and only works on Pg
 472       #refactor the proper last-inserted-id stuff out of Record::insert if this
 473       # ever gets use for anything besides a quick kludge for one customer
 474       my $default = dbdef->table($child_table)->column($child_pkey)->default;
 475       $default =~ /^nextval\(\(?'"?([\w\.]+)"?'/i
 476         or return "can't parse $child_table.$child_pkey default value ".
 477                   " for sequence name: $default";
 478       $sequence = $1;
 479
 480     }
 481
 482     my @sel_columns = grep { $_ ne $primary_key }
 483                            dbdef->table($child_table)->columns;
 484     my $sel_columns = join(', ', @sel_columns );
 485
 486     my @ins_columns = grep { $_ ne $child_pkey } @sel_columns;
 487     my $ins_columns = ' ( '. join(', ', $primary_key, @ins_columns ). ' ) ';
 488     my $placeholders = ' ( ?, '. join(', ', map '?', @ins_columns ). ' ) ';
 489
 490     my $sel_st = "SELECT $sel_columns FROM $child_table".
 491                  " WHERE $primary_key = $sourceid";
 492     warn "    $sel_st\n"
 493       if $DEBUG > 2;
 494     my $sel_sth = dbh->prepare( $sel_st )
 495       or return dbh->errstr;
 496
 497     $sel_sth->execute or return $sel_sth->errstr;
 498
 499     while ( my $row = $sel_sth->fetchrow_hashref ) {
 500
 501       warn "    selected row: ".
 502            join(', ', map { "$_=".$row->{$_} } keys %$row ). "\n"
 503         if $DEBUG > 2;
 504
 505       my $statement =
 506         "INSERT INTO $child_table $ins_columns VALUES $placeholders";
 507       my $ins_sth =dbh->prepare($statement)
 508           or return dbh->errstr;
 509       my @param = ( $destid, map $row->{$_}, @ins_columns );
 510       warn "    $statement: [ ". join(', ', @param). " ]\n"
 511         if $DEBUG > 2;
 512       $ins_sth->execute( @param )
 513         or return $ins_sth->errstr;
 514
 515       #next unless keys %{ $child_tables{$child_table} };
 516       next unless $sequence;
 517
 518       #another section of that laziness
 519       my $seq_sql = "SELECT currval('$sequence')";
 520       my $seq_sth = dbh->prepare($seq_sql) or return dbh->errstr;
 521       $seq_sth->execute or return $seq_sth->errstr;
 522       my $insertid = $seq_sth->fetchrow_arrayref->[0];
 523
 524       # don't drink soap!  recurse!  recurse!  okay!
 525       my $error =
 526         _copy_skel( $child_table_def,
 527                     $row->{$child_pkey}, #sourceid
 528                     $insertid, #destid
 529                     %{ $child_tables{$child_table_def} },
 530                   );
 531       return $error if $error;
 532
 533     }
 534
 535   }
 536
 537   return '';
 538
 539 }
 540
 541 =item order_pkgs HASHREF, [ SECONDSREF, [ , OPTION => VALUE ... ] ]
 542
 543 Like the insert method on an existing record, this method orders a package
 544 and included services atomicaly.  Pass a Tie::RefHash data structure to this
 545 method containing FS::cust_pkg and FS::svc_I<tablename> objects.  There should
 546 be a better explanation of this, but until then, here's an example:
 547
 548   use Tie::RefHash;
 549   tie %hash, 'Tie::RefHash'; #this part is important
 550   %hash = (
 551     $cust_pkg => [ $svc_acct ],
 552     ...
 553   );
 554   $cust_main->order_pkgs( \%hash, \'0', 'noexport'=>1 );
 555
 556 Services can be new, in which case they are inserted, or existing unaudited
 557 services, in which case they are linked to the newly-created package.
 558
 559 Currently available options are: I<depend_jobnum> and I<noexport>.
 560
 561 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
 562 on the supplied jobnum (they will not run until the specific job completes).
 563 This can be used to defer provisioning until some action completes (such
 564 as running the customer's credit card successfully).
 565
 566 The I<noexport> option is deprecated.  If I<noexport> is set true, no
 567 provisioning jobs (exports) are scheduled.  (You can schedule them later with
 568 the B<reexport> method for each cust_pkg object.  Using the B<reexport> method
 569 on the cust_main object is not recommended, as existing services will also be
 570 reexported.)
 571
 572 =cut
 573
 574 sub order_pkgs {
 575   my $self = shift;
 576   my $cust_pkgs = shift;
 577   my $seconds = shift;
 578   my %options = @_;
 579   my %svc_options = ();
 580   $svc_options{'depend_jobnum'} = $options{'depend_jobnum'}
 581     if exists $options{'depend_jobnum'};
 582   warn "$me order_pkgs called with options ".
 583        join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
 584     if $DEBUG;
 585
 586   local $SIG{HUP} = 'IGNORE';
 587   local $SIG{INT} = 'IGNORE';
 588   local $SIG{QUIT} = 'IGNORE';
 589   local $SIG{TERM} = 'IGNORE';
 590   local $SIG{TSTP} = 'IGNORE';
 591   local $SIG{PIPE} = 'IGNORE';
 592
 593   my $oldAutoCommit = $FS::UID::AutoCommit;
 594   local $FS::UID::AutoCommit = 0;
 595   my $dbh = dbh;
 596
 597   local $FS::svc_Common::noexport_hack = 1 if $options{'noexport'};
 598
 599   foreach my $cust_pkg ( keys %$cust_pkgs ) {
 600     $cust_pkg->custnum( $self->custnum );
 601     my $error = $cust_pkg->insert;
 602     if ( $error ) {
 603       $dbh->rollback if $oldAutoCommit;
 604       return "inserting cust_pkg (transaction rolled back): $error";
 605     }
 606     foreach my $svc_something ( @{$cust_pkgs->{$cust_pkg}} ) {
 607       if ( $svc_something->svcnum ) {
 608         my $old_cust_svc = $svc_something->cust_svc;
 609         my $new_cust_svc = new FS::cust_svc { $old_cust_svc->hash };
 610         $new_cust_svc->pkgnum( $cust_pkg->pkgnum);
 611         $error = $new_cust_svc->replace($old_cust_svc);
 612       } else {
 613         $svc_something->pkgnum( $cust_pkg->pkgnum );
 614         if ( $seconds && $$seconds && $svc_something->isa('FS::svc_acct') ) {
 615           $svc_something->seconds( $svc_something->seconds + $$seconds );
 616           $$seconds = 0;
 617         }
 618         $error = $svc_something->insert(%svc_options);
 619       }
 620       if ( $error ) {
 621         $dbh->rollback if $oldAutoCommit;
 622         #return "inserting svc_ (transaction rolled back): $error";
 623         return $error;
 624       }
 625     }
 626   }
 627
 628   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 629   ''; #no error
 630 }
 631
 632 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
 633
 634 Recharges this (existing) customer with the specified prepaid card (see
 635 L<FS::prepay_credit>), specified either by I<identifier> or as an
 636 FS::prepay_credit object.  If there is an error, returns the error, otherwise
 637 returns false.
 638
 639 Optionally, four scalar references can be passed as well.  They will have their
 640 values filled in with the amount, number of seconds, and number of upload and
 641 download bytes applied by this prepaid
 642 card.
 643
 644 =cut
 645
 646 sub recharge_prepay {
 647   my( $self, $prepay_credit, $amountref, $secondsref,
 648       $upbytesref, $downbytesref, $totalbytesref ) = @_;
 649
 650   local $SIG{HUP} = 'IGNORE';
 651   local $SIG{INT} = 'IGNORE';
 652   local $SIG{QUIT} = 'IGNORE';
 653   local $SIG{TERM} = 'IGNORE';
 654   local $SIG{TSTP} = 'IGNORE';
 655   local $SIG{PIPE} = 'IGNORE';
 656
 657   my $oldAutoCommit = $FS::UID::AutoCommit;
 658   local $FS::UID::AutoCommit = 0;
 659   my $dbh = dbh;
 660
 661   my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
 662
 663   my $error = $self->get_prepay($prepay_credit, \$amount,
 664                                 \$seconds, \$upbytes, \$downbytes, \$totalbytes)
 665            || $self->increment_seconds($seconds)
 666            || $self->increment_upbytes($upbytes)
 667            || $self->increment_downbytes($downbytes)
 668            || $self->increment_totalbytes($totalbytes)
 669            || $self->insert_cust_pay_prepay( $amount,
 670                                              ref($prepay_credit)
 671                                                ? $prepay_credit->identifier
 672                                                : $prepay_credit
 673                                            );
 674
 675   if ( $error ) {
 676     $dbh->rollback if $oldAutoCommit;
 677     return $error;
 678   }
 679
 680   if ( defined($amountref)  ) { $$amountref  = $amount;  }
 681   if ( defined($secondsref) ) { $$secondsref = $seconds; }
 682   if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
 683   if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
 684   if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
 685
 686   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 687   '';
 688
 689 }
 690
 691 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ , AMOUNTREF, SECONDSREF
 692
 693 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
 694 specified either by I<identifier> or as an FS::prepay_credit object.
 695
 696 References to I<amount> and I<seconds> scalars should be passed as arguments
 697 and will be incremented by the values of the prepaid card.
 698
 699 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
 700 check or set this customer's I<agentnum>.
 701
 702 If there is an error, returns the error, otherwise returns false.
 703
 704 =cut
 705
 706
 707 sub get_prepay {
 708   my( $self, $prepay_credit, $amountref, $secondsref,
 709       $upref, $downref, $totalref) = @_;
 710
 711   local $SIG{HUP} = 'IGNORE';
 712   local $SIG{INT} = 'IGNORE';
 713   local $SIG{QUIT} = 'IGNORE';
 714   local $SIG{TERM} = 'IGNORE';
 715   local $SIG{TSTP} = 'IGNORE';
 716   local $SIG{PIPE} = 'IGNORE';
 717
 718   my $oldAutoCommit = $FS::UID::AutoCommit;
 719   local $FS::UID::AutoCommit = 0;
 720   my $dbh = dbh;
 721
 722   unless ( ref($prepay_credit) ) {
 723
 724     my $identifier = $prepay_credit;
 725
 726     $prepay_credit = qsearchs(
 727       'prepay_credit',
 728       { 'identifier' => $prepay_credit },
 729       '',
 730       'FOR UPDATE'
 731     );
 732
 733     unless ( $prepay_credit ) {
 734       $dbh->rollback if $oldAutoCommit;
 735       return "Invalid prepaid card: ". $identifier;
 736     }
 737
 738   }
 739
 740   if ( $prepay_credit->agentnum ) {
 741     if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
 742       $dbh->rollback if $oldAutoCommit;
 743       return "prepaid card not valid for agent ". $self->agentnum;
 744     }
 745     $self->agentnum($prepay_credit->agentnum);
 746   }
 747
 748   my $error = $prepay_credit->delete;
 749   if ( $error ) {
 750     $dbh->rollback if $oldAutoCommit;
 751     return "removing prepay_credit (transaction rolled back): $error";
 752   }
 753
 754   $$amountref  += $prepay_credit->amount;
 755   $$secondsref += $prepay_credit->seconds;
 756   $$upref      += $prepay_credit->upbytes;
 757   $$downref    += $prepay_credit->downbytes;
 758   $$totalref   += $prepay_credit->totalbytes;
 759
 760   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 761   '';
 762
 763 }
 764
 765 =item increment_upbytes SECONDS
 766
 767 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 768 the specified number of upbytes.  If there is an error, returns the error,
 769 otherwise returns false.
 770
 771 =cut
 772
 773 sub increment_upbytes {
 774   _increment_column( shift, 'upbytes', @_);
 775 }
 776
 777 =item increment_downbytes SECONDS
 778
 779 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 780 the specified number of downbytes.  If there is an error, returns the error,
 781 otherwise returns false.
 782
 783 =cut
 784
 785 sub increment_downbytes {
 786   _increment_column( shift, 'downbytes', @_);
 787 }
 788
 789 =item increment_totalbytes SECONDS
 790
 791 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 792 the specified number of totalbytes.  If there is an error, returns the error,
 793 otherwise returns false.
 794
 795 =cut
 796
 797 sub increment_totalbytes {
 798   _increment_column( shift, 'totalbytes', @_);
 799 }
 800
 801 =item increment_seconds SECONDS
 802
 803 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 804 the specified number of seconds.  If there is an error, returns the error,
 805 otherwise returns false.
 806
 807 =cut
 808
 809 sub increment_seconds {
 810   _increment_column( shift, 'seconds', @_);
 811 }
 812
 813 =item _increment_column AMOUNT
 814
 815 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 816 the specified number of seconds or bytes.  If there is an error, returns
 817 the error, otherwise returns false.
 818
 819 =cut
 820
 821 sub _increment_column {
 822   my( $self, $column, $amount ) = @_;
 823   warn "$me increment_column called: $column, $amount\n"
 824     if $DEBUG;
 825
 826   return '' unless $amount;
 827
 828   my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
 829                       $self->ncancelled_pkgs;
 830
 831   if ( ! @cust_pkg ) {
 832     return 'No packages with primary or single services found'.
 833            ' to apply pre-paid time';
 834   } elsif ( scalar(@cust_pkg) > 1 ) {
 835     #maybe have a way to specify the package/account?
 836     return 'Multiple packages found to apply pre-paid time';
 837   }
 838
 839   my $cust_pkg = $cust_pkg[0];
 840   warn "  found package pkgnum ". $cust_pkg->pkgnum. "\n"
 841     if $DEBUG > 1;
 842
 843   my @cust_svc =
 844     $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
 845
 846   if ( ! @cust_svc ) {
 847     return 'No account found to apply pre-paid time';
 848   } elsif ( scalar(@cust_svc) > 1 ) {
 849     return 'Multiple accounts found to apply pre-paid time';
 850   }
 851
 852   my $svc_acct = $cust_svc[0]->svc_x;
 853   warn "  found service svcnum ". $svc_acct->pkgnum.
 854        ' ('. $svc_acct->email. ")\n"
 855     if $DEBUG > 1;
 856
 857   $column = "increment_$column";
 858   $svc_acct->$column($amount);
 859
 860 }
 861
 862 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
 863
 864 Inserts a prepayment in the specified amount for this customer.  An optional
 865 second argument can specify the prepayment identifier for tracking purposes.
 866 If there is an error, returns the error, otherwise returns false.
 867
 868 =cut
 869
 870 sub insert_cust_pay_prepay {
 871   shift->insert_cust_pay('PREP', @_);
 872 }
 873
 874 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
 875
 876 Inserts a cash payment in the specified amount for this customer.  An optional
 877 second argument can specify the payment identifier for tracking purposes.
 878 If there is an error, returns the error, otherwise returns false.
 879
 880 =cut
 881
 882 sub insert_cust_pay_cash {
 883   shift->insert_cust_pay('CASH', @_);
 884 }
 885
 886 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
 887
 888 Inserts a Western Union payment in the specified amount for this customer.  An
 889 optional second argument can specify the prepayment identifier for tracking
 890 purposes.  If there is an error, returns the error, otherwise returns false.
 891
 892 =cut
 893
 894 sub insert_cust_pay_west {
 895   shift->insert_cust_pay('WEST', @_);
 896 }
 897
 898 sub insert_cust_pay {
 899   my( $self, $payby, $amount ) = splice(@_, 0, 3);
 900   my $payinfo = scalar(@_) ? shift : '';
 901
 902   my $cust_pay = new FS::cust_pay {
 903     'custnum' => $self->custnum,
 904     'paid'    => sprintf('%.2f', $amount),
 905     #'_date'   => #date the prepaid card was purchased???
 906     'payby'   => $payby,
 907     'payinfo' => $payinfo,
 908   };
 909   $cust_pay->insert;
 910
 911 }
 912
 913 =item reexport
 914
 915 This method is deprecated.  See the I<depend_jobnum> option to the insert and
 916 order_pkgs methods for a better way to defer provisioning.
 917
 918 Re-schedules all exports by calling the B<reexport> method of all associated
 919 packages (see L<FS::cust_pkg>).  If there is an error, returns the error;
 920 otherwise returns false.
 921
 922 =cut
 923
 924 sub reexport {
 925   my $self = shift;
 926
 927   carp "WARNING: FS::cust_main::reexport is deprectated; ".
 928        "use the depend_jobnum option to insert or order_pkgs to delay export";
 929
 930   local $SIG{HUP} = 'IGNORE';
 931   local $SIG{INT} = 'IGNORE';
 932   local $SIG{QUIT} = 'IGNORE';
 933   local $SIG{TERM} = 'IGNORE';
 934   local $SIG{TSTP} = 'IGNORE';
 935   local $SIG{PIPE} = 'IGNORE';
 936
 937   my $oldAutoCommit = $FS::UID::AutoCommit;
 938   local $FS::UID::AutoCommit = 0;
 939   my $dbh = dbh;
 940
 941   foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
 942     my $error = $cust_pkg->reexport;
 943     if ( $error ) {
 944       $dbh->rollback if $oldAutoCommit;
 945       return $error;
 946     }
 947   }
 948
 949   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 950   '';
 951
 952 }
 953
 954 =item delete NEW_CUSTNUM
 955
 956 This deletes the customer.  If there is an error, returns the error, otherwise
 957 returns false.
 958
 959 This will completely remove all traces of the customer record.  This is not
 960 what you want when a customer cancels service; for that, cancel all of the
 961 customer's packages (see L</cancel>).
 962
 963 If the customer has any uncancelled packages, you need to pass a new (valid)
 964 customer number for those packages to be transferred to.  Cancelled packages
 965 will be deleted.  Did I mention that this is NOT what you want when a customer
 966 cancels service and that you really should be looking see L<FS::cust_pkg/cancel>?
 967
 968 You can't delete a customer with invoices (see L<FS::cust_bill>),
 969 or credits (see L<FS::cust_credit>), payments (see L<FS::cust_pay>) or
 970 refunds (see L<FS::cust_refund>).
 971
 972 =cut
 973
 974 sub delete {
 975   my $self = shift;
 976
 977   local $SIG{HUP} = 'IGNORE';
 978   local $SIG{INT} = 'IGNORE';
 979   local $SIG{QUIT} = 'IGNORE';
 980   local $SIG{TERM} = 'IGNORE';
 981   local $SIG{TSTP} = 'IGNORE';
 982   local $SIG{PIPE} = 'IGNORE';
 983
 984   my $oldAutoCommit = $FS::UID::AutoCommit;
 985   local $FS::UID::AutoCommit = 0;
 986   my $dbh = dbh;
 987
 988   if ( $self->cust_bill ) {
 989     $dbh->rollback if $oldAutoCommit;
 990     return "Can't delete a customer with invoices";
 991   }
 992   if ( $self->cust_credit ) {
 993     $dbh->rollback if $oldAutoCommit;
 994     return "Can't delete a customer with credits";
 995   }
 996   if ( $self->cust_pay ) {
 997     $dbh->rollback if $oldAutoCommit;
 998     return "Can't delete a customer with payments";
 999   }
1000   if ( $self->cust_refund ) {
1001     $dbh->rollback if $oldAutoCommit;
1002     return "Can't delete a customer with refunds";
1003   }
1004
1005   my @cust_pkg = $self->ncancelled_pkgs;
1006   if ( @cust_pkg ) {
1007     my $new_custnum = shift;
1008     unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1009       $dbh->rollback if $oldAutoCommit;
1010       return "Invalid new customer number: $new_custnum";
1011     }
1012     foreach my $cust_pkg ( @cust_pkg ) {
1013       my %hash = $cust_pkg->hash;
1014       $hash{'custnum'} = $new_custnum;
1015       my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1016       my $error = $new_cust_pkg->replace($cust_pkg,
1017                                          options => { $cust_pkg->options },
1018                                         );
1019       if ( $error ) {
1020         $dbh->rollback if $oldAutoCommit;
1021         return $error;
1022       }
1023     }
1024   }
1025   my @cancelled_cust_pkg = $self->all_pkgs;
1026   foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1027     my $error = $cust_pkg->delete;
1028     if ( $error ) {
1029       $dbh->rollback if $oldAutoCommit;
1030       return $error;
1031     }
1032   }
1033
1034   foreach my $cust_main_invoice ( #(email invoice destinations, not invoices)
1035     qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } )
1036   ) {
1037     my $error = $cust_main_invoice->delete;
1038     if ( $error ) {
1039       $dbh->rollback if $oldAutoCommit;
1040       return $error;
1041     }
1042   }
1043
1044   my $error = $self->SUPER::delete;
1045   if ( $error ) {
1046     $dbh->rollback if $oldAutoCommit;
1047     return $error;
1048   }
1049
1050   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1051   '';
1052
1053 }
1054
1055 =item replace OLD_RECORD [ INVOICING_LIST_ARYREF ]
1056
1057 Replaces the OLD_RECORD with this one in the database.  If there is an error,
1058 returns the error, otherwise returns false.
1059
1060 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1061 be set as the invoicing list (see L<"invoicing_list">).  Errors return as
1062 expected and rollback the entire transaction; it is not necessary to call
1063 check_invoicing_list first.  Here's an example:
1064
1065   $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1066
1067 =cut
1068
1069 sub replace {
1070   my $self = shift;
1071   my $old = shift;
1072   my @param = @_;
1073   warn "$me replace called\n"
1074     if $DEBUG;
1075
1076   local $SIG{HUP} = 'IGNORE';
1077   local $SIG{INT} = 'IGNORE';
1078   local $SIG{QUIT} = 'IGNORE';
1079   local $SIG{TERM} = 'IGNORE';
1080   local $SIG{TSTP} = 'IGNORE';
1081   local $SIG{PIPE} = 'IGNORE';
1082
1083   # We absolutely have to have an old vs. new record to make this work.
1084   if (!defined($old)) {
1085     $old = qsearchs( 'cust_main', { 'custnum' => $self->custnum } );
1086   }
1087
1088   my $curuser = $FS::CurrentUser::CurrentUser;
1089   if (    $self->payby eq 'COMP'
1090        && $self->payby ne $old->payby
1091        && ! $curuser->access_right('Complimentary customer')
1092      )
1093   {
1094     return "You are not permitted to create complimentary accounts.";
1095   }
1096
1097   local($ignore_expired_card) = 1
1098     if $old->payby  =~ /^(CARD|DCRD)$/
1099     && $self->payby =~ /^(CARD|DCRD)$/
1100     && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1101
1102   my $oldAutoCommit = $FS::UID::AutoCommit;
1103   local $FS::UID::AutoCommit = 0;
1104   my $dbh = dbh;
1105
1106   my $error = $self->SUPER::replace($old);
1107
1108   if ( $error ) {
1109     $dbh->rollback if $oldAutoCommit;
1110     return $error;
1111   }
1112
1113   if ( @param ) { # INVOICING_LIST_ARYREF
1114     my $invoicing_list = shift @param;
1115     $error = $self->check_invoicing_list( $invoicing_list );
1116     if ( $error ) {
1117       $dbh->rollback if $oldAutoCommit;
1118       return $error;
1119     }
1120     $self->invoicing_list( $invoicing_list );
1121   }
1122
1123   if ( $self->payby =~ /^(CARD|CHEK|LECB)$/ &&
1124        grep { $self->get($_) ne $old->get($_) } qw(payinfo paydate payname) ) {
1125     # card/check/lec info has changed, want to retry realtime_ invoice events
1126     my $error = $self->retry_realtime;
1127     if ( $error ) {
1128       $dbh->rollback if $oldAutoCommit;
1129       return $error;
1130     }
1131   }
1132
1133   unless ( $import || $skip_fuzzyfiles ) {
1134     $error = $self->queue_fuzzyfiles_update;
1135     if ( $error ) {
1136       $dbh->rollback if $oldAutoCommit;
1137       return "updating fuzzy search cache: $error";
1138     }
1139   }
1140
1141   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1142   '';
1143
1144 }
1145
1146 =item queue_fuzzyfiles_update
1147
1148 Used by insert & replace to update the fuzzy search cache
1149
1150 =cut
1151
1152 sub queue_fuzzyfiles_update {
1153   my $self = shift;
1154
1155   local $SIG{HUP} = 'IGNORE';
1156   local $SIG{INT} = 'IGNORE';
1157   local $SIG{QUIT} = 'IGNORE';
1158   local $SIG{TERM} = 'IGNORE';
1159   local $SIG{TSTP} = 'IGNORE';
1160   local $SIG{PIPE} = 'IGNORE';
1161
1162   my $oldAutoCommit = $FS::UID::AutoCommit;
1163   local $FS::UID::AutoCommit = 0;
1164   my $dbh = dbh;
1165
1166   my $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1167   my $error = $queue->insert( map $self->getfield($_),
1168                                   qw(first last company)
1169                             );
1170   if ( $error ) {
1171     $dbh->rollback if $oldAutoCommit;
1172     return "queueing job (transaction rolled back): $error";
1173   }
1174
1175   if ( $self->ship_last ) {
1176     $queue = new FS::queue { 'job' => 'FS::cust_main::append_fuzzyfiles' };
1177     $error = $queue->insert( map $self->getfield("ship_$_"),
1178                                  qw(first last company)
1179                            );
1180     if ( $error ) {
1181       $dbh->rollback if $oldAutoCommit;
1182       return "queueing job (transaction rolled back): $error";
1183     }
1184   }
1185
1186   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1187   '';
1188
1189 }
1190
1191 =item check
1192
1193 Checks all fields to make sure this is a valid customer record.  If there is
1194 an error, returns the error, otherwise returns false.  Called by the insert
1195 and replace methods.
1196
1197 =cut
1198
1199 sub check {
1200   my $self = shift;
1201
1202   warn "$me check BEFORE: \n". $self->_dump
1203     if $DEBUG > 2;
1204
1205   my $error =
1206     $self->ut_numbern('custnum')
1207     || $self->ut_number('agentnum')
1208     || $self->ut_textn('agent_custid')
1209     || $self->ut_number('refnum')
1210     || $self->ut_name('last')
1211     || $self->ut_name('first')
1212     || $self->ut_snumbern('birthdate')
1213     || $self->ut_snumbern('signupdate')
1214     || $self->ut_textn('company')
1215     || $self->ut_text('address1')
1216     || $self->ut_textn('address2')
1217     || $self->ut_text('city')
1218     || $self->ut_textn('county')
1219     || $self->ut_textn('state')
1220     || $self->ut_country('country')
1221     || $self->ut_anything('comments')
1222     || $self->ut_numbern('referral_custnum')
1223     || $self->ut_textn('stateid')
1224     || $self->ut_textn('stateid_state')
1225     || $self->ut_textn('invoice_terms')
1226   ;
1227   #barf.  need message catalogs.  i18n.  etc.
1228   $error .= "Please select an advertising source."
1229     if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1230   return $error if $error;
1231
1232   return "Unknown agent"
1233     unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1234
1235   return "Unknown refnum"
1236     unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1237
1238   return "Unknown referring custnum: ". $self->referral_custnum
1239     unless ! $self->referral_custnum
1240            || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1241
1242   if ( $self->ss eq '' ) {
1243     $self->ss('');
1244   } else {
1245     my $ss = $self->ss;
1246     $ss =~ s/\D//g;
1247     $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1248       or return "Illegal social security number: ". $self->ss;
1249     $self->ss("$1-$2-$3");
1250   }
1251
1252
1253 # bad idea to disable, causes billing to fail because of no tax rates later
1254 #  unless ( $import ) {
1255     unless ( qsearch('cust_main_county', {
1256       'country' => $self->country,
1257       'state'   => '',
1258      } ) ) {
1259       return "Unknown state/county/country: ".
1260         $self->state. "/". $self->county. "/". $self->country
1261         unless qsearch('cust_main_county',{
1262           'state'   => $self->state,
1263           'county'  => $self->county,
1264           'country' => $self->country,
1265         } );
1266     }
1267 #  }
1268
1269   $error =
1270     $self->ut_phonen('daytime', $self->country)
1271     || $self->ut_phonen('night', $self->country)
1272     || $self->ut_phonen('fax', $self->country)
1273     || $self->ut_zip('zip', $self->country)
1274   ;
1275   return $error if $error;
1276
1277   my @addfields = qw(
1278     last first company address1 address2 city county state zip
1279     country daytime night fax
1280   );
1281
1282   if ( defined $self->dbdef_table->column('ship_last') ) {
1283     if ( scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1284                        @addfields )
1285          && scalar ( grep { $self->getfield("ship_$_") ne '' } @addfields )
1286        )
1287     {
1288       my $error =
1289         $self->ut_name('ship_last')
1290         || $self->ut_name('ship_first')
1291         || $self->ut_textn('ship_company')
1292         || $self->ut_text('ship_address1')
1293         || $self->ut_textn('ship_address2')
1294         || $self->ut_text('ship_city')
1295         || $self->ut_textn('ship_county')
1296         || $self->ut_textn('ship_state')
1297         || $self->ut_country('ship_country')
1298       ;
1299       return $error if $error;
1300
1301       #false laziness with above
1302       unless ( qsearchs('cust_main_county', {
1303         'country' => $self->ship_country,
1304         'state'   => '',
1305        } ) ) {
1306         return "Unknown ship_state/ship_county/ship_country: ".
1307           $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1308           unless qsearch('cust_main_county',{
1309             'state'   => $self->ship_state,
1310             'county'  => $self->ship_county,
1311             'country' => $self->ship_country,
1312           } );
1313       }
1314       #eofalse
1315
1316       $error =
1317         $self->ut_phonen('ship_daytime', $self->ship_country)
1318         || $self->ut_phonen('ship_night', $self->ship_country)
1319         || $self->ut_phonen('ship_fax', $self->ship_country)
1320         || $self->ut_zip('ship_zip', $self->ship_country)
1321       ;
1322       return $error if $error;
1323
1324     } else { # ship_ info eq billing info, so don't store dup info in database
1325       $self->setfield("ship_$_", '')
1326         foreach qw( last first company address1 address2 city county state zip
1327                     country daytime night fax );
1328     }
1329   }
1330
1331   #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1332   #  or return "Illegal payby: ". $self->payby;
1333   #$self->payby($1);
1334   FS::payby->can_payby($self->table, $self->payby)
1335     or return "Illegal payby: ". $self->payby;
1336
1337   $error =    $self->ut_numbern('paystart_month')
1338            || $self->ut_numbern('paystart_year')
1339            || $self->ut_numbern('payissue')
1340            || $self->ut_textn('paytype')
1341   ;
1342   return $error if $error;
1343
1344   if ( $self->payip eq '' ) {
1345     $self->payip('');
1346   } else {
1347     $error = $self->ut_ip('payip');
1348     return $error if $error;
1349   }
1350
1351   # If it is encrypted and the private key is not availaible then we can't
1352   # check the credit card.
1353
1354   my $check_payinfo = 1;
1355
1356   if ($self->is_encrypted($self->payinfo)) {
1357     $check_payinfo = 0;
1358   }
1359
1360   if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1361
1362     my $payinfo = $self->payinfo;
1363     $payinfo =~ s/\D//g;
1364     $payinfo =~ /^(\d{13,16})$/
1365       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1366     $payinfo = $1;
1367     $self->payinfo($payinfo);
1368     validate($payinfo)
1369       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1370
1371     return gettext('unknown_card_type')
1372       if cardtype($self->payinfo) eq "Unknown";
1373
1374     my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1375     if ( $ban ) {
1376       return 'Banned credit card: banned on '.
1377              time2str('%a %h %o at %r', $ban->_date).
1378              ' by '. $ban->otaker.
1379              ' (ban# '. $ban->bannum. ')';
1380     }
1381
1382     if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1383       if ( cardtype($self->payinfo) eq 'American Express card' ) {
1384         $self->paycvv =~ /^(\d{4})$/
1385           or return "CVV2 (CID) for American Express cards is four digits.";
1386         $self->paycvv($1);
1387       } else {
1388         $self->paycvv =~ /^(\d{3})$/
1389           or return "CVV2 (CVC2/CID) is three digits.";
1390         $self->paycvv($1);
1391       }
1392     } else {
1393       $self->paycvv('');
1394     }
1395
1396     my $cardtype = cardtype($payinfo);
1397     if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1398
1399       return "Start date or issue number is required for $cardtype cards"
1400         unless $self->paystart_month && $self->paystart_year or $self->payissue;
1401
1402       return "Start month must be between 1 and 12"
1403         if $self->paystart_month
1404            and $self->paystart_month < 1 || $self->paystart_month > 12;
1405
1406       return "Start year must be 1990 or later"
1407         if $self->paystart_year
1408            and $self->paystart_year < 1990;
1409
1410       return "Issue number must be beween 1 and 99"
1411         if $self->payissue
1412           and $self->payissue < 1 || $self->payissue > 99;
1413
1414     } else {
1415       $self->paystart_month('');
1416       $self->paystart_year('');
1417       $self->payissue('');
1418     }
1419
1420   } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1421
1422     my $payinfo = $self->payinfo;
1423     $payinfo =~ s/[^\d\@]//g;
1424     if ( $conf->exists('echeck-nonus') ) {
1425       $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
1426       $payinfo = "$1\@$2";
1427     } else {
1428       $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
1429       $payinfo = "$1\@$2";
1430     }
1431     $self->payinfo($payinfo);
1432     $self->paycvv('');
1433
1434     my $ban = qsearchs('banned_pay', $self->_banned_pay_hashref);
1435     if ( $ban ) {
1436       return 'Banned ACH account: banned on '.
1437              time2str('%a %h %o at %r', $ban->_date).
1438              ' by '. $ban->otaker.
1439              ' (ban# '. $ban->bannum. ')';
1440     }
1441
1442   } elsif ( $self->payby eq 'LECB' ) {
1443
1444     my $payinfo = $self->payinfo;
1445     $payinfo =~ s/\D//g;
1446     $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
1447     $payinfo = $1;
1448     $self->payinfo($payinfo);
1449     $self->paycvv('');
1450
1451   } elsif ( $self->payby eq 'BILL' ) {
1452
1453     $error = $self->ut_textn('payinfo');
1454     return "Illegal P.O. number: ". $self->payinfo if $error;
1455     $self->paycvv('');
1456
1457   } elsif ( $self->payby eq 'COMP' ) {
1458
1459     my $curuser = $FS::CurrentUser::CurrentUser;
1460     if (    ! $self->custnum
1461          && ! $curuser->access_right('Complimentary customer')
1462        )
1463     {
1464       return "You are not permitted to create complimentary accounts."
1465     }
1466
1467     $error = $self->ut_textn('payinfo');
1468     return "Illegal comp account issuer: ". $self->payinfo if $error;
1469     $self->paycvv('');
1470
1471   } elsif ( $self->payby eq 'PREPAY' ) {
1472
1473     my $payinfo = $self->payinfo;
1474     $payinfo =~ s/\W//g; #anything else would just confuse things
1475     $self->payinfo($payinfo);
1476     $error = $self->ut_alpha('payinfo');
1477     return "Illegal prepayment identifier: ". $self->payinfo if $error;
1478     return "Unknown prepayment identifier"
1479       unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
1480     $self->paycvv('');
1481
1482   }
1483
1484   if ( $self->paydate eq '' || $self->paydate eq '-' ) {
1485     return "Expiration date required"
1486       unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
1487     $self->paydate('');
1488   } else {
1489     my( $m, $y );
1490     if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
1491       ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
1492     } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
1493       ( $m, $y ) = ( $3, "20$2" );
1494     } else {
1495       return "Illegal expiration date: ". $self->paydate;
1496     }
1497     $self->paydate("$y-$m-01");
1498     my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
1499     return gettext('expired_card')
1500       if !$import
1501       && !$ignore_expired_card
1502       && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
1503   }
1504
1505   if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
1506        ( ! $conf->exists('require_cardname')
1507          || $self->payby !~ /^(CARD|DCRD)$/  )
1508   ) {
1509     $self->payname( $self->first. " ". $self->getfield('last') );
1510   } else {
1511     $self->payname =~ /^([\w \,\.\-\'\&]+)$/
1512       or return gettext('illegal_name'). " payname: ". $self->payname;
1513     $self->payname($1);
1514   }
1515
1516   foreach my $flag (qw( tax spool_cdr )) {
1517     $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
1518     $self->$flag($1);
1519   }
1520
1521   $self->otaker(getotaker) unless $self->otaker;
1522
1523   warn "$me check AFTER: \n". $self->_dump
1524     if $DEBUG > 2;
1525
1526   $self->SUPER::check;
1527 }
1528
1529 =item all_pkgs
1530
1531 Returns all packages (see L<FS::cust_pkg>) for this customer.
1532
1533 =cut
1534
1535 sub all_pkgs {
1536   my $self = shift;
1537
1538   return $self->num_pkgs unless wantarray;
1539
1540   my @cust_pkg = ();
1541   if ( $self->{'_pkgnum'} ) {
1542     @cust_pkg = values %{ $self->{'_pkgnum'}->cache };
1543   } else {
1544     @cust_pkg = qsearch( 'cust_pkg', { 'custnum' => $self->custnum });
1545   }
1546
1547   sort sort_packages @cust_pkg;
1548 }
1549
1550 =item ncancelled_pkgs
1551
1552 Returns all non-cancelled packages (see L<FS::cust_pkg>) for this customer.
1553
1554 =cut
1555
1556 sub ncancelled_pkgs {
1557   my $self = shift;
1558
1559   return $self->num_ncancelled_pkgs unless wantarray;
1560
1561   my @cust_pkg = ();
1562   if ( $self->{'_pkgnum'} ) {
1563
1564     @cust_pkg = grep { ! $_->getfield('cancel') }
1565                 values %{ $self->{'_pkgnum'}->cache };
1566
1567   } else {
1568
1569     @cust_pkg =
1570       qsearch( 'cust_pkg', {
1571                              'custnum' => $self->custnum,
1572                              'cancel'  => '',
1573                            });
1574     push @cust_pkg,
1575       qsearch( 'cust_pkg', {
1576                              'custnum' => $self->custnum,
1577                              'cancel'  => 0,
1578                            });
1579   }
1580
1581   sort sort_packages @cust_pkg;
1582
1583 }
1584
1585 # This should be generalized to use config options to determine order.
1586 sub sort_packages {
1587   if ( $a->get('cancel') and $b->get('cancel') ) {
1588     $a->pkgnum <=> $b->pkgnum;
1589   } elsif ( $a->get('cancel') or $b->get('cancel') ) {
1590     return -1 if $b->get('cancel');
1591     return  1 if $a->get('cancel');
1592     return 0;
1593   } else {
1594     $a->pkgnum <=> $b->pkgnum;
1595   }
1596 }
1597
1598 =item suspended_pkgs
1599
1600 Returns all suspended packages (see L<FS::cust_pkg>) for this customer.
1601
1602 =cut
1603
1604 sub suspended_pkgs {
1605   my $self = shift;
1606   grep { $_->susp } $self->ncancelled_pkgs;
1607 }
1608
1609 =item unflagged_suspended_pkgs
1610
1611 Returns all unflagged suspended packages (see L<FS::cust_pkg>) for this
1612 customer (thouse packages without the `manual_flag' set).
1613
1614 =cut
1615
1616 sub unflagged_suspended_pkgs {
1617   my $self = shift;
1618   return $self->suspended_pkgs
1619     unless dbdef->table('cust_pkg')->column('manual_flag');
1620   grep { ! $_->manual_flag } $self->suspended_pkgs;
1621 }
1622
1623 =item unsuspended_pkgs
1624
1625 Returns all unsuspended (and uncancelled) packages (see L<FS::cust_pkg>) for
1626 this customer.
1627
1628 =cut
1629
1630 sub unsuspended_pkgs {
1631   my $self = shift;
1632   grep { ! $_->susp } $self->ncancelled_pkgs;
1633 }
1634
1635 =item num_cancelled_pkgs
1636
1637 Returns the number of cancelled packages (see L<FS::cust_pkg>) for this
1638 customer.
1639
1640 =cut
1641
1642 sub num_cancelled_pkgs {
1643   shift->num_pkgs("cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0");
1644 }
1645
1646 sub num_ncancelled_pkgs {
1647   shift->num_pkgs("( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )");
1648 }
1649
1650 sub num_pkgs {
1651   my( $self, $sql ) = @_;
1652   $sql = "AND $sql" if $sql && $sql !~ /^\s*$/ && $sql !~ /^\s*AND/i;
1653   my $sth = dbh->prepare(
1654     "SELECT COUNT(*) FROM cust_pkg WHERE custnum = ? $sql"
1655   ) or die dbh->errstr;
1656   $sth->execute($self->custnum) or die $sth->errstr;
1657   $sth->fetchrow_arrayref->[0];
1658 }
1659
1660 =item unsuspend
1661
1662 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
1663 and L<FS::cust_pkg>) for this customer.  Always returns a list: an empty list
1664 on success or a list of errors.
1665
1666 =cut
1667
1668 sub unsuspend {
1669   my $self = shift;
1670   grep { $_->unsuspend } $self->suspended_pkgs;
1671 }
1672
1673 =item suspend
1674
1675 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
1676
1677 Returns a list: an empty list on success or a list of errors.
1678
1679 =cut
1680
1681 sub suspend {
1682   my $self = shift;
1683   grep { $_->suspend(@_) } $self->unsuspended_pkgs;
1684 }
1685
1686 =item suspend_if_pkgpart PKGPART [ , PKGPART ... ]
1687
1688 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
1689 PKGPARTs (see L<FS::part_pkg>).
1690
1691 Returns a list: an empty list on success or a list of errors.
1692
1693 =cut
1694
1695 sub suspend_if_pkgpart {
1696   my $self = shift;
1697   my (@pkgparts, %opt);
1698   if (ref($_[0]) eq 'HASH'){
1699     @pkgparts = @{$_[0]{pkgparts}};
1700     %opt      = %{$_[0]};
1701   }else{
1702     @pkgparts = @_;
1703   }
1704   grep { $_->suspend(%opt) }
1705     grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
1706       $self->unsuspended_pkgs;
1707 }
1708
1709 =item suspend_unless_pkgpart PKGPART [ , PKGPART ... ]
1710
1711 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
1712 listed PKGPARTs (see L<FS::part_pkg>).
1713
1714 Returns a list: an empty list on success or a list of errors.
1715
1716 =cut
1717
1718 sub suspend_unless_pkgpart {
1719   my $self = shift;
1720   my (@pkgparts, %opt);
1721   if (ref($_[0]) eq 'HASH'){
1722     @pkgparts = @{$_[0]{pkgparts}};
1723     %opt      = %{$_[0]};
1724   }else{
1725     @pkgparts = @_;
1726   }
1727   grep { $_->suspend(%opt) }
1728     grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
1729       $self->unsuspended_pkgs;
1730 }
1731
1732 =item cancel [ OPTION => VALUE ... ]
1733
1734 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
1735
1736 Available options are: I<quiet>, I<reasonnum>, and I<ban>
1737
1738 I<quiet> can be set true to supress email cancellation notices.
1739
1740 # I<reasonnum> can be set to a cancellation reason (see L<FS::cancel_reason>)
1741
1742 I<ban> can be set true to ban this customer's credit card or ACH information,
1743 if present.
1744
1745 Always returns a list: an empty list on success or a list of errors.
1746
1747 =cut
1748
1749 sub cancel {
1750   my $self = shift;
1751   my %opt = @_;
1752
1753   if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
1754
1755     #should try decryption (we might have the private key)
1756     # and if not maybe queue a job for the server that does?
1757     return ( "Can't (yet) ban encrypted credit cards" )
1758       if $self->is_encrypted($self->payinfo);
1759
1760     my $ban = new FS::banned_pay $self->_banned_pay_hashref;
1761     my $error = $ban->insert;
1762     return ( $error ) if $error;
1763
1764   }
1765
1766   grep { $_ } map { $_->cancel(@_) } $self->ncancelled_pkgs;
1767 }
1768
1769 sub _banned_pay_hashref {
1770   my $self = shift;
1771
1772   my %payby2ban = (
1773     'CARD' => 'CARD',
1774     'DCRD' => 'CARD',
1775     'CHEK' => 'CHEK',
1776     'DCHK' => 'CHEK'
1777   );
1778
1779   {
1780     'payby'   => $payby2ban{$self->payby},
1781     'payinfo' => md5_base64($self->payinfo),
1782     #don't ever *search* on reason! #'reason'  =>
1783   };
1784 }
1785
1786 =item notes
1787
1788 Returns all notes (see L<FS::cust_main_note>) for this customer.
1789
1790 =cut
1791
1792 sub notes {
1793   my $self = shift;
1794   #order by?
1795   qsearch( 'cust_main_note',
1796            { 'custnum' => $self->custnum },
1797            '',
1798            'ORDER BY _DATE DESC'
1799          );
1800 }
1801
1802 =item agent
1803
1804 Returns the agent (see L<FS::agent>) for this customer.
1805
1806 =cut
1807
1808 sub agent {
1809   my $self = shift;
1810   qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1811 }
1812
1813 =item bill OPTIONS
1814
1815 Generates invoices (see L<FS::cust_bill>) for this customer.  Usually used in
1816 conjunction with the collect method.
1817
1818 Options are passed as name-value pairs.
1819
1820 Currently available options are:
1821
1822 resetup - if set true, re-charges setup fees.
1823
1824 time - bills the customer as if it were that time.  Specified as a UNIX
1825 timestamp; see L<perlfunc/"time">).  Also see L<Time::Local> and
1826 L<Date::Parse> for conversion functions.  For example:
1827
1828  use Date::Parse;
1829  ...
1830  $cust_main->bill( 'time' => str2time('April 20th, 2001') );
1831
1832
1833 If there is an error, returns the error, otherwise returns false.
1834
1835 =cut
1836
1837 sub bill {
1838   my( $self, %options ) = @_;
1839   return '' if $self->payby eq 'COMP';
1840   warn "$me bill customer ". $self->custnum. "\n"
1841     if $DEBUG;
1842
1843   my $time = $options{'time'} || time;
1844
1845   my $error;
1846
1847   #put below somehow?
1848   local $SIG{HUP} = 'IGNORE';
1849   local $SIG{INT} = 'IGNORE';
1850   local $SIG{QUIT} = 'IGNORE';
1851   local $SIG{TERM} = 'IGNORE';
1852   local $SIG{TSTP} = 'IGNORE';
1853   local $SIG{PIPE} = 'IGNORE';
1854
1855   my $oldAutoCommit = $FS::UID::AutoCommit;
1856   local $FS::UID::AutoCommit = 0;
1857   my $dbh = dbh;
1858
1859   $self->select_for_update; #mutex
1860
1861   #create a new invoice
1862   #(we'll remove it later if it doesn't actually need to be generated [contains
1863   # no line items] and we're inside a transaciton so nothing else will see it)
1864   my $cust_bill = new FS::cust_bill ( {
1865     'custnum' => $self->custnum,
1866     '_date'   => $time,
1867     #'charged' => $charged,
1868     'charged' => 0,
1869   } );
1870   $error = $cust_bill->insert;
1871   if ( $error ) {
1872     $dbh->rollback if $oldAutoCommit;
1873     return "can't create invoice for customer #". $self->custnum. ": $error";
1874   }
1875   my $invnum = $cust_bill->invnum;
1876
1877   ###
1878   # find the packages which are due for billing, find out how much they are
1879   # & generate invoice database.
1880   ###
1881
1882   my( $total_setup, $total_recur ) = ( 0, 0 );
1883   my %tax;
1884   my @precommit_hooks = ();
1885
1886   foreach my $cust_pkg (
1887     qsearch('cust_pkg', { 'custnum' => $self->custnum } )
1888   ) {
1889
1890     #NO!! next if $cust_pkg->cancel;
1891     next if $cust_pkg->getfield('cancel');
1892
1893     warn "  bill package ". $cust_pkg->pkgnum. "\n" if $DEBUG > 1;
1894
1895     #? to avoid use of uninitialized value errors... ?
1896     $cust_pkg->setfield('bill', '')
1897       unless defined($cust_pkg->bill);
1898
1899     my $part_pkg = $cust_pkg->part_pkg;
1900
1901     my %hash = $cust_pkg->hash;
1902     my $old_cust_pkg = new FS::cust_pkg \%hash;
1903
1904     my @details = ();
1905
1906     ###
1907     # bill setup
1908     ###
1909
1910     my $setup = 0;
1911     if ( ! $cust_pkg->setup &&
1912          (
1913            ( $conf->exists('disable_setup_suspended_pkgs') &&
1914             ! $cust_pkg->getfield('susp')
1915           ) || ! $conf->exists('disable_setup_suspended_pkgs')
1916          )
1917       || $options{'resetup'}
1918     ) {
1919
1920       warn "    bill setup\n" if $DEBUG > 1;
1921
1922       $setup = eval { $cust_pkg->calc_setup( $time, \@details ) };
1923       if ( $@ ) {
1924         $dbh->rollback if $oldAutoCommit;
1925         return "$@ running calc_setup for $cust_pkg\n";
1926       }
1927
1928       $cust_pkg->setfield('setup', $time) unless $cust_pkg->setup;
1929     }
1930
1931     ###
1932     # bill recurring fee
1933     ###
1934
1935     my $recur = 0;
1936     my $sdate;
1937     if ( $part_pkg->getfield('freq') ne '0' &&
1938          ! $cust_pkg->getfield('susp') &&
1939          ( $cust_pkg->getfield('bill') || 0 ) <= $time
1940     ) {
1941
1942       warn "    bill recur\n" if $DEBUG > 1;
1943
1944       # XXX shared with $recur_prog
1945       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1946
1947       #over two params!  lets at least switch to a hashref for the rest...
1948       my %param = ( 'precommit_hooks' => \@precommit_hooks, );
1949
1950       $recur = eval { $cust_pkg->calc_recur( \$sdate, \@details, \%param ) };
1951       if ( $@ ) {
1952         $dbh->rollback if $oldAutoCommit;
1953         return "$@ running calc_recur for $cust_pkg\n";
1954       }
1955
1956       #change this bit to use Date::Manip? CAREFUL with timezones (see
1957       # mailing list archive)
1958       my ($sec,$min,$hour,$mday,$mon,$year) =
1959         (localtime($sdate) )[0,1,2,3,4,5];
1960
1961       #pro-rating magic - if $recur_prog fiddles $sdate, want to use that
1962       # only for figuring next bill date, nothing else, so, reset $sdate again
1963       # here
1964       $sdate = $cust_pkg->bill || $cust_pkg->setup || $time;
1965       $cust_pkg->last_bill($sdate)
1966         if $cust_pkg->dbdef_table->column('last_bill');
1967
1968       if ( $part_pkg->freq =~ /^\d+$/ ) {
1969         $mon += $part_pkg->freq;
1970         until ( $mon < 12 ) { $mon -= 12; $year++; }
1971       } elsif ( $part_pkg->freq =~ /^(\d+)w$/ ) {
1972         my $weeks = $1;
1973         $mday += $weeks * 7;
1974       } elsif ( $part_pkg->freq =~ /^(\d+)d$/ ) {
1975         my $days = $1;
1976         $mday += $days;
1977       } elsif ( $part_pkg->freq =~ /^(\d+)h$/ ) {
1978         my $hours = $1;
1979         $hour += $hours;
1980       } else {
1981         $dbh->rollback if $oldAutoCommit;
1982         return "unparsable frequency: ". $part_pkg->freq;
1983       }
1984       $cust_pkg->setfield('bill',
1985         timelocal_nocheck($sec,$min,$hour,$mday,$mon,$year));
1986     }
1987
1988     warn "\$setup is undefined" unless defined($setup);
1989     warn "\$recur is undefined" unless defined($recur);
1990     warn "\$cust_pkg->bill is undefined" unless defined($cust_pkg->bill);
1991
1992     ###
1993     # If $cust_pkg has been modified, update it and create cust_bill_pkg records
1994     ###
1995
1996     if ( $cust_pkg->modified ) {  # hmmm.. and if the options are modified?
1997
1998       warn "  package ". $cust_pkg->pkgnum. " modified; updating\n"
1999         if $DEBUG >1;
2000
2001       $error=$cust_pkg->replace($old_cust_pkg,
2002                                 options => { $cust_pkg->options },
2003                                );
2004       if ( $error ) { #just in case
2005         $dbh->rollback if $oldAutoCommit;
2006         return "Error modifying pkgnum ". $cust_pkg->pkgnum. ": $error";
2007       }
2008
2009       $setup = sprintf( "%.2f", $setup );
2010       $recur = sprintf( "%.2f", $recur );
2011       if ( $setup < 0 && ! $conf->exists('allow_negative_charges') ) {
2012         $dbh->rollback if $oldAutoCommit;
2013         return "negative setup $setup for pkgnum ". $cust_pkg->pkgnum;
2014       }
2015       if ( $recur < 0 && ! $conf->exists('allow_negative_charges') ) {
2016         $dbh->rollback if $oldAutoCommit;
2017         return "negative recur $recur for pkgnum ". $cust_pkg->pkgnum;
2018       }
2019
2020       if ( $setup != 0 || $recur != 0 ) {
2021
2022         warn "    charges (setup=$setup, recur=$recur); adding line items\n"
2023           if $DEBUG > 1;
2024         my $cust_bill_pkg = new FS::cust_bill_pkg ({
2025           'invnum'  => $invnum,
2026           'pkgnum'  => $cust_pkg->pkgnum,
2027           'setup'   => $setup,
2028           'recur'   => $recur,
2029           'sdate'   => $sdate,
2030           'edate'   => $cust_pkg->bill,
2031           'details' => \@details,
2032         });
2033         $error = $cust_bill_pkg->insert;
2034         if ( $error ) {
2035           $dbh->rollback if $oldAutoCommit;
2036           return "can't create invoice line item for invoice #$invnum: $error";
2037         }
2038         $total_setup += $setup;
2039         $total_recur += $recur;
2040
2041         ###
2042         # handle taxes
2043         ###
2044
2045         unless ( $self->tax =~ /Y/i || $self->payby eq 'COMP' ) {
2046
2047           my $prefix =
2048             ( $conf->exists('tax-ship_address') && length($self->ship_last) )
2049             ? 'ship_'
2050             : '';
2051           my %taxhash = map { $_ => $self->get("$prefix$_") }
2052                             qw( state county country );
2053
2054           $taxhash{'taxclass'} = $part_pkg->taxclass;
2055
2056           my @taxes = qsearch( 'cust_main_county', \%taxhash );
2057
2058           unless ( @taxes ) {
2059             $taxhash{'taxclass'} = '';
2060             @taxes =  qsearch( 'cust_main_county', \%taxhash );
2061           }
2062
2063           #one more try at a whole-country tax rate
2064           unless ( @taxes ) {
2065             $taxhash{$_} = '' foreach qw( state county );
2066             @taxes =  qsearch( 'cust_main_county', \%taxhash );
2067           }
2068
2069           # maybe eliminate this entirely, along with all the 0% records
2070           unless ( @taxes ) {
2071             $dbh->rollback if $oldAutoCommit;
2072             return
2073               "fatal: can't find tax rate for state/county/country/taxclass ".
2074               join('/', ( map $self->get("$prefix$_"),
2075                               qw(state county country)
2076                         ),
2077                         $part_pkg->taxclass ). "\n";
2078           }
2079
2080           foreach my $tax ( @taxes ) {
2081
2082             my $taxable_charged = 0;
2083             $taxable_charged += $setup
2084               unless $part_pkg->setuptax =~ /^Y$/i
2085                   || $tax->setuptax =~ /^Y$/i;
2086             $taxable_charged += $recur
2087               unless $part_pkg->recurtax =~ /^Y$/i
2088                   || $tax->recurtax =~ /^Y$/i;
2089             next unless $taxable_charged;
2090
2091             if ( $tax->exempt_amount && $tax->exempt_amount > 0 ) {
2092               #my ($mon,$year) = (localtime($sdate) )[4,5];
2093               my ($mon,$year) = (localtime( $sdate || $cust_bill->_date ) )[4,5];
2094               $mon++;
2095               my $freq = $part_pkg->freq || 1;
2096               if ( $freq !~ /(\d+)$/ ) {
2097                 $dbh->rollback if $oldAutoCommit;
2098                 return "daily/weekly package definitions not (yet?)".
2099                        " compatible with monthly tax exemptions";
2100               }
2101               my $taxable_per_month =
2102                 sprintf("%.2f", $taxable_charged / $freq );
2103
2104               #call the whole thing off if this customer has any old
2105               #exemption records...
2106               my @cust_tax_exempt =
2107                 qsearch( 'cust_tax_exempt' => { custnum=> $self->custnum } );
2108               if ( @cust_tax_exempt ) {
2109                 $dbh->rollback if $oldAutoCommit;
2110                 return
2111                   'this customer still has old-style tax exemption records; '.
2112                   'run bin/fs-migrate-cust_tax_exempt?';
2113               }
2114
2115               foreach my $which_month ( 1 .. $freq ) {
2116
2117                 #maintain the new exemption table now
2118                 my $sql = "
2119                   SELECT SUM(amount)
2120                     FROM cust_tax_exempt_pkg
2121                       LEFT JOIN cust_bill_pkg USING ( billpkgnum )
2122                       LEFT JOIN cust_bill     USING ( invnum     )
2123                     WHERE custnum = ?
2124                       AND taxnum  = ?
2125                       AND year    = ?
2126                       AND month   = ?
2127                 ";
2128                 my $sth = dbh->prepare($sql) or do {
2129                   $dbh->rollback if $oldAutoCommit;
2130                   return "fatal: can't lookup exising exemption: ". dbh->errstr;
2131                 };
2132                 $sth->execute(
2133                   $self->custnum,
2134                   $tax->taxnum,
2135                   1900+$year,
2136                   $mon,
2137                 ) or do {
2138                   $dbh->rollback if $oldAutoCommit;
2139                   return "fatal: can't lookup exising exemption: ". dbh->errstr;
2140                 };
2141                 my $existing_exemption = $sth->fetchrow_arrayref->[0] || 0;
2142
2143                 my $remaining_exemption =
2144                   $tax->exempt_amount - $existing_exemption;
2145                 if ( $remaining_exemption > 0 ) {
2146                   my $addl = $remaining_exemption > $taxable_per_month
2147                     ? $taxable_per_month
2148                     : $remaining_exemption;
2149                   $taxable_charged -= $addl;
2150
2151                   my $cust_tax_exempt_pkg = new FS::cust_tax_exempt_pkg ( {
2152                     'billpkgnum' => $cust_bill_pkg->billpkgnum,
2153                     'taxnum'     => $tax->taxnum,
2154                     'year'       => 1900+$year,
2155                     'month'      => $mon,
2156                     'amount'     => sprintf("%.2f", $addl ),
2157                   } );
2158                   $error = $cust_tax_exempt_pkg->insert;
2159                   if ( $error ) {
2160                     $dbh->rollback if $oldAutoCommit;
2161                     return "fatal: can't insert cust_tax_exempt_pkg: $error";
2162                   }
2163                 } # if $remaining_exemption > 0
2164
2165                 #++
2166                 $mon++;
2167                 #until ( $mon < 12 ) { $mon -= 12; $year++; }
2168                 until ( $mon < 13 ) { $mon -= 12; $year++; }
2169
2170               } #foreach $which_month
2171
2172             } #if $tax->exempt_amount
2173
2174             $taxable_charged = sprintf( "%.2f", $taxable_charged);
2175
2176             #$tax += $taxable_charged * $cust_main_county->tax / 100
2177             $tax{ $tax->taxname || 'Tax' } +=
2178               $taxable_charged * $tax->tax / 100
2179
2180           } #foreach my $tax ( @taxes )
2181
2182         } #unless $self->tax =~ /Y/i || $self->payby eq 'COMP'
2183
2184       } #if $setup != 0 || $recur != 0
2185
2186     } #if $cust_pkg->modified
2187
2188   } #foreach my $cust_pkg
2189
2190   unless ( $cust_bill->cust_bill_pkg ) {
2191     $cust_bill->delete; #don't create an invoice w/o line items
2192     $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2193     return '';
2194   }
2195
2196   my $charged = sprintf( "%.2f", $total_setup + $total_recur );
2197
2198   foreach my $taxname ( grep { $tax{$_} > 0 } keys %tax ) {
2199     my $tax = sprintf("%.2f", $tax{$taxname} );
2200     $charged = sprintf( "%.2f", $charged+$tax );
2201
2202     my $cust_bill_pkg = new FS::cust_bill_pkg ({
2203       'invnum'   => $invnum,
2204       'pkgnum'   => 0,
2205       'setup'    => $tax,
2206       'recur'    => 0,
2207       'sdate'    => '',
2208       'edate'    => '',
2209       'itemdesc' => $taxname,
2210     });
2211     $error = $cust_bill_pkg->insert;
2212     if ( $error ) {
2213       $dbh->rollback if $oldAutoCommit;
2214       return "can't create invoice line item for invoice #$invnum: $error";
2215     }
2216     $total_setup += $tax;
2217
2218   }
2219
2220   $cust_bill->charged( sprintf( "%.2f", $total_setup + $total_recur ) );
2221   $error = $cust_bill->replace;
2222   if ( $error ) {
2223     $dbh->rollback if $oldAutoCommit;
2224     return "can't update charged for invoice #$invnum: $error";
2225   }
2226
2227   foreach my $hook ( @precommit_hooks ) {
2228     eval {
2229       &{$hook}; #($self) ?
2230     };
2231     if ( $@ ) {
2232       $dbh->rollback if $oldAutoCommit;
2233       return "$@ running precommit hook $hook\n";
2234     }
2235   }
2236
2237   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2238   ''; #no error
2239 }
2240
2241 =item collect OPTIONS
2242
2243 (Attempt to) collect money for this customer's outstanding invoices (see
2244 L<FS::cust_bill>).  Usually used after the bill method.
2245
2246 Depending on the value of `payby', this may print or email an invoice (I<BILL>,
2247 I<DCRD>, or I<DCHK>), charge a credit card (I<CARD>), charge via electronic
2248 check/ACH (I<CHEK>), or just add any necessary (pseudo-)payment (I<COMP>).
2249
2250 Most actions are now triggered by invoice events; see L<FS::part_bill_event>
2251 and the invoice events web interface.
2252
2253 If there is an error, returns the error, otherwise returns false.
2254
2255 Options are passed as name-value pairs.
2256
2257 Currently available options are:
2258
2259 invoice_time - Use this time when deciding when to print invoices and
2260 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>
2261 for conversion functions.
2262
2263 retry - Retry card/echeck/LEC transactions even when not scheduled by invoice
2264 events.
2265
2266 quiet - set true to surpress email card/ACH decline notices.
2267
2268 freq - "1d" for the traditional, daily events (the default), or "1m" for the
2269 new monthly events
2270
2271 payby - allows for one time override of normal customer billing method
2272
2273 =cut
2274
2275 sub collect {
2276   my( $self, %options ) = @_;
2277   my $invoice_time = $options{'invoice_time'} || time;
2278
2279   #put below somehow?
2280   local $SIG{HUP} = 'IGNORE';
2281   local $SIG{INT} = 'IGNORE';
2282   local $SIG{QUIT} = 'IGNORE';
2283   local $SIG{TERM} = 'IGNORE';
2284   local $SIG{TSTP} = 'IGNORE';
2285   local $SIG{PIPE} = 'IGNORE';
2286
2287   my $oldAutoCommit = $FS::UID::AutoCommit;
2288   local $FS::UID::AutoCommit = 0;
2289   my $dbh = dbh;
2290
2291   $self->select_for_update; #mutex
2292
2293   my $balance = $self->balance;
2294   warn "$me collect customer ". $self->custnum. ": balance $balance\n"
2295     if $DEBUG;
2296   unless ( $balance > 0 ) { #redundant?????
2297     $dbh->rollback if $oldAutoCommit; #hmm
2298     return '';
2299   }
2300
2301   if ( exists($options{'retry_card'}) ) {
2302     carp 'retry_card option passed to collect is deprecated; use retry';
2303     $options{'retry'} ||= $options{'retry_card'};
2304   }
2305   if ( exists($options{'retry'}) && $options{'retry'} ) {
2306     my $error = $self->retry_realtime;
2307     if ( $error ) {
2308       $dbh->rollback if $oldAutoCommit;
2309       return $error;
2310     }
2311   }
2312
2313   my $extra_sql = '';
2314   if ( defined $options{'freq'} && $options{'freq'} eq '1m' ) {
2315     $extra_sql = " AND freq = '1m' ";
2316   } else {
2317     $extra_sql = " AND ( freq = '1d' OR freq IS NULL OR freq = '' ) ";
2318   }
2319
2320   foreach my $cust_bill ( $self->open_cust_bill ) {
2321
2322     # don't try to charge for the same invoice if it's already in a batch
2323     #next if qsearchs( 'cust_pay_batch', { 'invnum' => $cust_bill->invnum } );
2324
2325     last if $self->balance <= 0;
2326
2327     warn "  invnum ". $cust_bill->invnum. " (owed ". $cust_bill->owed. ")\n"
2328       if $DEBUG > 1;
2329
2330     foreach my $part_bill_event ( due_events ( $cust_bill,
2331                                                exists($options{'payby'})
2332                                                  ? $options{'payby'}
2333                                                  : $self->payby,
2334                                                $invoice_time,
2335                                                $extra_sql ) ) {
2336
2337       last if $cust_bill->owed <= 0  # don't run subsequent events if owed<=0
2338            || $self->balance   <= 0; # or if balance<=0
2339
2340       {
2341         local $realtime_bop_decline_quiet = 1 if $options{'quiet'};
2342         warn "  do_event " .  $cust_bill . " ". (%options) .  "\n"
2343           if $DEBUG > 1;
2344
2345         if (my $error = $part_bill_event->do_event($cust_bill, %options)) {
2346           # gah, even with transactions.
2347           $dbh->commit if $oldAutoCommit; #well.
2348           return $error;
2349         }
2350       }
2351
2352     }
2353
2354   }
2355
2356   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2357   '';
2358
2359 }
2360
2361 =item retry_realtime
2362
2363 Schedules realtime / batch  credit card / electronic check / LEC billing
2364 events for for retry.  Useful if card information has changed or manual
2365 retry is desired.  The 'collect' method must be called to actually retry
2366 the transaction.
2367
2368 Implementation details: For each of this customer's open invoices, changes
2369 the status of the first "done" (with statustext error) realtime processing
2370 event to "failed".
2371
2372 =cut
2373
2374 sub retry_realtime {
2375   my $self = shift;
2376
2377   local $SIG{HUP} = 'IGNORE';
2378   local $SIG{INT} = 'IGNORE';
2379   local $SIG{QUIT} = 'IGNORE';
2380   local $SIG{TERM} = 'IGNORE';
2381   local $SIG{TSTP} = 'IGNORE';
2382   local $SIG{PIPE} = 'IGNORE';
2383
2384   my $oldAutoCommit = $FS::UID::AutoCommit;
2385   local $FS::UID::AutoCommit = 0;
2386   my $dbh = dbh;
2387
2388   foreach my $cust_bill (
2389     grep { $_->cust_bill_event }
2390       $self->open_cust_bill
2391   ) {
2392     my @cust_bill_event =
2393       sort { $a->part_bill_event->seconds <=> $b->part_bill_event->seconds }
2394         grep {
2395                #$_->part_bill_event->plan eq 'realtime-card'
2396                $_->part_bill_event->eventcode =~
2397                    /\$cust_bill\->(batch|realtime)_(card|ach|lec)/
2398                  && $_->status eq 'done'
2399                  && $_->statustext
2400              }
2401           $cust_bill->cust_bill_event;
2402     next unless @cust_bill_event;
2403     my $error = $cust_bill_event[0]->retry;
2404     if ( $error ) {
2405       $dbh->rollback if $oldAutoCommit;
2406       return "error scheduling invoice event for retry: $error";
2407     }
2408
2409   }
2410
2411   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2412   '';
2413
2414 }
2415
2416 =item realtime_bop METHOD AMOUNT [ OPTION => VALUE ... ]
2417
2418 Runs a realtime credit card, ACH (electronic check) or phone bill transaction
2419 via a Business::OnlinePayment realtime gateway.  See
2420 L<http://420.am/business-onlinepayment> for supported gateways.
2421
2422 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2423
2424 Available options are: I<description>, I<invnum>, I<quiet>
2425
2426 The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2427 I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
2428 if set, will override the value from the customer record.
2429
2430 I<description> is a free-text field passed to the gateway.  It defaults to
2431 "Internet services".
2432
2433 If an I<invnum> is specified, this payment (if successful) is applied to the
2434 specified invoice.  If you don't specify an I<invnum> you might want to
2435 call the B<apply_payments> method.
2436
2437 I<quiet> can be set true to surpress email decline notices.
2438
2439 (moved from cust_bill) (probably should get realtime_{card,ach,lec} here too)
2440
2441 =cut
2442
2443 sub realtime_bop {
2444   my( $self, $method, $amount, %options ) = @_;
2445   if ( $DEBUG ) {
2446     warn "$me realtime_bop: $method $amount\n";
2447     warn "  $_ => $options{$_}\n" foreach keys %options;
2448   }
2449
2450   $options{'description'} ||= 'Internet services';
2451
2452   eval "use Business::OnlinePayment";
2453   die $@ if $@;
2454
2455   my $payinfo = exists($options{'payinfo'})
2456                   ? $options{'payinfo'}
2457                   : $self->payinfo;
2458
2459   ###
2460   # select a gateway
2461   ###
2462
2463   my $taxclass = '';
2464   if ( $options{'invnum'} ) {
2465     my $cust_bill = qsearchs('cust_bill', { 'invnum' => $options{'invnum'} } );
2466     die "invnum ". $options{'invnum'}. " not found" unless $cust_bill;
2467     my @taxclasses =
2468       map  { $_->part_pkg->taxclass }
2469       grep { $_ }
2470       map  { $_->cust_pkg }
2471       $cust_bill->cust_bill_pkg;
2472     unless ( grep { $taxclasses[0] ne $_ } @taxclasses ) { #unless there are
2473                                                            #different taxclasses
2474       $taxclass = $taxclasses[0];
2475     }
2476   }
2477
2478   #look for an agent gateway override first
2479   my $cardtype;
2480   if ( $method eq 'CC' ) {
2481     $cardtype = cardtype($payinfo);
2482   } elsif ( $method eq 'ECHECK' ) {
2483     $cardtype = 'ACH';
2484   } else {
2485     $cardtype = $method;
2486   }
2487
2488   my $override =
2489        qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2490                                            cardtype => $cardtype,
2491                                            taxclass => $taxclass,       } )
2492     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2493                                            cardtype => '',
2494                                            taxclass => $taxclass,       } )
2495     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2496                                            cardtype => $cardtype,
2497                                            taxclass => '',              } )
2498     || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2499                                            cardtype => '',
2500                                            taxclass => '',              } );
2501
2502   my $payment_gateway = '';
2503   my( $processor, $login, $password, $action, @bop_options );
2504   if ( $override ) { #use a payment gateway override
2505
2506     $payment_gateway = $override->payment_gateway;
2507
2508     $processor   = $payment_gateway->gateway_module;
2509     $login       = $payment_gateway->gateway_username;
2510     $password    = $payment_gateway->gateway_password;
2511     $action      = $payment_gateway->gateway_action;
2512     @bop_options = $payment_gateway->options;
2513
2514   } else { #use the standard settings from the config
2515
2516     ( $processor, $login, $password, $action, @bop_options ) =
2517       $self->default_payment_gateway($method);
2518
2519   }
2520
2521   ###
2522   # massage data
2523   ###
2524
2525   my $address = exists($options{'address1'})
2526                     ? $options{'address1'}
2527                     : $self->address1;
2528   my $address2 = exists($options{'address2'})
2529                     ? $options{'address2'}
2530                     : $self->address2;
2531   $address .= ", ". $address2 if length($address2);
2532
2533   my $o_payname = exists($options{'payname'})
2534                     ? $options{'payname'}
2535                     : $self->payname;
2536   my($payname, $payfirst, $paylast);
2537   if ( $o_payname && $method ne 'ECHECK' ) {
2538     ($payname = $o_payname) =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
2539       or return "Illegal payname $payname";
2540     ($payfirst, $paylast) = ($1, $2);
2541   } else {
2542     $payfirst = $self->getfield('first');
2543     $paylast = $self->getfield('last');
2544     $payname =  "$payfirst $paylast";
2545   }
2546
2547   my @invoicing_list = $self->invoicing_list_emailonly;
2548   if ( $conf->exists('emailinvoiceautoalways')
2549        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
2550        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
2551     push @invoicing_list, $self->all_emails;
2552   }
2553
2554   my $email = ($conf->exists('business-onlinepayment-email-override'))
2555               ? $conf->config('business-onlinepayment-email-override')
2556               : $invoicing_list[0];
2557
2558   my %content = ();
2559
2560   my $payip = exists($options{'payip'})
2561                 ? $options{'payip'}
2562                 : $self->payip;
2563   $content{customer_ip} = $payip
2564     if length($payip);
2565
2566   $content{invoice_number} = $options{'invnum'}
2567     if exists($options{'invnum'}) && length($options{'invnum'});
2568
2569   if ( $method eq 'CC' ) {
2570
2571     $content{card_number} = $payinfo;
2572     my $paydate = exists($options{'paydate'})
2573                     ? $options{'paydate'}
2574                     : $self->paydate;
2575     $paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
2576     $content{expiration} = "$2/$1";
2577
2578     my $paycvv = exists($options{'paycvv'})
2579                    ? $options{'paycvv'}
2580                    : $self->paycvv;
2581     $content{cvv2} = $self->paycvv
2582       if length($paycvv);
2583
2584     my $paystart_month = exists($options{'paystart_month'})
2585                            ? $options{'paystart_month'}
2586                            : $self->paystart_month;
2587
2588     my $paystart_year  = exists($options{'paystart_year'})
2589                            ? $options{'paystart_year'}
2590                            : $self->paystart_year;
2591
2592     $content{card_start} = "$paystart_month/$paystart_year"
2593       if $paystart_month && $paystart_year;
2594
2595     my $payissue       = exists($options{'payissue'})
2596                            ? $options{'payissue'}
2597                            : $self->payissue;
2598     $content{issue_number} = $payissue if $payissue;
2599
2600     $content{recurring_billing} = 'YES'
2601       if qsearch('cust_pay', { 'custnum' => $self->custnum,
2602                                'payby'   => 'CARD',
2603                                'payinfo' => $payinfo,
2604                              } )
2605       || qsearch('cust_pay', { 'custnum' => $self->custnum,
2606                                'payby'   => 'CARD',
2607                                'paymask' => $self->mask_payinfo('CARD', $payinfo),
2608                              } );
2609
2610
2611   } elsif ( $method eq 'ECHECK' ) {
2612     ( $content{account_number}, $content{routing_code} ) =
2613       split('@', $payinfo);
2614     $content{bank_name} = $o_payname;
2615     $content{bank_state} = $self->getfield('paystate');
2616     $content{account_type} = uc($self->getfield('paytype')) || 'CHECKING';
2617     $content{account_name} = $payname;
2618     $content{customer_org} = $self->company ? 'B' : 'I';
2619     $content{state_id}       = $self->getfield('stateid');
2620     $content{state_id_state} = $self->getfield('stateid_state');
2621     $content{customer_ssn} = exists($options{'ss'})
2622                                ? $options{'ss'}
2623                                : $self->ss;
2624   } elsif ( $method eq 'LEC' ) {
2625     $content{phone} = $payinfo;
2626   }
2627
2628   ###
2629   # run transaction(s)
2630   ###
2631
2632   my( $action1, $action2 ) = split(/\s*\,\s*/, $action );
2633
2634   my $transaction = new Business::OnlinePayment( $processor, @bop_options );
2635   $transaction->content(
2636     'type'           => $method,
2637     'login'          => $login,
2638     'password'       => $password,
2639     'action'         => $action1,
2640     'description'    => $options{'description'},
2641     'amount'         => $amount,
2642     #'invoice_number' => $options{'invnum'},
2643     'customer_id'    => $self->custnum,
2644     'last_name'      => $paylast,
2645     'first_name'     => $payfirst,
2646     'name'           => $payname,
2647     'address'        => $address,
2648     'city'           => ( exists($options{'city'})
2649                             ? $options{'city'}
2650                             : $self->city          ),
2651     'state'          => ( exists($options{'state'})
2652                             ? $options{'state'}
2653                             : $self->state          ),
2654     'zip'            => ( exists($options{'zip'})
2655                             ? $options{'zip'}
2656                             : $self->zip          ),
2657     'country'        => ( exists($options{'country'})
2658                             ? $options{'country'}
2659                             : $self->country          ),
2660     'referer'        => 'http://cleanwhisker.420.am/',
2661     'email'          => $email,
2662     'phone'          => $self->daytime || $self->night,
2663     %content, #after
2664   );
2665   $transaction->submit();
2666
2667   if ( $transaction->is_success() && $action2 ) {
2668     my $auth = $transaction->authorization;
2669     my $ordernum = $transaction->can('order_number')
2670                    ? $transaction->order_number
2671                    : '';
2672
2673     my $capture =
2674       new Business::OnlinePayment( $processor, @bop_options );
2675
2676     my %capture = (
2677       %content,
2678       type           => $method,
2679       action         => $action2,
2680       login          => $login,
2681       password       => $password,
2682       order_number   => $ordernum,
2683       amount         => $amount,
2684       authorization  => $auth,
2685       description    => $options{'description'},
2686     );
2687
2688     foreach my $field (qw( authorization_source_code returned_ACI
2689                            transaction_identifier validation_code
2690                            transaction_sequence_num local_transaction_date
2691                            local_transaction_time AVS_result_code          )) {
2692       $capture{$field} = $transaction->$field() if $transaction->can($field);
2693     }
2694
2695     $capture->content( %capture );
2696
2697     $capture->submit();
2698
2699     unless ( $capture->is_success ) {
2700       my $e = "Authorization successful but capture failed, custnum #".
2701               $self->custnum. ': '.  $capture->result_code.
2702               ": ". $capture->error_message;
2703       warn $e;
2704       return $e;
2705     }
2706
2707   }
2708
2709   ###
2710   # remove paycvv after initial transaction
2711   ###
2712
2713   #false laziness w/misc/process/payment.cgi - check both to make sure working
2714   # correctly
2715   if ( defined $self->dbdef_table->column('paycvv')
2716        && length($self->paycvv)
2717        && ! grep { $_ eq cardtype($payinfo) } $conf->config('cvv-save')
2718   ) {
2719     my $error = $self->remove_cvv;
2720     if ( $error ) {
2721       warn "WARNING: error removing cvv: $error\n";
2722     }
2723   }
2724
2725   ###
2726   # result handling
2727   ###
2728
2729   if ( $transaction->is_success() ) {
2730
2731     my %method2payby = (
2732       'CC'     => 'CARD',
2733       'ECHECK' => 'CHEK',
2734       'LEC'    => 'LECB',
2735     );
2736
2737     my $paybatch = '';
2738     if ( $payment_gateway ) { # agent override
2739       $paybatch = $payment_gateway->gatewaynum. '-';
2740     }
2741
2742     $paybatch .= "$processor:". $transaction->authorization;
2743
2744     $paybatch .= ':'. $transaction->order_number
2745       if $transaction->can('order_number')
2746       && length($transaction->order_number);
2747
2748     my $cust_pay = new FS::cust_pay ( {
2749        'custnum'  => $self->custnum,
2750        'invnum'   => $options{'invnum'},
2751        'paid'     => $amount,
2752        '_date'     => '',
2753        'payby'    => $method2payby{$method},
2754        'payinfo'  => $payinfo,
2755        'paybatch' => $paybatch,
2756     } );
2757     my $error = $cust_pay->insert($options{'manual'} ? ( 'manual' => 1 ) : () );
2758     if ( $error ) {
2759       $cust_pay->invnum(''); #try again with no specific invnum
2760       my $error2 = $cust_pay->insert( $options{'manual'} ?
2761                                       ( 'manual' => 1 ) : ()
2762                                     );
2763       if ( $error2 ) {
2764         # gah, even with transactions.
2765         my $e = 'WARNING: Card/ACH debited but database not updated - '.
2766                 "error inserting payment ($processor): $error2".
2767                 " (previously tried insert with invnum #$options{'invnum'}" .
2768                 ": $error )";
2769         warn $e;
2770         return $e;
2771       }
2772     }
2773     return ''; #no error
2774
2775   } else {
2776
2777     my $perror = "$processor error: ". $transaction->error_message;
2778
2779     unless ( $transaction->error_message ) {
2780
2781       my $t_response;
2782       if ( $transaction->can('response_page') ) {
2783         $t_response = {
2784                         'page'    => ( $transaction->can('response_page')
2785                                          ? $transaction->response_page
2786                                          : ''
2787                                      ),
2788                         'code'    => ( $transaction->can('response_code')
2789                                          ? $transaction->response_code
2790                                          : ''
2791                                      ),
2792                         'headers' => ( $transaction->can('response_headers')
2793                                          ? $transaction->response_headers
2794                                          : ''
2795                                      ),
2796                       };
2797       } else {
2798         $t_response .=
2799           "No additional debugging information available for $processor";
2800       }
2801
2802       $perror .= "No error_message returned from $processor -- ".
2803                  ( ref($t_response) ? Dumper($t_response) : $t_response );
2804
2805     }
2806
2807     if ( !$options{'quiet'} && !$realtime_bop_decline_quiet
2808          && $conf->exists('emaildecline')
2809          && grep { $_ ne 'POST' } $self->invoicing_list
2810          && ! grep { $transaction->error_message =~ /$_/ }
2811                    $conf->config('emaildecline-exclude')
2812     ) {
2813       my @templ = $conf->config('declinetemplate');
2814       my $template = new Text::Template (
2815         TYPE   => 'ARRAY',
2816         SOURCE => [ map "$_\n", @templ ],
2817       ) or return "($perror) can't create template: $Text::Template::ERROR";
2818       $template->compile()
2819         or return "($perror) can't compile template: $Text::Template::ERROR";
2820
2821       my $templ_hash = { error => $transaction->error_message };
2822
2823       my $error = send_email(
2824         'from'    => $conf->config('invoice_from'),
2825         'to'      => [ grep { $_ ne 'POST' } $self->invoicing_list ],
2826         'subject' => 'Your payment could not be processed',
2827         'body'    => [ $template->fill_in(HASH => $templ_hash) ],
2828       );
2829
2830       $perror .= " (also received error sending decline notification: $error)"
2831         if $error;
2832
2833     }
2834
2835     return $perror;
2836   }
2837
2838 }
2839
2840 =item default_payment_gateway
2841
2842 =cut
2843
2844 sub default_payment_gateway {
2845   my( $self, $method ) = @_;
2846
2847   die "Real-time processing not enabled\n"
2848     unless $conf->exists('business-onlinepayment');
2849
2850   #load up config
2851   my $bop_config = 'business-onlinepayment';
2852   $bop_config .= '-ach'
2853     if $method eq 'ECHECK' && $conf->exists($bop_config. '-ach');
2854   my ( $processor, $login, $password, $action, @bop_options ) =
2855     $conf->config($bop_config);
2856   $action ||= 'normal authorization';
2857   pop @bop_options if scalar(@bop_options) % 2 && $bop_options[-1] =~ /^\s*$/;
2858   die "No real-time processor is enabled - ".
2859       "did you set the business-onlinepayment configuration value?\n"
2860     unless $processor;
2861
2862   ( $processor, $login, $password, $action, @bop_options )
2863 }
2864
2865 =item remove_cvv
2866
2867 Removes the I<paycvv> field from the database directly.
2868
2869 If there is an error, returns the error, otherwise returns false.
2870
2871 =cut
2872
2873 sub remove_cvv {
2874   my $self = shift;
2875   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2876     or return dbh->errstr;
2877   $sth->execute($self->custnum)
2878     or return $sth->errstr;
2879   $self->paycvv('');
2880   '';
2881 }
2882
2883 =item realtime_refund_bop METHOD [ OPTION => VALUE ... ]
2884
2885 Refunds a realtime credit card, ACH (electronic check) or phone bill transaction
2886 via a Business::OnlinePayment realtime gateway.  See
2887 L<http://420.am/business-onlinepayment> for supported gateways.
2888
2889 Available methods are: I<CC>, I<ECHECK> and I<LEC>
2890
2891 Available options are: I<amount>, I<reason>, I<paynum>
2892
2893 Most gateways require a reference to an original payment transaction to refund,
2894 so you probably need to specify a I<paynum>.
2895
2896 I<amount> defaults to the original amount of the payment if not specified.
2897
2898 I<reason> specifies a reason for the refund.
2899
2900 Implementation note: If I<amount> is unspecified or equal to the amount of the
2901 orignal payment, first an attempt is made to "void" the transaction via
2902 the gateway (to cancel a not-yet settled transaction) and then if that fails,
2903 the normal attempt is made to "refund" ("credit") the transaction via the
2904 gateway is attempted.
2905
2906 #The additional options I<payname>, I<address1>, I<address2>, I<city>, I<state>,
2907 #I<zip>, I<payinfo> and I<paydate> are also available.  Any of these options,
2908 #if set, will override the value from the customer record.
2909
2910 #If an I<invnum> is specified, this payment (if successful) is applied to the
2911 #specified invoice.  If you don't specify an I<invnum> you might want to
2912 #call the B<apply_payments> method.
2913
2914 =cut
2915
2916 #some false laziness w/realtime_bop, not enough to make it worth merging
2917 #but some useful small subs should be pulled out
2918 sub realtime_refund_bop {
2919   my( $self, $method, %options ) = @_;
2920   if ( $DEBUG ) {
2921     warn "$me realtime_refund_bop: $method refund\n";
2922     warn "  $_ => $options{$_}\n" foreach keys %options;
2923   }
2924
2925   eval "use Business::OnlinePayment";
2926   die $@ if $@;
2927
2928   ###
2929   # look up the original payment and optionally a gateway for that payment
2930   ###
2931
2932   my $cust_pay = '';
2933   my $amount = $options{'amount'};
2934
2935   my( $processor, $login, $password, @bop_options ) ;
2936   my( $auth, $order_number ) = ( '', '', '' );
2937
2938   if ( $options{'paynum'} ) {
2939
2940     warn "  paynum: $options{paynum}\n" if $DEBUG > 1;
2941     $cust_pay = qsearchs('cust_pay', { paynum=>$options{'paynum'} } )
2942       or return "Unknown paynum $options{'paynum'}";
2943     $amount ||= $cust_pay->paid;
2944
2945     $cust_pay->paybatch =~ /^((\d+)\-)?(\w+):\s*([\w\-\/ ]*)(:([\w\-]+))?$/
2946       or return "Can't parse paybatch for paynum $options{'paynum'}: ".
2947                 $cust_pay->paybatch;
2948     my $gatewaynum = '';
2949     ( $gatewaynum, $processor, $auth, $order_number ) = ( $2, $3, $4, $6 );
2950
2951     if ( $gatewaynum ) { #gateway for the payment to be refunded
2952
2953       my $payment_gateway =
2954         qsearchs('payment_gateway', { 'gatewaynum' => $gatewaynum } );
2955       die "payment gateway $gatewaynum not found"
2956         unless $payment_gateway;
2957
2958       $processor   = $payment_gateway->gateway_module;
2959       $login       = $payment_gateway->gateway_username;
2960       $password    = $payment_gateway->gateway_password;
2961       @bop_options = $payment_gateway->options;
2962
2963     } else { #try the default gateway
2964
2965       my( $conf_processor, $unused_action );
2966       ( $conf_processor, $login, $password, $unused_action, @bop_options ) =
2967         $self->default_payment_gateway($method);
2968
2969       return "processor of payment $options{'paynum'} $processor does not".
2970              " match default processor $conf_processor"
2971         unless $processor eq $conf_processor;
2972
2973     }
2974
2975
2976   } else { # didn't specify a paynum, so look for agent gateway overrides
2977            # like a normal transaction
2978
2979     my $cardtype;
2980     if ( $method eq 'CC' ) {
2981       $cardtype = cardtype($self->payinfo);
2982     } elsif ( $method eq 'ECHECK' ) {
2983       $cardtype = 'ACH';
2984     } else {
2985       $cardtype = $method;
2986     }
2987     my $override =
2988            qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2989                                                cardtype => $cardtype,
2990                                                taxclass => '',              } )
2991         || qsearchs('agent_payment_gateway', { agentnum => $self->agentnum,
2992                                                cardtype => '',
2993                                                taxclass => '',              } );
2994
2995     if ( $override ) { #use a payment gateway override
2996
2997       my $payment_gateway = $override->payment_gateway;
2998
2999       $processor   = $payment_gateway->gateway_module;
3000       $login       = $payment_gateway->gateway_username;
3001       $password    = $payment_gateway->gateway_password;
3002       #$action      = $payment_gateway->gateway_action;
3003       @bop_options = $payment_gateway->options;
3004
3005     } else { #use the standard settings from the config
3006
3007       my $unused_action;
3008       ( $processor, $login, $password, $unused_action, @bop_options ) =
3009         $self->default_payment_gateway($method);
3010
3011     }
3012
3013   }
3014   return "neither amount nor paynum specified" unless $amount;
3015
3016   my %content = (
3017     'type'           => $method,
3018     'login'          => $login,
3019     'password'       => $password,
3020     'order_number'   => $order_number,
3021     'amount'         => $amount,
3022     'referer'        => 'http://cleanwhisker.420.am/',
3023   );
3024   $content{authorization} = $auth
3025     if length($auth); #echeck/ACH transactions have an order # but no auth
3026                       #(at least with authorize.net)
3027
3028   #first try void if applicable
3029   if ( $cust_pay && $cust_pay->paid == $amount ) { #and check dates?
3030     warn "  attempting void\n" if $DEBUG > 1;
3031     my $void = new Business::OnlinePayment( $processor, @bop_options );
3032     $void->content( 'action' => 'void', %content );
3033     $void->submit();
3034     if ( $void->is_success ) {
3035       my $error = $cust_pay->void($options{'reason'});
3036       if ( $error ) {
3037         # gah, even with transactions.
3038         my $e = 'WARNING: Card/ACH voided but database not updated - '.
3039                 "error voiding payment: $error";
3040         warn $e;
3041         return $e;
3042       }
3043       warn "  void successful\n" if $DEBUG > 1;
3044       return '';
3045     }
3046   }
3047
3048   warn "  void unsuccessful, trying refund\n"
3049     if $DEBUG > 1;
3050
3051   #massage data
3052   my $address = $self->address1;
3053   $address .= ", ". $self->address2 if $self->address2;
3054
3055   my($payname, $payfirst, $paylast);
3056   if ( $self->payname && $method ne 'ECHECK' ) {
3057     $payname = $self->payname;
3058     $payname =~ /^\s*([\w \,\.\-\']*)?\s+([\w\,\.\-\']+)\s*$/
3059       or return "Illegal payname $payname";
3060     ($payfirst, $paylast) = ($1, $2);
3061   } else {
3062     $payfirst = $self->getfield('first');
3063     $paylast = $self->getfield('last');
3064     $payname =  "$payfirst $paylast";
3065   }
3066
3067   my @invoicing_list = $self->invoicing_list_emailonly;
3068   if ( $conf->exists('emailinvoiceautoalways')
3069        || $conf->exists('emailinvoiceauto') && ! @invoicing_list
3070        || ( $conf->exists('emailinvoiceonly') && ! @invoicing_list ) ) {
3071     push @invoicing_list, $self->all_emails;
3072   }
3073
3074   my $email = ($conf->exists('business-onlinepayment-email-override'))
3075               ? $conf->config('business-onlinepayment-email-override')
3076               : $invoicing_list[0];
3077
3078   my $payip = exists($options{'payip'})
3079                 ? $options{'payip'}
3080                 : $self->payip;
3081   $content{customer_ip} = $payip
3082     if length($payip);
3083
3084   my $payinfo = '';
3085   if ( $method eq 'CC' ) {
3086
3087     if ( $cust_pay ) {
3088       $content{card_number} = $payinfo = $cust_pay->payinfo;
3089       #$self->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3090       #$content{expiration} = "$2/$1";
3091     } else {
3092       $content{card_number} = $payinfo = $self->payinfo;
3093       $self->paydate =~ /^\d{2}(\d{2})[\/\-](\d+)[\/\-]\d+$/;
3094       $content{expiration} = "$2/$1";
3095     }
3096
3097   } elsif ( $method eq 'ECHECK' ) {
3098     ( $content{account_number}, $content{routing_code} ) =
3099       split('@', $payinfo = $self->payinfo);
3100     $content{bank_name} = $self->payname;
3101     $content{account_type} = 'CHECKING';
3102     $content{account_name} = $payname;
3103     $content{customer_org} = $self->company ? 'B' : 'I';
3104     $content{customer_ssn} = $self->ss;
3105   } elsif ( $method eq 'LEC' ) {
3106     $content{phone} = $payinfo = $self->payinfo;
3107   }
3108
3109   #then try refund
3110   my $refund = new Business::OnlinePayment( $processor, @bop_options );
3111   my %sub_content = $refund->content(
3112     'action'         => 'credit',
3113     'customer_id'    => $self->custnum,
3114     'last_name'      => $paylast,
3115     'first_name'     => $payfirst,
3116     'name'           => $payname,
3117     'address'        => $address,
3118     'city'           => $self->city,
3119     'state'          => $self->state,
3120     'zip'            => $self->zip,
3121     'country'        => $self->country,
3122     'email'          => $email,
3123     'phone'          => $self->daytime || $self->night,
3124     %content, #after
3125   );
3126   warn join('', map { "  $_ => $sub_content{$_}\n" } keys %sub_content )
3127     if $DEBUG > 1;
3128   $refund->submit();
3129
3130   return "$processor error: ". $refund->error_message
3131     unless $refund->is_success();
3132
3133   my %method2payby = (
3134     'CC'     => 'CARD',
3135     'ECHECK' => 'CHEK',
3136     'LEC'    => 'LECB',
3137   );
3138
3139   my $paybatch = "$processor:". $refund->authorization;
3140   $paybatch .= ':'. $refund->order_number
3141     if $refund->can('order_number') && $refund->order_number;
3142
3143   while ( $cust_pay && $cust_pay->unapplied < $amount ) {
3144     my @cust_bill_pay = $cust_pay->cust_bill_pay;
3145     last unless @cust_bill_pay;
3146     my $cust_bill_pay = pop @cust_bill_pay;
3147     my $error = $cust_bill_pay->delete;
3148     last if $error;
3149   }
3150
3151   my $cust_refund = new FS::cust_refund ( {
3152     'custnum'  => $self->custnum,
3153     'paynum'   => $options{'paynum'},
3154     'refund'   => $amount,
3155     '_date'    => '',
3156     'payby'    => $method2payby{$method},
3157     'payinfo'  => $payinfo,
3158     'paybatch' => $paybatch,
3159     'reason'   => $options{'reason'} || 'card or ACH refund',
3160   } );
3161   my $error = $cust_refund->insert;
3162   if ( $error ) {
3163     $cust_refund->paynum(''); #try again with no specific paynum
3164     my $error2 = $cust_refund->insert;
3165     if ( $error2 ) {
3166       # gah, even with transactions.
3167       my $e = 'WARNING: Card/ACH refunded but database not updated - '.
3168               "error inserting refund ($processor): $error2".
3169               " (previously tried insert with paynum #$options{'paynum'}" .
3170               ": $error )";
3171       warn $e;
3172       return $e;
3173     }
3174   }
3175
3176   ''; #no error
3177
3178 }
3179
3180 =item total_owed
3181
3182 Returns the total owed for this customer on all invoices
3183 (see L<FS::cust_bill/owed>).
3184
3185 =cut
3186
3187 sub total_owed {
3188   my $self = shift;
3189   $self->total_owed_date(2145859200); #12/31/2037
3190 }
3191
3192 =item total_owed_date TIME
3193
3194 Returns the total owed for this customer on all invoices with date earlier than
3195 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
3196 see L<Time::Local> and L<Date::Parse> for conversion functions.
3197
3198 =cut
3199
3200 sub total_owed_date {
3201   my $self = shift;
3202   my $time = shift;
3203   my $total_bill = 0;
3204   foreach my $cust_bill (
3205     grep { $_->_date <= $time }
3206       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3207   ) {
3208     $total_bill += $cust_bill->owed;
3209   }
3210   sprintf( "%.2f", $total_bill );
3211 }
3212
3213 =item apply_payments_and_credits
3214
3215 Applies unapplied payments and credits.
3216
3217 In most cases, this new method should be used in place of sequential
3218 apply_payments and apply_credits methods.
3219
3220 =cut
3221
3222 sub apply_payments_and_credits {
3223   my $self = shift;
3224
3225   foreach my $cust_bill ( $self->open_cust_bill ) {
3226     $cust_bill->apply_payments_and_credits;
3227   }
3228
3229 }
3230
3231 =item apply_credits OPTION => VALUE ...
3232
3233 Applies (see L<FS::cust_credit_bill>) unapplied credits (see L<FS::cust_credit>)
3234 to outstanding invoice balances in chronological order (or reverse
3235 chronological order if the I<order> option is set to B<newest>) and returns the
3236 value of any remaining unapplied credits available for refund (see
3237 L<FS::cust_refund>).
3238
3239 =cut
3240
3241 sub apply_credits {
3242   my $self = shift;
3243   my %opt = @_;
3244
3245   return 0 unless $self->total_credited;
3246
3247   my @credits = sort { $b->_date <=> $a->_date} (grep { $_->credited > 0 }
3248       qsearch('cust_credit', { 'custnum' => $self->custnum } ) );
3249
3250   my @invoices = $self->open_cust_bill;
3251   @invoices = sort { $b->_date <=> $a->_date } @invoices
3252     if defined($opt{'order'}) && $opt{'order'} eq 'newest';
3253
3254   my $credit;
3255   foreach my $cust_bill ( @invoices ) {
3256     my $amount;
3257
3258     if ( !defined($credit) || $credit->credited == 0) {
3259       $credit = pop @credits or last;
3260     }
3261
3262     if ($cust_bill->owed >= $credit->credited) {
3263       $amount=$credit->credited;
3264     }else{
3265       $amount=$cust_bill->owed;
3266     }
3267
3268     my $cust_credit_bill = new FS::cust_credit_bill ( {
3269       'crednum' => $credit->crednum,
3270       'invnum'  => $cust_bill->invnum,
3271       'amount'  => $amount,
3272     } );
3273     my $error = $cust_credit_bill->insert;
3274     die $error if $error;
3275
3276     redo if ($cust_bill->owed > 0);
3277
3278   }
3279
3280   return $self->total_credited;
3281 }
3282
3283 =item apply_payments
3284
3285 Applies (see L<FS::cust_bill_pay>) unapplied payments (see L<FS::cust_pay>)
3286 to outstanding invoice balances in chronological order.
3287
3288  #and returns the value of any remaining unapplied payments.
3289
3290 =cut
3291
3292 sub apply_payments {
3293   my $self = shift;
3294
3295   #return 0 unless
3296
3297   my @payments = sort { $b->_date <=> $a->_date } ( grep { $_->unapplied > 0 }
3298       qsearch('cust_pay', { 'custnum' => $self->custnum } ) );
3299
3300   my @invoices = sort { $a->_date <=> $b->_date} (grep { $_->owed > 0 }
3301       qsearch('cust_bill', { 'custnum' => $self->custnum } ) );
3302
3303   my $payment;
3304
3305   foreach my $cust_bill ( @invoices ) {
3306     my $amount;
3307
3308     if ( !defined($payment) || $payment->unapplied == 0 ) {
3309       $payment = pop @payments or last;
3310     }
3311
3312     if ( $cust_bill->owed >= $payment->unapplied ) {
3313       $amount = $payment->unapplied;
3314     } else {
3315       $amount = $cust_bill->owed;
3316     }
3317
3318     my $cust_bill_pay = new FS::cust_bill_pay ( {
3319       'paynum' => $payment->paynum,
3320       'invnum' => $cust_bill->invnum,
3321       'amount' => $amount,
3322     } );
3323     my $error = $cust_bill_pay->insert;
3324     die $error if $error;
3325
3326     redo if ( $cust_bill->owed > 0);
3327
3328   }
3329
3330   return $self->total_unapplied_payments;
3331 }
3332
3333 =item total_credited
3334
3335 Returns the total outstanding credit (see L<FS::cust_credit>) for this
3336 customer.  See L<FS::cust_credit/credited>.
3337
3338 =cut
3339
3340 sub total_credited {
3341   my $self = shift;
3342   my $total_credit = 0;
3343   foreach my $cust_credit ( qsearch('cust_credit', {
3344     'custnum' => $self->custnum,
3345   } ) ) {
3346     $total_credit += $cust_credit->credited;
3347   }
3348   sprintf( "%.2f", $total_credit );
3349 }
3350
3351 =item total_unapplied_payments
3352
3353 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
3354 See L<FS::cust_pay/unapplied>.
3355
3356 =cut
3357
3358 sub total_unapplied_payments {
3359   my $self = shift;
3360   my $total_unapplied = 0;
3361   foreach my $cust_pay ( qsearch('cust_pay', {
3362     'custnum' => $self->custnum,
3363   } ) ) {
3364     $total_unapplied += $cust_pay->unapplied;
3365   }
3366   sprintf( "%.2f", $total_unapplied );
3367 }
3368
3369 =item balance
3370
3371 Returns the balance for this customer (total_owed minus total_credited
3372 minus total_unapplied_payments).
3373
3374 =cut
3375
3376 sub balance {
3377   my $self = shift;
3378   sprintf( "%.2f",
3379     $self->total_owed - $self->total_credited - $self->total_unapplied_payments
3380   );
3381 }
3382
3383 =item balance_date TIME
3384
3385 Returns the balance for this customer, only considering invoices with date
3386 earlier than TIME (total_owed_date minus total_credited minus
3387 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
3388 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
3389 functions.
3390
3391 =cut
3392
3393 sub balance_date {
3394   my $self = shift;
3395   my $time = shift;
3396   sprintf( "%.2f",
3397     $self->total_owed_date($time)
3398       - $self->total_credited
3399       - $self->total_unapplied_payments
3400   );
3401 }
3402
3403 =item in_transit_payments
3404
3405 Returns the total of requests for payments for this customer pending in
3406 batches in transit to the bank.  See L<FS::pay_batch> and L<FS::cust_pay_batch>
3407
3408 =cut
3409
3410 sub in_transit_payments {
3411   my $self = shift;
3412   my $in_transit_payments = 0;
3413   foreach my $pay_batch ( qsearch('pay_batch', {
3414     'status' => 'I',
3415   } ) ) {
3416     foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
3417       'batchnum' => $pay_batch->batchnum,
3418       'custnum' => $self->custnum,
3419     } ) ) {
3420       $in_transit_payments += $cust_pay_batch->amount;
3421     }
3422   }
3423   sprintf( "%.2f", $in_transit_payments );
3424 }
3425
3426 =item paydate_monthyear
3427
3428 Returns a two-element list consisting of the month and year of this customer's
3429 paydate (credit card expiration date for CARD customers)
3430
3431 =cut
3432
3433 sub paydate_monthyear {
3434   my $self = shift;
3435   if ( $self->paydate  =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3436     ( $2, $1 );
3437   } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3438     ( $1, $3 );
3439   } else {
3440     ('', '');
3441   }
3442 }
3443
3444 =item invoicing_list [ ARRAYREF ]
3445
3446 If an arguement is given, sets these email addresses as invoice recipients
3447 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
3448 (except as warnings), so use check_invoicing_list first.
3449
3450 Returns a list of email addresses (with svcnum entries expanded).
3451
3452 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
3453 check it without disturbing anything by passing nothing.
3454
3455 This interface may change in the future.
3456
3457 =cut
3458
3459 sub invoicing_list {
3460   my( $self, $arrayref ) = @_;
3461
3462   if ( $arrayref ) {
3463     my @cust_main_invoice;
3464     if ( $self->custnum ) {
3465       @cust_main_invoice =
3466         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3467     } else {
3468       @cust_main_invoice = ();
3469     }
3470     foreach my $cust_main_invoice ( @cust_main_invoice ) {
3471       #warn $cust_main_invoice->destnum;
3472       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3473         #warn $cust_main_invoice->destnum;
3474         my $error = $cust_main_invoice->delete;
3475         warn $error if $error;
3476       }
3477     }
3478     if ( $self->custnum ) {
3479       @cust_main_invoice =
3480         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3481     } else {
3482       @cust_main_invoice = ();
3483     }
3484     my %seen = map { $_->address => 1 } @cust_main_invoice;
3485     foreach my $address ( @{$arrayref} ) {
3486       next if exists $seen{$address} && $seen{$address};
3487       $seen{$address} = 1;
3488       my $cust_main_invoice = new FS::cust_main_invoice ( {
3489         'custnum' => $self->custnum,
3490         'dest'    => $address,
3491       } );
3492       my $error = $cust_main_invoice->insert;
3493       warn $error if $error;
3494     }
3495   }
3496
3497   if ( $self->custnum ) {
3498     map { $_->address }
3499       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3500   } else {
3501     ();
3502   }
3503
3504 }
3505
3506 =item check_invoicing_list ARRAYREF
3507
3508 Checks these arguements as valid input for the invoicing_list method.  If there
3509 is an error, returns the error, otherwise returns false.
3510
3511 =cut
3512
3513 sub check_invoicing_list {
3514   my( $self, $arrayref ) = @_;
3515   foreach my $address ( @{$arrayref} ) {
3516
3517     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3518       return 'Can\'t add FAX invoice destination with a blank FAX number.';
3519     }
3520
3521     my $cust_main_invoice = new FS::cust_main_invoice ( {
3522       'custnum' => $self->custnum,
3523       'dest'    => $address,
3524     } );
3525     my $error = $self->custnum
3526                 ? $cust_main_invoice->check
3527                 : $cust_main_invoice->checkdest
3528     ;
3529     return $error if $error;
3530   }
3531   '';
3532 }
3533
3534 =item set_default_invoicing_list
3535
3536 Sets the invoicing list to all accounts associated with this customer,
3537 overwriting any previous invoicing list.
3538
3539 =cut
3540
3541 sub set_default_invoicing_list {
3542   my $self = shift;
3543   $self->invoicing_list($self->all_emails);
3544 }
3545
3546 =item all_emails
3547
3548 Returns the email addresses of all accounts provisioned for this customer.
3549
3550 =cut
3551
3552 sub all_emails {
3553   my $self = shift;
3554   my %list;
3555   foreach my $cust_pkg ( $self->all_pkgs ) {
3556     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3557     my @svc_acct =
3558       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3559         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3560           @cust_svc;
3561     $list{$_}=1 foreach map { $_->email } @svc_acct;
3562   }
3563   keys %list;
3564 }
3565
3566 =item invoicing_list_addpost
3567
3568 Adds postal invoicing to this customer.  If this customer is already configured
3569 to receive postal invoices, does nothing.
3570
3571 =cut
3572
3573 sub invoicing_list_addpost {
3574   my $self = shift;
3575   return if grep { $_ eq 'POST' } $self->invoicing_list;
3576   my @invoicing_list = $self->invoicing_list;
3577   push @invoicing_list, 'POST';
3578   $self->invoicing_list(\@invoicing_list);
3579 }
3580
3581 =item invoicing_list_emailonly
3582
3583 Returns the list of email invoice recipients (invoicing_list without non-email
3584 destinations such as POST and FAX).
3585
3586 =cut
3587
3588 sub invoicing_list_emailonly {
3589   my $self = shift;
3590   warn "$me invoicing_list_emailonly called"
3591     if $DEBUG;
3592   grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3593 }
3594
3595 =item invoicing_list_emailonly_scalar
3596
3597 Returns the list of email invoice recipients (invoicing_list without non-email
3598 destinations such as POST and FAX) as a comma-separated scalar.
3599
3600 =cut
3601
3602 sub invoicing_list_emailonly_scalar {
3603   my $self = shift;
3604   warn "$me invoicing_list_emailonly_scalar called"
3605     if $DEBUG;
3606   join(', ', $self->invoicing_list_emailonly);
3607 }
3608
3609 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3610
3611 Returns an array of customers referred by this customer (referral_custnum set
3612 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
3613 customers referred by customers referred by this customer and so on, inclusive.
3614 The default behavior is DEPTH 1 (no recursion).
3615
3616 =cut
3617
3618 sub referral_cust_main {
3619   my $self = shift;
3620   my $depth = @_ ? shift : 1;
3621   my $exclude = @_ ? shift : {};
3622
3623   my @cust_main =
3624     map { $exclude->{$_->custnum}++; $_; }
3625       grep { ! $exclude->{ $_->custnum } }
3626         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3627
3628   if ( $depth > 1 ) {
3629     push @cust_main,
3630       map { $_->referral_cust_main($depth-1, $exclude) }
3631         @cust_main;
3632   }
3633
3634   @cust_main;
3635 }
3636
3637 =item referral_cust_main_ncancelled
3638
3639 Same as referral_cust_main, except only returns customers with uncancelled
3640 packages.
3641
3642 =cut
3643
3644 sub referral_cust_main_ncancelled {
3645   my $self = shift;
3646   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3647 }
3648
3649 =item referral_cust_pkg [ DEPTH ]
3650
3651 Like referral_cust_main, except returns a flat list of all unsuspended (and
3652 uncancelled) packages for each customer.  The number of items in this list may
3653 be useful for comission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3654
3655 =cut
3656
3657 sub referral_cust_pkg {
3658   my $self = shift;
3659   my $depth = @_ ? shift : 1;
3660
3661   map { $_->unsuspended_pkgs }
3662     grep { $_->unsuspended_pkgs }
3663       $self->referral_cust_main($depth);
3664 }
3665
3666 =item referring_cust_main
3667
3668 Returns the single cust_main record for the customer who referred this customer
3669 (referral_custnum), or false.
3670
3671 =cut
3672
3673 sub referring_cust_main {
3674   my $self = shift;
3675   return '' unless $self->referral_custnum;
3676   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3677 }
3678
3679 =item credit AMOUNT, REASON
3680
3681 Applies a credit to this customer.  If there is an error, returns the error,
3682 otherwise returns false.
3683
3684 =cut
3685
3686 sub credit {
3687   my( $self, $amount, $reason ) = @_;
3688   my $cust_credit = new FS::cust_credit {
3689     'custnum' => $self->custnum,
3690     'amount'  => $amount,
3691     'reason'  => $reason,
3692   };
3693   $cust_credit->insert;
3694 }
3695
3696 =item charge AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3697
3698 Creates a one-time charge for this customer.  If there is an error, returns
3699 the error, otherwise returns false.
3700
3701 =cut
3702
3703 sub charge {
3704   my $self = shift;
3705   my ( $amount, $pkg, $comment, $taxclass, $additional );
3706   if ( ref( $_[0] ) ) {
3707     $amount     = $_[0]->{amount};
3708     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3709     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
3710                                            : '$'. sprintf("%.2f",$amount);
3711     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3712     $additional = $_[0]->{additional};
3713   }else{
3714     $amount     = shift;
3715     $pkg        = @_ ? shift : 'One-time charge';
3716     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
3717     $taxclass   = @_ ? shift : '';
3718     $additional = [];
3719   }
3720
3721   local $SIG{HUP} = 'IGNORE';
3722   local $SIG{INT} = 'IGNORE';
3723   local $SIG{QUIT} = 'IGNORE';
3724   local $SIG{TERM} = 'IGNORE';
3725   local $SIG{TSTP} = 'IGNORE';
3726   local $SIG{PIPE} = 'IGNORE';
3727
3728   my $oldAutoCommit = $FS::UID::AutoCommit;
3729   local $FS::UID::AutoCommit = 0;
3730   my $dbh = dbh;
3731
3732   my $part_pkg = new FS::part_pkg ( {
3733     'pkg'      => $pkg,
3734     'comment'  => $comment,
3735     'plan'     => 'flat',
3736     'freq'     => 0,
3737     'disabled' => 'Y',
3738     'taxclass' => $taxclass,
3739   } );
3740
3741   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3742                         ( 0 .. @$additional - 1 )
3743                   ),
3744                   'additional_count' => scalar(@$additional),
3745                   'setup_fee' => $amount,
3746                 );
3747
3748   my $error = $part_pkg->insert( options => \%options );
3749   if ( $error ) {
3750     $dbh->rollback if $oldAutoCommit;
3751     return $error;
3752   }
3753
3754   my $pkgpart = $part_pkg->pkgpart;
3755   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3756   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3757     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3758     $error = $type_pkgs->insert;
3759     if ( $error ) {
3760       $dbh->rollback if $oldAutoCommit;
3761       return $error;
3762     }
3763   }
3764
3765   my $cust_pkg = new FS::cust_pkg ( {
3766     'custnum' => $self->custnum,
3767     'pkgpart' => $pkgpart,
3768   } );
3769
3770   $error = $cust_pkg->insert;
3771   if ( $error ) {
3772     $dbh->rollback if $oldAutoCommit;
3773     return $error;
3774   }
3775
3776   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3777   '';
3778
3779 }
3780
3781 =item cust_bill
3782
3783 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3784
3785 =cut
3786
3787 sub cust_bill {
3788   my $self = shift;
3789   sort { $a->_date <=> $b->_date }
3790     qsearch('cust_bill', { 'custnum' => $self->custnum, } )
3791 }
3792
3793 =item open_cust_bill
3794
3795 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3796 customer.
3797
3798 =cut
3799
3800 sub open_cust_bill {
3801   my $self = shift;
3802   grep { $_->owed > 0 } $self->cust_bill;
3803 }
3804
3805 =item cust_credit
3806
3807 Returns all the credits (see L<FS::cust_credit>) for this customer.
3808
3809 =cut
3810
3811 sub cust_credit {
3812   my $self = shift;
3813   sort { $a->_date <=> $b->_date }
3814     qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3815 }
3816
3817 =item cust_pay
3818
3819 Returns all the payments (see L<FS::cust_pay>) for this customer.
3820
3821 =cut
3822
3823 sub cust_pay {
3824   my $self = shift;
3825   sort { $a->_date <=> $b->_date }
3826     qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3827 }
3828
3829 =item cust_pay_void
3830
3831 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3832
3833 =cut
3834
3835 sub cust_pay_void {
3836   my $self = shift;
3837   sort { $a->_date <=> $b->_date }
3838     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3839 }
3840
3841
3842 =item cust_refund
3843
3844 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3845
3846 =cut
3847
3848 sub cust_refund {
3849   my $self = shift;
3850   sort { $a->_date <=> $b->_date }
3851     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3852 }
3853
3854 =item name
3855
3856 Returns a name string for this customer, either "Company (Last, First)" or
3857 "Last, First".
3858
3859 =cut
3860
3861 sub name {
3862   my $self = shift;
3863   my $name = $self->contact;
3864   $name = $self->company. " ($name)" if $self->company;
3865   $name;
3866 }
3867
3868 =item ship_name
3869
3870 Returns a name string for this (service/shipping) contact, either
3871 "Company (Last, First)" or "Last, First".
3872
3873 =cut
3874
3875 sub ship_name {
3876   my $self = shift;
3877   if ( $self->get('ship_last') ) {
3878     my $name = $self->ship_contact;
3879     $name = $self->ship_company. " ($name)" if $self->ship_company;
3880     $name;
3881   } else {
3882     $self->name;
3883   }
3884 }
3885
3886 =item contact
3887
3888 Returns this customer's full (billing) contact name only, "Last, First"
3889
3890 =cut
3891
3892 sub contact {
3893   my $self = shift;
3894   $self->get('last'). ', '. $self->first;
3895 }
3896
3897 =item ship_contact
3898
3899 Returns this customer's full (shipping) contact name only, "Last, First"
3900
3901 =cut
3902
3903 sub ship_contact {
3904   my $self = shift;
3905   $self->get('ship_last')
3906     ? $self->get('ship_last'). ', '. $self->ship_first
3907     : $self->contact;
3908 }
3909
3910 =item country_full
3911
3912 Returns this customer's full country name
3913
3914 =cut
3915
3916 sub country_full {
3917   my $self = shift;
3918   code2country($self->country);
3919 }
3920
3921 =item cust_status
3922
3923 =item status
3924
3925 Returns a status string for this customer, currently:
3926
3927 =over 4
3928
3929 =item prospect - No packages have ever been ordered
3930
3931 =item active - One or more recurring packages is active
3932
3933 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
3934
3935 =item suspended - All non-cancelled recurring packages are suspended
3936
3937 =item cancelled - All recurring packages are cancelled
3938
3939 =back
3940
3941 =cut
3942
3943 sub status { shift->cust_status(@_); }
3944
3945 sub cust_status {
3946   my $self = shift;
3947   for my $status (qw( prospect active inactive suspended cancelled )) {
3948     my $method = $status.'_sql';
3949     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
3950     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
3951     $sth->execute( ($self->custnum) x $numnum )
3952       or die "Error executing 'SELECT $sql': ". $sth->errstr;
3953     return $status if $sth->fetchrow_arrayref->[0];
3954   }
3955 }
3956
3957 =item ucfirst_cust_status
3958
3959 =item ucfirst_status
3960
3961 Returns the status with the first character capitalized.
3962
3963 =cut
3964
3965 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
3966
3967 sub ucfirst_cust_status {
3968   my $self = shift;
3969   ucfirst($self->cust_status);
3970 }
3971
3972 =item statuscolor
3973
3974 Returns a hex triplet color string for this customer's status.
3975
3976 =cut
3977
3978 use vars qw(%statuscolor);
3979 %statuscolor = (
3980   'prospect'  => '7e0079', #'000000', #black?  naw, purple
3981   'active'    => '00CC00', #green
3982   'inactive'  => '0000CC', #blue
3983   'suspended' => 'FF9900', #yellow
3984   'cancelled' => 'FF0000', #red
3985 );
3986
3987 sub statuscolor { shift->cust_statuscolor(@_); }
3988
3989 sub cust_statuscolor {
3990   my $self = shift;
3991   $statuscolor{$self->cust_status};
3992 }
3993
3994 =back
3995
3996 =head1 CLASS METHODS
3997
3998 =over 4
3999
4000 =item prospect_sql
4001
4002 Returns an SQL expression identifying prospective cust_main records (customers
4003 with no packages ever ordered)
4004
4005 =cut
4006
4007 use vars qw($select_count_pkgs);
4008 $select_count_pkgs =
4009   "SELECT COUNT(*) FROM cust_pkg
4010     WHERE cust_pkg.custnum = cust_main.custnum";
4011
4012 sub select_count_pkgs_sql {
4013   $select_count_pkgs;
4014 }
4015
4016 sub prospect_sql { "
4017   0 = ( $select_count_pkgs )
4018 "; }
4019
4020 =item active_sql
4021
4022 Returns an SQL expression identifying active cust_main records (customers with
4023 no active recurring packages, but otherwise unsuspended/uncancelled).
4024
4025 =cut
4026
4027 sub active_sql { "
4028   0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. "
4029       )
4030 "; }
4031
4032 =item inactive_sql
4033
4034 Returns an SQL expression identifying inactive cust_main records (customers with
4035 active recurring packages).
4036
4037 =cut
4038
4039 sub inactive_sql { "
4040   0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4041   AND
4042   0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " )
4043 "; }
4044
4045 =item susp_sql
4046 =item suspended_sql
4047
4048 Returns an SQL expression identifying suspended cust_main records.
4049
4050 =cut
4051
4052
4053 sub suspended_sql { susp_sql(@_); }
4054 sub susp_sql { "
4055     0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " )
4056     AND
4057     0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " )
4058 "; }
4059
4060 =item cancel_sql
4061 =item cancelled_sql
4062
4063 Returns an SQL expression identifying cancelled cust_main records.
4064
4065 =cut
4066
4067 sub cancelled_sql { cancel_sql(@_); }
4068 sub cancel_sql {
4069
4070   my $recurring_sql = FS::cust_pkg->recurring_sql;
4071   #my $recurring_sql = "
4072   #  '0' != ( select freq from part_pkg
4073   #             where cust_pkg.pkgpart = part_pkg.pkgpart )
4074   #";
4075
4076   "
4077     0 < ( $select_count_pkgs )
4078     AND 0 = ( $select_count_pkgs AND $recurring_sql
4079                   AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
4080             )
4081   ";
4082 }
4083
4084 =item uncancel_sql
4085 =item uncancelled_sql
4086
4087 Returns an SQL expression identifying un-cancelled cust_main records.
4088
4089 =cut
4090
4091 sub uncancelled_sql { uncancel_sql(@_); }
4092 sub uncancel_sql { "
4093   ( 0 < ( $select_count_pkgs
4094                    AND ( cust_pkg.cancel IS NULL
4095                          OR cust_pkg.cancel = 0
4096                        )
4097         )
4098     OR 0 = ( $select_count_pkgs )
4099   )
4100 "; }
4101
4102 =item fuzzy_search FUZZY_HASHREF [ HASHREF, SELECT, EXTRA_SQL, CACHE_OBJ ]
4103
4104 Performs a fuzzy (approximate) search and returns the matching FS::cust_main
4105 records.  Currently, I<first>, I<last> and/or I<company> may be specified (the
4106 appropriate ship_ field is also searched).
4107
4108 Additional options are the same as FS::Record::qsearch
4109
4110 =cut
4111
4112 sub fuzzy_search {
4113   my( $self, $fuzzy, $hash, @opt) = @_;
4114   #$self
4115   $hash ||= {};
4116   my @cust_main = ();
4117
4118   check_and_rebuild_fuzzyfiles();
4119   foreach my $field ( keys %$fuzzy ) {
4120
4121     my $all = $self->all_X($field);
4122     next unless scalar(@$all);
4123
4124     my %match = ();
4125     $match{$_}=1 foreach ( amatch( $fuzzy->{$field}, ['i'], @$all ) );
4126
4127     my @fcust = ();
4128     foreach ( keys %match ) {
4129       push @fcust, qsearch('cust_main', { %$hash, $field=>$_}, @opt);
4130       push @fcust, qsearch('cust_main', { %$hash, "ship_$field"=>$_}, @opt);
4131     }
4132     my %fsaw = ();
4133     push @cust_main, grep { ! $fsaw{$_->custnum}++ } @fcust;
4134   }
4135
4136   # we want the components of $fuzzy ANDed, not ORed, but still don't want dupes
4137   my %saw = ();
4138   @cust_main = grep { ++$saw{$_->custnum} == scalar(keys %$fuzzy) } @cust_main;
4139
4140   @cust_main;
4141
4142 }
4143
4144 =item masked FIELD
4145
4146 Returns a masked version of the named field
4147
4148 =cut
4149
4150 sub masked {
4151 my ($self,$field) = @_;
4152
4153 # Show last four
4154
4155 'x'x(length($self->getfield($field))-4).
4156   substr($self->getfield($field), (length($self->getfield($field))-4));
4157
4158 }
4159
4160 =back
4161
4162 =head1 SUBROUTINES
4163
4164 =over 4
4165
4166 =item smart_search OPTION => VALUE ...
4167
4168 Accepts the following options: I<search>, the string to search for.  The string
4169 will be searched for as a customer number, phone number, name or company name,
4170 as an exact, or, in some cases, a substring or fuzzy match (see the source code
4171 for the exact heuristics used); I<no_fuzzy_on_exact>, causes smart_search to
4172 skip fuzzy matching when an exact match is found.
4173
4174 Any additional options are treated as an additional qualifier on the search
4175 (i.e. I<agentnum>).
4176
4177 Returns a (possibly empty) array of FS::cust_main objects.
4178
4179 =cut
4180
4181 sub smart_search {
4182   my %options = @_;
4183
4184   #here is the agent virtualization
4185   my $agentnums_sql = $FS::CurrentUser::CurrentUser->agentnums_sql;
4186
4187   my @cust_main = ();
4188
4189   my $skip_fuzzy = delete $options{'no_fuzzy_on_exact'};
4190   my $search = delete $options{'search'};
4191   ( my $alphanum_search = $search ) =~ s/\W//g;
4192
4193   if ( $alphanum_search =~ /^1?(\d{3})(\d{3})(\d{4})(\d*)$/ ) { #phone# search
4194
4195     #false laziness w/Record::ut_phone
4196     my $phonen = "$1-$2-$3";
4197     $phonen .= " x$4" if $4;
4198
4199     push @cust_main, qsearch( {
4200       'table'   => 'cust_main',
4201       'hashref' => { %options },
4202       'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4203                      ' ( '.
4204                          join(' OR ', map "$_ = '$phonen'",
4205                                           qw( daytime night fax
4206                                               ship_daytime ship_night ship_fax )
4207                              ).
4208                      ' ) '.
4209                      " AND $agentnums_sql", #agent virtualization
4210     } );
4211
4212     unless ( @cust_main || $phonen =~ /x\d+$/ ) { #no exact match
4213       #try looking for matches with extensions unless one was specified
4214
4215       push @cust_main, qsearch( {
4216         'table'   => 'cust_main',
4217         'hashref' => { %options },
4218         'extra_sql' => ( scalar(keys %options) ? ' AND ' : ' WHERE ' ).
4219                        ' ( '.
4220                            join(' OR ', map "$_ LIKE '$phonen\%'",
4221                                             qw( daytime night
4222                                                 ship_daytime ship_night )
4223                                ).
4224                        ' ) '.
4225                        " AND $agentnums_sql", #agent virtualization
4226       } );
4227
4228     }
4229
4230   } elsif ( $search =~ /^\s*(\d+)\s*$/ ) { # customer # search
4231
4232     push @cust_main, qsearch( {
4233       'table'     => 'cust_main',
4234       'hashref'   => { 'custnum' => $1, %options },
4235       'extra_sql' => " AND $agentnums_sql", #agent virtualization
4236     } );
4237
4238   } elsif ( $search =~ /^\s*(\S.*\S)\s+\((.+), ([^,]+)\)\s*$/ ) {
4239
4240     my($company, $last, $first) = ( $1, $2, $3 );
4241
4242     # "Company (Last, First)"
4243     #this is probably something a browser remembered,
4244     #so just do an exact search
4245
4246     foreach my $prefix ( '', 'ship_' ) {
4247       push @cust_main, qsearch( {
4248         'table'     => 'cust_main',
4249         'hashref'   => { $prefix.'first'   => $first,
4250                          $prefix.'last'    => $last,
4251                          $prefix.'company' => $company,
4252                          %options,
4253                        },
4254         'extra_sql' => " AND $agentnums_sql",
4255       } );
4256     }
4257
4258   } elsif ( $search =~ /^\s*(\S.*\S)\s*$/ ) { # value search
4259                                               # try (ship_){last,company}
4260
4261     my $value = lc($1);
4262
4263     # # remove "(Last, First)" in "Company (Last, First)", otherwise the
4264     # # full strings the browser remembers won't work
4265     # $value =~ s/\([\w \,\.\-\']*\)$//; #false laziness w/Record::ut_name
4266
4267     use Lingua::EN::NameParse;
4268     my $NameParse = new Lingua::EN::NameParse(
4269              auto_clean     => 1,
4270              allow_reversed => 1,
4271     );
4272
4273     my($last, $first) = ( '', '' );
4274     #maybe disable this too and just rely on NameParse?
4275     if ( $value =~ /^(.+),\s*([^,]+)$/ ) { # Last, First
4276
4277       ($last, $first) = ( $1, $2 );
4278
4279     #} elsif  ( $value =~ /^(.+)\s+(.+)$/ ) {
4280     } elsif ( ! $NameParse->parse($value) ) {
4281
4282       my %name = $NameParse->components;
4283       $first = $name{'given_name_1'};
4284       $last  = $name{'surname_1'};
4285
4286     }
4287
4288     if ( $first && $last ) {
4289
4290       my($q_last, $q_first) = ( dbh->quote($last), dbh->quote($first) );
4291
4292       #exact
4293       my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4294       $sql .= "
4295         (     ( LOWER(last) = $q_last AND LOWER(first) = $q_first )
4296            OR ( LOWER(ship_last) = $q_last AND LOWER(ship_first) = $q_first )
4297         )";
4298
4299       push @cust_main, qsearch( {
4300         'table'     => 'cust_main',
4301         'hashref'   => \%options,
4302         'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4303       } );
4304
4305       # or it just be something that was typed in... (try that in a sec)
4306
4307     }
4308
4309     my $q_value = dbh->quote($value);
4310
4311     #exact
4312     my $sql = scalar(keys %options) ? ' AND ' : ' WHERE ';
4313     $sql .= " (    LOWER(last)         = $q_value
4314                 OR LOWER(company)      = $q_value
4315                 OR LOWER(ship_last)    = $q_value
4316                 OR LOWER(ship_company) = $q_value
4317               )";
4318
4319     push @cust_main, qsearch( {
4320       'table'     => 'cust_main',
4321       'hashref'   => \%options,
4322       'extra_sql' => "$sql AND $agentnums_sql", #agent virtualization
4323     } );
4324
4325     #always do substring & fuzzy,
4326     #getting complains searches are not returning enough
4327     unless ( @cust_main && $skip_fuzzy ) {  #no exact match, trying substring/fuzzy
4328
4329       #still some false laziness w/ search/cust_main.cgi
4330
4331       #substring
4332
4333       my @hashrefs = (
4334         { 'company'      => { op=>'ILIKE', value=>"%$value%" }, },
4335         { 'ship_company' => { op=>'ILIKE', value=>"%$value%" }, },
4336       );
4337
4338       if ( $first && $last ) {
4339
4340         push @hashrefs,
4341           { 'first'        => { op=>'ILIKE', value=>"%$first%" },
4342             'last'         => { op=>'ILIKE', value=>"%$last%" },
4343           },
4344           { 'ship_first'   => { op=>'ILIKE', value=>"%$first%" },
4345             'ship_last'    => { op=>'ILIKE', value=>"%$last%" },
4346           },
4347         ;
4348
4349       } else {
4350
4351         push @hashrefs,
4352           { 'last'         => { op=>'ILIKE', value=>"%$value%" }, },
4353           { 'ship_last'    => { op=>'ILIKE', value=>"%$value%" }, },
4354         ;
4355       }
4356
4357       foreach my $hashref ( @hashrefs ) {
4358
4359         push @cust_main, qsearch( {
4360           'table'     => 'cust_main',
4361           'hashref'   => { %$hashref,
4362                            %options,
4363                          },
4364           'extra_sql' => " AND $agentnums_sql", #agent virtualizaiton
4365         } );
4366
4367       }
4368
4369       #fuzzy
4370       my @fuzopts = (
4371         \%options,                #hashref
4372         '',                       #select
4373         " AND $agentnums_sql",    #extra_sql  #agent virtualization
4374       );
4375
4376       if ( $first && $last ) {
4377         push @cust_main, FS::cust_main->fuzzy_search(
4378           { 'last'   => $last,    #fuzzy hashref
4379             'first'  => $first }, #
4380           @fuzopts
4381         );
4382       }
4383       foreach my $field ( 'last', 'company' ) {
4384         push @cust_main,
4385           FS::cust_main->fuzzy_search( { $field => $value }, @fuzopts );
4386       }
4387
4388     }
4389
4390     #eliminate duplicates
4391     my %saw = ();
4392     @cust_main = grep { !$saw{$_->custnum}++ } @cust_main;
4393
4394   }
4395
4396   @cust_main;
4397
4398 }
4399
4400 =item check_and_rebuild_fuzzyfiles
4401
4402 =cut
4403
4404 use vars qw(@fuzzyfields);
4405 @fuzzyfields = ( 'last', 'first', 'company' );
4406
4407 sub check_and_rebuild_fuzzyfiles {
4408   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4409   rebuild_fuzzyfiles() if grep { ! -e "$dir/cust_main.$_" } @fuzzyfields
4410 }
4411
4412 =item rebuild_fuzzyfiles
4413
4414 =cut
4415
4416 sub rebuild_fuzzyfiles {
4417
4418   use Fcntl qw(:flock);
4419
4420   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4421   mkdir $dir, 0700 unless -d $dir;
4422
4423   foreach my $fuzzy ( @fuzzyfields ) {
4424
4425     open(LOCK,">>$dir/cust_main.$fuzzy")
4426       or die "can't open $dir/cust_main.$fuzzy: $!";
4427     flock(LOCK,LOCK_EX)
4428       or die "can't lock $dir/cust_main.$fuzzy: $!";
4429
4430     open (CACHE,">$dir/cust_main.$fuzzy.tmp")
4431       or die "can't open $dir/cust_main.$fuzzy.tmp: $!";
4432
4433     foreach my $field ( $fuzzy, "ship_$fuzzy" ) {
4434       my $sth = dbh->prepare("SELECT $field FROM cust_main".
4435                              " WHERE $field != '' AND $field IS NOT NULL");
4436       $sth->execute or die $sth->errstr;
4437
4438       while ( my $row = $sth->fetchrow_arrayref ) {
4439         print CACHE $row->[0]. "\n";
4440       }
4441
4442     }
4443
4444     close CACHE or die "can't close $dir/cust_main.$fuzzy.tmp: $!";
4445
4446     rename "$dir/cust_main.$fuzzy.tmp", "$dir/cust_main.$fuzzy";
4447     close LOCK;
4448   }
4449
4450 }
4451
4452 =item all_X
4453
4454 =cut
4455
4456 sub all_X {
4457   my( $self, $field ) = @_;
4458   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4459   open(CACHE,"<$dir/cust_main.$field")
4460     or die "can't open $dir/cust_main.$field: $!";
4461   my @array = map { chomp; $_; } <CACHE>;
4462   close CACHE;
4463   \@array;
4464 }
4465
4466 =item append_fuzzyfiles LASTNAME COMPANY
4467
4468 =cut
4469
4470 sub append_fuzzyfiles {
4471   #my( $first, $last, $company ) = @_;
4472
4473   &check_and_rebuild_fuzzyfiles;
4474
4475   use Fcntl qw(:flock);
4476
4477   my $dir = $FS::UID::conf_dir. "cache.". $FS::UID::datasrc;
4478
4479   foreach my $field (qw( first last company )) {
4480     my $value = shift;
4481
4482     if ( $value ) {
4483
4484       open(CACHE,">>$dir/cust_main.$field")
4485         or die "can't open $dir/cust_main.$field: $!";
4486       flock(CACHE,LOCK_EX)
4487         or die "can't lock $dir/cust_main.$field: $!";
4488
4489       print CACHE "$value\n";
4490
4491       flock(CACHE,LOCK_UN)
4492         or die "can't unlock $dir/cust_main.$field: $!";
4493       close CACHE;
4494     }
4495
4496   }
4497
4498   1;
4499 }
4500
4501 =item batch_import
4502
4503 =cut
4504
4505 sub batch_import {
4506   my $param = shift;
4507   #warn join('-',keys %$param);
4508   my $fh = $param->{filehandle};
4509   my $agentnum = $param->{agentnum};
4510
4511   my $refnum = $param->{refnum};
4512   my $pkgpart = $param->{pkgpart};
4513
4514   #my @fields = @{$param->{fields}};
4515   my $format = $param->{'format'};
4516   my @fields;
4517   my $payby;
4518   if ( $format eq 'simple' ) {
4519     @fields = qw( cust_pkg.setup dayphone first last
4520                   address1 address2 city state zip comments );
4521     $payby = 'BILL';
4522   } elsif ( $format eq 'extended' ) {
4523     @fields = qw( agent_custid refnum
4524                   last first address1 address2 city state zip country
4525                   daytime night
4526                   ship_last ship_first ship_address1 ship_address2
4527                   ship_city ship_state ship_zip ship_country
4528                   payinfo paycvv paydate
4529                   invoicing_list
4530                   cust_pkg.pkgpart
4531                   svc_acct.username svc_acct._password
4532                 );
4533     $payby = 'BILL';
4534   } else {
4535     die "unknown format $format";
4536   }
4537
4538   eval "use Text::CSV_XS;";
4539   die $@ if $@;
4540
4541   my $csv = new Text::CSV_XS;
4542   #warn $csv;
4543   #warn $fh;
4544
4545   my $imported = 0;
4546   #my $columns;
4547
4548   local $SIG{HUP} = 'IGNORE';
4549   local $SIG{INT} = 'IGNORE';
4550   local $SIG{QUIT} = 'IGNORE';
4551   local $SIG{TERM} = 'IGNORE';
4552   local $SIG{TSTP} = 'IGNORE';
4553   local $SIG{PIPE} = 'IGNORE';
4554
4555   my $oldAutoCommit = $FS::UID::AutoCommit;
4556   local $FS::UID::AutoCommit = 0;
4557   my $dbh = dbh;
4558
4559   #while ( $columns = $csv->getline($fh) ) {
4560   my $line;
4561   while ( defined($line=<$fh>) ) {
4562
4563     $csv->parse($line) or do {
4564       $dbh->rollback if $oldAutoCommit;
4565       return "can't parse: ". $csv->error_input();
4566     };
4567
4568     my @columns = $csv->fields();
4569     #warn join('-',@columns);
4570
4571     my %cust_main = (
4572       agentnum => $agentnum,
4573       refnum   => $refnum,
4574       country  => $conf->config('countrydefault') || 'US',
4575       payby    => $payby, #default
4576       paydate  => '12/2037', #default
4577     );
4578     my $billtime = time;
4579     my %cust_pkg = ( pkgpart => $pkgpart );
4580     my %svc_acct = ();
4581     foreach my $field ( @fields ) {
4582
4583       if ( $field =~ /^cust_pkg\.(pkgpart|setup|bill|susp|expire|cancel)$/ ) {
4584
4585         #$cust_pkg{$1} = str2time( shift @$columns );
4586         if ( $1 eq 'pkgpart' ) {
4587           $cust_pkg{$1} = shift @columns;
4588         } elsif ( $1 eq 'setup' ) {
4589           $billtime = str2time(shift @columns);
4590         } else {
4591           $cust_pkg{$1} = str2time( shift @columns );
4592         }
4593
4594       } elsif ( $field =~ /^svc_acct\.(username|_password)$/ ) {
4595
4596         $svc_acct{$1} = shift @columns;
4597
4598       } else {
4599
4600         #refnum interception
4601         if ( $field eq 'refnum' && $columns[0] !~ /^\s*(\d+)\s*$/ ) {
4602
4603           my $referral = $columns[0];
4604           my %hash = ( 'referral' => $referral,
4605                        'agentnum' => $agentnum,
4606                        'disabled' => '',
4607                      );
4608
4609           my $part_referral = qsearchs('part_referral', \%hash )
4610                               || new FS::part_referral \%hash;
4611
4612           unless ( $part_referral->refnum ) {
4613             my $error = $part_referral->insert;
4614             if ( $error ) {
4615               $dbh->rollback if $oldAutoCommit;
4616               return "can't auto-insert advertising source: $referral: $error";
4617             }
4618           }
4619
4620           $columns[0] = $part_referral->refnum;
4621         }
4622
4623         #$cust_main{$field} = shift @$columns;
4624         $cust_main{$field} = shift @columns;
4625       }
4626     }
4627
4628     $cust_main{'payby'} = 'CARD' if length($cust_main{'payinfo'});
4629
4630     my $invoicing_list = $cust_main{'invoicing_list'}
4631                            ? [ delete $cust_main{'invoicing_list'} ]
4632                            : [];
4633
4634     my $cust_main = new FS::cust_main ( \%cust_main );
4635
4636     use Tie::RefHash;
4637     tie my %hash, 'Tie::RefHash'; #this part is important
4638
4639     if ( $cust_pkg{'pkgpart'} ) {
4640       my $cust_pkg = new FS::cust_pkg ( \%cust_pkg );
4641
4642       my @svc_acct = ();
4643       if ( $svc_acct{'username'} ) {
4644         my $part_pkg = $cust_pkg->part_pkg;
4645         unless ( $part_pkg ) {
4646           $dbh->rollback if $oldAutoCommit;
4647           return "unknown pkgnum ". $cust_pkg{'pkgpart'};
4648         }
4649         $svc_acct{svcpart} = $part_pkg->svcpart( 'svc_acct' );
4650         push @svc_acct, new FS::svc_acct ( \%svc_acct )
4651       }
4652
4653       $hash{$cust_pkg} = \@svc_acct;
4654     }
4655
4656     my $error = $cust_main->insert( \%hash, $invoicing_list );
4657
4658     if ( $error ) {
4659       $dbh->rollback if $oldAutoCommit;
4660       return "can't insert customer for $line: $error";
4661     }
4662
4663     if ( $format eq 'simple' ) {
4664
4665       #false laziness w/bill.cgi
4666       $error = $cust_main->bill( 'time' => $billtime );
4667       if ( $error ) {
4668         $dbh->rollback if $oldAutoCommit;
4669         return "can't bill customer for $line: $error";
4670       }
4671
4672       $cust_main->apply_payments_and_credits;
4673
4674       $error = $cust_main->collect();
4675       if ( $error ) {
4676         $dbh->rollback if $oldAutoCommit;
4677         return "can't collect customer for $line: $error";
4678       }
4679
4680     }
4681
4682     $imported++;
4683   }
4684
4685   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4686
4687   return "Empty file!" unless $imported;
4688
4689   ''; #no error
4690
4691 }
4692
4693 =item batch_charge
4694
4695 =cut
4696
4697 sub batch_charge {
4698   my $param = shift;
4699   #warn join('-',keys %$param);
4700   my $fh = $param->{filehandle};
4701   my @fields = @{$param->{fields}};
4702
4703   eval "use Text::CSV_XS;";
4704   die $@ if $@;
4705
4706   my $csv = new Text::CSV_XS;
4707   #warn $csv;
4708   #warn $fh;
4709
4710   my $imported = 0;
4711   #my $columns;
4712
4713   local $SIG{HUP} = 'IGNORE';
4714   local $SIG{INT} = 'IGNORE';
4715   local $SIG{QUIT} = 'IGNORE';
4716   local $SIG{TERM} = 'IGNORE';
4717   local $SIG{TSTP} = 'IGNORE';
4718   local $SIG{PIPE} = 'IGNORE';
4719
4720   my $oldAutoCommit = $FS::UID::AutoCommit;
4721   local $FS::UID::AutoCommit = 0;
4722   my $dbh = dbh;
4723
4724   #while ( $columns = $csv->getline($fh) ) {
4725   my $line;
4726   while ( defined($line=<$fh>) ) {
4727
4728     $csv->parse($line) or do {
4729       $dbh->rollback if $oldAutoCommit;
4730       return "can't parse: ". $csv->error_input();
4731     };
4732
4733     my @columns = $csv->fields();
4734     #warn join('-',@columns);
4735
4736     my %row = ();
4737     foreach my $field ( @fields ) {
4738       $row{$field} = shift @columns;
4739     }
4740
4741     my $cust_main = qsearchs('cust_main', { 'custnum' => $row{'custnum'} } );
4742     unless ( $cust_main ) {
4743       $dbh->rollback if $oldAutoCommit;
4744       return "unknown custnum $row{'custnum'}";
4745     }
4746
4747     if ( $row{'amount'} > 0 ) {
4748       my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4749       if ( $error ) {
4750         $dbh->rollback if $oldAutoCommit;
4751         return $error;
4752       }
4753       $imported++;
4754     } elsif ( $row{'amount'} < 0 ) {
4755       my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4756                                       $row{'pkg'}                         );
4757       if ( $error ) {
4758         $dbh->rollback if $oldAutoCommit;
4759         return $error;
4760       }
4761       $imported++;
4762     } else {
4763       #hmm?
4764     }
4765
4766   }
4767
4768   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4769
4770   return "Empty file!" unless $imported;
4771
4772   ''; #no error
4773
4774 }
4775
4776 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4777
4778 Sends a templated email notification to the customer (see L<Text::Template>).
4779
4780 OPTIONS is a hash and may include
4781
4782 I<from> - the email sender (default is invoice_from)
4783
4784 I<to> - comma-separated scalar or arrayref of recipients
4785    (default is invoicing_list)
4786
4787 I<subject> - The subject line of the sent email notification
4788    (default is "Notice from company_name")
4789
4790 I<extra_fields> - a hashref of name/value pairs which will be substituted
4791    into the template
4792
4793 The following variables are vavailable in the template.
4794
4795 I<$first> - the customer first name
4796 I<$last> - the customer last name
4797 I<$company> - the customer company
4798 I<$payby> - a description of the method of payment for the customer
4799             # would be nice to use FS::payby::shortname
4800 I<$payinfo> - the account information used to collect for this customer
4801 I<$expdate> - the expiration of the customer payment in seconds from epoch
4802
4803 =cut
4804
4805 sub notify {
4806   my ($customer, $template, %options) = @_;
4807
4808   return unless $conf->exists($template);
4809
4810   my $from = $conf->config('invoice_from') if $conf->exists('invoice_from');
4811   $from = $options{from} if exists($options{from});
4812
4813   my $to = join(',', $customer->invoicing_list_emailonly);
4814   $to = $options{to} if exists($options{to});
4815
4816   my $subject = "Notice from " . $conf->config('company_name')
4817     if $conf->exists('company_name');
4818   $subject = $options{subject} if exists($options{subject});
4819
4820   my $notify_template = new Text::Template (TYPE => 'ARRAY',
4821                                             SOURCE => [ map "$_\n",
4822                                               $conf->config($template)]
4823                                            )
4824     or die "can't create new Text::Template object: Text::Template::ERROR";
4825   $notify_template->compile()
4826     or die "can't compile template: Text::Template::ERROR";
4827
4828   my $paydate = $customer->paydate;
4829   $FS::notify_template::_template::first = $customer->first;
4830   $FS::notify_template::_template::last = $customer->last;
4831   $FS::notify_template::_template::company = $customer->company;
4832   $FS::notify_template::_template::payinfo = $customer->mask_payinfo;
4833   my $payby = $customer->payby;
4834   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4835   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4836
4837   #credit cards expire at the end of the month/year of their exp date
4838   if ($payby eq 'CARD' || $payby eq 'DCRD') {
4839     $FS::notify_template::_template::payby = 'credit card';
4840     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4841     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4842     $expire_time--;
4843   }elsif ($payby eq 'COMP') {
4844     $FS::notify_template::_template::payby = 'complimentary account';
4845   }else{
4846     $FS::notify_template::_template::payby = 'current method';
4847   }
4848   $FS::notify_template::_template::expdate = $expire_time;
4849
4850   for (keys %{$options{extra_fields}}){
4851     no strict "refs";
4852     ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4853   }
4854
4855   send_email(from => $from,
4856              to => $to,
4857              subject => $subject,
4858              body => $notify_template->fill_in( PACKAGE =>
4859                                                 'FS::notify_template::_template'                                              ),
4860             );
4861
4862 }
4863
4864 =back
4865
4866 =head1 BUGS
4867
4868 The delete method.
4869
4870 The delete method should possibly take an FS::cust_main object reference
4871 instead of a scalar customer number.
4872
4873 Bill and collect options should probably be passed as references instead of a
4874 list.
4875
4876 There should probably be a configuration file with a list of allowed credit
4877 card types.
4878
4879 No multiple currency support (probably a larger project than just this module).
4880
4881 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
4882
4883 Birthdates rely on negative epoch values.
4884
4885 =head1 SEE ALSO
4886
4887 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
4888 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
4889 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
4890
4891 =cut
4892
4893 1;
4894