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,$orderby_classnum) = (shift,shift);
2215   my $orderby = "_DATE DESC";
2216   $orderby = "CLASSNUM ASC, $orderby" if $orderby_classnum;
2217   qsearch( 'cust_main_note',
2218            { 'custnum' => $self->custnum },
2219            '',
2220            "ORDER BY $orderby",
2221          );
2222 }
2223
2224 =item agent
2225
2226 Returns the agent (see L<FS::agent>) for this customer.
2227
2228 =cut
2229
2230 sub agent {
2231   my $self = shift;
2232   qsearchs( 'agent', { 'agentnum' => $self->agentnum } );
2233 }
2234
2235 =item agent_name
2236
2237 Returns the agent name (see L<FS::agent>) for this customer.
2238
2239 =cut
2240
2241 sub agent_name {
2242   my $self = shift;
2243   $self->agent->agent;
2244 }
2245
2246 =item cust_tag
2247
2248 Returns any tags associated with this customer, as FS::cust_tag objects,
2249 or an empty list if there are no tags.
2250
2251 =cut
2252
2253 sub cust_tag {
2254   my $self = shift;
2255   qsearch('cust_tag', { 'custnum' => $self->custnum } );
2256 }
2257
2258 =item part_tag
2259
2260 Returns any tags associated with this customer, as FS::part_tag objects,
2261 or an empty list if there are no tags.
2262
2263 =cut
2264
2265 sub part_tag {
2266   my $self = shift;
2267   map $_->part_tag, $self->cust_tag;
2268 }
2269
2270
2271 =item cust_class
2272
2273 Returns the customer class, as an FS::cust_class object, or the empty string
2274 if there is no customer class.
2275
2276 =cut
2277
2278 sub cust_class {
2279   my $self = shift;
2280   if ( $self->classnum ) {
2281     qsearchs('cust_class', { 'classnum' => $self->classnum } );
2282   } else {
2283     return '';
2284   }
2285 }
2286
2287 =item categoryname
2288
2289 Returns the customer category name, or the empty string if there is no customer
2290 category.
2291
2292 =cut
2293
2294 sub categoryname {
2295   my $self = shift;
2296   my $cust_class = $self->cust_class;
2297   $cust_class
2298     ? $cust_class->categoryname
2299     : '';
2300 }
2301
2302 =item classname
2303
2304 Returns the customer class name, or the empty string if there is no customer
2305 class.
2306
2307 =cut
2308
2309 sub classname {
2310   my $self = shift;
2311   my $cust_class = $self->cust_class;
2312   $cust_class
2313     ? $cust_class->classname
2314     : '';
2315 }
2316
2317 =item BILLING METHODS
2318
2319 Documentation on billing methods has been moved to
2320 L<FS::cust_main::Billing>.
2321
2322 =item REALTIME BILLING METHODS
2323
2324 Documentation on realtime billing methods has been moved to
2325 L<FS::cust_main::Billing_Realtime>.
2326
2327 =item remove_cvv
2328
2329 Removes the I<paycvv> field from the database directly.
2330
2331 If there is an error, returns the error, otherwise returns false.
2332
2333 =cut
2334
2335 sub remove_cvv {
2336   my $self = shift;
2337   my $sth = dbh->prepare("UPDATE cust_main SET paycvv = '' WHERE custnum = ?")
2338     or return dbh->errstr;
2339   $sth->execute($self->custnum)
2340     or return $sth->errstr;
2341   $self->paycvv('');
2342   '';
2343 }
2344
2345 =item batch_card OPTION => VALUE...
2346
2347 Adds a payment for this invoice to the pending credit card batch (see
2348 L<FS::cust_pay_batch>), or, if the B<realtime> option is set to a true value,
2349 runs the payment using a realtime gateway.
2350
2351 =cut
2352
2353 sub batch_card {
2354   my ($self, %options) = @_;
2355
2356   my $amount;
2357   if (exists($options{amount})) {
2358     $amount = $options{amount};
2359   }else{
2360     $amount = sprintf("%.2f", $self->balance - $self->in_transit_payments);
2361   }
2362   return '' unless $amount > 0;
2363
2364   my $invnum = delete $options{invnum};
2365   my $payby = $options{payby} || $self->payby;  #still dubious
2366
2367   if ($options{'realtime'}) {
2368     return $self->realtime_bop( FS::payby->payby2bop($self->payby),
2369                                 $amount,
2370                                 %options,
2371                               );
2372   }
2373
2374   my $oldAutoCommit = $FS::UID::AutoCommit;
2375   local $FS::UID::AutoCommit = 0;
2376   my $dbh = dbh;
2377
2378   #this needs to handle mysql as well as Pg, like svc_acct.pm
2379   #(make it into a common function if folks need to do batching with mysql)
2380   $dbh->do("LOCK TABLE pay_batch IN SHARE ROW EXCLUSIVE MODE")
2381     or return "Cannot lock pay_batch: " . $dbh->errstr;
2382
2383   my %pay_batch = (
2384     'status' => 'O',
2385     'payby'  => FS::payby->payby2payment($payby),
2386   );
2387
2388   my $pay_batch = qsearchs( 'pay_batch', \%pay_batch );
2389
2390   unless ( $pay_batch ) {
2391     $pay_batch = new FS::pay_batch \%pay_batch;
2392     my $error = $pay_batch->insert;
2393     if ( $error ) {
2394       $dbh->rollback if $oldAutoCommit;
2395       die "error creating new batch: $error\n";
2396     }
2397   }
2398
2399   my $old_cust_pay_batch = qsearchs('cust_pay_batch', {
2400       'batchnum' => $pay_batch->batchnum,
2401       'custnum'  => $self->custnum,
2402   } );
2403
2404   foreach (qw( address1 address2 city state zip country payby payinfo paydate
2405                payname )) {
2406     $options{$_} = '' unless exists($options{$_});
2407   }
2408
2409   my $cust_pay_batch = new FS::cust_pay_batch ( {
2410     'batchnum' => $pay_batch->batchnum,
2411     'invnum'   => $invnum || 0,                    # is there a better value?
2412                                                    # this field should be
2413                                                    # removed...
2414                                                    # cust_bill_pay_batch now
2415     'custnum'  => $self->custnum,
2416     'last'     => $self->getfield('last'),
2417     'first'    => $self->getfield('first'),
2418     'address1' => $options{address1} || $self->address1,
2419     'address2' => $options{address2} || $self->address2,
2420     'city'     => $options{city}     || $self->city,
2421     'state'    => $options{state}    || $self->state,
2422     'zip'      => $options{zip}      || $self->zip,
2423     'country'  => $options{country}  || $self->country,
2424     'payby'    => $options{payby}    || $self->payby,
2425     'payinfo'  => $options{payinfo}  || $self->payinfo,
2426     'exp'      => $options{paydate}  || $self->paydate,
2427     'payname'  => $options{payname}  || $self->payname,
2428     'amount'   => $amount,                         # consolidating
2429   } );
2430
2431   $cust_pay_batch->paybatchnum($old_cust_pay_batch->paybatchnum)
2432     if $old_cust_pay_batch;
2433
2434   my $error;
2435   if ($old_cust_pay_batch) {
2436     $error = $cust_pay_batch->replace($old_cust_pay_batch)
2437   } else {
2438     $error = $cust_pay_batch->insert;
2439   }
2440
2441   if ( $error ) {
2442     $dbh->rollback if $oldAutoCommit;
2443     die $error;
2444   }
2445
2446   my $unapplied =   $self->total_unapplied_credits
2447                   + $self->total_unapplied_payments
2448                   + $self->in_transit_payments;
2449   foreach my $cust_bill ($self->open_cust_bill) {
2450     #$dbh->commit or die $dbh->errstr if $oldAutoCommit;
2451     my $cust_bill_pay_batch = new FS::cust_bill_pay_batch {
2452       'invnum' => $cust_bill->invnum,
2453       'paybatchnum' => $cust_pay_batch->paybatchnum,
2454       'amount' => $cust_bill->owed,
2455       '_date' => time,
2456     };
2457     if ($unapplied >= $cust_bill_pay_batch->amount){
2458       $unapplied -= $cust_bill_pay_batch->amount;
2459       next;
2460     }else{
2461       $cust_bill_pay_batch->amount(sprintf ( "%.2f",
2462                                    $cust_bill_pay_batch->amount - $unapplied ));      $unapplied = 0;
2463     }
2464     $error = $cust_bill_pay_batch->insert;
2465     if ( $error ) {
2466       $dbh->rollback if $oldAutoCommit;
2467       die $error;
2468     }
2469   }
2470
2471   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
2472   '';
2473 }
2474
2475 =item total_owed
2476
2477 Returns the total owed for this customer on all invoices
2478 (see L<FS::cust_bill/owed>).
2479
2480 =cut
2481
2482 sub total_owed {
2483   my $self = shift;
2484   $self->total_owed_date(2145859200); #12/31/2037
2485 }
2486
2487 =item total_owed_date TIME
2488
2489 Returns the total owed for this customer on all invoices with date earlier than
2490 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2491 see L<Time::Local> and L<Date::Parse> for conversion functions.
2492
2493 =cut
2494
2495 sub total_owed_date {
2496   my $self = shift;
2497   my $time = shift;
2498
2499   my $custnum = $self->custnum;
2500
2501   my $owed_sql = FS::cust_bill->owed_sql;
2502
2503   my $sql = "
2504     SELECT SUM($owed_sql) FROM cust_bill
2505       WHERE custnum = $custnum
2506         AND _date <= $time
2507   ";
2508
2509   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2510
2511 }
2512
2513 =item total_owed_pkgnum PKGNUM
2514
2515 Returns the total owed on all invoices for this customer's specific package
2516 when using experimental package balances (see L<FS::cust_bill/owed_pkgnum>).
2517
2518 =cut
2519
2520 sub total_owed_pkgnum {
2521   my( $self, $pkgnum ) = @_;
2522   $self->total_owed_date_pkgnum(2145859200, $pkgnum); #12/31/2037
2523 }
2524
2525 =item total_owed_date_pkgnum TIME PKGNUM
2526
2527 Returns the total owed for this customer's specific package when using
2528 experimental package balances on all invoices with date earlier than
2529 TIME.  TIME is specified as a UNIX timestamp; see L<perlfunc/"time">).  Also
2530 see L<Time::Local> and L<Date::Parse> for conversion functions.
2531
2532 =cut
2533
2534 sub total_owed_date_pkgnum {
2535   my( $self, $time, $pkgnum ) = @_;
2536
2537   my $total_bill = 0;
2538   foreach my $cust_bill (
2539     grep { $_->_date <= $time }
2540       qsearch('cust_bill', { 'custnum' => $self->custnum, } )
2541   ) {
2542     $total_bill += $cust_bill->owed_pkgnum($pkgnum);
2543   }
2544   sprintf( "%.2f", $total_bill );
2545
2546 }
2547
2548 =item total_paid
2549
2550 Returns the total amount of all payments.
2551
2552 =cut
2553
2554 sub total_paid {
2555   my $self = shift;
2556   my $total = 0;
2557   $total += $_->paid foreach $self->cust_pay;
2558   sprintf( "%.2f", $total );
2559 }
2560
2561 =item total_unapplied_credits
2562
2563 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2564 customer.  See L<FS::cust_credit/credited>.
2565
2566 =item total_credited
2567
2568 Old name for total_unapplied_credits.  Don't use.
2569
2570 =cut
2571
2572 sub total_credited {
2573   #carp "total_credited deprecated, use total_unapplied_credits";
2574   shift->total_unapplied_credits(@_);
2575 }
2576
2577 sub total_unapplied_credits {
2578   my $self = shift;
2579
2580   my $custnum = $self->custnum;
2581
2582   my $unapplied_sql = FS::cust_credit->unapplied_sql;
2583
2584   my $sql = "
2585     SELECT SUM($unapplied_sql) FROM cust_credit
2586       WHERE custnum = $custnum
2587   ";
2588
2589   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2590
2591 }
2592
2593 =item total_unapplied_credits_pkgnum PKGNUM
2594
2595 Returns the total outstanding credit (see L<FS::cust_credit>) for this
2596 customer.  See L<FS::cust_credit/credited>.
2597
2598 =cut
2599
2600 sub total_unapplied_credits_pkgnum {
2601   my( $self, $pkgnum ) = @_;
2602   my $total_credit = 0;
2603   $total_credit += $_->credited foreach $self->cust_credit_pkgnum($pkgnum);
2604   sprintf( "%.2f", $total_credit );
2605 }
2606
2607
2608 =item total_unapplied_payments
2609
2610 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer.
2611 See L<FS::cust_pay/unapplied>.
2612
2613 =cut
2614
2615 sub total_unapplied_payments {
2616   my $self = shift;
2617
2618   my $custnum = $self->custnum;
2619
2620   my $unapplied_sql = FS::cust_pay->unapplied_sql;
2621
2622   my $sql = "
2623     SELECT SUM($unapplied_sql) FROM cust_pay
2624       WHERE custnum = $custnum
2625   ";
2626
2627   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2628
2629 }
2630
2631 =item total_unapplied_payments_pkgnum PKGNUM
2632
2633 Returns the total unapplied payments (see L<FS::cust_pay>) for this customer's
2634 specific package when using experimental package balances.  See
2635 L<FS::cust_pay/unapplied>.
2636
2637 =cut
2638
2639 sub total_unapplied_payments_pkgnum {
2640   my( $self, $pkgnum ) = @_;
2641   my $total_unapplied = 0;
2642   $total_unapplied += $_->unapplied foreach $self->cust_pay_pkgnum($pkgnum);
2643   sprintf( "%.2f", $total_unapplied );
2644 }
2645
2646
2647 =item total_unapplied_refunds
2648
2649 Returns the total unrefunded refunds (see L<FS::cust_refund>) for this
2650 customer.  See L<FS::cust_refund/unapplied>.
2651
2652 =cut
2653
2654 sub total_unapplied_refunds {
2655   my $self = shift;
2656   my $custnum = $self->custnum;
2657
2658   my $unapplied_sql = FS::cust_refund->unapplied_sql;
2659
2660   my $sql = "
2661     SELECT SUM($unapplied_sql) FROM cust_refund
2662       WHERE custnum = $custnum
2663   ";
2664
2665   sprintf( "%.2f", $self->scalar_sql($sql) || 0 );
2666
2667 }
2668
2669 =item balance
2670
2671 Returns the balance for this customer (total_owed plus total_unrefunded, minus
2672 total_unapplied_credits minus total_unapplied_payments).
2673
2674 =cut
2675
2676 sub balance {
2677   my $self = shift;
2678   $self->balance_date_range;
2679 }
2680
2681 =item balance_date TIME
2682
2683 Returns the balance for this customer, only considering invoices with date
2684 earlier than TIME (total_owed_date minus total_credited minus
2685 total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
2686 L<perlfunc/"time">).  Also see L<Time::Local> and L<Date::Parse> for conversion
2687 functions.
2688
2689 =cut
2690
2691 sub balance_date {
2692   my $self = shift;
2693   $self->balance_date_range(shift);
2694 }
2695
2696 =item balance_date_range [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
2697
2698 Returns the balance for this customer, optionally considering invoices with
2699 date earlier than START_TIME, and not later than END_TIME
2700 (total_owed_date minus total_unapplied_credits minus total_unapplied_payments).
2701
2702 Times are specified as SQL fragments or numeric
2703 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
2704 L<Date::Parse> for conversion functions.  The empty string can be passed
2705 to disable that time constraint completely.
2706
2707 Available options are:
2708
2709 =over 4
2710
2711 =item unapplied_date
2712
2713 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)
2714
2715 =back
2716
2717 =cut
2718
2719 sub balance_date_range {
2720   my $self = shift;
2721   my $sql = 'SELECT SUM('. $self->balance_date_sql(@_).
2722             ') FROM cust_main WHERE custnum='. $self->custnum;
2723   sprintf( '%.2f', $self->scalar_sql($sql) || 0 );
2724 }
2725
2726 =item balance_pkgnum PKGNUM
2727
2728 Returns the balance for this customer's specific package when using
2729 experimental package balances (total_owed plus total_unrefunded, minus
2730 total_unapplied_credits minus total_unapplied_payments)
2731
2732 =cut
2733
2734 sub balance_pkgnum {
2735   my( $self, $pkgnum ) = @_;
2736
2737   sprintf( "%.2f",
2738       $self->total_owed_pkgnum($pkgnum)
2739 # n/a - refunds aren't part of pkg-balances since they don't apply to invoices
2740 #    + $self->total_unapplied_refunds_pkgnum($pkgnum)
2741     - $self->total_unapplied_credits_pkgnum($pkgnum)
2742     - $self->total_unapplied_payments_pkgnum($pkgnum)
2743   );
2744 }
2745
2746 =item in_transit_payments
2747
2748 Returns the total of requests for payments for this customer pending in
2749 batches in transit to the bank.  See L<FS::pay_batch> and L<FS::cust_pay_batch>
2750
2751 =cut
2752
2753 sub in_transit_payments {
2754   my $self = shift;
2755   my $in_transit_payments = 0;
2756   foreach my $pay_batch ( qsearch('pay_batch', {
2757     'status' => 'I',
2758   } ) ) {
2759     foreach my $cust_pay_batch ( qsearch('cust_pay_batch', {
2760       'batchnum' => $pay_batch->batchnum,
2761       'custnum' => $self->custnum,
2762     } ) ) {
2763       $in_transit_payments += $cust_pay_batch->amount;
2764     }
2765   }
2766   sprintf( "%.2f", $in_transit_payments );
2767 }
2768
2769 =item payment_info
2770
2771 Returns a hash of useful information for making a payment.
2772
2773 =over 4
2774
2775 =item balance
2776
2777 Current balance.
2778
2779 =item payby
2780
2781 'CARD' (credit card - automatic), 'DCRD' (credit card - on-demand),
2782 'CHEK' (electronic check - automatic), 'DCHK' (electronic check - on-demand),
2783 'LECB' (Phone bill billing), 'BILL' (billing), or 'COMP' (free).
2784
2785 =back
2786
2787 For credit card transactions:
2788
2789 =over 4
2790
2791 =item card_type 1
2792
2793 =item payname
2794
2795 Exact name on card
2796
2797 =back
2798
2799 For electronic check transactions:
2800
2801 =over 4
2802
2803 =item stateid_state
2804
2805 =back
2806
2807 =cut
2808
2809 sub payment_info {
2810   my $self = shift;
2811
2812   my %return = ();
2813
2814   $return{balance} = $self->balance;
2815
2816   $return{payname} = $self->payname
2817                      || ( $self->first. ' '. $self->get('last') );
2818
2819   $return{$_} = $self->get($_) for qw(address1 address2 city state zip);
2820
2821   $return{payby} = $self->payby;
2822   $return{stateid_state} = $self->stateid_state;
2823
2824   if ( $self->payby =~ /^(CARD|DCRD)$/ ) {
2825     $return{card_type} = cardtype($self->payinfo);
2826     $return{payinfo} = $self->paymask;
2827
2828     @return{'month', 'year'} = $self->paydate_monthyear;
2829
2830   }
2831
2832   if ( $self->payby =~ /^(CHEK|DCHK)$/ ) {
2833     my ($payinfo1, $payinfo2) = split '@', $self->paymask;
2834     $return{payinfo1} = $payinfo1;
2835     $return{payinfo2} = $payinfo2;
2836     $return{paytype}  = $self->paytype;
2837     $return{paystate} = $self->paystate;
2838
2839   }
2840
2841   #doubleclick protection
2842   my $_date = time;
2843   $return{paybatch} = "webui-MyAccount-$_date-$$-". rand() * 2**32;
2844
2845   %return;
2846
2847 }
2848
2849 =item paydate_monthyear
2850
2851 Returns a two-element list consisting of the month and year of this customer's
2852 paydate (credit card expiration date for CARD customers)
2853
2854 =cut
2855
2856 sub paydate_monthyear {
2857   my $self = shift;
2858   if ( $self->paydate  =~ /^(\d{4})-(\d{1,2})-\d{1,2}$/ ) { #Pg date format
2859     ( $2, $1 );
2860   } elsif ( $self->paydate =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2861     ( $1, $3 );
2862   } else {
2863     ('', '');
2864   }
2865 }
2866
2867 =item tax_exemption TAXNAME
2868
2869 =cut
2870
2871 sub tax_exemption {
2872   my( $self, $taxname ) = @_;
2873
2874   qsearchs( 'cust_main_exemption', { 'custnum' => $self->custnum,
2875                                      'taxname' => $taxname,
2876                                    },
2877           );
2878 }
2879
2880 =item cust_main_exemption
2881
2882 =cut
2883
2884 sub cust_main_exemption {
2885   my $self = shift;
2886   qsearch( 'cust_main_exemption', { 'custnum' => $self->custnum } );
2887 }
2888
2889 =item invoicing_list [ ARRAYREF ]
2890
2891 If an arguement is given, sets these email addresses as invoice recipients
2892 (see L<FS::cust_main_invoice>).  Errors are not fatal and are not reported
2893 (except as warnings), so use check_invoicing_list first.
2894
2895 Returns a list of email addresses (with svcnum entries expanded).
2896
2897 Note: You can clear the invoicing list by passing an empty ARRAYREF.  You can
2898 check it without disturbing anything by passing nothing.
2899
2900 This interface may change in the future.
2901
2902 =cut
2903
2904 sub invoicing_list {
2905   my( $self, $arrayref ) = @_;
2906
2907   if ( $arrayref ) {
2908     my @cust_main_invoice;
2909     if ( $self->custnum ) {
2910       @cust_main_invoice =
2911         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
2912     } else {
2913       @cust_main_invoice = ();
2914     }
2915     foreach my $cust_main_invoice ( @cust_main_invoice ) {
2916       #warn $cust_main_invoice->destnum;
2917       unless ( grep { $cust_main_invoice->address eq $_ } @{$arrayref} ) {
2918         #warn $cust_main_invoice->destnum;
2919         my $error = $cust_main_invoice->delete;
2920         warn $error if $error;
2921       }
2922     }
2923     if ( $self->custnum ) {
2924       @cust_main_invoice =
2925         qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
2926     } else {
2927       @cust_main_invoice = ();
2928     }
2929     my %seen = map { $_->address => 1 } @cust_main_invoice;
2930     foreach my $address ( @{$arrayref} ) {
2931       next if exists $seen{$address} && $seen{$address};
2932       $seen{$address} = 1;
2933       my $cust_main_invoice = new FS::cust_main_invoice ( {
2934         'custnum' => $self->custnum,
2935         'dest'    => $address,
2936       } );
2937       my $error = $cust_main_invoice->insert;
2938       warn $error if $error;
2939     }
2940   }
2941
2942   if ( $self->custnum ) {
2943     map { $_->address }
2944       qsearch( 'cust_main_invoice', { 'custnum' => $self->custnum } );
2945   } else {
2946     ();
2947   }
2948
2949 }
2950
2951 =item check_invoicing_list ARRAYREF
2952
2953 Checks these arguements as valid input for the invoicing_list method.  If there
2954 is an error, returns the error, otherwise returns false.
2955
2956 =cut
2957
2958 sub check_invoicing_list {
2959   my( $self, $arrayref ) = @_;
2960
2961   foreach my $address ( @$arrayref ) {
2962
2963     if ($address eq 'FAX' and $self->getfield('fax') eq '') {
2964       return 'Can\'t add FAX invoice destination with a blank FAX number.';
2965     }
2966
2967     my $cust_main_invoice = new FS::cust_main_invoice ( {
2968       'custnum' => $self->custnum,
2969       'dest'    => $address,
2970     } );
2971     my $error = $self->custnum
2972                 ? $cust_main_invoice->check
2973                 : $cust_main_invoice->checkdest
2974     ;
2975     return $error if $error;
2976
2977   }
2978
2979   return "Email address required"
2980     if $conf->exists('cust_main-require_invoicing_list_email')
2981     && ! grep { $_ !~ /^([A-Z]+)$/ } @$arrayref;
2982
2983   '';
2984 }
2985
2986 =item set_default_invoicing_list
2987
2988 Sets the invoicing list to all accounts associated with this customer,
2989 overwriting any previous invoicing list.
2990
2991 =cut
2992
2993 sub set_default_invoicing_list {
2994   my $self = shift;
2995   $self->invoicing_list($self->all_emails);
2996 }
2997
2998 =item all_emails
2999
3000 Returns the email addresses of all accounts provisioned for this customer.
3001
3002 =cut
3003
3004 sub all_emails {
3005   my $self = shift;
3006   my %list;
3007   foreach my $cust_pkg ( $self->all_pkgs ) {
3008     my @cust_svc = qsearch('cust_svc', { 'pkgnum' => $cust_pkg->pkgnum } );
3009     my @svc_acct =
3010       map { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3011         grep { qsearchs('svc_acct', { 'svcnum' => $_->svcnum } ) }
3012           @cust_svc;
3013     $list{$_}=1 foreach map { $_->email } @svc_acct;
3014   }
3015   keys %list;
3016 }
3017
3018 =item invoicing_list_addpost
3019
3020 Adds postal invoicing to this customer.  If this customer is already configured
3021 to receive postal invoices, does nothing.
3022
3023 =cut
3024
3025 sub invoicing_list_addpost {
3026   my $self = shift;
3027   return if grep { $_ eq 'POST' } $self->invoicing_list;
3028   my @invoicing_list = $self->invoicing_list;
3029   push @invoicing_list, 'POST';
3030   $self->invoicing_list(\@invoicing_list);
3031 }
3032
3033 =item invoicing_list_emailonly
3034
3035 Returns the list of email invoice recipients (invoicing_list without non-email
3036 destinations such as POST and FAX).
3037
3038 =cut
3039
3040 sub invoicing_list_emailonly {
3041   my $self = shift;
3042   warn "$me invoicing_list_emailonly called"
3043     if $DEBUG;
3044   grep { $_ !~ /^([A-Z]+)$/ } $self->invoicing_list;
3045 }
3046
3047 =item invoicing_list_emailonly_scalar
3048
3049 Returns the list of email invoice recipients (invoicing_list without non-email
3050 destinations such as POST and FAX) as a comma-separated scalar.
3051
3052 =cut
3053
3054 sub invoicing_list_emailonly_scalar {
3055   my $self = shift;
3056   warn "$me invoicing_list_emailonly_scalar called"
3057     if $DEBUG;
3058   join(', ', $self->invoicing_list_emailonly);
3059 }
3060
3061 =item referral_custnum_cust_main
3062
3063 Returns the customer who referred this customer (or the empty string, if
3064 this customer was not referred).
3065
3066 Note the difference with referral_cust_main method: This method,
3067 referral_custnum_cust_main returns the single customer (if any) who referred
3068 this customer, while referral_cust_main returns an array of customers referred
3069 BY this customer.
3070
3071 =cut
3072
3073 sub referral_custnum_cust_main {
3074   my $self = shift;
3075   return '' unless $self->referral_custnum;
3076   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3077 }
3078
3079 =item referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]
3080
3081 Returns an array of customers referred by this customer (referral_custnum set
3082 to this custnum).  If DEPTH is given, recurses up to the given depth, returning
3083 customers referred by customers referred by this customer and so on, inclusive.
3084 The default behavior is DEPTH 1 (no recursion).
3085
3086 Note the difference with referral_custnum_cust_main method: This method,
3087 referral_cust_main, returns an array of customers referred BY this customer,
3088 while referral_custnum_cust_main returns the single customer (if any) who
3089 referred this customer.
3090
3091 =cut
3092
3093 sub referral_cust_main {
3094   my $self = shift;
3095   my $depth = @_ ? shift : 1;
3096   my $exclude = @_ ? shift : {};
3097
3098   my @cust_main =
3099     map { $exclude->{$_->custnum}++; $_; }
3100       grep { ! $exclude->{ $_->custnum } }
3101         qsearch( 'cust_main', { 'referral_custnum' => $self->custnum } );
3102
3103   if ( $depth > 1 ) {
3104     push @cust_main,
3105       map { $_->referral_cust_main($depth-1, $exclude) }
3106         @cust_main;
3107   }
3108
3109   @cust_main;
3110 }
3111
3112 =item referral_cust_main_ncancelled
3113
3114 Same as referral_cust_main, except only returns customers with uncancelled
3115 packages.
3116
3117 =cut
3118
3119 sub referral_cust_main_ncancelled {
3120   my $self = shift;
3121   grep { scalar($_->ncancelled_pkgs) } $self->referral_cust_main;
3122 }
3123
3124 =item referral_cust_pkg [ DEPTH ]
3125
3126 Like referral_cust_main, except returns a flat list of all unsuspended (and
3127 uncancelled) packages for each customer.  The number of items in this list may
3128 be useful for commission calculations (perhaps after a C<grep { my $pkgpart = $_->pkgpart; grep { $_ == $pkgpart } @commission_worthy_pkgparts> } $cust_main-> ).
3129
3130 =cut
3131
3132 sub referral_cust_pkg {
3133   my $self = shift;
3134   my $depth = @_ ? shift : 1;
3135
3136   map { $_->unsuspended_pkgs }
3137     grep { $_->unsuspended_pkgs }
3138       $self->referral_cust_main($depth);
3139 }
3140
3141 =item referring_cust_main
3142
3143 Returns the single cust_main record for the customer who referred this customer
3144 (referral_custnum), or false.
3145
3146 =cut
3147
3148 sub referring_cust_main {
3149   my $self = shift;
3150   return '' unless $self->referral_custnum;
3151   qsearchs('cust_main', { 'custnum' => $self->referral_custnum } );
3152 }
3153
3154 =item credit AMOUNT, REASON [ , OPTION => VALUE ... ]
3155
3156 Applies a credit to this customer.  If there is an error, returns the error,
3157 otherwise returns false.
3158
3159 REASON can be a text string, an FS::reason object, or a scalar reference to
3160 a reasonnum.  If a text string, it will be automatically inserted as a new
3161 reason, and a 'reason_type' option must be passed to indicate the
3162 FS::reason_type for the new reason.
3163
3164 An I<addlinfo> option may be passed to set the credit's I<addlinfo> field.
3165
3166 Any other options are passed to FS::cust_credit::insert.
3167
3168 =cut
3169
3170 sub credit {
3171   my( $self, $amount, $reason, %options ) = @_;
3172
3173   my $cust_credit = new FS::cust_credit {
3174     'custnum' => $self->custnum,
3175     'amount'  => $amount,
3176   };
3177
3178   if ( ref($reason) ) {
3179
3180     if ( ref($reason) eq 'SCALAR' ) {
3181       $cust_credit->reasonnum( $$reason );
3182     } else {
3183       $cust_credit->reasonnum( $reason->reasonnum );
3184     }
3185
3186   } else {
3187     $cust_credit->set('reason', $reason)
3188   }
3189
3190   for (qw( addlinfo eventnum )) {
3191     $cust_credit->$_( delete $options{$_} )
3192       if exists($options{$_});
3193   }
3194
3195   $cust_credit->insert(%options);
3196
3197 }
3198
3199 =item charge HASHREF || AMOUNT [ PKG [ COMMENT [ TAXCLASS ] ] ]
3200
3201 Creates a one-time charge for this customer.  If there is an error, returns
3202 the error, otherwise returns false.
3203
3204 New-style, with a hashref of options:
3205
3206   my $error = $cust_main->charge(
3207                                   {
3208                                     'amount'     => 54.32,
3209                                     'quantity'   => 1,
3210                                     'start_date' => str2time('7/4/2009'),
3211                                     'pkg'        => 'Description',
3212                                     'comment'    => 'Comment',
3213                                     'additional' => [], #extra invoice detail
3214                                     'classnum'   => 1,  #pkg_class
3215
3216                                     'setuptax'   => '', # or 'Y' for tax exempt
3217
3218                                     #internal taxation
3219                                     'taxclass'   => 'Tax class',
3220
3221                                     #vendor taxation
3222                                     'taxproduct' => 2,  #part_pkg_taxproduct
3223                                     'override'   => {}, #XXX describe
3224
3225                                     #will be filled in with the new object
3226                                     'cust_pkg_ref' => \$cust_pkg,
3227
3228                                     #generate an invoice immediately
3229                                     'bill_now' => 0,
3230                                     'invoice_terms' => '', #with these terms
3231                                   }
3232                                 );
3233
3234 Old-style:
3235
3236   my $error = $cust_main->charge( 54.32, 'Description', 'Comment', 'Tax class' );
3237
3238 =cut
3239
3240 sub charge {
3241   my $self = shift;
3242   my ( $amount, $quantity, $start_date, $classnum );
3243   my ( $pkg, $comment, $additional );
3244   my ( $setuptax, $taxclass );   #internal taxes
3245   my ( $taxproduct, $override ); #vendor (CCH) taxes
3246   my $no_auto = '';
3247   my $cust_pkg_ref = '';
3248   my ( $bill_now, $invoice_terms ) = ( 0, '' );
3249   if ( ref( $_[0] ) ) {
3250     $amount     = $_[0]->{amount};
3251     $quantity   = exists($_[0]->{quantity}) ? $_[0]->{quantity} : 1;
3252     $start_date = exists($_[0]->{start_date}) ? $_[0]->{start_date} : '';
3253     $no_auto    = exists($_[0]->{no_auto}) ? $_[0]->{no_auto} : '';
3254     $pkg        = exists($_[0]->{pkg}) ? $_[0]->{pkg} : 'One-time charge';
3255     $comment    = exists($_[0]->{comment}) ? $_[0]->{comment}
3256                                            : '$'. sprintf("%.2f",$amount);
3257     $setuptax   = exists($_[0]->{setuptax}) ? $_[0]->{setuptax} : '';
3258     $taxclass   = exists($_[0]->{taxclass}) ? $_[0]->{taxclass} : '';
3259     $classnum   = exists($_[0]->{classnum}) ? $_[0]->{classnum} : '';
3260     $additional = $_[0]->{additional} || [];
3261     $taxproduct = $_[0]->{taxproductnum};
3262     $override   = { '' => $_[0]->{tax_override} };
3263     $cust_pkg_ref = exists($_[0]->{cust_pkg_ref}) ? $_[0]->{cust_pkg_ref} : '';
3264     $bill_now = exists($_[0]->{bill_now}) ? $_[0]->{bill_now} : '';
3265     $invoice_terms = exists($_[0]->{invoice_terms}) ? $_[0]->{invoice_terms} : '';
3266   } else {
3267     $amount     = shift;
3268     $quantity   = 1;
3269     $start_date = '';
3270     $pkg        = @_ ? shift : 'One-time charge';
3271     $comment    = @_ ? shift : '$'. sprintf("%.2f",$amount);
3272     $setuptax   = '';
3273     $taxclass   = @_ ? shift : '';
3274     $additional = [];
3275   }
3276
3277   local $SIG{HUP} = 'IGNORE';
3278   local $SIG{INT} = 'IGNORE';
3279   local $SIG{QUIT} = 'IGNORE';
3280   local $SIG{TERM} = 'IGNORE';
3281   local $SIG{TSTP} = 'IGNORE';
3282   local $SIG{PIPE} = 'IGNORE';
3283
3284   my $oldAutoCommit = $FS::UID::AutoCommit;
3285   local $FS::UID::AutoCommit = 0;
3286   my $dbh = dbh;
3287
3288   my $part_pkg = new FS::part_pkg ( {
3289     'pkg'           => $pkg,
3290     'comment'       => $comment,
3291     'plan'          => 'flat',
3292     'freq'          => 0,
3293     'disabled'      => 'Y',
3294     'classnum'      => ( $classnum ? $classnum : '' ),
3295     'setuptax'      => $setuptax,
3296     'taxclass'      => $taxclass,
3297     'taxproductnum' => $taxproduct,
3298   } );
3299
3300   my %options = ( ( map { ("additional_info$_" => $additional->[$_] ) }
3301                         ( 0 .. @$additional - 1 )
3302                   ),
3303                   'additional_count' => scalar(@$additional),
3304                   'setup_fee' => $amount,
3305                 );
3306
3307   my $error = $part_pkg->insert( options       => \%options,
3308                                  tax_overrides => $override,
3309                                );
3310   if ( $error ) {
3311     $dbh->rollback if $oldAutoCommit;
3312     return $error;
3313   }
3314
3315   my $pkgpart = $part_pkg->pkgpart;
3316   my %type_pkgs = ( 'typenum' => $self->agent->typenum, 'pkgpart' => $pkgpart );
3317   unless ( qsearchs('type_pkgs', \%type_pkgs ) ) {
3318     my $type_pkgs = new FS::type_pkgs \%type_pkgs;
3319     $error = $type_pkgs->insert;
3320     if ( $error ) {
3321       $dbh->rollback if $oldAutoCommit;
3322       return $error;
3323     }
3324   }
3325
3326   my $cust_pkg = new FS::cust_pkg ( {
3327     'custnum'    => $self->custnum,
3328     'pkgpart'    => $pkgpart,
3329     'quantity'   => $quantity,
3330     'start_date' => $start_date,
3331     'no_auto'    => $no_auto,
3332   } );
3333
3334   $error = $cust_pkg->insert;
3335   if ( $error ) {
3336     $dbh->rollback if $oldAutoCommit;
3337     return $error;
3338   } elsif ( $cust_pkg_ref ) {
3339     ${$cust_pkg_ref} = $cust_pkg;
3340   }
3341
3342   if ( $bill_now ) {
3343     my $error = $self->bill( 'invoice_terms' => $invoice_terms,
3344                              'pkg_list'      => [ $cust_pkg ],
3345                            );
3346     if ( $error ) {
3347       $dbh->rollback if $oldAutoCommit;
3348       return $error;
3349     }
3350   }
3351
3352   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
3353   return '';
3354
3355 }
3356
3357 #=item charge_postal_fee
3358 #
3359 #Applies a one time charge this customer.  If there is an error,
3360 #returns the error, returns the cust_pkg charge object or false
3361 #if there was no charge.
3362 #
3363 #=cut
3364 #
3365 # This should be a customer event.  For that to work requires that bill
3366 # also be a customer event.
3367
3368 sub charge_postal_fee {
3369   my $self = shift;
3370
3371   my $pkgpart = $conf->config('postal_invoice-fee_pkgpart');
3372   return '' unless ($pkgpart && grep { $_ eq 'POST' } $self->invoicing_list);
3373
3374   my $cust_pkg = new FS::cust_pkg ( {
3375     'custnum'  => $self->custnum,
3376     'pkgpart'  => $pkgpart,
3377     'quantity' => 1,
3378   } );
3379
3380   my $error = $cust_pkg->insert;
3381   $error ? $error : $cust_pkg;
3382 }
3383
3384 =item cust_bill [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3385
3386 Returns all the invoices (see L<FS::cust_bill>) for this customer.
3387
3388 Optionally, a list or hashref of additional arguments to the qsearch call can
3389 be passed.
3390
3391 =cut
3392
3393 sub cust_bill {
3394   my $self = shift;
3395   my $opt = ref($_[0]) ? shift : { @_ };
3396
3397   #return $self->num_cust_bill unless wantarray || keys %$opt;
3398
3399   $opt->{'table'} = 'cust_bill';
3400   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3401   $opt->{'hashref'}{'custnum'} = $self->custnum;
3402   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3403
3404   map { $_ } #behavior of sort undefined in scalar context
3405     sort { $a->_date <=> $b->_date }
3406       qsearch($opt);
3407 }
3408
3409 =item open_cust_bill
3410
3411 Returns all the open (owed > 0) invoices (see L<FS::cust_bill>) for this
3412 customer.
3413
3414 =cut
3415
3416 sub open_cust_bill {
3417   my $self = shift;
3418
3419   $self->cust_bill(
3420     'extra_sql' => ' AND '. FS::cust_bill->owed_sql. ' > 0',
3421     #@_
3422   );
3423
3424 }
3425
3426 =item cust_statement [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3427
3428 Returns all the statements (see L<FS::cust_statement>) for this customer.
3429
3430 Optionally, a list or hashref of additional arguments to the qsearch call can
3431 be passed.
3432
3433 =cut
3434
3435 sub cust_statement {
3436   my $self = shift;
3437   my $opt = ref($_[0]) ? shift : { @_ };
3438
3439   #return $self->num_cust_statement unless wantarray || keys %$opt;
3440
3441   $opt->{'table'} = 'cust_statement';
3442   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3443   $opt->{'hashref'}{'custnum'} = $self->custnum;
3444   $opt->{'order_by'} ||= 'ORDER BY _date ASC';
3445
3446   map { $_ } #behavior of sort undefined in scalar context
3447     sort { $a->_date <=> $b->_date }
3448       qsearch($opt);
3449 }
3450
3451 =item cust_credit
3452
3453 Returns all the credits (see L<FS::cust_credit>) for this customer.
3454
3455 =cut
3456
3457 sub cust_credit {
3458   my $self = shift;
3459   map { $_ } #return $self->num_cust_credit unless wantarray;
3460   sort { $a->_date <=> $b->_date }
3461     qsearch( 'cust_credit', { 'custnum' => $self->custnum } )
3462 }
3463
3464 =item cust_credit_pkgnum
3465
3466 Returns all the credits (see L<FS::cust_credit>) for this customer's specific
3467 package when using experimental package balances.
3468
3469 =cut
3470
3471 sub cust_credit_pkgnum {
3472   my( $self, $pkgnum ) = @_;
3473   map { $_ } #return $self->num_cust_credit_pkgnum($pkgnum) unless wantarray;
3474   sort { $a->_date <=> $b->_date }
3475     qsearch( 'cust_credit', { 'custnum' => $self->custnum,
3476                               'pkgnum'  => $pkgnum,
3477                             }
3478     );
3479 }
3480
3481 =item cust_pay
3482
3483 Returns all the payments (see L<FS::cust_pay>) for this customer.
3484
3485 =cut
3486
3487 sub cust_pay {
3488   my $self = shift;
3489   return $self->num_cust_pay unless wantarray;
3490   sort { $a->_date <=> $b->_date }
3491     qsearch( 'cust_pay', { 'custnum' => $self->custnum } )
3492 }
3493
3494 =item num_cust_pay
3495
3496 Returns the number of payments (see L<FS::cust_pay>) for this customer.  Also
3497 called automatically when the cust_pay method is used in a scalar context.
3498
3499 =cut
3500
3501 sub num_cust_pay {
3502   my $self = shift;
3503   my $sql = "SELECT COUNT(*) FROM cust_pay WHERE custnum = ?";
3504   my $sth = dbh->prepare($sql) or die dbh->errstr;
3505   $sth->execute($self->custnum) or die $sth->errstr;
3506   $sth->fetchrow_arrayref->[0];
3507 }
3508
3509 =item cust_pay_pkgnum
3510
3511 Returns all the payments (see L<FS::cust_pay>) for this customer's specific
3512 package when using experimental package balances.
3513
3514 =cut
3515
3516 sub cust_pay_pkgnum {
3517   my( $self, $pkgnum ) = @_;
3518   map { $_ } #return $self->num_cust_pay_pkgnum($pkgnum) unless wantarray;
3519   sort { $a->_date <=> $b->_date }
3520     qsearch( 'cust_pay', { 'custnum' => $self->custnum,
3521                            'pkgnum'  => $pkgnum,
3522                          }
3523     );
3524 }
3525
3526 =item cust_pay_void
3527
3528 Returns all voided payments (see L<FS::cust_pay_void>) for this customer.
3529
3530 =cut
3531
3532 sub cust_pay_void {
3533   my $self = shift;
3534   map { $_ } #return $self->num_cust_pay_void unless wantarray;
3535   sort { $a->_date <=> $b->_date }
3536     qsearch( 'cust_pay_void', { 'custnum' => $self->custnum } )
3537 }
3538
3539 =item cust_pay_batch [ OPTION => VALUE... | EXTRA_QSEARCH_PARAMS_HASHREF ]
3540
3541 Returns all batched payments (see L<FS::cust_pay_void>) for this customer.
3542
3543 Optionally, a list or hashref of additional arguments to the qsearch call can
3544 be passed.
3545
3546 =cut
3547
3548 sub cust_pay_batch {
3549   my $self = shift;
3550   my $opt = ref($_[0]) ? shift : { @_ };
3551
3552   #return $self->num_cust_statement unless wantarray || keys %$opt;
3553
3554   $opt->{'table'} = 'cust_pay_batch';
3555   $opt->{'hashref'} ||= {}; #i guess it would autovivify anyway...
3556   $opt->{'hashref'}{'custnum'} = $self->custnum;
3557   $opt->{'order_by'} ||= 'ORDER BY paybatchnum ASC';
3558
3559   map { $_ } #behavior of sort undefined in scalar context
3560     sort { $a->paybatchnum <=> $b->paybatchnum }
3561       qsearch($opt);
3562 }
3563
3564 =item cust_pay_pending
3565
3566 Returns all pending payments (see L<FS::cust_pay_pending>) for this customer
3567 (without status "done").
3568
3569 =cut
3570
3571 sub cust_pay_pending {
3572   my $self = shift;
3573   return $self->num_cust_pay_pending unless wantarray;
3574   sort { $a->_date <=> $b->_date }
3575     qsearch( 'cust_pay_pending', {
3576                                    'custnum' => $self->custnum,
3577                                    'status'  => { op=>'!=', value=>'done' },
3578                                  },
3579            );
3580 }
3581
3582 =item cust_pay_pending_attempt
3583
3584 Returns all payment attempts / declined payments for this customer, as pending
3585 payments objects (see L<FS::cust_pay_pending>), with status "done" but without
3586 a corresponding payment (see L<FS::cust_pay>).
3587
3588 =cut
3589
3590 sub cust_pay_pending_attempt {
3591   my $self = shift;
3592   return $self->num_cust_pay_pending_attempt unless wantarray;
3593   sort { $a->_date <=> $b->_date }
3594     qsearch( 'cust_pay_pending', {
3595                                    'custnum' => $self->custnum,
3596                                    'status'  => 'done',
3597                                    'paynum'  => '',
3598                                  },
3599            );
3600 }
3601
3602 =item num_cust_pay_pending
3603
3604 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3605 customer (without status "done").  Also called automatically when the
3606 cust_pay_pending method is used in a scalar context.
3607
3608 =cut
3609
3610 sub num_cust_pay_pending {
3611   my $self = shift;
3612   $self->scalar_sql(
3613     " SELECT COUNT(*) FROM cust_pay_pending ".
3614       " WHERE custnum = ? AND status != 'done' ",
3615     $self->custnum
3616   );
3617 }
3618
3619 =item num_cust_pay_pending_attempt
3620
3621 Returns the number of pending payments (see L<FS::cust_pay_pending>) for this
3622 customer, with status "done" but without a corresp.  Also called automatically when the
3623 cust_pay_pending method is used in a scalar context.
3624
3625 =cut
3626
3627 sub num_cust_pay_pending_attempt {
3628   my $self = shift;
3629   $self->scalar_sql(
3630     " SELECT COUNT(*) FROM cust_pay_pending ".
3631       " WHERE custnum = ? AND status = 'done' AND paynum IS NULL",
3632     $self->custnum
3633   );
3634 }
3635
3636 =item cust_refund
3637
3638 Returns all the refunds (see L<FS::cust_refund>) for this customer.
3639
3640 =cut
3641
3642 sub cust_refund {
3643   my $self = shift;
3644   map { $_ } #return $self->num_cust_refund unless wantarray;
3645   sort { $a->_date <=> $b->_date }
3646     qsearch( 'cust_refund', { 'custnum' => $self->custnum } )
3647 }
3648
3649 =item display_custnum
3650
3651 Returns the displayed customer number for this customer: agent_custid if
3652 cust_main-default_agent_custid is set and it has a value, custnum otherwise.
3653
3654 =cut
3655
3656 sub display_custnum {
3657   my $self = shift;
3658   if ( $conf->exists('cust_main-default_agent_custid') && $self->agent_custid ){
3659     return $self->agent_custid;
3660   } else {
3661     return $self->custnum;
3662   }
3663 }
3664
3665 =item name
3666
3667 Returns a name string for this customer, either "Company (Last, First)" or
3668 "Last, First".
3669
3670 =cut
3671
3672 sub name {
3673   my $self = shift;
3674   my $name = $self->contact;
3675   $name = $self->company. " ($name)" if $self->company;
3676   $name;
3677 }
3678
3679 =item ship_name
3680
3681 Returns a name string for this (service/shipping) contact, either
3682 "Company (Last, First)" or "Last, First".
3683
3684 =cut
3685
3686 sub ship_name {
3687   my $self = shift;
3688   if ( $self->get('ship_last') ) {
3689     my $name = $self->ship_contact;
3690     $name = $self->ship_company. " ($name)" if $self->ship_company;
3691     $name;
3692   } else {
3693     $self->name;
3694   }
3695 }
3696
3697 =item name_short
3698
3699 Returns a name string for this customer, either "Company" or "First Last".
3700
3701 =cut
3702
3703 sub name_short {
3704   my $self = shift;
3705   $self->company !~ /^\s*$/ ? $self->company : $self->contact_firstlast;
3706 }
3707
3708 =item ship_name_short
3709
3710 Returns a name string for this (service/shipping) contact, either "Company"
3711 or "First Last".
3712
3713 =cut
3714
3715 sub ship_name_short {
3716   my $self = shift;
3717   if ( $self->get('ship_last') ) {
3718     $self->ship_company !~ /^\s*$/
3719       ? $self->ship_company
3720       : $self->ship_contact_firstlast;
3721   } else {
3722     $self->name_company_or_firstlast;
3723   }
3724 }
3725
3726 =item contact
3727
3728 Returns this customer's full (billing) contact name only, "Last, First"
3729
3730 =cut
3731
3732 sub contact {
3733   my $self = shift;
3734   $self->get('last'). ', '. $self->first;
3735 }
3736
3737 =item ship_contact
3738
3739 Returns this customer's full (shipping) contact name only, "Last, First"
3740
3741 =cut
3742
3743 sub ship_contact {
3744   my $self = shift;
3745   $self->get('ship_last')
3746     ? $self->get('ship_last'). ', '. $self->ship_first
3747     : $self->contact;
3748 }
3749
3750 =item contact_firstlast
3751
3752 Returns this customers full (billing) contact name only, "First Last".
3753
3754 =cut
3755
3756 sub contact_firstlast {
3757   my $self = shift;
3758   $self->first. ' '. $self->get('last');
3759 }
3760
3761 =item ship_contact_firstlast
3762
3763 Returns this customer's full (shipping) contact name only, "First Last".
3764
3765 =cut
3766
3767 sub ship_contact_firstlast {
3768   my $self = shift;
3769   $self->get('ship_last')
3770     ? $self->first. ' '. $self->get('ship_last')
3771     : $self->contact_firstlast;
3772 }
3773
3774 =item country_full
3775
3776 Returns this customer's full country name
3777
3778 =cut
3779
3780 sub country_full {
3781   my $self = shift;
3782   code2country($self->country);
3783 }
3784
3785 =item geocode DATA_VENDOR
3786
3787 Returns a value for the customer location as encoded by DATA_VENDOR.
3788 Currently this only makes sense for "CCH" as DATA_VENDOR.
3789
3790 =cut
3791
3792 =item cust_status
3793
3794 =item status
3795
3796 Returns a status string for this customer, currently:
3797
3798 =over 4
3799
3800 =item prospect - No packages have ever been ordered
3801
3802 =item ordered - Recurring packages all are new (not yet billed).
3803
3804 =item active - One or more recurring packages is active
3805
3806 =item inactive - No active recurring packages, but otherwise unsuspended/uncancelled (the inactive status is new - previously inactive customers were mis-identified as cancelled)
3807
3808 =item suspended - All non-cancelled recurring packages are suspended
3809
3810 =item cancelled - All recurring packages are cancelled
3811
3812 =back
3813
3814 Behavior of inactive vs. cancelled edge cases can be adjusted with the
3815 cust_main-status_module configuration option.
3816
3817 =cut
3818
3819 sub status { shift->cust_status(@_); }
3820
3821 sub cust_status {
3822   my $self = shift;
3823   for my $status ( FS::cust_main->statuses() ) {
3824     my $method = $status.'_sql';
3825     my $numnum = ( my $sql = $self->$method() ) =~ s/cust_main\.custnum/?/g;
3826     my $sth = dbh->prepare("SELECT $sql") or die dbh->errstr;
3827     $sth->execute( ($self->custnum) x $numnum )
3828       or die "Error executing 'SELECT $sql': ". $sth->errstr;
3829     return $status if $sth->fetchrow_arrayref->[0];
3830   }
3831 }
3832
3833 =item ucfirst_cust_status
3834
3835 =item ucfirst_status
3836
3837 Returns the status with the first character capitalized.
3838
3839 =cut
3840
3841 sub ucfirst_status { shift->ucfirst_cust_status(@_); }
3842
3843 sub ucfirst_cust_status {
3844   my $self = shift;
3845   ucfirst($self->cust_status);
3846 }
3847
3848 =item statuscolor
3849
3850 Returns a hex triplet color string for this customer's status.
3851
3852 =cut
3853
3854 sub statuscolor { shift->cust_statuscolor(@_); }
3855
3856 sub cust_statuscolor {
3857   my $self = shift;
3858   __PACKAGE__->statuscolors->{$self->cust_status};
3859 }
3860
3861 =item tickets
3862
3863 Returns an array of hashes representing the customer's RT tickets.
3864
3865 =cut
3866
3867 sub tickets {
3868   my $self = shift;
3869
3870   my $num = $conf->config('cust_main-max_tickets') || 10;
3871   my @tickets = ();
3872
3873   if ( $conf->config('ticket_system') ) {
3874     unless ( $conf->config('ticket_system-custom_priority_field') ) {
3875
3876       @tickets = @{ FS::TicketSystem->customer_tickets($self->custnum, $num) };
3877
3878     } else {
3879
3880       foreach my $priority (
3881         $conf->config('ticket_system-custom_priority_field-values'), ''
3882       ) {
3883         last if scalar(@tickets) >= $num;
3884         push @tickets,
3885           @{ FS::TicketSystem->customer_tickets( $self->custnum,
3886                                                  $num - scalar(@tickets),
3887                                                  $priority,
3888                                                )
3889            };
3890       }
3891     }
3892   }
3893   (@tickets);
3894 }
3895
3896 # Return services representing svc_accts in customer support packages
3897 sub support_services {
3898   my $self = shift;
3899   my %packages = map { $_ => 1 } $conf->config('support_packages');
3900
3901   grep { $_->pkg_svc && $_->pkg_svc->primary_svc eq 'Y' }
3902     grep { $_->part_svc->svcdb eq 'svc_acct' }
3903     map { $_->cust_svc }
3904     grep { exists $packages{ $_->pkgpart } }
3905     $self->ncancelled_pkgs;
3906
3907 }
3908
3909 # Return a list of latitude/longitude for one of the services (if any)
3910 sub service_coordinates {
3911   my $self = shift;
3912
3913   my @svc_X =
3914     grep { $_->latitude && $_->longitude }
3915     map { $_->svc_x }
3916     map { $_->cust_svc }
3917     $self->ncancelled_pkgs;
3918
3919   scalar(@svc_X) ? ( $svc_X[0]->latitude, $svc_X[0]->longitude ) : ()
3920 }
3921
3922 =item masked FIELD
3923
3924 Returns a masked version of the named field
3925
3926 =cut
3927
3928 sub masked {
3929 my ($self,$field) = @_;
3930
3931 # Show last four
3932
3933 'x'x(length($self->getfield($field))-4).
3934   substr($self->getfield($field), (length($self->getfield($field))-4));
3935
3936 }
3937
3938 =back
3939
3940 =head1 CLASS METHODS
3941
3942 =over 4
3943
3944 =item statuses
3945
3946 Class method that returns the list of possible status strings for customers
3947 (see L<the status method|/status>).  For example:
3948
3949   @statuses = FS::cust_main->statuses();
3950
3951 =cut
3952
3953 sub statuses {
3954   my $self = shift;
3955   keys %{ $self->statuscolors };
3956 }
3957
3958 =item cust_status_sql
3959
3960 Returns an SQL fragment to determine the status of a cust_main record, as a
3961 string.
3962
3963 =cut
3964
3965 sub cust_status_sql {
3966   my $sql = 'CASE';
3967   for my $status ( FS::cust_main->statuses() ) {
3968     my $method = $status.'_sql';
3969     $sql .= ' WHEN ('.FS::cust_main->$method.") THEN '$status'";
3970   }
3971   $sql .= ' END';
3972   return $sql;
3973 }
3974
3975
3976 =item prospect_sql
3977
3978 Returns an SQL expression identifying prospective cust_main records (customers
3979 with no packages ever ordered)
3980
3981 =cut
3982
3983 use vars qw($select_count_pkgs);
3984 $select_count_pkgs =
3985   "SELECT COUNT(*) FROM cust_pkg
3986     WHERE cust_pkg.custnum = cust_main.custnum";
3987
3988 sub select_count_pkgs_sql {
3989   $select_count_pkgs;
3990 }
3991
3992 sub prospect_sql {
3993   " 0 = ( $select_count_pkgs ) ";
3994 }
3995
3996 =item ordered_sql
3997
3998 Returns an SQL expression identifying ordered cust_main records (customers with
3999 no active packages, but recurring packages not yet setup or one time charges
4000 not yet billed).
4001
4002 =cut
4003
4004 sub ordered_sql {
4005   FS::cust_main->none_active_sql.
4006   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->not_yet_billed_sql. " ) ";
4007 }
4008
4009 =item active_sql
4010
4011 Returns an SQL expression identifying active cust_main records (customers with
4012 active recurring packages).
4013
4014 =cut
4015
4016 sub active_sql {
4017   " 0 < ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4018 }
4019
4020 =item none_active_sql
4021
4022 Returns an SQL expression identifying cust_main records with no active
4023 recurring packages.  This includes customers of status prospect, ordered,
4024 inactive, and suspended.
4025
4026 =cut
4027
4028 sub none_active_sql {
4029   " 0 = ( $select_count_pkgs AND ". FS::cust_pkg->active_sql. " ) ";
4030 }
4031
4032 =item inactive_sql
4033
4034 Returns an SQL expression identifying inactive cust_main records (customers with
4035 no active recurring packages, but otherwise unsuspended/uncancelled).
4036
4037 =cut
4038
4039 sub inactive_sql {
4040   FS::cust_main->none_active_sql.
4041   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->inactive_sql. " ) ";
4042 }
4043
4044 =item susp_sql
4045 =item suspended_sql
4046
4047 Returns an SQL expression identifying suspended cust_main records.
4048
4049 =cut
4050
4051
4052 sub suspended_sql { susp_sql(@_); }
4053 sub susp_sql {
4054   FS::cust_main->none_active_sql.
4055   " AND 0 < ( $select_count_pkgs AND ". FS::cust_pkg->suspended_sql. " ) ";
4056 }
4057
4058 =item cancel_sql
4059 =item cancelled_sql
4060
4061 Returns an SQL expression identifying cancelled cust_main records.
4062
4063 =cut
4064
4065 sub cancel_sql { shift->cancelled_sql(@_); }
4066
4067 =item uncancel_sql
4068 =item uncancelled_sql
4069
4070 Returns an SQL expression identifying un-cancelled cust_main records.
4071
4072 =cut
4073
4074 sub uncancelled_sql { uncancel_sql(@_); }
4075 sub uncancel_sql { "
4076   ( 0 < ( $select_count_pkgs
4077                    AND ( cust_pkg.cancel IS NULL
4078                          OR cust_pkg.cancel = 0
4079                        )
4080         )
4081     OR 0 = ( $select_count_pkgs )
4082   )
4083 "; }
4084
4085 =item balance_sql
4086
4087 Returns an SQL fragment to retreive the balance.
4088
4089 =cut
4090
4091 sub balance_sql { "
4092     ( SELECT COALESCE( SUM(charged), 0 ) FROM cust_bill
4093         WHERE cust_bill.custnum   = cust_main.custnum     )
4094   - ( SELECT COALESCE( SUM(paid),    0 ) FROM cust_pay
4095         WHERE cust_pay.custnum    = cust_main.custnum     )
4096   - ( SELECT COALESCE( SUM(amount),  0 ) FROM cust_credit
4097         WHERE cust_credit.custnum = cust_main.custnum     )
4098   + ( SELECT COALESCE( SUM(refund),  0 ) FROM cust_refund
4099         WHERE cust_refund.custnum = cust_main.custnum     )
4100 "; }
4101
4102 =item balance_date_sql [ START_TIME [ END_TIME [ OPTION => VALUE ... ] ] ]
4103
4104 Returns an SQL fragment to retreive the balance for this customer, optionally
4105 considering invoices with date earlier than START_TIME, and not
4106 later than END_TIME (total_owed_date minus total_unapplied_credits minus
4107 total_unapplied_payments).
4108
4109 Times are specified as SQL fragments or numeric
4110 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
4111 L<Date::Parse> for conversion functions.  The empty string can be passed
4112 to disable that time constraint completely.
4113
4114 Available options are:
4115
4116 =over 4
4117
4118 =item unapplied_date
4119
4120 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)
4121
4122 =item total
4123
4124 (unused.  obsolete?)
4125 set to true to remove all customer comparison clauses, for totals
4126
4127 =item where
4128
4129 (unused.  obsolete?)
4130 WHERE clause hashref (elements "AND"ed together) (typically used with the total option)
4131
4132 =item join
4133
4134 (unused.  obsolete?)
4135 JOIN clause (typically used with the total option)
4136
4137 =item cutoff
4138
4139 An absolute cutoff time.  Payments, credits, and refunds I<applied> after this
4140 time will be ignored.  Note that START_TIME and END_TIME only limit the date
4141 range for invoices and I<unapplied> payments, credits, and refunds.
4142
4143 =back
4144
4145 =cut
4146
4147 sub balance_date_sql {
4148   my( $class, $start, $end, %opt ) = @_;
4149
4150   my $cutoff = $opt{'cutoff'};
4151
4152   my $owed         = FS::cust_bill->owed_sql($cutoff);
4153   my $unapp_refund = FS::cust_refund->unapplied_sql($cutoff);
4154   my $unapp_credit = FS::cust_credit->unapplied_sql($cutoff);
4155   my $unapp_pay    = FS::cust_pay->unapplied_sql($cutoff);
4156
4157   my $j = $opt{'join'} || '';
4158
4159   my $owed_wh   = $class->_money_table_where( 'cust_bill',   $start,$end,%opt );
4160   my $refund_wh = $class->_money_table_where( 'cust_refund', $start,$end,%opt );
4161   my $credit_wh = $class->_money_table_where( 'cust_credit', $start,$end,%opt );
4162   my $pay_wh    = $class->_money_table_where( 'cust_pay',    $start,$end,%opt );
4163
4164   "   ( SELECT COALESCE(SUM($owed),         0) FROM cust_bill   $j $owed_wh   )
4165     + ( SELECT COALESCE(SUM($unapp_refund), 0) FROM cust_refund $j $refund_wh )
4166     - ( SELECT COALESCE(SUM($unapp_credit), 0) FROM cust_credit $j $credit_wh )
4167     - ( SELECT COALESCE(SUM($unapp_pay),    0) FROM cust_pay    $j $pay_wh    )
4168   ";
4169
4170 }
4171
4172 =item unapplied_payments_date_sql START_TIME [ END_TIME ]
4173
4174 Returns an SQL fragment to retreive the total unapplied payments for this
4175 customer, only considering invoices with date earlier than START_TIME, and
4176 optionally not later than END_TIME.
4177
4178 Times are specified as SQL fragments or numeric
4179 UNIX timestamps; see L<perlfunc/"time">).  Also see L<Time::Local> and
4180 L<Date::Parse> for conversion functions.  The empty string can be passed
4181 to disable that time constraint completely.
4182
4183 Available options are:
4184
4185 =cut
4186
4187 sub unapplied_payments_date_sql {
4188   my( $class, $start, $end, %opt ) = @_;
4189
4190   my $cutoff = $opt{'cutoff'};
4191
4192   my $unapp_pay    = FS::cust_pay->unapplied_sql($cutoff);
4193
4194   my $pay_where = $class->_money_table_where( 'cust_pay', $start, $end,
4195                                                           'unapplied_date'=>1 );
4196
4197   " ( SELECT COALESCE(SUM($unapp_pay), 0) FROM cust_pay $pay_where ) ";
4198 }
4199
4200 =item _money_table_where TABLE START_TIME [ END_TIME [ OPTION => VALUE ... ] ]
4201
4202 Helper method for balance_date_sql; name (and usage) subject to change
4203 (suggestions welcome).
4204
4205 Returns a WHERE clause for the specified monetary TABLE (cust_bill,
4206 cust_refund, cust_credit or cust_pay).
4207
4208 If TABLE is "cust_bill" or the unapplied_date option is true, only
4209 considers records with date earlier than START_TIME, and optionally not
4210 later than END_TIME .
4211
4212 =cut
4213
4214 sub _money_table_where {
4215   my( $class, $table, $start, $end, %opt ) = @_;
4216
4217   my @where = ();
4218   push @where, "cust_main.custnum = $table.custnum" unless $opt{'total'};
4219   if ( $table eq 'cust_bill' || $opt{'unapplied_date'} ) {
4220     push @where, "$table._date <= $start" if defined($start) && length($start);
4221     push @where, "$table._date >  $end"   if defined($end)   && length($end);
4222   }
4223   push @where, @{$opt{'where'}} if $opt{'where'};
4224   my $where = scalar(@where) ? 'WHERE '. join(' AND ', @where ) : '';
4225
4226   $where;
4227
4228 }
4229
4230 #for dyanmic FS::$table->search in httemplate/misc/email_customers.html
4231 use FS::cust_main::Search;
4232 sub search {
4233   my $class = shift;
4234   FS::cust_main::Search->search(@_);
4235 }
4236
4237 =back
4238
4239 =head1 SUBROUTINES
4240
4241 =over 4
4242
4243 =item append_fuzzyfiles FIRSTNAME LASTNAME COMPANY ADDRESS1
4244
4245 =cut
4246
4247 use FS::cust_main::Search;
4248 sub append_fuzzyfiles {
4249   #my( $first, $last, $company ) = @_;
4250
4251   FS::cust_main::Search::check_and_rebuild_fuzzyfiles();
4252
4253   use Fcntl qw(:flock);
4254
4255   my $dir = $FS::UID::conf_dir. "/cache.". $FS::UID::datasrc;
4256
4257   foreach my $field (@fuzzyfields) {
4258     my $value = shift;
4259
4260     if ( $value ) {
4261
4262       open(CACHE,">>$dir/cust_main.$field")
4263         or die "can't open $dir/cust_main.$field: $!";
4264       flock(CACHE,LOCK_EX)
4265         or die "can't lock $dir/cust_main.$field: $!";
4266
4267       print CACHE "$value\n";
4268
4269       flock(CACHE,LOCK_UN)
4270         or die "can't unlock $dir/cust_main.$field: $!";
4271       close CACHE;
4272     }
4273
4274   }
4275
4276   1;
4277 }
4278
4279 =item batch_charge
4280
4281 =cut
4282
4283 sub batch_charge {
4284   my $param = shift;
4285   #warn join('-',keys %$param);
4286   my $fh = $param->{filehandle};
4287   my $agentnum = $param->{agentnum};
4288   my $format = $param->{format};
4289
4290   my $extra_sql = ' AND '. $FS::CurrentUser::CurrentUser->agentnums_sql;
4291
4292   my @fields;
4293   if ( $format eq 'simple' ) {
4294     @fields = qw( custnum agent_custid amount pkg );
4295   } else {
4296     die "unknown format $format";
4297   }
4298
4299   eval "use Text::CSV_XS;";
4300   die $@ if $@;
4301
4302   my $csv = new Text::CSV_XS;
4303   #warn $csv;
4304   #warn $fh;
4305
4306   my $imported = 0;
4307   #my $columns;
4308
4309   local $SIG{HUP} = 'IGNORE';
4310   local $SIG{INT} = 'IGNORE';
4311   local $SIG{QUIT} = 'IGNORE';
4312   local $SIG{TERM} = 'IGNORE';
4313   local $SIG{TSTP} = 'IGNORE';
4314   local $SIG{PIPE} = 'IGNORE';
4315
4316   my $oldAutoCommit = $FS::UID::AutoCommit;
4317   local $FS::UID::AutoCommit = 0;
4318   my $dbh = dbh;
4319
4320   #while ( $columns = $csv->getline($fh) ) {
4321   my $line;
4322   while ( defined($line=<$fh>) ) {
4323
4324     $csv->parse($line) or do {
4325       $dbh->rollback if $oldAutoCommit;
4326       return "can't parse: ". $csv->error_input();
4327     };
4328
4329     my @columns = $csv->fields();
4330     #warn join('-',@columns);
4331
4332     my %row = ();
4333     foreach my $field ( @fields ) {
4334       $row{$field} = shift @columns;
4335     }
4336
4337     if ( $row{custnum} && $row{agent_custid} ) {
4338       dbh->rollback if $oldAutoCommit;
4339       return "can't specify custnum with agent_custid $row{agent_custid}";
4340     }
4341
4342     my %hash = ();
4343     if ( $row{agent_custid} && $agentnum ) {
4344       %hash = ( 'agent_custid' => $row{agent_custid},
4345                 'agentnum'     => $agentnum,
4346               );
4347     }
4348
4349     if ( $row{custnum} ) {
4350       %hash = ( 'custnum' => $row{custnum} );
4351     }
4352
4353     unless ( scalar(keys %hash) ) {
4354       $dbh->rollback if $oldAutoCommit;
4355       return "can't find customer without custnum or agent_custid and agentnum";
4356     }
4357
4358     my $cust_main = qsearchs('cust_main', { %hash } );
4359     unless ( $cust_main ) {
4360       $dbh->rollback if $oldAutoCommit;
4361       my $custnum = $row{custnum} || $row{agent_custid};
4362       return "unknown custnum $custnum";
4363     }
4364
4365     if ( $row{'amount'} > 0 ) {
4366       my $error = $cust_main->charge($row{'amount'}, $row{'pkg'});
4367       if ( $error ) {
4368         $dbh->rollback if $oldAutoCommit;
4369         return $error;
4370       }
4371       $imported++;
4372     } elsif ( $row{'amount'} < 0 ) {
4373       my $error = $cust_main->credit( sprintf( "%.2f", 0-$row{'amount'} ),
4374                                       $row{'pkg'}                         );
4375       if ( $error ) {
4376         $dbh->rollback if $oldAutoCommit;
4377         return $error;
4378       }
4379       $imported++;
4380     } else {
4381       #hmm?
4382     }
4383
4384   }
4385
4386   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
4387
4388   return "Empty file!" unless $imported;
4389
4390   ''; #no error
4391
4392 }
4393
4394 =item notify CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4395
4396 Deprecated.  Use event notification and message templates
4397 (L<FS::msg_template>) instead.
4398
4399 Sends a templated email notification to the customer (see L<Text::Template>).
4400
4401 OPTIONS is a hash and may include
4402
4403 I<from> - the email sender (default is invoice_from)
4404
4405 I<to> - comma-separated scalar or arrayref of recipients
4406    (default is invoicing_list)
4407
4408 I<subject> - The subject line of the sent email notification
4409    (default is "Notice from company_name")
4410
4411 I<extra_fields> - a hashref of name/value pairs which will be substituted
4412    into the template
4413
4414 The following variables are vavailable in the template.
4415
4416 I<$first> - the customer first name
4417 I<$last> - the customer last name
4418 I<$company> - the customer company
4419 I<$payby> - a description of the method of payment for the customer
4420             # would be nice to use FS::payby::shortname
4421 I<$payinfo> - the account information used to collect for this customer
4422 I<$expdate> - the expiration of the customer payment in seconds from epoch
4423
4424 =cut
4425
4426 sub notify {
4427   my ($self, $template, %options) = @_;
4428
4429   return unless $conf->exists($template);
4430
4431   my $from = $conf->config('invoice_from', $self->agentnum)
4432     if $conf->exists('invoice_from', $self->agentnum);
4433   $from = $options{from} if exists($options{from});
4434
4435   my $to = join(',', $self->invoicing_list_emailonly);
4436   $to = $options{to} if exists($options{to});
4437
4438   my $subject = "Notice from " . $conf->config('company_name', $self->agentnum)
4439     if $conf->exists('company_name', $self->agentnum);
4440   $subject = $options{subject} if exists($options{subject});
4441
4442   my $notify_template = new Text::Template (TYPE => 'ARRAY',
4443                                             SOURCE => [ map "$_\n",
4444                                               $conf->config($template)]
4445                                            )
4446     or die "can't create new Text::Template object: Text::Template::ERROR";
4447   $notify_template->compile()
4448     or die "can't compile template: Text::Template::ERROR";
4449
4450   $FS::notify_template::_template::company_name =
4451     $conf->config('company_name', $self->agentnum);
4452   $FS::notify_template::_template::company_address =
4453     join("\n", $conf->config('company_address', $self->agentnum) ). "\n";
4454
4455   my $paydate = $self->paydate || '2037-12-31';
4456   $FS::notify_template::_template::first = $self->first;
4457   $FS::notify_template::_template::last = $self->last;
4458   $FS::notify_template::_template::company = $self->company;
4459   $FS::notify_template::_template::payinfo = $self->mask_payinfo;
4460   my $payby = $self->payby;
4461   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4462   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4463
4464   #credit cards expire at the end of the month/year of their exp date
4465   if ($payby eq 'CARD' || $payby eq 'DCRD') {
4466     $FS::notify_template::_template::payby = 'credit card';
4467     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4468     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4469     $expire_time--;
4470   }elsif ($payby eq 'COMP') {
4471     $FS::notify_template::_template::payby = 'complimentary account';
4472   }else{
4473     $FS::notify_template::_template::payby = 'current method';
4474   }
4475   $FS::notify_template::_template::expdate = $expire_time;
4476
4477   for (keys %{$options{extra_fields}}){
4478     no strict "refs";
4479     ${"FS::notify_template::_template::$_"} = $options{extra_fields}->{$_};
4480   }
4481
4482   send_email(from => $from,
4483              to => $to,
4484              subject => $subject,
4485              body => $notify_template->fill_in( PACKAGE =>
4486                                                 'FS::notify_template::_template'                                              ),
4487             );
4488
4489 }
4490
4491 =item generate_letter CUSTOMER_OBJECT TEMPLATE_NAME OPTIONS
4492
4493 Generates a templated notification to the customer (see L<Text::Template>).
4494
4495 OPTIONS is a hash and may include
4496
4497 I<extra_fields> - a hashref of name/value pairs which will be substituted
4498    into the template.  These values may override values mentioned below
4499    and those from the customer record.
4500
4501 The following variables are available in the template instead of or in addition
4502 to the fields of the customer record.
4503
4504 I<$payby> - a description of the method of payment for the customer
4505             # would be nice to use FS::payby::shortname
4506 I<$payinfo> - the masked account information used to collect for this customer
4507 I<$expdate> - the expiration of the customer payment method in seconds from epoch
4508 I<$returnaddress> - the return address defaults to invoice_latexreturnaddress or company_address
4509
4510 =cut
4511
4512 # a lot like cust_bill::print_latex
4513 sub generate_letter {
4514   my ($self, $template, %options) = @_;
4515
4516   return unless $conf->exists($template);
4517
4518   my $letter_template = new Text::Template
4519                         ( TYPE       => 'ARRAY',
4520                           SOURCE     => [ map "$_\n", $conf->config($template)],
4521                           DELIMITERS => [ '[@--', '--@]' ],
4522                         )
4523     or die "can't create new Text::Template object: Text::Template::ERROR";
4524
4525   $letter_template->compile()
4526     or die "can't compile template: Text::Template::ERROR";
4527
4528   my %letter_data = map { $_ => $self->$_ } $self->fields;
4529   $letter_data{payinfo} = $self->mask_payinfo;
4530
4531   #my $paydate = $self->paydate || '2037-12-31';
4532   my $paydate = $self->paydate =~ /^\S+$/ ? $self->paydate : '2037-12-31';
4533
4534   my $payby = $self->payby;
4535   my ($payyear,$paymonth,$payday) = split (/-/,$paydate);
4536   my $expire_time = timelocal(0,0,0,$payday,--$paymonth,$payyear);
4537
4538   #credit cards expire at the end of the month/year of their exp date
4539   if ($payby eq 'CARD' || $payby eq 'DCRD') {
4540     $letter_data{payby} = 'credit card';
4541     ($paymonth < 11) ? $paymonth++ : ($paymonth=0, $payyear++);
4542     $expire_time = timelocal(0,0,0,$payday,$paymonth,$payyear);
4543     $expire_time--;
4544   }elsif ($payby eq 'COMP') {
4545     $letter_data{payby} = 'complimentary account';
4546   }else{
4547     $letter_data{payby} = 'current method';
4548   }
4549   $letter_data{expdate} = $expire_time;
4550
4551   for (keys %{$options{extra_fields}}){
4552     $letter_data{$_} = $options{extra_fields}->{$_};
4553   }
4554
4555   unless(exists($letter_data{returnaddress})){
4556     my $retadd = join("\n", $conf->config_orbase( 'invoice_latexreturnaddress',
4557                                                   $self->agent_template)
4558                      );
4559     if ( length($retadd) ) {
4560       $letter_data{returnaddress} = $retadd;
4561     } elsif ( grep /\S/, $conf->config('company_address', $self->agentnum) ) {
4562       $letter_data{returnaddress} =
4563         join( "\n", map { s/( {2,})/'~' x length($1)/eg;
4564                           s/$/\\\\\*/;
4565                           $_;
4566                         }
4567                     ( $conf->config('company_name', $self->agentnum),
4568                       $conf->config('company_address', $self->agentnum),
4569                     )
4570         );
4571     } else {
4572       $letter_data{returnaddress} = '~';
4573     }
4574   }
4575
4576   $letter_data{conf_dir} = "$FS::UID::conf_dir/conf.$FS::UID::datasrc";
4577
4578   $letter_data{company_name} = $conf->config('company_name', $self->agentnum);
4579
4580   my $dir = $FS::UID::conf_dir."/cache.". $FS::UID::datasrc;
4581
4582   my $lh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4583                            DIR      => $dir,
4584                            SUFFIX   => '.eps',
4585                            UNLINK   => 0,
4586                          ) or die "can't open temp file: $!\n";
4587   print $lh $conf->config_binary('logo.eps', $self->agentnum)
4588     or die "can't write temp file: $!\n";
4589   close $lh;
4590   $letter_data{'logo_file'} = $lh->filename;
4591
4592   my $fh = new File::Temp( TEMPLATE => 'letter.'. $self->custnum. '.XXXXXXXX',
4593                            DIR      => $dir,
4594                            SUFFIX   => '.tex',
4595                            UNLINK   => 0,
4596                          ) or die "can't open temp file: $!\n";
4597
4598   $letter_template->fill_in( OUTPUT => $fh, HASH => \%letter_data );
4599   close $fh;
4600   $fh->filename =~ /^(.*).tex$/ or die "unparsable filename: ". $fh->filename;
4601   return ($1, $letter_data{'logo_file'});
4602
4603 }
4604
4605 =item print_ps TEMPLATE
4606
4607 Returns an postscript letter filled in from TEMPLATE, as a scalar.
4608
4609 =cut
4610
4611 sub print_ps {
4612   my $self = shift;
4613   my($file, $lfile) = $self->generate_letter(@_);
4614   my $ps = FS::Misc::generate_ps($file);
4615   unlink($file.'.tex');
4616   unlink($lfile);
4617
4618   $ps;
4619 }
4620
4621 =item print TEMPLATE
4622
4623 Prints the filled in template.
4624
4625 TEMPLATE is the name of a L<Text::Template> to fill in and print.
4626
4627 =cut
4628
4629 sub queueable_print {
4630   my %opt = @_;
4631
4632   my $self = qsearchs('cust_main', { 'custnum' => $opt{custnum} } )
4633     or die "invalid customer number: " . $opt{custvnum};
4634
4635   my $error = $self->print( $opt{template} );
4636   die $error if $error;
4637 }
4638
4639 sub print {
4640   my ($self, $template) = (shift, shift);
4641   do_print [ $self->print_ps($template) ];
4642 }
4643
4644 #these three subs should just go away once agent stuff is all config overrides
4645
4646 sub agent_template {
4647   my $self = shift;
4648   $self->_agent_plandata('agent_templatename');
4649 }
4650
4651 sub agent_invoice_from {
4652   my $self = shift;
4653   $self->_agent_plandata('agent_invoice_from');
4654 }
4655
4656 sub _agent_plandata {
4657   my( $self, $option ) = @_;
4658
4659   #yuck.  this whole thing needs to be reconciled better with 1.9's idea of
4660   #agent-specific Conf
4661
4662   use FS::part_event::Condition;
4663
4664   my $agentnum = $self->agentnum;
4665
4666   my $regexp = regexp_sql();
4667
4668   my $part_event_option =
4669     qsearchs({
4670       'select'    => 'part_event_option.*',
4671       'table'     => 'part_event_option',
4672       'addl_from' => q{
4673         LEFT JOIN part_event USING ( eventpart )
4674         LEFT JOIN part_event_option AS peo_agentnum
4675           ON ( part_event.eventpart = peo_agentnum.eventpart
4676                AND peo_agentnum.optionname = 'agentnum'
4677                AND peo_agentnum.optionvalue }. $regexp. q{ '(^|,)}. $agentnum. q{(,|$)'
4678              )
4679         LEFT JOIN part_event_condition
4680           ON ( part_event.eventpart = part_event_condition.eventpart
4681                AND part_event_condition.conditionname = 'cust_bill_age'
4682              )
4683         LEFT JOIN part_event_condition_option
4684           ON ( part_event_condition.eventconditionnum = part_event_condition_option.eventconditionnum
4685                AND part_event_condition_option.optionname = 'age'
4686              )
4687       },
4688       #'hashref'   => { 'optionname' => $option },
4689       #'hashref'   => { 'part_event_option.optionname' => $option },
4690       'extra_sql' =>
4691         " WHERE part_event_option.optionname = ". dbh->quote($option).
4692         " AND action = 'cust_bill_send_agent' ".
4693         " AND ( disabled IS NULL OR disabled != 'Y' ) ".
4694         " AND peo_agentnum.optionname = 'agentnum' ".
4695         " AND ( agentnum IS NULL OR agentnum = $agentnum ) ".
4696         " ORDER BY
4697            CASE WHEN part_event_condition_option.optionname IS NULL
4698            THEN -1
4699            ELSE ". FS::part_event::Condition->age2seconds_sql('part_event_condition_option.optionvalue').
4700         " END
4701           , part_event.weight".
4702         " LIMIT 1"
4703     });
4704
4705   unless ( $part_event_option ) {
4706     return $self->agent->invoice_template || ''
4707       if $option eq 'agent_templatename';
4708     return '';
4709   }
4710
4711   $part_event_option->optionvalue;
4712
4713 }
4714
4715 =item queued_bill 'custnum' => CUSTNUM [ , OPTION => VALUE ... ]
4716
4717 Subroutine (not a method), designed to be called from the queue.
4718
4719 Takes a list of options and values.
4720
4721 Pulls up the customer record via the custnum option and calls bill_and_collect.
4722
4723 =cut
4724
4725 sub queued_bill {
4726   my (%args) = @_; #, ($time, $invoice_time, $check_freq, $resetup) = @_;
4727
4728   my $cust_main = qsearchs( 'cust_main', { custnum => $args{'custnum'} } );
4729   warn 'bill_and_collect custnum#'. $cust_main->custnum. "\n";#log custnum w/pid
4730
4731   $cust_main->bill_and_collect( %args );
4732 }
4733
4734 sub process_bill_and_collect {
4735   my $job = shift;
4736   my $param = thaw(decode_base64(shift));
4737   my $cust_main = qsearchs( 'cust_main', { custnum => $param->{'custnum'} } )
4738       or die "custnum '$param->{custnum}' not found!\n";
4739   $param->{'job'}   = $job;
4740   $param->{'fatal'} = 1; # runs from job queue, will be caught
4741   $param->{'retry'} = 1;
4742
4743   $cust_main->bill_and_collect( %$param );
4744 }
4745
4746 sub _upgrade_data { #class method
4747   my ($class, %opts) = @_;
4748
4749   my @statements = (
4750     'UPDATE h_cust_main SET paycvv = NULL WHERE paycvv IS NOT NULL',
4751     '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',
4752   );
4753   # fix yyyy-m-dd formatted paydates
4754   if ( driver_name =~ /^mysql$/i ) {
4755     push @statements,
4756     "UPDATE cust_main SET paydate = CONCAT( SUBSTRING(paydate FROM 1 FOR 5), '0', SUBSTRING(paydate FROM 6) ) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
4757   }
4758   else { # the SQL standard
4759     push @statements,
4760     "UPDATE cust_main SET paydate = SUBSTRING(paydate FROM 1 FOR 5) || '0' || SUBSTRING(paydate FROM 6) WHERE SUBSTRING(paydate FROM 7 FOR 1) = '-'";
4761   }
4762
4763   foreach my $sql ( @statements ) {
4764     my $sth = dbh->prepare($sql) or die dbh->errstr;
4765     $sth->execute or die $sth->errstr;
4766   }
4767
4768   local($ignore_expired_card) = 1;
4769   local($ignore_illegal_zip) = 1;
4770   local($ignore_banned_card) = 1;
4771   local($skip_fuzzyfiles) = 1;
4772   $class->_upgrade_otaker(%opts);
4773
4774 }
4775
4776 =back
4777
4778 =head1 BUGS
4779
4780 The delete method.
4781
4782 The delete method should possibly take an FS::cust_main object reference
4783 instead of a scalar customer number.
4784
4785 Bill and collect options should probably be passed as references instead of a
4786 list.
4787
4788 There should probably be a configuration file with a list of allowed credit
4789 card types.
4790
4791 No multiple currency support (probably a larger project than just this module).
4792
4793 payinfo_masked false laziness with cust_pay.pm and cust_refund.pm
4794
4795 Birthdates rely on negative epoch values.
4796
4797 The payby for card/check batches is broken.  With mixed batching, bad
4798 things will happen.
4799
4800 B<collect> I<invoice_time> should be renamed I<time>, like B<bill>.
4801
4802 =head1 SEE ALSO
4803
4804 L<FS::Record>, L<FS::cust_pkg>, L<FS::cust_bill>, L<FS::cust_credit>
4805 L<FS::agent>, L<FS::part_referral>, L<FS::cust_main_county>,
4806 L<FS::cust_main_invoice>, L<FS::UID>, schema.html from the base documentation.
4807
4808 =cut
4809
4810 1;
4811