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