FS/FS/cust_main.pm

   1 package FS::cust_main;
   2
   3 require 5.006;
   4 use strict;
   5              #FS::cust_main:_Marketgear when they're ready to move to 2.1
   6 use base qw( FS::cust_main::Packages FS::cust_main::Status
   7              FS::cust_main::Billing FS::cust_main::Billing_Realtime
   8              FS::cust_main::Billing_Discount
   9              FS::otaker_Mixin FS::payinfo_Mixin FS::cust_main_Mixin
  10              FS::geocode_Mixin
  11              FS::Record
  12            );
  13 use vars qw( $DEBUG $me $conf
  14              @encrypted_fields
  15              $import
  16              $ignore_expired_card $ignore_illegal_zip $ignore_banned_card
  17              $skip_fuzzyfiles
  18              @paytypes
  19            );
  20 use Carp;
  21 use Scalar::Util qw( blessed );
  22 use Time::Local qw(timelocal);
  23 use Storable qw(thaw);
  24 use MIME::Base64;
  25 use Data::Dumper;
  26 use Tie::IxHash;
  27 use Digest::MD5 qw(md5_base64);
  28 use Date::Format;
  29 #use Date::Manip;
  30 use File::Temp; #qw( tempfile );
  31 use Business::CreditCard 0.28;
  32 use Locale::Country;
  33 use FS::UID qw( getotaker dbh driver_name );
  34 use FS::Record qw( qsearchs qsearch dbdef regexp_sql );
  35 use FS::Misc qw( generate_email send_email generate_ps do_print );
  36 use FS::Msgcat qw(gettext);
  37 use FS::CurrentUser;
  38 use FS::TicketSystem;
  39 use FS::payby;
  40 use FS::cust_pkg;
  41 use FS::cust_svc;
  42 use FS::cust_bill;
  43 use FS::legacy_cust_bill;
  44 use FS::cust_pay;
  45 use FS::cust_pay_pending;
  46 use FS::cust_pay_void;
  47 use FS::cust_pay_batch;
  48 use FS::cust_credit;
  49 use FS::cust_refund;
  50 use FS::part_referral;
  51 use FS::cust_main_county;
  52 use FS::cust_location;
  53 use FS::cust_class;
  54 use FS::cust_main_exemption;
  55 use FS::cust_tax_adjustment;
  56 use FS::cust_tax_location;
  57 use FS::agent;
  58 use FS::cust_main_invoice;
  59 use FS::cust_tag;
  60 use FS::prepay_credit;
  61 use FS::queue;
  62 use FS::part_pkg;
  63 use FS::part_export;
  64 #use FS::cust_event;
  65 use FS::type_pkgs;
  66 use FS::payment_gateway;
  67 use FS::agent_payment_gateway;
  68 use FS::banned_pay;
  69 use FS::cust_main_note;
  70 use FS::cust_attachment;
  71 use FS::contact;
  72 use FS::Locales;
  73
  74 # 1 is mostly method/subroutine entry and options
  75 # 2 traces progress of some operations
  76 # 3 is even more information including possibly sensitive data
  77 $DEBUG = 0;
  78 $me = '[FS::cust_main]';
  79
  80 $import = 0;
  81 $ignore_expired_card = 0;
  82 $ignore_illegal_zip = 0;
  83 $ignore_banned_card = 0;
  84
  85 $skip_fuzzyfiles = 0;
  86
  87 @encrypted_fields = ('payinfo', 'paycvv');
  88 sub nohistory_fields { ('payinfo', 'paycvv'); }
  89
  90 @paytypes = ('', 'Personal checking', 'Personal savings', 'Business checking', 'Business savings');
  91
  92 #ask FS::UID to run this stuff for us later
  93 #$FS::UID::callback{'FS::cust_main'} = sub {
  94 install_callback FS::UID sub {
  95   $conf = new FS::Conf;
  96   #yes, need it for stuff below (prolly should be cached)
  97 };
  98
  99 sub _cache {
 100   my $self = shift;
 101   my ( $hashref, $cache ) = @_;
 102   if ( exists $hashref->{'pkgnum'} ) {
 103     #@{ $self->{'_pkgnum'} } = ();
 104     my $subcache = $cache->subcache( 'pkgnum', 'cust_pkg', $hashref->{custnum});
 105     $self->{'_pkgnum'} = $subcache;
 106     #push @{ $self->{'_pkgnum'} },
 107     FS::cust_pkg->new_or_cached($hashref, $subcache) if $hashref->{pkgnum};
 108   }
 109 }
 110
 111 =head1 NAME
 112
 113 FS::cust_main - Object methods for cust_main records
 114
 115 =head1 SYNOPSIS
 116
 117   use FS::cust_main;
 118
 119   $record = new FS::cust_main \%hash;
 120   $record = new FS::cust_main { 'column' => 'value' };
 121
 122   $error = $record->insert;
 123
 124   $error = $new_record->replace($old_record);
 125
 126   $error = $record->delete;
 127
 128   $error = $record->check;
 129
 130   @cust_pkg = $record->all_pkgs;
 131
 132   @cust_pkg = $record->ncancelled_pkgs;
 133
 134   @cust_pkg = $record->suspended_pkgs;
 135
 136   $error = $record->bill;
 137   $error = $record->bill %options;
 138   $error = $record->bill 'time' => $time;
 139
 140   $error = $record->collect;
 141   $error = $record->collect %options;
 142   $error = $record->collect 'invoice_time'   => $time,
 143                           ;
 144
 145 =head1 DESCRIPTION
 146
 147 An FS::cust_main object represents a customer.  FS::cust_main inherits from
 148 FS::Record.  The following fields are currently supported:
 149
 150 =over 4
 151
 152 =item custnum
 153
 154 Primary key (assigned automatically for new customers)
 155
 156 =item agentnum
 157
 158 Agent (see L<FS::agent>)
 159
 160 =item refnum
 161
 162 Advertising source (see L<FS::part_referral>)
 163
 164 =item first
 165
 166 First name
 167
 168 =item last
 169
 170 Last name
 171
 172 =item ss
 173
 174 Cocial security number (optional)
 175
 176 =item company
 177
 178 (optional)
 179
 180 =item address1
 181
 182 =item address2
 183
 184 (optional)
 185
 186 =item city
 187
 188 =item county
 189
 190 (optional, see L<FS::cust_main_county>)
 191
 192 =item state
 193
 194 (see L<FS::cust_main_county>)
 195
 196 =item zip
 197
 198 =item country
 199
 200 (see L<FS::cust_main_county>)
 201
 202 =item daytime
 203
 204 phone (optional)
 205
 206 =item night
 207
 208 phone (optional)
 209
 210 =item fax
 211
 212 phone (optional)
 213
 214 =item mobile
 215
 216 phone (optional)
 217
 218 =item ship_first
 219
 220 Shipping first name
 221
 222 =item ship_last
 223
 224 Shipping last name
 225
 226 =item ship_company
 227
 228 (optional)
 229
 230 =item ship_address1
 231
 232 =item ship_address2
 233
 234 (optional)
 235
 236 =item ship_city
 237
 238 =item ship_county
 239
 240 (optional, see L<FS::cust_main_county>)
 241
 242 =item ship_state
 243
 244 (see L<FS::cust_main_county>)
 245
 246 =item ship_zip
 247
 248 =item ship_country
 249
 250 (see L<FS::cust_main_county>)
 251
 252 =item ship_daytime
 253
 254 phone (optional)
 255
 256 =item ship_night
 257
 258 phone (optional)
 259
 260 =item ship_fax
 261
 262 phone (optional)
 263
 264 =item ship_mobile
 265
 266 phone (optional)
 267
 268 =item payby
 269
 270 Payment Type (See L<FS::payinfo_Mixin> for valid payby values)
 271
 272 =item payinfo
 273
 274 Payment Information (See L<FS::payinfo_Mixin> for data format)
 275
 276 =item paymask
 277
 278 Masked payinfo (See L<FS::payinfo_Mixin> for how this works)
 279
 280 =item paycvv
 281
 282 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
 283
 284 =item paydate
 285
 286 Expiration date, mm/yyyy, m/yyyy, mm/yy or m/yy
 287
 288 =item paystart_month
 289
 290 Start date month (maestro/solo cards only)
 291
 292 =item paystart_year
 293
 294 Start date year (maestro/solo cards only)
 295
 296 =item payissue
 297
 298 Issue number (maestro/solo cards only)
 299
 300 =item payname
 301
 302 Name on card or billing name
 303
 304 =item payip
 305
 306 IP address from which payment information was received
 307
 308 =item tax
 309
 310 Tax exempt, empty or `Y'
 311
 312 =item usernum
 313
 314 Order taker (see L<FS::access_user>)
 315
 316 =item comments
 317
 318 Comments (optional)
 319
 320 =item referral_custnum
 321
 322 Referring customer number
 323
 324 =item spool_cdr
 325
 326 Enable individual CDR spooling, empty or `Y'
 327
 328 =item dundate
 329
 330 A suggestion to events (see L<FS::part_bill_event">) to delay until this unix timestamp
 331
 332 =item squelch_cdr
 333
 334 Discourage individual CDR printing, empty or `Y'
 335
 336 =item edit_subject
 337
 338 Allow self-service editing of ticket subjects, empty or 'Y'
 339
 340 =item calling_list_exempt
 341
 342 Do not call, empty or 'Y'
 343
 344 =back
 345
 346 =head1 METHODS
 347
 348 =over 4
 349
 350 =item new HASHREF
 351
 352 Creates a new customer.  To add the customer to the database, see L<"insert">.
 353
 354 Note that this stores the hash reference, not a distinct copy of the hash it
 355 points to.  You can ask the object for a copy with the I<hash> method.
 356
 357 =cut
 358
 359 sub table { 'cust_main'; }
 360
 361 =item insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
 362
 363 Adds this customer to the database.  If there is an error, returns the error,
 364 otherwise returns false.
 365
 366 CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
 367 method containing FS::cust_pkg and FS::svc_I<tablename> objects, all records
 368 are inserted atomicly, or the transaction is rolled back.  Passing an empty
 369 hash reference is equivalent to not supplying this parameter.  There should be
 370 a better explanation of this, but until then, here's an example:
 371
 372   use Tie::RefHash;
 373   tie %hash, 'Tie::RefHash'; #this part is important
 374   %hash = (
 375     $cust_pkg => [ $svc_acct ],
 376     ...
 377   );
 378   $cust_main->insert( \%hash );
 379
 380 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
 381 be set as the invoicing list (see L<"invoicing_list">).  Errors return as
 382 expected and rollback the entire transaction; it is not necessary to call
 383 check_invoicing_list first.  The invoicing_list is set after the records in the
 384 CUST_PKG_HASHREF above are inserted, so it is now possible to set an
 385 invoicing_list destination to the newly-created svc_acct.  Here's an example:
 386
 387   $cust_main->insert( {}, [ $email, 'POST' ] );
 388
 389 Currently available options are: I<depend_jobnum>, I<noexport>,
 390 I<tax_exemption> and I<prospectnum>.
 391
 392 If I<depend_jobnum> is set, all provisioning jobs will have a dependancy
 393 on the supplied jobnum (they will not run until the specific job completes).
 394 This can be used to defer provisioning until some action completes (such
 395 as running the customer's credit card successfully).
 396
 397 The I<noexport> option is deprecated.  If I<noexport> is set true, no
 398 provisioning jobs (exports) are scheduled.  (You can schedule them later with
 399 the B<reexport> method.)
 400
 401 The I<tax_exemption> option can be set to an arrayref of tax names.
 402 FS::cust_main_exemption records will be created and inserted.
 403
 404 If I<prospectnum> is set, moves contacts and locations from that prospect.
 405
 406 =cut
 407
 408 sub insert {
 409   my $self = shift;
 410   my $cust_pkgs = @_ ? shift : {};
 411   my $invoicing_list = @_ ? shift : '';
 412   my %options = @_;
 413   warn "$me insert called with options ".
 414        join(', ', map { "$_: $options{$_}" } keys %options ). "\n"
 415     if $DEBUG;
 416
 417   local $SIG{HUP} = 'IGNORE';
 418   local $SIG{INT} = 'IGNORE';
 419   local $SIG{QUIT} = 'IGNORE';
 420   local $SIG{TERM} = 'IGNORE';
 421   local $SIG{TSTP} = 'IGNORE';
 422   local $SIG{PIPE} = 'IGNORE';
 423
 424   my $oldAutoCommit = $FS::UID::AutoCommit;
 425   local $FS::UID::AutoCommit = 0;
 426   my $dbh = dbh;
 427
 428   my $prepay_identifier = '';
 429   my( $amount, $seconds, $upbytes, $downbytes, $totalbytes ) = (0, 0, 0, 0, 0);
 430   my $payby = '';
 431   if ( $self->payby eq 'PREPAY' ) {
 432
 433     $self->payby('BILL');
 434     $prepay_identifier = $self->payinfo;
 435     $self->payinfo('');
 436
 437     warn "  looking up prepaid card $prepay_identifier\n"
 438       if $DEBUG > 1;
 439
 440     my $error = $self->get_prepay( $prepay_identifier,
 441                                    'amount_ref'     => \$amount,
 442                                    'seconds_ref'    => \$seconds,
 443                                    'upbytes_ref'    => \$upbytes,
 444                                    'downbytes_ref'  => \$downbytes,
 445                                    'totalbytes_ref' => \$totalbytes,
 446                                  );
 447     if ( $error ) {
 448       $dbh->rollback if $oldAutoCommit;
 449       #return "error applying prepaid card (transaction rolled back): $error";
 450       return $error;
 451     }
 452
 453     $payby = 'PREP' if $amount;
 454
 455   } elsif ( $self->payby =~ /^(CASH|WEST|MCRD)$/ ) {
 456
 457     $payby = $1;
 458     $self->payby('BILL');
 459     $amount = $self->paid;
 460
 461   }
 462
 463   warn "  inserting $self\n"
 464     if $DEBUG > 1;
 465
 466   $self->signupdate(time) unless $self->signupdate;
 467
 468   $self->censusyear($conf->config('census_year')) if $self->censustract;
 469
 470   $self->auto_agent_custid()
 471     if $conf->config('cust_main-auto_agent_custid') && ! $self->agent_custid;
 472
 473   my $error = $self->SUPER::insert;
 474   if ( $error ) {
 475     $dbh->rollback if $oldAutoCommit;
 476     #return "inserting cust_main record (transaction rolled back): $error";
 477     return $error;
 478   }
 479
 480   warn "  setting invoicing list\n"
 481     if $DEBUG > 1;
 482
 483   if ( $invoicing_list ) {
 484     $error = $self->check_invoicing_list( $invoicing_list );
 485     if ( $error ) {
 486       $dbh->rollback if $oldAutoCommit;
 487       #return "checking invoicing_list (transaction rolled back): $error";
 488       return $error;
 489     }
 490     $self->invoicing_list( $invoicing_list );
 491   }
 492
 493   warn "  setting customer tags\n"
 494     if $DEBUG > 1;
 495
 496   foreach my $tagnum ( @{ $self->tagnum || [] } ) {
 497     my $cust_tag = new FS::cust_tag { 'tagnum'  => $tagnum,
 498                                       'custnum' => $self->custnum };
 499     my $error = $cust_tag->insert;
 500     if ( $error ) {
 501       $dbh->rollback if $oldAutoCommit;
 502       return $error;
 503     }
 504   }
 505
 506   my $prospectnum = delete $options{'prospectnum'};
 507   if ( $prospectnum ) {
 508
 509     warn "  moving contacts and locations from prospect $prospectnum\n"
 510       if $DEBUG > 1;
 511
 512     my $prospect_main =
 513       qsearchs('prospect_main', { 'prospectnum' => $prospectnum } );
 514     unless ( $prospect_main ) {
 515       $dbh->rollback if $oldAutoCommit;
 516       return "Unknown prospectnum $prospectnum";
 517     }
 518     $prospect_main->custnum($self->custnum);
 519     $prospect_main->disabled('Y');
 520     my $error = $prospect_main->replace;
 521     if ( $error ) {
 522       $dbh->rollback if $oldAutoCommit;
 523       return $error;
 524     }
 525
 526     my @contact = $prospect_main->contact;
 527     my @cust_location = $prospect_main->cust_location;
 528     my @qual = $prospect_main->qual;
 529
 530     foreach my $r ( @contact, @cust_location, @qual ) {
 531       $r->prospectnum('');
 532       $r->custnum($self->custnum);
 533       my $error = $r->replace;
 534       if ( $error ) {
 535         $dbh->rollback if $oldAutoCommit;
 536         return $error;
 537       }
 538     }
 539
 540   }
 541
 542   warn "  setting cust_main_exemption\n"
 543     if $DEBUG > 1;
 544
 545   my $tax_exemption = delete $options{'tax_exemption'};
 546   if ( $tax_exemption ) {
 547     foreach my $taxname ( @$tax_exemption ) {
 548       my $cust_main_exemption = new FS::cust_main_exemption {
 549         'custnum' => $self->custnum,
 550         'taxname' => $taxname,
 551       };
 552       my $error = $cust_main_exemption->insert;
 553       if ( $error ) {
 554         $dbh->rollback if $oldAutoCommit;
 555         return "inserting cust_main_exemption (transaction rolled back): $error";
 556       }
 557     }
 558   }
 559
 560   if ( $self->can('start_copy_skel') ) {
 561     my $error = $self->start_copy_skel;
 562     if ( $error ) {
 563       $dbh->rollback if $oldAutoCommit;
 564       return $error;
 565     }
 566   }
 567
 568   warn "  ordering packages\n"
 569     if $DEBUG > 1;
 570
 571   $error = $self->order_pkgs( $cust_pkgs,
 572                               %options,
 573                               'seconds_ref'    => \$seconds,
 574                               'upbytes_ref'    => \$upbytes,
 575                               'downbytes_ref'  => \$downbytes,
 576                               'totalbytes_ref' => \$totalbytes,
 577                             );
 578   if ( $error ) {
 579     $dbh->rollback if $oldAutoCommit;
 580     return $error;
 581   }
 582
 583   if ( $seconds ) {
 584     $dbh->rollback if $oldAutoCommit;
 585     return "No svc_acct record to apply pre-paid time";
 586   }
 587   if ( $upbytes || $downbytes || $totalbytes ) {
 588     $dbh->rollback if $oldAutoCommit;
 589     return "No svc_acct record to apply pre-paid data";
 590   }
 591
 592   if ( $amount ) {
 593     warn "  inserting initial $payby payment of $amount\n"
 594       if $DEBUG > 1;
 595     $error = $self->insert_cust_pay($payby, $amount, $prepay_identifier);
 596     if ( $error ) {
 597       $dbh->rollback if $oldAutoCommit;
 598       return "inserting payment (transaction rolled back): $error";
 599     }
 600   }
 601
 602   unless ( $import || $skip_fuzzyfiles ) {
 603     warn "  queueing fuzzyfiles update\n"
 604       if $DEBUG > 1;
 605     $error = $self->queue_fuzzyfiles_update;
 606     if ( $error ) {
 607       $dbh->rollback if $oldAutoCommit;
 608       return "updating fuzzy search cache: $error";
 609     }
 610   }
 611
 612   # cust_main exports!
 613   warn "  exporting\n" if $DEBUG > 1;
 614
 615   my $export_args = $options{'export_args'} || [];
 616
 617   my @part_export =
 618     map qsearch( 'part_export', {exportnum=>$_} ),
 619       $conf->config('cust_main-exports'); #, $agentnum
 620
 621   foreach my $part_export ( @part_export ) {
 622     my $error = $part_export->export_insert($self, @$export_args);
 623     if ( $error ) {
 624       $dbh->rollback if $oldAutoCommit;
 625       return "exporting to ". $part_export->exporttype.
 626              " (transaction rolled back): $error";
 627     }
 628   }
 629
 630   #foreach my $depend_jobnum ( @$depend_jobnums ) {
 631   #    warn "[$me] inserting dependancies on supplied job $depend_jobnum\n"
 632   #      if $DEBUG;
 633   #    foreach my $jobnum ( @jobnums ) {
 634   #      my $queue = qsearchs('queue', { 'jobnum' => $jobnum } );
 635   #      warn "[$me] inserting dependancy for job $jobnum on $depend_jobnum\n"
 636   #        if $DEBUG;
 637   #      my $error = $queue->depend_insert($depend_jobnum);
 638   #      if ( $error ) {
 639   #        $dbh->rollback if $oldAutoCommit;
 640   #        return "error queuing job dependancy: $error";
 641   #      }
 642   #    }
 643   #  }
 644   #
 645   #}
 646   #
 647   #if ( exists $options{'jobnums'} ) {
 648   #  push @{ $options{'jobnums'} }, @jobnums;
 649   #}
 650
 651   warn "  insert complete; committing transaction\n"
 652     if $DEBUG > 1;
 653
 654   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 655   '';
 656
 657 }
 658
 659 use File::CounterFile;
 660 sub auto_agent_custid {
 661   my $self = shift;
 662
 663   my $format = $conf->config('cust_main-auto_agent_custid');
 664   my $agent_custid;
 665   if ( $format eq '1YMMXXXXXXXX' ) {
 666
 667     my $counter = new File::CounterFile 'cust_main.agent_custid';
 668     $counter->lock;
 669
 670     my $ym = 100000000000 + time2str('%y%m00000000', time);
 671     if ( $ym > $counter->value ) {
 672       $counter->{'value'} = $agent_custid = $ym;
 673       $counter->{'updated'} = 1;
 674     } else {
 675       $agent_custid = $counter->inc;
 676     }
 677
 678     $counter->unlock;
 679
 680   } else {
 681     die "Unknown cust_main-auto_agent_custid format: $format";
 682   }
 683
 684   $self->agent_custid($agent_custid);
 685
 686 }
 687
 688 =item PACKAGE METHODS
 689
 690 Documentation on customer package methods has been moved to
 691 L<FS::cust_main::Packages>.
 692
 693 =item recharge_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , AMOUNTREF, SECONDSREF, UPBYTEREF, DOWNBYTEREF ]
 694
 695 Recharges this (existing) customer with the specified prepaid card (see
 696 L<FS::prepay_credit>), specified either by I<identifier> or as an
 697 FS::prepay_credit object.  If there is an error, returns the error, otherwise
 698 returns false.
 699
 700 Optionally, five scalar references can be passed as well.  They will have their
 701 values filled in with the amount, number of seconds, and number of upload,
 702 download, and total bytes applied by this prepaid card.
 703
 704 =cut
 705
 706 #the ref bullshit here should be refactored like get_prepay.  MyAccount.pm is
 707 #the only place that uses these args
 708 sub recharge_prepay {
 709   my( $self, $prepay_credit, $amountref, $secondsref,
 710       $upbytesref, $downbytesref, $totalbytesref ) = @_;
 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   my( $amount, $seconds, $upbytes, $downbytes, $totalbytes) = ( 0, 0, 0, 0, 0 );
 724
 725   my $error = $self->get_prepay( $prepay_credit,
 726                                  'amount_ref'     => \$amount,
 727                                  'seconds_ref'    => \$seconds,
 728                                  'upbytes_ref'    => \$upbytes,
 729                                  'downbytes_ref'  => \$downbytes,
 730                                  'totalbytes_ref' => \$totalbytes,
 731                                )
 732            || $self->increment_seconds($seconds)
 733            || $self->increment_upbytes($upbytes)
 734            || $self->increment_downbytes($downbytes)
 735            || $self->increment_totalbytes($totalbytes)
 736            || $self->insert_cust_pay_prepay( $amount,
 737                                              ref($prepay_credit)
 738                                                ? $prepay_credit->identifier
 739                                                : $prepay_credit
 740                                            );
 741
 742   if ( $error ) {
 743     $dbh->rollback if $oldAutoCommit;
 744     return $error;
 745   }
 746
 747   if ( defined($amountref)  ) { $$amountref  = $amount;  }
 748   if ( defined($secondsref) ) { $$secondsref = $seconds; }
 749   if ( defined($upbytesref) ) { $$upbytesref = $upbytes; }
 750   if ( defined($downbytesref) ) { $$downbytesref = $downbytes; }
 751   if ( defined($totalbytesref) ) { $$totalbytesref = $totalbytes; }
 752
 753   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 754   '';
 755
 756 }
 757
 758 =item get_prepay IDENTIFIER | PREPAY_CREDIT_OBJ [ , OPTION => VALUE ... ]
 759
 760 Looks up and deletes a prepaid card (see L<FS::prepay_credit>),
 761 specified either by I<identifier> or as an FS::prepay_credit object.
 762
 763 Available options are: I<amount_ref>, I<seconds_ref>, I<upbytes_ref>, I<downbytes_ref>, and I<totalbytes_ref>.  The scalars (provided by references) will be
 764 incremented by the values of the prepaid card.
 765
 766 If the prepaid card specifies an I<agentnum> (see L<FS::agent>), it is used to
 767 check or set this customer's I<agentnum>.
 768
 769 If there is an error, returns the error, otherwise returns false.
 770
 771 =cut
 772
 773
 774 sub get_prepay {
 775   my( $self, $prepay_credit, %opt ) = @_;
 776
 777   local $SIG{HUP} = 'IGNORE';
 778   local $SIG{INT} = 'IGNORE';
 779   local $SIG{QUIT} = 'IGNORE';
 780   local $SIG{TERM} = 'IGNORE';
 781   local $SIG{TSTP} = 'IGNORE';
 782   local $SIG{PIPE} = 'IGNORE';
 783
 784   my $oldAutoCommit = $FS::UID::AutoCommit;
 785   local $FS::UID::AutoCommit = 0;
 786   my $dbh = dbh;
 787
 788   unless ( ref($prepay_credit) ) {
 789
 790     my $identifier = $prepay_credit;
 791
 792     $prepay_credit = qsearchs(
 793       'prepay_credit',
 794       { 'identifier' => $identifier },
 795       '',
 796       'FOR UPDATE'
 797     );
 798
 799     unless ( $prepay_credit ) {
 800       $dbh->rollback if $oldAutoCommit;
 801       return "Invalid prepaid card: ". $identifier;
 802     }
 803
 804   }
 805
 806   if ( $prepay_credit->agentnum ) {
 807     if ( $self->agentnum && $self->agentnum != $prepay_credit->agentnum ) {
 808       $dbh->rollback if $oldAutoCommit;
 809       return "prepaid card not valid for agent ". $self->agentnum;
 810     }
 811     $self->agentnum($prepay_credit->agentnum);
 812   }
 813
 814   my $error = $prepay_credit->delete;
 815   if ( $error ) {
 816     $dbh->rollback if $oldAutoCommit;
 817     return "removing prepay_credit (transaction rolled back): $error";
 818   }
 819
 820   ${ $opt{$_.'_ref'} } += $prepay_credit->$_()
 821     for grep $opt{$_.'_ref'}, qw( amount seconds upbytes downbytes totalbytes );
 822
 823   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 824   '';
 825
 826 }
 827
 828 =item increment_upbytes SECONDS
 829
 830 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 831 the specified number of upbytes.  If there is an error, returns the error,
 832 otherwise returns false.
 833
 834 =cut
 835
 836 sub increment_upbytes {
 837   _increment_column( shift, 'upbytes', @_);
 838 }
 839
 840 =item increment_downbytes SECONDS
 841
 842 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 843 the specified number of downbytes.  If there is an error, returns the error,
 844 otherwise returns false.
 845
 846 =cut
 847
 848 sub increment_downbytes {
 849   _increment_column( shift, 'downbytes', @_);
 850 }
 851
 852 =item increment_totalbytes SECONDS
 853
 854 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 855 the specified number of totalbytes.  If there is an error, returns the error,
 856 otherwise returns false.
 857
 858 =cut
 859
 860 sub increment_totalbytes {
 861   _increment_column( shift, 'totalbytes', @_);
 862 }
 863
 864 =item increment_seconds SECONDS
 865
 866 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 867 the specified number of seconds.  If there is an error, returns the error,
 868 otherwise returns false.
 869
 870 =cut
 871
 872 sub increment_seconds {
 873   _increment_column( shift, 'seconds', @_);
 874 }
 875
 876 =item _increment_column AMOUNT
 877
 878 Updates this customer's single or primary account (see L<FS::svc_acct>) by
 879 the specified number of seconds or bytes.  If there is an error, returns
 880 the error, otherwise returns false.
 881
 882 =cut
 883
 884 sub _increment_column {
 885   my( $self, $column, $amount ) = @_;
 886   warn "$me increment_column called: $column, $amount\n"
 887     if $DEBUG;
 888
 889   return '' unless $amount;
 890
 891   my @cust_pkg = grep { $_->part_pkg->svcpart('svc_acct') }
 892                       $self->ncancelled_pkgs;
 893
 894   if ( ! @cust_pkg ) {
 895     return 'No packages with primary or single services found'.
 896            ' to apply pre-paid time';
 897   } elsif ( scalar(@cust_pkg) > 1 ) {
 898     #maybe have a way to specify the package/account?
 899     return 'Multiple packages found to apply pre-paid time';
 900   }
 901
 902   my $cust_pkg = $cust_pkg[0];
 903   warn "  found package pkgnum ". $cust_pkg->pkgnum. "\n"
 904     if $DEBUG > 1;
 905
 906   my @cust_svc =
 907     $cust_pkg->cust_svc( $cust_pkg->part_pkg->svcpart('svc_acct') );
 908
 909   if ( ! @cust_svc ) {
 910     return 'No account found to apply pre-paid time';
 911   } elsif ( scalar(@cust_svc) > 1 ) {
 912     return 'Multiple accounts found to apply pre-paid time';
 913   }
 914
 915   my $svc_acct = $cust_svc[0]->svc_x;
 916   warn "  found service svcnum ". $svc_acct->pkgnum.
 917        ' ('. $svc_acct->email. ")\n"
 918     if $DEBUG > 1;
 919
 920   $column = "increment_$column";
 921   $svc_acct->$column($amount);
 922
 923 }
 924
 925 =item insert_cust_pay_prepay AMOUNT [ PAYINFO ]
 926
 927 Inserts a prepayment in the specified amount for this customer.  An optional
 928 second argument can specify the prepayment identifier for tracking purposes.
 929 If there is an error, returns the error, otherwise returns false.
 930
 931 =cut
 932
 933 sub insert_cust_pay_prepay {
 934   shift->insert_cust_pay('PREP', @_);
 935 }
 936
 937 =item insert_cust_pay_cash AMOUNT [ PAYINFO ]
 938
 939 Inserts a cash payment in the specified amount for this customer.  An optional
 940 second argument can specify the payment identifier for tracking purposes.
 941 If there is an error, returns the error, otherwise returns false.
 942
 943 =cut
 944
 945 sub insert_cust_pay_cash {
 946   shift->insert_cust_pay('CASH', @_);
 947 }
 948
 949 =item insert_cust_pay_west AMOUNT [ PAYINFO ]
 950
 951 Inserts a Western Union payment in the specified amount for this customer.  An
 952 optional second argument can specify the prepayment identifier for tracking
 953 purposes.  If there is an error, returns the error, otherwise returns false.
 954
 955 =cut
 956
 957 sub insert_cust_pay_west {
 958   shift->insert_cust_pay('WEST', @_);
 959 }
 960
 961 sub insert_cust_pay {
 962   my( $self, $payby, $amount ) = splice(@_, 0, 3);
 963   my $payinfo = scalar(@_) ? shift : '';
 964
 965   my $cust_pay = new FS::cust_pay {
 966     'custnum' => $self->custnum,
 967     'paid'    => sprintf('%.2f', $amount),
 968     #'_date'   => #date the prepaid card was purchased???
 969     'payby'   => $payby,
 970     'payinfo' => $payinfo,
 971   };
 972   $cust_pay->insert;
 973
 974 }
 975
 976 =item reexport
 977
 978 This method is deprecated.  See the I<depend_jobnum> option to the insert and
 979 order_pkgs methods for a better way to defer provisioning.
 980
 981 Re-schedules all exports by calling the B<reexport> method of all associated
 982 packages (see L<FS::cust_pkg>).  If there is an error, returns the error;
 983 otherwise returns false.
 984
 985 =cut
 986
 987 sub reexport {
 988   my $self = shift;
 989
 990   carp "WARNING: FS::cust_main::reexport is deprectated; ".
 991        "use the depend_jobnum option to insert or order_pkgs to delay export";
 992
 993   local $SIG{HUP} = 'IGNORE';
 994   local $SIG{INT} = 'IGNORE';
 995   local $SIG{QUIT} = 'IGNORE';
 996   local $SIG{TERM} = 'IGNORE';
 997   local $SIG{TSTP} = 'IGNORE';
 998   local $SIG{PIPE} = 'IGNORE';
 999
1000   my $oldAutoCommit = $FS::UID::AutoCommit;
1001   local $FS::UID::AutoCommit = 0;
1002   my $dbh = dbh;
1003
1004   foreach my $cust_pkg ( $self->ncancelled_pkgs ) {
1005     my $error = $cust_pkg->reexport;
1006     if ( $error ) {
1007       $dbh->rollback if $oldAutoCommit;
1008       return $error;
1009     }
1010   }
1011
1012   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1013   '';
1014
1015 }
1016
1017 =item delete [ OPTION => VALUE ... ]
1018
1019 This deletes the customer.  If there is an error, returns the error, otherwise
1020 returns false.
1021
1022 This will completely remove all traces of the customer record.  This is not
1023 what you want when a customer cancels service; for that, cancel all of the
1024 customer's packages (see L</cancel>).
1025
1026 If the customer has any uncancelled packages, you need to pass a new (valid)
1027 customer number for those packages to be transferred to, as the "new_customer"
1028 option.  Cancelled packages will be deleted.  Did I mention that this is NOT
1029 what you want when a customer cancels service and that you really should be
1030 looking at L<FS::cust_pkg/cancel>?
1031
1032 You can't delete a customer with invoices (see L<FS::cust_bill>),
1033 statements (see L<FS::cust_statement>), credits (see L<FS::cust_credit>),
1034 payments (see L<FS::cust_pay>) or refunds (see L<FS::cust_refund>), unless you
1035 set the "delete_financials" option to a true value.
1036
1037 =cut
1038
1039 sub delete {
1040   my( $self, %opt ) = @_;
1041
1042   local $SIG{HUP} = 'IGNORE';
1043   local $SIG{INT} = 'IGNORE';
1044   local $SIG{QUIT} = 'IGNORE';
1045   local $SIG{TERM} = 'IGNORE';
1046   local $SIG{TSTP} = 'IGNORE';
1047   local $SIG{PIPE} = 'IGNORE';
1048
1049   my $oldAutoCommit = $FS::UID::AutoCommit;
1050   local $FS::UID::AutoCommit = 0;
1051   my $dbh = dbh;
1052
1053   if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1054      $dbh->rollback if $oldAutoCommit;
1055      return "Can't delete a master agent customer";
1056   }
1057
1058   #use FS::access_user
1059   if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1060      $dbh->rollback if $oldAutoCommit;
1061      return "Can't delete a master employee customer";
1062   }
1063
1064   tie my %financial_tables, 'Tie::IxHash',
1065     'cust_bill'      => 'invoices',
1066     'cust_statement' => 'statements',
1067     'cust_credit'    => 'credits',
1068     'cust_pay'       => 'payments',
1069     'cust_refund'    => 'refunds',
1070   ;
1071
1072   foreach my $table ( keys %financial_tables ) {
1073
1074     my @records = $self->$table();
1075
1076     if ( @records && ! $opt{'delete_financials'} ) {
1077       $dbh->rollback if $oldAutoCommit;
1078       return "Can't delete a customer with ". $financial_tables{$table};
1079     }
1080
1081     foreach my $record ( @records ) {
1082       my $error = $record->delete;
1083       if ( $error ) {
1084         $dbh->rollback if $oldAutoCommit;
1085         return "Error deleting ". $financial_tables{$table}. ": $error\n";
1086       }
1087     }
1088
1089   }
1090
1091   my @cust_pkg = $self->ncancelled_pkgs;
1092   if ( @cust_pkg ) {
1093     my $new_custnum = $opt{'new_custnum'};
1094     unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1095       $dbh->rollback if $oldAutoCommit;
1096       return "Invalid new customer number: $new_custnum";
1097     }
1098     foreach my $cust_pkg ( @cust_pkg ) {
1099       my %hash = $cust_pkg->hash;
1100       $hash{'custnum'} = $new_custnum;
1101       my $new_cust_pkg = new FS::cust_pkg ( \%hash );
1102       my $error = $new_cust_pkg->replace($cust_pkg,
1103                                          options => { $cust_pkg->options },
1104                                         );
1105       if ( $error ) {
1106         $dbh->rollback if $oldAutoCommit;
1107         return $error;
1108       }
1109     }
1110   }
1111   my @cancelled_cust_pkg = $self->all_pkgs;
1112   foreach my $cust_pkg ( @cancelled_cust_pkg ) {
1113     my $error = $cust_pkg->delete;
1114     if ( $error ) {
1115       $dbh->rollback if $oldAutoCommit;
1116       return $error;
1117     }
1118   }
1119
1120   #cust_tax_adjustment in financials?
1121   #cust_pay_pending?  ouch
1122   #cust_recon?
1123   foreach my $table (qw(
1124     cust_main_invoice cust_main_exemption cust_tag cust_attachment contact
1125     cust_location cust_main_note cust_tax_adjustment
1126     cust_pay_void cust_pay_batch queue cust_tax_exempt
1127   )) {
1128     foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1129       my $error = $record->delete;
1130       if ( $error ) {
1131         $dbh->rollback if $oldAutoCommit;
1132         return $error;
1133       }
1134     }
1135   }
1136
1137   my $sth = $dbh->prepare(
1138     'UPDATE cust_main SET referral_custnum = NULL WHERE referral_custnum = ?'
1139   ) or do {
1140     my $errstr = $dbh->errstr;
1141     $dbh->rollback if $oldAutoCommit;
1142     return $errstr;
1143   };
1144   $sth->execute($self->custnum) or do {
1145     my $errstr = $sth->errstr;
1146     $dbh->rollback if $oldAutoCommit;
1147     return $errstr;
1148   };
1149
1150   #tickets
1151
1152   my $ticket_dbh = '';
1153   if ($conf->config('ticket_system') eq 'RT_Internal') {
1154     $ticket_dbh = $dbh;
1155   } elsif ($conf->config('ticket_system') eq 'RT_External') {
1156     my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1157     $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1158       #or die "RT_External DBI->connect error: $DBI::errstr\n";
1159   }
1160
1161   if ( $ticket_dbh ) {
1162
1163     my $ticket_sth = $ticket_dbh->prepare(
1164       'DELETE FROM Links WHERE Target = ?'
1165     ) or do {
1166       my $errstr = $ticket_dbh->errstr;
1167       $dbh->rollback if $oldAutoCommit;
1168       return $errstr;
1169     };
1170     $ticket_sth->execute('freeside://freeside/cust_main/'.$self->custnum)
1171       or do {
1172         my $errstr = $ticket_sth->errstr;
1173         $dbh->rollback if $oldAutoCommit;
1174         return $errstr;
1175       };
1176
1177     #check and see if the customer is the only link on the ticket, and
1178     #if so, set the ticket to deleted status in RT?
1179     #maybe someday, for now this will at least fix tickets not displaying
1180
1181   }
1182
1183   #delete the customer record
1184
1185   my $error = $self->SUPER::delete;
1186   if ( $error ) {
1187     $dbh->rollback if $oldAutoCommit;
1188     return $error;
1189   }
1190
1191   # cust_main exports!
1192
1193   #my $export_args = $options{'export_args'} || [];
1194
1195   my @part_export =
1196     map qsearch( 'part_export', {exportnum=>$_} ),
1197       $conf->config('cust_main-exports'); #, $agentnum
1198
1199   foreach my $part_export ( @part_export ) {
1200     my $error = $part_export->export_delete( $self ); #, @$export_args);
1201     if ( $error ) {
1202       $dbh->rollback if $oldAutoCommit;
1203       return "exporting to ". $part_export->exporttype.
1204              " (transaction rolled back): $error";
1205     }
1206   }
1207
1208   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1209   '';
1210
1211 }
1212
1213 =item merge NEW_CUSTNUM [ , OPTION => VALUE ... ]
1214
1215 This merges this customer into the provided new custnum, and then deletes the
1216 customer.  If there is an error, returns the error, otherwise returns false.
1217
1218 The source customer's name, company name, phone numbers, agent,
1219 referring customer, customer class, advertising source, order taker, and
1220 billing information (except balance) are discarded.
1221
1222 All packages are moved to the target customer.  Packages with package locations
1223 are preserved.  Packages without package locations are moved to a new package
1224 location with the source customer's service/shipping address.
1225
1226 All invoices, statements, payments, credits and refunds are moved to the target
1227 customer.  The source customer's balance is added to the target customer.
1228
1229 All notes, attachments, tickets and customer tags are moved to the target
1230 customer.
1231
1232 Change history is not currently moved.
1233
1234 =cut
1235
1236 sub merge {
1237   my( $self, $new_custnum, %opt ) = @_;
1238
1239   return "Can't merge a customer into self" if $self->custnum == $new_custnum;
1240
1241   unless ( qsearchs( 'cust_main', { 'custnum' => $new_custnum } ) ) {
1242     return "Invalid new customer number: $new_custnum";
1243   }
1244
1245   local $SIG{HUP} = 'IGNORE';
1246   local $SIG{INT} = 'IGNORE';
1247   local $SIG{QUIT} = 'IGNORE';
1248   local $SIG{TERM} = 'IGNORE';
1249   local $SIG{TSTP} = 'IGNORE';
1250   local $SIG{PIPE} = 'IGNORE';
1251
1252   my $oldAutoCommit = $FS::UID::AutoCommit;
1253   local $FS::UID::AutoCommit = 0;
1254   my $dbh = dbh;
1255
1256   if ( qsearch('agent', { 'agent_custnum' => $self->custnum } ) ) {
1257      $dbh->rollback if $oldAutoCommit;
1258      return "Can't merge a master agent customer";
1259   }
1260
1261   #use FS::access_user
1262   if ( qsearch('access_user', { 'user_custnum' => $self->custnum } ) ) {
1263      $dbh->rollback if $oldAutoCommit;
1264      return "Can't merge a master employee customer";
1265   }
1266
1267   if ( qsearch('cust_pay_pending', { 'custnum' => $self->custnum,
1268                                      'status'  => { op=>'!=', value=>'done' },
1269                                    }
1270               )
1271   ) {
1272      $dbh->rollback if $oldAutoCommit;
1273      return "Can't merge a customer with pending payments";
1274   }
1275
1276   tie my %financial_tables, 'Tie::IxHash',
1277     'cust_bill'      => 'invoices',
1278     'cust_statement' => 'statements',
1279     'cust_credit'    => 'credits',
1280     'cust_pay'       => 'payments',
1281     'cust_pay_void'  => 'voided payments',
1282     'cust_refund'    => 'refunds',
1283   ;
1284
1285   foreach my $table ( keys %financial_tables ) {
1286
1287     my @records = $self->$table();
1288
1289     foreach my $record ( @records ) {
1290       $record->custnum($new_custnum);
1291       my $error = $record->replace;
1292       if ( $error ) {
1293         $dbh->rollback if $oldAutoCommit;
1294         return "Error merging ". $financial_tables{$table}. ": $error\n";
1295       }
1296     }
1297
1298   }
1299
1300   my $name = $self->ship_name;
1301
1302   my $locationnum = '';
1303   foreach my $cust_pkg ( $self->all_pkgs ) {
1304     $cust_pkg->custnum($new_custnum);
1305
1306     unless ( $cust_pkg->locationnum ) {
1307       unless ( $locationnum ) {
1308         my $cust_location = new FS::cust_location {
1309           $self->location_hash,
1310           'custnum' => $new_custnum,
1311         };
1312         my $error = $cust_location->insert;
1313         if ( $error ) {
1314           $dbh->rollback if $oldAutoCommit;
1315           return $error;
1316         }
1317         $locationnum = $cust_location->locationnum;
1318       }
1319       $cust_pkg->locationnum($locationnum);
1320     }
1321
1322     my $error = $cust_pkg->replace;
1323     if ( $error ) {
1324       $dbh->rollback if $oldAutoCommit;
1325       return $error;
1326     }
1327
1328     # add customer (ship) name to svc_phone.phone_name if blank
1329     my @cust_svc = $cust_pkg->cust_svc;
1330     foreach my $cust_svc (@cust_svc) {
1331       my($label, $value, $svcdb) = $cust_svc->label;
1332       next unless $svcdb eq 'svc_phone';
1333       my $svc_phone = $cust_svc->svc_x;
1334       next if $svc_phone->phone_name;
1335       $svc_phone->phone_name($name);
1336       my $error = $svc_phone->replace;
1337       if ( $error ) {
1338         $dbh->rollback if $oldAutoCommit;
1339         return $error;
1340       }
1341     }
1342
1343   }
1344
1345   #not considered:
1346   # cust_tax_exempt (texas tax exemptions)
1347   # cust_recon (some sort of not-well understood thing for OnPac)
1348
1349   #these are moved over
1350   foreach my $table (qw(
1351     cust_tag cust_location contact cust_attachment cust_main_note
1352     cust_tax_adjustment cust_pay_batch queue
1353   )) {
1354     foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1355       $record->custnum($new_custnum);
1356       my $error = $record->replace;
1357       if ( $error ) {
1358         $dbh->rollback if $oldAutoCommit;
1359         return $error;
1360       }
1361     }
1362   }
1363
1364   #these aren't preserved
1365   foreach my $table (qw(
1366     cust_main_exemption cust_main_invoice
1367   )) {
1368     foreach my $record ( qsearch( $table, { 'custnum' => $self->custnum } ) ) {
1369       my $error = $record->delete;
1370       if ( $error ) {
1371         $dbh->rollback if $oldAutoCommit;
1372         return $error;
1373       }
1374     }
1375   }
1376
1377
1378   my $sth = $dbh->prepare(
1379     'UPDATE cust_main SET referral_custnum = ? WHERE referral_custnum = ?'
1380   ) or do {
1381     my $errstr = $dbh->errstr;
1382     $dbh->rollback if $oldAutoCommit;
1383     return $errstr;
1384   };
1385   $sth->execute($new_custnum, $self->custnum) or do {
1386     my $errstr = $sth->errstr;
1387     $dbh->rollback if $oldAutoCommit;
1388     return $errstr;
1389   };
1390
1391   #tickets
1392
1393   my $ticket_dbh = '';
1394   if ($conf->config('ticket_system') eq 'RT_Internal') {
1395     $ticket_dbh = $dbh;
1396   } elsif ($conf->config('ticket_system') eq 'RT_External') {
1397     my ($datasrc, $user, $pass) = $conf->config('ticket_system-rt_external_datasrc');
1398     $ticket_dbh = DBI->connect($datasrc, $user, $pass, { 'ChopBlanks' => 1 });
1399       #or die "RT_External DBI->connect error: $DBI::errstr\n";
1400   }
1401
1402   if ( $ticket_dbh ) {
1403
1404     my $ticket_sth = $ticket_dbh->prepare(
1405       'UPDATE Links SET Target = ? WHERE Target = ?'
1406     ) or do {
1407       my $errstr = $ticket_dbh->errstr;
1408       $dbh->rollback if $oldAutoCommit;
1409       return $errstr;
1410     };
1411     $ticket_sth->execute('freeside://freeside/cust_main/'.$new_custnum,
1412                          'freeside://freeside/cust_main/'.$self->custnum)
1413       or do {
1414         my $errstr = $ticket_sth->errstr;
1415         $dbh->rollback if $oldAutoCommit;
1416         return $errstr;
1417       };
1418
1419   }
1420
1421   #delete the customer record
1422
1423   my $error = $self->delete;
1424   if ( $error ) {
1425     $dbh->rollback if $oldAutoCommit;
1426     return $error;
1427   }
1428
1429   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1430   '';
1431
1432 }
1433
1434 =item replace [ OLD_RECORD ] [ INVOICING_LIST_ARYREF ] [ , OPTION => VALUE ... ] ]
1435
1436
1437 Replaces the OLD_RECORD with this one in the database.  If there is an error,
1438 returns the error, otherwise returns false.
1439
1440 INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
1441 be set as the invoicing list (see L<"invoicing_list">).  Errors return as
1442 expected and rollback the entire transaction; it is not necessary to call
1443 check_invoicing_list first.  Here's an example:
1444
1445   $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
1446
1447 Currently available options are: I<tax_exemption>.
1448
1449 The I<tax_exemption> option can be set to an arrayref of tax names.
1450 FS::cust_main_exemption records will be deleted and inserted as appropriate.
1451
1452 =cut
1453
1454 sub replace {
1455   my $self = shift;
1456
1457   my $old = ( blessed($_[0]) && $_[0]->isa('FS::Record') )
1458               ? shift
1459               : $self->replace_old;
1460
1461   my @param = @_;
1462
1463   warn "$me replace called\n"
1464     if $DEBUG;
1465
1466   my $curuser = $FS::CurrentUser::CurrentUser;
1467   if (    $self->payby eq 'COMP'
1468        && $self->payby ne $old->payby
1469        && ! $curuser->access_right('Complimentary customer')
1470      )
1471   {
1472     return "You are not permitted to create complimentary accounts.";
1473   }
1474
1475   if ( $old->get('geocode') && $old->get('geocode') eq $self->get('geocode')
1476        && $conf->exists('enable_taxproducts')
1477      )
1478   {
1479     my $pre = ($conf->exists('tax-ship_address') && $self->ship_zip)
1480                 ? 'ship_' : '';
1481     $self->set('geocode', '')
1482       if $old->get($pre.'zip') ne $self->get($pre.'zip')
1483       && length($self->get($pre.'zip')) >= 10;
1484   }
1485
1486   for my $pre ( grep $old->get($_.'coord_auto'), ( '', 'ship_' ) ) {
1487
1488     $self->set($pre.'coord_auto', '') && next
1489       if $self->get($pre.'latitude') && $self->get($pre.'longitude')
1490       && (    $self->get($pre.'latitude')  != $old->get($pre.'latitude')
1491            || $self->get($pre.'longitude') != $old->get($pre.'longitude')
1492          );
1493
1494     $self->set_coord($pre)
1495       if $old->get($pre.'address1') ne $self->get($pre.'address1')
1496       || $old->get($pre.'city')     ne $self->get($pre.'city')
1497       || $old->get($pre.'state')    ne $self->get($pre.'state')
1498       || $old->get($pre.'country')  ne $self->get($pre.'country');
1499
1500   }
1501
1502   $self->set_coord
1503     if ! $self->coord_auto && ! $self->latitude && ! $self->longitude;
1504
1505   $self->set_coord('ship_')
1506     if $self->has_ship_address && ! $self->ship_coord_auto
1507     && ! $self->ship_latitude && ! $self->ship_longitude;
1508
1509   local($ignore_expired_card) = 1
1510     if $old->payby  =~ /^(CARD|DCRD)$/
1511     && $self->payby =~ /^(CARD|DCRD)$/
1512     && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1513
1514   local($ignore_banned_card) = 1
1515     if (    $old->payby  =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1516          || $old->payby  =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1517     && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1518
1519   if ( $self->censustract ne '' and $self->censustract ne $old->censustract ) {
1520     # update censusyear whenever tract code changes
1521     $self->censusyear($conf->config('census_year'));
1522   }
1523
1524
1525   local $SIG{HUP} = 'IGNORE';
1526   local $SIG{INT} = 'IGNORE';
1527   local $SIG{QUIT} = 'IGNORE';
1528   local $SIG{TERM} = 'IGNORE';
1529   local $SIG{TSTP} = 'IGNORE';
1530   local $SIG{PIPE} = 'IGNORE';
1531
1532   my $oldAutoCommit = $FS::UID::AutoCommit;
1533   local $FS::UID::AutoCommit = 0;
1534   my $dbh = dbh;
1535
1536   my $error = $self->SUPER::replace($old);
1537
1538   if ( $error ) {
1539     $dbh->rollback if $oldAutoCommit;
1540     return $error;
1541   }
1542
1543   if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1544     my $invoicing_list = shift @param;
1545     $error = $self->check_invoicing_list( $invoicing_list );
1546     if ( $error ) {
1547       $dbh->rollback if $oldAutoCommit;
1548       return $error;
1549     }
1550     $self->invoicing_list( $invoicing_list );
1551   }
1552
1553   if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1554
1555     #this could be more efficient than deleting and re-inserting, if it matters
1556     foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1557       my $error = $cust_tag->delete;
1558       if ( $error ) {
1559         $dbh->rollback if $oldAutoCommit;
1560         return $error;
1561       }
1562     }
1563     foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1564       my $cust_tag = new FS::cust_tag { 'tagnum'  => $tagnum,
1565                                         'custnum' => $self->custnum };
1566       my $error = $cust_tag->insert;
1567       if ( $error ) {
1568         $dbh->rollback if $oldAutoCommit;
1569         return $error;
1570       }
1571     }
1572
1573   }
1574
1575   my %options = @param;
1576
1577   my $tax_exemption = delete $options{'tax_exemption'};
1578   if ( $tax_exemption ) {
1579
1580     my %cust_main_exemption =
1581       map { $_->taxname => $_ }
1582           qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1583
1584     foreach my $taxname ( @$tax_exemption ) {
1585
1586       next if delete $cust_main_exemption{$taxname};
1587
1588       my $cust_main_exemption = new FS::cust_main_exemption {
1589         'custnum' => $self->custnum,
1590         'taxname' => $taxname,
1591       };
1592       my $error = $cust_main_exemption->insert;
1593       if ( $error ) {
1594         $dbh->rollback if $oldAutoCommit;
1595         return "inserting cust_main_exemption (transaction rolled back): $error";
1596       }
1597     }
1598
1599     foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1600       my $error = $cust_main_exemption->delete;
1601       if ( $error ) {
1602         $dbh->rollback if $oldAutoCommit;
1603         return "deleting cust_main_exemption (transaction rolled back): $error";
1604       }
1605     }
1606
1607   }
1608
1609   if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1610        && ( ( $self->get('payinfo') ne $old->get('payinfo')
1611               && $self->get('payinfo') !~ /^99\d{14}$/
1612             )
1613             || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1614           )
1615      )
1616   {
1617
1618     # card/check/lec info has changed, want to retry realtime_ invoice events
1619     my $error = $self->retry_realtime;
1620     if ( $error ) {
1621       $dbh->rollback if $oldAutoCommit;
1622       return $error;
1623     }
1624   }
1625
1626   unless ( $import || $skip_fuzzyfiles ) {
1627     $error = $self->queue_fuzzyfiles_update;
1628     if ( $error ) {
1629       $dbh->rollback if $oldAutoCommit;
1630       return "updating fuzzy search cache: $error";
1631     }
1632   }
1633
1634   # cust_main exports!
1635
1636   my $export_args = $options{'export_args'} || [];
1637
1638   my @part_export =
1639     map qsearch( 'part_export', {exportnum=>$_} ),
1640       $conf->config('cust_main-exports'); #, $agentnum
1641
1642   foreach my $part_export ( @part_export ) {
1643     my $error = $part_export->export_replace( $self, $old, @$export_args);
1644     if ( $error ) {
1645       $dbh->rollback if $oldAutoCommit;
1646       return "exporting to ". $part_export->exporttype.
1647              " (transaction rolled back): $error";
1648     }
1649   }
1650
1651   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1652   '';
1653
1654 }
1655
1656 =item queue_fuzzyfiles_update
1657
1658 Used by insert & replace to update the fuzzy search cache
1659
1660 =cut
1661
1662 use FS::cust_main::Search;
1663 sub queue_fuzzyfiles_update {
1664   my $self = shift;
1665
1666   local $SIG{HUP} = 'IGNORE';
1667   local $SIG{INT} = 'IGNORE';
1668   local $SIG{QUIT} = 'IGNORE';
1669   local $SIG{TERM} = 'IGNORE';
1670   local $SIG{TSTP} = 'IGNORE';
1671   local $SIG{PIPE} = 'IGNORE';
1672
1673   my $oldAutoCommit = $FS::UID::AutoCommit;
1674   local $FS::UID::AutoCommit = 0;
1675   my $dbh = dbh;
1676
1677   my $queue = new FS::queue { 'job' => 'FS::cust_main::Search::append_fuzzyfiles' };
1678   my $error = $queue->insert( map $self->getfield($_), @FS::cust_main::Search::fuzzyfields );
1679   if ( $error ) {
1680     $dbh->rollback if $oldAutoCommit;
1681     return "queueing job (transaction rolled back): $error";
1682   }
1683
1684   if ( $self->ship_last ) {
1685     $queue = new FS::queue { 'job' => 'FS::cust_main::Search::append_fuzzyfiles' };
1686     $error = $queue->insert( map $self->getfield("ship_$_"), @FS::cust_main::Search::fuzzyfields );
1687     if ( $error ) {
1688       $dbh->rollback if $oldAutoCommit;
1689       return "queueing job (transaction rolled back): $error";
1690     }
1691   }
1692
1693   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1694   '';
1695
1696 }
1697
1698 =item check
1699
1700 Checks all fields to make sure this is a valid customer record.  If there is
1701 an error, returns the error, otherwise returns false.  Called by the insert
1702 and replace methods.
1703
1704 =cut
1705
1706 sub check {
1707   my $self = shift;
1708
1709   warn "$me check BEFORE: \n". $self->_dump
1710     if $DEBUG > 2;
1711
1712   my $error =
1713     $self->ut_numbern('custnum')
1714     || $self->ut_number('agentnum')
1715     || $self->ut_textn('agent_custid')
1716     || $self->ut_number('refnum')
1717     || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1718     || $self->ut_textn('custbatch')
1719     || $self->ut_name('last')
1720     || $self->ut_name('first')
1721     || $self->ut_snumbern('birthdate')
1722     || $self->ut_snumbern('signupdate')
1723     || $self->ut_textn('company')
1724     || $self->ut_text('address1')
1725     || $self->ut_textn('address2')
1726     || $self->ut_text('city')
1727     || $self->ut_textn('county')
1728     || $self->ut_textn('state')
1729     || $self->ut_country('country')
1730     || $self->ut_coordn('latitude')
1731     || $self->ut_coordn('longitude')
1732     || $self->ut_enum('coord_auto', [ '', 'Y' ])
1733     || $self->ut_numbern('censusyear')
1734     || $self->ut_anything('comments')
1735     || $self->ut_numbern('referral_custnum')
1736     || $self->ut_textn('stateid')
1737     || $self->ut_textn('stateid_state')
1738     || $self->ut_textn('invoice_terms')
1739     || $self->ut_alphan('geocode')
1740     || $self->ut_floatn('cdr_termination_percentage')
1741     || $self->ut_floatn('credit_limit')
1742     || $self->ut_numbern('billday')
1743     || $self->ut_enum('edit_subject', [ '', 'Y' ] )
1744     || $self->ut_enum('calling_list_exempt', [ '', 'Y' ] )
1745     || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1746   ;
1747
1748   $self->set_coord
1749     unless $import || ($self->latitude && $self->longitude);
1750
1751   #barf.  need message catalogs.  i18n.  etc.
1752   $error .= "Please select an advertising source."
1753     if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1754   return $error if $error;
1755
1756   return "Unknown agent"
1757     unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1758
1759   return "Unknown refnum"
1760     unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1761
1762   return "Unknown referring custnum: ". $self->referral_custnum
1763     unless ! $self->referral_custnum
1764            || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1765
1766   if ( $self->censustract ne '' ) {
1767     $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1768       or return "Illegal census tract: ". $self->censustract;
1769
1770     $self->censustract("$1.$2");
1771   }
1772
1773   if ( $self->ss eq '' ) {
1774     $self->ss('');
1775   } else {
1776     my $ss = $self->ss;
1777     $ss =~ s/\D//g;
1778     $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1779       or return "Illegal social security number: ". $self->ss;
1780     $self->ss("$1-$2-$3");
1781   }
1782
1783
1784 # bad idea to disable, causes billing to fail because of no tax rates later
1785 # except we don't fail any more
1786   unless ( $import ) {
1787     unless ( qsearch('cust_main_county', {
1788       'country' => $self->country,
1789       'state'   => '',
1790      } ) ) {
1791       return "Unknown state/county/country: ".
1792         $self->state. "/". $self->county. "/". $self->country
1793         unless qsearch('cust_main_county',{
1794           'state'   => $self->state,
1795           'county'  => $self->county,
1796           'country' => $self->country,
1797         } );
1798     }
1799   }
1800
1801   $error =
1802        $self->ut_phonen('daytime', $self->country)
1803     || $self->ut_phonen('night',   $self->country)
1804     || $self->ut_phonen('fax',     $self->country)
1805     || $self->ut_phonen('mobile',  $self->country)
1806   ;
1807   return $error if $error;
1808
1809   unless ( $ignore_illegal_zip ) {
1810     $error = $self->ut_zip('zip', $self->country);
1811     return $error if $error;
1812   }
1813
1814   if ( $conf->exists('cust_main-require_phone')
1815        && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1816      ) {
1817
1818     my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1819                           ? 'Day Phone'
1820                           : FS::Msgcat::_gettext('daytime');
1821     my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1822                         ? 'Night Phone'
1823                         : FS::Msgcat::_gettext('night');
1824
1825     my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1826                         ? 'Mobile Phone'
1827                         : FS::Msgcat::_gettext('mobile');
1828
1829     return "$daytime_label, $night_label or $mobile_label is required"
1830
1831   }
1832
1833   if ( $self->has_ship_address
1834        && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1835                         $self->addr_fields )
1836      )
1837   {
1838     my $error =
1839       $self->ut_name('ship_last')
1840       || $self->ut_name('ship_first')
1841       || $self->ut_textn('ship_company')
1842       || $self->ut_text('ship_address1')
1843       || $self->ut_textn('ship_address2')
1844       || $self->ut_text('ship_city')
1845       || $self->ut_textn('ship_county')
1846       || $self->ut_textn('ship_state')
1847       || $self->ut_country('ship_country')
1848       || $self->ut_coordn('ship_latitude')
1849       || $self->ut_coordn('ship_longitude')
1850       || $self->ut_enum('ship_coord_auto', [ '', 'Y' ] )
1851     ;
1852     return $error if $error;
1853
1854     $self->set_coord('ship_')
1855       unless $import || ($self->ship_latitude && $self->ship_longitude);
1856
1857     #false laziness with above
1858     unless ( qsearchs('cust_main_county', {
1859       'country' => $self->ship_country,
1860       'state'   => '',
1861      } ) ) {
1862       return "Unknown ship_state/ship_county/ship_country: ".
1863         $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1864         unless qsearch('cust_main_county',{
1865           'state'   => $self->ship_state,
1866           'county'  => $self->ship_county,
1867           'country' => $self->ship_country,
1868         } );
1869     }
1870     #eofalse
1871
1872     $error =
1873          $self->ut_phonen('ship_daytime', $self->ship_country)
1874       || $self->ut_phonen('ship_night',   $self->ship_country)
1875       || $self->ut_phonen('ship_fax',     $self->ship_country)
1876       || $self->ut_phonen('ship_mobile',  $self->ship_country)
1877     ;
1878     return $error if $error;
1879
1880     unless ( $ignore_illegal_zip ) {
1881       $error = $self->ut_zip('ship_zip', $self->ship_country);
1882       return $error if $error;
1883     }
1884     return "Unit # is required."
1885       if $self->ship_address2 =~ /^\s*$/
1886       && $conf->exists('cust_main-require_address2');
1887
1888   } else { # ship_ info eq billing info, so don't store dup info in database
1889
1890     $self->setfield("ship_$_", '')
1891       foreach $self->addr_fields;
1892
1893     return "Unit # is required."
1894       if $self->address2 =~ /^\s*$/
1895       && $conf->exists('cust_main-require_address2');
1896
1897   }
1898
1899   #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1900   #  or return "Illegal payby: ". $self->payby;
1901   #$self->payby($1);
1902   FS::payby->can_payby($self->table, $self->payby)
1903     or return "Illegal payby: ". $self->payby;
1904
1905   $error =    $self->ut_numbern('paystart_month')
1906            || $self->ut_numbern('paystart_year')
1907            || $self->ut_numbern('payissue')
1908            || $self->ut_textn('paytype')
1909   ;
1910   return $error if $error;
1911
1912   if ( $self->payip eq '' ) {
1913     $self->payip('');
1914   } else {
1915     $error = $self->ut_ip('payip');
1916     return $error if $error;
1917   }
1918
1919   # If it is encrypted and the private key is not availaible then we can't
1920   # check the credit card.
1921   my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1922
1923   if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1924
1925     my $payinfo = $self->payinfo;
1926     $payinfo =~ s/\D//g;
1927     $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1928       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1929     $payinfo = $1;
1930     $self->payinfo($payinfo);
1931     validate($payinfo)
1932       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1933
1934     return gettext('unknown_card_type')
1935       if $self->payinfo !~ /^99\d{14}$/ #token
1936       && cardtype($self->payinfo) eq "Unknown";
1937
1938     unless ( $ignore_banned_card ) {
1939       my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1940       if ( $ban ) {
1941         if ( $ban->bantype eq 'warn' ) {
1942           #or others depending on value of $ban->reason ?
1943           return '_duplicate_card'.
1944                  ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1945                  ' until '.         time2str('%a %h %o at %r', $ban->_end_date).
1946                  ' (ban# '. $ban->bannum. ')'
1947             unless $self->override_ban_warn;
1948         } else {
1949           return 'Banned credit card: banned on '.
1950                  time2str('%a %h %o at %r', $ban->_date).
1951                  ' by '. $ban->otaker.
1952                  ' (ban# '. $ban->bannum. ')';
1953         }
1954       }
1955     }
1956
1957     if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1958       if ( cardtype($self->payinfo) eq 'American Express card' ) {
1959         $self->paycvv =~ /^(\d{4})$/
1960           or return "CVV2 (CID) for American Express cards is four digits.";
1961         $self->paycvv($1);
1962       } else {
1963         $self->paycvv =~ /^(\d{3})$/
1964           or return "CVV2 (CVC2/CID) is three digits.";
1965         $self->paycvv($1);
1966       }
1967     } else {
1968       $self->paycvv('');
1969     }
1970
1971     my $cardtype = cardtype($payinfo);
1972     if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1973
1974       return "Start date or issue number is required for $cardtype cards"
1975         unless $self->paystart_month && $self->paystart_year or $self->payissue;
1976
1977       return "Start month must be between 1 and 12"
1978         if $self->paystart_month
1979            and $self->paystart_month < 1 || $self->paystart_month > 12;
1980
1981       return "Start year must be 1990 or later"
1982         if $self->paystart_year
1983            and $self->paystart_year < 1990;
1984
1985       return "Issue number must be beween 1 and 99"
1986         if $self->payissue
1987           and $self->payissue < 1 || $self->payissue > 99;
1988
1989     } else {
1990       $self->paystart_month('');
1991       $self->paystart_year('');
1992       $self->payissue('');
1993     }
1994
1995   } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1996
1997     my $payinfo = $self->payinfo;
1998     $payinfo =~ s/[^\d\@\.]//g;
1999     if ( $conf->exists('cust_main-require-bank-branch') ) {
2000       $payinfo =~ /^(\d+)\@(\d+)\.(\d+)$/ or return 'invalid echeck account@branch.bank';
2001       $payinfo = "$1\@$2.$3";
2002     } elsif ( $conf->exists('echeck-nonus') ) {
2003       $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
2004       $payinfo = "$1\@$2";
2005     } else {
2006       $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
2007       $payinfo = "$1\@$2";
2008     }
2009     $self->payinfo($payinfo);
2010     $self->paycvv('');
2011
2012     unless ( $ignore_banned_card ) {
2013       my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
2014       if ( $ban ) {
2015         if ( $ban->bantype eq 'warn' ) {
2016           #or others depending on value of $ban->reason ?
2017           return '_duplicate_ach' unless $self->override_ban_warn;
2018         } else {
2019           return 'Banned ACH account: banned on '.
2020                  time2str('%a %h %o at %r', $ban->_date).
2021                  ' by '. $ban->otaker.
2022                  ' (ban# '. $ban->bannum. ')';
2023         }
2024       }
2025     }
2026
2027   } elsif ( $self->payby eq 'LECB' ) {
2028
2029     my $payinfo = $self->payinfo;
2030     $payinfo =~ s/\D//g;
2031     $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2032     $payinfo = $1;
2033     $self->payinfo($payinfo);
2034     $self->paycvv('');
2035
2036   } elsif ( $self->payby eq 'BILL' ) {
2037
2038     $error = $self->ut_textn('payinfo');
2039     return "Illegal P.O. number: ". $self->payinfo if $error;
2040     $self->paycvv('');
2041
2042   } elsif ( $self->payby eq 'COMP' ) {
2043
2044     my $curuser = $FS::CurrentUser::CurrentUser;
2045     if (    ! $self->custnum
2046          && ! $curuser->access_right('Complimentary customer')
2047        )
2048     {
2049       return "You are not permitted to create complimentary accounts."
2050     }
2051
2052     $error = $self->ut_textn('payinfo');
2053     return "Illegal comp account issuer: ". $self->payinfo if $error;
2054     $self->paycvv('');
2055
2056   } elsif ( $self->payby eq 'PREPAY' ) {
2057
2058     my $payinfo = $self->payinfo;
2059     $payinfo =~ s/\W//g; #anything else would just confuse things
2060     $self->payinfo($payinfo);
2061     $error = $self->ut_alpha('payinfo');
2062     return "Illegal prepayment identifier: ". $self->payinfo if $error;
2063     return "Unknown prepayment identifier"
2064       unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2065     $self->paycvv('');
2066
2067   }
2068
2069   if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2070     return "Expiration date required"
2071       unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
2072     $self->paydate('');
2073   } else {
2074     my( $m, $y );
2075     if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2076       ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2077     } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2078       ( $m, $y ) = ( $2, "19$1" );
2079     } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2080       ( $m, $y ) = ( $3, "20$2" );
2081     } else {
2082       return "Illegal expiration date: ". $self->paydate;
2083     }
2084     $m = sprintf('%02d',$m);
2085     $self->paydate("$y-$m-01");
2086     my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2087     return gettext('expired_card')
2088       if !$import
2089       && !$ignore_expired_card
2090       && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2091   }
2092
2093   if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2094        ( ! $conf->exists('require_cardname')
2095          || $self->payby !~ /^(CARD|DCRD)$/  )
2096   ) {
2097     $self->payname( $self->first. " ". $self->getfield('last') );
2098   } else {
2099     $self->payname =~ /^([\w \,\.\-\'\&]+)$/
2100       or return gettext('illegal_name'). " payname: ". $self->payname;
2101     $self->payname($1);
2102   }
2103
2104   foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2105     $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2106     $self->$flag($1);
2107   }
2108
2109   $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2110
2111   warn "$me check AFTER: \n". $self->_dump
2112     if $DEBUG > 2;
2113
2114   $self->SUPER::check;
2115 }
2116
2117 =item addr_fields
2118
2119 Returns a list of fields which have ship_ duplicates.
2120
2121 =cut
2122
2123 sub addr_fields {
2124   qw( last first company
2125       address1 address2 city county state zip country
2126       latitude longitude
2127       daytime night fax mobile
2128     );
2129 }
2130
2131 =item has_ship_address
2132
2133 Returns true if this customer record has a separate shipping address.
2134
2135 =cut
2136
2137 sub has_ship_address {
2138   my $self = shift;
2139   scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
2140 }
2141
2142 =item location_hash
2143
2144 Returns a list of key/value pairs, with the following keys: address1, adddress2,
2145 city, county, state, zip, country, and geocode.  The shipping address is used if present.
2146
2147 =cut
2148
2149 =item cust_location
2150
2151 Returns all locations (see L<FS::cust_location>) for this customer.
2152
2153 =cut
2154
2155 sub cust_location {
2156   my $self = shift;
2157   qsearch('cust_location', { 'custnum' => $self->custnum } );
2158 }
2159
2160 =item cust_contact
2161
2162 Returns all contacts (see L<FS::contact>) for this customer.
2163
2164 =cut
2165
2166 #already used :/ sub contact {
2167 sub cust_contact {
2168   my $self = shift;
2169   qsearch('contact', { 'custnum' => $self->custnum } );
2170 }
2171
2172 =item unsuspend
2173
2174 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2175 and L<FS::cust_pkg>) for this customer.  Always returns a list: an empty list
2176 on success or a list of errors.
2177
2178 =cut
2179
2180 sub unsuspend {
2181   my $self = shift;
2182   grep { $_->unsuspend } $self->suspended_pkgs;
2183 }
2184
2185 =item suspend
2186
2187 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2188
2189 Returns a list: an empty list on success or a list of errors.
2190
2191 =cut
2192
2193 sub suspend {
2194   my $self = shift;
2195   grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2196 }
2197
2198 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2199
2200 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2201 PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref instead
2202 of a list of pkgparts; the hashref has the following keys:
2203
2204 =over 4
2205
2206 =item pkgparts - listref of pkgparts
2207
2208 =item (other options are passed to the suspend method)
2209
2210 =back
2211
2212
2213 Returns a list: an empty list on success or a list of errors.
2214
2215 =cut
2216
2217 sub suspend_if_pkgpart {
2218   my $self = shift;
2219   my (@pkgparts, %opt);
2220   if (ref($_[0]) eq 'HASH'){
2221     @pkgparts = @{$_[0]{pkgparts}};
2222     %opt      = %{$_[0]};
2223   }else{
2224     @pkgparts = @_;
2225   }
2226   grep { $_->suspend(%opt) }
2227     grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2228       $self->unsuspended_pkgs;
2229 }
2230
2231 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2232
2233 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2234 given PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref
2235 instead of a list of pkgparts; the hashref has the following keys:
2236
2237 =over 4
2238
2239 =item pkgparts - listref of pkgparts
2240
2241 =item (other options are passed to the suspend method)
2242
2243 =back
2244
2245 Returns a list: an empty list on success or a list of errors.
2246
2247 =cut
2248
2249 sub suspend_unless_pkgpart {
2250   my $self = shift;
2251   my (@pkgparts, %opt);
2252   if (ref($_[0]) eq 'HASH'){
2253     @pkgparts = @{$_[0]{pkgparts}};
2254     %opt      = %{$_[0]};
2255   }else{
2256     @pkgparts = @_;
2257   }
2258   grep { $_->suspend(%opt) }
2259     grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2260       $self->unsuspended_pkgs;
2261 }
2262
2263 =item cancel [ OPTION => VALUE ... ]
2264
2265 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2266
2267 Available options are:
2268
2269 =over 4
2270
2271 =item quiet - can be set true to supress email cancellation notices.
2272
2273 =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.
2274
2275 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2276
2277 =item nobill - can be set true to skip billing if it might otherwise be done.
2278
2279 =back
2280
2281 Always returns a list: an empty list on success or a list of errors.
2282
2283 =cut
2284
2285 # nb that dates are not specified as valid options to this method
2286
2287 sub cancel {
2288   my( $self, %opt ) = @_;
2289
2290   warn "$me cancel called on customer ". $self->custnum. " with options ".
2291        join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2292     if $DEBUG;
2293
2294   return ( 'access denied' )
2295     unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2296
2297   if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2298
2299     #should try decryption (we might have the private key)
2300     # and if not maybe queue a job for the server that does?
2301     return ( "Can't (yet) ban encrypted credit cards" )
2302       if $self->is_encrypted($self->payinfo);
2303
2304     my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2305     my $error = $ban->insert;
2306     return ( $error ) if $error;
2307
2308   }
2309
2310   my @pkgs = $self->ncancelled_pkgs;
2311
2312   if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2313     $opt{nobill} = 1;
2314     my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2315     warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2316       if $error;
2317   }
2318
2319   warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2320        scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2321     if $DEBUG;
2322
2323   grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2324 }
2325
2326 sub _banned_pay_hashref {
2327   my $self = shift;
2328
2329   my %payby2ban = (
2330     'CARD' => 'CARD',
2331     'DCRD' => 'CARD',
2332     'CHEK' => 'CHEK',
2333     'DCHK' => 'CHEK'
2334   );
2335
2336   {
2337     'payby'   => $payby2ban{$self->payby},
2338     'payinfo' => $self->payinfo,
2339     #don't ever *search* on reason! #'reason'  =>
2340   };
2341 }
2342
2343 sub _new_banned_pay_hashref {
2344   my $self = shift;
2345   my $hr = $self->_banned_pay_hashref;
2346   $hr->{payinfo} = md5_base64($hr->{payinfo});
2347   $hr;
2348 }
2349
2350 =item notes
2351
2352 Returns all notes (see L<FS::cust_main_note>) for this customer.
2353
2354 =cut
2355
2356 sub notes {
2357   my($self,$orderby_classnum) = (shift,shift);
2358   my $orderby = "_DATE DESC";
2359   $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2360   qsearch( 'cust_main_note',
2361            { 'custnum' => $self->custnum },
2362            '',
2363            "ORDER BY $orderby",
2364          );
2365 }
2366
2367 =item agent
2368
2369 Returns the agent (see L<FS::agent>) for this customer.
2370
2371 =cut
2372
2373 sub agent {
2374   my $self = shift;
2375   qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2376 }
2377
2378 =item agent_name
2379
2380 Returns the agent name (see L<FS::agent>) for this customer.
2381
2382 =cut
2383
2384 sub agent_name {
2385   my $self = shift;
2386   $self->agent->agent;
2387 }
2388
2389 =item cust_tag
2390
2391 Returns any tags associated with this customer, as FS::cust_tag objects,
2392 or an empty list if there are no tags.
2393
2394 =cut
2395
2396 sub cust_tag {
2397   my $self = shift;
2398   qsearch('cust_tag', { 'custnum' => $self->custnum } );
2399 }
2400
2401 =item part_tag
2402
2403 Returns any tags associated with this customer, as FS::part_tag objects,
2404 or an empty list if there are no tags.
2405
2406 =cut
2407
2408 sub part_tag {
2409   my $self = shift;
2410   map $_->part_tag, $self->cust_tag;
2411 }
2412
2413
2414 =item cust_class
2415
2416 Returns the customer class, as an FS::cust_class object, or the empty string
2417 if there is no customer class.
2418
2419 =cut
2420
2421 sub cust_class {
2422   my $self = shift;
2423   if ( $self->classnum ) {
2424     qsearchs('cust_class', { 'classnum' => $self->classnum } );
2425   } else {
2426     return '';
2427   }
2428 }
2429
2430 =item categoryname
2431
2432 Returns the customer category name, or the empty string if there is no customer
2433 category.
2434
2435 =cut
2436
2437 sub categoryname {
2438   my $self = shift;
2439   my $cust_class = $self->cust_class;
2440   $cust_class
2441     ? $cust_class->categoryname
2442     : '';
2443 }
2444
2445 =item classname
2446
2447 Returns the customer class name, or the empty string if there is no customer
2448 class.
2449
2450 =cut
2451
2452 sub classname {
2453   my $self = shift;
2454   my $cust_class = $self->cust_class;
2455   $cust_class
2456     ? $cust_class->classname
2457     : '';
2458 }
2459
2460 =item BILLING METHODS
2461
2462 Documentation on billing methods has been moved to
2463 L<FS::cust_main::Billing>.
2464
2465 =item REALTIME BILLING METHODS
2466
2467 Documentation on realtime billing methods has been moved to
2468 L<FS::cust_main::Billing_Realtime>.
2469
2470 =item remove_cvv
2471
2472 Removes the I<paycvv> field from the database directly.
2473
2474 If there is an error, returns the error, otherwise returns false.
2475
2476 =cut
2477
2478 sub remove_cvv {
2479   my $self = shift;
2480   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2481     or return dbh->errstr;
2482   $sth->execute($self->custnum)
2483     or return $sth->errstr;
2484   $self->paycvv('');
2485   '';
2486 }
2487
2488 =item batch_card OPTION => VALUE...
2489
2490 Adds a payment for this invoice to the pending credit card batch (see
2491 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2492 runs the payment using a realtime gateway.
2493
2494 =cut
2495
2496 sub batch_card {
2497   my ($self, %options) = @_;
2498
2499   my $amount;
2500   if (exists($options{amount})) {
2501     $amount = $options{amount};
2502   }else{
2503     $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2504   }
2505   return '' unless $amount > 0;
2506
2507   my $invnum = delete $options{invnum};
2508   my $payby = $options{payby} || $self->payby;  #still dubious
2509
2510   if ($options{'realtime'}) {
2511     return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2512                                 $amount,
2513                                 %options,
2514                               );
2515   }
2516
2517   my $oldAutoCommit = $FS::UID::AutoCommit;
2518   local $FS::UID::AutoCommit = 0;
2519   my $dbh = dbh;
2520
2521   #this needs to handle mysql as well as Pg, like svc_acct.pm
2522   #(make it into a common function if folks need to do batching with mysql)
2523   $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2524     or return "Cannot lock pay_batch: " . $dbh->errstr;
2525
2526   my %pay_batch = (
2527     'status' => 'O',
2528     'payby'  => FS::payby->payby2payment($payby),
2529   );
2530   $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2531
2532   my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2533
2534   unless ( $pay_batch ) {
2535     $pay_batch = new FS::pay_batch \%pay_batch;
2536     my $error = $pay_batch->insert;
2537     if ( $error ) {
2538       $dbh->rollback if $oldAutoCommit;
2539       die "error creating new batch: $error\n";
2540     }
2541   }
2542
2543   my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2544       'batchnum' => $pay_batch->batchnum,
2545       'custnum'  => $self->custnum,
2546   } );
2547
2548   foreach (qw( address1 address2 city state zip country latitude longitude
2549                payby payinfo paydate payname ))
2550   {
2551     $options{$_} = '' unless exists($options{$_});
2552   }
2553
2554   my $cust_pay_batch = new FS::cust_pay_batch ( {
2555     'batchnum' => $pay_batch->batchnum,
2556     'invnum'   => $invnum || 0,                    # is there a better value?
2557                                                    # this field should be
2558                                                    # removed...
2559                                                    # cust_bill_pay_batch now
2560     'custnum'  => $self->custnum,
2561     'last'     => $self->getfield('last'),
2562     'first'    => $self->getfield('first'),
2563     'address1' => $options{address1} || $self->address1,
2564     'address2' => $options{address2} || $self->address2,
2565     'city'     => $options{city}     || $self->city,
2566     'state'    => $options{state}    || $self->state,
2567     'zip'      => $options{zip}      || $self->zip,
2568     'country'  => $options{country}  || $self->country,
2569     'payby'    => $options{payby}    || $self->payby,
2570     'payinfo'  => $options{payinfo}  || $self->payinfo,
2571     'exp'      => $options{paydate}  || $self->paydate,
2572     'payname'  => $options{payname}  || $self->payname,
2573     'amount'   => $amount,                         # consolidating
2574   } );
2575
2576   $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2577     if $old_cust_pay_batch;
2578
2579   my $error;
2580   if ($old_cust_pay_batch) {
2581     $error = $cust_pay_batch->replace($old_cust_pay_batch)
2582   } else {
2583     $error = $cust_pay_batch->insert;
2584   }
2585
2586   if ( $error ) {
2587     $dbh->rollback if $oldAutoCommit;
2588     die $error;
2589   }
2590
2591   my $unapplied =   $self->total_unapplied_credits
2592                   + $self->total_unapplied_payments
2593                   + $self->in_transit_payments;
2594   foreach my $cust_bill ($self->open_cust_bill) {
2595     #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2596     my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2597       'invnum' => $cust_bill->invnum,
2598       'paybatchnum' => $cust_pay_batch->paybatchnum,
2599       'amount' => $cust_bill->owed,
2600       '_date' => time,
2601     };
2602     if ($unapplied >= $cust_bill_pay_batch->amount){
2603       $unapplied -= $cust_bill_pay_batch->amount;
2604       next;
2605     }else{
2606       $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2607                                    $cust_bill_pay_batch->amount - $unapplied ));      $unapplied = 0;
2608     }
2609     $error = $cust_bill_pay_batch->insert;
2610     if ( $error ) {
2611       $dbh->rollback if $oldAutoCommit;
2612       die $error;
2613     }
2614   }
2615
2616   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2617   '';
2618 }
2619
2620 =item total_owed
2621
2622 Returns the total owed for this customer on all invoices
2623 (see L<FS::cust_bill/owed>).
2624
2625 =cut
2626
2627 sub total_owed {
2628   my $self = shift;
2629   $self->total_owed_date(2145859200); #12/31/2037
2630 }
2631
2632 =item total_owed_date TIME
2633
2634 Returns the total owed for this customer on all invoices with date earlier than
2635 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2636 see L<Time::Local> and L<Date::Parse> for conversion functions.
2637
2638 =cut
2639
2640 sub total_owed_date {
2641   my $self = shift;
2642   my $time = shift;
2643
2644   my $custnum = $self->custnum;
2645
2646   my $owed_sql = FS::cust_bill->owed_sql;
2647
2648   my $sql = "
2649     SELECT SUM($owed_sql) FROM cust_bill
2650       WHERE custnum = $custnum
2651         AND _date <= $time
2652   ";
2653
2654   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2655
2656 }
2657
2658 =item total_owed_pkgnum PKGNUM
2659
2660 Returns the total owed on all invoices for this customer's specific package
2661 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2662
2663 =cut
2664
2665 sub total_owed_pkgnum {
2666   my( $self, $pkgnum ) = @_;
2667   $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2668 }
2669
2670 =item total_owed_date_pkgnum TIME PKGNUM
2671
2672 Returns the total owed for this customer's specific package when using
2673 experimental package balances on all invoices with date earlier than
2674 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2675 see L<Time::Local> and L<Date::Parse> for conversion functions.
2676
2677 =cut
2678
2679 sub total_owed_date_pkgnum {
2680   my( $self, $time, $pkgnum ) = @_;
2681
2682   my $total_bill = 0;
2683   foreach my $cust_bill (
2684     grep { $_->_date <= $time }
2685       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2686   ) {
2687     $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2688   }
2689   sprintf( "%.2f", $total_bill );
2690
2691 }
2692
2693 =item total_paid
2694
2695 Returns the total amount of all payments.
2696
2697 =cut
2698
2699 sub total_paid {
2700   my $self = shift;
2701   my $total = 0;
2702   $total += $_->paid foreach $self->cust_pay;
2703   sprintf( "%.2f", $total );
2704 }
2705
2706 =item total_unapplied_credits
2707
2708 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2709 customer.  See L<FS::cust_credit/credited>.
2710
2711 =item total_credited
2712
2713 Old name for total_unapplied_credits.  Don't use.
2714
2715 =cut
2716
2717 sub total_credited {
2718   #carp "total_credited deprecated, use total_unapplied_credits";
2719   shift->total_unapplied_credits(@_);
2720 }
2721
2722 sub total_unapplied_credits {
2723   my $self = shift;
2724
2725   my $custnum = $self->custnum;
2726
2727   my $unapplied_sql = FS::cust_credit->unapplied_sql;
2728
2729   my $sql = "
2730     SELECT SUM($unapplied_sql) FROM cust_credit
2731       WHERE custnum = $custnum
2732   ";
2733
2734   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2735
2736 }
2737
2738 =item total_unapplied_credits_pkgnum PKGNUM
2739
2740 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2741 customer.  See L<FS::cust_credit/credited>.
2742
2743 =cut
2744
2745 sub total_unapplied_credits_pkgnum {
2746   my( $self, $pkgnum ) = @_;
2747   my $total_credit = 0;
2748   $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2749   sprintf( "%.2f", $total_credit );
2750 }
2751
2752
2753 =item total_unapplied_payments
2754
2755 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2756 See L<FS::cust_pay/unapplied>.
2757
2758 =cut
2759
2760 sub total_unapplied_payments {
2761   my $self = shift;
2762
2763   my $custnum = $self->custnum;
2764
2765   my $unapplied_sql = FS::cust_pay->unapplied_sql;
2766
2767   my $sql = "
2768     SELECT SUM($unapplied_sql) FROM cust_pay
2769       WHERE custnum = $custnum
2770   ";
2771
2772   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2773
2774 }
2775
2776 =item total_unapplied_payments_pkgnum PKGNUM
2777
2778 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2779 specific package when using experimental package balances.  See
2780 L<FS::cust_pay/unapplied>.
2781
2782 =cut
2783
2784 sub total_unapplied_payments_pkgnum {
2785   my( $self, $pkgnum ) = @_;
2786   my $total_unapplied = 0;
2787   $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2788   sprintf( "%.2f", $total_unapplied );
2789 }
2790
2791
2792 =item total_unapplied_refunds
2793
2794 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2795 customer.  See L<FS::cust_refund/unapplied>.
2796
2797 =cut
2798
2799 sub total_unapplied_refunds {
2800   my $self = shift;
2801   my $custnum = $self->custnum;
2802
2803   my $unapplied_sql = FS::cust_refund->unapplied_sql;
2804
2805   my $sql = "
2806     SELECT SUM($unapplied_sql) FROM cust_refund
2807       WHERE custnum = $custnum
2808   ";
2809
2810   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2811
2812 }
2813
2814 =item balance
2815
2816 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2817 total_unapplied_credits minus total_unapplied_payments).
2818
2819 =cut
2820
2821 sub balance {
2822   my $self = shift;
2823   $self->balance_date_range;
2824 }
2825
2826 =item balance_date TIME
2827
2828 Returns the balance for this customer, only considering invoices with date
2829 earlier than TIME (total_owed_date minus total_credited minus
2830 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
2831 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
2832 functions.
2833
2834 =cut
2835
2836 sub balance_date {
2837   my $self = shift;
2838   $self->balance_date_range(shift);
2839 }
2840
2841 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2842
2843 Returns the balance for this customer, optionally considering invoices with
2844 date earlier than START_TIME, and not later than END_TIME
2845 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2846
2847 Times are specified as SQL fragments or numeric
2848 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
2849 L<Date::Parse> for conversion functions.  The empty string can be passed
2850 to disable that time constraint completely.
2851
2852 Available options are:
2853
2854 =over 4
2855
2856 =item unapplied_date
2857
2858 set to true to disregard unapplied credits, payments and refunds outside the specified time period - by default the time period restriction only applies to invoices (useful for reporting, probably a bad idea for event triggering)
2859
2860 =back
2861
2862 =cut
2863
2864 sub balance_date_range {
2865   my $self = shift;
2866   my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2867             ') FROM cust_main WHERE custnum='. $self->custnum;
2868   sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2869 }
2870
2871 =item balance_pkgnum PKGNUM
2872
2873 Returns the balance for this customer's specific package when using
2874 experimental package balances (total_owed plus total_unrefunded, minus
2875 total_unapplied_credits minus total_unapplied_payments)
2876
2877 =cut
2878
2879 sub balance_pkgnum {
2880   my( $self, $pkgnum ) = @_;
2881
2882   sprintf( "%.2f",
2883       $self->total_owed_pkgnum($pkgnum)
2884 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2885 #    + $self->total_unapplied_refunds_pkgnum($pkgnum)
2886     - $self->total_unapplied_credits_pkgnum($pkgnum)
2887     - $self->total_unapplied_payments_pkgnum($pkgnum)
2888   );
2889 }
2890
2891 =item in_transit_payments
2892
2893 Returns the total of requests for payments for this customer pending in
2894 batches in transit to the bank.  See L<FS::pay_batch> and L<FS::cust_pay_batch>
2895
2896 =cut
2897
2898 sub in_transit_payments {
2899   my $self = shift;
2900   my $in_transit_payments = 0;
2901   foreach my $pay_batch ( qsearch('pay_batch', {
2902     'status' => 'I',
2903   } ) ) {
2904     foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2905       'batchnum' => $pay_batch->batchnum,
2906       'custnum' => $self->custnum,
2907     } ) ) {
2908       $in_transit_payments += $cust_pay_batch->amount;
2909     }
2910   }
2911   sprintf( "%.2f", $in_transit_payments );
2912 }
2913
2914 =item payment_info
2915
2916 Returns a hash of useful information for making a payment.
2917
2918 =over 4
2919
2920 =item balance
2921
2922 Current balance.
2923
2924 =item payby
2925
2926 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2927 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2928 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2929
2930 =back
2931
2932 For credit card transactions:
2933
2934 =over 4
2935
2936 =item card_type 1
2937
2938 =item payname
2939
2940 Exact name on card
2941
2942 =back
2943
2944 For electronic check transactions:
2945
2946 =over 4
2947
2948 =item stateid_state
2949
2950 =back
2951
2952 =cut
2953
2954 sub payment_info {
2955   my $self = shift;
2956
2957   my %return = ();
2958
2959   $return{balance} = $self->balance;
2960
2961   $return{payname} = $self->payname
2962                      || ( $self->first. ' '. $self->get('last') );
2963
2964   $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
2965
2966   $return{payby} = $self->payby;
2967   $return{stateid_state} = $self->stateid_state;
2968
2969   if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2970     $return{card_type} = cardtype($self->payinfo);
2971     $return{payinfo} = $self->paymask;
2972
2973     @return{'month', 'year'} = $self->paydate_monthyear;
2974
2975   }
2976
2977   if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2978     my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2979     $return{payinfo1} = $payinfo1;
2980     $return{payinfo2} = $payinfo2;
2981     $return{paytype}  = $self->paytype;
2982     $return{paystate} = $self->paystate;
2983
2984   }
2985
2986   #doubleclick protection
2987   my $_date = time;
2988   $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2989
2990   %return;
2991
2992 }
2993
2994 =item paydate_monthyear
2995
2996 Returns a two-element list consisting of the month and year of this customer's
2997 paydate (credit card expiration date for CARD customers)
2998
2999 =cut
3000
3001 sub paydate_monthyear {
3002   my $self = shift;
3003   if ( $self->paydate  =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3004     ( $2, $1 );
3005   } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3006     ( $1, $3 );
3007   } else {
3008     ('', '');
3009   }
3010 }
3011
3012 =item paydate_epoch
3013
3014 Returns the exact time in seconds corresponding to the payment method
3015 expiration date.  For CARD/DCRD customers this is the end of the month;
3016 for others (COMP is the only other payby that uses paydate) it's the start.
3017 Returns 0 if the paydate is empty or set to the far future.
3018
3019 =cut
3020
3021 sub paydate_epoch {
3022   my $self = shift;
3023   my ($month, $year) = $self->paydate_monthyear;
3024   return 0 if !$year or $year >= 2037;
3025   if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3026     $month++;
3027     if ( $month == 13 ) {
3028       $month = 1;
3029       $year++;
3030     }
3031     return timelocal(0,0,0,1,$month-1,$year) - 1;
3032   }
3033   else {
3034     return timelocal(0,0,0,1,$month-1,$year);
3035   }
3036 }
3037
3038 =item paydate_epoch_sql
3039
3040 Class method.  Returns an SQL expression to obtain the payment expiration date
3041 as a number of seconds.
3042
3043 =cut
3044
3045 # Special expiration date behavior for non-CARD/DCRD customers has been
3046 # carefully preserved.  Do we really use that?
3047 sub paydate_epoch_sql {
3048   my $class = shift;
3049   my $table = shift || 'cust_main';
3050   my ($case1, $case2);
3051   if ( driver_name eq 'Pg' ) {
3052     $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3053     $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3054   }
3055   elsif ( lc(driver_name) eq 'mysql' ) {
3056     $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3057     $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3058   }
3059   else { return '' }
3060   return "CASE WHEN $table.payby IN('CARD','DCRD')
3061   THEN ($case1)
3062   ELSE ($case2)
3063   END"
3064 }
3065
3066 =item tax_exemption TAXNAME
3067
3068 =cut
3069
3070 sub tax_exemption {
3071   my( $self, $taxname ) = @_;
3072
3073   qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3074                                      'taxname' => $taxname,
3075                                    },
3076           );
3077 }
3078
3079 =item cust_main_exemption
3080
3081 =cut
3082
3083 sub cust_main_exemption {
3084   my $self = shift;
3085   qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3086 }
3087
3088 =item invoicing_list [ ARRAYREF ]
3089
3090 If an arguement is given, sets these email addresses as invoice recipients
3091 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
3092 (except as warnings), so use check_invoicing_list first.
3093
3094 Returns a list of email addresses (with svcnum entries expanded).
3095
3096 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
3097 check it without disturbing anything by passing nothing.
3098
3099 This interface may change in the future.
3100
3101 =cut
3102
3103 sub invoicing_list {
3104   my( $self, $arrayref ) = @_;
3105
3106   if ( $arrayref ) {
3107     my @cust_main_invoice;
3108     if ( $self->custnum ) {
3109       @cust_main_invoice =
3110         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3111     } else {
3112       @cust_main_invoice = ();
3113     }
3114     foreach my $cust_main_invoice ( @cust_main_invoice ) {
3115       #warn $cust_main_invoice->destnum;
3116       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3117         #warn $cust_main_invoice->destnum;
3118         my $error = $cust_main_invoice->delete;
3119         warn $error if $error;
3120       }
3121     }
3122     if ( $self->custnum ) {
3123       @cust_main_invoice =
3124         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3125     } else {
3126       @cust_main_invoice = ();
3127     }
3128     my %seen = map { $_->address => 1 } @cust_main_invoice;
3129     foreach my $address ( @{$arrayref} ) {
3130       next if exists $seen{$address} && $seen{$address};
3131       $seen{$address} = 1;
3132       my $cust_main_invoice = new FS::cust_main_invoice ( {
3133         'custnum' => $self->custnum,
3134         'dest'    => $address,
3135       } );
3136       my $error = $cust_main_invoice->insert;
3137       warn $error if $error;
3138     }
3139   }
3140
3141   if ( $self->custnum ) {
3142     map { $_->address }
3143       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3144   } else {
3145     ();
3146   }
3147
3148 }
3149
3150 =item check_invoicing_list ARRAYREF
3151
3152 Checks these arguements as valid input for the invoicing_list method.  If there
3153 is an error, returns the error, otherwise returns false.
3154
3155 =cut
3156
3157 sub check_invoicing_list {
3158   my( $self, $arrayref ) = @_;
3159
3160   foreach my $address ( @$arrayref ) {
3161
3162     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3163       return 'Can\'t add FAX invoice destination with a blank FAX number.';
3164     }
3165
3166     my $cust_main_invoice = new FS::cust_main_invoice ( {
3167       'custnum' => $self->custnum,
3168       'dest'    => $address,
3169     } );
3170     my $error = $self->custnum
3171                 ? $cust_main_invoice->check
3172                 : $cust_main_invoice->checkdest
3173     ;
3174     return $error if $error;
3175
3176   }
3177
3178   return "Email address required"
3179     if $conf->exists('cust_main-require_invoicing_list_email')
3180     && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3181
3182   '';
3183 }
3184
3185 =item set_default_invoicing_list
3186
3187 Sets the invoicing list to all accounts associated with this customer,
3188 overwriting any previous invoicing list.
3189
3190 =cut
3191
3192 sub set_default_invoicing_list {
3193   my $self = shift;
3194   $self->invoicing_list($self->all_emails);
3195 }
3196
3197 =item all_emails
3198
3199 Returns the email addresses of all accounts provisioned for this customer.
3200
3201 =cut
3202
3203 sub all_emails {
3204   my $self = shift;
3205   my %list;
3206   foreach my $cust_pkg ( $self->all_pkgs ) {
3207     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3208     my @svc_acct =
3209       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3210         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3211           @cust_svc;
3212     $list{$_}=1 foreach map { $_->email } @svc_acct;
3213   }
3214   keys %list;
3215 }
3216
3217 =item invoicing_list_addpost
3218
3219 Adds postal invoicing to this customer.  If this customer is already configured
3220 to receive postal invoices, does nothing.
3221
3222 =cut
3223
3224 sub invoicing_list_addpost {
3225   my $self = shift;
3226   return if grep { $_ eq 'POST' } $self->invoicing_list;
3227   my @invoicing_list = $self->invoicing_list;
3228   push @invoicing_list, 'POST';
3229   $self->invoicing_list(\@invoicing_list);
3230 }
3231
3232 =item invoicing_list_emailonly
3233
3234 Returns the list of email invoice recipients (invoicing_list without non-email
3235 destinations such as POST and FAX).
3236
3237 =cut
3238
3239 sub invoicing_list_emailonly {
3240   my $self = shift;
3241   warn "$me invoicing_list_emailonly called"
3242     if $DEBUG;
3243   grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3244 }
3245
3246 =item invoicing_list_emailonly_scalar
3247
3248 Returns the list of email invoice recipients (invoicing_list without non-email
3249 destinations such as POST and FAX) as a comma-separated scalar.
3250
3251 =cut
3252
3253 sub invoicing_list_emailonly_scalar {
3254   my $self = shift;
3255   warn "$me invoicing_list_emailonly_scalar called"
3256     if $DEBUG;
3257   join(', ', $self->invoicing_list_emailonly);
3258 }
3259
3260 =item referral_custnum_cust_main
3261
3262 Returns the customer who referred this customer (or the empty string, if
3263 this customer was not referred).
3264
3265 Note the difference with referral_cust_main method: This method,
3266 referral_custnum_cust_main returns the single customer (if any) who referred
3267 this customer, while referral_cust_main returns an array of customers referred
3268 BY this customer.
3269
3270 =cut
3271
3272 sub referral_custnum_cust_main {
3273   my $self = shift;
3274   return '' unless $self->referral_custnum;
3275   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3276 }
3277
3278 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3279
3280 Returns an array of customers referred by this customer (referral_custnum set
3281 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
3282 customers referred by customers referred by this customer and so on, inclusive.
3283 The default behavior is DEPTH 1 (no recursion).
3284
3285 Note the difference with referral_custnum_cust_main method: This method,
3286 referral_cust_main, returns an array of customers referred BY this customer,
3287 while referral_custnum_cust_main returns the single customer (if any) who
3288 referred this customer.
3289
3290 =cut
3291
3292 sub referral_cust_main {
3293   my $self = shift;
3294   my $depth = @_ ? shift : 1;
3295   my $exclude = @_ ? shift : {};
3296
3297   my @cust_main =
3298     map { $exclude->{$_->custnum}++; $_; }
3299       grep { ! $exclude->{ $_->custnum } }
3300         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3301
3302   if ( $depth > 1 ) {
3303     push @cust_main,
3304       map { $_->referral_cust_main($depth-1, $exclude) }
3305         @cust_main;
3306   }
3307
3308   @cust_main;
3309 }
3310
3311 =item referral_cust_main_ncancelled
3312
3313 Same as referral_cust_main, except only returns customers with uncancelled
3314 packages.
3315
3316 =cut
3317
3318 sub referral_cust_main_ncancelled {
3319   my $self = shift;
3320   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3321 }
3322
3323 =item referral_cust_pkg [ DEPTH ]
3324
3325 Like referral_cust_main, except returns a flat list of all unsuspended (and
3326 uncancelled) packages for each customer.  The number of items in this list may
3327 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3328
3329 =cut
3330
3331 sub referral_cust_pkg {
3332   my $self = shift;
3333   my $depth = @_ ? shift : 1;
3334
3335   map { $_->unsuspended_pkgs }
3336     grep { $_->unsuspended_pkgs }
3337       $self->referral_cust_main($depth);
3338 }
3339
3340 =item referring_cust_main
3341
3342 Returns the single cust_main record for the customer who referred this customer
3343 (referral_custnum), or false.
3344
3345 =cut
3346
3347 sub referring_cust_main {
3348   my $self = shift;
3349   return '' unless $self->referral_custnum;
3350   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3351 }
3352
3353 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3354
3355 Applies a credit to this customer.  If there is an error, returns the error,
3356 otherwise returns false.
3357
3358 REASON can be a text string, an FS::reason object, or a scalar reference to
3359 a reasonnum.  If a text string, it will be automatically inserted as a new
3360 reason, and a 'reason_type' option must be passed to indicate the
3361 FS::reason_type for the new reason.
3362
3363 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3364
3365 Any other options are passed to FS::cust_credit::insert.
3366
3367 =cut
3368
3369 sub credit {
3370   my( $self, $amount, $reason, %options ) = @_;
3371
3372   my $cust_credit = new FS::cust_credit {
3373     'custnum' => $self->custnum,
3374     'amount'  => $amount,
3375   };
3376
3377   if ( ref($reason) ) {
3378
3379     if ( ref($reason) eq 'SCALAR' ) {
3380       $cust_credit->reasonnum( $$reason );
3381     } else {
3382       $cust_credit->reasonnum( $reason->reasonnum );
3383     }
3384
3385   } else {
3386     $cust_credit->set('reason', $reason)
3387   }
3388
3389   for (qw( addlinfo eventnum )) {
3390     $cust_credit->$_( delete $options{$_} )
3391       if exists($options{$_});
3392   }
3393
3394   $cust_credit->insert(%options);
3395
3396 }
3397
3398 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3399
3400 Creates a one-time charge for this customer.  If there is an error, returns
3401 the error, otherwise returns false.
3402
3403 New-style, with a hashref of options:
3404
3405   my $error = $cust_main->charge(
3406                                   {
3407                                     'amount'     => 54.32,
3408                                     'quantity'   => 1,
3409                                     'start_date' => str2time('7/4/2009'),
3410                                     'pkg'        => 'Description',
3411                                     'comment'    => 'Comment',
3412                                     'additional' => [], #extra invoice detail
3413                                     'classnum'   => 1,  #pkg_class
3414
3415                                     'setuptax'   => '', # or 'Y' for tax exempt
3416
3417                                     #internal taxation
3418                                     'taxclass'   => 'Tax class',
3419
3420                                     #vendor taxation
3421                                     'taxproduct' => 2,  #part_pkg_taxproduct
3422                                     'override'   => {}, #XXX describe
3423
3424                                     #will be filled in with the new object
3425                                     'cust_pkg_ref' => \$cust_pkg,
3426
3427                                     #generate an invoice immediately
3428                                     'bill_now' => 0,
3429                                     'invoice_terms' => '', #with these terms
3430                                   }
3431                                 );
3432
3433 Old-style:
3434
3435   my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3436
3437 =cut
3438
3439 sub charge {
3440   my $self = shift;
3441   my ( $amount, $quantity, $start_date, $classnum );
3442   my ( $pkg, $comment, $additional );
3443   my ( $setuptax, $taxclass );   #internal taxes
3444   my ( $taxproduct, $override ); #vendor (CCH) taxes
3445   my $no_auto = '';
3446   my $cust_pkg_ref = '';
3447   my ( $bill_now, $invoice_terms ) = ( 0, '' );
3448   if ( ref( $_[0] ) ) {
3449     $amount     = $_[0]->{amount};
3450     $quantity   = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3451     $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3452     $no_auto    = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3453     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3454     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
3455                                            : '$'. sprintf("%.2f",$amount);
3456     $setuptax   = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3457     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3458     $classnum   = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3459     $additional = $_[0]->{additional} || [];
3460     $taxproduct = $_[0]->{taxproductnum};
3461     $override   = { '' => $_[0]->{tax_override} };
3462     $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3463     $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3464     $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3465   } else {
3466     $amount     = shift;
3467     $quantity   = 1;
3468     $start_date = '';
3469     $pkg        = @_ ? shift : 'One-time charge';
3470     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
3471     $setuptax   = '';
3472     $taxclass   = @_ ? shift : '';
3473     $additional = [];
3474   }
3475
3476   local $SIG{HUP} = 'IGNORE';
3477   local $SIG{INT} = 'IGNORE';
3478   local $SIG{QUIT} = 'IGNORE';
3479   local $SIG{TERM} = 'IGNORE';
3480   local $SIG{TSTP} = 'IGNORE';
3481   local $SIG{PIPE} = 'IGNORE';
3482
3483   my $oldAutoCommit = $FS::UID::AutoCommit;
3484   local $FS::UID::AutoCommit = 0;
3485   my $dbh = dbh;
3486
3487   my $part_pkg = new FS::part_pkg ( {
3488     'pkg'           => $pkg,
3489     'comment'       => $comment,
3490     'plan'          => 'flat',
3491     'freq'          => 0,
3492     'disabled'      => 'Y',
3493     'classnum'      => ( $classnum ? $classnum : '' ),
3494     'setuptax'      => $setuptax,
3495     'taxclass'      => $taxclass,
3496     'taxproductnum' => $taxproduct,
3497   } );
3498
3499   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3500                         ( 0 .. @$additional - 1 )
3501                   ),
3502                   'additional_count' => scalar(@$additional),
3503                   'setup_fee' => $amount,
3504                 );
3505
3506   my $error = $part_pkg->insert( options       => \%options,
3507                                  tax_overrides => $override,
3508                                );
3509   if ( $error ) {
3510     $dbh->rollback if $oldAutoCommit;
3511     return $error;
3512   }
3513
3514   my $pkgpart = $part_pkg->pkgpart;
3515   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3516   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3517     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3518     $error = $type_pkgs->insert;
3519     if ( $error ) {
3520       $dbh->rollback if $oldAutoCommit;
3521       return $error;
3522     }
3523   }
3524
3525   my $cust_pkg = new FS::cust_pkg ( {
3526     'custnum'    => $self->custnum,
3527     'pkgpart'    => $pkgpart,
3528     'quantity'   => $quantity,
3529     'start_date' => $start_date,
3530     'no_auto'    => $no_auto,
3531   } );
3532
3533   $error = $cust_pkg->insert;
3534   if ( $error ) {
3535     $dbh->rollback if $oldAutoCommit;
3536     return $error;
3537   } elsif ( $cust_pkg_ref ) {
3538     ${$cust_pkg_ref} = $cust_pkg;
3539   }
3540
3541   if ( $bill_now ) {
3542     my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3543                              'pkg_list'      => [ $cust_pkg ],
3544                            );
3545     if ( $error ) {
3546       $dbh->rollback if $oldAutoCommit;
3547       return $error;
3548     }
3549   }
3550
3551   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3552   return '';
3553
3554 }
3555
3556 #=item charge_postal_fee
3557 #
3558 #Applies a one time charge this customer.  If there is an error,
3559 #returns the error, returns the cust_pkg charge object or false
3560 #if there was no charge.
3561 #
3562 #=cut
3563 #
3564 # This should be a customer event.  For that to work requires that bill
3565 # also be a customer event.
3566
3567 sub charge_postal_fee {
3568   my $self = shift;
3569
3570   my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3571   return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3572
3573   my $cust_pkg = new FS::cust_pkg ( {
3574     'custnum'  => $self->custnum,
3575     'pkgpart'  => $pkgpart,
3576     'quantity' => 1,
3577   } );
3578
3579   my $error = $cust_pkg->insert;
3580   $error ? $error : $cust_pkg;
3581 }
3582
3583 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3584
3585 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3586
3587 Optionally, a list or hashref of additional arguments to the qsearch call can
3588 be passed.
3589
3590 =cut
3591
3592 sub cust_bill {
3593   my $self = shift;
3594   my $opt = ref($_[0]) ? shift : { @_ };
3595
3596   #return $self->num_cust_bill unless wantarray || keys %$opt;
3597
3598   $opt->{'table'} = 'cust_bill';
3599   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3600   $opt->{'hashref'}{'custnum'} = $self->custnum;
3601   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3602
3603   map { $_ } #behavior of sort undefined in scalar context
3604     sort { $a->_date <=> $b->_date }
3605       qsearch($opt);
3606 }
3607
3608 =item open_cust_bill
3609
3610 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3611 customer.
3612
3613 =cut
3614
3615 sub open_cust_bill {
3616   my $self = shift;
3617
3618   $self->cust_bill(
3619     'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3620     #@_
3621   );
3622
3623 }
3624
3625 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3626
3627 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3628
3629 =cut
3630
3631 sub legacy_cust_bill {
3632   my $self = shift;
3633
3634   #return $self->num_legacy_cust_bill unless wantarray;
3635
3636   map { $_ } #behavior of sort undefined in scalar context
3637     sort { $a->_date <=> $b->_date }
3638       qsearch({ 'table'    => 'legacy_cust_bill',
3639                 'hashref'  => { 'custnum' => $self->custnum, },
3640                 'order_by' => 'ORDER BY _date ASC',
3641              });
3642 }
3643
3644 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3645
3646 Returns all the statements (see L<FS::cust_statement>) for this customer.
3647
3648 Optionally, a list or hashref of additional arguments to the qsearch call can
3649 be passed.
3650
3651 =cut
3652
3653 sub cust_statement {
3654   my $self = shift;
3655   my $opt = ref($_[0]) ? shift : { @_ };
3656
3657   #return $self->num_cust_statement unless wantarray || keys %$opt;
3658
3659   $opt->{'table'} = 'cust_statement';
3660   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3661   $opt->{'hashref'}{'custnum'} = $self->custnum;
3662   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3663
3664   map { $_ } #behavior of sort undefined in scalar context
3665     sort { $a->_date <=> $b->_date }
3666       qsearch($opt);
3667 }
3668
3669 =item svc_x SVCDB [ OPTION => VALUE | EXTRA_QSEARCH_PARAMS_HASHREF ]
3670
3671 Returns all services of type SVCDB (such as 'svc_acct') for this customer.
3672
3673 Optionally, a list or hashref of additional arguments to the qsearch call can
3674 be passed following the SVCDB.
3675
3676 =cut
3677
3678 sub svc_x {
3679   my $self = shift;
3680   my $svcdb = shift;
3681   if ( ! $svcdb =~ /^svc_\w+$/ ) {
3682     warn "$me svc_x requires a svcdb";
3683     return;
3684   }
3685   my $opt = ref($_[0]) ? shift : { @_ };
3686
3687   $opt->{'table'} = $svcdb;
3688   $opt->{'addl_from'} =
3689     'LEFT JOIN cust_svc USING (svcnum) LEFT JOIN cust_pkg USING (pkgnum) '.
3690     ($opt->{'addl_from'} || '');
3691
3692   my $custnum = $self->custnum;
3693   $custnum =~ /^\d+$/ or die "bad custnum '$custnum'";
3694   my $where = "cust_pkg.custnum = $custnum";
3695
3696   my $extra_sql = $opt->{'extra_sql'} || '';
3697   if ( keys %{ $opt->{'hashref'} } ) {
3698     $extra_sql = " AND $where $extra_sql";
3699   }
3700   else {
3701     if ( $opt->{'extra_sql'} =~ /^\s*where\s(.*)/si ) {
3702       $extra_sql = "WHERE $where AND $1";
3703     }
3704     else {
3705       $extra_sql = "WHERE $where $extra_sql";
3706     }
3707   }
3708   $opt->{'extra_sql'} = $extra_sql;
3709
3710   qsearch($opt);
3711 }
3712
3713 # required for use as an eventtable;
3714 sub svc_acct {
3715   my $self = shift;
3716   $self->svc_x('svc_acct', @_);
3717 }
3718
3719 =item cust_credit
3720
3721 Returns all the credits (see L<FS::cust_credit>) for this customer.
3722
3723 =cut
3724
3725 sub cust_credit {
3726   my $self = shift;
3727   map { $_ } #return $self->num_cust_credit unless wantarray;
3728   sort { $a->_date <=> $b->_date }
3729     qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3730 }
3731
3732 =item cust_credit_pkgnum
3733
3734 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3735 package when using experimental package balances.
3736
3737 =cut
3738
3739 sub cust_credit_pkgnum {
3740   my( $self, $pkgnum ) = @_;
3741   map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3742   sort { $a->_date <=> $b->_date }
3743     qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3744                               'pkgnum'  => $pkgnum,
3745                             }
3746     );
3747 }
3748
3749 =item cust_pay
3750
3751 Returns all the payments (see L<FS::cust_pay>) for this customer.
3752
3753 =cut
3754
3755 sub cust_pay {
3756   my $self = shift;
3757   return $self->num_cust_pay unless wantarray;
3758   sort { $a->_date <=> $b->_date }
3759     qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3760 }
3761
3762 =item num_cust_pay
3763
3764 Returns the number of payments (see L<FS::cust_pay>) for this customer.  Also
3765 called automatically when the cust_pay method is used in a scalar context.
3766
3767 =cut
3768
3769 sub num_cust_pay {
3770   my $self = shift;
3771   my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3772   my $sth = dbh->prepare($sql) or die dbh->errstr;
3773   $sth->execute($self->custnum) or die $sth->errstr;
3774   $sth->fetchrow_arrayref->[0];
3775 }
3776
3777 =item cust_pay_pkgnum
3778
3779 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3780 package when using experimental package balances.
3781
3782 =cut
3783
3784 sub cust_pay_pkgnum {
3785   my( $self, $pkgnum ) = @_;
3786   map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3787   sort { $a->_date <=> $b->_date }
3788     qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3789                            'pkgnum'  => $pkgnum,
3790                          }
3791     );
3792 }
3793
3794 =item cust_pay_void
3795
3796 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3797
3798 =cut
3799
3800 sub cust_pay_void {
3801   my $self = shift;
3802   map { $_ } #return $self->num_cust_pay_void unless wantarray;
3803   sort { $a->_date <=> $b->_date }
3804     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3805 }
3806
3807 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3808
3809 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
3810
3811 Optionally, a list or hashref of additional arguments to the qsearch call can
3812 be passed.
3813
3814 =cut
3815
3816 sub cust_pay_batch {
3817   my $self = shift;
3818   my $opt = ref($_[0]) ? shift : { @_ };
3819
3820   #return $self->num_cust_statement unless wantarray || keys %$opt;
3821
3822   $opt->{'table'} = 'cust_pay_batch';
3823   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3824   $opt->{'hashref'}{'custnum'} = $self->custnum;
3825   $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3826
3827   map { $_ } #behavior of sort undefined in scalar context
3828     sort { $a->paybatchnum <=> $b->paybatchnum }
3829       qsearch($opt);
3830 }
3831
3832 =item cust_pay_pending
3833
3834 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3835 (without status "done").
3836
3837 =cut
3838
3839 sub cust_pay_pending {
3840   my $self = shift;
3841   return $self->num_cust_pay_pending unless wantarray;
3842   sort { $a->_date <=> $b->_date }
3843     qsearch( 'cust_pay_pending', {
3844                                    'custnum' => $self->custnum,
3845                                    'status'  => { op=>'!=', value=>'done' },
3846                                  },
3847            );
3848 }
3849
3850 =item cust_pay_pending_attempt
3851
3852 Returns all payment attempts / declined payments for this customer, as pending
3853 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3854 a corresponding payment (see L<FS::cust_pay>).
3855
3856 =cut
3857
3858 sub cust_pay_pending_attempt {
3859   my $self = shift;
3860   return $self->num_cust_pay_pending_attempt unless wantarray;
3861   sort { $a->_date <=> $b->_date }
3862     qsearch( 'cust_pay_pending', {
3863                                    'custnum' => $self->custnum,
3864                                    'status'  => 'done',
3865                                    'paynum'  => '',
3866                                  },
3867            );
3868 }
3869
3870 =item num_cust_pay_pending
3871
3872 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3873 customer (without status "done").  Also called automatically when the
3874 cust_pay_pending method is used in a scalar context.
3875
3876 =cut
3877
3878 sub num_cust_pay_pending {
3879   my $self = shift;
3880   $self->scalar_sql(
3881     " SELECT COUNT(*) FROM cust_pay_pending ".
3882       " WHERE custnum = ? AND status != 'done' ",
3883     $self->custnum
3884   );
3885 }
3886
3887 =item num_cust_pay_pending_attempt
3888
3889 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3890 customer, with status "done" but without a corresp.  Also called automatically when the
3891 cust_pay_pending method is used in a scalar context.
3892
3893 =cut
3894
3895 sub num_cust_pay_pending_attempt {
3896   my $self = shift;
3897   $self->scalar_sql(
3898     " SELECT COUNT(*) FROM cust_pay_pending ".
3899       " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3900     $self->custnum
3901   );
3902 }
3903
3904 =item cust_refund
3905
3906 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3907
3908 =cut
3909
3910 sub cust_refund {
3911   my $self = shift;
3912   map { $_ } #return $self->num_cust_refund unless wantarray;
3913   sort { $a->_date <=> $b->_date }
3914     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3915 }
3916
3917 =item display_custnum
3918
3919 Returns the displayed customer number for this customer: agent_custid if
3920 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3921
3922 =cut
3923
3924 sub display_custnum {
3925   my $self = shift;
3926   if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3927     return $self->agent_custid;
3928   } elsif ( $conf->config('cust_main-custnum-display_prefix') ) {
3929     return $conf->config('cust_main-custnum-display_prefix').
3930            sprintf('%08d', $self->custnum)
3931   } else {
3932     return $self->custnum;
3933   }
3934 }
3935
3936 =item name
3937
3938 Returns a name string for this customer, either "Company (Last, First)" or
3939 "Last, First".
3940
3941 =cut
3942
3943 sub name {
3944   my $self = shift;
3945   my $name = $self->contact;
3946   $name = $self->company. " ($name)" if $self->company;
3947   $name;
3948 }
3949
3950 =item ship_name
3951
3952 Returns a name string for this (service/shipping) contact, either
3953 "Company (Last, First)" or "Last, First".
3954
3955 =cut
3956
3957 sub ship_name {
3958   my $self = shift;
3959   if ( $self->get('ship_last') ) {
3960     my $name = $self->ship_contact;
3961     $name = $self->ship_company. " ($name)" if $self->ship_company;
3962     $name;
3963   } else {
3964     $self->name;
3965   }
3966 }
3967
3968 =item name_short
3969
3970 Returns a name string for this customer, either "Company" or "First Last".
3971
3972 =cut
3973
3974 sub name_short {
3975   my $self = shift;
3976   $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3977 }
3978
3979 =item ship_name_short
3980
3981 Returns a name string for this (service/shipping) contact, either "Company"
3982 or "First Last".
3983
3984 =cut
3985
3986 sub ship_name_short {
3987   my $self = shift;
3988   if ( $self->get('ship_last') ) {
3989     $self->ship_company !~ /^\s*$/
3990       ? $self->ship_company
3991       : $self->ship_contact_firstlast;
3992   } else {
3993     $self->name_company_or_firstlast;
3994   }
3995 }
3996
3997 =item contact
3998
3999 Returns this customer's full (billing) contact name only, "Last, First"
4000
4001 =cut
4002
4003 sub contact {
4004   my $self = shift;
4005   $self->get('last'). ', '. $self->first;
4006 }
4007
4008 =item ship_contact
4009
4010 Returns this customer's full (shipping) contact name only, "Last, First"
4011
4012 =cut
4013
4014 sub ship_contact {
4015   my $self = shift;
4016   $self->get('ship_last')
4017     ? $self->get('ship_last'). ', '. $self->ship_first
4018     : $self->contact;
4019 }
4020
4021 =item contact_firstlast
4022
4023 Returns this customers full (billing) contact name only, "First Last".
4024
4025 =cut
4026
4027 sub contact_firstlast {
4028   my $self = shift;
4029   $self->first. ' '. $self->get('last');
4030 }
4031
4032 =item ship_contact_firstlast
4033
4034 Returns this customer's full (shipping) contact name only, "First Last".
4035
4036 =cut
4037
4038 sub ship_contact_firstlast {
4039   my $self = shift;
4040   $self->get('ship_last')
4041     ? $self->first. ' '. $self->get('ship_last')
4042     : $self->contact_firstlast;
4043 }
4044
4045 =item country_full
4046
4047 Returns this customer's full country name
4048
4049 =cut
4050
4051 sub country_full {
4052   my $self = shift;
4053   code2country($self->country);
4054 }
4055
4056 =item geocode DATA_VENDOR
4057
4058 Returns a value for the customer location as encoded by DATA_VENDOR.
4059 Currently this only makes sense for "CCH" as DATA_VENDOR.
4060
4061 =cut
4062
4063 =item cust_status
4064
4065 =item status
4066
4067 Returns a status string for this customer, currently:
4068
4069 =over 4
4070
4071 =item prospect - No packages have ever been ordered
4072
4073 =item ordered - Recurring packages all are new (not yet billed).
4074
4075 =item active - One or more recurring packages is active
4076
4077 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4078
4079 =item suspended - All non-cancelled recurring packages are suspended
4080
4081 =item cancelled - All recurring packages are cancelled
4082
4083 =back
4084
4085 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4086 cust_main-status_module configuration option.
4087
4088 =cut
4089
4090 sub status { shift->cust_status(@_); }
4091
4092 sub cust_status {
4093   my $self = shift;
4094   for my $status ( FS::cust_main->statuses() ) {
4095     my $method = $status.'_sql';
4096     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4097     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4098     $sth->execute( ($self->custnum) x $numnum )
4099       or die "Error executing 'SELECT $sql': ". $sth->errstr;
4100     return $status if $sth->fetchrow_arrayref->[0];
4101   }
4102 }
4103
4104 =item ucfirst_cust_status
4105
4106 =item ucfirst_status
4107
4108 Returns the status with the first character capitalized.
4109
4110 =cut
4111
4112 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4113
4114 sub ucfirst_cust_status {
4115   my $self = shift;
4116   ucfirst($self->cust_status);
4117 }
4118
4119 =item statuscolor
4120
4121 Returns a hex triplet color string for this customer's status.
4122
4123 =cut
4124
4125 sub statuscolor { shift->cust_statuscolor(@_); }
4126
4127 sub cust_statuscolor {
4128   my $self = shift;
4129   __PACKAGE__->statuscolors->{$self->cust_status};
4130 }
4131
4132 =item tickets
4133
4134 Returns an array of hashes representing the customer's RT tickets.
4135
4136 =cut
4137
4138 sub tickets {
4139   my $self = shift;
4140
4141   my $num = $conf->config('cust_main-max_tickets') || 10;
4142   my @tickets = ();
4143
4144   if ( $conf->config('ticket_system') ) {
4145     unless ( $conf->config('ticket_system-custom_priority_field') ) {
4146
4147       @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4148
4149     } else {
4150
4151       foreach my $priority (
4152         $conf->config('ticket_system-custom_priority_field-values'), ''
4153       ) {
4154         last if scalar(@tickets) >= $num;
4155         push @tickets,
4156           @{ FS::TicketSystem->customer_tickets( $self->custnum,
4157                                                  $num - scalar(@tickets),
4158                                                  $priority,
4159                                                )
4160            };
4161       }
4162     }
4163   }
4164   (@tickets);
4165 }
4166
4167 # Return services representing svc_accts in customer support packages
4168 sub support_services {
4169   my $self = shift;
4170   my %packages = map { $_ => 1 } $conf->config('support_packages');
4171
4172   grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4173     grep { $_->part_svc->svcdb eq 'svc_acct' }
4174     map { $_->cust_svc }
4175     grep { exists $packages{ $_->pkgpart } }
4176     $self->ncancelled_pkgs;
4177
4178 }
4179
4180 # Return a list of latitude/longitude for one of the services (if any)
4181 sub service_coordinates {
4182   my $self = shift;
4183
4184   my @svc_X =
4185     grep { $_->latitude && $_->longitude }
4186     map { $_->svc_x }
4187     map { $_->cust_svc }
4188     $self->ncancelled_pkgs;
4189
4190   scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4191 }
4192
4193 =item masked FIELD
4194
4195 Returns a masked version of the named field
4196
4197 =cut
4198
4199 sub masked {
4200 my ($self,$field) = @_;
4201
4202 # Show last four
4203
4204 'x'x(length($self->getfield($field))-4).
4205   substr($self->getfield($field), (length($self->getfield($field))-4));
4206
4207 }
4208
4209 =back
4210
4211 =head1 CLASS METHODS
4212
4213 =over 4
4214
4215 =item statuses
4216
4217 Class method that returns the list of possible status strings for customers
4218 (see L<the status method|/status>).  For example:
4219
4220   @statuses = FS::cust_main->statuses();
4221
4222 =cut
4223
4224 sub statuses {
4225   my $self = shift;
4226   keys %{ $self->statuscolors };
4227 }
4228
4229 =item cust_status_sql
4230
4231 Returns an SQL fragment to determine the status of a cust_main record, as a
4232 string.
4233
4234 =cut
4235
4236 sub cust_status_sql {
4237   my $sql = 'CASE';
4238   for my $status ( FS::cust_main->statuses() ) {
4239     my $method = $status.'_sql';
4240     $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4241   }
4242   $sql .= ' END';
4243   return $sql;
4244 }
4245
4246
4247 =item prospect_sql
4248
4249 Returns an SQL expression identifying prospective cust_main records (customers
4250 with no packages ever ordered)
4251
4252 =cut
4253
4254 use vars qw($select_count_pkgs);
4255 $select_count_pkgs =
4256   "SELECT COUNT(*) FROM cust_pkg
4257     WHERE cust_pkg.custnum = cust_main.custnum";
4258
4259 sub select_count_pkgs_sql {
4260   $select_count_pkgs;
4261 }
4262
4263 sub prospect_sql {
4264   " 0 = ( $select_count_pkgs ) ";
4265 }
4266
4267 =item ordered_sql
4268
4269 Returns an SQL expression identifying ordered cust_main records (customers with
4270 no active packages, but recurring packages not yet setup or one time charges
4271 not yet billed).
4272
4273 =cut
4274
4275 sub ordered_sql {
4276   FS::cust_main->none_active_sql.
4277   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4278 }
4279
4280 =item active_sql
4281
4282 Returns an SQL expression identifying active cust_main records (customers with
4283 active recurring packages).
4284
4285 =cut
4286
4287 sub active_sql {
4288   " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4289 }
4290
4291 =item none_active_sql
4292
4293 Returns an SQL expression identifying cust_main records with no active
4294 recurring packages.  This includes customers of status prospect, ordered,
4295 inactive, and suspended.
4296
4297 =cut
4298
4299 sub none_active_sql {
4300   " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4301 }
4302
4303 =item inactive_sql
4304
4305 Returns an SQL expression identifying inactive cust_main records (customers with
4306 no active recurring packages, but otherwise unsuspended/uncancelled).
4307
4308 =cut
4309
4310 sub inactive_sql {
4311   FS::cust_main->none_active_sql.
4312   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4313 }
4314
4315 =item susp_sql
4316 =item suspended_sql
4317
4318 Returns an SQL expression identifying suspended cust_main records.
4319
4320 =cut
4321
4322
4323 sub suspended_sql { susp_sql(@_); }
4324 sub susp_sql {
4325   FS::cust_main->none_active_sql.
4326   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4327 }
4328
4329 =item cancel_sql
4330 =item cancelled_sql
4331
4332 Returns an SQL expression identifying cancelled cust_main records.
4333
4334 =cut
4335
4336 sub cancel_sql { shift->cancelled_sql(@_); }
4337
4338 =item uncancel_sql
4339 =item uncancelled_sql
4340
4341 Returns an SQL expression identifying un-cancelled cust_main records.
4342
4343 =cut
4344
4345 sub uncancelled_sql { uncancel_sql(@_); }
4346 sub uncancel_sql { "
4347   ( 0 < ( $select_count_pkgs
4348                    AND ( cust_pkg.cancel IS NULL
4349                          OR cust_pkg.cancel = 0
4350                        )
4351         )
4352     OR 0 = ( $select_count_pkgs )
4353   )
4354 "; }
4355
4356 =item balance_sql
4357
4358 Returns an SQL fragment to retreive the balance.
4359
4360 =cut
4361
4362 sub balance_sql { "
4363     ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4364         WHERE cust_bill.custnum   = cust_main.custnum     )
4365   - ( SELECT COALESCE( SUM(paid),    0 ) FROM cust_pay
4366         WHERE cust_pay.custnum    = cust_main.custnum     )
4367   - ( SELECT COALESCE( SUM(amount),  0 ) FROM cust_credit
4368         WHERE cust_credit.custnum = cust_main.custnum     )
4369   + ( SELECT COALESCE( SUM(refund),  0 ) FROM cust_refund
4370         WHERE cust_refund.custnum = cust_main.custnum     )
4371 "; }
4372
4373 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4374
4375 Returns an SQL fragment to retreive the balance for this customer, optionally
4376 considering invoices with date earlier than START_TIME, and not
4377 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4378 total_unapplied_payments).
4379
4380 Times are specified as SQL fragments or numeric
4381 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
4382 L<Date::Parse> for conversion functions.  The empty string can be passed
4383 to disable that time constraint completely.
4384
4385 Available options are:
4386
4387 =over 4
4388
4389 =item unapplied_date
4390
4391 set to true to disregard unapplied credits, payments and refunds outside the specified time period - by default the time period restriction only applies to invoices (useful for reporting, probably a bad idea for event triggering)
4392
4393 =item total
4394
4395 (unused.  obsolete?)
4396 set to true to remove all customer comparison clauses, for totals
4397
4398 =item where
4399
4400 (unused.  obsolete?)
4401 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4402
4403 =item join
4404
4405 (unused.  obsolete?)
4406 JOIN clause (typically used with the total option)
4407
4408 =item cutoff
4409
4410 An absolute cutoff time.  Payments, credits, and refunds I<applied> after this
4411 time will be ignored.  Note that START_TIME and END_TIME only limit the date
4412 range for invoices and I<unapplied> payments, credits, and refunds.
4413
4414 =back
4415
4416 =cut
4417
4418 sub balance_date_sql {
4419   my( $class, $start, $end, %opt ) = @_;
4420
4421   my $cutoff = $opt{'cutoff'};
4422
4423   my $owed         = FS::cust_bill->owed_sql($cutoff);
4424   my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4425   my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4426   my $unapp_pay    = FS::cust_pay->unapplied_sql($cutoff);
4427
4428   my $j = $opt{'join'} || '';
4429
4430   my $owed_wh   = $class->_money_table_where( 'cust_bill',   $start,$end,%opt );
4431   my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4432   my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4433   my $pay_wh    = $class->_money_table_where( 'cust_pay',    $start,$end,%opt );
4434
4435   "   ( SELECT COALESCE(SUM($owed),         0) FROM cust_bill   $j $owed_wh   )
4436     + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4437     - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4438     - ( SELECT COALESCE(SUM($unapp_pay),    0) FROM cust_pay    $j $pay_wh    )
4439   ";
4440
4441 }
4442
4443 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4444
4445 Returns an SQL fragment to retreive the total unapplied payments for this
4446 customer, only considering payments with date earlier than START_TIME, and
4447 optionally not later than END_TIME.
4448
4449 Times are specified as SQL fragments or numeric
4450 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
4451 L<Date::Parse> for conversion functions.  The empty string can be passed
4452 to disable that time constraint completely.
4453
4454 Available options are:
4455
4456 =cut
4457
4458 sub unapplied_payments_date_sql {
4459   my( $class, $start, $end, %opt ) = @_;
4460
4461   my $cutoff = $opt{'cutoff'};
4462
4463   my $unapp_pay    = FS::cust_pay->unapplied_sql($cutoff);
4464
4465   my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4466                                                           'unapplied_date'=>1 );
4467
4468   " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4469 }
4470
4471 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4472
4473 Helper method for balance_date_sql; name (and usage) subject to change
4474 (suggestions welcome).
4475
4476 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4477 cust_refund, cust_credit or cust_pay).
4478
4479 If TABLE is "cust_bill" or the unapplied_date option is true, only
4480 considers records with date earlier than START_TIME, and optionally not
4481 later than END_TIME .
4482
4483 =cut
4484
4485 sub _money_table_where {
4486   my( $class, $table, $start, $end, %opt ) = @_;
4487
4488   my @where = ();
4489   push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4490   if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4491     push @where, "$table._date <= $start" if defined($start) && length($start);
4492     push @where, "$table._date >  $end"   if defined($end)   && length($end);
4493   }
4494   push @where, @{$opt{'where'}} if $opt{'where'};
4495   my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4496
4497   $where;
4498
4499 }
4500
4501 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4502 use FS::cust_main::Search;
4503 sub search {
4504   my $class = shift;
4505   FS::cust_main::Search->search(@_);
4506 }
4507
4508 =back
4509
4510 =head1 SUBROUTINES
4511
4512 =over 4
4513
4514 =item batch_charge
4515
4516 =cut
4517
4518 sub batch_charge {
4519   my $param = shift;
4520   #warn join('-',keys %$param);
4521   my $fh = $param->{filehandle};
4522   my $agentnum = $param->{agentnum};
4523   my $format = $param->{format};
4524
4525   my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4526
4527   my @fields;
4528   if ( $format eq 'simple' ) {
4529     @fields = qw( custnum agent_custid amount pkg );
4530   } else {
4531     die "unknown format $format";
4532   }
4533
4534   eval "use Text::CSV_XS;";
4535   die $@ if $@;
4536
4537   my $csv = new Text::CSV_XS;
4538   #warn $csv;
4539   #warn $fh;
4540
4541   my $imported = 0;
4542   #my $columns;
4543
4544   local $SIG{HUP} = 'IGNORE';
4545   local $SIG{INT} = 'IGNORE';
4546   local $SIG{QUIT} = 'IGNORE';
4547   local $SIG{TERM} = 'IGNORE';
4548   local $SIG{TSTP} = 'IGNORE';
4549   local $SIG{PIPE} = 'IGNORE';
4550
4551   my $oldAutoCommit = $FS::UID::AutoCommit;
4552   local $FS::UID::AutoCommit = 0;
4553   my $dbh = dbh;
4554
4555   #while ( $columns = $csv->getline($fh) ) {
4556   my $line;
4557   while ( defined($line=<$fh>) ) {
4558
4559     $csv->parse($line) or do {
4560       $dbh->rollback if $oldAutoCommit;
4561       return "can't parse: ". $csv->error_input();
4562     };
4563
4564     my @columns = $csv->fields();
4565     #warn join('-',@columns);
4566
4567     my %row = ();
4568     foreach my $field ( @fields ) {
4569       $row{$field} = shift @columns;
4570     }
4571
4572     if ( $row{custnum} && $row{agent_custid} ) {
4573       dbh->rollback if $oldAutoCommit;
4574       return "can't specify custnum with agent_custid $row{agent_custid}";
4575     }
4576
4577     my %hash = ();
4578     if ( $row{agent_custid} && $agentnum ) {
4579       %hash = ( 'agent_custid' => $row{agent_custid},
4580                 'agentnum'     => $agentnum,
4581               );
4582     }
4583
4584     if ( $row{custnum} ) {
4585       %hash = ( 'custnum' => $row{custnum} );
4586     }
4587
4588     unless ( scalar(keys %hash) ) {
4589       $dbh->rollback if $oldAutoCommit;
4590       return "can't find customer without custnum or agent_custid and agentnum";
4591     }
4592
4593     my $cust_main = qsearchs('cust_main', { %hash } );
4594     unless ( $cust_main ) {
4595       $dbh->rollback if $oldAutoCommit;
4596       my $custnum = $row{custnum} || $row{agent_custid};
4597       return "unknown custnum $custnum";
4598     }
4599
4600     if ( $row{'amount'} > 0 ) {
4601       my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4602       if ( $error ) {
4603         $dbh->rollback if $oldAutoCommit;
4604         return $error;
4605       }
4606       $imported++;
4607     } elsif ( $row{'amount'} < 0 ) {
4608       my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4609                                       $row{'pkg'}                         );
4610       if ( $error ) {
4611         $dbh->rollback if $oldAutoCommit;
4612         return $error;
4613       }
4614       $imported++;
4615     } else {
4616       #hmm?
4617     }
4618
4619   }
4620
4621   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4622
4623   return "Empty file!" unless $imported;
4624
4625   ''; #no error
4626
4627 }
4628
4629 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4630
4631 Deprecated.  Use event notification and message templates
4632 (L<FS::msg_template>) instead.
4633
4634 Sends a templated email notification to the customer (see L<Text::Template>).
4635
4636 OPTIONS is a hash and may include
4637
4638 I<from> - the email sender (default is invoice_from)
4639
4640 I<to> - comma-separated scalar or arrayref of recipients
4641    (default is invoicing_list)
4642
4643 I<subject> - The subject line of the sent email notification
4644    (default is "Notice from company_name")
4645
4646 I<extra_fields> - a hashref of name/value pairs which will be substituted
4647    into the template
4648
4649 The following variables are vavailable in the template.
4650
4651 I<$first> - the customer first name
4652 I<$last> - the customer last name
4653 I<$company> - the customer company
4654 I<$payby> - a description of the method of payment for the customer
4655             # would be nice to use FS::payby::shortname
4656 I<$payinfo> - the account information used to collect for this customer
4657 I<$expdate> - the expiration of the customer payment in seconds from epoch
4658
4659 =cut
4660
4661 sub notify {
4662   my ($self, $template, %options) = @_;
4663
4664   return unless $conf->exists($template);
4665
4666   my $from = $conf->config('invoice_from', $self->agentnum)
4667     if $conf->exists('invoice_from', $self->agentnum);
4668   $from = $options{from} if exists($options{from});
4669
4670   my $to = join(',', $self->invoicing_list_emailonly);
4671   $to = $options{to} if exists($options{to});
4672
4673   my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4674     if $conf->exists('company_name', $self->agentnum);
4675   $subject = $options{subject} if exists($options{subject});
4676
4677   my $notify_template = new Text::Template (TYPE => 'ARRAY',
4678                                             SOURCE => [ map "$_\n",
4679                                               $conf->config($template)]
4680                                            )
4681     or die "can't create new Text::Template object: Text::Template::ERROR";
4682   $notify_template->compile()
4683     or die "can't compile template: Text::Template::ERROR";
4684
4685   $FS::notify_template::_template::company_name =
4686     $conf->config('company_name', $self->agentnum);
4687   $FS::notify_template::_template::company_address =
4688     join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4689
4690   my $paydate = $self->paydate || '2037-12-31';
4691   $FS::notify_template::_template::first = $self->first;
4692   $FS::notify_template::_template::last = $self->last;
4693   $FS::notify_template::_template::company = $self->company;
4694   $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4695   my $payby = $self->payby;
4696   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4697   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4698
4699   #credit cards expire at the end of the month/year of their exp date
4700   if ($payby eq 'CARD' || $payby eq 'DCRD') {
4701     $FS::notify_template::_template::payby = 'credit card';
4702     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4703     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4704     $expire_time--;
4705   }elsif ($payby eq 'COMP') {
4706     $FS::notify_template::_template::payby = 'complimentary account';
4707   }else{
4708     $FS::notify_template::_template::payby = 'current method';
4709   }
4710   $FS::notify_template::_template::expdate = $expire_time;
4711
4712   for (keys %{$options{extra_fields}}){
4713     no strict "refs";
4714     ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4715   }
4716
4717   send_email(from => $from,
4718              to => $to,
4719              subject => $subject,
4720              body => $notify_template->fill_in( PACKAGE =>
4721                                                 'FS::notify_template::_template'                                              ),
4722             );
4723
4724 }
4725
4726 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4727
4728 Generates a templated notification to the customer (see L<Text::Template>).
4729
4730 OPTIONS is a hash and may include
4731
4732 I<extra_fields> - a hashref of name/value pairs which will be substituted
4733    into the template.  These values may override values mentioned below
4734    and those from the customer record.
4735
4736 The following variables are available in the template instead of or in addition
4737 to the fields of the customer record.
4738
4739 I<$payby> - a description of the method of payment for the customer
4740             # would be nice to use FS::payby::shortname
4741 I<$payinfo> - the masked account information used to collect for this customer
4742 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4743 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4744
4745 =cut
4746
4747 # a lot like cust_bill::print_latex
4748 sub generate_letter {
4749   my ($self, $template, %options) = @_;
4750
4751   return unless $conf->exists($template);
4752
4753   my $letter_template = new Text::Template
4754                         ( TYPE       => 'ARRAY',
4755                           SOURCE     => [ map "$_\n", $conf->config($template)],
4756                           DELIMITERS => [ '[@--', '--@]' ],
4757                         )
4758     or die "can't create new Text::Template object: Text::Template::ERROR";
4759
4760   $letter_template->compile()
4761     or die "can't compile template: Text::Template::ERROR";
4762
4763   my %letter_data = map { $_ => $self->$_ } $self->fields;
4764   $letter_data{payinfo} = $self->mask_payinfo;
4765
4766   #my $paydate = $self->paydate || '2037-12-31';
4767   my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4768
4769   my $payby = $self->payby;
4770   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4771   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4772
4773   #credit cards expire at the end of the month/year of their exp date
4774   if ($payby eq 'CARD' || $payby eq 'DCRD') {
4775     $letter_data{payby} = 'credit card';
4776     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4777     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4778     $expire_time--;
4779   }elsif ($payby eq 'COMP') {
4780     $letter_data{payby} = 'complimentary account';
4781   }else{
4782     $letter_data{payby} = 'current method';
4783   }
4784   $letter_data{expdate} = $expire_time;
4785
4786   for (keys %{$options{extra_fields}}){
4787     $letter_data{$_} = $options{extra_fields}->{$_};
4788   }
4789
4790   unless(exists($letter_data{returnaddress})){
4791     my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4792                                                   $self->agent_template)
4793                      );
4794     if ( length($retadd) ) {
4795       $letter_data{returnaddress} = $retadd;
4796     } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4797       $letter_data{returnaddress} =
4798         join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4799                           s/$/\\\\\*/;
4800                           $_;
4801                         }
4802                     ( $conf->config('company_name', $self->agentnum),
4803                       $conf->config('company_address', $self->agentnum),
4804                     )
4805         );
4806     } else {
4807       $letter_data{returnaddress} = '~';
4808     }
4809   }
4810
4811   $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4812
4813   $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4814
4815   my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4816
4817   my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4818                            DIR      => $dir,
4819                            SUFFIX   => '.eps',
4820                            UNLINK   => 0,
4821                          ) or die "can't open temp file: $!\n";
4822   print $lh $conf->config_binary('logo.eps', $self->agentnum)
4823     or die "can't write temp file: $!\n";
4824   close $lh;
4825   $letter_data{'logo_file'} = $lh->filename;
4826
4827   my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4828                            DIR      => $dir,
4829                            SUFFIX   => '.tex',
4830                            UNLINK   => 0,
4831                          ) or die "can't open temp file: $!\n";
4832
4833   $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4834   close $fh;
4835   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4836   return ($1, $letter_data{'logo_file'});
4837
4838 }
4839
4840 =item print_ps TEMPLATE
4841
4842 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4843
4844 =cut
4845
4846 sub print_ps {
4847   my $self = shift;
4848   my($file, $lfile) = $self->generate_letter(@_);
4849   my $ps = FS::Misc::generate_ps($file);
4850   unlink($file.'.tex');
4851   unlink($lfile);
4852
4853   $ps;
4854 }
4855
4856 =item print TEMPLATE
4857
4858 Prints the filled in template.
4859
4860 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4861
4862 =cut
4863
4864 sub queueable_print {
4865   my %opt = @_;
4866
4867   my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4868     or die "invalid customer number: " . $opt{custvnum};
4869
4870   my $error = $self->print( $opt{template} );
4871   die $error if $error;
4872 }
4873
4874 sub print {
4875   my ($self, $template) = (shift, shift);
4876   do_print [ $self->print_ps($template) ];
4877 }
4878
4879 #these three subs should just go away once agent stuff is all config overrides
4880
4881 sub agent_template {
4882   my $self = shift;
4883   $self->_agent_plandata('agent_templatename');
4884 }
4885
4886 sub agent_invoice_from {
4887   my $self = shift;
4888   $self->_agent_plandata('agent_invoice_from');
4889 }
4890
4891 sub _agent_plandata {
4892   my( $self, $option ) = @_;
4893
4894   #yuck.  this whole thing needs to be reconciled better with 1.9's idea of
4895   #agent-specific Conf
4896
4897   use FS::part_event::Condition;
4898
4899   my $agentnum = $self->agentnum;
4900
4901   my $regexp = regexp_sql();
4902
4903   my $part_event_option =
4904     qsearchs({
4905       'select'    => 'part_event_option.*',
4906       'table'     => 'part_event_option',
4907       'addl_from' => q{
4908         LEFT JOIN part_event USING ( eventpart )
4909         LEFT JOIN part_event_option AS peo_agentnum
4910           ON ( part_event.eventpart = peo_agentnum.eventpart
4911                AND peo_agentnum.optionname = 'agentnum'
4912                AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4913              )
4914         LEFT JOIN part_event_condition
4915           ON ( part_event.eventpart = part_event_condition.eventpart
4916                AND part_event_condition.conditionname = 'cust_bill_age'
4917              )
4918         LEFT JOIN part_event_condition_option
4919           ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4920                AND part_event_condition_option.optionname = 'age'
4921              )
4922       },
4923       #'hashref'   => { 'optionname' => $option },
4924       #'hashref'   => { 'part_event_option.optionname' => $option },
4925       'extra_sql' =>
4926         " WHERE part_event_option.optionname = ". dbh->quote($option).
4927         " AND action = 'cust_bill_send_agent' ".
4928         " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4929         " AND peo_agentnum.optionname = 'agentnum' ".
4930         " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4931         " ORDER BY
4932            CASE WHEN part_event_condition_option.optionname IS NULL
4933            THEN -1
4934            ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4935         " END
4936           , part_event.weight".
4937         " LIMIT 1"
4938     });
4939
4940   unless ( $part_event_option ) {
4941     return $self->agent->invoice_template || ''
4942       if $option eq 'agent_templatename';
4943     return '';
4944   }
4945
4946   $part_event_option->optionvalue;
4947
4948 }
4949
4950 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4951
4952 Subroutine (not a method), designed to be called from the queue.
4953
4954 Takes a list of options and values.
4955
4956 Pulls up the customer record via the custnum option and calls bill_and_collect.
4957
4958 =cut
4959
4960 sub queued_bill {
4961   my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
4962
4963   my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
4964   warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
4965
4966   $cust_main->bill_and_collect( %args );
4967 }
4968
4969 sub process_bill_and_collect {
4970   my $job = shift;
4971   my $param = thaw(decode_base64(shift));
4972   my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
4973       or die "custnum '$param->{custnum}' not found!\n";
4974   $param->{'job'}   = $job;
4975   $param->{'fatal'} = 1; # runs from job queue, will be caught
4976   $param->{'retry'} = 1;
4977
4978   $cust_main->bill_and_collect( %$param );
4979 }
4980
4981 =item process_censustract_update CUSTNUM
4982
4983 Queueable function to update the census tract to the current year (as set in
4984 the 'census_year' configuration variable) and retrieve the new tract code.
4985
4986 =cut
4987
4988 sub process_censustract_update {
4989   eval "use FS::Misc::Geo qw(get_censustract)";
4990   die $@ if $@;
4991   my $custnum = shift;
4992   my $cust_main = qsearchs( 'cust_main', { custnum => $custnum })
4993       or die "custnum '$custnum' not found!\n";
4994
4995   my $new_year = $conf->config('census_year') or return;
4996   my $new_tract = get_censustract({ $cust_main->location_hash }, $new_year);
4997   if ( $new_tract =~ /^\d/ ) {
4998     # then it's a tract code
4999         $cust_main->set('censustract', $new_tract);
5000     $cust_main->set('censusyear',  $new_year);
5001     my $error = $cust_main->replace;
5002     die $error if $error;
5003   }
5004   else {
5005     # it's an error message
5006     die $new_tract;
5007   }
5008   return;
5009 }
5010
5011 sub _upgrade_data { #class method
5012   my ($class, %opts) = @_;
5013
5014   my @statements = (
5015     'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
5016     'UPDATE cust_main SET signupdate = (SELECT signupdate FROM h_cust_main WHERE signupdate IS NOT NULL AND h_cust_main.custnum = cust_main.custnum ORDER BY historynum DESC LIMIT 1) WHERE signupdate IS NULL',
5017   );
5018   # fix yyyy-m-dd formatted paydates
5019   if ( driver_name =~ /^mysql$/i ) {
5020     push @statements,
5021     "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5022   }
5023   else { # the SQL standard
5024     push @statements,
5025     "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
5026   }
5027
5028   foreach my $sql ( @statements ) {
5029     my $sth = dbh->prepare($sql) or die dbh->errstr;
5030     $sth->execute or die $sth->errstr;
5031   }
5032
5033   local($ignore_expired_card) = 1;
5034   local($ignore_illegal_zip) = 1;
5035   local($ignore_banned_card) = 1;
5036   local($skip_fuzzyfiles) = 1;
5037   $class->_upgrade_otaker(%opts);
5038
5039 }
5040
5041 =back
5042
5043 =head1 BUGS
5044
5045 The delete method.
5046
5047 The delete method should possibly take an FS::cust_main object reference
5048 instead of a scalar customer number.
5049
5050 Bill and collect options should probably be passed as references instead of a
5051 list.
5052
5053 There should probably be a configuration file with a list of allowed credit
5054 card types.
5055
5056 No multiple currency support (probably a larger project than just this module).
5057
5058 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5059
5060 Birthdates rely on negative epoch values.
5061
5062 The payby for card/check batches is broken.  With mixed batching, bad
5063 things will happen.
5064
5065 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5066
5067 =head1 SEE ALSO
5068
5069 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5070 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5071 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
5072
5073 =cut
5074
5075 1;
5076