FS/FS/cust_main.pm

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