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   unless ( $import ) {
1503     $self->set_coord
1504       if ! $self->coord_auto && ! $self->latitude && ! $self->longitude;
1505
1506     $self->set_coord('ship_')
1507       if $self->has_ship_address && ! $self->ship_coord_auto
1508       && ! $self->ship_latitude && ! $self->ship_longitude;
1509   }
1510
1511   local($ignore_expired_card) = 1
1512     if $old->payby  =~ /^(CARD|DCRD)$/
1513     && $self->payby =~ /^(CARD|DCRD)$/
1514     && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1515
1516   local($ignore_banned_card) = 1
1517     if (    $old->payby  =~ /^(CARD|DCRD)$/ && $self->payby =~ /^(CARD|DCRD)$/
1518          || $old->payby  =~ /^(CHEK|DCHK)$/ && $self->payby =~ /^(CHEK|DCHK)$/ )
1519     && ( $old->payinfo eq $self->payinfo || $old->paymask eq $self->paymask );
1520
1521   if ( $self->censustract ne '' and $self->censustract ne $old->censustract ) {
1522     # update censusyear whenever tract code changes
1523     $self->censusyear($conf->config('census_year'));
1524   }
1525
1526
1527   local $SIG{HUP} = 'IGNORE';
1528   local $SIG{INT} = 'IGNORE';
1529   local $SIG{QUIT} = 'IGNORE';
1530   local $SIG{TERM} = 'IGNORE';
1531   local $SIG{TSTP} = 'IGNORE';
1532   local $SIG{PIPE} = 'IGNORE';
1533
1534   my $oldAutoCommit = $FS::UID::AutoCommit;
1535   local $FS::UID::AutoCommit = 0;
1536   my $dbh = dbh;
1537
1538   my $error = $self->SUPER::replace($old);
1539
1540   if ( $error ) {
1541     $dbh->rollback if $oldAutoCommit;
1542     return $error;
1543   }
1544
1545   if ( @param && ref($param[0]) eq 'ARRAY' ) { # INVOICING_LIST_ARYREF
1546     my $invoicing_list = shift @param;
1547     $error = $self->check_invoicing_list( $invoicing_list );
1548     if ( $error ) {
1549       $dbh->rollback if $oldAutoCommit;
1550       return $error;
1551     }
1552     $self->invoicing_list( $invoicing_list );
1553   }
1554
1555   if ( $self->exists('tagnum') ) { #so we don't delete these on edit by accident
1556
1557     #this could be more efficient than deleting and re-inserting, if it matters
1558     foreach my $cust_tag (qsearch('cust_tag', {'custnum'=>$self->custnum} )) {
1559       my $error = $cust_tag->delete;
1560       if ( $error ) {
1561         $dbh->rollback if $oldAutoCommit;
1562         return $error;
1563       }
1564     }
1565     foreach my $tagnum ( @{ $self->tagnum || [] } ) {
1566       my $cust_tag = new FS::cust_tag { 'tagnum'  => $tagnum,
1567                                         'custnum' => $self->custnum };
1568       my $error = $cust_tag->insert;
1569       if ( $error ) {
1570         $dbh->rollback if $oldAutoCommit;
1571         return $error;
1572       }
1573     }
1574
1575   }
1576
1577   my %options = @param;
1578
1579   my $tax_exemption = delete $options{'tax_exemption'};
1580   if ( $tax_exemption ) {
1581
1582     my %cust_main_exemption =
1583       map { $_->taxname => $_ }
1584           qsearch('cust_main_exemption', { 'custnum' => $old->custnum } );
1585
1586     foreach my $taxname ( @$tax_exemption ) {
1587
1588       next if delete $cust_main_exemption{$taxname};
1589
1590       my $cust_main_exemption = new FS::cust_main_exemption {
1591         'custnum' => $self->custnum,
1592         'taxname' => $taxname,
1593       };
1594       my $error = $cust_main_exemption->insert;
1595       if ( $error ) {
1596         $dbh->rollback if $oldAutoCommit;
1597         return "inserting cust_main_exemption (transaction rolled back): $error";
1598       }
1599     }
1600
1601     foreach my $cust_main_exemption ( values %cust_main_exemption ) {
1602       my $error = $cust_main_exemption->delete;
1603       if ( $error ) {
1604         $dbh->rollback if $oldAutoCommit;
1605         return "deleting cust_main_exemption (transaction rolled back): $error";
1606       }
1607     }
1608
1609   }
1610
1611   if ( $self->payby =~ /^(CARD|CHEK|LECB)$/
1612        && ( ( $self->get('payinfo') ne $old->get('payinfo')
1613               && $self->get('payinfo') !~ /^99\d{14}$/
1614             )
1615             || grep { $self->get($_) ne $old->get($_) } qw(paydate payname)
1616           )
1617      )
1618   {
1619
1620     # card/check/lec info has changed, want to retry realtime_ invoice events
1621     my $error = $self->retry_realtime;
1622     if ( $error ) {
1623       $dbh->rollback if $oldAutoCommit;
1624       return $error;
1625     }
1626   }
1627
1628   unless ( $import || $skip_fuzzyfiles ) {
1629     $error = $self->queue_fuzzyfiles_update;
1630     if ( $error ) {
1631       $dbh->rollback if $oldAutoCommit;
1632       return "updating fuzzy search cache: $error";
1633     }
1634   }
1635
1636   # cust_main exports!
1637
1638   my $export_args = $options{'export_args'} || [];
1639
1640   my @part_export =
1641     map qsearch( 'part_export', {exportnum=>$_} ),
1642       $conf->config('cust_main-exports'); #, $agentnum
1643
1644   foreach my $part_export ( @part_export ) {
1645     my $error = $part_export->export_replace( $self, $old, @$export_args);
1646     if ( $error ) {
1647       $dbh->rollback if $oldAutoCommit;
1648       return "exporting to ". $part_export->exporttype.
1649              " (transaction rolled back): $error";
1650     }
1651   }
1652
1653   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1654   '';
1655
1656 }
1657
1658 =item queue_fuzzyfiles_update
1659
1660 Used by insert & replace to update the fuzzy search cache
1661
1662 =cut
1663
1664 use FS::cust_main::Search;
1665 sub queue_fuzzyfiles_update {
1666   my $self = shift;
1667
1668   local $SIG{HUP} = 'IGNORE';
1669   local $SIG{INT} = 'IGNORE';
1670   local $SIG{QUIT} = 'IGNORE';
1671   local $SIG{TERM} = 'IGNORE';
1672   local $SIG{TSTP} = 'IGNORE';
1673   local $SIG{PIPE} = 'IGNORE';
1674
1675   my $oldAutoCommit = $FS::UID::AutoCommit;
1676   local $FS::UID::AutoCommit = 0;
1677   my $dbh = dbh;
1678
1679   my $queue = new FS::queue { 'job' => 'FS::cust_main::Search::append_fuzzyfiles' };
1680   my $error = $queue->insert( map $self->getfield($_), @FS::cust_main::Search::fuzzyfields );
1681   if ( $error ) {
1682     $dbh->rollback if $oldAutoCommit;
1683     return "queueing job (transaction rolled back): $error";
1684   }
1685
1686   if ( $self->ship_last ) {
1687     $queue = new FS::queue { 'job' => 'FS::cust_main::Search::append_fuzzyfiles' };
1688     $error = $queue->insert( map $self->getfield("ship_$_"), @FS::cust_main::Search::fuzzyfields );
1689     if ( $error ) {
1690       $dbh->rollback if $oldAutoCommit;
1691       return "queueing job (transaction rolled back): $error";
1692     }
1693   }
1694
1695   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
1696   '';
1697
1698 }
1699
1700 =item check
1701
1702 Checks all fields to make sure this is a valid customer record.  If there is
1703 an error, returns the error, otherwise returns false.  Called by the insert
1704 and replace methods.
1705
1706 =cut
1707
1708 sub check {
1709   my $self = shift;
1710
1711   warn "$me check BEFORE: \n". $self->_dump
1712     if $DEBUG > 2;
1713
1714   my $error =
1715     $self->ut_numbern('custnum')
1716     || $self->ut_number('agentnum')
1717     || $self->ut_textn('agent_custid')
1718     || $self->ut_number('refnum')
1719     || $self->ut_foreign_keyn('classnum', 'cust_class', 'classnum')
1720     || $self->ut_textn('custbatch')
1721     || $self->ut_name('last')
1722     || $self->ut_name('first')
1723     || $self->ut_snumbern('birthdate')
1724     || $self->ut_snumbern('signupdate')
1725     || $self->ut_textn('company')
1726     || $self->ut_text('address1')
1727     || $self->ut_textn('address2')
1728     || $self->ut_text('city')
1729     || $self->ut_textn('county')
1730     || $self->ut_textn('state')
1731     || $self->ut_country('country')
1732     || $self->ut_coordn('latitude')
1733     || $self->ut_coordn('longitude')
1734     || $self->ut_enum('coord_auto', [ '', 'Y' ])
1735     || $self->ut_numbern('censusyear')
1736     || $self->ut_anything('comments')
1737     || $self->ut_numbern('referral_custnum')
1738     || $self->ut_textn('stateid')
1739     || $self->ut_textn('stateid_state')
1740     || $self->ut_textn('invoice_terms')
1741     || $self->ut_alphan('geocode')
1742     || $self->ut_floatn('cdr_termination_percentage')
1743     || $self->ut_floatn('credit_limit')
1744     || $self->ut_numbern('billday')
1745     || $self->ut_enum('edit_subject', [ '', 'Y' ] )
1746     || $self->ut_enum('calling_list_exempt', [ '', 'Y' ] )
1747     || $self->ut_enum('locale', [ '', FS::Locales->locales ])
1748   ;
1749
1750   $self->set_coord
1751     unless $import || ($self->latitude && $self->longitude);
1752
1753   #barf.  need message catalogs.  i18n.  etc.
1754   $error .= "Please select an advertising source."
1755     if $error =~ /^Illegal or empty \(numeric\) refnum: /;
1756   return $error if $error;
1757
1758   return "Unknown agent"
1759     unless qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
1760
1761   return "Unknown refnum"
1762     unless qsearchs( 'part_referral', { 'refnum' => $self->refnum } );
1763
1764   return "Unknown referring custnum: ". $self->referral_custnum
1765     unless ! $self->referral_custnum
1766            || qsearchs( 'cust_main', { 'custnum' => $self->referral_custnum } );
1767
1768   if ( $self->censustract ne '' ) {
1769     $self->censustract =~ /^\s*(\d{9})\.?(\d{2})\s*$/
1770       or return "Illegal census tract: ". $self->censustract;
1771
1772     $self->censustract("$1.$2");
1773   }
1774
1775   if ( $self->ss eq '' ) {
1776     $self->ss('');
1777   } else {
1778     my $ss = $self->ss;
1779     $ss =~ s/\D//g;
1780     $ss =~ /^(\d{3})(\d{2})(\d{4})$/
1781       or return "Illegal social security number: ". $self->ss;
1782     $self->ss("$1-$2-$3");
1783   }
1784
1785
1786 # bad idea to disable, causes billing to fail because of no tax rates later
1787 # except we don't fail any more
1788   unless ( $import ) {
1789     unless ( qsearch('cust_main_county', {
1790       'country' => $self->country,
1791       'state'   => '',
1792      } ) ) {
1793       return "Unknown state/county/country: ".
1794         $self->state. "/". $self->county. "/". $self->country
1795         unless qsearch('cust_main_county',{
1796           'state'   => $self->state,
1797           'county'  => $self->county,
1798           'country' => $self->country,
1799         } );
1800     }
1801   }
1802
1803   $error =
1804        $self->ut_phonen('daytime', $self->country)
1805     || $self->ut_phonen('night',   $self->country)
1806     || $self->ut_phonen('fax',     $self->country)
1807     || $self->ut_phonen('mobile',  $self->country)
1808   ;
1809   return $error if $error;
1810
1811   unless ( $ignore_illegal_zip ) {
1812     $error = $self->ut_zip('zip', $self->country);
1813     return $error if $error;
1814   }
1815
1816   if ( $conf->exists('cust_main-require_phone')
1817        && ! length($self->daytime) && ! length($self->night) && ! length($self->mobile)
1818      ) {
1819
1820     my $daytime_label = FS::Msgcat::_gettext('daytime') =~ /^(daytime)?$/
1821                           ? 'Day Phone'
1822                           : FS::Msgcat::_gettext('daytime');
1823     my $night_label = FS::Msgcat::_gettext('night') =~ /^(night)?$/
1824                         ? 'Night Phone'
1825                         : FS::Msgcat::_gettext('night');
1826
1827     my $mobile_label = FS::Msgcat::_gettext('mobile') =~ /^(mobile)?$/
1828                         ? 'Mobile Phone'
1829                         : FS::Msgcat::_gettext('mobile');
1830
1831     return "$daytime_label, $night_label or $mobile_label is required"
1832
1833   }
1834
1835   if ( $self->has_ship_address
1836        && scalar ( grep { $self->getfield($_) ne $self->getfield("ship_$_") }
1837                         $self->addr_fields )
1838      )
1839   {
1840     my $error =
1841       $self->ut_name('ship_last')
1842       || $self->ut_name('ship_first')
1843       || $self->ut_textn('ship_company')
1844       || $self->ut_text('ship_address1')
1845       || $self->ut_textn('ship_address2')
1846       || $self->ut_text('ship_city')
1847       || $self->ut_textn('ship_county')
1848       || $self->ut_textn('ship_state')
1849       || $self->ut_country('ship_country')
1850       || $self->ut_coordn('ship_latitude')
1851       || $self->ut_coordn('ship_longitude')
1852       || $self->ut_enum('ship_coord_auto', [ '', 'Y' ] )
1853     ;
1854     return $error if $error;
1855
1856     $self->set_coord('ship_')
1857       unless $import || ($self->ship_latitude && $self->ship_longitude);
1858
1859     #false laziness with above
1860     unless ( qsearchs('cust_main_county', {
1861       'country' => $self->ship_country,
1862       'state'   => '',
1863      } ) ) {
1864       return "Unknown ship_state/ship_county/ship_country: ".
1865         $self->ship_state. "/". $self->ship_county. "/". $self->ship_country
1866         unless qsearch('cust_main_county',{
1867           'state'   => $self->ship_state,
1868           'county'  => $self->ship_county,
1869           'country' => $self->ship_country,
1870         } );
1871     }
1872     #eofalse
1873
1874     $error =
1875          $self->ut_phonen('ship_daytime', $self->ship_country)
1876       || $self->ut_phonen('ship_night',   $self->ship_country)
1877       || $self->ut_phonen('ship_fax',     $self->ship_country)
1878       || $self->ut_phonen('ship_mobile',  $self->ship_country)
1879     ;
1880     return $error if $error;
1881
1882     unless ( $ignore_illegal_zip ) {
1883       $error = $self->ut_zip('ship_zip', $self->ship_country);
1884       return $error if $error;
1885     }
1886     return "Unit # is required."
1887       if $self->ship_address2 =~ /^\s*$/
1888       && $conf->exists('cust_main-require_address2');
1889
1890   } else { # ship_ info eq billing info, so don't store dup info in database
1891
1892     $self->setfield("ship_$_", '')
1893       foreach $self->addr_fields;
1894
1895     return "Unit # is required."
1896       if $self->address2 =~ /^\s*$/
1897       && $conf->exists('cust_main-require_address2');
1898
1899   }
1900
1901   #$self->payby =~ /^(CARD|DCRD|CHEK|DCHK|LECB|BILL|COMP|PREPAY|CASH|WEST|MCRD)$/
1902   #  or return "Illegal payby: ". $self->payby;
1903   #$self->payby($1);
1904   FS::payby->can_payby($self->table, $self->payby)
1905     or return "Illegal payby: ". $self->payby;
1906
1907   $error =    $self->ut_numbern('paystart_month')
1908            || $self->ut_numbern('paystart_year')
1909            || $self->ut_numbern('payissue')
1910            || $self->ut_textn('paytype')
1911   ;
1912   return $error if $error;
1913
1914   if ( $self->payip eq '' ) {
1915     $self->payip('');
1916   } else {
1917     $error = $self->ut_ip('payip');
1918     return $error if $error;
1919   }
1920
1921   # If it is encrypted and the private key is not availaible then we can't
1922   # check the credit card.
1923   my $check_payinfo = ! $self->is_encrypted($self->payinfo);
1924
1925   if ( $check_payinfo && $self->payby =~ /^(CARD|DCRD)$/ ) {
1926
1927     my $payinfo = $self->payinfo;
1928     $payinfo =~ s/\D//g;
1929     $payinfo =~ /^(\d{13,16}|\d{8,9})$/
1930       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1931     $payinfo = $1;
1932     $self->payinfo($payinfo);
1933     validate($payinfo)
1934       or return gettext('invalid_card'); # . ": ". $self->payinfo;
1935
1936     return gettext('unknown_card_type')
1937       if $self->payinfo !~ /^99\d{14}$/ #token
1938       && cardtype($self->payinfo) eq "Unknown";
1939
1940     unless ( $ignore_banned_card ) {
1941       my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
1942       if ( $ban ) {
1943         if ( $ban->bantype eq 'warn' ) {
1944           #or others depending on value of $ban->reason ?
1945           return '_duplicate_card'.
1946                  ': disabled from'. time2str('%a %h %o at %r', $ban->_date).
1947                  ' until '.         time2str('%a %h %o at %r', $ban->_end_date).
1948                  ' (ban# '. $ban->bannum. ')'
1949             unless $self->override_ban_warn;
1950         } else {
1951           return 'Banned credit card: banned on '.
1952                  time2str('%a %h %o at %r', $ban->_date).
1953                  ' by '. $ban->otaker.
1954                  ' (ban# '. $ban->bannum. ')';
1955         }
1956       }
1957     }
1958
1959     if (length($self->paycvv) && !$self->is_encrypted($self->paycvv)) {
1960       if ( cardtype($self->payinfo) eq 'American Express card' ) {
1961         $self->paycvv =~ /^(\d{4})$/
1962           or return "CVV2 (CID) for American Express cards is four digits.";
1963         $self->paycvv($1);
1964       } else {
1965         $self->paycvv =~ /^(\d{3})$/
1966           or return "CVV2 (CVC2/CID) is three digits.";
1967         $self->paycvv($1);
1968       }
1969     } else {
1970       $self->paycvv('');
1971     }
1972
1973     my $cardtype = cardtype($payinfo);
1974     if ( $cardtype =~ /^(Switch|Solo)$/i ) {
1975
1976       return "Start date or issue number is required for $cardtype cards"
1977         unless $self->paystart_month && $self->paystart_year or $self->payissue;
1978
1979       return "Start month must be between 1 and 12"
1980         if $self->paystart_month
1981            and $self->paystart_month < 1 || $self->paystart_month > 12;
1982
1983       return "Start year must be 1990 or later"
1984         if $self->paystart_year
1985            and $self->paystart_year < 1990;
1986
1987       return "Issue number must be beween 1 and 99"
1988         if $self->payissue
1989           and $self->payissue < 1 || $self->payissue > 99;
1990
1991     } else {
1992       $self->paystart_month('');
1993       $self->paystart_year('');
1994       $self->payissue('');
1995     }
1996
1997   } elsif ( $check_payinfo && $self->payby =~ /^(CHEK|DCHK)$/ ) {
1998
1999     my $payinfo = $self->payinfo;
2000     $payinfo =~ s/[^\d\@\.]//g;
2001     if ( $conf->exists('cust_main-require-bank-branch') ) {
2002       $payinfo =~ /^(\d+)\@(\d+)\.(\d+)$/ or return 'invalid echeck account@branch.bank';
2003       $payinfo = "$1\@$2.$3";
2004     } elsif ( $conf->exists('echeck-nonus') ) {
2005       $payinfo =~ /^(\d+)\@(\d+)$/ or return 'invalid echeck account@aba';
2006       $payinfo = "$1\@$2";
2007     } else {
2008       $payinfo =~ /^(\d+)\@(\d{9})$/ or return 'invalid echeck account@aba';
2009       $payinfo = "$1\@$2";
2010     }
2011     $self->payinfo($payinfo);
2012     $self->paycvv('');
2013
2014     unless ( $ignore_banned_card ) {
2015       my $ban = FS::banned_pay->ban_search( %{ $self->_banned_pay_hashref } );
2016       if ( $ban ) {
2017         if ( $ban->bantype eq 'warn' ) {
2018           #or others depending on value of $ban->reason ?
2019           return '_duplicate_ach' unless $self->override_ban_warn;
2020         } else {
2021           return 'Banned ACH account: banned on '.
2022                  time2str('%a %h %o at %r', $ban->_date).
2023                  ' by '. $ban->otaker.
2024                  ' (ban# '. $ban->bannum. ')';
2025         }
2026       }
2027     }
2028
2029   } elsif ( $self->payby eq 'LECB' ) {
2030
2031     my $payinfo = $self->payinfo;
2032     $payinfo =~ s/\D//g;
2033     $payinfo =~ /^1?(\d{10})$/ or return 'invalid btn billing telephone number';
2034     $payinfo = $1;
2035     $self->payinfo($payinfo);
2036     $self->paycvv('');
2037
2038   } elsif ( $self->payby eq 'BILL' ) {
2039
2040     $error = $self->ut_textn('payinfo');
2041     return "Illegal P.O. number: ". $self->payinfo if $error;
2042     $self->paycvv('');
2043
2044   } elsif ( $self->payby eq 'COMP' ) {
2045
2046     my $curuser = $FS::CurrentUser::CurrentUser;
2047     if (    ! $self->custnum
2048          && ! $curuser->access_right('Complimentary customer')
2049        )
2050     {
2051       return "You are not permitted to create complimentary accounts."
2052     }
2053
2054     $error = $self->ut_textn('payinfo');
2055     return "Illegal comp account issuer: ". $self->payinfo if $error;
2056     $self->paycvv('');
2057
2058   } elsif ( $self->payby eq 'PREPAY' ) {
2059
2060     my $payinfo = $self->payinfo;
2061     $payinfo =~ s/\W//g; #anything else would just confuse things
2062     $self->payinfo($payinfo);
2063     $error = $self->ut_alpha('payinfo');
2064     return "Illegal prepayment identifier: ". $self->payinfo if $error;
2065     return "Unknown prepayment identifier"
2066       unless qsearchs('prepay_credit', { 'identifier' => $self->payinfo } );
2067     $self->paycvv('');
2068
2069   }
2070
2071   if ( $self->paydate eq '' || $self->paydate eq '-' ) {
2072     return "Expiration date required"
2073       unless $self->payby =~ /^(BILL|PREPAY|CHEK|DCHK|LECB|CASH|WEST|MCRD)$/;
2074     $self->paydate('');
2075   } else {
2076     my( $m, $y );
2077     if ( $self->paydate =~ /^(\d{1,2})[\/\-](\d{2}(\d{2})?)$/ ) {
2078       ( $m, $y ) = ( $1, length($2) == 4 ? $2 : "20$2" );
2079     } elsif ( $self->paydate =~ /^19(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2080       ( $m, $y ) = ( $2, "19$1" );
2081     } elsif ( $self->paydate =~ /^(20)?(\d{2})[\/\-](\d{1,2})[\/\-]\d+$/ ) {
2082       ( $m, $y ) = ( $3, "20$2" );
2083     } else {
2084       return "Illegal expiration date: ". $self->paydate;
2085     }
2086     $m = sprintf('%02d',$m);
2087     $self->paydate("$y-$m-01");
2088     my($nowm,$nowy)=(localtime(time))[4,5]; $nowm++; $nowy+=1900;
2089     return gettext('expired_card')
2090       if !$import
2091       && !$ignore_expired_card
2092       && ( $y<$nowy || ( $y==$nowy && $1<$nowm ) );
2093   }
2094
2095   if ( $self->payname eq '' && $self->payby !~ /^(CHEK|DCHK)$/ &&
2096        ( ! $conf->exists('require_cardname')
2097          || $self->payby !~ /^(CARD|DCRD)$/  )
2098   ) {
2099     $self->payname( $self->first. " ". $self->getfield('last') );
2100   } else {
2101     $self->payname =~ /^([\w \,\.\-\'\&]+)$/
2102       or return gettext('illegal_name'). " payname: ". $self->payname;
2103     $self->payname($1);
2104   }
2105
2106   foreach my $flag (qw( tax spool_cdr squelch_cdr archived email_csv_cdr )) {
2107     $self->$flag() =~ /^(Y?)$/ or return "Illegal $flag: ". $self->$flag();
2108     $self->$flag($1);
2109   }
2110
2111   $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
2112
2113   warn "$me check AFTER: \n". $self->_dump
2114     if $DEBUG > 2;
2115
2116   $self->SUPER::check;
2117 }
2118
2119 =item addr_fields
2120
2121 Returns a list of fields which have ship_ duplicates.
2122
2123 =cut
2124
2125 sub addr_fields {
2126   qw( last first company
2127       address1 address2 city county state zip country
2128       latitude longitude
2129       daytime night fax mobile
2130     );
2131 }
2132
2133 =item has_ship_address
2134
2135 Returns true if this customer record has a separate shipping address.
2136
2137 =cut
2138
2139 sub has_ship_address {
2140   my $self = shift;
2141   scalar( grep { $self->getfield("ship_$_") ne '' } $self->addr_fields );
2142 }
2143
2144 =item location_hash
2145
2146 Returns a list of key/value pairs, with the following keys: address1, adddress2,
2147 city, county, state, zip, country, and geocode.  The shipping address is used if present.
2148
2149 =cut
2150
2151 =item cust_location
2152
2153 Returns all locations (see L<FS::cust_location>) for this customer.
2154
2155 =cut
2156
2157 sub cust_location {
2158   my $self = shift;
2159   qsearch('cust_location', { 'custnum' => $self->custnum } );
2160 }
2161
2162 =item cust_contact
2163
2164 Returns all contacts (see L<FS::contact>) for this customer.
2165
2166 =cut
2167
2168 #already used :/ sub contact {
2169 sub cust_contact {
2170   my $self = shift;
2171   qsearch('contact', { 'custnum' => $self->custnum } );
2172 }
2173
2174 =item unsuspend
2175
2176 Unsuspends all unflagged suspended packages (see L</unflagged_suspended_pkgs>
2177 and L<FS::cust_pkg>) for this customer.  Always returns a list: an empty list
2178 on success or a list of errors.
2179
2180 =cut
2181
2182 sub unsuspend {
2183   my $self = shift;
2184   grep { $_->unsuspend } $self->suspended_pkgs;
2185 }
2186
2187 =item suspend
2188
2189 Suspends all unsuspended packages (see L<FS::cust_pkg>) for this customer.
2190
2191 Returns a list: an empty list on success or a list of errors.
2192
2193 =cut
2194
2195 sub suspend {
2196   my $self = shift;
2197   grep { $_->suspend(@_) } $self->unsuspended_pkgs;
2198 }
2199
2200 =item suspend_if_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2201
2202 Suspends all unsuspended packages (see L<FS::cust_pkg>) matching the listed
2203 PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref instead
2204 of a list of pkgparts; the hashref has the following keys:
2205
2206 =over 4
2207
2208 =item pkgparts - listref of pkgparts
2209
2210 =item (other options are passed to the suspend method)
2211
2212 =back
2213
2214
2215 Returns a list: an empty list on success or a list of errors.
2216
2217 =cut
2218
2219 sub suspend_if_pkgpart {
2220   my $self = shift;
2221   my (@pkgparts, %opt);
2222   if (ref($_[0]) eq 'HASH'){
2223     @pkgparts = @{$_[0]{pkgparts}};
2224     %opt      = %{$_[0]};
2225   }else{
2226     @pkgparts = @_;
2227   }
2228   grep { $_->suspend(%opt) }
2229     grep { my $pkgpart = $_->pkgpart; grep { $pkgpart eq $_ } @pkgparts }
2230       $self->unsuspended_pkgs;
2231 }
2232
2233 =item suspend_unless_pkgpart HASHREF | PKGPART [ , PKGPART ... ]
2234
2235 Suspends all unsuspended packages (see L<FS::cust_pkg>) unless they match the
2236 given PKGPARTs (see L<FS::part_pkg>).  Preferred usage is to pass a hashref
2237 instead of a list of pkgparts; the hashref has the following keys:
2238
2239 =over 4
2240
2241 =item pkgparts - listref of pkgparts
2242
2243 =item (other options are passed to the suspend method)
2244
2245 =back
2246
2247 Returns a list: an empty list on success or a list of errors.
2248
2249 =cut
2250
2251 sub suspend_unless_pkgpart {
2252   my $self = shift;
2253   my (@pkgparts, %opt);
2254   if (ref($_[0]) eq 'HASH'){
2255     @pkgparts = @{$_[0]{pkgparts}};
2256     %opt      = %{$_[0]};
2257   }else{
2258     @pkgparts = @_;
2259   }
2260   grep { $_->suspend(%opt) }
2261     grep { my $pkgpart = $_->pkgpart; ! grep { $pkgpart eq $_ } @pkgparts }
2262       $self->unsuspended_pkgs;
2263 }
2264
2265 =item cancel [ OPTION => VALUE ... ]
2266
2267 Cancels all uncancelled packages (see L<FS::cust_pkg>) for this customer.
2268
2269 Available options are:
2270
2271 =over 4
2272
2273 =item quiet - can be set true to supress email cancellation notices.
2274
2275 =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.
2276
2277 =item ban - can be set true to ban this customer's credit card or ACH information, if present.
2278
2279 =item nobill - can be set true to skip billing if it might otherwise be done.
2280
2281 =back
2282
2283 Always returns a list: an empty list on success or a list of errors.
2284
2285 =cut
2286
2287 # nb that dates are not specified as valid options to this method
2288
2289 sub cancel {
2290   my( $self, %opt ) = @_;
2291
2292   warn "$me cancel called on customer ". $self->custnum. " with options ".
2293        join(', ', map { "$_: $opt{$_}" } keys %opt ). "\n"
2294     if $DEBUG;
2295
2296   return ( 'access denied' )
2297     unless $FS::CurrentUser::CurrentUser->access_right('Cancel customer');
2298
2299   if ( $opt{'ban'} && $self->payby =~ /^(CARD|DCRD|CHEK|DCHK)$/ ) {
2300
2301     #should try decryption (we might have the private key)
2302     # and if not maybe queue a job for the server that does?
2303     return ( "Can't (yet) ban encrypted credit cards" )
2304       if $self->is_encrypted($self->payinfo);
2305
2306     my $ban = new FS::banned_pay $self->_new_banned_pay_hashref;
2307     my $error = $ban->insert;
2308     return ( $error ) if $error;
2309
2310   }
2311
2312   my @pkgs = $self->ncancelled_pkgs;
2313
2314   if ( !$opt{nobill} && $conf->exists('bill_usage_on_cancel') ) {
2315     $opt{nobill} = 1;
2316     my $error = $self->bill( pkg_list => [ @pkgs ], cancel => 1 );
2317     warn "Error billing during cancel, custnum ". $self->custnum. ": $error"
2318       if $error;
2319   }
2320
2321   warn "$me cancelling ". scalar($self->ncancelled_pkgs). "/".
2322        scalar(@pkgs). " packages for customer ". $self->custnum. "\n"
2323     if $DEBUG;
2324
2325   grep { $_ } map { $_->cancel(%opt) } $self->ncancelled_pkgs;
2326 }
2327
2328 sub _banned_pay_hashref {
2329   my $self = shift;
2330
2331   my %payby2ban = (
2332     'CARD' => 'CARD',
2333     'DCRD' => 'CARD',
2334     'CHEK' => 'CHEK',
2335     'DCHK' => 'CHEK'
2336   );
2337
2338   {
2339     'payby'   => $payby2ban{$self->payby},
2340     'payinfo' => $self->payinfo,
2341     #don't ever *search* on reason! #'reason'  =>
2342   };
2343 }
2344
2345 sub _new_banned_pay_hashref {
2346   my $self = shift;
2347   my $hr = $self->_banned_pay_hashref;
2348   $hr->{payinfo} = md5_base64($hr->{payinfo});
2349   $hr;
2350 }
2351
2352 =item notes
2353
2354 Returns all notes (see L<FS::cust_main_note>) for this customer.
2355
2356 =cut
2357
2358 sub notes {
2359   my($self,$orderby_classnum) = (shift,shift);
2360   my $orderby = "_DATE DESC";
2361   $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2362   qsearch( 'cust_main_note',
2363            { 'custnum' => $self->custnum },
2364            '',
2365            "ORDER BY $orderby",
2366          );
2367 }
2368
2369 =item agent
2370
2371 Returns the agent (see L<FS::agent>) for this customer.
2372
2373 =cut
2374
2375 sub agent {
2376   my $self = shift;
2377   qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2378 }
2379
2380 =item agent_name
2381
2382 Returns the agent name (see L<FS::agent>) for this customer.
2383
2384 =cut
2385
2386 sub agent_name {
2387   my $self = shift;
2388   $self->agent->agent;
2389 }
2390
2391 =item cust_tag
2392
2393 Returns any tags associated with this customer, as FS::cust_tag objects,
2394 or an empty list if there are no tags.
2395
2396 =cut
2397
2398 sub cust_tag {
2399   my $self = shift;
2400   qsearch('cust_tag', { 'custnum' => $self->custnum } );
2401 }
2402
2403 =item part_tag
2404
2405 Returns any tags associated with this customer, as FS::part_tag objects,
2406 or an empty list if there are no tags.
2407
2408 =cut
2409
2410 sub part_tag {
2411   my $self = shift;
2412   map $_->part_tag, $self->cust_tag;
2413 }
2414
2415
2416 =item cust_class
2417
2418 Returns the customer class, as an FS::cust_class object, or the empty string
2419 if there is no customer class.
2420
2421 =cut
2422
2423 sub cust_class {
2424   my $self = shift;
2425   if ( $self->classnum ) {
2426     qsearchs('cust_class', { 'classnum' => $self->classnum } );
2427   } else {
2428     return '';
2429   }
2430 }
2431
2432 =item categoryname
2433
2434 Returns the customer category name, or the empty string if there is no customer
2435 category.
2436
2437 =cut
2438
2439 sub categoryname {
2440   my $self = shift;
2441   my $cust_class = $self->cust_class;
2442   $cust_class
2443     ? $cust_class->categoryname
2444     : '';
2445 }
2446
2447 =item classname
2448
2449 Returns the customer class name, or the empty string if there is no customer
2450 class.
2451
2452 =cut
2453
2454 sub classname {
2455   my $self = shift;
2456   my $cust_class = $self->cust_class;
2457   $cust_class
2458     ? $cust_class->classname
2459     : '';
2460 }
2461
2462 =item BILLING METHODS
2463
2464 Documentation on billing methods has been moved to
2465 L<FS::cust_main::Billing>.
2466
2467 =item REALTIME BILLING METHODS
2468
2469 Documentation on realtime billing methods has been moved to
2470 L<FS::cust_main::Billing_Realtime>.
2471
2472 =item remove_cvv
2473
2474 Removes the I<paycvv> field from the database directly.
2475
2476 If there is an error, returns the error, otherwise returns false.
2477
2478 =cut
2479
2480 sub remove_cvv {
2481   my $self = shift;
2482   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2483     or return dbh->errstr;
2484   $sth->execute($self->custnum)
2485     or return $sth->errstr;
2486   $self->paycvv('');
2487   '';
2488 }
2489
2490 =item batch_card OPTION => VALUE...
2491
2492 Adds a payment for this invoice to the pending credit card batch (see
2493 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2494 runs the payment using a realtime gateway.
2495
2496 =cut
2497
2498 sub batch_card {
2499   my ($self, %options) = @_;
2500
2501   my $amount;
2502   if (exists($options{amount})) {
2503     $amount = $options{amount};
2504   }else{
2505     $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2506   }
2507   return '' unless $amount > 0;
2508
2509   my $invnum = delete $options{invnum};
2510   my $payby = $options{payby} || $self->payby;  #still dubious
2511
2512   if ($options{'realtime'}) {
2513     return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2514                                 $amount,
2515                                 %options,
2516                               );
2517   }
2518
2519   my $oldAutoCommit = $FS::UID::AutoCommit;
2520   local $FS::UID::AutoCommit = 0;
2521   my $dbh = dbh;
2522
2523   #this needs to handle mysql as well as Pg, like svc_acct.pm
2524   #(make it into a common function if folks need to do batching with mysql)
2525   $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2526     or return "Cannot lock pay_batch: " . $dbh->errstr;
2527
2528   my %pay_batch = (
2529     'status' => 'O',
2530     'payby'  => FS::payby->payby2payment($payby),
2531   );
2532   $pay_batch{agentnum} = $self->agentnum if $conf->exists('batch-spoolagent');
2533
2534   my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2535
2536   unless ( $pay_batch ) {
2537     $pay_batch = new FS::pay_batch \%pay_batch;
2538     my $error = $pay_batch->insert;
2539     if ( $error ) {
2540       $dbh->rollback if $oldAutoCommit;
2541       die "error creating new batch: $error\n";
2542     }
2543   }
2544
2545   my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2546       'batchnum' => $pay_batch->batchnum,
2547       'custnum'  => $self->custnum,
2548   } );
2549
2550   foreach (qw( address1 address2 city state zip country latitude longitude
2551                payby payinfo paydate payname ))
2552   {
2553     $options{$_} = '' unless exists($options{$_});
2554   }
2555
2556   my $cust_pay_batch = new FS::cust_pay_batch ( {
2557     'batchnum' => $pay_batch->batchnum,
2558     'invnum'   => $invnum || 0,                    # is there a better value?
2559                                                    # this field should be
2560                                                    # removed...
2561                                                    # cust_bill_pay_batch now
2562     'custnum'  => $self->custnum,
2563     'last'     => $self->getfield('last'),
2564     'first'    => $self->getfield('first'),
2565     'address1' => $options{address1} || $self->address1,
2566     'address2' => $options{address2} || $self->address2,
2567     'city'     => $options{city}     || $self->city,
2568     'state'    => $options{state}    || $self->state,
2569     'zip'      => $options{zip}      || $self->zip,
2570     'country'  => $options{country}  || $self->country,
2571     'payby'    => $options{payby}    || $self->payby,
2572     'payinfo'  => $options{payinfo}  || $self->payinfo,
2573     'exp'      => $options{paydate}  || $self->paydate,
2574     'payname'  => $options{payname}  || $self->payname,
2575     'amount'   => $amount,                         # consolidating
2576   } );
2577
2578   $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2579     if $old_cust_pay_batch;
2580
2581   my $error;
2582   if ($old_cust_pay_batch) {
2583     $error = $cust_pay_batch->replace($old_cust_pay_batch)
2584   } else {
2585     $error = $cust_pay_batch->insert;
2586   }
2587
2588   if ( $error ) {
2589     $dbh->rollback if $oldAutoCommit;
2590     die $error;
2591   }
2592
2593   my $unapplied =   $self->total_unapplied_credits
2594                   + $self->total_unapplied_payments
2595                   + $self->in_transit_payments;
2596   foreach my $cust_bill ($self->open_cust_bill) {
2597     #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2598     my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2599       'invnum' => $cust_bill->invnum,
2600       'paybatchnum' => $cust_pay_batch->paybatchnum,
2601       'amount' => $cust_bill->owed,
2602       '_date' => time,
2603     };
2604     if ($unapplied >= $cust_bill_pay_batch->amount){
2605       $unapplied -= $cust_bill_pay_batch->amount;
2606       next;
2607     }else{
2608       $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2609                                    $cust_bill_pay_batch->amount - $unapplied ));      $unapplied = 0;
2610     }
2611     $error = $cust_bill_pay_batch->insert;
2612     if ( $error ) {
2613       $dbh->rollback if $oldAutoCommit;
2614       die $error;
2615     }
2616   }
2617
2618   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2619   '';
2620 }
2621
2622 =item total_owed
2623
2624 Returns the total owed for this customer on all invoices
2625 (see L<FS::cust_bill/owed>).
2626
2627 =cut
2628
2629 sub total_owed {
2630   my $self = shift;
2631   $self->total_owed_date(2145859200); #12/31/2037
2632 }
2633
2634 =item total_owed_date TIME
2635
2636 Returns the total owed for this customer on all invoices with date earlier than
2637 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2638 see L<Time::Local> and L<Date::Parse> for conversion functions.
2639
2640 =cut
2641
2642 sub total_owed_date {
2643   my $self = shift;
2644   my $time = shift;
2645
2646   my $custnum = $self->custnum;
2647
2648   my $owed_sql = FS::cust_bill->owed_sql;
2649
2650   my $sql = "
2651     SELECT SUM($owed_sql) FROM cust_bill
2652       WHERE custnum = $custnum
2653         AND _date <= $time
2654   ";
2655
2656   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2657
2658 }
2659
2660 =item total_owed_pkgnum PKGNUM
2661
2662 Returns the total owed on all invoices for this customer's specific package
2663 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2664
2665 =cut
2666
2667 sub total_owed_pkgnum {
2668   my( $self, $pkgnum ) = @_;
2669   $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2670 }
2671
2672 =item total_owed_date_pkgnum TIME PKGNUM
2673
2674 Returns the total owed for this customer's specific package when using
2675 experimental package balances on all invoices with date earlier than
2676 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2677 see L<Time::Local> and L<Date::Parse> for conversion functions.
2678
2679 =cut
2680
2681 sub total_owed_date_pkgnum {
2682   my( $self, $time, $pkgnum ) = @_;
2683
2684   my $total_bill = 0;
2685   foreach my $cust_bill (
2686     grep { $_->_date <= $time }
2687       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2688   ) {
2689     $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2690   }
2691   sprintf( "%.2f", $total_bill );
2692
2693 }
2694
2695 =item total_paid
2696
2697 Returns the total amount of all payments.
2698
2699 =cut
2700
2701 sub total_paid {
2702   my $self = shift;
2703   my $total = 0;
2704   $total += $_->paid foreach $self->cust_pay;
2705   sprintf( "%.2f", $total );
2706 }
2707
2708 =item total_unapplied_credits
2709
2710 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2711 customer.  See L<FS::cust_credit/credited>.
2712
2713 =item total_credited
2714
2715 Old name for total_unapplied_credits.  Don't use.
2716
2717 =cut
2718
2719 sub total_credited {
2720   #carp "total_credited deprecated, use total_unapplied_credits";
2721   shift->total_unapplied_credits(@_);
2722 }
2723
2724 sub total_unapplied_credits {
2725   my $self = shift;
2726
2727   my $custnum = $self->custnum;
2728
2729   my $unapplied_sql = FS::cust_credit->unapplied_sql;
2730
2731   my $sql = "
2732     SELECT SUM($unapplied_sql) FROM cust_credit
2733       WHERE custnum = $custnum
2734   ";
2735
2736   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2737
2738 }
2739
2740 =item total_unapplied_credits_pkgnum PKGNUM
2741
2742 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2743 customer.  See L<FS::cust_credit/credited>.
2744
2745 =cut
2746
2747 sub total_unapplied_credits_pkgnum {
2748   my( $self, $pkgnum ) = @_;
2749   my $total_credit = 0;
2750   $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2751   sprintf( "%.2f", $total_credit );
2752 }
2753
2754
2755 =item total_unapplied_payments
2756
2757 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2758 See L<FS::cust_pay/unapplied>.
2759
2760 =cut
2761
2762 sub total_unapplied_payments {
2763   my $self = shift;
2764
2765   my $custnum = $self->custnum;
2766
2767   my $unapplied_sql = FS::cust_pay->unapplied_sql;
2768
2769   my $sql = "
2770     SELECT SUM($unapplied_sql) FROM cust_pay
2771       WHERE custnum = $custnum
2772   ";
2773
2774   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2775
2776 }
2777
2778 =item total_unapplied_payments_pkgnum PKGNUM
2779
2780 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2781 specific package when using experimental package balances.  See
2782 L<FS::cust_pay/unapplied>.
2783
2784 =cut
2785
2786 sub total_unapplied_payments_pkgnum {
2787   my( $self, $pkgnum ) = @_;
2788   my $total_unapplied = 0;
2789   $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2790   sprintf( "%.2f", $total_unapplied );
2791 }
2792
2793
2794 =item total_unapplied_refunds
2795
2796 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2797 customer.  See L<FS::cust_refund/unapplied>.
2798
2799 =cut
2800
2801 sub total_unapplied_refunds {
2802   my $self = shift;
2803   my $custnum = $self->custnum;
2804
2805   my $unapplied_sql = FS::cust_refund->unapplied_sql;
2806
2807   my $sql = "
2808     SELECT SUM($unapplied_sql) FROM cust_refund
2809       WHERE custnum = $custnum
2810   ";
2811
2812   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2813
2814 }
2815
2816 =item balance
2817
2818 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2819 total_unapplied_credits minus total_unapplied_payments).
2820
2821 =cut
2822
2823 sub balance {
2824   my $self = shift;
2825   $self->balance_date_range;
2826 }
2827
2828 =item balance_date TIME
2829
2830 Returns the balance for this customer, only considering invoices with date
2831 earlier than TIME (total_owed_date minus total_credited minus
2832 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
2833 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
2834 functions.
2835
2836 =cut
2837
2838 sub balance_date {
2839   my $self = shift;
2840   $self->balance_date_range(shift);
2841 }
2842
2843 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2844
2845 Returns the balance for this customer, optionally considering invoices with
2846 date earlier than START_TIME, and not later than END_TIME
2847 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2848
2849 Times are specified as SQL fragments or numeric
2850 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
2851 L<Date::Parse> for conversion functions.  The empty string can be passed
2852 to disable that time constraint completely.
2853
2854 Available options are:
2855
2856 =over 4
2857
2858 =item unapplied_date
2859
2860 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)
2861
2862 =back
2863
2864 =cut
2865
2866 sub balance_date_range {
2867   my $self = shift;
2868   my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2869             ') FROM cust_main WHERE custnum='. $self->custnum;
2870   sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2871 }
2872
2873 =item balance_pkgnum PKGNUM
2874
2875 Returns the balance for this customer's specific package when using
2876 experimental package balances (total_owed plus total_unrefunded, minus
2877 total_unapplied_credits minus total_unapplied_payments)
2878
2879 =cut
2880
2881 sub balance_pkgnum {
2882   my( $self, $pkgnum ) = @_;
2883
2884   sprintf( "%.2f",
2885       $self->total_owed_pkgnum($pkgnum)
2886 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2887 #    + $self->total_unapplied_refunds_pkgnum($pkgnum)
2888     - $self->total_unapplied_credits_pkgnum($pkgnum)
2889     - $self->total_unapplied_payments_pkgnum($pkgnum)
2890   );
2891 }
2892
2893 =item in_transit_payments
2894
2895 Returns the total of requests for payments for this customer pending in
2896 batches in transit to the bank.  See L<FS::pay_batch> and L<FS::cust_pay_batch>
2897
2898 =cut
2899
2900 sub in_transit_payments {
2901   my $self = shift;
2902   my $in_transit_payments = 0;
2903   foreach my $pay_batch ( qsearch('pay_batch', {
2904     'status' => 'I',
2905   } ) ) {
2906     foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2907       'batchnum' => $pay_batch->batchnum,
2908       'custnum' => $self->custnum,
2909     } ) ) {
2910       $in_transit_payments += $cust_pay_batch->amount;
2911     }
2912   }
2913   sprintf( "%.2f", $in_transit_payments );
2914 }
2915
2916 =item payment_info
2917
2918 Returns a hash of useful information for making a payment.
2919
2920 =over 4
2921
2922 =item balance
2923
2924 Current balance.
2925
2926 =item payby
2927
2928 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2929 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2930 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2931
2932 =back
2933
2934 For credit card transactions:
2935
2936 =over 4
2937
2938 =item card_type 1
2939
2940 =item payname
2941
2942 Exact name on card
2943
2944 =back
2945
2946 For electronic check transactions:
2947
2948 =over 4
2949
2950 =item stateid_state
2951
2952 =back
2953
2954 =cut
2955
2956 sub payment_info {
2957   my $self = shift;
2958
2959   my %return = ();
2960
2961   $return{balance} = $self->balance;
2962
2963   $return{payname} = $self->payname
2964                      || ( $self->first. ' '. $self->get('last') );
2965
2966   $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
2967
2968   $return{payby} = $self->payby;
2969   $return{stateid_state} = $self->stateid_state;
2970
2971   if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2972     $return{card_type} = cardtype($self->payinfo);
2973     $return{payinfo} = $self->paymask;
2974
2975     @return{'month', 'year'} = $self->paydate_monthyear;
2976
2977   }
2978
2979   if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2980     my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2981     $return{payinfo1} = $payinfo1;
2982     $return{payinfo2} = $payinfo2;
2983     $return{paytype}  = $self->paytype;
2984     $return{paystate} = $self->paystate;
2985
2986   }
2987
2988   #doubleclick protection
2989   my $_date = time;
2990   $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2991
2992   %return;
2993
2994 }
2995
2996 =item paydate_monthyear
2997
2998 Returns a two-element list consisting of the month and year of this customer's
2999 paydate (credit card expiration date for CARD customers)
3000
3001 =cut
3002
3003 sub paydate_monthyear {
3004   my $self = shift;
3005   if ( $self->paydate  =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
3006     ( $2, $1 );
3007   } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
3008     ( $1, $3 );
3009   } else {
3010     ('', '');
3011   }
3012 }
3013
3014 =item paydate_epoch
3015
3016 Returns the exact time in seconds corresponding to the payment method
3017 expiration date.  For CARD/DCRD customers this is the end of the month;
3018 for others (COMP is the only other payby that uses paydate) it's the start.
3019 Returns 0 if the paydate is empty or set to the far future.
3020
3021 =cut
3022
3023 sub paydate_epoch {
3024   my $self = shift;
3025   my ($month, $year) = $self->paydate_monthyear;
3026   return 0 if !$year or $year >= 2037;
3027   if ( $self->payby eq 'CARD' or $self->payby eq 'DCRD' ) {
3028     $month++;
3029     if ( $month == 13 ) {
3030       $month = 1;
3031       $year++;
3032     }
3033     return timelocal(0,0,0,1,$month-1,$year) - 1;
3034   }
3035   else {
3036     return timelocal(0,0,0,1,$month-1,$year);
3037   }
3038 }
3039
3040 =item paydate_epoch_sql
3041
3042 Class method.  Returns an SQL expression to obtain the payment expiration date
3043 as a number of seconds.
3044
3045 =cut
3046
3047 # Special expiration date behavior for non-CARD/DCRD customers has been
3048 # carefully preserved.  Do we really use that?
3049 sub paydate_epoch_sql {
3050   my $class = shift;
3051   my $table = shift || 'cust_main';
3052   my ($case1, $case2);
3053   if ( driver_name eq 'Pg' ) {
3054     $case1 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) + INTERVAL '1 month') - 1";
3055     $case2 = "EXTRACT( EPOCH FROM CAST( $table.paydate AS TIMESTAMP ) )";
3056   }
3057   elsif ( lc(driver_name) eq 'mysql' ) {
3058     $case1 = "UNIX_TIMESTAMP( DATE_ADD( CAST( $table.paydate AS DATETIME ), INTERVAL 1 month ) ) - 1";
3059     $case2 = "UNIX_TIMESTAMP( CAST( $table.paydate AS DATETIME ) )";
3060   }
3061   else { return '' }
3062   return "CASE WHEN $table.payby IN('CARD','DCRD')
3063   THEN ($case1)
3064   ELSE ($case2)
3065   END"
3066 }
3067
3068 =item tax_exemption TAXNAME
3069
3070 =cut
3071
3072 sub tax_exemption {
3073   my( $self, $taxname ) = @_;
3074
3075   qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
3076                                      'taxname' => $taxname,
3077                                    },
3078           );
3079 }
3080
3081 =item cust_main_exemption
3082
3083 =cut
3084
3085 sub cust_main_exemption {
3086   my $self = shift;
3087   qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
3088 }
3089
3090 =item invoicing_list [ ARRAYREF ]
3091
3092 If an arguement is given, sets these email addresses as invoice recipients
3093 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
3094 (except as warnings), so use check_invoicing_list first.
3095
3096 Returns a list of email addresses (with svcnum entries expanded).
3097
3098 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
3099 check it without disturbing anything by passing nothing.
3100
3101 This interface may change in the future.
3102
3103 =cut
3104
3105 sub invoicing_list {
3106   my( $self, $arrayref ) = @_;
3107
3108   if ( $arrayref ) {
3109     my @cust_main_invoice;
3110     if ( $self->custnum ) {
3111       @cust_main_invoice =
3112         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3113     } else {
3114       @cust_main_invoice = ();
3115     }
3116     foreach my $cust_main_invoice ( @cust_main_invoice ) {
3117       #warn $cust_main_invoice->destnum;
3118       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
3119         #warn $cust_main_invoice->destnum;
3120         my $error = $cust_main_invoice->delete;
3121         warn $error if $error;
3122       }
3123     }
3124     if ( $self->custnum ) {
3125       @cust_main_invoice =
3126         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3127     } else {
3128       @cust_main_invoice = ();
3129     }
3130     my %seen = map { $_->address => 1 } @cust_main_invoice;
3131     foreach my $address ( @{$arrayref} ) {
3132       next if exists $seen{$address} && $seen{$address};
3133       $seen{$address} = 1;
3134       my $cust_main_invoice = new FS::cust_main_invoice ( {
3135         'custnum' => $self->custnum,
3136         'dest'    => $address,
3137       } );
3138       my $error = $cust_main_invoice->insert;
3139       warn $error if $error;
3140     }
3141   }
3142
3143   if ( $self->custnum ) {
3144     map { $_->address }
3145       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
3146   } else {
3147     ();
3148   }
3149
3150 }
3151
3152 =item check_invoicing_list ARRAYREF
3153
3154 Checks these arguements as valid input for the invoicing_list method.  If there
3155 is an error, returns the error, otherwise returns false.
3156
3157 =cut
3158
3159 sub check_invoicing_list {
3160   my( $self, $arrayref ) = @_;
3161
3162   foreach my $address ( @$arrayref ) {
3163
3164     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
3165       return 'Can\'t add FAX invoice destination with a blank FAX number.';
3166     }
3167
3168     my $cust_main_invoice = new FS::cust_main_invoice ( {
3169       'custnum' => $self->custnum,
3170       'dest'    => $address,
3171     } );
3172     my $error = $self->custnum
3173                 ? $cust_main_invoice->check
3174                 : $cust_main_invoice->checkdest
3175     ;
3176     return $error if $error;
3177
3178   }
3179
3180   return "Email address required"
3181     if $conf->exists('cust_main-require_invoicing_list_email')
3182     && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
3183
3184   '';
3185 }
3186
3187 =item set_default_invoicing_list
3188
3189 Sets the invoicing list to all accounts associated with this customer,
3190 overwriting any previous invoicing list.
3191
3192 =cut
3193
3194 sub set_default_invoicing_list {
3195   my $self = shift;
3196   $self->invoicing_list($self->all_emails);
3197 }
3198
3199 =item all_emails
3200
3201 Returns the email addresses of all accounts provisioned for this customer.
3202
3203 =cut
3204
3205 sub all_emails {
3206   my $self = shift;
3207   my %list;
3208   foreach my $cust_pkg ( $self->all_pkgs ) {
3209     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3210     my @svc_acct =
3211       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3212         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3213           @cust_svc;
3214     $list{$_}=1 foreach map { $_->email } @svc_acct;
3215   }
3216   keys %list;
3217 }
3218
3219 =item invoicing_list_addpost
3220
3221 Adds postal invoicing to this customer.  If this customer is already configured
3222 to receive postal invoices, does nothing.
3223
3224 =cut
3225
3226 sub invoicing_list_addpost {
3227   my $self = shift;
3228   return if grep { $_ eq 'POST' } $self->invoicing_list;
3229   my @invoicing_list = $self->invoicing_list;
3230   push @invoicing_list, 'POST';
3231   $self->invoicing_list(\@invoicing_list);
3232 }
3233
3234 =item invoicing_list_emailonly
3235
3236 Returns the list of email invoice recipients (invoicing_list without non-email
3237 destinations such as POST and FAX).
3238
3239 =cut
3240
3241 sub invoicing_list_emailonly {
3242   my $self = shift;
3243   warn "$me invoicing_list_emailonly called"
3244     if $DEBUG;
3245   grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3246 }
3247
3248 =item invoicing_list_emailonly_scalar
3249
3250 Returns the list of email invoice recipients (invoicing_list without non-email
3251 destinations such as POST and FAX) as a comma-separated scalar.
3252
3253 =cut
3254
3255 sub invoicing_list_emailonly_scalar {
3256   my $self = shift;
3257   warn "$me invoicing_list_emailonly_scalar called"
3258     if $DEBUG;
3259   join(', ', $self->invoicing_list_emailonly);
3260 }
3261
3262 =item referral_custnum_cust_main
3263
3264 Returns the customer who referred this customer (or the empty string, if
3265 this customer was not referred).
3266
3267 Note the difference with referral_cust_main method: This method,
3268 referral_custnum_cust_main returns the single customer (if any) who referred
3269 this customer, while referral_cust_main returns an array of customers referred
3270 BY this customer.
3271
3272 =cut
3273
3274 sub referral_custnum_cust_main {
3275   my $self = shift;
3276   return '' unless $self->referral_custnum;
3277   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3278 }
3279
3280 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3281
3282 Returns an array of customers referred by this customer (referral_custnum set
3283 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
3284 customers referred by customers referred by this customer and so on, inclusive.
3285 The default behavior is DEPTH 1 (no recursion).
3286
3287 Note the difference with referral_custnum_cust_main method: This method,
3288 referral_cust_main, returns an array of customers referred BY this customer,
3289 while referral_custnum_cust_main returns the single customer (if any) who
3290 referred this customer.
3291
3292 =cut
3293
3294 sub referral_cust_main {
3295   my $self = shift;
3296   my $depth = @_ ? shift : 1;
3297   my $exclude = @_ ? shift : {};
3298
3299   my @cust_main =
3300     map { $exclude->{$_->custnum}++; $_; }
3301       grep { ! $exclude->{ $_->custnum } }
3302         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3303
3304   if ( $depth > 1 ) {
3305     push @cust_main,
3306       map { $_->referral_cust_main($depth-1, $exclude) }
3307         @cust_main;
3308   }
3309
3310   @cust_main;
3311 }
3312
3313 =item referral_cust_main_ncancelled
3314
3315 Same as referral_cust_main, except only returns customers with uncancelled
3316 packages.
3317
3318 =cut
3319
3320 sub referral_cust_main_ncancelled {
3321   my $self = shift;
3322   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3323 }
3324
3325 =item referral_cust_pkg [ DEPTH ]
3326
3327 Like referral_cust_main, except returns a flat list of all unsuspended (and
3328 uncancelled) packages for each customer.  The number of items in this list may
3329 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3330
3331 =cut
3332
3333 sub referral_cust_pkg {
3334   my $self = shift;
3335   my $depth = @_ ? shift : 1;
3336
3337   map { $_->unsuspended_pkgs }
3338     grep { $_->unsuspended_pkgs }
3339       $self->referral_cust_main($depth);
3340 }
3341
3342 =item referring_cust_main
3343
3344 Returns the single cust_main record for the customer who referred this customer
3345 (referral_custnum), or false.
3346
3347 =cut
3348
3349 sub referring_cust_main {
3350   my $self = shift;
3351   return '' unless $self->referral_custnum;
3352   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3353 }
3354
3355 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3356
3357 Applies a credit to this customer.  If there is an error, returns the error,
3358 otherwise returns false.
3359
3360 REASON can be a text string, an FS::reason object, or a scalar reference to
3361 a reasonnum.  If a text string, it will be automatically inserted as a new
3362 reason, and a 'reason_type' option must be passed to indicate the
3363 FS::reason_type for the new reason.
3364
3365 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3366
3367 Any other options are passed to FS::cust_credit::insert.
3368
3369 =cut
3370
3371 sub credit {
3372   my( $self, $amount, $reason, %options ) = @_;
3373
3374   my $cust_credit = new FS::cust_credit {
3375     'custnum' => $self->custnum,
3376     'amount'  => $amount,
3377   };
3378
3379   if ( ref($reason) ) {
3380
3381     if ( ref($reason) eq 'SCALAR' ) {
3382       $cust_credit->reasonnum( $$reason );
3383     } else {
3384       $cust_credit->reasonnum( $reason->reasonnum );
3385     }
3386
3387   } else {
3388     $cust_credit->set('reason', $reason)
3389   }
3390
3391   for (qw( addlinfo eventnum )) {
3392     $cust_credit->$_( delete $options{$_} )
3393       if exists($options{$_});
3394   }
3395
3396   $cust_credit->insert(%options);
3397
3398 }
3399
3400 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3401
3402 Creates a one-time charge for this customer.  If there is an error, returns
3403 the error, otherwise returns false.
3404
3405 New-style, with a hashref of options:
3406
3407   my $error = $cust_main->charge(
3408                                   {
3409                                     'amount'     => 54.32,
3410                                     'quantity'   => 1,
3411                                     'start_date' => str2time('7/4/2009'),
3412                                     'pkg'        => 'Description',
3413                                     'comment'    => 'Comment',
3414                                     'additional' => [], #extra invoice detail
3415                                     'classnum'   => 1,  #pkg_class
3416
3417                                     'setuptax'   => '', # or 'Y' for tax exempt
3418
3419                                     #internal taxation
3420                                     'taxclass'   => 'Tax class',
3421
3422                                     #vendor taxation
3423                                     'taxproduct' => 2,  #part_pkg_taxproduct
3424                                     'override'   => {}, #XXX describe
3425
3426                                     #will be filled in with the new object
3427                                     'cust_pkg_ref' => \$cust_pkg,
3428
3429                                     #generate an invoice immediately
3430                                     'bill_now' => 0,
3431                                     'invoice_terms' => '', #with these terms
3432                                   }
3433                                 );
3434
3435 Old-style:
3436
3437   my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3438
3439 =cut
3440
3441 sub charge {
3442   my $self = shift;
3443   my ( $amount, $quantity, $start_date, $classnum );
3444   my ( $pkg, $comment, $additional );
3445   my ( $setuptax, $taxclass );   #internal taxes
3446   my ( $taxproduct, $override ); #vendor (CCH) taxes
3447   my $no_auto = '';
3448   my $cust_pkg_ref = '';
3449   my ( $bill_now, $invoice_terms ) = ( 0, '' );
3450   if ( ref( $_[0] ) ) {
3451     $amount     = $_[0]->{amount};
3452     $quantity   = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3453     $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3454     $no_auto    = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3455     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3456     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
3457                                            : '$'. sprintf("%.2f",$amount);
3458     $setuptax   = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3459     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3460     $classnum   = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3461     $additional = $_[0]->{additional} || [];
3462     $taxproduct = $_[0]->{taxproductnum};
3463     $override   = { '' => $_[0]->{tax_override} };
3464     $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3465     $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3466     $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3467   } else {
3468     $amount     = shift;
3469     $quantity   = 1;
3470     $start_date = '';
3471     $pkg        = @_ ? shift : 'One-time charge';
3472     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
3473     $setuptax   = '';
3474     $taxclass   = @_ ? shift : '';
3475     $additional = [];
3476   }
3477
3478   local $SIG{HUP} = 'IGNORE';
3479   local $SIG{INT} = 'IGNORE';
3480   local $SIG{QUIT} = 'IGNORE';
3481   local $SIG{TERM} = 'IGNORE';
3482   local $SIG{TSTP} = 'IGNORE';
3483   local $SIG{PIPE} = 'IGNORE';
3484
3485   my $oldAutoCommit = $FS::UID::AutoCommit;
3486   local $FS::UID::AutoCommit = 0;
3487   my $dbh = dbh;
3488
3489   my $part_pkg = new FS::part_pkg ( {
3490     'pkg'           => $pkg,
3491     'comment'       => $comment,
3492     'plan'          => 'flat',
3493     'freq'          => 0,
3494     'disabled'      => 'Y',
3495     'classnum'      => ( $classnum ? $classnum : '' ),
3496     'setuptax'      => $setuptax,
3497     'taxclass'      => $taxclass,
3498     'taxproductnum' => $taxproduct,
3499   } );
3500
3501   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3502                         ( 0 .. @$additional - 1 )
3503                   ),
3504                   'additional_count' => scalar(@$additional),
3505                   'setup_fee' => $amount,
3506                 );
3507
3508   my $error = $part_pkg->insert( options       => \%options,
3509                                  tax_overrides => $override,
3510                                );
3511   if ( $error ) {
3512     $dbh->rollback if $oldAutoCommit;
3513     return $error;
3514   }
3515
3516   my $pkgpart = $part_pkg->pkgpart;
3517   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3518   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3519     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3520     $error = $type_pkgs->insert;
3521     if ( $error ) {
3522       $dbh->rollback if $oldAutoCommit;
3523       return $error;
3524     }
3525   }
3526
3527   my $cust_pkg = new FS::cust_pkg ( {
3528     'custnum'    => $self->custnum,
3529     'pkgpart'    => $pkgpart,
3530     'quantity'   => $quantity,
3531     'start_date' => $start_date,
3532     'no_auto'    => $no_auto,
3533   } );
3534
3535   $error = $cust_pkg->insert;
3536   if ( $error ) {
3537     $dbh->rollback if $oldAutoCommit;
3538     return $error;
3539   } elsif ( $cust_pkg_ref ) {
3540     ${$cust_pkg_ref} = $cust_pkg;
3541   }
3542
3543   if ( $bill_now ) {
3544     my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3545                              'pkg_list'      => [ $cust_pkg ],
3546                            );
3547     if ( $error ) {
3548       $dbh->rollback if $oldAutoCommit;
3549       return $error;
3550     }
3551   }
3552
3553   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3554   return '';
3555
3556 }
3557
3558 #=item charge_postal_fee
3559 #
3560 #Applies a one time charge this customer.  If there is an error,
3561 #returns the error, returns the cust_pkg charge object or false
3562 #if there was no charge.
3563 #
3564 #=cut
3565 #
3566 # This should be a customer event.  For that to work requires that bill
3567 # also be a customer event.
3568
3569 sub charge_postal_fee {
3570   my $self = shift;
3571
3572   my $pkgpart = $conf->config('postal_invoice-fee_pkgpart', $self->agentnum);
3573   return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3574
3575   my $cust_pkg = new FS::cust_pkg ( {
3576     'custnum'  => $self->custnum,
3577     'pkgpart'  => $pkgpart,
3578     'quantity' => 1,
3579   } );
3580
3581   my $error = $cust_pkg->insert;
3582   $error ? $error : $cust_pkg;
3583 }
3584
3585 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3586
3587 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3588
3589 Optionally, a list or hashref of additional arguments to the qsearch call can
3590 be passed.
3591
3592 =cut
3593
3594 sub cust_bill {
3595   my $self = shift;
3596   my $opt = ref($_[0]) ? shift : { @_ };
3597
3598   #return $self->num_cust_bill unless wantarray || keys %$opt;
3599
3600   $opt->{'table'} = 'cust_bill';
3601   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3602   $opt->{'hashref'}{'custnum'} = $self->custnum;
3603   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3604
3605   map { $_ } #behavior of sort undefined in scalar context
3606     sort { $a->_date <=> $b->_date }
3607       qsearch($opt);
3608 }
3609
3610 =item open_cust_bill
3611
3612 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3613 customer.
3614
3615 =cut
3616
3617 sub open_cust_bill {
3618   my $self = shift;
3619
3620   $self->cust_bill(
3621     'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3622     #@_
3623   );
3624
3625 }
3626
3627 =item legacy_cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3628
3629 Returns all the legacy invoices (see L<FS::legacy_cust_bill>) for this customer.
3630
3631 =cut
3632
3633 sub legacy_cust_bill {
3634   my $self = shift;
3635
3636   #return $self->num_legacy_cust_bill unless wantarray;
3637
3638   map { $_ } #behavior of sort undefined in scalar context
3639     sort { $a->_date <=> $b->_date }
3640       qsearch({ 'table'    => 'legacy_cust_bill',
3641                 'hashref'  => { 'custnum' => $self->custnum, },
3642                 'order_by' => 'ORDER BY _date ASC',
3643              });
3644 }
3645
3646 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3647
3648 Returns all the statements (see L<FS::cust_statement>) for this customer.
3649
3650 Optionally, a list or hashref of additional arguments to the qsearch call can
3651 be passed.
3652
3653 =cut
3654
3655 sub cust_statement {
3656   my $self = shift;
3657   my $opt = ref($_[0]) ? shift : { @_ };
3658
3659   #return $self->num_cust_statement unless wantarray || keys %$opt;
3660
3661   $opt->{'table'} = 'cust_statement';
3662   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3663   $opt->{'hashref'}{'custnum'} = $self->custnum;
3664   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3665
3666   map { $_ } #behavior of sort undefined in scalar context
3667     sort { $a->_date <=> $b->_date }
3668       qsearch($opt);
3669 }
3670
3671 =item cust_credit
3672
3673 Returns all the credits (see L<FS::cust_credit>) for this customer.
3674
3675 =cut
3676
3677 sub cust_credit {
3678   my $self = shift;
3679   map { $_ } #return $self->num_cust_credit unless wantarray;
3680   sort { $a->_date <=> $b->_date }
3681     qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3682 }
3683
3684 =item cust_credit_pkgnum
3685
3686 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3687 package when using experimental package balances.
3688
3689 =cut
3690
3691 sub cust_credit_pkgnum {
3692   my( $self, $pkgnum ) = @_;
3693   map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3694   sort { $a->_date <=> $b->_date }
3695     qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3696                               'pkgnum'  => $pkgnum,
3697                             }
3698     );
3699 }
3700
3701 =item cust_pay
3702
3703 Returns all the payments (see L<FS::cust_pay>) for this customer.
3704
3705 =cut
3706
3707 sub cust_pay {
3708   my $self = shift;
3709   return $self->num_cust_pay unless wantarray;
3710   sort { $a->_date <=> $b->_date }
3711     qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3712 }
3713
3714 =item num_cust_pay
3715
3716 Returns the number of payments (see L<FS::cust_pay>) for this customer.  Also
3717 called automatically when the cust_pay method is used in a scalar context.
3718
3719 =cut
3720
3721 sub num_cust_pay {
3722   my $self = shift;
3723   my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3724   my $sth = dbh->prepare($sql) or die dbh->errstr;
3725   $sth->execute($self->custnum) or die $sth->errstr;
3726   $sth->fetchrow_arrayref->[0];
3727 }
3728
3729 =item cust_pay_pkgnum
3730
3731 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3732 package when using experimental package balances.
3733
3734 =cut
3735
3736 sub cust_pay_pkgnum {
3737   my( $self, $pkgnum ) = @_;
3738   map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3739   sort { $a->_date <=> $b->_date }
3740     qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3741                            'pkgnum'  => $pkgnum,
3742                          }
3743     );
3744 }
3745
3746 =item cust_pay_void
3747
3748 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3749
3750 =cut
3751
3752 sub cust_pay_void {
3753   my $self = shift;
3754   map { $_ } #return $self->num_cust_pay_void unless wantarray;
3755   sort { $a->_date <=> $b->_date }
3756     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3757 }
3758
3759 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3760
3761 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
3762
3763 Optionally, a list or hashref of additional arguments to the qsearch call can
3764 be passed.
3765
3766 =cut
3767
3768 sub cust_pay_batch {
3769   my $self = shift;
3770   my $opt = ref($_[0]) ? shift : { @_ };
3771
3772   #return $self->num_cust_statement unless wantarray || keys %$opt;
3773
3774   $opt->{'table'} = 'cust_pay_batch';
3775   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3776   $opt->{'hashref'}{'custnum'} = $self->custnum;
3777   $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3778
3779   map { $_ } #behavior of sort undefined in scalar context
3780     sort { $a->paybatchnum <=> $b->paybatchnum }
3781       qsearch($opt);
3782 }
3783
3784 =item cust_pay_pending
3785
3786 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3787 (without status "done").
3788
3789 =cut
3790
3791 sub cust_pay_pending {
3792   my $self = shift;
3793   return $self->num_cust_pay_pending unless wantarray;
3794   sort { $a->_date <=> $b->_date }
3795     qsearch( 'cust_pay_pending', {
3796                                    'custnum' => $self->custnum,
3797                                    'status'  => { op=>'!=', value=>'done' },
3798                                  },
3799            );
3800 }
3801
3802 =item cust_pay_pending_attempt
3803
3804 Returns all payment attempts / declined payments for this customer, as pending
3805 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3806 a corresponding payment (see L<FS::cust_pay>).
3807
3808 =cut
3809
3810 sub cust_pay_pending_attempt {
3811   my $self = shift;
3812   return $self->num_cust_pay_pending_attempt unless wantarray;
3813   sort { $a->_date <=> $b->_date }
3814     qsearch( 'cust_pay_pending', {
3815                                    'custnum' => $self->custnum,
3816                                    'status'  => 'done',
3817                                    'paynum'  => '',
3818                                  },
3819            );
3820 }
3821
3822 =item num_cust_pay_pending
3823
3824 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3825 customer (without status "done").  Also called automatically when the
3826 cust_pay_pending method is used in a scalar context.
3827
3828 =cut
3829
3830 sub num_cust_pay_pending {
3831   my $self = shift;
3832   $self->scalar_sql(
3833     " SELECT COUNT(*) FROM cust_pay_pending ".
3834       " WHERE custnum = ? AND status != 'done' ",
3835     $self->custnum
3836   );
3837 }
3838
3839 =item num_cust_pay_pending_attempt
3840
3841 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3842 customer, with status "done" but without a corresp.  Also called automatically when the
3843 cust_pay_pending method is used in a scalar context.
3844
3845 =cut
3846
3847 sub num_cust_pay_pending_attempt {
3848   my $self = shift;
3849   $self->scalar_sql(
3850     " SELECT COUNT(*) FROM cust_pay_pending ".
3851       " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3852     $self->custnum
3853   );
3854 }
3855
3856 =item cust_refund
3857
3858 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3859
3860 =cut
3861
3862 sub cust_refund {
3863   my $self = shift;
3864   map { $_ } #return $self->num_cust_refund unless wantarray;
3865   sort { $a->_date <=> $b->_date }
3866     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3867 }
3868
3869 =item display_custnum
3870
3871 Returns the displayed customer number for this customer: agent_custid if
3872 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3873
3874 =cut
3875
3876 sub display_custnum {
3877   my $self = shift;
3878   if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3879     return $self->agent_custid;
3880   } elsif ( $conf->config('cust_main-custnum-display_prefix') ) {
3881     return $conf->config('cust_main-custnum-display_prefix').
3882            sprintf('%08d', $self->custnum)
3883   } else {
3884     return $self->custnum;
3885   }
3886 }
3887
3888 =item name
3889
3890 Returns a name string for this customer, either "Company (Last, First)" or
3891 "Last, First".
3892
3893 =cut
3894
3895 sub name {
3896   my $self = shift;
3897   my $name = $self->contact;
3898   $name = $self->company. " ($name)" if $self->company;
3899   $name;
3900 }
3901
3902 =item ship_name
3903
3904 Returns a name string for this (service/shipping) contact, either
3905 "Company (Last, First)" or "Last, First".
3906
3907 =cut
3908
3909 sub ship_name {
3910   my $self = shift;
3911   if ( $self->get('ship_last') ) {
3912     my $name = $self->ship_contact;
3913     $name = $self->ship_company. " ($name)" if $self->ship_company;
3914     $name;
3915   } else {
3916     $self->name;
3917   }
3918 }
3919
3920 =item name_short
3921
3922 Returns a name string for this customer, either "Company" or "First Last".
3923
3924 =cut
3925
3926 sub name_short {
3927   my $self = shift;
3928   $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3929 }
3930
3931 =item ship_name_short
3932
3933 Returns a name string for this (service/shipping) contact, either "Company"
3934 or "First Last".
3935
3936 =cut
3937
3938 sub ship_name_short {
3939   my $self = shift;
3940   if ( $self->get('ship_last') ) {
3941     $self->ship_company !~ /^\s*$/
3942       ? $self->ship_company
3943       : $self->ship_contact_firstlast;
3944   } else {
3945     $self->name_company_or_firstlast;
3946   }
3947 }
3948
3949 =item contact
3950
3951 Returns this customer's full (billing) contact name only, "Last, First"
3952
3953 =cut
3954
3955 sub contact {
3956   my $self = shift;
3957   $self->get('last'). ', '. $self->first;
3958 }
3959
3960 =item ship_contact
3961
3962 Returns this customer's full (shipping) contact name only, "Last, First"
3963
3964 =cut
3965
3966 sub ship_contact {
3967   my $self = shift;
3968   $self->get('ship_last')
3969     ? $self->get('ship_last'). ', '. $self->ship_first
3970     : $self->contact;
3971 }
3972
3973 =item contact_firstlast
3974
3975 Returns this customers full (billing) contact name only, "First Last".
3976
3977 =cut
3978
3979 sub contact_firstlast {
3980   my $self = shift;
3981   $self->first. ' '. $self->get('last');
3982 }
3983
3984 =item ship_contact_firstlast
3985
3986 Returns this customer's full (shipping) contact name only, "First Last".
3987
3988 =cut
3989
3990 sub ship_contact_firstlast {
3991   my $self = shift;
3992   $self->get('ship_last')
3993     ? $self->first. ' '. $self->get('ship_last')
3994     : $self->contact_firstlast;
3995 }
3996
3997 =item country_full
3998
3999 Returns this customer's full country name
4000
4001 =cut
4002
4003 sub country_full {
4004   my $self = shift;
4005   code2country($self->country);
4006 }
4007
4008 =item geocode DATA_VENDOR
4009
4010 Returns a value for the customer location as encoded by DATA_VENDOR.
4011 Currently this only makes sense for "CCH" as DATA_VENDOR.
4012
4013 =cut
4014
4015 =item cust_status
4016
4017 =item status
4018
4019 Returns a status string for this customer, currently:
4020
4021 =over 4
4022
4023 =item prospect - No packages have ever been ordered
4024
4025 =item ordered - Recurring packages all are new (not yet billed).
4026
4027 =item active - One or more recurring packages is active
4028
4029 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
4030
4031 =item suspended - All non-cancelled recurring packages are suspended
4032
4033 =item cancelled - All recurring packages are cancelled
4034
4035 =back
4036
4037 Behavior of inactive vs. cancelled edge cases can be adjusted with the
4038 cust_main-status_module configuration option.
4039
4040 =cut
4041
4042 sub status { shift->cust_status(@_); }
4043
4044 sub cust_status {
4045   my $self = shift;
4046   for my $status ( FS::cust_main->statuses() ) {
4047     my $method = $status.'_sql';
4048     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
4049     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
4050     $sth->execute( ($self->custnum) x $numnum )
4051       or die "Error executing 'SELECT $sql': ". $sth->errstr;
4052     return $status if $sth->fetchrow_arrayref->[0];
4053   }
4054 }
4055
4056 =item ucfirst_cust_status
4057
4058 =item ucfirst_status
4059
4060 Returns the status with the first character capitalized.
4061
4062 =cut
4063
4064 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
4065
4066 sub ucfirst_cust_status {
4067   my $self = shift;
4068   ucfirst($self->cust_status);
4069 }
4070
4071 =item statuscolor
4072
4073 Returns a hex triplet color string for this customer's status.
4074
4075 =cut
4076
4077 sub statuscolor { shift->cust_statuscolor(@_); }
4078
4079 sub cust_statuscolor {
4080   my $self = shift;
4081   __PACKAGE__->statuscolors->{$self->cust_status};
4082 }
4083
4084 =item tickets
4085
4086 Returns an array of hashes representing the customer's RT tickets.
4087
4088 =cut
4089
4090 sub tickets {
4091   my $self = shift;
4092
4093   my $num = $conf->config('cust_main-max_tickets') || 10;
4094   my @tickets = ();
4095
4096   if ( $conf->config('ticket_system') ) {
4097     unless ( $conf->config('ticket_system-custom_priority_field') ) {
4098
4099       @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
4100
4101     } else {
4102
4103       foreach my $priority (
4104         $conf->config('ticket_system-custom_priority_field-values'), ''
4105       ) {
4106         last if scalar(@tickets) >= $num;
4107         push @tickets,
4108           @{ FS::TicketSystem->customer_tickets( $self->custnum,
4109                                                  $num - scalar(@tickets),
4110                                                  $priority,
4111                                                )
4112            };
4113       }
4114     }
4115   }
4116   (@tickets);
4117 }
4118
4119 # Return services representing svc_accts in customer support packages
4120 sub support_services {
4121   my $self = shift;
4122   my %packages = map { $_ => 1 } $conf->config('support_packages');
4123
4124   grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
4125     grep { $_->part_svc->svcdb eq 'svc_acct' }
4126     map { $_->cust_svc }
4127     grep { exists $packages{ $_->pkgpart } }
4128     $self->ncancelled_pkgs;
4129
4130 }
4131
4132 # Return a list of latitude/longitude for one of the services (if any)
4133 sub service_coordinates {
4134   my $self = shift;
4135
4136   my @svc_X =
4137     grep { $_->latitude && $_->longitude }
4138     map { $_->svc_x }
4139     map { $_->cust_svc }
4140     $self->ncancelled_pkgs;
4141
4142   scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
4143 }
4144
4145 =item masked FIELD
4146
4147 Returns a masked version of the named field
4148
4149 =cut
4150
4151 sub masked {
4152 my ($self,$field) = @_;
4153
4154 # Show last four
4155
4156 'x'x(length($self->getfield($field))-4).
4157   substr($self->getfield($field), (length($self->getfield($field))-4));
4158
4159 }
4160
4161 =back
4162
4163 =head1 CLASS METHODS
4164
4165 =over 4
4166
4167 =item statuses
4168
4169 Class method that returns the list of possible status strings for customers
4170 (see L<the status method|/status>).  For example:
4171
4172   @statuses = FS::cust_main->statuses();
4173
4174 =cut
4175
4176 sub statuses {
4177   my $self = shift;
4178   keys %{ $self->statuscolors };
4179 }
4180
4181 =item cust_status_sql
4182
4183 Returns an SQL fragment to determine the status of a cust_main record, as a
4184 string.
4185
4186 =cut
4187
4188 sub cust_status_sql {
4189   my $sql = 'CASE';
4190   for my $status ( FS::cust_main->statuses() ) {
4191     my $method = $status.'_sql';
4192     $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
4193   }
4194   $sql .= ' END';
4195   return $sql;
4196 }
4197
4198
4199 =item prospect_sql
4200
4201 Returns an SQL expression identifying prospective cust_main records (customers
4202 with no packages ever ordered)
4203
4204 =cut
4205
4206 use vars qw($select_count_pkgs);
4207 $select_count_pkgs =
4208   "SELECT COUNT(*) FROM cust_pkg
4209     WHERE cust_pkg.custnum = cust_main.custnum";
4210
4211 sub select_count_pkgs_sql {
4212   $select_count_pkgs;
4213 }
4214
4215 sub prospect_sql {
4216   " 0 = ( $select_count_pkgs ) ";
4217 }
4218
4219 =item ordered_sql
4220
4221 Returns an SQL expression identifying ordered cust_main records (customers with
4222 no active packages, but recurring packages not yet setup or one time charges
4223 not yet billed).
4224
4225 =cut
4226
4227 sub ordered_sql {
4228   FS::cust_main->none_active_sql.
4229   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4230 }
4231
4232 =item active_sql
4233
4234 Returns an SQL expression identifying active cust_main records (customers with
4235 active recurring packages).
4236
4237 =cut
4238
4239 sub active_sql {
4240   " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4241 }
4242
4243 =item none_active_sql
4244
4245 Returns an SQL expression identifying cust_main records with no active
4246 recurring packages.  This includes customers of status prospect, ordered,
4247 inactive, and suspended.
4248
4249 =cut
4250
4251 sub none_active_sql {
4252   " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4253 }
4254
4255 =item inactive_sql
4256
4257 Returns an SQL expression identifying inactive cust_main records (customers with
4258 no active recurring packages, but otherwise unsuspended/uncancelled).
4259
4260 =cut
4261
4262 sub inactive_sql {
4263   FS::cust_main->none_active_sql.
4264   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4265 }
4266
4267 =item susp_sql
4268 =item suspended_sql
4269
4270 Returns an SQL expression identifying suspended cust_main records.
4271
4272 =cut
4273
4274
4275 sub suspended_sql { susp_sql(@_); }
4276 sub susp_sql {
4277   FS::cust_main->none_active_sql.
4278   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4279 }
4280
4281 =item cancel_sql
4282 =item cancelled_sql
4283
4284 Returns an SQL expression identifying cancelled cust_main records.
4285
4286 =cut
4287
4288 sub cancel_sql { shift->cancelled_sql(@_); }
4289
4290 =item uncancel_sql
4291 =item uncancelled_sql
4292
4293 Returns an SQL expression identifying un-cancelled cust_main records.
4294
4295 =cut
4296
4297 sub uncancelled_sql { uncancel_sql(@_); }
4298 sub uncancel_sql { "
4299   ( 0 < ( $select_count_pkgs
4300                    AND ( cust_pkg.cancel IS NULL
4301                          OR cust_pkg.cancel = 0
4302                        )
4303         )
4304     OR 0 = ( $select_count_pkgs )
4305   )
4306 "; }
4307
4308 =item balance_sql
4309
4310 Returns an SQL fragment to retreive the balance.
4311
4312 =cut
4313
4314 sub balance_sql { "
4315     ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4316         WHERE cust_bill.custnum   = cust_main.custnum     )
4317   - ( SELECT COALESCE( SUM(paid),    0 ) FROM cust_pay
4318         WHERE cust_pay.custnum    = cust_main.custnum     )
4319   - ( SELECT COALESCE( SUM(amount),  0 ) FROM cust_credit
4320         WHERE cust_credit.custnum = cust_main.custnum     )
4321   + ( SELECT COALESCE( SUM(refund),  0 ) FROM cust_refund
4322         WHERE cust_refund.custnum = cust_main.custnum     )
4323 "; }
4324
4325 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4326
4327 Returns an SQL fragment to retreive the balance for this customer, optionally
4328 considering invoices with date earlier than START_TIME, and not
4329 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4330 total_unapplied_payments).
4331
4332 Times are specified as SQL fragments or numeric
4333 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
4334 L<Date::Parse> for conversion functions.  The empty string can be passed
4335 to disable that time constraint completely.
4336
4337 Available options are:
4338
4339 =over 4
4340
4341 =item unapplied_date
4342
4343 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)
4344
4345 =item total
4346
4347 (unused.  obsolete?)
4348 set to true to remove all customer comparison clauses, for totals
4349
4350 =item where
4351
4352 (unused.  obsolete?)
4353 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4354
4355 =item join
4356
4357 (unused.  obsolete?)
4358 JOIN clause (typically used with the total option)
4359
4360 =item cutoff
4361
4362 An absolute cutoff time.  Payments, credits, and refunds I<applied> after this
4363 time will be ignored.  Note that START_TIME and END_TIME only limit the date
4364 range for invoices and I<unapplied> payments, credits, and refunds.
4365
4366 =back
4367
4368 =cut
4369
4370 sub balance_date_sql {
4371   my( $class, $start, $end, %opt ) = @_;
4372
4373   my $cutoff = $opt{'cutoff'};
4374
4375   my $owed         = FS::cust_bill->owed_sql($cutoff);
4376   my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4377   my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4378   my $unapp_pay    = FS::cust_pay->unapplied_sql($cutoff);
4379
4380   my $j = $opt{'join'} || '';
4381
4382   my $owed_wh   = $class->_money_table_where( 'cust_bill',   $start,$end,%opt );
4383   my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4384   my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4385   my $pay_wh    = $class->_money_table_where( 'cust_pay',    $start,$end,%opt );
4386
4387   "   ( SELECT COALESCE(SUM($owed),         0) FROM cust_bill   $j $owed_wh   )
4388     + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4389     - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4390     - ( SELECT COALESCE(SUM($unapp_pay),    0) FROM cust_pay    $j $pay_wh    )
4391   ";
4392
4393 }
4394
4395 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4396
4397 Returns an SQL fragment to retreive the total unapplied payments for this
4398 customer, only considering payments with date earlier than START_TIME, and
4399 optionally not later than END_TIME.
4400
4401 Times are specified as SQL fragments or numeric
4402 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
4403 L<Date::Parse> for conversion functions.  The empty string can be passed
4404 to disable that time constraint completely.
4405
4406 Available options are:
4407
4408 =cut
4409
4410 sub unapplied_payments_date_sql {
4411   my( $class, $start, $end, %opt ) = @_;
4412
4413   my $cutoff = $opt{'cutoff'};
4414
4415   my $unapp_pay    = FS::cust_pay->unapplied_sql($cutoff);
4416
4417   my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4418                                                           'unapplied_date'=>1 );
4419
4420   " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4421 }
4422
4423 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4424
4425 Helper method for balance_date_sql; name (and usage) subject to change
4426 (suggestions welcome).
4427
4428 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4429 cust_refund, cust_credit or cust_pay).
4430
4431 If TABLE is "cust_bill" or the unapplied_date option is true, only
4432 considers records with date earlier than START_TIME, and optionally not
4433 later than END_TIME .
4434
4435 =cut
4436
4437 sub _money_table_where {
4438   my( $class, $table, $start, $end, %opt ) = @_;
4439
4440   my @where = ();
4441   push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4442   if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4443     push @where, "$table._date <= $start" if defined($start) && length($start);
4444     push @where, "$table._date >  $end"   if defined($end)   && length($end);
4445   }
4446   push @where, @{$opt{'where'}} if $opt{'where'};
4447   my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4448
4449   $where;
4450
4451 }
4452
4453 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4454 use FS::cust_main::Search;
4455 sub search {
4456   my $class = shift;
4457   FS::cust_main::Search->search(@_);
4458 }
4459
4460 =back
4461
4462 =head1 SUBROUTINES
4463
4464 =over 4
4465
4466 =item batch_charge
4467
4468 =cut
4469
4470 sub batch_charge {
4471   my $param = shift;
4472   #warn join('-',keys %$param);
4473   my $fh = $param->{filehandle};
4474   my $agentnum = $param->{agentnum};
4475   my $format = $param->{format};
4476
4477   my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4478
4479   my @fields;
4480   if ( $format eq 'simple' ) {
4481     @fields = qw( custnum agent_custid amount pkg );
4482   } else {
4483     die "unknown format $format";
4484   }
4485
4486   eval "use Text::CSV_XS;";
4487   die $@ if $@;
4488
4489   my $csv = new Text::CSV_XS;
4490   #warn $csv;
4491   #warn $fh;
4492
4493   my $imported = 0;
4494   #my $columns;
4495
4496   local $SIG{HUP} = 'IGNORE';
4497   local $SIG{INT} = 'IGNORE';
4498   local $SIG{QUIT} = 'IGNORE';
4499   local $SIG{TERM} = 'IGNORE';
4500   local $SIG{TSTP} = 'IGNORE';
4501   local $SIG{PIPE} = 'IGNORE';
4502
4503   my $oldAutoCommit = $FS::UID::AutoCommit;
4504   local $FS::UID::AutoCommit = 0;
4505   my $dbh = dbh;
4506
4507   #while ( $columns = $csv->getline($fh) ) {
4508   my $line;
4509   while ( defined($line=<$fh>) ) {
4510
4511     $csv->parse($line) or do {
4512       $dbh->rollback if $oldAutoCommit;
4513       return "can't parse: ". $csv->error_input();
4514     };
4515
4516     my @columns = $csv->fields();
4517     #warn join('-',@columns);
4518
4519     my %row = ();
4520     foreach my $field ( @fields ) {
4521       $row{$field} = shift @columns;
4522     }
4523
4524     if ( $row{custnum} && $row{agent_custid} ) {
4525       dbh->rollback if $oldAutoCommit;
4526       return "can't specify custnum with agent_custid $row{agent_custid}";
4527     }
4528
4529     my %hash = ();
4530     if ( $row{agent_custid} && $agentnum ) {
4531       %hash = ( 'agent_custid' => $row{agent_custid},
4532                 'agentnum'     => $agentnum,
4533               );
4534     }
4535
4536     if ( $row{custnum} ) {
4537       %hash = ( 'custnum' => $row{custnum} );
4538     }
4539
4540     unless ( scalar(keys %hash) ) {
4541       $dbh->rollback if $oldAutoCommit;
4542       return "can't find customer without custnum or agent_custid and agentnum";
4543     }
4544
4545     my $cust_main = qsearchs('cust_main', { %hash } );
4546     unless ( $cust_main ) {
4547       $dbh->rollback if $oldAutoCommit;
4548       my $custnum = $row{custnum} || $row{agent_custid};
4549       return "unknown custnum $custnum";
4550     }
4551
4552     if ( $row{'amount'} > 0 ) {
4553       my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4554       if ( $error ) {
4555         $dbh->rollback if $oldAutoCommit;
4556         return $error;
4557       }
4558       $imported++;
4559     } elsif ( $row{'amount'} < 0 ) {
4560       my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4561                                       $row{'pkg'}                         );
4562       if ( $error ) {
4563         $dbh->rollback if $oldAutoCommit;
4564         return $error;
4565       }
4566       $imported++;
4567     } else {
4568       #hmm?
4569     }
4570
4571   }
4572
4573   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4574
4575   return "Empty file!" unless $imported;
4576
4577   ''; #no error
4578
4579 }
4580
4581 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4582
4583 Deprecated.  Use event notification and message templates
4584 (L<FS::msg_template>) instead.
4585
4586 Sends a templated email notification to the customer (see L<Text::Template>).
4587
4588 OPTIONS is a hash and may include
4589
4590 I<from> - the email sender (default is invoice_from)
4591
4592 I<to> - comma-separated scalar or arrayref of recipients
4593    (default is invoicing_list)
4594
4595 I<subject> - The subject line of the sent email notification
4596    (default is "Notice from company_name")
4597
4598 I<extra_fields> - a hashref of name/value pairs which will be substituted
4599    into the template
4600
4601 The following variables are vavailable in the template.
4602
4603 I<$first> - the customer first name
4604 I<$last> - the customer last name
4605 I<$company> - the customer company
4606 I<$payby> - a description of the method of payment for the customer
4607             # would be nice to use FS::payby::shortname
4608 I<$payinfo> - the account information used to collect for this customer
4609 I<$expdate> - the expiration of the customer payment in seconds from epoch
4610
4611 =cut
4612
4613 sub notify {
4614   my ($self, $template, %options) = @_;
4615
4616   return unless $conf->exists($template);
4617
4618   my $from = $conf->config('invoice_from', $self->agentnum)
4619     if $conf->exists('invoice_from', $self->agentnum);
4620   $from = $options{from} if exists($options{from});
4621
4622   my $to = join(',', $self->invoicing_list_emailonly);
4623   $to = $options{to} if exists($options{to});
4624
4625   my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4626     if $conf->exists('company_name', $self->agentnum);
4627   $subject = $options{subject} if exists($options{subject});
4628
4629   my $notify_template = new Text::Template (TYPE => 'ARRAY',
4630                                             SOURCE => [ map "$_\n",
4631                                               $conf->config($template)]
4632                                            )
4633     or die "can't create new Text::Template object: Text::Template::ERROR";
4634   $notify_template->compile()
4635     or die "can't compile template: Text::Template::ERROR";
4636
4637   $FS::notify_template::_template::company_name =
4638     $conf->config('company_name', $self->agentnum);
4639   $FS::notify_template::_template::company_address =
4640     join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4641
4642   my $paydate = $self->paydate || '2037-12-31';
4643   $FS::notify_template::_template::first = $self->first;
4644   $FS::notify_template::_template::last = $self->last;
4645   $FS::notify_template::_template::company = $self->company;
4646   $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4647   my $payby = $self->payby;
4648   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4649   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4650
4651   #credit cards expire at the end of the month/year of their exp date
4652   if ($payby eq 'CARD' || $payby eq 'DCRD') {
4653     $FS::notify_template::_template::payby = 'credit card';
4654     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4655     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4656     $expire_time--;
4657   }elsif ($payby eq 'COMP') {
4658     $FS::notify_template::_template::payby = 'complimentary account';
4659   }else{
4660     $FS::notify_template::_template::payby = 'current method';
4661   }
4662   $FS::notify_template::_template::expdate = $expire_time;
4663
4664   for (keys %{$options{extra_fields}}){
4665     no strict "refs";
4666     ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4667   }
4668
4669   send_email(from => $from,
4670              to => $to,
4671              subject => $subject,
4672              body => $notify_template->fill_in( PACKAGE =>
4673                                                 'FS::notify_template::_template'                                              ),
4674             );
4675
4676 }
4677
4678 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4679
4680 Generates a templated notification to the customer (see L<Text::Template>).
4681
4682 OPTIONS is a hash and may include
4683
4684 I<extra_fields> - a hashref of name/value pairs which will be substituted
4685    into the template.  These values may override values mentioned below
4686    and those from the customer record.
4687
4688 The following variables are available in the template instead of or in addition
4689 to the fields of the customer record.
4690
4691 I<$payby> - a description of the method of payment for the customer
4692             # would be nice to use FS::payby::shortname
4693 I<$payinfo> - the masked account information used to collect for this customer
4694 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4695 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4696
4697 =cut
4698
4699 # a lot like cust_bill::print_latex
4700 sub generate_letter {
4701   my ($self, $template, %options) = @_;
4702
4703   return unless $conf->exists($template);
4704
4705   my $letter_template = new Text::Template
4706                         ( TYPE       => 'ARRAY',
4707                           SOURCE     => [ map "$_\n", $conf->config($template)],
4708                           DELIMITERS => [ '[@--', '--@]' ],
4709                         )
4710     or die "can't create new Text::Template object: Text::Template::ERROR";
4711
4712   $letter_template->compile()
4713     or die "can't compile template: Text::Template::ERROR";
4714
4715   my %letter_data = map { $_ => $self->$_ } $self->fields;
4716   $letter_data{payinfo} = $self->mask_payinfo;
4717
4718   #my $paydate = $self->paydate || '2037-12-31';
4719   my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4720
4721   my $payby = $self->payby;
4722   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4723   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4724
4725   #credit cards expire at the end of the month/year of their exp date
4726   if ($payby eq 'CARD' || $payby eq 'DCRD') {
4727     $letter_data{payby} = 'credit card';
4728     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4729     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4730     $expire_time--;
4731   }elsif ($payby eq 'COMP') {
4732     $letter_data{payby} = 'complimentary account';
4733   }else{
4734     $letter_data{payby} = 'current method';
4735   }
4736   $letter_data{expdate} = $expire_time;
4737
4738   for (keys %{$options{extra_fields}}){
4739     $letter_data{$_} = $options{extra_fields}->{$_};
4740   }
4741
4742   unless(exists($letter_data{returnaddress})){
4743     my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4744                                                   $self->agent_template)
4745                      );
4746     if ( length($retadd) ) {
4747       $letter_data{returnaddress} = $retadd;
4748     } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4749       $letter_data{returnaddress} =
4750         join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4751                           s/$/\\\\\*/;
4752                           $_;
4753                         }
4754                     ( $conf->config('company_name', $self->agentnum),
4755                       $conf->config('company_address', $self->agentnum),
4756                     )
4757         );
4758     } else {
4759       $letter_data{returnaddress} = '~';
4760     }
4761   }
4762
4763   $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4764
4765   $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4766
4767   my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4768
4769   my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4770                            DIR      => $dir,
4771                            SUFFIX   => '.eps',
4772                            UNLINK   => 0,
4773                          ) or die "can't open temp file: $!\n";
4774   print $lh $conf->config_binary('logo.eps', $self->agentnum)
4775     or die "can't write temp file: $!\n";
4776   close $lh;
4777   $letter_data{'logo_file'} = $lh->filename;
4778
4779   my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4780                            DIR      => $dir,
4781                            SUFFIX   => '.tex',
4782                            UNLINK   => 0,
4783                          ) or die "can't open temp file: $!\n";
4784
4785   $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4786   close $fh;
4787   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4788   return ($1, $letter_data{'logo_file'});
4789
4790 }
4791
4792 =item print_ps TEMPLATE
4793
4794 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4795
4796 =cut
4797
4798 sub print_ps {
4799   my $self = shift;
4800   my($file, $lfile) = $self->generate_letter(@_);
4801   my $ps = FS::Misc::generate_ps($file);
4802   unlink($file.'.tex');
4803   unlink($lfile);
4804
4805   $ps;
4806 }
4807
4808 =item print TEMPLATE
4809
4810 Prints the filled in template.
4811
4812 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4813
4814 =cut
4815
4816 sub queueable_print {
4817   my %opt = @_;
4818
4819   my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4820     or die "invalid customer number: " . $opt{custvnum};
4821
4822   my $error = $self->print( $opt{template} );
4823   die $error if $error;
4824 }
4825
4826 sub print {
4827   my ($self, $template) = (shift, shift);
4828   do_print [ $self->print_ps($template) ];
4829 }
4830
4831 #these three subs should just go away once agent stuff is all config overrides
4832
4833 sub agent_template {
4834   my $self = shift;
4835   $self->_agent_plandata('agent_templatename');
4836 }
4837
4838 sub agent_invoice_from {
4839   my $self = shift;
4840   $self->_agent_plandata('agent_invoice_from');
4841 }
4842
4843 sub _agent_plandata {
4844   my( $self, $option ) = @_;
4845
4846   #yuck.  this whole thing needs to be reconciled better with 1.9's idea of
4847   #agent-specific Conf
4848
4849   use FS::part_event::Condition;
4850
4851   my $agentnum = $self->agentnum;
4852
4853   my $regexp = regexp_sql();
4854
4855   my $part_event_option =
4856     qsearchs({
4857       'select'    => 'part_event_option.*',
4858       'table'     => 'part_event_option',
4859       'addl_from' => q{
4860         LEFT JOIN part_event USING ( eventpart )
4861         LEFT JOIN part_event_option AS peo_agentnum
4862           ON ( part_event.eventpart = peo_agentnum.eventpart
4863                AND peo_agentnum.optionname = 'agentnum'
4864                AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4865              )
4866         LEFT JOIN part_event_condition
4867           ON ( part_event.eventpart = part_event_condition.eventpart
4868                AND part_event_condition.conditionname = 'cust_bill_age'
4869              )
4870         LEFT JOIN part_event_condition_option
4871           ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4872                AND part_event_condition_option.optionname = 'age'
4873              )
4874       },
4875       #'hashref'   => { 'optionname' => $option },
4876       #'hashref'   => { 'part_event_option.optionname' => $option },
4877       'extra_sql' =>
4878         " WHERE part_event_option.optionname = ". dbh->quote($option).
4879         " AND action = 'cust_bill_send_agent' ".
4880         " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4881         " AND peo_agentnum.optionname = 'agentnum' ".
4882         " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4883         " ORDER BY
4884            CASE WHEN part_event_condition_option.optionname IS NULL
4885            THEN -1
4886            ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4887         " END
4888           , part_event.weight".
4889         " LIMIT 1"
4890     });
4891
4892   unless ( $part_event_option ) {
4893     return $self->agent->invoice_template || ''
4894       if $option eq 'agent_templatename';
4895     return '';
4896   }
4897
4898   $part_event_option->optionvalue;
4899
4900 }
4901
4902 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4903
4904 Subroutine (not a method), designed to be called from the queue.
4905
4906 Takes a list of options and values.
4907
4908 Pulls up the customer record via the custnum option and calls bill_and_collect.
4909
4910 =cut
4911
4912 sub queued_bill {
4913   my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
4914
4915   my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
4916   warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
4917
4918   $cust_main->bill_and_collect( %args );
4919 }
4920
4921 sub process_bill_and_collect {
4922   my $job = shift;
4923   my $param = thaw(decode_base64(shift));
4924   my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
4925       or die "custnum '$param->{custnum}' not found!\n";
4926   $param->{'job'}   = $job;
4927   $param->{'fatal'} = 1; # runs from job queue, will be caught
4928   $param->{'retry'} = 1;
4929
4930   $cust_main->bill_and_collect( %$param );
4931 }
4932
4933 =item process_censustract_update CUSTNUM
4934
4935 Queueable function to update the census tract to the current year (as set in
4936 the 'census_year' configuration variable) and retrieve the new tract code.
4937
4938 =cut
4939
4940 sub process_censustract_update {
4941   eval "use FS::Misc::Geo qw(get_censustract)";
4942   die $@ if $@;
4943   my $custnum = shift;
4944   my $cust_main = qsearchs( 'cust_main', { custnum => $custnum })
4945       or die "custnum '$custnum' not found!\n";
4946
4947   my $new_year = $conf->config('census_year') or return;
4948   my $new_tract = get_censustract({ $cust_main->location_hash }, $new_year);
4949   if ( $new_tract =~ /^\d/ ) {
4950     # then it's a tract code
4951         $cust_main->set('censustract', $new_tract);
4952     $cust_main->set('censusyear',  $new_year);
4953     my $error = $cust_main->replace;
4954     die $error if $error;
4955   }
4956   else {
4957     # it's an error message
4958     die $new_tract;
4959   }
4960   return;
4961 }
4962
4963 sub _upgrade_data { #class method
4964   my ($class, %opts) = @_;
4965
4966   my @statements = (
4967     'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
4968     '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',
4969   );
4970   # fix yyyy-m-dd formatted paydates
4971   if ( driver_name =~ /^mysql$/i ) {
4972     push @statements,
4973     "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
4974   }
4975   else { # the SQL standard
4976     push @statements,
4977     "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
4978   }
4979
4980   foreach my $sql ( @statements ) {
4981     my $sth = dbh->prepare($sql) or die dbh->errstr;
4982     $sth->execute or die $sth->errstr;
4983   }
4984
4985   local($ignore_expired_card) = 1;
4986   local($ignore_illegal_zip) = 1;
4987   local($ignore_banned_card) = 1;
4988   local($skip_fuzzyfiles) = 1;
4989   local($import) = 1; #prevent automatic geocoding (need its own variable?)
4990   $class->_upgrade_otaker(%opts);
4991
4992 }
4993
4994 =back
4995
4996 =head1 BUGS
4997
4998 The delete method.
4999
5000 The delete method should possibly take an FS::cust_main object reference
5001 instead of a scalar customer number.
5002
5003 Bill and collect options should probably be passed as references instead of a
5004 list.
5005
5006 There should probably be a configuration file with a list of allowed credit
5007 card types.
5008
5009 No multiple currency support (probably a larger project than just this module).
5010
5011 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
5012
5013 Birthdates rely on negative epoch values.
5014
5015 The payby for card/check batches is broken.  With mixed batching, bad
5016 things will happen.
5017
5018 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
5019
5020 =head1 SEE ALSO
5021
5022 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
5023 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
5024 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
5025
5026 =cut
5027
5028 1;
5029