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