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